매개변수 이름 | 유형 | 필수 여부 | 설명 |
subject | string | true | 信封 주제 예: "Offer Letter" |
remark | string | false | 信封 비고, 길이 제한 1000자 |
signerSettings | object | false | 서명자가 수행할 수 있는 작업 |
| | allowTransfer | boolean | false | 서명자가 이 봉투를 다른 사람에게 전달하여 서명할 수 있는지 여부, 기본값 false true-봉투의 서명자가 봉투를 타인에게 전달할 수 있는 권한을 가짐; false-봉투의 서명자가 봉투를 타인에게 전달할 수 있는 권한을 가지지 않음; |
| | allowModifyName | boolean | false | 서명자가 성명을 수정할 수 있는지 여부(템플릿 서명에만 적용), 기본값 false true-서명자가 성명을 수정할 수 있음 false-서명자가 성명을 수정할 수 없음 |
expireAfterSeconds | long | false | 봉투 만료 시간, 지정된 초 이후에 봉투가 만료됨 만료 범위: 86,400초(1일) ~ 7,776,000초(90일) |
redirectUrl | string | false | 유효한 https 주소여야 함 |
callBackUrl | string | false | 콜백 주소(길이 500), https 프로토콜 주소를 따라야 함. |
sendLaterAfterSeconds | long | false | 사용자의 지연 발송 지원, 초 단위 지원 시간 범위: 3600초(1시간) ~ 259200초(30일) |
autoFinish | boolean | false | 봉투 자동 종료 여부 제어, 기본값 true true-봉투 자동 종료 false-봉투 수동 종료 |
CCInfos | array | false | 참조자 정보 집합 |
| userEmail | string | false | 참조자 이메일 주소 |
| userName | string | false | 참조자 이름. 서명 페이지 및 봉투 외부에 참조자 이름을 표시하는 데 사용됩니다. [주의]: 다음 9개의 특수문자를 포함할 수 없습니다: / \ : * " < > | ? 그리고 모든 이모지 |
| ccOrder | int | false | 서명 프로세스에서 참조자의 순서 위치. 서명자의 signOrder와 순서를 공유합니다. 전달하지 않을 경우 기존 참조 알림 로직을 따릅니다. |
| | customizeSettings | object | false | 사용자 정의 구성 |
| | | notificationSettings | object | false | 알림 관련 사용자 정의 구성 |
| | | | notificationLanguage | string | false | 알림 언어. 기본값은 '기본 알림 언어' 구성에서 가져옵니다. en-US 영어 zh-CN 중국어(간체) zh-Hant 중국어(번체) ja-JP 일본어 es-MX 스페인어 pt-PT 포르투갈어 th-TH 태국어 id-ID 인도네시아어 vi-VN 베트남어 ms-MY 말레이어 fil-PH 필리핀어 de-DE 독일어 fr-FR 프랑스어 ru-RU 러시아어 it-IT 이탈리아어 ko-KR 한국어 |
signFiles | array | true | 서명 파일 정보 집합, 표시 순서는 파일 추가 순서입니다. |
| fileKey | string | true | 서명 파일 fileKey, PDF 형식만 지원 |
| | documentFields | array | false | 파일 차원 컨트롤 목록. 서명자와 바인딩되지 않은 파일 차원 컨트롤을 지정된 파일에 추가하는 데 사용됩니다. |
| | fieldType | string | false | 컨트롤 유형. eMeterai를 전달하면 인도네시아 스탬프 컨트롤을 나타냅니다. |
| | pageNo | string | false | 컨트롤이 있는 페이지 번호. 인도네시아 스탬프 컨트롤은 단일 페이지만 지정할 수 있으므로 단일 페이지 번호를 전달해야 하며, 1-3 또는 1,3과 같은 연속 또는 비연속 다중 페이지 형식은 지원되지 않습니다. |
| | | posX | float | false | x축 오프셋, 페이지 왼쪽 하단이 좌표 원점입니다. 좌표 범위는 다른 컨트롤의 좌표 범위와 동일합니다. |
| | | posY | float | false | y축 오프셋, 페이지 좌하단이 좌표 원점입니다. 좌표 범위는 다른 컨트롤의 좌표 범위와 동일합니다. |
attachments | array | false | 봉투 첨부 파일 집합, 표시 순서는 파일 추가 순서입니다. |
| fileKey | string | false | 파일 fileKey |
signerInfos | array | true | 서명자 정보 집합 |
| businessId | string | false | 개발자 정의 비즈니스 번호, 길이 제한 500 |
| | roleTypes | array | false | 서명자 작업 방식, 기본값은 ["sign", "fill"] fill-입력 sign-서명 |
| | deliveryMethods | string | false | 알림 방식, 기본값은 auto auto-userEmail을 전달할 경우 이메일 알림 전송, phoneNumber를 전달할 경우 SMS 알림 전송 none-메시지 알림 미전송 email-이메일 알림 전송 sms-SMS 알림 전송 WhatsApp-WhatsApp 알림 전송 |
| userEmail | string | false | 서명자 이메일 주소 |
| userName | string | true | 서명자 이름은 서명 페이지와信封(봉투) 외부에 표시되는 서명자의 이름을 나타냅니다. [주의] 다음 9개의 특수문자를 포함할 수 없습니다: / \ : * " < > | ? 및 모든 이모티콘 |
| | minimumReadingDuration | int | false | 페이지 강제 읽기 카운트다운 시간을 설정합니다. 기본값은 0입니다(단위: 초, 최대값 999). 0 또는 전달하지 않으면 활성화되지 않으며, 읽기 카운트다운이 필요하지 않습니다. |
| | readToEndRequired | boolean | false | 하단까지 반드시 읽어야 하는지 여부를 나타냅니다. 기본값은 false입니다. true는 활성화를 의미하며, false 또는 전달하지 않으면 비활성화를 의미합니다. |
| phoneNumber | object | false | 전화번호이며, 기본값은 빈 문자열입니다. SMS 알림이 필요한 경우 필수 파라미터이며, countryCode와 number 모두 전달해야 합니다. |
| | countryCode | string | false | 국가/지역의 국제 코드이며, '+' 기호는 포함하지 않아도 됩니다. |
| | number | string | false | 형식 검증은 수행되지 않으며, 길이는 최대 13자리로 제한됩니다. |
| | customizeSettings | object | false | 사용자 정의 구성 |
| | | notificationSettings | object | false | 알림 관련 사용자 정의 구성 |
| | | | customizeMessage | string | false | 전용 메시지 알림, 문자 제한 200자 |
| | | | notificationLanguage | string | false | 알림 언어이며, 기본값은 '기본 알림 언어' 구성에서 가져옵니다. en-US 영어 zh-CN 간체 중국어 zh-Hant 번체 중국어 ja-JP 일본어 es-MX 멕시코 스페인어 pt-PT 포르투갈어 th-TH 태국어 id-ID 인도네시아어 vi-VN 베트남어 ms-MY 말레이어 fil-PH 필리핀어 de-DE 독일어 fr-FR 프랑스어 ru-RU 러시아어 it-IT 이탈리아어 ko-KR 한국어 |
| signOrder | int | true | 서명자의 서명 순서로, 최소값은 1입니다. 비순차적 서명의 경우 동일한 순서 값을 지정할 수 있습니다. |
| signTaskSuspend | boolean | false | 해당 서명 위치 전에 프로세스 차단 노드를 설정할지 여부이며, 기본값은 false입니다. true-차단 노드 설정; false-차단 노드 미설정. 동일한 signOrder의 병렬 서명 그룹 내에서는 차단 구성이 일관되어야 합니다. |
| suspensionKey | string | false | 차단 노드 식별자로, 최대 500자까지 가능하며, 동일한信封(봉투) 내에서 고유해야 합니다. signTaskSuspend=true일 때 필수 입력 항목이며, signTaskSuspend=false이거나 전달되지 않은 경우 입력해서는 안 됩니다. |
| suspendReason | string | false | 차단 사유로, 전달 시 공백일 수 없으며 최대 50자까지 가능합니다. signTaskSuspend=true일 때만 전달 가능하며, 전달되지 않을 경우 외부 시스템 처리를 기다려야 함을 기본값으로 나타냅니다. signTaskSuspend=false이거나 전달되지 않은 경우 입력해서는 안 됩니다. |
| anySigner | boolean | false | 누구든 서명할 수 있는지 여부를 나타내며, 기본값은 false입니다. true-동일한 signOrder에서는 그중 한 사람만 서명하면 됩니다. false-동일한 signOrder에서는 모든 사람이 서명해야 합니다. |
| authModes | string | false | 검증 방식으로, 기본값은 noAuth입니다. noAuth-검증 없음 accessCode-서명 비밀번호 검증 사용 sms-SMS OTP 검증 idVerification-신분증 검증 emailAuth-이메일 OTP 검증 digitalId-전자 신분 검증 whatsappAuth-WhatsApp OTP 검증 |
| authConfig | object | false | 인증 방식 설정 |
| | accessCode | object | false | 서명 비밀번호 설정, authModes=일 때 필수 입력accessCode필수 입력 |
| | | accessCode | string | false | 비밀번호 내용, 대소문자 구분 없음, 영숫자 포함 가능, 길이 제한 45 |
| | | | promptInfo | string | false | 액세스 비밀번호 안내 메시지, 액세스 비밀번호를 포함할 수 없으며, 길이 제한 30, authModes=일 때 필수 입력. accessCode필수 입력. |
| | sms | object | false | SMS OTP 검증, authModes=일 때 필수 입력sms필수 입력 |
| | | countryCode | string | false | 국가/지역의 국제 코드, '+' 기호는 전달하지 않음 |
| | | number | string | false | 형식 검증 없이 최대 13자리로 길이만 제한 |
| | idVerification | object | false | 신분증 검증 설정, authModes=일 때 필수 입력idVerification필수 입력 |
| | | name | string | false | 서명자의 신분증에 기재된 성명 전체, 최대 길이 100자 |
| | | emailAuth | object | false | 이메일 OTP 검증, authModes=일 때 필수 입력emailAuth필수 입력 |
| | | | authEmail | string | false | 서명자 신원 확인 이메일 주소 |
| | digitalId | array | false | 전자 신원 확인, authModes=digitalId일 때 필수 입력 |
| | | authApp | string | false | 전자 신원 확인에 사용되는 앱 singpass-Singpass를 사용한 신원 인증 iamsmart-i AM Smart를 사용한 신원 인증 |
| | | idNumber | string | false | 서명자가 검증할 신분증 번호 authApp=singpass일 경우, 전달 규칙은 다음과 같습니다: 대문자 + 7자리 또는 8자리 숫자 + 대문자 authApp=iamsmart일 경우, 전달 규칙은 다음과 같습니다: 1. 시퀀스의 시작 부분으로 하나의 대문자(A-Z) 또는 두 개의 대문자(AA-ZZ); 2. 그 다음 6자리 숫자; 3. 마지막으로 체크 디지트(숫자 0-9 또는 문자 A-Z). 예: A888888(A) |
| | whatsappAuth | object | false | WhatsApp OTP 검증, authModes=whatsappAuth일 때 필수 입력 |
| | | countryCode | string | false | 국가/지역의 국제 코드, '+' 기호는 포함하지 않음 |
| | | number | string | false | 형식 검증 없이 길이만 최대 13자리로 제한 |
| digitalSignature | boolean | false | 디지털 서명 활성화 여부, 기본값 false true-활성화, false-비활성화 |
| tsp | string | false | 서명자가 사용할 TSP 선택, 기본값 false. 설정하지 않으면 서명자가 사용할 TSP를 직접 선택합니다. 열거형 포함: vinotek、eSignPersonal、localCertificates、iAmSmart、vnptSmartCa、adacomOneShot、audkenni belgianIdCard、certEuropeUsbToken、certSignWebSign、chaveMovel、croatianIdCard、czechIdCard、dTrustSignMe、diia estonianIdCard、estonianMobileId、evrotrust、finnishIdCard、frejaEid、frejaEidSign、gseGestionDeSeguridadElectronica、halcom harica、idAustriaATrustSignatur、infoCert、ltId、latvianIdCard、latvianEParakstsMobile、lithuanianIdCard、lithuanianMobileId mscTrustGate、mitId、norwegianBankId、oneId、pscWorldWallet、spid、serproId、simplySign smartId、swedenBankId、swissId、swisscom、transSped、trustAsia、zealidApp、certMe certSignUsbToken、eCertChile、eMudhra、itsme、mojeId、emdha |
| freeFormSign | boolean | false | 서명자가 자유로운 도장 사용 가능 여부, 기본값 false 보충 설명: freeFormSign가 true로 설정된 경우, sealInfos 내 다른 파라미터는 전달할 필요가 없습니다. 동시에 전달되면 freeFormSign가 sealInfos보다 우선하며, sealInfos 내 파라미터는 적용되지 않습니다. [주의]자유로운 도장 사용은 서명자가 삽입할 수 있는 도장/서명의 수와 위치를 제한하지 않음을 의미합니다. |
| documentVisibility | object | false | 파일 가시성 구성, 기본값 전체 표시. |
| | documentViewType | string | false | 가시성 정책, 기본값 all; all은 봉투 내 모든 서명 파일을 볼 수 있음을 의미하며, limited는 자신의 서명 파일과 추가적으로 표시 가능한 파일만 볼 수 있음을 의미합니다. |
| | viewableFileKeys | array | false | 서명 당사자가 추가로 볼 수 있도록 허용된 fileKey 목록; documentViewType=limited일 때만 전달 및 적용됩니다. |
| sealInfos | array | false | 서명 작업 정보 |
| | fileKey | string | true | 서명 파일 fileKey |
| | signConfigs | array | false | 컨트롤 위치 정보, 전자 서명을 수행하려면 반드시 컨트롤의 위치 정보를 지정해야 합니다. |
| | | fieldType | string | false | 컨트롤 유형, 기본값은 signature signature-서명 컨트롤 stamp-도장 컨트롤 approval-승인 컨트롤 |
| | | | required | boolean | false | 필수 입력 여부, 기본값은 필수 입력 true-필수 입력 false-선택 입력 |
| | | | signFieldStyle | string | false | 서명 컨트롤 도장 부착 방식, 기본값은 normalSeal. normalSeal-일반 도장 pagingSeal-페이지 경계 도장 페이지 경계 도장은 서명 컨트롤과 도장 컨트롤에서만 설정할 수 있습니다. |
| | | | pagingSealMode | string | false | 페이지 경계 도장 적용 페이지 범위, 기본값은 all. all-전체 페이지 번호 assignedPages-지정된 페이지 번호 even-짝수 페이지 odd-홀수 페이지 signFieldStyle=pagingSeal일 때만 지정 가능. |
| | | | sizeRule | string | false | 서명 영역 크기 표시 방식 originalSize-서명/도장 실제 크기에 맞춰 배치 targetSize-커스텀 서명/도장 영역 너비 및 높이 sizeRule, height, width가 모두 비어 있을 경우, 서명/도장 실제 크기에 맞춰 배치; sizeRule이 비어 있고 height, width가 비어 있지 않을 경우, 지정된 크기에 맞춰 배치; sizeRule이 비어 있지 않을 경우, 지정된 표시 방식에 맞춰 배치; 교차 도장은 이 파라미터를 지정할 필요가 없으며, 실제 크기에 맞춰 배치됩니다. |
| | | height | int | false | 서명 컨트롤 높이, fieldType이 signature/stamp인 경우 적용, 단위 px, 양의 정수만 허용, 기본값 auto(시스템 자동 크기); fieldType=signature일 경우, 설정 범위는 20-250px; fieldType=stamp일 경우, 설정 범위는 30-280px; 교차 도장은 이 파라미터를 지정할 필요가 없습니다. |
| | | width | int | false | 서명 컨트롤 너비, fieldType이 signature/stamp인 경우 적용, 단위 px, 양의 정수만 허용, 기본값 auto(시스템 자동 크기); fieldType가 signature일 경우, 범위는 20-250px로 설정 가능; fieldType가 stamp일 경우, 범위는 30-280px로 설정 가능; 교차 도장(骑缝章)은 이 파라미터를 지정할 필요가 없습니다. |
| | | signatureOptions | string | false | 서명 위젯 옵션. fieldType이 signature인 경우에만 적용됨 입력 가능한 값: template: 템플릿 서명 handDrawn: 손으로 그린 서명 upload: 로컬에서 서명 이미지 업로드 aiHandDrawn: AI 기반 필기 서명 여러 개 선택 가능, 쉼표(",")로 구분, 기본값은 전체 선택 |
| | | movable | boolean | false | 서명 시 위치 이동 허용 여부, 기본값 false false - 서명자가 자신의 서명 위젯 위치를 조정할 수 없음 true - 서명자가 자신의 서명 위젯 위치를 조정할 수 있음 |
| | | allowedOptions | array | false | 서명자의 승인 옵션 허용 여부, fieldType이 approval인 경우에만 적용됨. 기본값은 ["approve", "decline"] approve- 동의 decline-거부 |
| | | pageNo | string | false | 서명 페이지 번호; 연속된 페이지 번호는 "-"로 연결하고, 개별 페이지 번호는 ","로 연결합니다. 예시: 1-3,6-10 pagingSealMode=assignedPages일 때, 교차 도장(骑缝章)이 적용될 페이지 범위를 전달합니다. 교차 도장은 1페이지 이상의 파일에만 사용할 수 있습니다. |
| | | posX | float | false | x축 좌표 [주의] fieldType이 signature인 경우, 좌표 위치는 서명 영역을 의미합니다.좌하단; fieldType이 stamp인 경우, 좌표 위치는 도장 영역을 의미합니다.중심점위치 2026년 2월 3일부터 fieldType이 signature 또는 stamp인 경우, 그 좌표 위치는 도장 영역의 중심점을 의미합니다. 교차 도장은 0을 전달할 수 있으며 null은 전달할 수 없습니다. 위젯은 파일 오른쪽 가장자리에 고정됩니다. |
| | | posY | float | false | y축 좌표 [주의] fieldType이 signature인 경우, 좌표 위치는 서명 영역을 의미합니다.좌하단; fieldType이 stamp인 경우, 좌표 위치는 도장 영역을 의미합니다.중심점위치 2026년 2월 3일부터 fieldType이 signature 또는 stamp인 경우, 그 좌표 위치는 도장 영역의 중심점 위치를 의미합니다. |
| | fillConfigs | array | false | 컨트롤 정보 입력 |
| | | fieldName | string | false | 컨트롤 이름, 문자 수 제한 128 |
| | | required | boolean | false | 필수 입력 여부, 기본값은 필수 입력 true-필수 입력 false-선택 입력 |
| | | fieldType | string | false | 컨트롤 유형: 1-단일 줄 텍스트 15-체크박스 |
| | | textField | object | false | 텍스트 컨트롤 속성 |
| | | | overflowType | int | false | text에만 적용되며, 기본값은 1입니다. 1-글꼴 크기 자동 축소 2-입력 제한 |
| | | | minFontSize | float | false | text에만 적용되며, overflowType=1일 때만 적용됨. 기본값은 8입니다. 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72 |
| | | | width | int | false | 컨트롤 너비. 기본값은 160px입니다. |
| | | | font | int | false | text에만 적용되며, 폰트. 기본값은 송체(宋体)입니다. 1-송체(宋体) 2-신흥송체(新宋体) 4-흑체(黑体) 5-계체(楷体) 6-Arial 7-Helvetica 9-Times New Roman 10-방송체(仿宋) 11-Georgia 12-Monospace |
| | | | fontSize | float | false | text에만 적용되며, 폰트 크기. 기본값은 12입니다. 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72 |
| | | | textColor | string | false | text에만 적용되며, 16진수 색상. 기본값은 검은색(#000)입니다. |
| | | | bold | boolean | false | text에만 적용되며, 폰트 굵기 여부. 기본값은 false입니다. true-굵게 false-굵지 않음 |
| | | | italic | boolean | false | text에만 적용되며, 이탤릭체 여부. 기본값은 false입니다. true-기울임체 false-비기울임체 |
| | | | underline | boolean | false | text에만 적용, 글자에 밑줄 추가 여부, 기본값 false true-밑줄 추가 false-밑줄 미추가 |
| | | | lineThrough | boolean | false | text에만 적용, 삭제선 추가 여부, 기본값 false true-삭제선 추가 false-삭제선 미추가 |
| | | | horizontalAlignment | string | false | text에만 적용, 수평 정렬 형식, 기본값 left LEFT-왼쪽 정렬 CENTER-가운데 정렬 RIGHT-오른쪽 정렬 |
| | | tickBoxField | object | false | 체크박스 속성 |
| | | | tickOptions | array | false | tickBox에만 적용, 기본값 1 1-체크됨 2-叉 |
| | | posX | float | false | 컨트롤 위치 X 좌표 |
| | | posY | float | false | 컨트롤 위치 Y 좌표 |
| | | pageNo | string | false | 컨트롤이 있는 페이지 번호 |
| | signDateConfigs | array | false | 서명 날짜 위치 정보 |
| | | movable | boolean | false | 서명 시 위치 이동 허용 여부, 기본값 false false - 서명자가 자신의 서명 컨트롤 위치를 조정할 수 없음 true - 서명자가 자신의 서명 컨트롤 위치를 조정할 수 있음 |
| | | pageNo | string | false | 서명 페이지 번호; 연속된 페이지는 "-"로 연결하고, 개별 페이지는 ","로 연결합니다. 예: 1-3, 6-10; 연속되지 않은 경우 ","로 구분하여 전달합니다. |
| | | posX | float | false | x축 오프셋, 페이지 왼쪽 하단이 좌표 원점입니다 |
| | | posY | float | false | y축 오프셋, 페이지 왼쪽 하단이 좌표 원점입니다 |
| | | signDateFormat | string | false | 서명 날짜 형식, 기본 형식은 yyyy-MM-dd입니다 다음 형식을 지원합니다: yyyy년 MM월 dd일 yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MMM dd,yyyy dd MMM yyyy |