전자서명 템플릿으로 서명 요청 API
POST kit-api/v1/signature-templates/[key]/signatures
POST kit-api/v1/signature-templates/[key]/signaturesExample
.../kit-api/v1/signature-templates/4328/signatures{
"input": {
"title": "솔루션 공급 계약서",
"participants": [
// 전자서명 템플릿 생성/편집 시, 옵션으로 '일부 참여자에게 요청' 기능을 허용했다면 일부 참여자 정보만 전달할 수 있습니다.
{
"role": "갑", // 참여자 역할 (워크플로우의 참여자와 매칭)
"input": {
"name": "홍길동", // 참여자 이름
"email": "[email protected]", // 참여자 이메일 (이메일, 전화번호 중에 하나 필요)
"auth": "EMAIL", // 인증 수단 (EMAIL, PHONE 존재 / send와 동일한 값으로 입력)
"send": "EMAIL" // 발송 수단 (EMAIL, PHONE 존재)
}
},
{
"role": "을",
"input": {
"name": "김프릭",
"phone": "010-1234-1234", // 참여자 전화번호
"auth": "PHONE",
"send": "PHONE",
"extraAuthList": [
{
// 휴대폰 본인인증이 필요한 경우 해당 값 사용
"type": "MOBILE_IDENTIFICATION",
"phoneName": "김실명",
"phoneNumber": "010-1234-1234"
}
]
}
}
],
"items": [
{
// 사전입력값 내용 추가를 위해 사용
"id": 231, // 입력값 id (ex. "금액" 사전입력값의 id가 231인 경우)
"contents": "2,000,000" // 입력값 내용
},
{
"id": 232, // (ex. "주소" 입력값의 id가 232인 경우)
"contents": "선릉로 551 새롬아파트 101-204"
},
{
"id": 233, // (ex. "동의" 입력값의 id가 233인 경우)
"contents": "true" // 체크박스 체크 여부 ('true' 혹은 빈 문자열)
},
// 사전 입력값 생성/편집 시 slug를 지정한 경우 id 대신 slug를 전달할 수 있습니다.
{
"slug": "object-1", // (ex. "동의" 입력값의 slug가 "object-1"인 경우)
"contents": "true" // 체크박스 체크 여부 ('true' 혹은 빈 문자열)
}
],
"additionalFiles": ["...견적서.pdf"], // 합본할 파일 url 목록
"contract": {
"type": "NEW", // 재계약 여부 (선택 / NEW, RENEWAL)
"customKey": "custom-id", // 연결할 맞춤 키 값 (선택 / 중복 불가)
"fileToReplace": "...contract.pdf", // 실제 서명 요청 시 사용할 계약서 문서 url (주의사항: fileToReplace 필드를 사용하여 계약 문서를 변경하여 서명을 요청하는 경우, 템플릿에 등록된 계약서와 페이지 수가 동일해야 합니다.)
"slugColumns": [
// 계약서에 연결할 커스텀 컬럼 정보
{
"slug": "slug-column-1", // 커스텀 컬럼 식별값 (별도 연락 필요)
"value": "slug-column-value" // 커스텀 컬럼 값 (String)
}
],
"connectedContractUuids": ["contract-uuid"], // 연결할 계약서 uuid 목록 (선택)
"contractDate": {
"startDate": "2024-10-01T00:00:00.000Z", // 시작일
"endDate": null, // 종료일
"concludedDate": null // 체결일
},
"customers": [
// 계약서에 연결할 고객의 Id 또는 CustomKey (고객을 연결하려면 둘 중 하나는 필수로 입력해야 합니다.)
{
"id": 1,
"customKey": "customer-custom-key-32"
}
],
"shareNotification": {
// 전자서명 체결 완료 후 계약서 외부 공유 알림 설정 (수신자 여러 명 설정 가능)
"receivers": [
{
"method": "EMAIL", // EMAIL, PHONE
"contact": "[email protected]", // PHONE인 경우, 010-xxxx-xxxx 형식
"name": "EMAIL_TESTER"
},
{
"method": "PHONE", // EMAIL, PHONE
"contact": "010-XXXX-XXXX", // PHONE인 경우, 010-xxxx-xxxx 형식
"name": "PHONE_TESTER"
}
]
}
},
"signature": {
"expiredDate": "2024-12-20T15:00:00.000Z", // 서명 만료일 (현재보다 이후 시간이어야 함)
"ccEmails": [], // 참조자 이메일 목록
"requesterName": "프릭스 컴퍼니", // 서명 요청자
"facilitator": {
// 대면서명 진행자 정보 (대면서명 미요청 시 facilitator 필드 사용하지 않아야 함)
"name": "대면서명 담당자", // 대면서명 진행자 이름
"email": "[email protected]" // 대면서명 진행자 이메일
},
"additionalRequests": [
{
"role": "참관자", // 추가 참여자 역할
"type": "EMAIL", // 발송 방식 (EMAIL, PHONE)
"contact": "[email protected]" // 이메일 주소 또는 전화번호
}
],
"redirectUrl": "https://example.com/callback" // 각 서명 별 리다이렉트 시키고자 하는 경로
},
"option": {
"skipSend": false // 알림 발송 스킵 여부 (선택, true 인 경우 서명 참여 알림을 발송하지 않음)
}
}
}Request Body
Key
Description
Required
Response
Status Code
Error Code
Description
Last updated