메인 콘텐츠로 건너뛰기
POST
curl

주소 기반 서비스

주소 확인(거주지 또는 공과금 주소 검증)을 제공하는 서비스에서는 단일 address 값을 보내면 처리 전에 Didit이 이를 나눕니다. 일치율을 가장 높이려면 Didit의 구조화된 주소 필드를 직접 보내십시오. 구조화된 필드는 단일 address 값보다 우선합니다. postal_code는 address_element_5의 별칭으로 허용됩니다.

동의

일부 데이터베이스 서비스는 제공자를 조회하기 전에 최종 사용자의 명시적 동의가 필요합니다. 서비스 카탈로그에서는 이러한 항목에 requires_consent=true로 표시합니다. 선택한 서비스에 사용자 동의가 적용되는 경우 consent=true를 보내십시오. 선택한 서비스에 동의가 필요한데 이를 보내지 않으면, Didit은 제공자 호출이나 과금 이벤트가 발생하기 전에 요청을 거부합니다.

파일 업로드

데이터베이스 검증은 multipart/form-data를 사용합니다. selfie가 필요한 생체 인증 서비스는 API 플레이그라운드에서 이를 파일 업로드 필드로 제공하므로, 경로나 base64 문자열을 붙여넣지 않고 이미지를 직접 선택할 수 있습니다. 코드에서는 일반적인 multipart 문법으로 파일을 업로드하십시오:

검증 오류

Didit은 제공자를 호출하기 전에 필수 필드, 주소 구조, 서비스별 형식을 검증합니다. 예를 들어 chn_national_id, chn_passport_verification 같은 중국 등기 서비스는 full_name을 원래의 중국어 문자로 입력받으며, chn_national_id는 체크섬이 올바른 유효한 15자리 또는 18자리 중국 주민등록번호도 필요합니다. 요청을 실행할 수 없으면 API는 명시적인 필드 오류를 반환하며 사용량은 과금되지 않습니다. 사전 검증 이후 제공자가 실패하면 응답에 validation_errors가 포함되고, 저장된 API 요청은 해당 오류를 데이터베이스 검증 결과에 저장합니다.

거부된 입력 및 사용할 수 없는 결과

사용할 수 있는 결과를 반환한 서비스가 하나도 없으면, 재시도 여부를 결정하기 전에 각 validation_errors 항목을 확인하십시오. HTTP 상태 코드만으로는 재시도가 적절한지 판단할 수 없습니다. code: "provider_rejected_input"과 retryable: false가 포함된 400 응답은 응답되지 않은 모든 시도가 입력을 명시적으로 거부했음을 뜻합니다. 다시 시도하기 전에 제공된 데이터를 수정하십시오. 이러한 시도에는 과금되지 않습니다. code: "empty_provider_response"와 retryable: true가 포함된 502 응답은 다른 이유로 서비스가 사용할 수 있는 결과를 만들지 못했음을 뜻합니다. 여기에는 거부된 입력 뒤에 사용할 수 없는 대체 서비스가 이어진 경우나, 설명을 제공하지 않는 대체 서비스가 이어진 경우도 포함됩니다. 나중에 다시 시도하십시오. 이 응답만으로 입력이 잘못되었다고 판단할 수는 없습니다. 데이터베이스가 계속 실패하면, 중단이 지속될 때 Didit이 최근에 해당 데이터베이스를 사용한 조직에 한 번 이메일을 보내며, 실제 검사에서 서비스가 응답을 다시 시작했음이 확인되면 한 번 더 보냅니다. 자세한 내용은 가용성 알림을 참조하십시오. 선택한 서비스 중 일부만 실패하면 요청은 대신 성공합니다. 응답은 200이며, 실패한 서비스는 database_validation.errors[]에 나열되고 각 항목에는 동일한 code와 retryable 필드가 포함됩니다. 이때 database_validation.status는 응답한 서비스를 기준으로 결정되며 Approved일 수 있으므로, 4xx 또는 5xx 응답뿐 아니라 모든 응답에서 errors[]를 확인하십시오. 여기에 보고된 서비스는 validations와 services_used에서 제외되며 과금되지 않습니다. 해당 서비스만 따로 다시 시도하십시오. 그 밖의 502 오류는 입력을 수정해야 할 수 있습니다. 예를 들어 provider_invalid_input과 provider_validation_error는 원본 제공자가 거부한 입력을 나타내므로, 레거시 응답에 retryable이 없더라도 수정 없이 다시 시도하면 안 됩니다. empty_provider_response의 재시도 지침은 이러한 코드에 적용되지 않습니다. 결과가 일치하는 대상이 없다는 확정적 결과라면, 그것은 가용성 실패가 아니라 완료된 검사입니다.

