계약문서 생성 및 발송

get-create-document-params로 얻은 파라미터 양식에 값을 채워 계약 문서를 생성할 수 있습니다.

파라미터 정보는 get-create-document-params 에 나와 있는 결과값을 참고하시기 바랍니다.

계약문서 생성 및 발송

POST /rest/api/create-document

get-create-document-params로 얻은 파라미터로 값을 지정 후 문서를 생성(발송) 합니다.

templateId(*) 또는 templateIds(*) 중 하나의 값은 반드시 전달해주어야 합니다.

templateId, templateIds 모두 전달하는 경우 templateId가 우선 시 됩니다.

Headers

Name	Type	Description
apiKey	String	apiKey

Request Body

Name	Type	Description
templateId (conditinally required)	Number | String	사용할 템플릿 아이디
templateIds (conditinally required)	String	사용할 템플릿 아이디 목록, comma로 구분됨 예시) "templateIds":"10,11"
name*	String	생성될 문서의 이름
message	String	서명자가 문서 서명화면을 열 때 표시되는 알림 문구, 빈값일 경우 알림 문구 팝업은 뜨지 않는다.
expiredDays	Number	문서 생성 후 서명 가능한 유효기간, 1 = 1일
tagData	String	문서 조회 시 이용 가능한 태그 정보, ","로 구분하며 최대 10개까지 가능
userPassword	String	서명하기 화면에서 사용자가 인증하는 암호
password	String	완료 시 문서를 확인하기 위해 필요한 암호
groupNameSend	String	발송을 하는 경우 발송자가 싸인투게더에서 해당 그룹명이 되도록 함.
docSecurity*	Boolean	완료된 문서의 암호를 설정하도록 한다. false면 위에 설정한 암호가 의미 없음
userSecurity*	Booelan	서명하기 화면에서 사용자에게 암호를 묻도록 한다.
transferType	Number	문서 생성 시 메일이나 카카오 알림을 보내거나 보내지 않는다 0 = 보내지 않는다, null or "" 인 경우 보낸다.
contractors*	ObjectArray	서명을 하는 사람 정보 예시) { "name": "서명자이름", "contact": "연락처" , "phone": "본인인증전화번호", "language": "kor", //표시 언어 "companyName": "법인명 ", "companyRegNo": "사업자등록번호", "additionalData": "추가전달데이터", "attachments": [ { *"required":true, *"requestName":"필수 첨부파일", "description":"업로드 해주세요." }, { *"required":false, *"requestName":"첨부파일" }, ... ] }
referrers	ObjectArray	참조 대상자 정보 { "name": "서명자이름", "contact": "연락처" }
companyCert*	Booelan	법인 인증서 적용 여부
attachSecurity	Booelan	첨부파일이 있는 경우, 해당 값이 true이면 서명 완료 전 서명자가 첨부파일을 볼 수 있도록 한다.
participantPassword	Boolean	해당 값이 true 이면 서명 하기 화면에서 암호를 묻는다.
hideConsenseMessage	Booelan	서명 화면에서 완료 시 싸인투게더 약관 및 동의 페이지를 표시할 것인지 말 것인지 여부(url 파라미터에 자동으로 포함됨)
content	Object	각 페이지별 서명 요청자가 입력하는 정보
signpadOption	String	Default : 기존과 동일 SignOnly : 서명 패드만 표시 NameFixed : 텍스트를 이용한 도장/싸인 생성 시 계약자 이름으로 고정
mobileCertOption	String	Default : 기존과 동일하게 휴대폰 인증, 통합인증(전자서명) 모두 표시하며 브라우저 팝업 사용 Phone : 휴대폰 인증만 표시, 브라우저 팝업 사용 eSign : 통합인증(전자서명)만 표시, 브라우저 팝업 사용 DefaultModal : Default 옵션과 동일하나 Layered Modal 사용 PhoneModal : 휴대폰 인증만 표시, Layered Modal 사용 eSignModal : 통합인증(전자서명)만 표시, Layered Modal 사용
useUpdateAllSign	Boolean	참여자의 서명 일괄적용 활성화 여부 Default : true
contentMappedByElementName	Boolean	파라미터 매핑 시 순서/seq를 지키지 않음 Default:false
noOrder	Boolean	서명자가 여러명인 경우 해당 값이 true이면 서명 순서를 무시
mobileCert	Boolean	본인 인증 여부
hideRefuseButton	Booelan	서명하기 화면에서 거절버튼을 숨긴다.
hideButtonAtComplete	Booelan	계약(문서)완료 시점에 체험하기 버튼, 로그인 링크 숨긴다.
postProcessId	String	문서속 처리 아이디
additionalData	String	문서 후속 처리 시 추가로 전달하고자 하는 정보
allPagesReadRequired	Boolean	참여자의 계약문서 모든 페이지 필수확인 옵션 Default:false
reserved	Boolean	예약 발송 문서 여부 Default:false
reservedDate	String	예약 발송 시간, 양식 : yyyyMMddhh 예시) 2024년 10월 1일 오후 1시 발송 2024100113 ※ 대한민국 시간 기준

Response Example

200: OK 성공 또는 핸들링된 오류

Example

 {
    "contractId":100,                         //계약 문서에 대한 아이디
    "contractorId":200,                       //계약자에 대한 아이디
    "sharedKey":"공유키",                      //계약 대상에 대한 계약서의 고유한 값
    "signingUrl":"https://url?shardkey=..."   //서명하기 화면에 대한 URL
  }

type

json

400: Bad Request 핸들링하지 못한 오류에 대한 처리

Example

{
  "timestamp": "2023-09-01T14:27:27.971+00:00",
  "status": 400,
  "error": "Bad Request",
  "message": "[|COM_002]Invalid_Parameter|파라미터 정보가 정상적이지 않습니다.",
  "path": "/rest/create-document"
}

401: Unauthorized keyauth 토큰(apikey)이 잘못된 경우

Example

{
    "message": "Bad token; invalid JSON"
}

401: Unauthorized Header에 apikey를 전달하지 않은 경우

Example

{
    "message": "Unauthorized"
}