봉투 템플릿으로 서명 시작

POST /esignglobal/v1/envelopeTemplates/sendEnvelope

API 설명

페이지 측에서 사전 구성된 "봉투 템플릿"을 사용하여 서명을 진행합니다.

요청 파라미터

파라미터 이름				타입	필수	설명
envelopeTemplateId				string	true	봉투 템플릿 ID
envelopeConfig				object	true	서명 프로세스 설정
	contractConfig			boolean	false	계약 서명 설정
		envelopeRemark		array	false	계약 비고
	envelopeSubject			string	true	현재 서명 프로세스의 제목
	expireAfterSeconds			int	false	현재 서명 프로세스의 서명 마감 시각. 해당 시각 이후에는 서명이 불가능하며, 밀리초 단위 Unix 타임스탬프입니다. 기본 및 최대 유효 기간은 90일입니다.
	callbackUrl			string	false	콜백 알림 수신용 웹 주소
	redirectUrl			string	false	유효한 HTTPS 주소여야 합니다.
	signConfig			object	false	서명 구성 항목
		allowTransfer		boolean	false	서명인이 해당 봉투를 다른 사람에게 위임하여 서명할 수 있는지 여부, 기본값 false true-봉투 내 서명인에게 봉투를 타인에게 위임할 권한을 부여합니다; false-봉투 내 서명인에게 봉투를 타인에게 위임할 권한을 부여하지 않습니다;
participants				array	false	참여자 구성
	participantId			string	true	참여자 ID
	authConfig			object	false	인증 구성 항목
		willingnessAuthModes		array	false	서명자가 선택 가능한 의사 확인 방식, 기본값 noAuth noAuth-검증하지 않음 accessCode-서명 비밀번호를 사용하여 검증 sms-SMS OTP 검증 idVerification-신분증 검증 emailAuth-이메일 OTP 검증 digitalId-전자 신분증 검증 whatsappAuth-whatsapp OTP 검증
		accessCode		object	false	서명 비밀번호 설정, authModes=accessCode일 때 필수
			accessCode	string	false	비밀번호 내용, 대소문자 구분 안 함, 영숫자 포함 가능, 길이 제한 45
			promptInfo	string	false	접근 비밀번호 안내 메시지, 접근 비밀번호 포함 불가, 길이 제한 30, authModes=1일 때 필수.
		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-IAM Smart를 이용한 신분 인증
			idNumber	string	false	서명자 검증 대상 신분증 번호
		whatsappAuth		object	false	whatsapp OTP 검증, authModes=whatsappAuth일 때 필수
			countryCode	string	false	국가/지역 국제 코드, '+' 기호 생략
			number	string	false	형식 검증 없이 길이만 최대 13자리로 제한
	participantInfos			object	false	개인 참여자
		userEmail		string	false	서명자 이메일
		phoneNumber		object	false	전화번호, 기본값은 비어 있음 SMS 알림이 필요한 경우 필수 파라미터, countryCode와 number 모두 입력 필요
			countryCode	string	false	국가/지역 국제 코드, '+' 기호 생략
			number	string	false	형식 검증 없이 길이만 최대 13자리로 제한
		userName		string	false	개인 성명
		deliveryMethod		string	false	알림 방식 none-메시지 알림 미전송 email-이메일 알림 전송 sms-SMS 알림 전송 WhatsApp-WhatsApp 알림 전송
		customizeSettings		object	false	사용자 정의 구성
			customizeMessage	object	false	알림 유형 사용자 정의 구성
			notificationLanguage	string	false	알림 언어, 기본값은 영어 en-US 영어 zh-CN 간체 중국어 zh-Hant 번체 중국어 ja 일본어 ES-MX 스페인어
copiers				array	false	참조 추가
	copierId			string	true	참여자 ID
	CCInfos			object	false	참조 정보
		userEmail		string	false	이메일
		userName		string	false	성명
		customizeSettings		object	false	사용자 정의 구성
			customizeMessage	object	false	알림 유형 사용자 정의 구성
			notificationLanguage	string	false	알림 언어, 기본값은 영어입니다 en-US 영어 zh-CN 간체 중국어 zh-Hant 번체 중국어 ja 일본어 ES-MX 스페인어
attchments				array	false	첨부 파일(서명 불필요한 파일) 정보
	documentId			string	false	첨부 파일 ID
	fileName			string	false	첨부 파일 이름
components				array	false	컨트롤 목록
	documentId			string	false	컨트롤이 속한 파일 ID
	componentId			string	false	컨트롤 ID
	componentKey			string	false	컨트롤 키, (컨트롤 ID와 컨트롤 키 중 하나 선택)
	componentValue			string	false	컨트롤 입력값
	editComponentValue			boolean	false	해당 컨트롤의 서명자가 미리 입력된 내용을 수정할 수 있는지 여부 제어, 기본값은 true true-서명자는 사전 입력값을 수정할 수 있음 false-사전 입력값이 있을 경우 읽기 전용으로 고정되며 서명자가 수정할 수 없음

요청 예시

{
  "envelopeTemplateId": "dc4be9641a3145b****9018d7a9180",
  "envelopeConfig": {
    "envelopeSubject": "*****"
  },
  "participants": [
    {
      "participantId": "42750b92c7a34******34dd5342",
      "participantInfos": {
        "userEmail": "***",
        "userName": "Preset Signer"
      }
    }
  ],
  "copiers": [],
  "attachments": [],
  "components": [
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142***2c3b02c3b5c663aa146",
      "componentId": "30c616512991***d68ab930210c",
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c74***2c3b5c663aa146",
      "componentId": "a130c54c1472444f***6c6e83a2f540"
    },
    {
      "componentValue": "123.4444",
      "documentId": "d559142672c***b02c3b5c663aa146",
      "componentId": "42b76dfbf15e4cf1***a409159c35"
    },
    {
      "componentValue": "0",
      "documentId": "d559142672c7***3b02c3b5c663aa146",
      "componentId": "556b60f7bd32442***3bbec8c54"
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c742c***b5c663aa146",
      "componentId": "7929410bb8754***497d6df30cb2"
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c742c3***c663aa146",
      "componentId": "9e92a77b50b24cd***f6ade4b7d9"
    },
    {
      "componentValue": "123",
      "documentId": "d559142672c7402c3***b5c663aa146",
      "componentId": "9600135a35fb4ff***4ce42b6af"
    },
    {
      "componentValue": "0,1",
      "documentId": "d559142672c742c***b5c663aa146",
      "componentId": "d41cea8f288e***4c18c0289a"
    },
    {
      "componentValue": "1",
      "documentId": "d559142672c***b02c3b5c663aa146",
      "componentId": "9edab2c19***08b3c2dcc2d1a78171"
    },
    {
      "componentValue": "0",
      "documentId": "d559142672c74***c3b5c663aa146",
      "componentId": "4a6136cd81c54***01c113fcd30"
    },
    {
      "componentValue": "***",
      "documentId": "d559142672c7***02c3b5c663aa146",
      "componentId": "73d836894fb34***fb90fcd813"
    },
    {
      "componentValue": "***",
      "documentId": "d5591426***b02c3b5c663aa146",
      "componentId": "4e22fe4be9314a8***81d5354b51da4"
    }
  ]
}

응답 파라미터

파라미터 이름	유형	설명
envelopeId	string	인벨로프 ID

응답 예시

{
  "code": "0",
  "data": {
    "envelopeId": "4e2eb9cc95044a7****a9a81f76397"
  },
  "message": "SUCCESS"
}