인증

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 를 참고하십시오.

본문

issuing_state
string
필수

유효성을 검증할 등기부의 ISO 3166-1 alpha-3 국가 코드(예: BRA, ESP, COL)입니다. 사용 가능한 서비스를 결정합니다. 지원되지 않는 코드는 유효한 옵션의 전체 목록과 함께 400을 반환합니다.

예시:

"BRA"

services
string[]

해당 국가에 대해 실행할 카탈로그 service_id 목록(예: ["bra_cpf"]). 단일 문자열이나 쉼표로 구분된/JSON으로 인코딩된 문자열도 허용합니다. 생략되거나 비어 있는 경우 정확히 하나의 기본 서비스가 실행됩니다 — 해당 국가에서 가장 오래 운영된 라이브 서비스입니다. 최신 서비스, 생체 인식 서비스 및 종량제 서비스는 명시적으로 지정해야 합니다. services를 전송하면 응답이 확장된 형태(services_used 및 match_score 추가)로 전환됩니다. 모든 id는 issuing_state에 존재하고 활성 상태여야 합니다. 온보딩이 필요한 서비스는 조직에 활성화될 때까지 400을 반환합니다. 국가별 사용 가능한 서비스는 GET /v1/organization/database-validation-countries/(이 사양에 문서화되지 않은 카탈로그 endpoint) 또는 Business Console 워크플로 편집기를 통해 확인할 수 있습니다.

예시:
validation_type
string
지원 중단

지원 중단됨. 이전 버전과의 호환성을 위해 허용되지만 무시됩니다. 이제 응답의 validation_type은 완전히 일치한 서비스 수에서 파생됩니다. 특정 서비스를 고정하려면 services를 사용하세요.

최종 사용자가 선택한 검증 서비스에 명시적으로 동의한 경우 true로 설정합니다. 카탈로그에서 requires_consent=true로 표시된 서비스의 경우 필수입니다. 동의하지 않으면 해당 서비스는 services_requiring_consent와 함께 400을 반환합니다.

identification_number
string

범용 식별 번호 — 해당 국가별 필드에 자동으로 매핑되므로 personal_number/tax_number/document_number 대신 사용할 수 있습니다: ARG→document_number (DNI), BOL→document_number (CI), BRA→tax_number (CPF, 11자리), CHL→personal_number (RUT), COL→personal_number (Cédula), CRI→personal_number (Cédula), DOM→personal_number (Cédula, 11자리), ECU→personal_number (Cédula, 10자리), ESP→personal_number (DNI/NIE), GTM→document_number (DPI), HND→document_number (DNI), MEX→personal_number (CURP, 18자), PAN→personal_number (Cédula), PER→personal_number (DNI, 8자리), PRY→document_number (CI), SLV→document_number (DUI), URY→personal_number (CI), VEN→document_number (Cédula). 명시적으로 제공된 국가별 필드를 절대 덮어쓰지 않습니다.

first_name
string

개인의 이름입니다. 일부 서비스/국가에서 필수입니다.

예시:

"John"

last_name
string

개인의 성입니다. 일부 서비스/국가에서 필수입니다.

예시:

"Doe"

middle_name
string

일부 국가 서비스(AUS, NZL 등)에서 사용되는 중간 이름입니다.

full_name
string

