봉투 만들기

POST /esignglobal/v1/envelope/create

인터페이스 설명

초안 상태의 봉투를 생성합니다.

요청 매개변수

매개변수 이름		유형	필수 여부	설명
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	서명 완료 후 리디렉션 주소(길이 2048), 유효한 http 주소여야 합니다.
callBackUrl		string	false	콜백 주소(길이 500), https/http 프로토콜 주소와 일치해야 합니다.

요청 예시

  {
    "subject": "api subject fdsfasdfafs",
    "remark": "This is a remark",
    "expireAfterSeconds": 888640,
    "redirectUrl": "https://www.example.com"
}

응답 매개변수

매개변수 이름

유형

설명

envelopeId

string

봉투 ID

envelopeStatus

int

봉투 상태

0-생성됨(초안)

1-서명 중

2-완료됨

3-만료됨

5-취소됨

응답 예시

{
    "code": "0",
    "data": {
        "envelopeId": "9fbe6c8190824227bde29136b0145c81",
        "envelopeStatus": 0
    },
    "message": "success"
}