봉투 생성

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-서명자는 성명을 수정할 수 없습니다
tspScope		array	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。
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",
    "tspScope": ["corpId", "vinotek", "eSignPersonal"],
    "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"
}