성명 — 일부 서비스에서는 이름/성 대신 이를 허용합니다(예: 고유 문자 체계 이름을 일치시키는 CHN 서비스).

date_of_birth
string<date>

생년월일, YYYY-MM-DD입니다. 많은 서비스에서 필수 항목입니다.

예시:

"1980-01-01"

personal_number
string

정부 발급 고유 개인 식별자입니다. 다음 국가에서 사용됩니다: CHL(RUT), COL(Cédula), CRI, DOM, ECU, ESP(DNI/NIE), MEX(CURP), PAN(Cédula), PER(DNI), URY. 대신 identification_number를 사용하는 것을 고려하십시오.

tax_number
string

납세자 번호입니다. 사용 국가: BRA(CPF, 11자리). 대신 identification_number 사용을 고려하십시오.

document_number
string

문서 번호입니다. 다음 국가에서 사용됩니다: ARG (DNI), BOL (CI), GTM (DPI), HND (DNI), PRY (CI), SLV (DUI), VEN (Cédula). 대신 identification_number 사용을 고려하세요.

document_type
enum<string>

검증 중인 문서 유형: P(여권), DL(운전면허증), ID(국가 신분증), RP(거주 허가증)(추가로 SSC, HIC, WP, TC, VISA, PSC, BC, OTHER). 일부 서비스(예: ESP)에서 필수입니다.

사용 가능한 옵션:
P,
DL,
ID,
RP,
SSC,
HIC,
WP,
TC,
VISA,
PSC,
BC,
OTHER
expiration_date
string<date>

문서 만료일(YYYY-MM-DD)입니다. ESP(스페인) 검증에 필요합니다.

예시:

"2030-01-15"

date_of_issue
string<date>

문서 발급일, YYYY-MM-DD(fecha de expedición)입니다. COL(콜롬비아) cédula 검증에 필요합니다.

예시:

"2015-06-20"

nationality
string

ISO 3166-1 alpha-3 형식의 국적입니다. 일부 서비스에서 필수입니다.

gender
enum<string>

성별: M, F 또는 X(기타/알 수 없음). 아르헨티나 RENAPER 검증(arg_renaper) 시 필수입니다.

사용 가능한 옵션:
M,
F,
X
address

거주지 주소입니다. 구조화된 객체 {"street_1":"123 Main St","street_2":"Apt 4B","city":"Springfield","region":"IL","postal_code":"62701","country":"US"} 형식을 권장하지만, 완전한 단일 라인 문자열도 허용됩니다. 주소 검증 서비스에 필수입니다. 서비스에 주소 요구사항이 정의되어 있는 경우 누락된 구성 요소가 있으면 address_fields_required_by와 함께 400이 반환됩니다.

address_element_1
string

도로명 번호 및 유형을 포함한 도로명 주소입니다. 생략 시 address에서 파생됩니다.

address_element_2
string

아파트, 동/호수, 건물, 층 또는 추가 주소 라인입니다. 명시적으로 보유한 경우에만 전송하십시오.

address_element_3
string

시, 교외, 구, 지역 또는 동입니다. 생략된 경우 address에서 파생됩니다.

address_element_4
string

주, 도, 지역 또는 시/군/구입니다. 생략된 경우 address에서 파생됩니다.

address_element_5
string

우편번호입니다. postal_code도 별칭으로 허용됩니다.

postal_code
string

주소 기반 서비스를 위한 우편번호(address_element_5의 별칭)입니다.

driver_license_number
string

정부 문서 검증 서비스(AUS, NZL, IND)용 운전면허증 번호입니다.

driver_license_card_number
string

면허증 번호와 별도로 요구되는 경우 실물 운전면허증 카드 번호(AUS).

driver_license_state
string

운전면허증 발급 주 또는 테리토리(AUS)입니다.

driver_license_version
string

운전면허증 버전 코드(NZL)입니다.

passport_number
string

정부 여권 검증 서비스(AUS, NZL, IND, CHN)용 여권 번호입니다.

