메인 콘텐츠로 건너뛰기
POST
Python
미리보기는 세션을 변경하거나 이메일을 보내지 않습니다. 응답을 검토한 후에는 Update Session Status로 확인하고, 반환된 preview_token을 email_preview_token으로 전달합니다. 이 영수증은 15분 후에 만료됩니다. 변경되었거나 만료된 영수증은 세션이 변경되거나 이메일이 발송되기 전에 409를 반환합니다. 충돌이 발생하면 새 미리보기를 생성합니다. 기존 API 연동에서는 영수증을 생략할 수 있습니다. 콘솔은 미리보기를 확인할 때 영수증을 자동으로 제공합니다. 발신자와 브랜딩은 기존 화이트 라벨 설정을 따릅니다. 메시지 내용은 번역된 인증 템플릿에서 가져옵니다. 임의의 제목, 본문, 작업 URL은 템플릿 입력으로 허용되지 않습니다.

이메일을 받는 사람

email_address는 선택 사항입니다. 이 값을 생략하면 이메일은 해당 사람의 본인 주소로 전송됩니다. 흐름의 이메일 인증 단계에서 인증한 주소가 우선이며, 그런 주소가 없으면 세션을 생성할 때 contact_details에 입력한 주소로 전송됩니다. email_address에 전달한 주소가 우선합니다. recipient_source는 적용되는 주소를 알려 줍니다:

이메일 발송 여부

send_email: true로 재제출을 확인할 때 이메일이 발송되면 will_be_sent는 true입니다. false이면 not_sent_reason에 이유가 나타납니다:

재제출 확인

다음 필드와 함께 Update Session Status를 호출합니다: 응답의 language는 이메일이 작성되는 언어입니다. 요청한 언어가 제공되지 않으면 영어로 작성됩니다.

백엔드 전용 재제출 반복

재제출할 모든 단계가 사람의 개입 없이 실행되는 경우(AML, 데이터베이스 검증 또는 IP 분석), 세션은 30초에 한 번만 해당 사람을 위해 재제출할 수 있습니다. 이 기간 내에는 Update Session Status와 마찬가지로 미리보기가 429를 반환하며, 대기 시간은 Retry-After 헤더에 담깁니다.

관련 문서

인증

x-api-key
string
header
필수

Business Console의 Developers -> API keys에서 발급받은 귀하 애플리케이션의 API 키입니다. 기본 키는 전체 접근 권한을 갖습니다. 이름이 지정된 키는 리소스별 none, read, write 범위로 권한을 제한할 수 있으며 특정 워크플로나 승인된 세션, IP 주소 목록, 만료일 등으로 제한할 수도 있습니다. 401은 키가 잘못되었거나 폐기되었거나 만료되었음을 의미합니다. 403은 키가 전송되지 않았거나, 키에 해당 리소스나 작업에 대한 접근 권한이 없거나, 요청이 허용된 IP 목록 외부 주소에서 발생했음을 의미합니다. 세션 경로에서의 404는 해당 세션이 키의 허용 워크플로 또는 상태 범위를 벗어났음을 의미합니다. 미디어 접근 권한이 없는 키는 이미지, 비디오, PDF URL을 null로 수신하며, 세션 write 권한이 없는 키는 세션 링크와 token을 null로 수신합니다. https://docs.didit.me/console/api-keys 를 참고하십시오.

경로 매개변수

sessionId
string<uuid>
필수

업데이트할 인증 세션의 UUID입니다. 사용자(KYC) 및 기업(KYB) 세션 ID를 모두 지원하며, 서비스는 두 세션 유형 전체에서 ID를 확인합니다.

예시:

"11111111-2222-3333-4444-555555555555"

본문

application/json
nodes_to_resubmit
object[]

재제출과 동일한 검증, 선택 및 워크플로 순서를 사용하여 미리 볼 단계입니다. 재제출이 필요한 기록된 시도를 자동 선택하려면 생략하십시오.

email_address
string<email>

선택 사항입니다. 개인 본인의 주소 대신 이 주소로 이메일을 전송합니다. 지정하지 않으면 워크플로에서 개인이 인증한 주소가 수신자가 되며, 그렇지 않으면 contact_details에 입력된 주소가 사용됩니다. 이 호출로는 이메일이 전송되지 않습니다.

