매개변수 이름 | 유형 | 필수 여부 | 설명 |
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개의 특수문자를 포함할 수 없습니다: / \ : * " < > | ? 그리고 모든 이모티콘 |
| | 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 형식만 지원 |
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입니다. 비순차적 서명의 경우 동일한 순서 값을 지정할 수 있습니다. |
| 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=일 때, 전달 규칙: 대문자 + 7 또는 8자리 숫자 + 대문자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-비활성화 |
| freeFormSign | boolean | false | 서명인이 자유롭게 도장을 찍을 수 있는지 여부, 기본값 false 보충 설명: freeFormSign이 true로 선택된 경우, sealInfos 내 다른 파라미터는 전달할 필요가 없습니다. 동시에 전달될 경우 freeFormSign이 sealInfos보다 우선하며, sealInfos 내 파라미터는 적용되지 않습니다. [주의]자유로운 도장 찍기는 서명인이 삽입할 수 있는 도장/서명의 수와 위치에 제한이 없음을 의미합니다 |
| 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: 로컬에서 서명 이미지 업로드 다중 선택 가능, 쉼표(",")로 구분, 기본값 전체 선택 |
| | | movable | boolean | false | 서명 시 위치 이동 허용 여부, 기본값 false false - 서명자가 자신의 서명 컨트롤 위치를 조정할 수 없음 true - 서명자가 자신의 서명 컨트롤 위치를 조정할 수 있음 |
| | | allowedOptions | array | false | 서명자의 승인 옵션 허용 여부, fieldType이 approval인 경우 적용됨. 기본값은 ["approve", "decline"] approve-동의 decline-거부 |
| | | pageNo | string | false | 서명 페이지 번호; 연속된 페이지 번호는 "-"로 연결하고, 개별 페이지 번호는 ","로 연결합니다. 예시: 1-3,6-10 pagingSealMode=assignedPages일 때, 교차 도장(骑缝章)이 적용될 페이지 범위를 전달합니다. |
| | | 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 |