passport_expiration_date
string<date>

여권 검증 서비스를 위한 여권 만료일(YYYY-MM-DD)입니다.

passport_file_number
string

여권 파일 번호(IND)입니다.

passport_issue_country
string

여권 인증 서비스용 여권 발급 국가(ISO 3166-1 alpha-3)입니다.

medicare_card_number
string

Medicare 카드 번호(AUS).

immi_card_number
string

호주 ImmiCard 번호입니다.

immi_card_expiry_date
string<date>

호주 ImmiCard 만료일입니다.

citizenship_certificate_number
string

시민권 증명서 번호(AUS)입니다.

birth_registration_number
string

출생증명서 등록번호(호주).

birth_registration_date
string<date>

출생증명서 등록일(호주).

birth_registration_state
string

출생증명서 등록 주/지역(호주).

marriage_certificate_number
string

혼인 증명서 번호(AUS).

change_of_name_certificate_number
string

개명 증명서 번호(호주).

first_partner_name
string

결혼 증명서상의 배우자 이름(호주)입니다.

last_partner_name
string

결혼 증명서(AUS)에 기재된 배우자의 성입니다.

voter_id
string

유권자 등록번호(IND EPIC, IRL)입니다.

epic_card
string

인도 EPIC 유권자 카드 번호.

pan
string

인도 PAN(영구 계좌 번호).

national_id
string

국가 신분증 번호(CHN, MYS, KEN, KHM, NGA, ZAF, …).

cic
string

멕시코 INE/IFE 신분증 식별 코드(CIC, 9자리)입니다. 멕시코 INE 신분증 유효성 서비스(mex_ine_vigencia)에서 사용됩니다.

identificador_ciudadano
string

멕시코 INE 시민 식별자(Identificador del Ciudadano, 9자리)입니다. mex_ine_vigencia에서 최신 INE 모델(E/F/G/H)의 cic와 함께 사용됩니다.

ocr
string

멕시코 INE OCR 번호(13자리, 카드 뒷면)입니다. mex_ine_vigencia에서 모델 D의 cic와 함께 사용됩니다.

voter_number
string

멕시코 INE 유권자 식별 번호(Clave de Elector, 18자)입니다. mex_ine_vigencia에서 기존 IFE 모델(A/B/C)의 emission_number와 함께 사용됩니다.

emission_number
string

멕시코 INE 발급 번호(Número de Emisión)입니다. mex_ine_vigencia에서 기존 IFE 모델(A/B/C)의 voter_number와 함께 사용됩니다.

bvn
string

나이지리아 은행 검증 번호입니다.

bank_card_number
string

은행 카드 번호입니다(중국 은행 카드 인증).

company_registration_number
string

법인 등기부에서 발급한 기업 등록번호입니다. 예를 들어 브라질의 CNPJ(예: 11222333000181), 남아프리카공화국의 등록번호(예: 1936/007721/06) 등이 있습니다. 법인 등기부 및 기업 이사 조회 서비스(bra_company_registry, bra_company_directors, zaf_company_registry, zaf_company_directors)에서 필수입니다.

company_name
string

등록부 항목과 대조 확인된 등록 회사명입니다. zaf_company_registry의 경우 선택 사항입니다.

initials
string

문서에 인쇄된 해당 인물의 이니셜입니다. zaf_drivers_license에는 필수이며, zaf_bank_account_holder에서는 허용됩니다.

licence_number
string

zaf_drivers_license의 카드에 인쇄된 운전면허증 번호입니다. 생략 시 document_number가 사용됩니다.

refugee_file_number
string

남아프리카공화국 내무부에서 발급한 난민 파일 번호입니다. zaf_refugee에 필수입니다.

bank_name
string

계좌를 보유한 은행의 이름입니다. zaf_bank_account_holder에 필수입니다.

bank_account_number
string

은행 계좌번호입니다. zaf_bank_account_holder에 필수이며, zaf_fraud_prevention에서 허용됩니다.

account_type
string