예시:

"user@example.com"

email_language
string
기본값:en

알림 이메일 언어입니다. 스키마 수준에서 모든 문자열을 허용하며, 지원되지 않는 코드는 영어(en)로 자동 대체됩니다.

예시:

"en"

응답

미리보기 전용입니다. 세션은 변경되지 않으며 이메일도 전송되지 않습니다.

recipient
string
필수

이메일이 전송되는 주소입니다. 사용자의 주소를 알 수 없는 경우 빈 문자열입니다: 이 경우 이메일을 전송할 수 없으며 preview_token도 비어 있습니다. 확인할 때 email_address로 전달하십시오.

예시:

"person@example.com"

recipient_source
enum<string>
필수

recipient의 출처입니다. request: 전달한 email_address입니다. email_verification: 플로우의 이메일 인증 단계에서 사용자가 인증한 주소입니다. contact_details: 세션 생성 시 contact_details에 제공된 주소입니다. 주소가 없는 경우 빈 문자열입니다.

사용 가능한 옵션:
email_verification,
contact_details,
request,
예시:

"email_verification"

sender
string
필수

이메일 발송에 사용되는 From 헤더입니다.

예시:

"Example App <no-reply@mail.example.com>"

sender_name
string
필수

sender의 표시 이름 부분입니다.

예시:

"Example App"

sender_email
string<email>
필수

sender의 주소 부분입니다.

예시:

"no-reply@mail.example.com"

sender_kind
enum<string>
필수

customer: 이메일이 애플리케이션의 인증된 발신자 도메인(화이트 라벨)에서 발송됩니다. didit: Didit의 자체 발신자에서 발송됩니다.

사용 가능한 옵션:
customer,
didit
예시:

"customer"

subject
string
필수

전송된 그대로의 제목 라인입니다.

예시:

"Action Required: Complete your verification in Example App"

html
string
필수

전송된 그대로의 이메일 HTML이며, 로고는 data URL로 임베드되어 있습니다. 애플리케이션 DOM에 직접 렌더링하지 말고 반드시 샌드박스 처리된 프레임에서 렌더링하세요.

예시:

"<!DOCTYPE html><html><body>...</body></html>"

text
string
필수

간결한 미리보기를 제공하기 위해 수신자의 메시지 스레드에 보관되는 일반 텍스트 형태의 이메일 내용입니다(HTML은 수신자가 받는 이메일 그대로 유지됨).

예시:

"Almost there\n\nSome steps need to be completed again.\nHere’s what to fix:\n\nhttps://verify.didit.me/session/abc123"

language
string
필수

이메일이 작성된 언어입니다. 요청한 email_language가 제공되지 않는 경우 영어(en)로 설정됩니다.

예시:

"en"

will_be_sent
boolean
필수

send_email: true로 변경 사항을 확인할 때 이 이메일을 발송할지 여부입니다. not_sent_reason이 설정된 경우 false입니다.

예시:

true

not_sent_reason
enum<string> | null
필수

확인 시 이메일이 전송되지 않는 이유 또는 전송될 예정인 경우 null입니다. no_user_action: 선택한 모든 단계가 사용자 없이 실행되므로 재제출이 자동으로 완료되고 이메일이 발송되지 않습니다. no_recipient: 사용자의 알려진 주소가 없으며 전달된 주소도 없습니다. sandbox: 수신자가 샌드박스 이메일 전송에 동의하지 않은 샌드박스 세션이므로 전송이 시뮬레이션만 됩니다.

사용 가능한 옵션:
no_user_action,
no_recipient,
sandbox,
null
예시:

null

nodes_to_resubmit
object[]
필수
requires_user_action
boolean
필수

선택한 검사 중 하나 이상에 사용자 상호작용이 필요한지 여부입니다. 이는 최종 워크플로 결과를 예측하지 않습니다.

preview_token
string
필수

해당 이메일에 대한 서명된 영수증으로, 15분 동안 유효합니다. 세션 상태 업데이트에 email_preview_token으로 전달하십시오. 수신자가 없는 경우 빈 문자열입니다.

예시:

"eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"

마지막 수정일 2026년 11월 7일