서명자 편집

POST/esignglobal/v1/envelope/recipients/editSigners

API 설명

미완료 서명자의 서명자 정보를 수정합니다.

개발자가信封을 생성한 후 서명자 연락처, 서명자 이름, 알림 설정 또는 인증 방식 입력 오류를 발견하거나 서명자 정보를 변경해야 할 경우, 해당 인터페이스를 통해 미완료 서명자 정보를 업데이트할 수 있습니다. 이를 통해 정보 오류로 인해信封이 무효화되어 재발송되는 상황을 방지할 수 있습니다.

주의사항

미완료 서명자 정보만 수정할 수 있습니다.
서명 완료, 거절 완료 등 최종 상태의 서명자는 수정할 수 없습니다.
信封이 최종 상태 또는 무효화 상태일 경우 서명자 정보 수정이 불가능합니다.
알림 방식에 SMS와 이메일이 모두 포함된 경우, 다음 항목만 수정하는 것은 지원하지 않습니다. phoneNumber。
API는 전달된 서명자 정보와 현재 서명자 정보를 비교하며, 정보가 일치하지 않을 경우 해당 서명자 정보를 업데이트합니다.

요청 파라미터

파라미터 이름				타입	필수 여부	설명
envelopeId				string	true	信封 ID
signerInfos				object	true	서명자 정보
	recipientId			string	true	참여자 ID
	businessId			string	false	개발자 지정 비즈니스 번호, 길이 제한 500
	deliveryMethods			string	false	알림 방식, 기본값은 auto auto-userEmail이 전달될 경우 이메일 알림 전송, phoneNumber가 전달될 경우 SMS 알림 전송 none-알림 메시지 전송 안 함 email-이메일 알림 전송 sms-SMS 알림 전송 WhatsApp-WhatsApp 알림 전송
	userEmail			string	false	서명자 이메일 주소
	userName			string	true	서명자 이름, 서명 페이지 및 봉투에서 서명자 이름을 표시하는 데 사용됩니다. 【주의】다음 9개의 특수 문자를 포함할 수 없습니다: / \ : * " < > \| ? 및 모든 이모지
	minimumReadingDuration			int	false	페이지 강제 읽기 카운트다운 시간 설정, 기본값은 0(단위: 초, 최대값 999) 0 또는 값을 전달하지 않으면 비활성화되며, 읽기 카운트다운이 필요하지 않음을 의미합니다.
	readToEndRequired			boolean	false	하단까지 반드시 읽어야 하는지 여부를 나타냅니다. 기본값은 false입니다. true는 활성화됨을 나타내며, false 또는 미전송 시 비활성화됩니다.
	phoneNumber			object	false	전화번호, 기본값은 빈 값입니다. SMS 알림이 필요한 경우 필수 파라미터이며, countryCode와 number를 모두 전달해야 합니다.
		countryCode		string	false	국가 및 지역 국제 코드, '+'는 생략합니다.
		number		string	false	형식 검증 없이 최대 길이만 13자리로 제한됩니다.
	customizeSettings			object	false	사용자 정의 설정
		notificationSettings		object	false	알림 유형 사용자 정의 설정
			customizeMessage	string	false	전용 메시지 알림, 최대 200자 제한
			notificationLanguage	string	false	알림 언어, 기본값은 '기본 알림 언어' 설정을 따릅니다. en-US 영어 zh-CN 중국어(간체) zh-Hant 중국어(번체) ja-JP 일본어 es-MX 스페인어 pt-PT 포르투갈어 th-TH 태국어 id-ID 인도네시아어 vi-VN 베트남어 ms-MY 말레이시아어 fil-PH 필리핀어 de-DE 독일어 fr-FR 프랑스어 ru-RU 러시아어 it-IT 이탈리아어 ko-KR 한국어
	authModes			string	false	검증 방식, 기본값은 noAuth noAuth-검증 안 함 accessCode-서명 비밀번호로 검증 sms-SMS OTP 검증 idVerification-신분증 검증 emailAuth-이메일 OTP 인증 digitalId-전자 신분 인증 whatsappAuth-WhatsApp OTP 인증
	authConfig			object	false	인증 방식 설정
		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를 사용한 신분 인증
			idNumber	string	false	검증 대상 서명자의 신분증 번호
		whatsappAuth		object	false	WhatsApp OTP 인증, authModes=whatsappAuth일 때 필수 입력
			countryCode	string	false	국가/지역의 국제 코드, '+'는 입력하지 않음
			number	string	false	형식 검증은 수행하지 않으며, 길이는 최대 13자까지만 제한

응답 예시

{
  "code": 0,
  "message": "success",
  "data": {
    "envelopeId": "9fbe6c8190824227bde29136b0145c81",
    "signerInfos": [
      {
        "recipientId": "recipient_123456789",
        "businessId": "biz-20260604-001",
        "userEmail": "new_signer@example.com",
        "userName": "Alex Chen"
      }
    ]
  }
}