zaf_bank_account_holder의 은행 계좌 유형: current, savings, transmission, subscriptionShare 또는 notKnown(대소문자 구분 없음). 다른 모든 값은 400을 반환합니다. 유형을 모르는 경우 생략하십시오. 이 경우 계좌 유형 교차 검증은 확인되지 않음으로 보고됩니다.

phone_number
string

연락 가능 여부를 교차 확인하는 서비스(zaf_bank_account_holder, zaf_fraud_prevention, zaf_refugee)를 위한 연락처 휴대폰 번호입니다.

right_thumb
string

zaf_dha_fingerprint_match를 위한 Base64 인코딩된 오른손 엄지 지문으로, left_thumb와 함께 전송하거나 단독으로 전송합니다.

left_thumb
string

zaf_dha_fingerprint_match를 위한 Base64 인코딩된 왼손 엄지 지문으로, right_thumb와 함께 전송하거나 단독으로 전송합니다.

score_level
integer

zaf_criminal_face_screening의 최소 생체 인식 점수 등급입니다. 기본값은 3입니다.

max_matches
integer

zaf_criminal_face_screening이 반환하는 최대 후보 일치 항목 수입니다. 기본값은 1입니다.

vehicle_register_number
string

차량 등록번호. zaf_vehicle_ownership에서 vehicle_licence_plate 및 vin과 함께 필수입니다.

vehicle_licence_plate
string

차량 번호판 번호. zaf_vehicle_ownership에서 vehicle_register_number 및 vin과 함께 필수입니다.

vin
string

차대번호(VIN 또는 섀시 번호). zaf_vehicle_ownership에서 vehicle_register_number 및 vehicle_licence_plate와 함께 필수입니다.

ssn
string

사회보장번호(미국).

phone
string

전화번호 인증 서비스를 위한 전화번호입니다.

landline
string

전화번호 인증 서비스용 유선 전화번호입니다.

email
string<email>

신원 인증 서비스에 사용할 이메일 주소입니다.

country_of_residence
string

거주 국가의 ISO 3166-1 alpha-2 코드입니다. 글로벌 신원 보강 서비스(예: glb_identity_enrichment)에서 조회를 세부 조정하는 데 사용됩니다.

예시:

"US"

partial_match_action
enum<string>
기본값:NO_ACTION

partial_match가 database_validation.status에 적용하는 영향입니다. 기본값은 NO_ACTION입니다(상태는 경고와 함께 Approved로 유지됨).

사용 가능한 옵션:
DECLINE,
NO_ACTION
no_match_action
enum<string>
기본값:DECLINE

no_match가 database_validation.status에 적용하는 영향입니다. 기본값은 DECLINE입니다.

사용 가능한 옵션:
DECLINE,
NO_ACTION
save_api_request
boolean
기본값:true

검증을 세션으로 유지합니다(콘솔 표시, 결정 endpoint, status.updated webhook). 또한 validations 응답 형태를 변경합니다: true(기본값)인 경우 서비스별 객체, false인 경우 병합된 필드 맵.

vendor_data
string

검증 대상 사용자에 대한 귀하의 식별자입니다. 세션에 저장되며 그대로 다시 반환됩니다.

metadata
object | null

요청과 함께 저장되고 그대로 반환되는 자유 형식 JSON입니다.

응답

검증 완료 — 선택한 서비스 중 최소 하나가 사용 가능한 결과를 반환했습니다. 종합 결과는 database_validation.match_type, 서비스별 필드 비교 및 outcome_codes는 validations, 실패한 서비스는 errors(있는 경우)를 확인하십시오.

request_id
string<uuid>

save_api_request=true일 때 유지된 세션 ID(GET /v3/session/{sessionId}/decision/와 함께 사용 가능), 그렇지 않으면 임시 상관관계 UUID입니다.

database_validation
object
vendor_data
string | null

전송한 vendor_data의 에코 값입니다.

metadata
object | null

전송한 metadata의 에코 값입니다.

created_at
string<date-time>
마지막 수정일 2026년 11월 7일