For services that validate a residential or utility address, you can send a single address and Didit will split it before processing the check. For the best match rate, send structured Didit address fields directly:
Field
Meaning
address_element_1
Street address, including number and street type
address_element_2
Optional unit, building, floor, or extra address line
address_element_3
Suburb, district, locality, or neighborhood
address_element_4
City, town, state, province, or region
address_element_5
Postcode or postal code
Structured fields override the single address value. postal_code is accepted as an alias for address_element_5.
Consent
Some database services require explicit end-user consent before the provider can be queried. The service catalog marks these rows with requires_consent=true.Send consent=true when the user consent applies to the selected services.Didit rejects the request before any provider call or billing event if a selected service requires consent and you do not send it.
File uploads
Database validation uses multipart/form-data. Biometric services that require selfie expose it as a file upload field in the API playground, so you can select an image directly instead of pasting a path or base64 string.In code, upload the file with normal multipart syntax:
-F "selfie=@./selfie.jpg"
Validation errors
Didit validates required fields, address structure, and service-specific formats before calling the provider. For example, China registry services such as chn_national_id and chn_passport_verification expect full_name in the original Chinese script, and chn_national_id also requires a valid 15- or 18-character Chinese national ID with a correct checksum.If a request cannot run, the API returns explicit field errors and no usage is billed. If a provider fails after preflight, the response includes validation_errors, and saved API requests store those errors in the database validation result.
Rejected input and unavailable results
When no service returns a usable result, inspect each validation_errors entry before deciding whether to retry.
The HTTP status alone does not determine whether retrying is appropriate.
A 400 response with code: "provider_rejected_input" and retryable: false means every unanswered attempt explicitly refused the input.
Correct the supplied data before trying again.
These attempts are not billed.A 502 response with code: "empty_provider_response" and retryable: true means the service could not produce a usable result for another reason.
This includes a refused input followed by an unavailable fallback or a fallback that provides no explanation.
Retry later; the response does not establish that the input is wrong.
If a database keeps failing, Didit emails the organizations that recently used it once the interruption is sustained, and again when real checks confirm it is answering — see Availability notifications.When only some of the selected services fail, the request succeeds instead: the response is 200 and the failed services are listed under database_validation.errors[], each with the same code and retryable fields.
database_validation.status then follows the services that did answer and can be Approved, so inspect errors[] on every response and not only on a 4xx or 5xx.
A service reported there is absent from validations and services_used, and is not billed; retry that service on its own.Other 502 errors can require corrected input.
For example, provider_invalid_input and provider_validation_error describe input the source rejected and must not be retried unchanged, even when the legacy response omits retryable.
The retry guidance for empty_provider_response does not apply to these codes.
A conclusive no-match result is a completed check, not an availability failure.
Authorizations
x-api-key
string
header
required
Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is wrong, revoked or expired; 403 means no key was sent, the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.
Headers
Idempotency-Key
string
Optional retry-safety key you choose for one operation, up to 255 characters (a UUID works). A request repeated with the same key, endpoint, query and body is answered with the first response, same status and same body, and runs and bills nothing a second time. The same key with another endpoint, query or body returns 409idempotency_key_reused, and while the first request is still running, 409idempotency_key_in_progress with Retry-After. A failed request (any 4xx or 5xx) is not stored, so you can send it again with the same key. Keys belong to your application, whether you call with an API key or an access token. See Retries and idempotency.
Required string length: 1 - 255
Body
application/jsonmultipart/form-data
issuing_state
string
required
ISO 3166-1 alpha-3 country code of the registry to validate against (e.g. BRA, ESP, COL). Determines which services are available. Unsupported codes return 400 with the full list of valid options.
Example:
"BRA"
services
string[]
Catalog service_ids to run for this country (e.g. ["bra_cpf"]). Also accepts a single string or a comma-separated/JSON-encoded string. If omitted or empty, exactly one default service runs — the longest-established live service for the country; newer, biometric, and pay-as-you-go services must be named explicitly. Sending services switches the response to the extended shape (adds services_used and match_score). Every id must exist and be live for the issuing_state; services that require onboarding return 400 until activated for your organization. Discover available services per country via GET /v1/organization/database-validation-countries/ (a catalog endpoint not documented in this spec) or the Business Console workflow editor.
Example:
["bra_cpf"]
validation_type
string
deprecated
DEPRECATED. Accepted for backward compatibility but ignored — the response validation_type is now derived from how many services full-matched. Use services to pin specific services.
consent
boolean
default:false
Set to true when the end user has explicitly consented to the selected validation services. Required for services flagged requires_consent=true in the catalog — without it those services return 400 with services_requiring_consent.
electoral_roll_only
boolean
default:false
Paraguay (pry_cedula) only. Set to true to check the cédula against the TSJE electoral roll alone. The electoral roll lists only citizens aged 18 or over, so a MATCH also confirms that the holder is an adult, and a cédula that is not on the roll returns DOCUMENT_NOT_FOUND. Defaults to false, which also checks the DNIT taxpayer register for wider identity coverage but cannot confirm age. Any other service rejects it with 400.
identification_number
string
Universal identification number — automatically mapped to the correct country-specific field, so you can use it instead of personal_number/tax_number/document_number: ARG→document_number (DNI), BOL→document_number (CI), BRA→tax_number (CPF, 11 digits), CHL→personal_number (RUT), COL→personal_number (Cédula), CRI→personal_number (Cédula), DOM→personal_number (Cédula, 11 digits), ECU→personal_number (Cédula, 10 digits), ESP→personal_number (DNI/NIE), GTM→document_number (DPI), HND→document_number (DNI), MEX→personal_number (CURP, 18 chars), PAN→personal_number (Cédula), PER→personal_number (DNI, 8 digits), PRY→document_number (CI), SLV→document_number (DUI), URY→personal_number (CI), VEN→document_number (Cédula). It never overrides an explicitly provided country-specific field.
first_name
string
The individual's first name. Required by some services/countries.
Example:
"John"
last_name
string
The individual's last name. Required by some services/countries.
Example:
"Doe"
middle_name
string
Middle name, used by some country services (AUS, NZL, …).
full_name
string
Full name — some services accept this in lieu of first/last name (e.g. CHN services, which match the native-script name).
date_of_birth
string<date>
Date of birth, YYYY-MM-DD. Required by many services.
Example:
"1980-01-01"
personal_number
string
Government-issued unique personal identifier. Used by: CHL (RUT), COL (Cédula), CRI, DOM, ECU, ESP (DNI/NIE), MEX (CURP), PAN (Cédula), PER (DNI), URY. Consider identification_number instead.
tax_number
string
Tax identification number. Used by: BRA (CPF, 11 digits). Consider identification_number instead.
document_number
string
Document number. Used by: ARG (DNI), BOL (CI), GTM (DPI), HND (DNI), PRY (CI), SLV (DUI), VEN (Cédula). Consider identification_number instead.
document_type
enum<string>
Type of document being validated: P passport, DL driver license, ID national ID, RP residence permit (plus SSC, HIC, WP, TC, VISA, PSC, BC, OTHER). Required by some services (e.g. ESP).
Available options:
P,
DL,
ID,
RP,
SSC,
HIC,
WP,
TC,
VISA,
PSC,
BC,
OTHER
expiration_date
string<date>
Document expiration date, YYYY-MM-DD. Required for ESP (Spain) validation.
Example:
"2030-01-15"
date_of_issue
string<date>
Document issue date, YYYY-MM-DD (fecha de expedición). Required for COL (Colombia) cédula validation.
Example:
"2015-06-20"
nationality
string
Nationality as ISO 3166-1 alpha-3. Required by some services.
gender
enum<string>
Gender: M, F, or X (other/unknown). Required for Argentina's RENAPER validation (arg_renaper).
Available options:
M,
F,
X
address
objectstring
Residential address. Prefer the structured object {"street_1":"123 Main St","street_2":"Apt 4B","city":"Springfield","region":"IL","postal_code":"62701","country":"US"}; a complete single-line string is still accepted. Required by address-verification services; when a service defines address requirements, missing parts return 400 with address_fields_required_by.
Show child attributes
address_element_1
string
Street address including street number and type. If omitted, derived from address.
address_element_2
string
Apartment, unit, building, floor, or extra address line. Only send when you have it explicitly.
address_element_3
string
City, suburb, district, locality, or neighborhood. If omitted, derived from address.
address_element_4
string
State, province, region, or town. If omitted, derived from address.
address_element_5
string
Postcode or postal code. postal_code is accepted as an alias.
postal_code
string
Postal code for address-based services (alias of address_element_5).
driver_license_number
string
Driver licence number for government document-verification services (AUS, NZL, IND).
driver_license_card_number
string
Physical driver licence card number, where required separately from the licence number (AUS).
driver_license_state
string
Driver licence state or territory of issue (AUS).
driver_license_version
string
Driver licence version code (NZL).
passport_number
string
Passport number for government passport-verification services (AUS, NZL, IND, CHN).
passport_expiration_date
string<date>
Passport expiry date, YYYY-MM-DD, for passport-verification services.
passport_file_number
string
Passport file number (IND).
passport_issue_country
string
Issuing country of the passport (ISO 3166-1 alpha-3) for passport-verification services.
medicare_card_number
string
Medicare card number (AUS).
immi_card_number
string
Australian ImmiCard number.
immi_card_expiry_date
string<date>
Australian ImmiCard expiry date.
citizenship_certificate_number
string
Citizenship certificate number (AUS).
birth_registration_number
string
Birth-certificate registration number (AUS).
birth_registration_date
string<date>
Birth-certificate registration date (AUS).
birth_registration_state
string
Birth-certificate registration state (AUS).
marriage_certificate_number
string
Marriage certificate number (AUS).
change_of_name_certificate_number
string
Change-of-name certificate number (AUS).
first_partner_name
string
First name of the partner on a marriage certificate (AUS).
last_partner_name
string
Last name of the partner on a marriage certificate (AUS).
voter_id
string
Voter registration number (IND EPIC, IRL).
epic_card
string
India EPIC voter card number.
pan
string
India PAN (Permanent Account Number).
national_id
string
National ID number (CHN, MYS, KEN, KHM, NGA, ZAF, …).
cic
string
Mexican INE/IFE Código de Identificación de Credencial (CIC), 9 digits. Used by the MEX INE credential-validity service (mex_ine_vigencia).
identificador_ciudadano
string
Mexican INE Identificador del Ciudadano (9 digits). Used with cic for modern INE models (E/F/G/H) in mex_ine_vigencia.
ocr
string
Mexican INE OCR number (13 digits, back of card). Used with cic for Model D in mex_ine_vigencia.
voter_number
string
Mexican INE Clave de Elector (18 chars). Used with emission_number for legacy IFE models (A/B/C) in mex_ine_vigencia.
emission_number
string
Mexican INE Número de Emisión. Used with voter_number for legacy IFE models (A/B/C) in mex_ine_vigencia.
bvn
string
Nigerian Bank Verification Number.
bank_card_number
string
Bank card number (CHN bank-card verification).
company_registration_number
string
Company registration number as issued by the companies register: the CNPJ in Brazil (e.g. 11222333000181), the registration number in South Africa (e.g. 1936/007721/06). Required by the company registry and company directors services (bra_company_registry, bra_company_directors, zaf_company_registry, zaf_company_directors).
company_name
string
Registered company name, cross-checked against the register entry. Optional for zaf_company_registry.
initials
string
The person's initials as printed on the document. Required by zaf_drivers_license; accepted by zaf_bank_account_holder.
licence_number
string
Driving licence number as printed on the card, for zaf_drivers_license. When omitted, document_number is used.
refugee_file_number
string
Refugee file number issued by South Africa's Department of Home Affairs. Required by zaf_refugee.
bank_name
string
Name of the bank that holds the account. Required by zaf_bank_account_holder.
bank_account_number
string
Bank account number. Required by zaf_bank_account_holder; accepted by zaf_fraud_prevention.
account_type
string
Bank account type for zaf_bank_account_holder: current, savings, transmission, subscriptionShare or notKnown, case-insensitive. Any other value returns 400. Omit it when you do not know the type: the account-type cross-check is then reported as not confirmed.
phone_number
string
Contact mobile number, for the services that cross-check contactability (zaf_bank_account_holder, zaf_fraud_prevention, zaf_refugee).
right_thumb
string
Base64-encoded right thumb fingerprint for zaf_dha_fingerprint_match, with left_thumb or on its own.
left_thumb
string
Base64-encoded left thumb fingerprint for zaf_dha_fingerprint_match, with right_thumb or on its own.
score_level
integer
Minimum biometric score level for zaf_criminal_face_screening. Defaults to 3.
max_matches
integer
Maximum number of candidate matches zaf_criminal_face_screening returns. Defaults to 1.
vehicle_register_number
string
Vehicle register number. Required, with vehicle_licence_plate and vin, by zaf_vehicle_ownership.
vehicle_licence_plate
string
Vehicle licence plate number. Required, with vehicle_register_number and vin, by zaf_vehicle_ownership.
vin
string
Vehicle Identification Number (VIN or chassis number). Required, with vehicle_register_number and vehicle_licence_plate, by zaf_vehicle_ownership.
ssn
string
Social Security Number (USA).
phone
string
Phone number for phone-verification services.
landline
string
Landline number for phone-verification services.
email
string<email>
Email address for identity-verification services.
country_of_residence
string
ISO 3166-1 alpha-2 country of residence. It was used only by the retired global identity-enrichment service (glb_identity_enrichment), which Didit no longer offers.
Example:
"US"
partial_match_action
enum<string>
default:NO_ACTION
What a partial_match does to database_validation.status. Defaults to NO_ACTION (status stays Approved, with a warning).
Available options:
DECLINE,
NO_ACTION
no_match_action
enum<string>
default:DECLINE
What a no_match does to database_validation.status. Defaults to DECLINE.
Available options:
DECLINE,
NO_ACTION
save_api_request
boolean
default:true
Persist the validation as a session (console visibility, decision endpoint, status.updated webhook). Also changes the validations response shape: per-service objects when true (default), a merged field map when false.
vendor_data
string
Your identifier for the validated user; echoed back and stored with the session.
metadata
object | null
Free-form JSON stored with the request and echoed back.
Response
Validation completed — at least one selected service returned a usable result. Inspect database_validation.match_type for the aggregate outcome, validations for the per-service field comparisons and outcome_codes, and errors (when present) for services that failed.
request_id
string<uuid>
Persisted session id when save_api_request=true (usable with GET /v3/session/{sessionId}/decision/); otherwise a transient correlation UUID.
database_validation
object
Show child attributes
vendor_data
string | null
Echo of the vendor_data you sent.
metadata
object | null
Echo of the metadata you sent.
created_at
string<date-time>
Last modified on November 1, 2026
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Didit Docs","description":"The best way to integrate identity and fraud checks into your app. One API, four product lines (KYC · KYB · Transaction Monitoring · Wallet Screening), 220+ countries, 14,000+ documents, sub-2s inference, $10 free credit/month.","colors":{"primary":"#2567FF","light":"#90B1FF","dark":"#1B4FE0"},"logo":{"light":"https://mintcdn.com/didit-0f962782/dCzNNoYCusBNdK3I/logo/didit.svg?fit=max\u0026auto=format\u0026n=dCzNNoYCusBNdK3I\u0026q=85\u0026s=9f162fb8295fa1fd9300a24b293ce0b7","dark":"https://mintcdn.com/didit-0f962782/TefoKXCbZA_GIK5a/logo/didit-logo-wordmark-white.svg?fit=max\u0026auto=format\u0026n=TefoKXCbZA_GIK5a\u0026q=85\u0026s=c8c541689c814ca6a2c873cf6185a3a7","href":"https://docs.didit.me"},"favicon":"https://mintcdn.com/didit-0f962782/t6r0B-WdGMU5mSS-/favicon.ico?fit=max\u0026auto=format\u0026n=t6r0B-WdGMU5mSS-\u0026q=85\u0026s=b291917b960ebe959ae3b1aa233eafa8","api":{"examples":{"prefill":true},"mdx":{"auth":{"method":"key","name":"x-api-key"},"server":"https://verification.didit.me"}},"background":{"color":{"light":"#FFFFFF","dark":"#1A1A1A"}},"navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Support"},{"icon":"signal","href":"https://status.didit.me","label":"Status"}],"primary":{"type":"button","label":"Sign in","href":"https://business.didit.me"}},"footer":{"socials":{"x":"https://x.com/didit","github":"https://github.com/didit-protocol","linkedin":"https://linkedin.com/company/91001155","website":"https://didit.me"}},"search":{"prompt":"Search Didit docs..."},"seo":{"metatags":{"twitter:site":"@didit","theme-color":"#2567FF","apple-mobile-web-app-title":"Didit Docs"},"organization":{"id":"https://didit.me/#organization","name":"Didit","legalName":"Didit Protocol","url":"https://didit.me","logo":"https://didit.me/logos/primary-horizontal-light.png","sameAs":["https://www.linkedin.com/company/91001155","https://www.youtube.com/@getdidit","https://github.com/didit-protocol","https://x.com/didit"]},"indexing":"navigable"},"fonts":{"heading":{"family":"Inter","weight":500},"body":{"family":"Inter","weight":400}},"errors":{"404":{"redirect":false,"title":"Page not found","description":"This page moved or never existed. [Back to docs](/)"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"light","background":"https://mintcdn.com/didit-0f962782/Xkecx-xLq1K2abHK/images/og-thumbnail-backplate.png?fit=max\u0026auto=format\u0026n=Xkecx-xLq1K2abHK\u0026q=85\u0026s=c699fa252554b2ac8d4c631e209a1473","fonts":{"family":"Inter"}},"metadata":{"timestamp":true},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","href":""},{"language":"es","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Soporte"},{"icon":"signal","href":"https://status.didit.me","label":"Estado"}],"primary":{"type":"button","label":"Iniciar sesión","href":"https://business.didit.me"}},"href":"es"},{"language":"pt-BR","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Suporte"},{"icon":"signal","href":"https://status.didit.me","label":"Status"}],"primary":{"type":"button","label":"Entrar","href":"https://business.didit.me"}},"href":"pt-br"},{"language":"ja","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"サポート"},{"icon":"signal","href":"https://status.didit.me","label":"ステータス"}],"primary":{"type":"button","label":"サインイン","href":"https://business.didit.me"}},"href":"ja"},{"language":"de","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Support"},{"icon":"signal","href":"https://status.didit.me","label":"Status"}],"primary":{"type":"button","label":"Anmelden","href":"https://business.didit.me"}},"href":"de"},{"language":"fr","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Assistance"},{"icon":"signal","href":"https://status.didit.me","label":"Statut"}],"primary":{"type":"button","label":"Se connecter","href":"https://business.didit.me"}},"href":"fr"},{"language":"it","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Supporto"},{"icon":"signal","href":"https://status.didit.me","label":"Stato"}],"primary":{"type":"button","label":"Accedi","href":"https://business.didit.me"}},"href":"it"},{"language":"pt","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Suporte"},{"icon":"signal","href":"https://status.didit.me","label":"Estado"}],"primary":{"type":"button","label":"Iniciar sessão","href":"https://business.didit.me"}},"href":"pt"},{"language":"ca","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Suport"},{"icon":"signal","href":"https://status.didit.me","label":"Estat"}],"primary":{"type":"button","label":"Inicia la sessió","href":"https://business.didit.me"}},"href":"ca"},{"language":"id","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Dukungan"},{"icon":"signal","href":"https://status.didit.me","label":"Status"}],"primary":{"type":"button","label":"Masuk","href":"https://business.didit.me"}},"href":"id"},{"language":"ru","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Поддержка"},{"icon":"signal","href":"https://status.didit.me","label":"Статус"}],"primary":{"type":"button","label":"Вход","href":"https://business.didit.me"}},"href":"ru"},{"language":"ko","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"지원"},{"icon":"signal","href":"https://status.didit.me","label":"상태"}],"primary":{"type":"button","label":"로그인","href":"https://business.didit.me"}},"href":"ko"},{"language":"zh","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"支持"},{"icon":"signal","href":"https://status.didit.me","label":"状态"}],"primary":{"type":"button","label":"登录","href":"https://business.didit.me"}},"href":"zh"},{"language":"ar","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"الدعم"},{"icon":"signal","href":"https://status.didit.me","label":"الحالة"}],"primary":{"type":"button","label":"تسجيل الدخول","href":"https://business.didit.me"}},"href":"ar"},{"language":"hi","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"सहायता"},{"icon":"signal","href":"https://status.didit.me","label":"स्थिति"}],"primary":{"type":"button","label":"साइन इन करें","href":"https://business.didit.me"}},"href":"hi"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"didit-0f962782","hasAudioNarration":false,"actualSubdomain":"didit-0f962782","customDomains":["docs.didit.me"],"gitSource":{"type":"github","owner":"didit-protocol","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afb3c50f20ad22eaaf0629a","clientVersion":"0.0.4149","searchFilterCounts":[{"language":"ar","tag":"مرجع API","count":440},{"language":"ca","tag":"Referència de l'API","count":440},{"language":"de","tag":"API-Referenz","count":440},{"language":"es","tag":"Referencia de la API","count":440},{"language":"fr","tag":"Référence API","count":440},{"language":"hi","tag":"API संदर्भ","count":440},{"language":"id","tag":"Referensi API","count":440},{"language":"it","tag":"Riferimento API","count":440},{"language":"ja","tag":"APIリファレンス","count":440},{"language":"ko","tag":"API 레퍼런스","count":440},{"language":"pt-BR","tag":"Referência da API","count":440},{"language":"pt","tag":"Referência da API","count":440},{"language":"ru","tag":"Справочник API","count":440},{"language":"zh","tag":"API 参考","count":440},{"language":"en","tag":"API Reference","count":432},{"language":"en","tag":"Database Validation","count":129},{"language":"ar","tag":"التحقق من قواعد البيانات","count":129},{"language":"ca","tag":"Validació en bases de dades","count":129},{"language":"de","tag":"Datenbankvalidierung","count":129},{"language":"es","tag":"Validación de base de datos","count":129},{"language":"fr","tag":"Validation en base de données","count":129},{"language":"hi","tag":"डेटाबेस सत्यापन","count":129},{"language":"id","tag":"Validasi Database","count":129},{"language":"it","tag":"Validazione su database","count":129},{"language":"ja","tag":"データベース検証","count":129},{"language":"ko","tag":"데이터베이스 검증","count":129},{"language":"pt-BR","tag":"Validação de banco de dados","count":129},{"language":"pt","tag":"Validação de base de dados","count":129},{"language":"ru","tag":"Проверка по базам данных","count":129},{"language":"zh","tag":"数据库核验","count":129},{"language":"ca","tag":"Primers passos","count":93},{"language":"de","tag":"Erste Schritte","count":93},{"language":"es","tag":"Primeros pasos","count":93},{"language":"ja","tag":"はじめに","count":93},{"language":"ko","tag":"시작하기","count":93},{"language":"pt-BR","tag":"Primeiros passos","count":93},{"language":"ru","tag":"Начало работы","count":93},{"language":"en","tag":"Get Started","count":87},{"language":"ar","tag":"ابدأ الآن","count":87},{"language":"fr","tag":"Commencer","count":87},{"language":"hi","tag":"शुरू करें","count":87},{"language":"id","tag":"Mulai","count":87},{"language":"it","tag":"Inizia","count":87},{"language":"pt","tag":"Começar","count":87},{"language":"zh","tag":"快速开始","count":87},{"language":"ko","tag":"인증","count":85},{"language":"en","tag":"User Verification","count":74},{"language":"ar","tag":"التحقق من المستخدمين","count":74},{"language":"ca","tag":"Verificació d'usuaris","count":74},{"language":"de","tag":"Benutzerverifizierung","count":74},{"language":"es","tag":"Verificación de usuarios","count":74},{"language":"fr","tag":"Vérification des utilisateurs","count":74},{"language":"hi","tag":"उपयोगकर्ता सत्यापन","count":74},{"language":"id","tag":"Verifikasi Pengguna","count":74},{"language":"it","tag":"Verifica degli utenti","count":74},{"language":"ja","tag":"ユーザー認証","count":74},{"language":"ko","tag":"사용자 인증","count":74},{"language":"pt-BR","tag":"Verificação de usuários","count":74},{"language":"pt","tag":"Verificação de utilizadores","count":74},{"language":"ru","tag":"Проверка пользователей","count":74},{"language":"zh","tag":"用户验证","count":74},{"language":"en","tag":"Integrate / SDKs","count":67},{"language":"ar","tag":"التكامل / SDKs","count":67},{"language":"ca","tag":"Integració / SDK","count":67},{"language":"de","tag":"Integrieren / SDKs","count":67},{"language":"es","tag":"Integración / SDKs","count":67},{"language":"fr","tag":"Intégrer / SDK","count":67},{"language":"hi","tag":"इंटीग्रेट करें / SDK","count":67},{"language":"id","tag":"Integrasi / SDK","count":67},{"language":"it","tag":"Integrazione / SDK","count":67},{"language":"ja","tag":"連携 / SDK","count":67},{"language":"ko","tag":"연동 / SDK","count":67},{"language":"pt-BR","tag":"Integração / SDKs","count":67},{"language":"pt","tag":"Integrar / SDKs","count":67},{"language":"ru","tag":"Интеграция / SDK","count":67},{"language":"zh","tag":"集成 / SDK","count":67},{"language":"en","tag":"Travel Rule","count":58},{"language":"ar","tag":"Travel Rule","count":58},{"language":"ca","tag":"Travel Rule","count":58},{"language":"de","tag":"Travel Rule","count":58},{"language":"es","tag":"Travel Rule","count":58},{"language":"fr","tag":"Travel Rule","count":58},{"language":"hi","tag":"Travel Rule","count":58},{"language":"id","tag":"Travel Rule","count":58},{"language":"it","tag":"Travel Rule","count":58},{"language":"ja","tag":"トラベルルール","count":58},{"language":"ko","tag":"Travel Rule","count":58},{"language":"pt-BR","tag":"Travel Rule","count":58},{"language":"pt","tag":"Travel Rule","count":58},{"language":"ru","tag":"Travel Rule","count":58},{"language":"zh","tag":"Travel Rule","count":58},{"language":"en","tag":"Verification","count":48},{"language":"ar","tag":"التحقق","count":48},{"language":"ca","tag":"Verificació","count":48},{"language":"de","tag":"Verifizierung","count":48},{"language":"es","tag":"Verificación","count":48},{"language":"fr","tag":"Vérification","count":48},{"language":"hi","tag":"सत्यापन","count":48},{"language":"id","tag":"Verifikasi","count":48},{"language":"it","tag":"Verifica","count":48},{"language":"ja","tag":"検証","count":48},{"language":"pt-BR","tag":"Verificação","count":48},{"language":"pt","tag":"Verificação","count":48},{"language":"ru","tag":"Верификация","count":48},{"language":"zh","tag":"验证","count":48},{"language":"en","tag":"Authentication","count":37},{"language":"ar","tag":"المصادقة","count":37},{"language":"ca","tag":"Autenticació","count":37},{"language":"de","tag":"Authentifizierung","count":37},{"language":"es","tag":"Autenticación","count":37},{"language":"fr","tag":"Authentification","count":37},{"language":"hi","tag":"प्रमाणीकरण","count":37},{"language":"id","tag":"Autentikasi","count":37},{"language":"it","tag":"Autenticazione","count":37},{"language":"ja","tag":"認証","count":37},{"language":"pt-BR","tag":"Autenticação","count":37},{"language":"pt","tag":"Autenticação","count":37},{"language":"ru","tag":"Аутентификация","count":37},{"language":"zh","tag":"身份认证","count":37},{"language":"en","tag":"Digital ID wallets","count":35},{"language":"en","tag":"User and Business Verifications","count":35},{"language":"ar","tag":"محافظ الهوية الرقمية","count":35},{"language":"ar","tag":"التحقق من المستخدمين والشركات","count":35},{"language":"ca","tag":"Carteres d'identitat digital","count":35},{"language":"ca","tag":"Verificacions d'usuaris i empreses","count":35},{"language":"de","tag":"Digitale ID-Wallets","count":35},{"language":"de","tag":"Benutzer- und Unternehmensverifizierungen","count":35},{"language":"es","tag":"Wallets de identidad digital","count":35},{"language":"es","tag":"Verificaciones de usuarios y empresas","count":35},{"language":"fr","tag":"Portefeuilles d'identité numérique","count":35},{"language":"fr","tag":"Vérifications des utilisateurs et des entreprises","count":35},{"language":"hi","tag":"डिजिटल ID वॉलेट","count":35},{"language":"hi","tag":"उपयोगकर्ता और व्यवसाय सत्यापन","count":35},{"language":"id","tag":"Dompet ID Digital","count":35},{"language":"id","tag":"Verifikasi Pengguna dan Bisnis","count":35},{"language":"it","tag":"Wallet di identità digitale","count":35},{"language":"it","tag":"Verifiche di utenti e aziende","count":35},{"language":"ja","tag":"デジタルIDウォレット","count":35},{"language":"ja","tag":"ユーザーと企業の認証","count":35},{"language":"ko","tag":"디지털 신분증 지갑","count":35},{"language":"ko","tag":"사용자 인증 및 기업 확인","count":35},{"language":"pt-BR","tag":"Carteiras de identidade digital","count":35},{"language":"pt-BR","tag":"Verificações de usuários e empresas","count":35},{"language":"pt","tag":"Carteiras de identidade digital","count":35},{"language":"pt","tag":"Verificações de utilizadores e empresas","count":35},{"language":"ru","tag":"Цифровые ID-кошельки","count":35},{"language":"ru","tag":"Верификация пользователей и компаний","count":35},{"language":"zh","tag":"数字身份钱包","count":35},{"language":"zh","tag":"用户与企业验证","count":35},{"language":"ko","tag":"거래 모니터링","count":28}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/_mintlify/custom/didit-0f962782/714dd91730ddd114/style.css"}],"page":{"pagePath":"standalone-apis/database-validation","slug":"/standalone-apis/database-validation","pageMetadata":{"title":"Database Validation API: National ID Match","sidebarTitle":"Database Validation API","description":"POST /v3/database-validation/ to validate identity data against 100+ national and global sources with 1x1 and 2x2 waterfall matching. Pay-per-call.","keywords":["database validation API","identity database API","KYC database check","national ID validation","government and authoritative database API","identity verification API","waterfall providers","2x2 matching","Trulioo alternative","Didit API"],"openapi":"openapi-25.json POST /v3/database-validation/","href":"/standalone-apis/database-validation"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"POST /v3/database-validation/ to validate identity data against 100+ national and global sources with 1x1 and 2x2 waterfall matching. Pay-per-call.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`address-based-services`,children:`Address-based services`}),`\n`,_jsxs(_components.p,{children:[`For services that validate a residential or utility address, you can send a single `,_jsx(_components.code,{children:`address`}),` and Didit will split it before processing the check. For the best match rate, send structured Didit address fields directly:`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`address_element_1`})}),_jsx(_components.td,{children:`Street address, including number and street type`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`address_element_2`})}),_jsx(_components.td,{children:`Optional unit, building, floor, or extra address line`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`address_element_3`})}),_jsx(_components.td,{children:`Suburb, district, locality, or neighborhood`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`address_element_4`})}),_jsx(_components.td,{children:`City, town, state, province, or region`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`address_element_5`})}),_jsx(_components.td,{children:`Postcode or postal code`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Structured fields override the single `,_jsx(_components.code,{children:`address`}),` value. `,_jsx(_components.code,{children:`postal_code`}),` is accepted as an alias for `,_jsx(_components.code,{children:`address_element_5`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`consent`,children:`Consent`}),`\n`,_jsxs(_components.p,{children:[`Some database services require explicit end-user consent before the provider can be queried. The service catalog marks these rows with `,_jsx(_components.code,{children:`requires_consent=true`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Send `,_jsx(_components.code,{children:`consent=true`}),` when the user consent applies to the selected services.`]}),`\n`,_jsx(_components.p,{children:`Didit rejects the request before any provider call or billing event if a selected service requires consent and you do not send it.`}),`\n`,_jsx(Heading,{level:`2`,id:`file-uploads`,children:`File uploads`}),`\n`,_jsxs(_components.p,{children:[`Database validation uses `,_jsx(_components.code,{children:`multipart/form-data`}),`. Biometric services that require `,_jsx(_components.code,{children:`selfie`}),` expose it as a file upload field in the API playground, so you can select an image directly instead of pasting a path or base64 string.`]}),`\n`,_jsx(_components.p,{children:`In code, upload the file with normal multipart syntax:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`-F`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"selfie=@./selfie.jpg\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`validation-errors`,children:`Validation errors`}),`\n`,_jsxs(_components.p,{children:[`Didit validates required fields, address structure, and service-specific formats before calling the provider. For example, China registry services such as `,_jsx(_components.code,{children:`chn_national_id`}),` and `,_jsx(_components.code,{children:`chn_passport_verification`}),` expect `,_jsx(_components.code,{children:`full_name`}),` in the original Chinese script, and `,_jsx(_components.code,{children:`chn_national_id`}),` also requires a valid 15- or 18-character Chinese national ID with a correct checksum.`]}),`\n`,_jsxs(_components.p,{children:[`If a request cannot run, the API returns explicit field errors and no usage is billed. If a provider fails after preflight, the response includes `,_jsx(_components.code,{children:`validation_errors`}),`, and saved API requests store those errors in the database validation result.`]}),`\n`,_jsx(Heading,{level:`2`,id:`rejected-input-and-unavailable-results`,children:`Rejected input and unavailable results`}),`\n`,_jsxs(_components.p,{children:[`When no service returns a usable result, inspect each `,_jsx(_components.code,{children:`validation_errors`}),` entry before deciding whether to retry.\nThe HTTP status alone does not determine whether retrying is appropriate.\nA `,_jsx(_components.code,{children:`400`}),` response with `,_jsx(_components.code,{children:`code: \"provider_rejected_input\"`}),` and `,_jsx(_components.code,{children:`retryable: false`}),` means every unanswered attempt explicitly refused the input.\nCorrect the supplied data before trying again.\nThese attempts are not billed.`]}),`\n`,_jsxs(_components.p,{children:[`A `,_jsx(_components.code,{children:`502`}),` response with `,_jsx(_components.code,{children:`code: \"empty_provider_response\"`}),` and `,_jsx(_components.code,{children:`retryable: true`}),` means the service could not produce a usable result for another reason.\nThis includes a refused input followed by an unavailable fallback or a fallback that provides no explanation.\nRetry later; the response does not establish that the input is wrong.\nIf a database keeps failing, Didit emails the organizations that recently used it once the interruption is sustained, and again when real checks confirm it is answering — see `,_jsx(_components.a,{href:`/core-technology/database-validation/overview#availability-notifications`,children:`Availability notifications`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`When only some of the selected services fail, the request succeeds instead: the response is `,_jsx(_components.code,{children:`200`}),` and the failed services are listed under `,_jsx(_components.code,{children:`database_validation.errors[]`}),`, each with the same `,_jsx(_components.code,{children:`code`}),` and `,_jsx(_components.code,{children:`retryable`}),` fields.\n`,_jsx(_components.code,{children:`database_validation.status`}),` then follows the services that did answer and can be `,_jsx(_components.code,{children:`Approved`}),`, so inspect `,_jsx(_components.code,{children:`errors[]`}),` on every response and not only on a `,_jsx(_components.code,{children:`4xx`}),` or `,_jsx(_components.code,{children:`5xx`}),`.\nA service reported there is absent from `,_jsx(_components.code,{children:`validations`}),` and `,_jsx(_components.code,{children:`services_used`}),`, and is not billed; retry that service on its own.`]}),`\n`,_jsxs(_components.p,{children:[`Other `,_jsx(_components.code,{children:`502`}),` errors can require corrected input.\nFor example, `,_jsx(_components.code,{children:`provider_invalid_input`}),` and `,_jsx(_components.code,{children:`provider_validation_error`}),` describe input the source rejected and must not be retried unchanged, even when the legacy response omits `,_jsx(_components.code,{children:`retryable`}),`.\nThe retry guidance for `,_jsx(_components.code,{children:`empty_provider_response`}),` does not apply to these codes.\nA conclusive no-match result is a completed check, not an availability failure.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Database Validation API: National ID Match","sidebarTitle":"Database Validation API","description":"POST /v3/database-validation/ to validate identity data against 100+ national and global sources with 1x1 and 2x2 waterfall matching. Pay-per-call.","keywords":["database validation API","identity database API","KYC database check","national ID validation","government and authoritative database API","identity verification API","waterfall providers","2x2 matching","Trulioo alternative","Didit API"],"openapi":"openapi-25.json POST /v3/database-validation/","href":"/standalone-apis/database-validation"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Address-based services","slug":"address-based-services","depth":2,"children":[]},{"title":"Consent","slug":"consent","depth":2,"children":[]},{"title":"File uploads","slug":"file-uploads","depth":2,"children":[]},{"title":"Validation errors","slug":"validation-errors","depth":2,"children":[]},{"title":"Rejected input and unavailable results","slug":"rejected-input-and-unavailable-results","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/didit-0f962782/75622e87c9213fdc/snippets/data/database-validation-coverage.js","/_mintlify/custom/didit-0f962782/4ac7d3c2a19a354d/database-validation-playground.js"],"openApiReferenceData":{"operation":{"summary":"Database Validation (standalone)","operationId":"post_v3database-validation","x-didit-sdk":{"resource":"database_validation","method":"validate","auth":"api_key","server":true},"tags":["Standalone APIs"],"security":["5b3b12d3-4594-4967-b02a-fe03125fa19f"],"parameters":["c29946af-11a6-4b78-b789-2ef792dde466"],"description":"POST /v3/database-validation/ to validate identity data against 100+ national and global sources with 1x1 and 2x2 waterfall matching. Pay-per-call.","requestBody":"d577a7c1-a150-4fa5-a2f7-6e18b0970307","x-codeSamples":[{"lang":"curl","label":"curl","source":"curl -X POST https://verification.didit.me/v3/database-validation/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"issuing_state\": \"BRA\",\n \"services\": [\"bra_cpf\"],\n \"identification_number\": \"12345678900\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1980-01-01\",\n \"vendor_data\": \"user-1234\"\n }'"},{"lang":"python","label":"Python","source":"from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.database_validation.validate(\n issuing_state=\"BRA\",\n services=[\"bra_cpf\"],\n identification_number=\"12345678900\",\n first_name=\"John\",\n last_name=\"Doe\",\n date_of_birth=\"1980-01-01\",\n vendor_data=\"user-1234\",\n)\nprint(result)"},{"lang":"javascript","label":"Node.js","source":"import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.databaseValidation.validate({\n issuing_state: \"BRA\",\n services: [\"bra_cpf\"],\n identification_number: \"12345678900\",\n first_name: \"John\",\n last_name: \"Doe\",\n date_of_birth: \"1980-01-01\",\n vendor_data: \"user-1234\",\n});\nconsole.log(result);"},{"lang":"go","label":"Go","source":"ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.DatabaseValidation.Validate(ctx, didit.DatabaseValidationValidateParams{\n\tIssuingState: \"BRA\",\n\tServices: didit.Some([]string{\"bra_cpf\"}),\n\tIdentificationNumber: didit.String(\"12345678900\"),\n\tFirstName: didit.String(\"John\"),\n\tLastName: didit.String(\"Doe\"),\n\tDateOfBirth: didit.String(\"1980-01-01\"),\n\tVendorData: didit.String(\"user-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"},{"lang":"java","label":"Java","source":"import java.time.LocalDate;\nimport java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.DatabaseValidationValidateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.databaseValidation().validate(DatabaseValidationValidateParams.builder()\n .issuingState(\"BRA\")\n .services(List.of(\"bra_cpf\"))\n .identificationNumber(\"12345678900\")\n .firstName(\"John\")\n .lastName(\"Doe\")\n .dateOfBirth(LocalDate.parse(\"1980-01-01\"))\n .vendorData(\"user-1234\")\n .build());\nSystem.out.println(result);"},{"lang":"php","label":"PHP","source":"\u003c?php\n\nrequire 'vendor/autoload.php';\n\nuse Didit\\DiditClient;\n\n// Reads DIDIT_API_KEY.\n$didit = new DiditClient();\n\n$result = $didit->databaseValidation->validate([\n 'issuing_state' => 'BRA',\n 'services' => ['bra_cpf'],\n 'identification_number' => '12345678900',\n 'first_name' => 'John',\n 'last_name' => 'Doe',\n 'date_of_birth' => '1980-01-01',\n 'vendor_data' => 'user-1234',\n]);\nprint_r($result->toArray());"},{"lang":"ruby","label":"Ruby","source":"require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.database_validation.validate(\n issuing_state: \"BRA\",\n services: [\"bra_cpf\"],\n identification_number: \"12345678900\",\n first_name: \"John\",\n last_name: \"Doe\",\n date_of_birth: \"1980-01-01\",\n vendor_data: \"user-1234\"\n)\nputs result.to_h"},{"lang":"csharp","label":".NET","source":"using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.DatabaseValidation.ValidateAsync(new DatabaseValidationValidateParams\n{\n IssuingState = \"BRA\",\n Services = new string[] { \"bra_cpf\" },\n IdentificationNumber = \"12345678900\",\n FirstName = \"John\",\n LastName = \"Doe\",\n DateOfBirth = \"1980-01-01\",\n VendorData = \"user-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));"}],"responses":{"200":"90c27a2d-ad54-4a18-b480-f101d7444426","400":"cef58e24-9bc5-4792-b1f8-3ae04f102344","403":"26c8a33d-9100-486f-869a-1e07d5c0590b","429":"04096caf-a3a8-4cbd-a4b3-ae046312c338","502":"9d1aa012-bba2-479f-a7af-9179eb34db46"},"method":"post","type":"path","servers":["9175aafc-0880-48bd-9d74-3d26d6c81029"],"path":"/v3/database-validation/","baseUrlOptions":["https://verification.didit.me"],"title":"Database Validation (standalone)","codeSamples":[{"label":"curl","lang":"curl","source":"curl -X POST https://verification.didit.me/v3/database-validation/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"issuing_state\": \"BRA\",\n \"services\": [\"bra_cpf\"],\n \"identification_number\": \"12345678900\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1980-01-01\",\n \"vendor_data\": \"user-1234\"\n }'"},{"label":"Python","lang":"python","source":"from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.database_validation.validate(\n issuing_state=\"BRA\",\n services=[\"bra_cpf\"],\n identification_number=\"12345678900\",\n first_name=\"John\",\n last_name=\"Doe\",\n date_of_birth=\"1980-01-01\",\n vendor_data=\"user-1234\",\n)\nprint(result)"},{"label":"Node.js","lang":"javascript","source":"import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.databaseValidation.validate({\n issuing_state: \"BRA\",\n services: [\"bra_cpf\"],\n identification_number: \"12345678900\",\n first_name: \"John\",\n last_name: \"Doe\",\n date_of_birth: \"1980-01-01\",\n vendor_data: \"user-1234\",\n});\nconsole.log(result);"},{"label":"Go","lang":"go","source":"ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.DatabaseValidation.Validate(ctx, didit.DatabaseValidationValidateParams{\n\tIssuingState: \"BRA\",\n\tServices: didit.Some([]string{\"bra_cpf\"}),\n\tIdentificationNumber: didit.String(\"12345678900\"),\n\tFirstName: didit.String(\"John\"),\n\tLastName: didit.String(\"Doe\"),\n\tDateOfBirth: didit.String(\"1980-01-01\"),\n\tVendorData: didit.String(\"user-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"},{"label":"Java","lang":"java","source":"import java.time.LocalDate;\nimport java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.DatabaseValidationValidateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.databaseValidation().validate(DatabaseValidationValidateParams.builder()\n .issuingState(\"BRA\")\n .services(List.of(\"bra_cpf\"))\n .identificationNumber(\"12345678900\")\n .firstName(\"John\")\n .lastName(\"Doe\")\n .dateOfBirth(LocalDate.parse(\"1980-01-01\"))\n .vendorData(\"user-1234\")\n .build());\nSystem.out.println(result);"},{"label":"PHP","lang":"php","source":"\u003c?php\n\nrequire 'vendor/autoload.php';\n\nuse Didit\\DiditClient;\n\n// Reads DIDIT_API_KEY.\n$didit = new DiditClient();\n\n$result = $didit->databaseValidation->validate([\n 'issuing_state' => 'BRA',\n 'services' => ['bra_cpf'],\n 'identification_number' => '12345678900',\n 'first_name' => 'John',\n 'last_name' => 'Doe',\n 'date_of_birth' => '1980-01-01',\n 'vendor_data' => 'user-1234',\n]);\nprint_r($result->toArray());"},{"label":"Ruby","lang":"ruby","source":"require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.database_validation.validate(\n issuing_state: \"BRA\",\n services: [\"bra_cpf\"],\n identification_number: \"12345678900\",\n first_name: \"John\",\n last_name: \"Doe\",\n date_of_birth: \"1980-01-01\",\n vendor_data: \"user-1234\"\n)\nputs result.to_h"},{"label":".NET","lang":"csharp","source":"using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.DatabaseValidation.ValidateAsync(new DatabaseValidationValidateParams\n{\n IssuingState = \"BRA\",\n Services = new string[] { \"bra_cpf\" },\n IdentificationNumber = \"12345678900\",\n FirstName = \"John\",\n LastName = \"Doe\",\n DateOfBirth = \"1980-01-01\",\n VendorData = \"user-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.issuing_state":"BRA","body.services.items.0":"bra_cpf","body.identification_number":"12345678900","body.first_name":"John","body.last_name":"Doe","body.date_of_birth":"1980-01-01","body.vendor_data":"user-1234"}]},"dependencies":{"parameters":{"c29946af-11a6-4b78-b789-2ef792dde466":{"name":"Idempotency-Key","in":"header","required":false,"description":"Optional retry-safety key you choose for one operation, up to 255 characters (a UUID works). A request repeated with the same key, endpoint, query and body is answered with the first response, same status and same body, and runs and bills nothing a second time. The same key with another endpoint, query or body returns `409` `idempotency_key_reused`, and while the first request is still running, `409` `idempotency_key_in_progress` with `Retry-After`. A failed request (any `4xx` or `5xx`) is not stored, so you can send it again with the same key. Keys belong to your application, whether you call with an API key or an access token. See [Retries and idempotency](/integration/api-errors#retries-and-idempotency).","schema":{"type":"string","minLength":1,"maxLength":255,"isRequired":false,"description":"Optional retry-safety key you choose for one operation, up to 255 characters (a UUID works). A request repeated with the same key, endpoint, query and body is answered with the first response, same status and same body, and runs and bills nothing a second time. The same key with another endpoint, query or body returns `409` `idempotency_key_reused`, and while the first request is still running, `409` `idempotency_key_in_progress` with `Retry-After`. A failed request (any `4xx` or `5xx`) is not stored, so you can send it again with the same key. Keys belong to your application, whether you call with an API key or an access token. See [Retries and idempotency](/integration/api-errors#retries-and-idempotency).","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["issuing_state"],"properties":{"issuing_state":{"type":"string","description":"ISO 3166-1 **alpha-3** country code of the registry to validate against (e.g. `BRA`, `ESP`, `COL`). Determines which services are available. Unsupported codes return `400` with the full list of valid options.","example":"BRA","isRequired":true,"uniqueKey":"issuing_state","typeLabel":"string"},"services":{"type":"array","items":{"type":"string","uniqueKey":"services.items.[INDEX]","typeLabel":"string"},"description":"Catalog `service_id`s to run for this country (e.g. `[\"bra_cpf\"]`). Also accepts a single string or a comma-separated/JSON-encoded string. **If omitted or empty, exactly one default service runs** — the longest-established live service for the country; newer, biometric, and pay-as-you-go services must be named explicitly. Sending `services` switches the response to the extended shape (adds `services_used` and `match_score`). Every id must exist and be live for the `issuing_state`; services that require onboarding return `400` until activated for your organization. Discover available services per country via `GET /v1/organization/database-validation-countries/` (a catalog endpoint not documented in this spec) or the Business Console workflow editor.","example":["bra_cpf"],"uniqueKey":"services","typeLabel":"string[]"},"validation_type":{"type":"string","deprecated":true,"description":"DEPRECATED. Accepted for backward compatibility but ignored — the response `validation_type` is now derived from how many services full-matched. Use `services` to pin specific services.","uniqueKey":"validation_type","typeLabel":"string"},"consent":{"type":"boolean","default":false,"description":"Set to `true` when the end user has explicitly consented to the selected validation services. Required for services flagged `requires_consent=true` in the catalog — without it those services return `400` with `services_requiring_consent`.","uniqueKey":"consent","typeLabel":"boolean"},"electoral_roll_only":{"type":"boolean","default":false,"description":"Paraguay (`pry_cedula`) only. Set to `true` to check the cédula against the TSJE electoral roll alone. The electoral roll lists only citizens aged 18 or over, so a `MATCH` also confirms that the holder is an adult, and a cédula that is not on the roll returns `DOCUMENT_NOT_FOUND`. Defaults to `false`, which also checks the DNIT taxpayer register for wider identity coverage but cannot confirm age. Any other service rejects it with `400`.","uniqueKey":"electoral_roll_only","typeLabel":"boolean"},"identification_number":{"type":"string","description":"Universal identification number — automatically mapped to the correct country-specific field, so you can use it instead of `personal_number`/`tax_number`/`document_number`: ARG→document_number (DNI), BOL→document_number (CI), BRA→tax_number (CPF, 11 digits), CHL→personal_number (RUT), COL→personal_number (Cédula), CRI→personal_number (Cédula), DOM→personal_number (Cédula, 11 digits), ECU→personal_number (Cédula, 10 digits), ESP→personal_number (DNI/NIE), GTM→document_number (DPI), HND→document_number (DNI), MEX→personal_number (CURP, 18 chars), PAN→personal_number (Cédula), PER→personal_number (DNI, 8 digits), PRY→document_number (CI), SLV→document_number (DUI), URY→personal_number (CI), VEN→document_number (Cédula). It never overrides an explicitly provided country-specific field.","uniqueKey":"identification_number","typeLabel":"string"},"first_name":{"type":"string","description":"The individual's first name. Required by some services/countries.","example":"John","uniqueKey":"first_name","typeLabel":"string"},"last_name":{"type":"string","description":"The individual's last name. Required by some services/countries.","example":"Doe","uniqueKey":"last_name","typeLabel":"string"},"middle_name":{"type":"string","description":"Middle name, used by some country services (AUS, NZL, …).","uniqueKey":"middle_name","typeLabel":"string"},"full_name":{"type":"string","description":"Full name — some services accept this in lieu of first/last name (e.g. CHN services, which match the native-script name).","uniqueKey":"full_name","typeLabel":"string"},"date_of_birth":{"type":"string","format":"date","description":"Date of birth, `YYYY-MM-DD`. Required by many services.","example":"1980-01-01","uniqueKey":"date_of_birth","typeLabel":"string\u003cdate>"},"personal_number":{"type":"string","description":"Government-issued unique personal identifier. Used by: CHL (RUT), COL (Cédula), CRI, DOM, ECU, ESP (DNI/NIE), MEX (CURP), PAN (Cédula), PER (DNI), URY. Consider `identification_number` instead.","uniqueKey":"personal_number","typeLabel":"string"},"tax_number":{"type":"string","description":"Tax identification number. Used by: BRA (CPF, 11 digits). Consider `identification_number` instead.","uniqueKey":"tax_number","typeLabel":"string"},"document_number":{"type":"string","description":"Document number. Used by: ARG (DNI), BOL (CI), GTM (DPI), HND (DNI), PRY (CI), SLV (DUI), VEN (Cédula). Consider `identification_number` instead.","uniqueKey":"document_number","typeLabel":"string"},"document_type":{"type":"string","enum":["P","DL","ID","RP","SSC","HIC","WP","TC","VISA","PSC","BC","OTHER"],"description":"Type of document being validated: `P` passport, `DL` driver license, `ID` national ID, `RP` residence permit (plus `SSC`, `HIC`, `WP`, `TC`, `VISA`, `PSC`, `BC`, `OTHER`). Required by some services (e.g. ESP).","uniqueKey":"document_type","typeLabel":"enum\u003cstring>"},"expiration_date":{"type":"string","format":"date","description":"Document expiration date, `YYYY-MM-DD`. Required for ESP (Spain) validation.","example":"2030-01-15","uniqueKey":"expiration_date","typeLabel":"string\u003cdate>"},"date_of_issue":{"type":"string","format":"date","description":"Document issue date, `YYYY-MM-DD` (fecha de expedición). Required for COL (Colombia) cédula validation.","example":"2015-06-20","uniqueKey":"date_of_issue","typeLabel":"string\u003cdate>"},"nationality":{"type":"string","description":"Nationality as ISO 3166-1 alpha-3. Required by some services.","uniqueKey":"nationality","typeLabel":"string"},"gender":{"type":"string","enum":["M","F","X"],"description":"Gender: `M`, `F`, or `X` (other/unknown). Required for Argentina's RENAPER validation (`arg_renaper`).","uniqueKey":"gender","typeLabel":"enum\u003cstring>"},"address":{"oneOf":[{"type":"object","description":"Residential address. Prefer the structured object `{\"street_1\":\"123 Main St\",\"street_2\":\"Apt 4B\",\"city\":\"Springfield\",\"region\":\"IL\",\"postal_code\":\"62701\",\"country\":\"US\"}`; a complete single-line string is still accepted. Required by address-verification services; when a service defines address requirements, missing parts return `400` with `address_fields_required_by`.","properties":{"street_1":{"type":"string","uniqueKey":"address.oneOf.0.street_1","typeLabel":"string"},"street_2":{"type":"string","uniqueKey":"address.oneOf.0.street_2","typeLabel":"string"},"city":{"type":"string","uniqueKey":"address.oneOf.0.city","typeLabel":"string"},"region":{"type":"string","uniqueKey":"address.oneOf.0.region","typeLabel":"string"},"postal_code":{"type":"string","uniqueKey":"address.oneOf.0.postal_code","typeLabel":"string"},"country":{"type":"string","uniqueKey":"address.oneOf.0.country","typeLabel":"string"}},"uniqueKey":"address.oneOf.0","typeLabel":"object"},{"type":"string","description":"Residential address. Prefer the structured object `{\"street_1\":\"123 Main St\",\"street_2\":\"Apt 4B\",\"city\":\"Springfield\",\"region\":\"IL\",\"postal_code\":\"62701\",\"country\":\"US\"}`; a complete single-line string is still accepted. Required by address-verification services; when a service defines address requirements, missing parts return `400` with `address_fields_required_by`.","uniqueKey":"address.oneOf.1","typeLabel":"string"}],"uniqueKey":"address","typeLabel":"object | string"},"address_element_1":{"type":"string","description":"Street address including street number and type. If omitted, derived from `address`.","uniqueKey":"address_element_1","typeLabel":"string"},"address_element_2":{"type":"string","description":"Apartment, unit, building, floor, or extra address line. Only send when you have it explicitly.","uniqueKey":"address_element_2","typeLabel":"string"},"address_element_3":{"type":"string","description":"City, suburb, district, locality, or neighborhood. If omitted, derived from `address`.","uniqueKey":"address_element_3","typeLabel":"string"},"address_element_4":{"type":"string","description":"State, province, region, or town. If omitted, derived from `address`.","uniqueKey":"address_element_4","typeLabel":"string"},"address_element_5":{"type":"string","description":"Postcode or postal code. `postal_code` is accepted as an alias.","uniqueKey":"address_element_5","typeLabel":"string"},"postal_code":{"type":"string","description":"Postal code for address-based services (alias of `address_element_5`).","uniqueKey":"postal_code","typeLabel":"string"},"driver_license_number":{"type":"string","description":"Driver licence number for government document-verification services (AUS, NZL, IND).","uniqueKey":"driver_license_number","typeLabel":"string"},"driver_license_card_number":{"type":"string","description":"Physical driver licence card number, where required separately from the licence number (AUS).","uniqueKey":"driver_license_card_number","typeLabel":"string"},"driver_license_state":{"type":"string","description":"Driver licence state or territory of issue (AUS).","uniqueKey":"driver_license_state","typeLabel":"string"},"driver_license_version":{"type":"string","description":"Driver licence version code (NZL).","uniqueKey":"driver_license_version","typeLabel":"string"},"passport_number":{"type":"string","description":"Passport number for government passport-verification services (AUS, NZL, IND, CHN).","uniqueKey":"passport_number","typeLabel":"string"},"passport_expiration_date":{"type":"string","format":"date","description":"Passport expiry date, `YYYY-MM-DD`, for passport-verification services.","uniqueKey":"passport_expiration_date","typeLabel":"string\u003cdate>"},"passport_file_number":{"type":"string","description":"Passport file number (IND).","uniqueKey":"passport_file_number","typeLabel":"string"},"passport_issue_country":{"type":"string","description":"Issuing country of the passport (ISO 3166-1 alpha-3) for passport-verification services.","uniqueKey":"passport_issue_country","typeLabel":"string"},"medicare_card_number":{"type":"string","description":"Medicare card number (AUS).","uniqueKey":"medicare_card_number","typeLabel":"string"},"immi_card_number":{"type":"string","description":"Australian ImmiCard number.","uniqueKey":"immi_card_number","typeLabel":"string"},"immi_card_expiry_date":{"type":"string","format":"date","description":"Australian ImmiCard expiry date.","uniqueKey":"immi_card_expiry_date","typeLabel":"string\u003cdate>"},"citizenship_certificate_number":{"type":"string","description":"Citizenship certificate number (AUS).","uniqueKey":"citizenship_certificate_number","typeLabel":"string"},"birth_registration_number":{"type":"string","description":"Birth-certificate registration number (AUS).","uniqueKey":"birth_registration_number","typeLabel":"string"},"birth_registration_date":{"type":"string","format":"date","description":"Birth-certificate registration date (AUS).","uniqueKey":"birth_registration_date","typeLabel":"string\u003cdate>"},"birth_registration_state":{"type":"string","description":"Birth-certificate registration state (AUS).","uniqueKey":"birth_registration_state","typeLabel":"string"},"marriage_certificate_number":{"type":"string","description":"Marriage certificate number (AUS).","uniqueKey":"marriage_certificate_number","typeLabel":"string"},"change_of_name_certificate_number":{"type":"string","description":"Change-of-name certificate number (AUS).","uniqueKey":"change_of_name_certificate_number","typeLabel":"string"},"first_partner_name":{"type":"string","description":"First name of the partner on a marriage certificate (AUS).","uniqueKey":"first_partner_name","typeLabel":"string"},"last_partner_name":{"type":"string","description":"Last name of the partner on a marriage certificate (AUS).","uniqueKey":"last_partner_name","typeLabel":"string"},"voter_id":{"type":"string","description":"Voter registration number (IND EPIC, IRL).","uniqueKey":"voter_id","typeLabel":"string"},"epic_card":{"type":"string","description":"India EPIC voter card number.","uniqueKey":"epic_card","typeLabel":"string"},"pan":{"type":"string","description":"India PAN (Permanent Account Number).","uniqueKey":"pan","typeLabel":"string"},"national_id":{"type":"string","description":"National ID number (CHN, MYS, KEN, KHM, NGA, ZAF, …).","uniqueKey":"national_id","typeLabel":"string"},"cic":{"type":"string","description":"Mexican INE/IFE Código de Identificación de Credencial (CIC), 9 digits. Used by the MEX INE credential-validity service (`mex_ine_vigencia`).","uniqueKey":"cic","typeLabel":"string"},"identificador_ciudadano":{"type":"string","description":"Mexican INE Identificador del Ciudadano (9 digits). Used with `cic` for modern INE models (E/F/G/H) in `mex_ine_vigencia`.","uniqueKey":"identificador_ciudadano","typeLabel":"string"},"ocr":{"type":"string","description":"Mexican INE OCR number (13 digits, back of card). Used with `cic` for Model D in `mex_ine_vigencia`.","uniqueKey":"ocr","typeLabel":"string"},"voter_number":{"type":"string","description":"Mexican INE Clave de Elector (18 chars). Used with `emission_number` for legacy IFE models (A/B/C) in `mex_ine_vigencia`.","uniqueKey":"voter_number","typeLabel":"string"},"emission_number":{"type":"string","description":"Mexican INE Número de Emisión. Used with `voter_number` for legacy IFE models (A/B/C) in `mex_ine_vigencia`.","uniqueKey":"emission_number","typeLabel":"string"},"bvn":{"type":"string","description":"Nigerian Bank Verification Number.","uniqueKey":"bvn","typeLabel":"string"},"bank_card_number":{"type":"string","description":"Bank card number (CHN bank-card verification).","uniqueKey":"bank_card_number","typeLabel":"string"},"company_registration_number":{"type":"string","description":"Company registration number as issued by the companies register: the CNPJ in Brazil (e.g. `11222333000181`), the registration number in South Africa (e.g. `1936/007721/06`). Required by the company registry and company directors services (`bra_company_registry`, `bra_company_directors`, `zaf_company_registry`, `zaf_company_directors`).","uniqueKey":"company_registration_number","typeLabel":"string"},"company_name":{"type":"string","description":"Registered company name, cross-checked against the register entry. Optional for `zaf_company_registry`.","uniqueKey":"company_name","typeLabel":"string"},"initials":{"type":"string","description":"The person's initials as printed on the document. Required by `zaf_drivers_license`; accepted by `zaf_bank_account_holder`.","uniqueKey":"initials","typeLabel":"string"},"licence_number":{"type":"string","description":"Driving licence number as printed on the card, for `zaf_drivers_license`. When omitted, `document_number` is used.","uniqueKey":"licence_number","typeLabel":"string"},"refugee_file_number":{"type":"string","description":"Refugee file number issued by South Africa's Department of Home Affairs. Required by `zaf_refugee`.","uniqueKey":"refugee_file_number","typeLabel":"string"},"bank_name":{"type":"string","description":"Name of the bank that holds the account. Required by `zaf_bank_account_holder`.","uniqueKey":"bank_name","typeLabel":"string"},"bank_account_number":{"type":"string","description":"Bank account number. Required by `zaf_bank_account_holder`; accepted by `zaf_fraud_prevention`.","uniqueKey":"bank_account_number","typeLabel":"string"},"account_type":{"type":"string","description":"Bank account type for `zaf_bank_account_holder`: `current`, `savings`, `transmission`, `subscriptionShare` or `notKnown`, case-insensitive. Any other value returns `400`. Omit it when you do not know the type: the account-type cross-check is then reported as not confirmed.","uniqueKey":"account_type","typeLabel":"string"},"phone_number":{"type":"string","description":"Contact mobile number, for the services that cross-check contactability (`zaf_bank_account_holder`, `zaf_fraud_prevention`, `zaf_refugee`).","uniqueKey":"phone_number","typeLabel":"string"},"right_thumb":{"type":"string","description":"Base64-encoded right thumb fingerprint for `zaf_dha_fingerprint_match`, with `left_thumb` or on its own.","uniqueKey":"right_thumb","typeLabel":"string"},"left_thumb":{"type":"string","description":"Base64-encoded left thumb fingerprint for `zaf_dha_fingerprint_match`, with `right_thumb` or on its own.","uniqueKey":"left_thumb","typeLabel":"string"},"score_level":{"type":"integer","description":"Minimum biometric score level for `zaf_criminal_face_screening`. Defaults to `3`.","uniqueKey":"score_level","typeLabel":"integer"},"max_matches":{"type":"integer","description":"Maximum number of candidate matches `zaf_criminal_face_screening` returns. Defaults to `1`.","uniqueKey":"max_matches","typeLabel":"integer"},"vehicle_register_number":{"type":"string","description":"Vehicle register number. Required, with `vehicle_licence_plate` and `vin`, by `zaf_vehicle_ownership`.","uniqueKey":"vehicle_register_number","typeLabel":"string"},"vehicle_licence_plate":{"type":"string","description":"Vehicle licence plate number. Required, with `vehicle_register_number` and `vin`, by `zaf_vehicle_ownership`.","uniqueKey":"vehicle_licence_plate","typeLabel":"string"},"vin":{"type":"string","description":"Vehicle Identification Number (VIN or chassis number). Required, with `vehicle_register_number` and `vehicle_licence_plate`, by `zaf_vehicle_ownership`.","uniqueKey":"vin","typeLabel":"string"},"ssn":{"type":"string","description":"Social Security Number (USA).","uniqueKey":"ssn","typeLabel":"string"},"phone":{"type":"string","description":"Phone number for phone-verification services.","uniqueKey":"phone","typeLabel":"string"},"landline":{"type":"string","description":"Landline number for phone-verification services.","uniqueKey":"landline","typeLabel":"string"},"email":{"type":"string","format":"email","description":"Email address for identity-verification services.","uniqueKey":"email","typeLabel":"string\u003cemail>"},"country_of_residence":{"type":"string","description":"ISO 3166-1 alpha-2 country of residence. It was used only by the retired global identity-enrichment service (`glb_identity_enrichment`), which Didit no longer offers.","example":"US","uniqueKey":"country_of_residence","typeLabel":"string"},"partial_match_action":{"type":"string","enum":["DECLINE","NO_ACTION"],"default":"NO_ACTION","description":"What a `partial_match` does to `database_validation.status`. Defaults to `NO_ACTION` (status stays `Approved`, with a warning).","uniqueKey":"partial_match_action","typeLabel":"enum\u003cstring>"},"no_match_action":{"type":"string","enum":["DECLINE","NO_ACTION"],"default":"DECLINE","description":"What a `no_match` does to `database_validation.status`. Defaults to `DECLINE`.","uniqueKey":"no_match_action","typeLabel":"enum\u003cstring>"},"save_api_request":{"type":"boolean","default":true,"description":"Persist the validation as a session (console visibility, decision endpoint, `status.updated` webhook). Also changes the `validations` response shape: per-service objects when `true` (default), a merged field map when `false`.","uniqueKey":"save_api_request","typeLabel":"boolean"},"vendor_data":{"type":"string","description":"Your identifier for the validated user; echoed back and stored with the session.","uniqueKey":"vendor_data","typeLabel":"string"},"metadata":{"oneOf":[{"type":"object","description":"Free-form JSON stored with the request and echoed back.","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Free-form JSON stored with the request and echoed back.","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"issuing_state":"BRA","services":["bra_cpf"],"identification_number":"12345678900","first_name":"John","last_name":"Doe","date_of_birth":"1980-01-01","vendor_data":"user-1234"},"examples":{"Example":{"title":"Example","value":{"issuing_state":"BRA","services":["bra_cpf"],"identification_number":"12345678900","first_name":"John","last_name":"Doe","date_of_birth":"1980-01-01","vendor_data":"user-1234"}}},"exampleType":"examples"},"multipart/form-data":{"schema":{"type":"object","required":["issuing_state"],"properties":{"issuing_state":{"type":"string","description":"ISO 3166-1 **alpha-3** country code of the registry to validate against (e.g. `BRA`, `ESP`, `COL`). Determines which services are available. Unsupported codes return `400` with the full list of valid options.","example":"BRA","isRequired":true,"uniqueKey":"issuing_state","typeLabel":"string"},"services":{"type":"array","items":{"type":"string","uniqueKey":"services.items.[INDEX]","typeLabel":"string"},"description":"Catalog `service_id`s to run for this country (e.g. `[\"bra_cpf\"]`). Also accepts a single string or a comma-separated/JSON-encoded string. **If omitted or empty, exactly one default service runs** — the longest-established live service for the country; newer, biometric, and pay-as-you-go services must be named explicitly. Sending `services` switches the response to the extended shape (adds `services_used` and `match_score`). Every id must exist and be live for the `issuing_state`; services that require onboarding return `400` until activated for your organization. Discover available services per country via `GET /v1/organization/database-validation-countries/` (a catalog endpoint not documented in this spec) or the Business Console workflow editor.","example":["bra_cpf"],"uniqueKey":"services","typeLabel":"string[]"},"validation_type":{"type":"string","deprecated":true,"description":"DEPRECATED. Accepted for backward compatibility but ignored — the response `validation_type` is now derived from how many services full-matched. Use `services` to pin specific services.","uniqueKey":"validation_type","typeLabel":"string"},"consent":{"type":"boolean","default":false,"description":"Set to `true` when the end user has explicitly consented to the selected validation services. Required for services flagged `requires_consent=true` in the catalog — without it those services return `400` with `services_requiring_consent`.","uniqueKey":"consent","typeLabel":"boolean"},"electoral_roll_only":{"type":"boolean","default":false,"description":"Paraguay (`pry_cedula`) only. Set to `true` to check the cédula against the TSJE electoral roll alone. The electoral roll lists only citizens aged 18 or over, so a `MATCH` also confirms that the holder is an adult, and a cédula that is not on the roll returns `DOCUMENT_NOT_FOUND`. Defaults to `false`, which also checks the DNIT taxpayer register for wider identity coverage but cannot confirm age. Any other service rejects it with `400`.","uniqueKey":"electoral_roll_only","typeLabel":"boolean"},"identification_number":{"type":"string","description":"Universal identification number — automatically mapped to the correct country-specific field, so you can use it instead of `personal_number`/`tax_number`/`document_number`: ARG→document_number (DNI), BOL→document_number (CI), BRA→tax_number (CPF, 11 digits), CHL→personal_number (RUT), COL→personal_number (Cédula), CRI→personal_number (Cédula), DOM→personal_number (Cédula, 11 digits), ECU→personal_number (Cédula, 10 digits), ESP→personal_number (DNI/NIE), GTM→document_number (DPI), HND→document_number (DNI), MEX→personal_number (CURP, 18 chars), PAN→personal_number (Cédula), PER→personal_number (DNI, 8 digits), PRY→document_number (CI), SLV→document_number (DUI), URY→personal_number (CI), VEN→document_number (Cédula). It never overrides an explicitly provided country-specific field.","uniqueKey":"identification_number","typeLabel":"string"},"first_name":{"type":"string","description":"The individual's first name. Required by some services/countries.","example":"John","uniqueKey":"first_name","typeLabel":"string"},"last_name":{"type":"string","description":"The individual's last name. Required by some services/countries.","example":"Doe","uniqueKey":"last_name","typeLabel":"string"},"middle_name":{"type":"string","description":"Middle name, used by some country services (AUS, NZL, …).","uniqueKey":"middle_name","typeLabel":"string"},"full_name":{"type":"string","description":"Full name — some services accept this in lieu of first/last name (e.g. CHN services, which match the native-script name).","uniqueKey":"full_name","typeLabel":"string"},"date_of_birth":{"type":"string","format":"date","description":"Date of birth, `YYYY-MM-DD`. Required by many services.","example":"1980-01-01","uniqueKey":"date_of_birth","typeLabel":"string\u003cdate>"},"personal_number":{"type":"string","description":"Government-issued unique personal identifier. Used by: CHL (RUT), COL (Cédula), CRI, DOM, ECU, ESP (DNI/NIE), MEX (CURP), PAN (Cédula), PER (DNI), URY. Consider `identification_number` instead.","uniqueKey":"personal_number","typeLabel":"string"},"tax_number":{"type":"string","description":"Tax identification number. Used by: BRA (CPF, 11 digits). Consider `identification_number` instead.","uniqueKey":"tax_number","typeLabel":"string"},"document_number":{"type":"string","description":"Document number. Used by: ARG (DNI), BOL (CI), GTM (DPI), HND (DNI), PRY (CI), SLV (DUI), VEN (Cédula). Consider `identification_number` instead.","uniqueKey":"document_number","typeLabel":"string"},"document_type":{"type":"string","enum":["P","DL","ID","RP","SSC","HIC","WP","TC","VISA","PSC","BC","OTHER"],"description":"Type of document being validated: `P` passport, `DL` driver license, `ID` national ID, `RP` residence permit (plus `SSC`, `HIC`, `WP`, `TC`, `VISA`, `PSC`, `BC`, `OTHER`). Required by some services (e.g. ESP).","uniqueKey":"document_type","typeLabel":"enum\u003cstring>"},"expiration_date":{"type":"string","format":"date","description":"Document expiration date, `YYYY-MM-DD`. Required for ESP (Spain) validation.","example":"2030-01-15","uniqueKey":"expiration_date","typeLabel":"string\u003cdate>"},"date_of_issue":{"type":"string","format":"date","description":"Document issue date, `YYYY-MM-DD` (fecha de expedición). Required for COL (Colombia) cédula validation.","example":"2015-06-20","uniqueKey":"date_of_issue","typeLabel":"string\u003cdate>"},"nationality":{"type":"string","description":"Nationality as ISO 3166-1 alpha-3. Required by some services.","uniqueKey":"nationality","typeLabel":"string"},"gender":{"type":"string","enum":["M","F","X"],"description":"Gender: `M`, `F`, or `X` (other/unknown). Required for Argentina's RENAPER validation (`arg_renaper`).","uniqueKey":"gender","typeLabel":"enum\u003cstring>"},"address":{"oneOf":[{"type":"object","description":"Residential address. Prefer the structured object `{\"street_1\":\"123 Main St\",\"street_2\":\"Apt 4B\",\"city\":\"Springfield\",\"region\":\"IL\",\"postal_code\":\"62701\",\"country\":\"US\"}`; a complete single-line string is still accepted. Required by address-verification services; when a service defines address requirements, missing parts return `400` with `address_fields_required_by`.","properties":{"street_1":{"type":"string","uniqueKey":"address.oneOf.0.street_1","typeLabel":"string"},"street_2":{"type":"string","uniqueKey":"address.oneOf.0.street_2","typeLabel":"string"},"city":{"type":"string","uniqueKey":"address.oneOf.0.city","typeLabel":"string"},"region":{"type":"string","uniqueKey":"address.oneOf.0.region","typeLabel":"string"},"postal_code":{"type":"string","uniqueKey":"address.oneOf.0.postal_code","typeLabel":"string"},"country":{"type":"string","uniqueKey":"address.oneOf.0.country","typeLabel":"string"}},"uniqueKey":"address.oneOf.0","typeLabel":"object"},{"type":"string","description":"Residential address. Prefer the structured object `{\"street_1\":\"123 Main St\",\"street_2\":\"Apt 4B\",\"city\":\"Springfield\",\"region\":\"IL\",\"postal_code\":\"62701\",\"country\":\"US\"}`; a complete single-line string is still accepted. Required by address-verification services; when a service defines address requirements, missing parts return `400` with `address_fields_required_by`.","uniqueKey":"address.oneOf.1","typeLabel":"string"}],"uniqueKey":"address","typeLabel":"object | string"},"address_element_1":{"type":"string","description":"Street address including street number and type. If omitted, derived from `address`.","uniqueKey":"address_element_1","typeLabel":"string"},"address_element_2":{"type":"string","description":"Apartment, unit, building, floor, or extra address line. Only send when you have it explicitly.","uniqueKey":"address_element_2","typeLabel":"string"},"address_element_3":{"type":"string","description":"City, suburb, district, locality, or neighborhood. If omitted, derived from `address`.","uniqueKey":"address_element_3","typeLabel":"string"},"address_element_4":{"type":"string","description":"State, province, region, or town. If omitted, derived from `address`.","uniqueKey":"address_element_4","typeLabel":"string"},"address_element_5":{"type":"string","description":"Postcode or postal code. `postal_code` is accepted as an alias.","uniqueKey":"address_element_5","typeLabel":"string"},"postal_code":{"type":"string","description":"Postal code for address-based services (alias of `address_element_5`).","uniqueKey":"postal_code","typeLabel":"string"},"driver_license_number":{"type":"string","description":"Driver licence number for government document-verification services (AUS, NZL, IND).","uniqueKey":"driver_license_number","typeLabel":"string"},"driver_license_card_number":{"type":"string","description":"Physical driver licence card number, where required separately from the licence number (AUS).","uniqueKey":"driver_license_card_number","typeLabel":"string"},"driver_license_state":{"type":"string","description":"Driver licence state or territory of issue (AUS).","uniqueKey":"driver_license_state","typeLabel":"string"},"driver_license_version":{"type":"string","description":"Driver licence version code (NZL).","uniqueKey":"driver_license_version","typeLabel":"string"},"passport_number":{"type":"string","description":"Passport number for government passport-verification services (AUS, NZL, IND, CHN).","uniqueKey":"passport_number","typeLabel":"string"},"passport_expiration_date":{"type":"string","format":"date","description":"Passport expiry date, `YYYY-MM-DD`, for passport-verification services.","uniqueKey":"passport_expiration_date","typeLabel":"string\u003cdate>"},"passport_file_number":{"type":"string","description":"Passport file number (IND).","uniqueKey":"passport_file_number","typeLabel":"string"},"passport_issue_country":{"type":"string","description":"Issuing country of the passport (ISO 3166-1 alpha-3) for passport-verification services.","uniqueKey":"passport_issue_country","typeLabel":"string"},"medicare_card_number":{"type":"string","description":"Medicare card number (AUS).","uniqueKey":"medicare_card_number","typeLabel":"string"},"immi_card_number":{"type":"string","description":"Australian ImmiCard number.","uniqueKey":"immi_card_number","typeLabel":"string"},"immi_card_expiry_date":{"type":"string","format":"date","description":"Australian ImmiCard expiry date.","uniqueKey":"immi_card_expiry_date","typeLabel":"string\u003cdate>"},"citizenship_certificate_number":{"type":"string","description":"Citizenship certificate number (AUS).","uniqueKey":"citizenship_certificate_number","typeLabel":"string"},"birth_registration_number":{"type":"string","description":"Birth-certificate registration number (AUS).","uniqueKey":"birth_registration_number","typeLabel":"string"},"birth_registration_date":{"type":"string","format":"date","description":"Birth-certificate registration date (AUS).","uniqueKey":"birth_registration_date","typeLabel":"string\u003cdate>"},"birth_registration_state":{"type":"string","description":"Birth-certificate registration state (AUS).","uniqueKey":"birth_registration_state","typeLabel":"string"},"marriage_certificate_number":{"type":"string","description":"Marriage certificate number (AUS).","uniqueKey":"marriage_certificate_number","typeLabel":"string"},"change_of_name_certificate_number":{"type":"string","description":"Change-of-name certificate number (AUS).","uniqueKey":"change_of_name_certificate_number","typeLabel":"string"},"first_partner_name":{"type":"string","description":"First name of the partner on a marriage certificate (AUS).","uniqueKey":"first_partner_name","typeLabel":"string"},"last_partner_name":{"type":"string","description":"Last name of the partner on a marriage certificate (AUS).","uniqueKey":"last_partner_name","typeLabel":"string"},"voter_id":{"type":"string","description":"Voter registration number (IND EPIC, IRL).","uniqueKey":"voter_id","typeLabel":"string"},"epic_card":{"type":"string","description":"India EPIC voter card number.","uniqueKey":"epic_card","typeLabel":"string"},"pan":{"type":"string","description":"India PAN (Permanent Account Number).","uniqueKey":"pan","typeLabel":"string"},"national_id":{"type":"string","description":"National ID number (CHN, MYS, KEN, KHM, NGA, ZAF, …).","uniqueKey":"national_id","typeLabel":"string"},"cic":{"type":"string","description":"Mexican INE/IFE Código de Identificación de Credencial (CIC), 9 digits. Used by the MEX INE credential-validity service (`mex_ine_vigencia`).","uniqueKey":"cic","typeLabel":"string"},"identificador_ciudadano":{"type":"string","description":"Mexican INE Identificador del Ciudadano (9 digits). Used with `cic` for modern INE models (E/F/G/H) in `mex_ine_vigencia`.","uniqueKey":"identificador_ciudadano","typeLabel":"string"},"ocr":{"type":"string","description":"Mexican INE OCR number (13 digits, back of card). Used with `cic` for Model D in `mex_ine_vigencia`.","uniqueKey":"ocr","typeLabel":"string"},"voter_number":{"type":"string","description":"Mexican INE Clave de Elector (18 chars). Used with `emission_number` for legacy IFE models (A/B/C) in `mex_ine_vigencia`.","uniqueKey":"voter_number","typeLabel":"string"},"emission_number":{"type":"string","description":"Mexican INE Número de Emisión. Used with `voter_number` for legacy IFE models (A/B/C) in `mex_ine_vigencia`.","uniqueKey":"emission_number","typeLabel":"string"},"bvn":{"type":"string","description":"Nigerian Bank Verification Number.","uniqueKey":"bvn","typeLabel":"string"},"bank_card_number":{"type":"string","description":"Bank card number (CHN bank-card verification).","uniqueKey":"bank_card_number","typeLabel":"string"},"company_registration_number":{"type":"string","description":"Company registration number as issued by the companies register: the CNPJ in Brazil (e.g. `11222333000181`), the registration number in South Africa (e.g. `1936/007721/06`). Required by the company registry and company directors services (`bra_company_registry`, `bra_company_directors`, `zaf_company_registry`, `zaf_company_directors`).","uniqueKey":"company_registration_number","typeLabel":"string"},"company_name":{"type":"string","description":"Registered company name, cross-checked against the register entry. Optional for `zaf_company_registry`.","uniqueKey":"company_name","typeLabel":"string"},"initials":{"type":"string","description":"The person's initials as printed on the document. Required by `zaf_drivers_license`; accepted by `zaf_bank_account_holder`.","uniqueKey":"initials","typeLabel":"string"},"licence_number":{"type":"string","description":"Driving licence number as printed on the card, for `zaf_drivers_license`. When omitted, `document_number` is used.","uniqueKey":"licence_number","typeLabel":"string"},"refugee_file_number":{"type":"string","description":"Refugee file number issued by South Africa's Department of Home Affairs. Required by `zaf_refugee`.","uniqueKey":"refugee_file_number","typeLabel":"string"},"bank_name":{"type":"string","description":"Name of the bank that holds the account. Required by `zaf_bank_account_holder`.","uniqueKey":"bank_name","typeLabel":"string"},"bank_account_number":{"type":"string","description":"Bank account number. Required by `zaf_bank_account_holder`; accepted by `zaf_fraud_prevention`.","uniqueKey":"bank_account_number","typeLabel":"string"},"account_type":{"type":"string","description":"Bank account type for `zaf_bank_account_holder`: `current`, `savings`, `transmission`, `subscriptionShare` or `notKnown`, case-insensitive. Any other value returns `400`. Omit it when you do not know the type: the account-type cross-check is then reported as not confirmed.","uniqueKey":"account_type","typeLabel":"string"},"phone_number":{"type":"string","description":"Contact mobile number, for the services that cross-check contactability (`zaf_bank_account_holder`, `zaf_fraud_prevention`, `zaf_refugee`).","uniqueKey":"phone_number","typeLabel":"string"},"right_thumb":{"type":"string","description":"Base64-encoded right thumb fingerprint for `zaf_dha_fingerprint_match`, with `left_thumb` or on its own.","uniqueKey":"right_thumb","typeLabel":"string"},"left_thumb":{"type":"string","description":"Base64-encoded left thumb fingerprint for `zaf_dha_fingerprint_match`, with `right_thumb` or on its own.","uniqueKey":"left_thumb","typeLabel":"string"},"score_level":{"type":"integer","description":"Minimum biometric score level for `zaf_criminal_face_screening`. Defaults to `3`.","uniqueKey":"score_level","typeLabel":"integer"},"max_matches":{"type":"integer","description":"Maximum number of candidate matches `zaf_criminal_face_screening` returns. Defaults to `1`.","uniqueKey":"max_matches","typeLabel":"integer"},"vehicle_register_number":{"type":"string","description":"Vehicle register number. Required, with `vehicle_licence_plate` and `vin`, by `zaf_vehicle_ownership`.","uniqueKey":"vehicle_register_number","typeLabel":"string"},"vehicle_licence_plate":{"type":"string","description":"Vehicle licence plate number. Required, with `vehicle_register_number` and `vin`, by `zaf_vehicle_ownership`.","uniqueKey":"vehicle_licence_plate","typeLabel":"string"},"vin":{"type":"string","description":"Vehicle Identification Number (VIN or chassis number). Required, with `vehicle_register_number` and `vehicle_licence_plate`, by `zaf_vehicle_ownership`.","uniqueKey":"vin","typeLabel":"string"},"ssn":{"type":"string","description":"Social Security Number (USA).","uniqueKey":"ssn","typeLabel":"string"},"phone":{"type":"string","description":"Phone number for phone-verification services.","uniqueKey":"phone","typeLabel":"string"},"landline":{"type":"string","description":"Landline number for phone-verification services.","uniqueKey":"landline","typeLabel":"string"},"email":{"type":"string","format":"email","description":"Email address for identity-verification services.","uniqueKey":"email","typeLabel":"string\u003cemail>"},"country_of_residence":{"type":"string","description":"ISO 3166-1 alpha-2 country of residence. It was used only by the retired global identity-enrichment service (`glb_identity_enrichment`), which Didit no longer offers.","example":"US","uniqueKey":"country_of_residence","typeLabel":"string"},"partial_match_action":{"type":"string","enum":["DECLINE","NO_ACTION"],"default":"NO_ACTION","description":"What a `partial_match` does to `database_validation.status`. Defaults to `NO_ACTION` (status stays `Approved`, with a warning).","uniqueKey":"partial_match_action","typeLabel":"enum\u003cstring>"},"no_match_action":{"type":"string","enum":["DECLINE","NO_ACTION"],"default":"DECLINE","description":"What a `no_match` does to `database_validation.status`. Defaults to `DECLINE`.","uniqueKey":"no_match_action","typeLabel":"enum\u003cstring>"},"save_api_request":{"type":"boolean","default":true,"description":"Persist the validation as a session (console visibility, decision endpoint, `status.updated` webhook). Also changes the `validations` response shape: per-service objects when `true` (default), a merged field map when `false`.","uniqueKey":"save_api_request","typeLabel":"boolean"},"vendor_data":{"type":"string","description":"Your identifier for the validated user; echoed back and stored with the session.","uniqueKey":"vendor_data","typeLabel":"string"},"metadata":{"oneOf":[{"type":"object","description":"Free-form JSON stored with the request and echoed back.","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Free-form JSON stored with the request and echoed back.","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"selfie":{"type":"string","format":"binary","description":"Selfie image (`jpg`, `jpeg`, `png`, `webp`; max 2 MB — images are compressed to ~1.5 MB before upload to the registry) for biometric validation services, e.g. Argentina RENAPER (`arg_renaper`) and Panama SIB (`pan_cedula_sib`, `pan_cedula_sib_plus`). Required whenever a selected service lists it as a required field. Only available via `multipart/form-data`.","uniqueKey":"selfie","typeLabel":"file"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"issuing_state":"BRA","services":["bra_cpf"],"validation_type":"\u003cstring>","consent":false,"electoral_roll_only":false,"identification_number":"\u003cstring>","first_name":"John","last_name":"Doe","middle_name":"\u003cstring>","full_name":"\u003cstring>","date_of_birth":"1980-01-01","personal_number":"\u003cstring>","tax_number":"\u003cstring>","document_number":"\u003cstring>","expiration_date":"2030-01-15","date_of_issue":"2015-06-20","nationality":"\u003cstring>","address":{"street_1":"\u003cstring>","street_2":"\u003cstring>","city":"\u003cstring>","region":"\u003cstring>","postal_code":"\u003cstring>","country":"\u003cstring>"},"address_element_1":"\u003cstring>","address_element_2":"\u003cstring>","address_element_3":"\u003cstring>","address_element_4":"\u003cstring>","address_element_5":"\u003cstring>","postal_code":"\u003cstring>","driver_license_number":"\u003cstring>","driver_license_card_number":"\u003cstring>","driver_license_state":"\u003cstring>","driver_license_version":"\u003cstring>","passport_number":"\u003cstring>","passport_expiration_date":"2023-12-25","passport_file_number":"\u003cstring>","passport_issue_country":"\u003cstring>","medicare_card_number":"\u003cstring>","immi_card_number":"\u003cstring>","immi_card_expiry_date":"2023-12-25","citizenship_certificate_number":"\u003cstring>","birth_registration_number":"\u003cstring>","birth_registration_date":"2023-12-25","birth_registration_state":"\u003cstring>","marriage_certificate_number":"\u003cstring>","change_of_name_certificate_number":"\u003cstring>","first_partner_name":"\u003cstring>","last_partner_name":"\u003cstring>","voter_id":"\u003cstring>","epic_card":"\u003cstring>","pan":"\u003cstring>","national_id":"\u003cstring>","cic":"\u003cstring>","identificador_ciudadano":"\u003cstring>","ocr":"\u003cstring>","voter_number":"\u003cstring>","emission_number":"\u003cstring>","bvn":"\u003cstring>","bank_card_number":"\u003cstring>","company_registration_number":"\u003cstring>","company_name":"\u003cstring>","initials":"\u003cstring>","licence_number":"\u003cstring>","refugee_file_number":"\u003cstring>","bank_name":"\u003cstring>","bank_account_number":"\u003cstring>","account_type":"\u003cstring>","phone_number":"\u003cstring>","right_thumb":"\u003cstring>","left_thumb":"\u003cstring>","score_level":123,"max_matches":123,"vehicle_register_number":"\u003cstring>","vehicle_licence_plate":"\u003cstring>","vin":"\u003cstring>","ssn":"\u003cstring>","phone":"\u003cstring>","landline":"\u003cstring>","email":"jsmith@example.com","country_of_residence":"US","partial_match_action":"NO_ACTION","no_match_action":"DECLINE","save_api_request":true,"vendor_data":"\u003cstring>","metadata":{},"selfie":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"examples"},"responses":{"90c27a2d-ad54-4a18-b480-f101d7444426":{"description":"Validation completed — at least one selected service returned a usable result. Inspect `database_validation.match_type` for the aggregate outcome, `validations` for the per-service field comparisons and `outcome_code`s, and `errors` (when present) for services that failed.","content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string","format":"uuid","description":"Persisted session id when `save_api_request=true` (usable with `GET /v3/session/{sessionId}/decision/`); otherwise a transient correlation UUID.","uniqueKey":"request_id","typeLabel":"string\u003cuuid>"},"database_validation":{"type":"object","properties":{"status":{"type":"string","enum":["Approved","Declined","In Review"],"description":"`Declined` when the overall `match_type` triggers a `DECLINE` action (`no_match_action` defaults to `DECLINE`, `partial_match_action` to `NO_ACTION`); `In Review` when no service produced a usable comparison, for example when the only selected service came back `REGISTRY_UNAVAILABLE` or `INCONCLUSIVE`; `Approved` otherwise. A request that selected several services can be `Approved` on one service's match while another was unavailable, so check `errors` and the per-service `outcome_code`s too.","uniqueKey":"database_validation.status","typeLabel":"enum\u003cstring>"},"issuing_state":{"type":"string","description":"Echo of the ISO 3166-1 alpha-3 country validated against.","example":"BRA","uniqueKey":"database_validation.issuing_state","typeLabel":"string"},"validation_type":{"type":"string","enum":["one_by_one","two_by_two"],"description":"Derived from the results: `two_by_two` when ≥2 distinct services produced a full match (on the identification number, on full name + date of birth together, or on the address without contradictions); `one_by_one` otherwise. (The request field of the same name is deprecated and ignored.)","uniqueKey":"database_validation.validation_type","typeLabel":"enum\u003cstring>"},"screened_data":{"type":"object","description":"Echo of the input fields that were sent to the selected services (dates normalized to `YYYY-MM-DD`; a `selfie`, when sent, is returned as a pre-signed URL; `consent_obtained: true` is added when consent was given).","uniqueKey":"database_validation.screened_data","typeLabel":"object"},"match_type":{"oneOf":[{"type":"string","enum":["full_match","partial_match","no_match"],"description":"Overall result aggregated across services with field-level comparisons: any `full_match` → `full_match`; else any `partial_match` → `partial_match`; else `no_match`. Outcome-only services, such as biometric criminal screening, can return `null`; inspect each item in `validations` for its `outcome_code`.","uniqueKey":"database_validation.match_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["full_match","partial_match","no_match"],"description":"Overall result aggregated across services with field-level comparisons: any `full_match` → `full_match`; else any `partial_match` → `partial_match`; else `no_match`. Outcome-only services, such as biometric criminal screening, can return `null`; inspect each item in `validations` for its `outcome_code`.","uniqueKey":"database_validation.match_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"database_validation.match_type","typeLabel":"enum\u003cstring> | null"},"validations":{"oneOf":[{"type":"array","items":{"type":"object","description":"Per-service validation result (returned when `save_api_request=true`, the default).","properties":{"service_id":{"type":"string","description":"Catalog id of the service that produced this result (e.g. `bra_cpf`).","example":"bra_cpf","uniqueKey":"database_validation.validations.oneOf.0.items.[INDEX].service_id","typeLabel":"string"},"service_name":{"type":"string","description":"Human-readable catalog name of the service.","example":"Brazil - CPF status check","uniqueKey":"database_validation.validations.oneOf.0.items.[INDEX].service_name","typeLabel":"string"},"validation":{"type":"object","description":"Field-by-field comparison between your input and the registry record. Keys are canonical field names (`full_name`, `date_of_birth`, `identification_number`, `address`, …); values are `full_match`, `partial_match`, or `no_match`.","additionalProperties":{"type":"string","enum":["full_match","partial_match","no_match"],"uniqueKey":"database_validation.validations.oneOf.0.items.[INDEX].validation.additionalProperties","typeLabel":"enum\u003cstring>"},"uniqueKey":"database_validation.validations.oneOf.0.items.[INDEX].validation","typeLabel":"object"},"outcome_code":{"type":"string","enum":["MATCH","PARTIAL_MATCH","NO_MATCH","DOCUMENT_NOT_FOUND","INVALID_DOCUMENT_FORMAT","INVALID_INPUT","MINOR_BLOCKED","DECEASED","BIOMETRIC_NO_MATCH","BIOMETRIC_IMAGE_UNUSABLE","INCONCLUSIVE","DOCUMENT_SUPERSEDED","REGISTRY_UNAVAILABLE","REGISTRY_ERROR"],"description":"Vendor-neutral outcome of the registry lookup. `MATCH`/`PARTIAL_MATCH`/`NO_MATCH` describe the comparison; `DOCUMENT_NOT_FOUND` means the identifier is not in the registry; `INCONCLUSIVE` means the registry could not confirm either way (routed to review — NOT a no-match); `BIOMETRIC_NO_MATCH` is a definitive face mismatch while `BIOMETRIC_IMAGE_UNUSABLE` is a technical image problem (retake the selfie); `DECEASED`/`MINOR_BLOCKED` are registry-policy outcomes; `DOCUMENT_SUPERSEDED` means the identity matched but the edition of the document presented is not the one on file (a newer edition has been issued); `INVALID_DOCUMENT_FORMAT`/`INVALID_INPUT` mean the registry itself rejected the data it was sent; `REGISTRY_UNAVAILABLE`/`REGISTRY_ERROR` indicate upstream failures.","uniqueKey":"database_validation.validations.oneOf.0.items.[INDEX].outcome_code","typeLabel":"enum\u003cstring>"},"outcome_detail":{"oneOf":[{"type":"string","description":"Raw upstream status detail backing the outcome code (e.g. an HTTP or registry status code).","uniqueKey":"database_validation.validations.oneOf.0.items.[INDEX].outcome_detail.oneOf.0","typeLabel":"string"},{"type":"null","description":"Raw upstream status detail backing the outcome code (e.g. an HTTP or registry status code).","uniqueKey":"database_validation.validations.oneOf.0.items.[INDEX].outcome_detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"database_validation.validations.oneOf.0.items.[INDEX].outcome_detail","typeLabel":"string | null"},"source_data":{"oneOf":[{"type":"object","description":"Cleaned, normalized view of the registry record using canonical field names (`identification_number`, `first_name`, `last_name`, `date_of_birth`, plus registry-specific flags). Image fields, when present, are returned as pre-signed URLs.","uniqueKey":"database_validation.validations.oneOf.0.items.[INDEX].source_data.oneOf.0","typeLabel":"object"},{"type":"null","description":"Cleaned, normalized view of the registry record using canonical field names (`identification_number`, `first_name`, `last_name`, `date_of_birth`, plus registry-specific flags). Image fields, when present, are returned as pre-signed URLs.","uniqueKey":"database_validation.validations.oneOf.0.items.[INDEX].source_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"database_validation.validations.oneOf.0.items.[INDEX].source_data","typeLabel":"object | null"}},"uniqueKey":"database_validation.validations.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Shape depends on `save_api_request`. **`true` (default):** an array of per-service objects (`service_id`, `service_name`, `validation`, `outcome_code`, `outcome_detail`, `source_data`). **`false`:** a single flat object merging the field-level results of all services (`{\"full_name\": \"full_match\", ...}`).","uniqueKey":"database_validation.validations.oneOf.0","typeLabel":"object[]"},{"type":"object","description":"Shape depends on `save_api_request`. **`true` (default):** an array of per-service objects (`service_id`, `service_name`, `validation`, `outcome_code`, `outcome_detail`, `source_data`). **`false`:** a single flat object merging the field-level results of all services (`{\"full_name\": \"full_match\", ...}`).","additionalProperties":{"type":"string","enum":["full_match","partial_match","no_match"],"uniqueKey":"database_validation.validations.oneOf.1.additionalProperties","typeLabel":"enum\u003cstring>"},"uniqueKey":"database_validation.validations.oneOf.1","typeLabel":"object"}],"uniqueKey":"database_validation.validations","typeLabel":"object[] | object"},"warnings":{"type":"array","items":{"type":"object","properties":{"feature":{"type":"string","description":"Feature that raised the warning.","uniqueKey":"database_validation.warnings.items.[INDEX].feature","typeLabel":"string"},"risk":{"type":"string","description":"Machine-readable risk identifier.","uniqueKey":"database_validation.warnings.items.[INDEX].risk","typeLabel":"string"},"additional_data":{"oneOf":[{"type":"object","description":"Extra context for the warning, when available.","uniqueKey":"database_validation.warnings.items.[INDEX].additional_data.oneOf.0","typeLabel":"object"},{"type":"null","description":"Extra context for the warning, when available.","uniqueKey":"database_validation.warnings.items.[INDEX].additional_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"database_validation.warnings.items.[INDEX].additional_data","typeLabel":"object | null"},"log_type":{"type":"string","description":"`warning`, `information`, or `error` — how the risk affected the outcome.","uniqueKey":"database_validation.warnings.items.[INDEX].log_type","typeLabel":"string"},"short_description":{"type":"string","description":"One-line human-readable summary.","uniqueKey":"database_validation.warnings.items.[INDEX].short_description","typeLabel":"string"},"long_description":{"type":"string","description":"Full human-readable explanation.","uniqueKey":"database_validation.warnings.items.[INDEX].long_description","typeLabel":"string"}},"uniqueKey":"database_validation.warnings.items.[INDEX]","typeLabel":"object"},"description":"`DATABASE_VALIDATION_NO_MATCH` or `DATABASE_VALIDATION_PARTIAL_MATCH` when applicable; empty on a full match.","uniqueKey":"database_validation.warnings","typeLabel":"object[]"},"errors":{"type":"array","description":"Present only when some (but not all) selected services failed. Each entry carries `service_id`, `code`, `message`, and `retryable`. A service reported here is absent from `validations` and `services_used`, and is not billed. This array is the only place it appears, so inspect it even when `status` is `Approved`.","items":{"type":"object","properties":{"service_id":{"type":"string","uniqueKey":"database_validation.errors.items.[INDEX].service_id","typeLabel":"string"},"code":{"type":"string","example":"empty_provider_response","uniqueKey":"database_validation.errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"database_validation.errors.items.[INDEX].message","typeLabel":"string"},"retryable":{"type":"boolean","description":"`true` when the service produced no answer and retrying it later can succeed; `false` when the source refused the data it was sent and the input must be corrected first.","example":true,"uniqueKey":"database_validation.errors.items.[INDEX].retryable","typeLabel":"boolean"}},"uniqueKey":"database_validation.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"database_validation.errors","typeLabel":"object[]"},"services_used":{"type":"array","items":{"type":"string","uniqueKey":"database_validation.services_used.items.[INDEX]","typeLabel":"string"},"description":"Catalog ids of the services that returned a billable result. **Only present when the request explicitly sent `services`.**","uniqueKey":"database_validation.services_used","typeLabel":"string[]"},"match_score":{"type":"number","description":"Fraction (0.0–1.0) of attempted services that produced a full match (on the identification number, on full name + date of birth together, or on the address without contradictions). **Only present when the request explicitly sent `services`.**","uniqueKey":"database_validation.match_score","typeLabel":"number"}},"uniqueKey":"database_validation","typeLabel":"object"},"vendor_data":{"oneOf":[{"type":"string","description":"Echo of the `vendor_data` you sent.","uniqueKey":"vendor_data.oneOf.0","typeLabel":"string"},{"type":"null","description":"Echo of the `vendor_data` you sent.","uniqueKey":"vendor_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_data","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","description":"Echo of the `metadata` you sent.","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Echo of the `metadata` you sent.","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"created_at":{"type":"string","format":"date-time","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Full match (Approved)":{"title":"Full match (Approved)","summary":"Default save_api_request=true — per-service `validations` objects","value":{"request_id":"7f9a1c0e-1f2b-4f6e-9d3a-2b1c0e7f9a1c","database_validation":{"status":"Approved","issuing_state":"BRA","validation_type":"one_by_one","screened_data":{"tax_number":"12345678900","first_name":"John","last_name":"Doe","date_of_birth":"1980-01-01"},"match_type":"full_match","validations":[{"validation":{"full_name":"full_match","date_of_birth":"full_match","identification_number":"full_match"},"outcome_code":"MATCH","outcome_detail":"200","service_id":"bra_cpf","service_name":"Brazil - CPF status check","source_data":{"identification_number":"12345678900","first_name":"JOHN","last_name":"DOE","date_of_birth":"1980-01-01","lgpd_minor":false,"minor_under_16":false,"minor_under_18":false}}],"warnings":[]},"vendor_data":"user-1234","metadata":null,"created_at":"2026-06-11T10:30:00.000000+00:00"}},"Explicit services (extended shape)":{"title":"Explicit services (extended shape)","summary":"Request sent `services` — response adds `services_used` and `match_score`","value":{"request_id":"b3e7c1a2-9d4f-4f0b-8a6c-5e2d1f0a9b3e","database_validation":{"status":"Approved","issuing_state":"BRA","validation_type":"one_by_one","screened_data":{"tax_number":"12345678900","first_name":"John","last_name":"Doe","date_of_birth":"1980-01-01"},"match_type":"full_match","validations":[{"validation":{"full_name":"full_match","date_of_birth":"full_match","identification_number":"full_match"},"outcome_code":"MATCH","outcome_detail":"200","service_id":"bra_cpf","service_name":"Brazil - CPF status check","source_data":{"identification_number":"12345678900","first_name":"JOHN","last_name":"DOE","date_of_birth":"1980-01-01","lgpd_minor":false,"minor_under_16":false,"minor_under_18":false}}],"warnings":[],"services_used":["bra_cpf"],"match_score":1},"vendor_data":"user-1234","metadata":null,"created_at":"2026-06-11T10:30:00.000000+00:00"}},"No match (Declined)":{"title":"No match (Declined)","summary":"Registry record does not match — default `no_match_action=DECLINE`","value":{"request_id":"0a1b2c3d-4e5f-6789-abcd-ef0123456789","database_validation":{"status":"Declined","issuing_state":"BRA","validation_type":"one_by_one","screened_data":{"tax_number":"12345678900","first_name":"John","last_name":"Doe","date_of_birth":"1980-01-01"},"match_type":"no_match","validations":[{"validation":{"full_name":"no_match","date_of_birth":"no_match","identification_number":"no_match"},"outcome_code":"NO_MATCH","outcome_detail":"200","service_id":"bra_cpf","service_name":"Brazil - CPF status check","source_data":{"identification_number":"00987654321","first_name":"TOTALLY","last_name":"DIFFERENT NAME","date_of_birth":"1999-01-01","lgpd_minor":false,"minor_under_16":false,"minor_under_18":false}}],"warnings":[{"feature":"DATABASE_VALIDATION","risk":"DATABASE_VALIDATION_NO_MATCH","additional_data":null,"log_type":"error","short_description":"Database validation no match","long_description":"The system identified a no match in the database validation, requiring further investigation."}]},"vendor_data":null,"metadata":null,"created_at":"2026-06-11T10:31:00.000000+00:00"}},"Stateless (save_api_request=false)":{"title":"Stateless (save_api_request=false)","summary":"`validations` collapses to a merged field map; nothing is stored","value":{"request_id":"c4d5e6f7-8901-2345-6789-abcdef012345","database_validation":{"status":"Approved","issuing_state":"BRA","validation_type":"one_by_one","screened_data":{"tax_number":"12345678900","first_name":"John","last_name":"Doe","date_of_birth":"1980-01-01"},"match_type":"full_match","validations":{"full_name":"full_match","date_of_birth":"full_match","identification_number":"full_match"},"warnings":[]},"vendor_data":null,"metadata":null,"created_at":"2026-06-11T10:32:00.000000+00:00"}}},"exampleType":"examples"}},"exampleType":"examples"},"cef58e24-9bc5-4792-b1f8-3ae04f102344":{"description":"Validation error - nothing is billed. Preflight field errors occur before any external call. If every unanswered attempt explicitly refuses the input, the response instead includes `validation_errors` with `code: provider_rejected_input` and `retryable: false`; correct the input before retrying. Field-level problems use DRF's standard envelope; catalog problems return a `services` array (plus `requires_onboarding` or `services_requiring_consent` when relevant); missing-field errors include `fields_required_by` mapping each missing field to the services that demand it; services that need at least one extra identifier (e.g. `usa_states_credit_bureau`, which cannot verify a name alone) return `any_field_required_by` mapping each service to the fields of which at least one must be present; format problems checked per service return `invalid_fields_by_service`.","content":{"application/json":{"examples":{"Invalid issuing_state":{"title":"Invalid issuing_state","summary":"Country not supported — message lists every valid alpha-3 code","value":{"error":["Invalid issuing state. Valid options are: ARE, ARG, AUS, AUT, BEL, BGD, BOL, BRA, CAN, CHE, CHL, CHN, CIV, COL, CRI, CZE, DEU, DNK, DOM, ECU, ESP, FIN, FRA, GBR, GHA, GLB, GRC, GTM, HKG, HND, IDN, IND, IRL, ITA, KEN, KHM, MAR, MEX, MYS, NGA, NLD, NOR, NZL, OMN, PAN, PER, PHL, POL, PRT, PRY, QAT, SGP, SLV, SVK, SWE, THA, UGA, URY, USA, VEN, ZAF, ZMB, ZWE"]}},"Missing required fields":{"title":"Missing required fields","summary":"Union of required fields across selected services, with the universal-field hint","value":{"error":["Missing required fields: tax_number (or use 'identification_number' which maps to 'tax_number' for BRA)"],"fields_required_by":{"tax_number":["bra_cpf"]}}},"Unknown service id":{"title":"Unknown service id","summary":"`services` contains an id that is not in the catalog","value":{"services":["Unknown service_id(s): ['bogus_service']"]}},"Service not live for country":{"title":"Service not live for country","summary":"`services` names a service from another country (or a stub entry)","value":{"services":["Services not currently live for PER: ['bra_cpf']. Available services: ['per_dni', 'per_residential', 'per_tax_registration']"]}},"Service requires onboarding":{"title":"Service requires onboarding","summary":"Service exists but is not activated for your organization yet","value":{"services":["Services require onboarding before they can be enabled for AUS: ['aus_australia_driver_licence']. Contact Didit support to activate them."],"requires_onboarding":["aus_australia_driver_licence"]}},"Consent missing":{"title":"Consent missing","summary":"A selected service is flagged requires_consent=true and `consent` was not `true`","value":{"consent":["Explicit end-user consent is required for these database validation services: ['chn_national_id']. Send `consent=true`."],"services_requiring_consent":["chn_national_id"]}},"Country format rule violation":{"title":"Country format rule violation","summary":"Identifier fails the country's format rule (length/digits/regex)","value":{"tax_number":["Invalid tax number for BRA: Brazilian CPF (exactly 11 digits). Must be exactly 11 characters long (got 10)."]}},"Service-specific format violation":{"title":"Service-specific format violation","summary":"A field fails the selected service's own format requirements","value":{"error":["One or more fields do not match the format required by the selected service."],"invalid_fields_by_service":{"chn_national_id":["national_id_format"]}}},"Input refused by every attempt":{"title":"Input refused by every attempt","summary":"Correct the input before retrying","value":{"error":"The source refused to run this query with the supplied input.","validation_errors":[{"service_id":"bra_cpf","code":"provider_rejected_input","message":"The source refused to run this query with the supplied input.","retryable":false}]}}},"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"oneOf":[{"type":"string","description":"Request-level explanation or preflight field errors.","uniqueKey":"error.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"error.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Request-level explanation or preflight field errors.","uniqueKey":"error.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"error","typeLabel":"string | string[]"},"validation_errors":{"type":"array","description":"Present when every unanswered attempt refused the input after preflight.","items":{"type":"object","properties":{"service_id":{"type":"string","uniqueKey":"validation_errors.items.[INDEX].service_id","typeLabel":"string"},"code":{"type":"string","uniqueKey":"validation_errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"validation_errors.items.[INDEX].message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying later can resolve this service failure. False means correct the supplied input first.","uniqueKey":"validation_errors.items.[INDEX].retryable","typeLabel":"boolean"}},"uniqueKey":"validation_errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"validation_errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"exampleType":"examples"},"26c8a33d-9100-486f-869a-1e07d5c0590b":{"description":"Permission denied. Returned when the `x-api-key` header is missing, and also when the calling organization's balance cannot cover the call; a wrong, revoked or expired key returns `401`. A missing key returns `403` with `{\"detail\": ...}`; a wrong, revoked or expired key returns `401`. Credit shortfalls return `403` with `{\"error\": ...}` before any screening or provider call happens.","content":{"application/json":{"examples":{"Missing or invalid API key":{"title":"Missing or invalid API key","summary":"No `x-api-key` header, or the key is invalid/revoked","value":{"detail":"You do not have permission to perform this action."}},"Not enough credits":{"title":"Not enough credits","summary":"Organization balance cannot cover the call","value":{"error":"You don't have enough credits to perform this request. Please top up at https://business.didit.me"}}},"exampleType":"examples"}},"exampleType":"examples"},"04096caf-a3a8-4cbd-a4b3-ae046312c338":{"description":"Rate limit exceeded. POST/PATCH/DELETE endpoints share a budget of 300 write requests per minute per API key (transaction creates and event ingestion have a separate budget of 600). The response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`, and `Retry-After` headers.","content":{"application/json":{"examples":{"Write rate limit exceeded":{"title":"Write rate limit exceeded","summary":"More than 300 write requests in the current minute","value":{"detail":"Write request rate limit exceeded. You can make up to 300 requests per minute.","reference":"RL-00000000000040008000000000000001","limit":300,"remaining":0,"reset":1794358860,"window_seconds":60}}},"schema":{"type":"object","description":"Returned only for a rate-limit middleware budget refusal. Other 429 errors, including idempotency conflicts and endpoint-specific caps, do not promise these metadata fields.","required":["detail","reference","limit","remaining","reset","window_seconds"],"properties":{"detail":{"type":"string","description":"Existing human-readable budget refusal message.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"reference":{"type":"string","pattern":"^RL-[0-9a-f]{32}$","description":"Opaque support reference: RL- followed by 32 lowercase UUID hexadecimal characters.","isRequired":true,"uniqueKey":"reference","typeLabel":"string"},"limit":{"type":"integer","description":"Budget for the exceeded scope; equals X-RateLimit-Limit.","isRequired":true,"uniqueKey":"limit","typeLabel":"integer"},"remaining":{"type":"integer","minimum":0,"description":"Remaining budget, clamped to zero; equals X-RateLimit-Remaining.","isRequired":true,"uniqueKey":"remaining","typeLabel":"integer"},"reset":{"type":"integer","format":"int64","description":"Window reset time in Unix seconds; equals X-RateLimit-Reset.","isRequired":true,"uniqueKey":"reset","typeLabel":"integer\u003cint64>"},"window_seconds":{"type":"integer","description":"Fixed-window duration in seconds, not the remaining wait. Honor Retry-After before retrying.","isRequired":true,"uniqueKey":"window_seconds","typeLabel":"integer"}},"example":{"detail":"Write request rate limit exceeded. You can make up to 300 requests per minute.","reference":"RL-00000000000040008000000000000001","limit":300,"remaining":0,"reset":1794358860,"window_seconds":60},"uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"headers":{"Retry-After":{"description":"Seconds to wait, rounded up to the next window. Present on middleware budget refusals.","schema":{"type":"integer"}},"X-RateLimit-Scope":{"description":"The scope whose budget was exceeded. Present on middleware budget refusals.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Budget for the exceeded scope; equals body limit. Present on middleware budget refusals.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Remaining budget, clamped to zero; equals body remaining. Present on middleware budget refusals.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Reset time in Unix seconds; equals body reset. Present on middleware budget refusals.","schema":{"type":"integer"}}},"exampleType":"examples"},"9d1aa012-bba2-479f-a7af-9179eb34db46":{"description":"No selected service returned a usable result. Inspect each validation_errors entry before retrying; HTTP 502 alone does not establish a transient failure. An empty_provider_response with retryable: true indicates unavailable or unexplained results, including a refused primary followed by an unavailable fallback. Legacy provider_invalid_input and provider_validation_error entries instead require corrected input and may omit retryable. Nothing is billed. When save_api_request=true, the failed attempt is recorded as a session with status Not Finished. Partial failures return 200 with database_validation.errors.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"validation_errors":{"type":"array","items":{"type":"object","properties":{"service_id":{"type":"string","uniqueKey":"validation_errors.items.[INDEX].service_id","typeLabel":"string"},"code":{"type":"string","uniqueKey":"validation_errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"validation_errors.items.[INDEX].message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying later can resolve this service failure. False means correct the supplied input first.","uniqueKey":"validation_errors.items.[INDEX].retryable","typeLabel":"boolean"}},"uniqueKey":"validation_errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"validation_errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Provider returned no result":{"title":"Provider returned no result","summary":"Every selected service failed","value":{"error":"Database validation could not be performed. The external validation service did not return a result. Please try again later.","validation_errors":[{"service_id":"bra_cpf","code":"empty_provider_response","message":"The provider did not return a database validation result.","retryable":true}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"5b3b12d3-4594-4967-b02a-fe03125fa19f":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is wrong, revoked or expired; 403 means no key was sent, the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"9175aafc-0880-48bd-9d74-3d26d6c81029":{"url":"https://verification.didit.me"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is wrong, revoked or expired; 403 means no key was sent, the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","description":"Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is wrong, revoked or expired; 403 means no key was sent, the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi-25.json"},"subdomain":"didit-0f962782","siteName":"Didit Docs","title":"Database Validation API: National ID Match - Didit Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/standalone-apis/database-validation","matchLevel":0},"es":{"href":"/es/standalone-apis/database-validation","matchLevel":1},"pt-BR":{"href":"/pt-br/standalone-apis/database-validation","matchLevel":1},"ja":{"href":"/ja/standalone-apis/database-validation","matchLevel":1},"de":{"href":"/de/standalone-apis/database-validation","matchLevel":1},"fr":{"href":"/fr/standalone-apis/database-validation","matchLevel":1},"it":{"href":"/it/standalone-apis/database-validation","matchLevel":1},"pt":{"href":"/pt/standalone-apis/database-validation","matchLevel":1},"ca":{"href":"/ca/standalone-apis/database-validation","matchLevel":1},"id":{"href":"/id/standalone-apis/database-validation","matchLevel":1},"ru":{"href":"/ru/standalone-apis/database-validation","matchLevel":1},"ko":{"href":"/ko/standalone-apis/database-validation","matchLevel":1},"zh":{"href":"/zh/standalone-apis/database-validation","matchLevel":1},"ar":{"href":"/ar/standalone-apis/database-validation","matchLevel":1},"hi":{"href":"/hi/standalone-apis/database-validation","matchLevel":1}}},"lastModified":"2026-11-12T09:05:22.395Z","gitLastModified":"2026-11-01T10:56:28.000Z","originalFileLocation":"standalone-apis/database-validation.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"POST /v3/database-validation/ to validate identity data against 100+ national and global sources with 1x1 and 2x2 waterfall matching. Pay-per-call.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Didit Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Database Validation API: National ID Match - Didit Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"POST /v3/database-validation/ to validate identity data against 100+ national and global sources with 1x1 and 2x2 waterfall matching. Pay-per-call.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Didit Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.didit.me/standalone-apis/database-validation\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://didit-0f962782.mintlify.site/_mintlify/api/og/v2?division=Database+Validation+API\u0026amp;title=Database+Validation+API%3A+National+ID+Match\u0026amp;description=POST+%2Fv3%2Fdatabase-validation%2F+to+validate+identity+data+against+100%2B+national+and+global+sources+with+1x1+and+2x2+waterfall+matching.+Pay-per-call.\u0026amp;theme=6763de7356559382b06288d9\u0026amp;signature=3389ced73a98f29e23c024183f089b133a6dd2fbfc13e674b2f25bb82033524f\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Database Validation API: National ID Match - Didit Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"POST /v3/database-validation/ to validate identity data against 100+ national and global sources with 1x1 and 2x2 waterfall matching. Pay-per-call.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://didit-0f962782.mintlify.site/_mintlify/api/og/v2?division=Database+Validation+API\u0026amp;title=Database+Validation+API%3A+National+ID+Match\u0026amp;description=POST+%2Fv3%2Fdatabase-validation%2F+to+validate+identity+data+against+100%2B+national+and+global+sources+with+1x1+and+2x2+waterfall+matching.+Pay-per-call.\u0026amp;theme=6763de7356559382b06288d9\u0026amp;signature=3389ced73a98f29e23c024183f089b133a6dd2fbfc13e674b2f25bb82033524f\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/didit-0f962782/h7Er2opLBVoQwrdf/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Didit Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2567FF\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#2567FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.didit.me/standalone-apis/database-validation\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/standalone-apis/database-validation.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.didit.me/standalone-apis/database-validation\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.didit.me/es/standalone-apis/database-validation\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://docs.didit.me/pt-br/standalone-apis/database-validation\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://docs.didit.me/ja/standalone-apis/database-validation\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"de\" href=\"https://docs.didit.me/de/standalone-apis/database-validation\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.didit.me/fr/standalone-apis/database-validation\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"it\" href=\"https://docs.didit.me/it/standalone-apis/database-validation\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt\" href=\"https://docs.didit.me/pt/standalone-apis/database-validation\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ca\" href=\"https://docs.didit.me/ca/standalone-apis/database-validation\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"id\" href=\"https://docs.didit.me/id/standalone-apis/database-validation\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ru\" href=\"https://docs.didit.me/ru/standalone-apis/database-validation\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ko\" href=\"https://docs.didit.me/ko/standalone-apis/database-validation\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.didit.me/zh/standalone-apis/database-validation\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ar\" href=\"https://docs.didit.me/ar/standalone-apis/database-validation\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"hi\" href=\"https://docs.didit.me/hi/standalone-apis/database-validation\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.didit.me/standalone-apis/database-validation\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://didit.me/#organization\",\"name\":\"Didit\",\"legalName\":\"Didit Protocol\",\"url\":\"https://didit.me\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://didit.me/logos/primary-horizontal-light.png\"},\"sameAs\":[\"https://www.linkedin.com/company/91001155\",\"https://www.youtube.com/@getdidit\",\"https://github.com/didit-protocol\",\"https://x.com/didit\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.didit.me#website\",\"name\":\"Didit Docs\",\"url\":\"https://docs.didit.me\",\"publisher\":{\"@id\":\"https://didit.me/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.didit.me/standalone-apis/database-validation#webpage\",\"url\":\"https://docs.didit.me/standalone-apis/database-validation\",\"name\":\"Database Validation API: National ID Match\",\"description\":\"POST /v3/database-validation/ to validate identity data against 100+ national and global sources with 1x1 and 2x2 waterfall matching. Pay-per-call.\",\"dateModified\":\"2026-11-01T10:56:28.000Z\",\"isPartOf\":{\"@id\":\"https://docs.didit.me#website\"},\"breadcrumb\":{\"@id\":\"https://docs.didit.me/standalone-apis/database-validation#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.didit.me/standalone-apis/database-validation#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Didit Docs\",\"item\":\"https://docs.didit.me\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Database Validation API: National ID Match\",\"item\":\"https://docs.didit.me/standalone-apis/database-validation\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.didit.me/standalone-apis/database-validation#apireference\",\"headline\":\"Database Validation API: National ID Match\",\"name\":\"Database Validation API: National ID Match\",\"description\":\"POST /v3/database-validation/ to validate identity data against 100+ national and global sources with 1x1 and 2x2 waterfall matching. Pay-per-call.\",\"url\":\"https://docs.didit.me/standalone-apis/database-validation\",\"mainEntityOfPage\":{\"@id\":\"https://docs.didit.me/standalone-apis/database-validation#webpage\"},\"dateModified\":\"2026-11-01T10:56:28.000Z\",\"keywords\":\"database validation API, identity database API, KYC database check, national ID validation, government and authoritative database API, identity verification API, waterfall providers, 2x2 matching, Trulioo alternative, Didit API\",\"publisher\":{\"@id\":\"https://didit.me/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.didit.me#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Didit Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Didit\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/standalone-apis/database-validation.md","siteName":"Didit Docs","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Get Started","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/rocket.svg","pages":[{"title":"Get Started","href":""}]},{"tab":"Integrate / SDKs","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/code.svg","pages":[{"title":"Integrate / SDKs","href":"/integration/sdks"}]},{"tab":"API Reference","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/code.svg","groups":[{"group":"Overview","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/overview.svg","pages":[{"title":"Didit API Reference: Identity Verification REST API","sidebarTitle":"API Reference","href":"/api-reference/overview"},{"title":"Healthcheck API: Public Liveness Probe","sidebarTitle":"Healthcheck","openapi":"openapi-healthcheck.json GET /system/healthcheck","href":"/api-reference/healthcheck"},{"title":"Service Status API: Public Didit Status Feed","sidebarTitle":"Service status","openapi":"openapi-25.json GET /v3/status/","href":"/api-reference/service-status"},{"title":"Bank Verification Pricing API: Public Price Feed","sidebarTitle":"Bank verification prices","openapi":"openapi-25.json GET /v3/organization/bank-verification-pricing/","href":"/api-reference/bank-verification-pricing"}]},{"group":"User and Business Verifications","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/user-verifications.svg","pages":[{"title":"Sessions API: Unified KYC \u0026 KYB Verification","sidebarTitle":"Overview","href":"/sessions-api/overview"},{"title":"Create Session API: Start KYC or KYB Verification","sidebarTitle":"Create Session","openapi":"openapi-25.json POST /v3/session/","href":"/sessions-api/create-session"},{"title":"Import Data from Another Provider","openapi":"openapi-25.json POST /v3/session/imports/","href":"/sessions-api/import-verifications"},{"title":"Retrieve Session API: KYC \u0026 KYB Decision Data","sidebarTitle":"Retrieve Session","openapi":"openapi-25.json GET /v3/session/{sessionId}/decision/","href":"/sessions-api/retrieve-session"},{"title":"List Sessions API: Filter KYC \u0026 KYB Sessions","sidebarTitle":"List Sessions","openapi":"openapi-25.json GET /v3/sessions/","href":"/sessions-api/list-sessions"},{"title":"Update Session Status API: Approve \u0026 Decline","sidebarTitle":"Update Session Status","openapi":"openapi-25.json PATCH /v3/session/{sessionId}/update-status/","href":"/sessions-api/update-status"},{"title":"Preview Resubmission Email","openapi":"openapi-25.json POST /v3/session/{sessionId}/resubmission-preview/","href":"/sessions-api/preview-resubmission"},{"title":"Preview Decision Email API: Approved and Declined Emails","sidebarTitle":"Preview Decision Email","openapi":"openapi-25.json POST /v3/session/{sessionId}/decision-email-preview/","href":"/sessions-api/preview-decision-email"},{"title":"Update Feature Status API: Approve/Decline a Single Step","sidebarTitle":"Update Feature Status","openapi":"openapi-25.json PATCH /v3/session/{sessionId}/features/{nodeId}/update-status/","href":"/sessions-api/update-feature-status"},{"title":"List Feature Overrides API: Step Status History","sidebarTitle":"List Feature Overrides","openapi":"openapi-25.json GET /v3/session/{sessionId}/features/overrides/","href":"/sessions-api/list-feature-overrides"},{"title":"Cancel Feature Override API: Drop a Pending Step Override","sidebarTitle":"Cancel Feature Override","openapi":"openapi-25.json POST /v3/session/{sessionId}/features/overrides/{overrideId}/cancel/","href":"/sessions-api/cancel-feature-override"},{"title":"Update AML Hit Status API: Clear \u0026 Confirm Matches","sidebarTitle":"Update AML Hit Status","openapi":"openapi-25.json PATCH /v3/session/{sessionId}/update-aml-hit-status/","href":"/sessions-api/update-aml-hit-status"},{"title":"Update Session Data API: Fix KYC \u0026 KYB Fields","sidebarTitle":"Update Session Data","href":"/sessions-api/update-data"},{"title":"Update AML Check Status API","sidebarTitle":"Update AML Check Status","openapi":"openapi-25.json PATCH /v3/session/{sessionId}/update-aml-status/","href":"/sessions-api/update-aml-status"},{"title":"Update Document AI Data API","sidebarTitle":"Update Document AI Data","openapi":"openapi-25.json PATCH /v3/document-ai/{sessionId}/documents/{documentUuid}/","href":"/sessions-api/update-document-ai-data"},{"title":"Regenerate Key People KYC Session API","sidebarTitle":"Regenerate Key People KYC Session","openapi":"openapi-25.json POST /v3/session/{sessionId}/kyb/parties/{partyUuid}/regenerate/","href":"/sessions-api/regenerate-kyb-party"},{"title":"Upload KYB Documents API","sidebarTitle":"Upload KYB Documents","openapi":"openapi-25.json POST /v3/session/{sessionId}/kyb/documents/","href":"/sessions-api/kyb-upload-documents"},{"title":"List KYB Extracted Parties API","sidebarTitle":"List KYB Extracted Parties","openapi":"openapi-25.json GET /v3/session/{sessionId}/kyb/extracted-parties/","href":"/sessions-api/kyb-extracted-parties"},{"title":"List KYB Party Drafts API","sidebarTitle":"List KYB Party Drafts","openapi":"openapi-25.json GET /v3/session/{sessionId}/kyb/parties/drafts/","href":"/sessions-api/kyb-list-party-drafts"},{"title":"Create KYB Party Draft API","sidebarTitle":"Create KYB Party Draft","openapi":"openapi-25.json POST /v3/session/{sessionId}/kyb/parties/drafts/","href":"/sessions-api/kyb-create-party-draft"},{"title":"Edit KYB Party Draft API","sidebarTitle":"Edit KYB Party Draft","openapi":"openapi-25.json PATCH /v3/session/{sessionId}/kyb/parties/drafts/{draftId}/","href":"/sessions-api/kyb-update-party-draft"},{"title":"Delete KYB Party Draft API","sidebarTitle":"Delete KYB Party Draft","openapi":"openapi-25.json DELETE /v3/session/{sessionId}/kyb/parties/drafts/{draftId}/","href":"/sessions-api/kyb-delete-party-draft"},{"title":"Submit KYB Key People API","sidebarTitle":"Submit KYB Key People","openapi":"openapi-25.json POST /v3/session/{sessionId}/kyb/parties/submit/","href":"/sessions-api/kyb-submit-parties"},{"title":"Add Images to a Session API","sidebarTitle":"Add Images to a Session","openapi":"openapi-25.json PATCH /v3/session/{sessionId}/add-images/","href":"/sessions-api/add-images"},{"title":"Delete Session API: GDPR Right-to-Be-Forgotten","sidebarTitle":"Delete Session","openapi":"openapi-25.json DELETE /v3/session/{sessionId}/delete/","href":"/sessions-api/delete-session"},{"title":"Generate PDF API: KYC \u0026 KYB Compliance Reports","sidebarTitle":"Generate PDF","openapi":"openapi-25.json GET /v3/session/{sessionId}/generate-pdf/","href":"/sessions-api/generate-pdf"},{"title":"Export Session Files API: Download Every File as One ZIP","sidebarTitle":"Export files","openapi":"openapi-25.json POST /v3/session/{sessionId}/files-export/","href":"/sessions-api/export-files"},{"title":"Get Session Files Export API: Status and Download Link","sidebarTitle":"Get files export","openapi":"openapi-25.json GET /v3/session/{sessionId}/files-export/{exportId}/","href":"/sessions-api/get-files-export"},{"group":"E-signatures","pages":[{"title":"Download Signed Document API: Signed PDF","sidebarTitle":"Download a Signed Document","openapi":"openapi-25.json GET /v3/session/{sessionId}/signatures/{nodeId}/documents/{documentId}/file/","href":"/sessions-api/electronic-signature/download-signed-document"},{"title":"Signature Evidence API: Audit Trail PDF","sidebarTitle":"Download the Signature Evidence","openapi":"openapi-25.json GET /v3/session/{sessionId}/signatures/{nodeId}/evidence/","href":"/sessions-api/electronic-signature/download-evidence"},{"title":"Signature Image API: Adopted Signature PNG","sidebarTitle":"Download a Signature Image","openapi":"openapi-25.json GET /v3/session/{sessionId}/signatures/{nodeId}/fields/{fieldId}/image/","href":"/sessions-api/electronic-signature/download-field-image"},{"title":"Validate Signatures API: Re-check Signed PDFs","sidebarTitle":"Validate Signatures","openapi":"openapi-25.json POST /v3/session/{sessionId}/signatures/{nodeId}/validate/","href":"/sessions-api/electronic-signature/validate-signatures"}]},{"title":"Share Session API: Reusable KYC Between Partners","sidebarTitle":"Overview","href":"/sessions-api/share-session/overview"},{"title":"Share Session API: Generate Share Token","sidebarTitle":"Share Session","openapi":"openapi-25.json POST /v3/session/{sessionId}/share/","href":"/sessions-api/share-session/share"},{"title":"Import Shared Session API: Reusable KYC \u0026 KYB","sidebarTitle":"Import Shared Session","openapi":"openapi-25.json POST /v3/session/import-shared/","href":"/sessions-api/share-session/import"}]},{"group":"Lists","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/lists.svg","pages":[{"title":"Lists API: Blocklists \u0026 Allowlists","sidebarTitle":"Overview","href":"/management-api/lists/overview"},{"title":"List All Lists API: Blocklists \u0026 Allowlists","sidebarTitle":"List Lists","openapi":"openapi-25.json GET /v3/lists/","href":"/management-api/lists/list"},{"title":"Create List API: Allowlist \u0026 Custom List","sidebarTitle":"Create List","openapi":"openapi-25.json POST /v3/lists/","href":"/management-api/lists/create"},{"title":"Get List API: Retrieve Compliance List","sidebarTitle":"Get List","openapi":"openapi-25.json GET /v3/lists/{list_uuid}/","href":"/management-api/lists/get"},{"title":"Update List API: Edit Compliance List","sidebarTitle":"Update List","openapi":"openapi-25.json PATCH /v3/lists/{list_uuid}/","href":"/management-api/lists/update"},{"title":"Delete List API: Remove Compliance List","sidebarTitle":"Delete List","openapi":"openapi-25.json DELETE /v3/lists/{list_uuid}/","href":"/management-api/lists/delete"},{"title":"List Entries API: Blocklist \u0026 Allowlist Items","sidebarTitle":"List Entries","openapi":"openapi-25.json GET /v3/lists/{list_uuid}/entries/","href":"/management-api/lists/list-entries"},{"title":"Create List Entry API: Blocklist \u0026 Allowlist","sidebarTitle":"Create List Entry","openapi":"openapi-25.json POST /v3/lists/{list_uuid}/entries/","href":"/management-api/lists/create-entry"},{"title":"Delete List Entry API: Unblock Item","sidebarTitle":"Delete List Entry","openapi":"openapi-25.json DELETE /v3/lists/{list_uuid}/entries/{entry_uuid}/","href":"/management-api/lists/delete-entry"},{"title":"Upload Face API: Biometric Lists","sidebarTitle":"Upload Face","openapi":"openapi-25.json POST /v3/lists/{list_uuid}/entries/face-upload/","href":"/management-api/lists/upload-face"}]},{"group":"Blocklist","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/lists.svg","pages":[{"title":"List Blocklisted Items API","sidebarTitle":"List Blocklisted Items","openapi":"openapi-25.json GET /v3/blocklist/","href":"/management-api/blocklist/list"},{"title":"Add to Blocklist API: Block Session Items","sidebarTitle":"Add to Blocklist","openapi":"openapi-25.json POST /v3/blocklist/add/","href":"/management-api/blocklist/add"},{"title":"Remove from Blocklist API: Unblock Session Items","sidebarTitle":"Remove from Blocklist","openapi":"openapi-25.json POST /v3/blocklist/remove/","href":"/management-api/blocklist/remove"}]},{"group":"Workflows","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/workflows.svg","pages":[{"title":"List Workflows API: Verification Flows","sidebarTitle":"List Workflows","openapi":"openapi-25.json GET /v3/workflows/","href":"/management-api/workflows/list"},{"title":"Create Workflow API: Build KYC Flow","sidebarTitle":"Create Workflow","openapi":"openapi-25.json POST /v3/workflows/","href":"/management-api/workflows/create"},{"title":"Workflow Feature Configs API Reference","sidebarTitle":"Workflow Feature Configs","href":"/management-api/workflows/feature-configs"},{"title":"Get Workflow API: Retrieve KYC Flow","sidebarTitle":"Get Workflow","openapi":"openapi-25.json GET /v3/workflows/{settings_uuid}/","href":"/management-api/workflows/get"},{"title":"Update Workflow API: Edit KYC Flow","sidebarTitle":"Update Workflow","openapi":"openapi-25.json PATCH /v3/workflows/{settings_uuid}/","href":"/management-api/workflows/update"},{"title":"Delete Workflow API: Remove KYC Flow","sidebarTitle":"Delete Workflow","openapi":"openapi-25.json DELETE /v3/workflows/{settings_uuid}/","href":"/management-api/workflows/delete"}]},{"group":"Questionnaires","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/task-square.svg","pages":[{"title":"List Questionnaires API: KYC Forms","sidebarTitle":"List Questionnaires","openapi":"openapi-25.json GET /v3/questionnaires/","href":"/management-api/questionnaires/list"},{"title":"Create Questionnaire API: Custom KYC Form","sidebarTitle":"Create Questionnaire","openapi":"openapi-25.json POST /v3/questionnaires/","href":"/management-api/questionnaires/create"},{"title":"Get Questionnaire API: Retrieve KYC Form","sidebarTitle":"Get Questionnaire","openapi":"openapi-25.json GET /v3/questionnaires/{questionnaire_uuid}/","href":"/management-api/questionnaires/get"},{"title":"Update Questionnaire API: Edit KYC Form","sidebarTitle":"Update Questionnaire","openapi":"openapi-25.json PATCH /v3/questionnaires/{questionnaire_uuid}/","href":"/management-api/questionnaires/update"},{"title":"Delete Questionnaire API: Remove KYC Form","sidebarTitle":"Delete Questionnaire","openapi":"openapi-25.json DELETE /v3/questionnaires/{questionnaire_uuid}/","href":"/management-api/questionnaires/delete"}]},{"group":"Users","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/users.svg","pages":[{"title":"List Users API: Vendor User Entities","sidebarTitle":"List Users","openapi":"openapi-25.json GET /v3/users/","href":"/management-api/users/list"},{"title":"Create User API: Vendor User Entity","sidebarTitle":"Create User","openapi":"openapi-25.json POST /v3/users/create/","href":"/management-api/users/create"},{"title":"Upload User Face API: Vendor User Profile","sidebarTitle":"Upload User Face","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/","href":"/management-api/users/upload-face"},{"title":"Get User API: Vendor User Entity","sidebarTitle":"Get User","openapi":"openapi-25.json GET /v3/users/{vendor_data}/","href":"/management-api/users/get"},{"title":"User History PDF API: All Sessions of a User","sidebarTitle":"User history PDF","openapi":"openapi-25.json GET /v3/users/{vendor_data}/generate-pdf/","href":"/management-api/users/generate-pdf"},{"title":"Update User API: Vendor User Entity","sidebarTitle":"Update User","openapi":"openapi-25.json PATCH /v3/users/{vendor_data}/","href":"/management-api/users/update"},{"title":"Update User Status API: Block or Flag","sidebarTitle":"Update User Status","openapi":"openapi-25.json PATCH /v3/users/{vendor_data}/update-status/","href":"/management-api/users/update-status"},{"title":"Batch Delete Users API: GDPR Erasure","sidebarTitle":"Batch Delete Users","openapi":"openapi-25.json POST /v3/users/delete/","href":"/management-api/users/delete"}]},{"group":"Biometric Templates","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/liveness.svg","pages":[{"title":"Biometric Templates API","sidebarTitle":"Overview","href":"/management-api/biometric-templates/overview"},{"title":"List Biometric Templates API","sidebarTitle":"List Templates","openapi":"openapi-25.json GET /v3/biometric-templates/","href":"/management-api/biometric-templates/list"},{"title":"Count Biometric Templates API","sidebarTitle":"Count Templates","openapi":"openapi-25.json GET /v3/biometric-templates/count/","href":"/management-api/biometric-templates/count"},{"title":"Get Biometric Template API","sidebarTitle":"Get Template","openapi":"openapi-25.json GET /v3/biometric-templates/{template_uuid}/","href":"/management-api/biometric-templates/get"},{"title":"Purge Biometric Template API","sidebarTitle":"Purge Template","openapi":"openapi-25.json DELETE /v3/biometric-templates/{template_uuid}/","href":"/management-api/biometric-templates/purge"},{"title":"Bulk Purge Biometric Templates API","sidebarTitle":"Bulk Purge","openapi":"openapi-25.json POST /v3/biometric-templates/delete/","href":"/management-api/biometric-templates/batch-purge"}]},{"group":"Businesses","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/businesses.svg","pages":[{"title":"List Businesses API: Vendor KYB Entities","sidebarTitle":"List Businesses","openapi":"openapi-25.json GET /v3/businesses/","href":"/management-api/businesses/list"},{"title":"Create Business API: Vendor KYB Entity","sidebarTitle":"Create Business","openapi":"openapi-25.json POST /v3/businesses/create/","href":"/management-api/businesses/create"},{"title":"Get Business API: Vendor KYB Entity","sidebarTitle":"Get Business","openapi":"openapi-25.json GET /v3/businesses/{vendor_data}/","href":"/management-api/businesses/get"},{"title":"Business Session PDF API","sidebarTitle":"Generate Business Session PDF","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/businesses/{business_session_id}/pdf/","href":"/management-api/businesses/generate-session-pdf"},{"title":"Update Business API: Vendor KYB Entity","sidebarTitle":"Update Business","openapi":"openapi-25.json PATCH /v3/businesses/{vendor_data}/","href":"/management-api/businesses/update"},{"title":"Update Business Status API: Block or Flag","sidebarTitle":"Update Business Status","openapi":"openapi-25.json PATCH /v3/businesses/{vendor_data}/update-status/","href":"/management-api/businesses/update-status"},{"title":"Batch Delete Businesses API: KYB Erasure","sidebarTitle":"Batch Delete Businesses","openapi":"openapi-25.json POST /v3/businesses/delete/","href":"/management-api/businesses/delete"}]},{"group":"AML Ongoing Monitoring","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/aml-screening.svg","pages":[{"title":"Toggle AML Monitoring for Users API","sidebarTitle":"Toggle for Users","openapi":"openapi-25.json POST /v3/users/aml-monitoring/","href":"/management-api/aml-monitoring/toggle-users"},{"title":"Toggle AML Monitoring for Businesses API","sidebarTitle":"Toggle for Businesses","openapi":"openapi-25.json POST /v3/businesses/aml-monitoring/","href":"/management-api/aml-monitoring/toggle-businesses"},{"title":"Get AML Monitoring Job API","sidebarTitle":"Get AML Monitoring Job","openapi":"openapi-25.json GET /v3/aml-monitoring/jobs/{job_id}/","href":"/management-api/aml-monitoring/get-job"}]},{"group":"Cases","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/clipboard-check.svg","pages":[{"title":"List Cases API","sidebarTitle":"List Cases","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/cases/","href":"/management-api/cases/list"},{"title":"Create Case API","sidebarTitle":"Create Case","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/","href":"/management-api/cases/create"},{"title":"Get Case API","sidebarTitle":"Get Case","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/","href":"/management-api/cases/get"},{"title":"Update Case API","sidebarTitle":"Update Case","openapi":"openapi-25.json PATCH /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/","href":"/management-api/cases/update"},{"title":"Delete Case API","sidebarTitle":"Delete Case","openapi":"openapi-25.json DELETE /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/","href":"/management-api/cases/delete"},{"title":"Resolve Case API","sidebarTitle":"Resolve Case","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/resolve/","href":"/management-api/cases/resolve"},{"title":"Request Info Case API","sidebarTitle":"Request Info (Awaiting User)","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/request-info/","href":"/management-api/cases/request-info"},{"title":"Transfer Case API","sidebarTitle":"Transfer Case","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/transfer/","href":"/management-api/cases/transfer"},{"title":"Print Case PDF API","sidebarTitle":"Print Case","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/print/","href":"/management-api/cases/print"},{"title":"Case Analytics API","sidebarTitle":"Case Analytics","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/cases/statistics/","href":"/management-api/cases/statistics"},{"title":"Bulk Update Case Status API","sidebarTitle":"Bulk Update Case Status","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/bulk/status/","href":"/management-api/cases/bulk-status"},{"title":"List Case Notes API","sidebarTitle":"List Case Notes","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/","href":"/management-api/cases/list-notes"},{"title":"Create Case Note API","sidebarTitle":"Create Case Note","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/","href":"/management-api/cases/create-note"}]},{"group":"Case Blueprints","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/sliders.svg","pages":[{"title":"List Case Blueprints API","sidebarTitle":"List Case Blueprints","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/","href":"/management-api/case-blueprints/list"},{"title":"Create Case Blueprint API","sidebarTitle":"Create Case Blueprint","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/","href":"/management-api/case-blueprints/create"},{"title":"Draft case blueprint with AI API","sidebarTitle":"Draft with AI","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/ai-draft/","href":"/management-api/case-blueprints/ai-draft"},{"title":"Install Blueprint Presets API","sidebarTitle":"Install Blueprint Presets","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/presets/install/","href":"/management-api/case-blueprints/install-presets"}]},{"group":"Networks","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/link.svg","pages":[{"title":"List Fraud Networks API","sidebarTitle":"List Networks","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/","href":"/management-api/networks/list"},{"title":"Get Fraud Network API","sidebarTitle":"Get Network","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/","href":"/management-api/networks/get"},{"title":"Add a Tag to a Fraud Network API","sidebarTitle":"Add Network Tag","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/add/","href":"/management-api/networks/add-tag"},{"title":"Remove a Tag from a Fraud Network API","sidebarTitle":"Remove Network Tag","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/remove/","href":"/management-api/networks/remove-tag"},{"title":"Fraud Network Graph API","sidebarTitle":"Get Network Graph","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/graph/","href":"/management-api/networks/graph"},{"title":"List Fraud Network Members API","sidebarTitle":"List Network Members","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/members/","href":"/management-api/networks/members"},{"title":"List Fraud Network Signals API","sidebarTitle":"List Network Signals","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/signals/","href":"/management-api/networks/signals"},{"title":"Fraud Network Timeline API","sidebarTitle":"Get Network Timeline","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/timeline/","href":"/management-api/networks/timeline"},{"title":"Fraud Network Map API","sidebarTitle":"Get Network Map","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/map/","href":"/management-api/networks/map"},{"title":"Network Membership Lookup API","sidebarTitle":"Membership Lookup","href":"/management-api/networks/membership-lookup"}]},{"group":"Async reports","pages":[{"title":"List Async Reports API","sidebarTitle":"List reports","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/reports/","href":"/management-api/reports/list"},{"title":"Retrieve Async Report API","sidebarTitle":"Retrieve report","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/reports/{report_uuid}/","href":"/management-api/reports/retrieve"},{"title":"Retry Async Report API","sidebarTitle":"Retry report","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/reports/{report_uuid}/retry/","href":"/management-api/reports/retry"}]},{"group":"Report Templates","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/task-square.svg","pages":[{"title":"List Report Templates API","sidebarTitle":"List Report Templates","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/report-templates/","href":"/management-api/report-templates/list"},{"title":"Create Report Template API","sidebarTitle":"Create Report Template","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/report-templates/","href":"/management-api/report-templates/create"}]},{"group":"Regulatory Reports","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/search-file.svg","pages":[{"title":"Create FIU Report From Case API","sidebarTitle":"Create Report From Case","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/","href":"/management-api/regulatory-reports/create-for-case"},{"title":"List FIU Reports API","sidebarTitle":"List Reports","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/","href":"/management-api/regulatory-reports/list"},{"title":"Validate FIU Report API","sidebarTitle":"Validate Report","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/validate/","href":"/management-api/regulatory-reports/validate"},{"title":"Finalize FIU Report API","sidebarTitle":"Finalize Report","openapi":"openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/finalize/","href":"/management-api/regulatory-reports/finalize"},{"title":"Delete FIU Report API","sidebarTitle":"Delete Report","openapi":"openapi-25.json DELETE /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/","href":"/management-api/regulatory-reports/delete"},{"title":"Get FIU Report Download URL API","sidebarTitle":"Get Report Download URL","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/download-url/","href":"/management-api/regulatory-reports/download-url"}]},{"group":"Transactions","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/transactions.svg","pages":[{"title":"List Transactions API: KYT Monitoring","sidebarTitle":"List Transactions","openapi":"openapi-25.json GET /v3/transactions/","href":"/management-api/transactions/list"},{"title":"Create Transaction API: KYT Submission","sidebarTitle":"Create Transaction","openapi":"openapi-25.json POST /v3/transactions/","href":"/management-api/transactions/create"},{"title":"Batch Delete Transactions API","sidebarTitle":"Batch Delete Transactions","openapi":"openapi-25.json DELETE /v3/organization/{organization_id}/application/{application_id}/transactions/delete/","href":"/management-api/transactions/delete"},{"title":"Get Transaction API: KYT Detail","sidebarTitle":"Get Transaction","openapi":"openapi-25.json GET /v3/transactions/{transaction_id}/","href":"/management-api/transactions/get"},{"title":"List Transaction Notes API","sidebarTitle":"List Transaction Notes","openapi":"openapi-25.json GET /v3/transactions/{transaction_id}/notes/","href":"/management-api/transactions/list-notes"},{"title":"Create Transaction Note API","sidebarTitle":"Create Transaction Note","openapi":"openapi-25.json POST /v3/transactions/{transaction_id}/notes/","href":"/management-api/transactions/create-note"},{"title":"List Related Transactions API","sidebarTitle":"List Related Transactions","openapi":"openapi-25.json GET /v3/transactions/{transaction_id}/related/","href":"/management-api/transactions/list-related"},{"title":"Transaction PDF Report API","sidebarTitle":"Generate Transaction PDF Report","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/transactions/{transaction_uuid}/pdf/","href":"/management-api/transactions/generate-pdf"},{"title":"Screen Wallet API: On-demand Crypto AML","sidebarTitle":"Screen Wallet","openapi":"openapi-25.json POST /v3/wallet-screening/","href":"/management-api/transactions/screen-wallet"},{"title":"Wallet Screening PDF Report API","sidebarTitle":"Screen Wallet PDF","openapi":"openapi-25.json POST /v3/wallet-screening/pdf/","href":"/management-api/transactions/screen-wallet-pdf"},{"title":"Mint SDK Transaction Token API: Client-Side KYT","sidebarTitle":"Mint SDK Transaction Token","openapi":"openapi-25.json POST /v3/transactions/sdk-token/","href":"/management-api/transactions/sdk-token"},{"title":"Submit Transaction from an SDK: Client-Side KYT","sidebarTitle":"Submit Transaction (SDK Token)","openapi":"openapi-25.json POST /v1/transactions/","href":"/management-api/transactions/submit-sdk"},{"title":"Get Transaction from an SDK: Client-Side KYT","sidebarTitle":"Get Transaction (SDK Token)","openapi":"openapi-25.json GET /v1/transactions/{transaction_id}/","href":"/management-api/transactions/get-sdk"},{"title":"List Transaction Monitoring Rules API","sidebarTitle":"List Rules","openapi":"openapi-25.json GET /v3/transactions/rules/","href":"/management-api/transactions/rules-list"},{"title":"Create Transaction Monitoring Rule API - KYT Rules","sidebarTitle":"Create Rule","openapi":"openapi-25.json POST /v3/transactions/rules/","href":"/management-api/transactions/rules-create"},{"title":"Get Transaction Monitoring Rule API","sidebarTitle":"Get Rule","openapi":"openapi-25.json GET /v3/transactions/rules/{rule_uuid}/","href":"/management-api/transactions/rules-get"},{"title":"Update Transaction Monitoring Rule API","sidebarTitle":"Update Rule","openapi":"openapi-25.json PATCH /v3/transactions/rules/{rule_uuid}/","href":"/management-api/transactions/rules-update"},{"title":"Delete Transaction Monitoring Rule API","sidebarTitle":"Delete Rule","openapi":"openapi-25.json DELETE /v3/transactions/rules/{rule_uuid}/","href":"/management-api/transactions/rules-delete"},{"title":"Backtest Transaction Monitoring Rules API","sidebarTitle":"Backtest Rules","openapi":"openapi-25.json POST /v3/transactions/rules/backtest/","href":"/management-api/transactions/rules-backtest"},{"title":"Transaction Monitoring Rule Library API - 150+ Presets","sidebarTitle":"List Rule Library","openapi":"openapi-25.json GET /v3/transactions/rules/library/","href":"/management-api/transactions/rules-library"},{"title":"Install Preset Transaction Monitoring Rules API","sidebarTitle":"Install Library Rules","openapi":"openapi-25.json POST /v3/transactions/rules/install/","href":"/management-api/transactions/rules-install"},{"title":"Uninstall Preset Transaction Monitoring Rules API","sidebarTitle":"Uninstall Library Rules","openapi":"openapi-25.json DELETE /v3/transactions/rules/install/","href":"/management-api/transactions/rules-uninstall"}]},{"group":"Monitoring Events","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/transactions.svg","pages":[{"title":"List Monitoring Events API","sidebarTitle":"List Monitoring Events","openapi":"openapi-25.json GET /v3/events/","href":"/management-api/monitoring-events/list"},{"title":"Create Monitoring Event API","sidebarTitle":"Create Monitoring Event","openapi":"openapi-25.json POST /v3/events/","href":"/management-api/monitoring-events/create"},{"title":"Batch Monitoring Events API","sidebarTitle":"Create Monitoring Events in Batch","openapi":"openapi-25.json POST /v3/events/batch/","href":"/management-api/monitoring-events/create-batch"},{"title":"Mint Monitoring SDK Token API","sidebarTitle":"Mint Monitoring SDK Token","openapi":"openapi-25.json POST /v3/events/sdk-token/","href":"/management-api/monitoring-events/sdk-token"},{"title":"Get Monitoring Event API","sidebarTitle":"Get Monitoring Event","openapi":"openapi-25.json GET /v3/events/{event_uuid}/","href":"/management-api/monitoring-events/get"},{"title":"Subject Event Timeline API","sidebarTitle":"Get Subject Event Timeline","openapi":"openapi-25.json GET /v3/events/subjects/{vendor_data}/","href":"/management-api/monitoring-events/subject-timeline"},{"title":"Event Enrichment Metrics API","sidebarTitle":"Get Event Enrichment Metrics","openapi":"openapi-25.json GET /v3/events/enrichment-metrics/","href":"/management-api/monitoring-events/enrichment-metrics"},{"title":"Delete Monitoring Event API","sidebarTitle":"Delete Monitoring Event","openapi":"openapi-25.json DELETE /v3/events/{event_uuid}/delete/","href":"/management-api/monitoring-events/delete"}]},{"group":"Travel Rule","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/transactions.svg","pages":[{"title":"Get Travel Rule Settings API: VASP Profile","sidebarTitle":"Get Travel Rule Settings","openapi":"openapi-25.json GET /v3/travel-rule/settings/","href":"/management-api/travel-rule/get-settings"},{"title":"Update Travel Rule Settings API: Enable \u0026 Configure","sidebarTitle":"Update Travel Rule Settings","openapi":"openapi-25.json PUT /v3/travel-rule/settings/","href":"/management-api/travel-rule/update-settings"},{"title":"Get Travel Rule Networks API","sidebarTitle":"Get Travel Rule Networks","openapi":"openapi-25.json GET /v3/travel-rule/networks/","href":"/management-api/travel-rule/get-networks"},{"title":"Get Travel Rule Network Questionnaire API","sidebarTitle":"Get Network Questionnaire","openapi":"openapi-25.json GET /v3/travel-rule/networks/questionnaire/","href":"/management-api/travel-rule/get-network-questionnaire"},{"title":"Save Travel Rule Network Questionnaire API","sidebarTitle":"Save Network Questionnaire Answers","openapi":"openapi-25.json PUT /v3/travel-rule/networks/questionnaire/","href":"/management-api/travel-rule/update-network-questionnaire"},{"title":"Submit Travel Rule Network Questionnaire API","sidebarTitle":"Submit Network Questionnaire","openapi":"openapi-25.json POST /v3/travel-rule/networks/questionnaire/submit/","href":"/management-api/travel-rule/submit-network-questionnaire"},{"title":"Request Travel Rule Network Access API","sidebarTitle":"Request a Travel Rule Network","openapi":"openapi-25.json POST /v3/travel-rule/networks/{network}/request/","href":"/management-api/travel-rule/request-network"},{"title":"Confirm the Travel Rule Compliance Email API","sidebarTitle":"Send the Compliance Email Confirmation","openapi":"openapi-25.json POST /v3/travel-rule/settings/compliance-email/confirmation/","href":"/management-api/travel-rule/send-compliance-email-confirmation"},{"title":"List Travel Rule Transfers API","sidebarTitle":"List Travel Rule Transfers","openapi":"openapi-25.json GET /v3/travel-rule/transfers/","href":"/management-api/travel-rule/list-transfers"},{"title":"List Unmatched Travel Rule Deposits API","sidebarTitle":"List Unmatched Deposits","openapi":"openapi-25.json GET /v3/travel-rule/unmatched/","href":"/management-api/travel-rule/list-unmatched-deposits"},{"title":"Match Travel Rule Deposit API: Pair a Message","sidebarTitle":"Match Unmatched Deposit","openapi":"openapi-25.json POST /v3/travel-rule/unmatched/{transaction_uuid}/match/","href":"/management-api/travel-rule/match-unmatched-deposit"},{"title":"Travel Rule Transfer Actions API: Finish, Resend, Update","sidebarTitle":"Finish, Cancel, Resend, or Update a Transfer","openapi":"openapi-25.json PATCH /v3/transactions/{transaction_id}/travel-rule/","href":"/management-api/travel-rule/update-transfer"},{"title":"Create or email a Travel Rule end-user link","sidebarTitle":"Create an end-user link","openapi":"openapi-25.json POST /v3/transactions/{transaction_id}/travel-rule/user-link/","href":"/management-api/travel-rule/create-user-link"},{"title":"Confirm Wallet Ownership API: Travel Rule Beneficiary","sidebarTitle":"Confirm or Deny Wallet Ownership","openapi":"openapi-25.json POST /v3/transactions/{transaction_id}/travel-rule/ownership/","href":"/management-api/travel-rule/confirm-ownership"},{"title":"List Travel Rule Messages API","sidebarTitle":"List Travel Rule Messages","openapi":"openapi-25.json GET /v3/transactions/{transaction_id}/travel-rule/messages/","href":"/management-api/travel-rule/list-messages"},{"title":"Travel Rule delivery history API","sidebarTitle":"List delivery history","openapi":"openapi-25.json GET /v3/transactions/{transaction_id}/travel-rule/deliveries/","href":"/management-api/travel-rule/list-deliveries"},{"title":"Send Travel Rule Message API","sidebarTitle":"Send a Travel Rule Message","openapi":"openapi-25.json POST /v3/transactions/{transaction_id}/travel-rule/messages/","href":"/management-api/travel-rule/create-message"},{"title":"Register Inbound Sunrise Transfer API: Travel Rule","sidebarTitle":"Register Inbound (Sunrise) Transfer","openapi":"openapi-25.json POST /v3/travel-rule/inbound/","href":"/management-api/travel-rule/register-inbound"},{"title":"Trigger Test VASP Inbound Transfer API","sidebarTitle":"Trigger Test VASP Inbound Transfer","openapi":"openapi-25.json POST /v3/travel-rule/test-vasp/inbound/","href":"/management-api/travel-rule/trigger-test-vasp-inbound"},{"title":"VASP Directory Search API: Travel Rule Routes","sidebarTitle":"Search the VASP Directory","openapi":"openapi-25.json GET /v3/travel-rule/vasps/","href":"/management-api/travel-rule/search-vasps"},{"title":"Create a private Travel Rule VASP entry","sidebarTitle":"Create a VASP","openapi":"openapi-25.json POST /v3/travel-rule/vasps/","href":"/management-api/travel-rule/create-vasp"},{"title":"Get a VASP Directory Entry API: Travel Rule Routes","sidebarTitle":"Get a VASP Directory Entry","openapi":"openapi-25.json GET /v3/travel-rule/vasps/{vasp_id}/","href":"/management-api/travel-rule/get-vasp"},{"title":"Get a Counterparty VASP Decision API: Travel Rule","sidebarTitle":"Get Your Decision on a VASP","openapi":"openapi-25.json GET /v3/travel-rule/vasps/{vasp_id}/decision/","href":"/management-api/travel-rule/get-vasp-decision"},{"title":"Set a Counterparty VASP Decision API: Travel Rule","sidebarTitle":"Set Your Decision on a VASP","openapi":"openapi-25.json PUT /v3/travel-rule/vasps/{vasp_id}/decision/","href":"/management-api/travel-rule/set-vasp-decision"},{"title":"Clear a Counterparty VASP Decision API: Travel Rule","sidebarTitle":"Clear Your Decision on a VASP","openapi":"openapi-25.json DELETE /v3/travel-rule/vasps/{vasp_id}/decision/","href":"/management-api/travel-rule/clear-vasp-decision"},{"title":"Get a Counterparty VASP Screening API: Travel Rule","sidebarTitle":"Get a VASP's Entity Screening","openapi":"openapi-25.json GET /v3/travel-rule/vasps/{vasp_id}/screening/","href":"/management-api/travel-rule/get-vasp-screening"},{"title":"Screen a Counterparty VASP API: Sanctions Check","sidebarTitle":"Screen a Counterparty VASP","openapi":"openapi-25.json POST /v3/travel-rule/vasps/{vasp_id}/screening/","href":"/management-api/travel-rule/screen-vasp"},{"title":"List VASP Due-Diligence Questionnaires API","sidebarTitle":"List Due-Diligence Questionnaires with a VASP","openapi":"openapi-25.json GET /v3/travel-rule/vasps/{vasp_id}/questionnaires/","href":"/management-api/travel-rule/list-vasp-questionnaires"},{"title":"Send a VASP Due-Diligence Questionnaire API","sidebarTitle":"Send a Due-Diligence Questionnaire to a VASP","openapi":"openapi-25.json POST /v3/travel-rule/vasps/{vasp_id}/questionnaires/","href":"/management-api/travel-rule/send-vasp-questionnaire"},{"title":"List Counterparty Contacts API - Travel Rule Email Rail","sidebarTitle":"List Counterparty Contacts","openapi":"openapi-25.json GET /v3/travel-rule/counterparty-contacts/","href":"/management-api/travel-rule/list-counterparty-contacts"},{"title":"Add a Counterparty Contact API - Travel Rule Email Rail","sidebarTitle":"Add a Counterparty Contact","openapi":"openapi-25.json POST /v3/travel-rule/counterparty-contacts/","href":"/management-api/travel-rule/create-counterparty-contact"},{"title":"Delete a Counterparty Contact API - Travel Rule","sidebarTitle":"Delete a Counterparty Contact","openapi":"openapi-25.json DELETE /v3/travel-rule/counterparty-contacts/{contact_uuid}/","href":"/management-api/travel-rule/delete-counterparty-contact"},{"title":"List Wallet Addresses API: Travel Rule Address Book","sidebarTitle":"List Wallet Addresses","openapi":"openapi-25.json GET /v3/travel-rule/wallet-addresses/","href":"/management-api/travel-rule/list-wallet-addresses"},{"title":"Register Wallet Address API: Travel Rule Address Book","sidebarTitle":"Register Wallet Address","openapi":"openapi-25.json POST /v3/travel-rule/wallet-addresses/","href":"/management-api/travel-rule/create-wallet-address"},{"title":"Import Wallet Addresses API: Travel Rule Address Book","sidebarTitle":"Import Wallet Addresses","openapi":"openapi-25.json POST /v3/travel-rule/wallet-addresses/import/","href":"/management-api/travel-rule/import-wallet-addresses"},{"title":"Update Wallet Address API: Travel Rule Address Book","sidebarTitle":"Update Wallet Address","openapi":"openapi-25.json PATCH /v3/travel-rule/wallet-addresses/{entry_uuid}/","href":"/management-api/travel-rule/update-wallet-address"},{"title":"Delete Wallet Address API: Travel Rule Address Book","sidebarTitle":"Delete Wallet Address","openapi":"openapi-25.json DELETE /v3/travel-rule/wallet-addresses/{entry_uuid}/","href":"/management-api/travel-rule/delete-wallet-address"},{"title":"List Screenshot Wallet Proofs API - Travel Rule Review","sidebarTitle":"List Wallet Proofs to Review","openapi":"openapi-25.json GET /v3/travel-rule/wallet-proofs/","href":"/management-api/travel-rule/list-wallet-proofs"},{"title":"Approve or Reject a Screenshot Wallet Proof API","sidebarTitle":"Decide a Wallet Proof","openapi":"openapi-25.json POST /v3/travel-rule/wallet-proofs/{proof_uuid}/decision/","href":"/management-api/travel-rule/decide-wallet-proof"},{"title":"Mint Wallet-Ownership Widget API: Proof of Control","sidebarTitle":"Mint Wallet-Ownership Widget Session","openapi":"openapi-25.json POST /v3/travel-rule/widget-session/","href":"/management-api/travel-rule/create-widget-session"},{"title":"Get Wallet-Ownership Widget Context API","sidebarTitle":"Get Widget Context","openapi":"openapi-25.json GET /v3/travel-rule/widget/{token}/","href":"/management-api/travel-rule/get-widget-context"},{"title":"Start a Wallet-Ownership Proof API - Travel Rule Widget","sidebarTitle":"Start a Widget Proof","openapi":"openapi-25.json POST /v3/travel-rule/widget/{token}/proofs/","href":"/management-api/travel-rule/create-widget-proof"},{"title":"Submit Wallet-Ownership Proof Evidence API - Travel Rule","sidebarTitle":"Submit Widget Proof Evidence","openapi":"openapi-25.json POST /v3/travel-rule/widget/{token}/proofs/{proof_id}/verify/","href":"/management-api/travel-rule/verify-widget-proof"},{"title":"Widget VASP Selection API: Travel Rule Counterparty","sidebarTitle":"Pick the Counterparty VASP in the Wallet Widget","openapi":"openapi-25.json POST /v3/travel-rule/widget/{token}/vasps/","href":"/management-api/travel-rule/select-widget-vasp"},{"title":"Widget VASP Picker API: Travel Rule Directory Search","sidebarTitle":"Search VASPs from the Wallet Widget","openapi":"openapi-25.json GET /v3/travel-rule/widget/{token}/vasps/","href":"/management-api/travel-rule/search-widget-vasps"},{"title":"Get Email Pickup Info API: Travel Rule Email Rail","sidebarTitle":"Get Email Pickup Info","openapi":"openapi-25.json GET /v3/travel-rule/pickup/{token}/","href":"/management-api/travel-rule/get-pickup"},{"title":"Respond to Email Pickup API: Travel Rule Email Rail","sidebarTitle":"Respond to Email Pickup","openapi":"openapi-25.json POST /v3/travel-rule/pickup/{token}/respond/","href":"/management-api/travel-rule/respond-pickup"},{"title":"List Pickup Messages API - Travel Rule Email Rail","sidebarTitle":"List Pickup Messages","openapi":"openapi-25.json GET /v3/travel-rule/pickup/{token}/messages/","href":"/management-api/travel-rule/list-pickup-messages"},{"title":"Reply in Pickup Portal API - Travel Rule Email Rail","sidebarTitle":"Reply in the Pickup Portal","openapi":"openapi-25.json POST /v3/travel-rule/pickup/{token}/messages/","href":"/management-api/travel-rule/create-pickup-message"},{"title":"Get Join Invitation API - Travel Rule Free Join","sidebarTitle":"Get Join Invitation","openapi":"openapi-25.json GET /v3/travel-rule/join/{token}/","href":"/management-api/travel-rule/get-join-invitation"},{"title":"Register a Free Travel Rule Account API","sidebarTitle":"Register a Free Travel Rule Account","openapi":"openapi-25.json POST /v3/travel-rule/join/{token}/","href":"/management-api/travel-rule/register-join"},{"title":"Verify a Free Travel Rule Account API","sidebarTitle":"Verify a Free Travel Rule Account","openapi":"openapi-25.json POST /v3/travel-rule/join/{token}/verify/","href":"/management-api/travel-rule/verify-join"},{"title":"Get Free Workspace API - Travel Rule Free Join","sidebarTitle":"Get Free Workspace","openapi":"openapi-25.json GET /v3/travel-rule/workspace/","href":"/management-api/travel-rule/get-workspace"},{"title":"Claim a Directory Entry API - Travel Rule Free Join","sidebarTitle":"Claim a Directory Entry","openapi":"openapi-25.json POST /v3/travel-rule/workspace/claim/","href":"/management-api/travel-rule/claim-workspace"},{"title":"Send Domain Code API - Travel Rule Free Join","sidebarTitle":"Send Domain Code","openapi":"openapi-25.json POST /v3/travel-rule/workspace/domain/code/","href":"/management-api/travel-rule/send-workspace-domain-code"},{"title":"Confirm Domain Code API - Travel Rule Free Join","sidebarTitle":"Confirm Domain Code","openapi":"openapi-25.json POST /v3/travel-rule/workspace/domain/confirm/","href":"/management-api/travel-rule/confirm-workspace-domain"},{"title":"Verify Domain by DNS API - Travel Rule Free Join","sidebarTitle":"Verify Domain by DNS","openapi":"openapi-25.json POST /v3/travel-rule/workspace/domain/dns/","href":"/management-api/travel-rule/verify-workspace-domain-dns"},{"title":"Enable Outbound Billing API - Travel Rule Free Join","sidebarTitle":"Enable Outbound Billing","openapi":"openapi-25.json POST /v3/travel-rule/workspace/billing/","href":"/management-api/travel-rule/enable-workspace-billing"}]},{"group":"Session Operations","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/play.svg","pages":[{"title":"Batch Delete Sessions API: KYC Cleanup","sidebarTitle":"Batch Delete Sessions","openapi":"openapi-25.json POST /v3/sessions/delete/","href":"/management-api/sessions/batch-delete"},{"title":"Get Session Deletion Job API","sidebarTitle":"Get Session Deletion Job","openapi":"openapi-25.json GET /v3/sessions/delete/{job_id}/","href":"/management-api/sessions/get-deletion-job"},{"title":"List Session Reviews API: KYC Audit Log","sidebarTitle":"List Session Reviews","openapi":"openapi-25.json GET /v3/sessions/{session_id}/reviews/","href":"/management-api/sessions/list-reviews"},{"title":"Create Session Review API: Manual KYC","sidebarTitle":"Create Session Review","openapi":"openapi-25.json POST /v3/sessions/{session_id}/reviews/","href":"/management-api/sessions/create-review"},{"title":"List Session Events API","sidebarTitle":"List Session Events","openapi":"openapi-25.json GET /v3/session/{sessionId}/events/","href":"/management-api/sessions/list-events"},{"title":"List Session Webhook Deliveries API","sidebarTitle":"List Session Webhook Deliveries","openapi":"openapi-25.json GET /v3/session/{sessionId}/webhooks/","href":"/management-api/sessions/list-webhooks"},{"title":"Get Session Webhook Delivery API","sidebarTitle":"Get Session Webhook Delivery","openapi":"openapi-25.json GET /v3/session/{sessionId}/webhook/{webhook_uuid}","href":"/management-api/sessions/get-webhook"},{"title":"Resend Session Webhook Delivery API","sidebarTitle":"Resend Session Webhook Delivery","openapi":"openapi-25.json POST /v3/session/{sessionId}/webhook/{webhook_uuid}/resend","href":"/management-api/sessions/resend-webhook"},{"title":"List AML Screening History API","sidebarTitle":"List AML Screening History","openapi":"openapi-25.json GET /v3/session/{sessionId}/aml-screening-history/","href":"/management-api/sessions/aml-screening-history"},{"title":"Export AML Screening History as CSV API","sidebarTitle":"Export AML Screening History","openapi":"openapi-25.json GET /v3/session/{sessionId}/aml-screening-history/export/","href":"/management-api/sessions/export-aml-screening-history"}]},{"group":"Customization","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/sliders.svg","pages":[{"title":"Get Branding Customization API","sidebarTitle":"Get Branding","openapi":"openapi-25.json GET /v3/customization/","href":"/management-api/customization/get"},{"title":"Update Branding Customization API","sidebarTitle":"Update Branding","openapi":"openapi-25.json PATCH /v3/customization/","href":"/management-api/customization/update"}]},{"group":"Webhook","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/link.svg","pages":[{"title":"List Webhook Destinations API","sidebarTitle":"List Webhook Destinations","openapi":"openapi-25.json GET /v3/webhook/destinations/","href":"/management-api/webhook/list-destinations"},{"title":"Create Webhook Destination API","sidebarTitle":"Create Webhook Destination","openapi":"openapi-25.json POST /v3/webhook/destinations/","href":"/management-api/webhook/create-destination"},{"title":"Retrieve a Webhook Destination: Management API","sidebarTitle":"Get Webhook Destination","openapi":"openapi-25.json GET /v3/webhook/destinations/{destination_uuid}/","href":"/management-api/webhook/get-destination"},{"title":"Update Webhook Destination API","sidebarTitle":"Update Webhook Destination","openapi":"openapi-25.json PATCH /v3/webhook/destinations/{destination_uuid}/","href":"/management-api/webhook/update-destination"},{"title":"Delete Webhook Destination API","sidebarTitle":"Delete Webhook Destination","openapi":"openapi-25.json DELETE /v3/webhook/destinations/{destination_uuid}/","href":"/management-api/webhook/delete-destination"},{"title":"Get Webhook Configuration API","sidebarTitle":"Get Webhook Configuration","openapi":"openapi-25.json GET /v3/webhook/","href":"/management-api/webhook/get-config"},{"title":"Update Webhook Configuration API","sidebarTitle":"Update Webhook Configuration","openapi":"openapi-25.json PATCH /v3/webhook/","href":"/management-api/webhook/update-config"},{"title":"Webhook Destination Analytics API","sidebarTitle":"Get Webhook Destination Analytics","openapi":"openapi-25.json GET /v3/webhook/destinations/{destination_uuid}/analytics/","href":"/management-api/webhook/destination-analytics"},{"title":"Webhook Destination Failure Activity API","sidebarTitle":"List destination activity","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/webhook/destinations/{destination_uuid}/activity/","href":"/management-api/webhook/destination-activity"},{"title":"List Webhook Deliveries API","sidebarTitle":"List Webhook Destination Deliveries","openapi":"openapi-25.json GET /v3/webhook/destinations/{destination_uuid}/deliveries/","href":"/management-api/webhook/list-deliveries"},{"title":"Get Webhook Delivery API","sidebarTitle":"Get Webhook Destination Delivery","openapi":"openapi-25.json GET /v3/webhook/destinations/{destination_uuid}/deliveries/{delivery_uuid}/","href":"/management-api/webhook/get-delivery"},{"title":"Resend Webhook Delivery API","sidebarTitle":"Resend Webhook Destination Delivery","openapi":"openapi-25.json POST /v3/webhook/destinations/{destination_uuid}/deliveries/{delivery_uuid}/resend/","href":"/management-api/webhook/resend-delivery"}]},{"group":"Billing","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/billing.svg","pages":[{"title":"Get Credit Balance API: KYC Billing","sidebarTitle":"Get Credit Balance","openapi":"openapi-25.json GET /v3/billing/balance/","href":"/management-api/billing/balance"},{"title":"Top Up Credits API","sidebarTitle":"Top Up Credits","openapi":"openapi-25.json POST /v3/billing/top-up/","href":"/management-api/billing/top-up"}]},{"group":"Analytics","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/overview.svg","pages":[{"title":"Application Analytics API","sidebarTitle":"Get Application Analytics","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/analytics/","href":"/management-api/analytics/get"},{"title":"Today's Verifications by Hour API","sidebarTitle":"Get Today's Verifications by Hour","openapi":"openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/analytics/today/","href":"/management-api/analytics/today-by-hour"}]},{"group":"Management API Overview","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/info.svg","pages":[{"title":"Management API v3: Workflows \u0026 Billing","sidebarTitle":"Management API","href":"/sessions-api/management-api"}]},{"group":"Auth API (Programmatic)","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/key.svg","pages":[{"title":"Auth API: Programmatic Registration","sidebarTitle":"Register Account","openapi":"openapi-auth.json POST /programmatic/register/","href":"/auth-api/register"},{"title":"Verify Email API: Get Didit API Credentials","sidebarTitle":"Verify Email","openapi":"openapi-auth.json POST /programmatic/verify-email/","href":"/auth-api/verify-email"},{"title":"Programmatic Login API: Headless Auth Tokens","sidebarTitle":"Login","openapi":"openapi-auth.json POST /programmatic/login/","href":"/auth-api/login"},{"title":"Get Credentials API: Fetch client_id \u0026 api_key","sidebarTitle":"Get Credentials","openapi":"openapi-auth.json GET /organizations/me/{org_id}/applications/{app_id}/","href":"/auth-api/get-credentials"},{"title":"Create Application API: Programmatic Apps","sidebarTitle":"Create Application","openapi":"openapi-auth.json POST /organizations/me/{org_id}/applications/","href":"/auth-api/create-application"},{"title":"Update Application API: Manage Customer Apps","sidebarTitle":"Update Application","openapi":"openapi-auth.json PATCH /organizations/me/{org_id}/applications/{app_id}/","href":"/auth-api/update-application"}]},{"group":"Identity \u0026 Documents","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/id-scan.svg","pages":[{"title":"ID Verification API: Document OCR \u0026 Authenticity","sidebarTitle":"ID Verification API","openapi":"openapi-25.json POST /v3/id-verification/","href":"/standalone-apis/id-verification"},{"title":"Proof of Address API: POA Verification \u0026 OCR","sidebarTitle":"Proof of Address API","openapi":"openapi-25.json POST /v3/poa/","href":"/standalone-apis/proof-of-address"},{"title":"Address Validation API: Verify and Normalise Addresses","sidebarTitle":"Address Validation","openapi":"openapi-25.json POST /v3/address-validation/","href":"/standalone-apis/address-validation"}]},{"group":"Digital ID wallets","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/id-scan.svg","pages":[{"title":"Digital ID Wallet Verification APIs","sidebarTitle":"Digital ID wallet APIs","href":"/standalone-apis/digital-id-wallets"},{"title":"Digital ID Wallet API Catalog","sidebarTitle":"List digital ID wallets","openapi":"openapi-25.json GET /v3/id-verification/wallets/","href":"/standalone-apis/digital-id-wallet-catalog"},{"group":"Start verification","pages":[{"title":"Bank iD CONNECT Verification API","sidebarTitle":"Bank iD CONNECT","openapi":"openapi-25.json POST /v3/id-verification/wallets/bankid-cz/","href":"/api-reference/digital-id-wallets/bankid-cz"},{"title":"BankID Sweden Verification API","sidebarTitle":"BankID Sweden","openapi":"openapi-25.json POST /v3/id-verification/wallets/bankid-se/","href":"/api-reference/digital-id-wallets/bankid-se"},{"title":"Finnish Trust Network Verification API","sidebarTitle":"Finnish Trust Network","openapi":"openapi-25.json POST /v3/id-verification/wallets/ftn/","href":"/api-reference/digital-id-wallets/ftn"},{"title":"Google Wallet ID Verification API","sidebarTitle":"Google Wallet ID","openapi":"openapi-25.json POST /v3/id-verification/wallets/google-wallet/","href":"/api-reference/digital-id-wallets/google-wallet"},{"title":"MitID personal Verification API","sidebarTitle":"MitID personal","openapi":"openapi-25.json POST /v3/id-verification/wallets/mitid/","href":"/api-reference/digital-id-wallets/mitid"},{"title":"Mobile-ID Verification API","sidebarTitle":"Mobile-ID","openapi":"openapi-25.json POST /v3/id-verification/wallets/mobile-id/","href":"/api-reference/digital-id-wallets/mobile-id"},{"title":"Smart-ID Verification API","sidebarTitle":"Smart-ID","openapi":"openapi-25.json POST /v3/id-verification/wallets/smart-id/","href":"/api-reference/digital-id-wallets/smart-id"},{"title":"iDIN full identification Verification API","sidebarTitle":"iDIN full identification","openapi":"openapi-25.json POST /v3/id-verification/wallets/idin/","href":"/api-reference/digital-id-wallets/idin"},{"title":"Auðkenni Verification API","sidebarTitle":"Auðkenni","openapi":"openapi-25.json POST /v3/id-verification/wallets/audkenni/","href":"/api-reference/digital-id-wallets/audkenni"},{"title":"BankID Norway Verification API","sidebarTitle":"BankID Norway","openapi":"openapi-25.json POST /v3/id-verification/wallets/bankid-no/","href":"/api-reference/digital-id-wallets/bankid-no"},{"title":"Buypass ID Verification API","sidebarTitle":"Buypass ID","openapi":"openapi-25.json POST /v3/id-verification/wallets/buypass/","href":"/api-reference/digital-id-wallets/buypass"},{"title":"ConnectID Verification API","sidebarTitle":"ConnectID","openapi":"openapi-25.json POST /v3/id-verification/wallets/connectid/","href":"/api-reference/digital-id-wallets/connectid"},{"title":"Diia Verification API","sidebarTitle":"Diia","openapi":"openapi-25.json POST /v3/id-verification/wallets/diia/","href":"/api-reference/digital-id-wallets/diia"},{"title":"EUDI Wallet Verification API","sidebarTitle":"EUDI Wallet","openapi":"openapi-25.json POST /v3/id-verification/wallets/eudi/","href":"/api-reference/digital-id-wallets/eudi"},{"title":"Estonian ID-card Verification API","sidebarTitle":"Estonian ID-card","openapi":"openapi-25.json POST /v3/id-verification/wallets/idcard-ee/","href":"/api-reference/digital-id-wallets/idcard-ee"},{"title":"FranceConnect Verification API","sidebarTitle":"FranceConnect","openapi":"openapi-25.json POST /v3/id-verification/wallets/franceconnect/","href":"/api-reference/digital-id-wallets/franceconnect"},{"title":"Freja eID Verification API","sidebarTitle":"Freja eID","openapi":"openapi-25.json POST /v3/id-verification/wallets/frejaid/","href":"/api-reference/digital-id-wallets/frejaid"},{"title":"GOV.UK Wallet Verification API","sidebarTitle":"GOV.UK Wallet","openapi":"openapi-25.json POST /v3/id-verification/wallets/govuk-wallet/","href":"/api-reference/digital-id-wallets/govuk-wallet"},{"title":"MojeID Verification API","sidebarTitle":"MojeID","openapi":"openapi-25.json POST /v3/id-verification/wallets/mojeid/","href":"/api-reference/digital-id-wallets/mojeid"},{"title":"OneID Verification API","sidebarTitle":"OneID","openapi":"openapi-25.json POST /v3/id-verification/wallets/oneid/","href":"/api-reference/digital-id-wallets/oneid"},{"title":"Personalausweis Profile 2 Verification API","sidebarTitle":"Personalausweis Profile 2","openapi":"openapi-25.json POST /v3/id-verification/wallets/personalausweis/","href":"/api-reference/digital-id-wallets/personalausweis"},{"title":"UAE PASS Verification API","sidebarTitle":"UAE PASS","openapi":"openapi-25.json POST /v3/id-verification/wallets/uae-pass/","href":"/api-reference/digital-id-wallets/uae-pass"},{"title":"Vipps Plus Verification API","sidebarTitle":"Vipps Plus","openapi":"openapi-25.json POST /v3/id-verification/wallets/vipps/","href":"/api-reference/digital-id-wallets/vipps"},{"title":"eParaksts mobile Verification API","sidebarTitle":"eParaksts mobile","openapi":"openapi-25.json POST /v3/id-verification/wallets/eparaksts-mobile/","href":"/api-reference/digital-id-wallets/eparaksts-mobile"},{"title":"gov.br Verification API","sidebarTitle":"gov.br","openapi":"openapi-25.json POST /v3/id-verification/wallets/govbr/","href":"/api-reference/digital-id-wallets/govbr"},{"title":"itsme Verification API","sidebarTitle":"itsme","openapi":"openapi-25.json POST /v3/id-verification/wallets/itsme/","href":"/api-reference/digital-id-wallets/itsme"}]},{"title":"Get Digital ID Wallet Verification Result","sidebarTitle":"Get wallet verification","openapi":"openapi-25.json GET /v3/id-verification/wallets/verifications/{request_id}/","href":"/standalone-apis/digital-id-wallet-result"},{"title":"Submit a Digital Credentials Wallet Response","sidebarTitle":"Submit wallet response","openapi":"openapi-25.json POST /v3/id-verification/wallets/verifications/{request_id}/response/","href":"/standalone-apis/digital-id-wallet-response"},{"title":"Poll Smart-ID and Mobile-ID Authentication","sidebarTitle":"Poll wallet verification","openapi":"openapi-25.json POST /v3/id-verification/wallets/verifications/{request_id}/poll/","href":"/standalone-apis/digital-id-wallet-poll"},{"title":"Cancel Digital ID Wallet Verification","sidebarTitle":"Cancel wallet verification","openapi":"openapi-25.json POST /v3/id-verification/wallets/verifications/{request_id}/cancel/","href":"/standalone-apis/digital-id-wallet-cancel"}]},{"group":"Document AI","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/document-ai.svg","pages":[{"title":"Document AI API: Custom Document Data Extraction","sidebarTitle":"Document AI API","description":"POST /v3/document-ai/ extracts fields you define from any PDF or image server to server, with name matching and tampering checks. $0.20 per document.","openapi":"openapi-25.json POST /v3/document-ai/","href":"/standalone-apis/document-ai"}]},{"group":"Database Validation API","pages":[{"title":"Database Validation API: National ID Match","sidebarTitle":"Database Validation API","openapi":"openapi-25.json POST /v3/database-validation/","href":"/standalone-apis/database-validation"}]},{"group":"Database Validation","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/driver-2.svg","pages":[{"group":"🇦🇷 Argentina","pages":[{"title":"Argentina - DNI data verification API: Data Match","sidebarTitle":"Argentina - DNI data verification (RENAPER, no selfie)","description":"Argentina - DNI data verification (RENAPER, no selfie): authoritative Argentina database lookup via Didit. Pay-per-call from $0.20, no contracts, no minimums.","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/argentina/renaper-data"},{"title":"Argentina - DNI verification (RENAPER) API","sidebarTitle":"Argentina - DNI verification (RENAPER)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/argentina/renaper"},{"title":"Argentina Citizens (AFIP) Verification API","sidebarTitle":"Argentina Citizens (AFIP)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/argentina/citizens"},{"title":"Argentina Credit Bureau Verification API: ID Match","sidebarTitle":"Argentina Credit Bureau","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/argentina/credit-bureau"}]},{"group":"🇦🇺 Australia","pages":[{"title":"Australia - DVS - Birth Certificate Verification API","sidebarTitle":"Australia - DVS - Birth Certificate","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/birth-certificate"},{"title":"Australia - DVS - Centrelink Card Verification API","sidebarTitle":"Australia - DVS - Centrelink Card","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/centrelink-card"},{"title":"Australia - DVS - ImmiCard Verification API","sidebarTitle":"Australia - DVS - ImmiCard","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/immicard"},{"title":"Australia - DVS - Travel Document Verification API","sidebarTitle":"Australia - DVS - Travel Document","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/travel-document"},{"title":"Australia - DVS – Change of Name Certificate API","sidebarTitle":"Australia - DVS – Change of Name Certificate","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/change-of-name-certificate"},{"title":"Australia - DVS – Citizenship Certificate API","sidebarTitle":"Australia - DVS – Citizenship Certificate","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/citizenship-certificate"},{"title":"Australia - DVS – Marriage Certificate API","sidebarTitle":"Australia - DVS – Marriage Certificate","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/marriage-certificate"},{"title":"Australia Credit Bureau Verification API: ID Match","sidebarTitle":"Australia Credit Bureau","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/credit-bureau"},{"title":"Australia Death Check (BDM) API: Real-Time Lookup","sidebarTitle":"Australia Death Check (BDM)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/death-check"},{"title":"Australia Electoral Roll Verification API: ID Match","sidebarTitle":"Australia Electoral Roll","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/electoral-roll"},{"title":"Australia Superannuation \u0026 Payroll Verification API","sidebarTitle":"Australia Superannuation \u0026 Payroll","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/superannuation-payroll"},{"title":"Australia VEVO Verification API: Real-Time Lookup","sidebarTitle":"Australia VEVO","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/vevo"},{"title":"DVS - Australia Driver Licence Verification API","sidebarTitle":"DVS - Australia Driver Licence","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/driver-licence"},{"title":"DVS - Australia Medicare Card Verification API","sidebarTitle":"DVS - Australia Medicare Card","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/medicare-card"},{"title":"DVS - Australia Passport Verification API: ID Match","sidebarTitle":"DVS - Australia Passport","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/passport"},{"title":"DVS - Australia Visa Verification API: Data Match","sidebarTitle":"DVS - Australia Visa","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/australia/visa"}]},{"group":"🇦🇹 Austria","pages":[{"title":"Austria Credit Bureau Verification API: Data Match","sidebarTitle":"Austria Credit Bureau","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/austria/credit-bureau"}]},{"group":"🇧🇴 Bolivia","pages":[{"title":"Bolivia - CI verification API: Real-Time ID Lookup","sidebarTitle":"Bolivia - CI verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/bolivia/cedula"}]},{"group":"🇧🇷 Brazil","pages":[{"title":"BRA - Unico IDCloud (CPF + selfie) Verification API","sidebarTitle":"BRA - Unico IDCloud (CPF + selfie)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/unico-idcloud"},{"title":"Brazil - CNH QR code + face match (Datavalid) API","sidebarTitle":"Brazil - CNH QR code + face match (Datavalid)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/cnh-facial-qrcode"},{"title":"Brazil - CPF + face match (Datavalid) API: ID Match","sidebarTitle":"Brazil - CPF + face match (Datavalid)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/cpf-facial"},{"title":"Brazil - CPF status check API: Real-Time ID Lookup","sidebarTitle":"Brazil - CPF status check","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/cpf"},{"title":"Brazil - Company Partners and Directors (QSA) API","sidebarTitle":"Brazil - Company Partners and Directors (QSA)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/company-directors"},{"title":"Brazil - Company Registry Lookup (CNPJ) API","sidebarTitle":"Brazil - Company Registry Lookup (CNPJ)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/company-registry"},{"title":"Brazil - Death Check (CPF) API: Real-Time ID Lookup","sidebarTitle":"Brazil - Death Check (CPF)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/death-check"},{"title":"Brazil - Federal Criminal Record Verification API","sidebarTitle":"Brazil - Federal Criminal Record (Polícia Federal)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/antecedentes-criminais-pf"},{"title":"Brazil Residential Verification API: Identity Match","sidebarTitle":"Brazil Residential","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/residential"},{"title":"Brazil Tax Registration (CPF/CNPJ) Verification API","sidebarTitle":"Brazil Tax Registration (CPF/CNPJ)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/brazil/tax-registration"}]},{"group":"🇰🇭 Cambodia","pages":[{"title":"Cambodia National ID Verification API: Data Match","sidebarTitle":"Cambodia National ID","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/cambodia/national-id"}]},{"group":"🇨🇦 Canada","pages":[{"title":"Canada Credit Bureau (FINTRAC) Verification API","sidebarTitle":"Canada Credit Bureau (FINTRAC)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/canada/credit-bureau-fintrac"},{"title":"Canada Credit Bureau 2 (Non-FINTRAC) API: ID Match","sidebarTitle":"Canada Credit Bureau 2 (Non-FINTRAC)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/canada/credit-bureau-2-non-fintrac"},{"title":"Canada Residential Verification API: Identity Match","sidebarTitle":"Canada Residential","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/canada/residential"}]},{"group":"🇨🇱 Chile","pages":[{"title":"Chile - RUT verification API: Real-Time ID Lookup","sidebarTitle":"Chile - RUT verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/chile/rut"}]},{"group":"🇨🇳 China","pages":[{"title":"China Bank Card Verification API: Real-Time Lookup","sidebarTitle":"China Bank Card","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/china/bank-card"},{"title":"China National ID Verification API: Identity Lookup","sidebarTitle":"China National ID","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/china/national-id"},{"title":"China Passport Verification API: Real-Time Lookup","sidebarTitle":"China Passport Verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/china/passport-verification"},{"title":"China Phone Verification API: Real-Time ID Lookup","sidebarTitle":"China Phone","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/china/phone"}]},{"group":"🇨🇴 Colombia","pages":[{"title":"Colombia - Cédula verification API: Identity Lookup","sidebarTitle":"Colombia - Cédula verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/colombia/cedula"},{"title":"Colombia - Migración Colombia foreigner status API","sidebarTitle":"Colombia - Migración Colombia foreigner status","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/colombia/migracion"}]},{"group":"🇨🇷 Costa Rica","pages":[{"title":"Costa Rica - Cédula verification API: Data Match","sidebarTitle":"Costa Rica - Cédula verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/costa-rica/cedula"}]},{"group":"🇩🇰 Denmark","pages":[{"title":"Denmark Consumer 2 Verification API: Identity Match","sidebarTitle":"Denmark Consumer 2","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/denmark/consumer-2"},{"title":"Denmark National ID Verification API: Data Match","sidebarTitle":"Denmark National ID","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/denmark/national-id"}]},{"group":"🇩🇴 Dominican Republic","pages":[{"title":"Dominican Republic - Cédula verification API","sidebarTitle":"Dominican Republic - Cédula verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/dominican-republic/cedula"}]},{"group":"🇪🇨 Ecuador","pages":[{"title":"Ecuador - Cédula verification API: Real-Time Lookup","sidebarTitle":"Ecuador - Cédula verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/ecuador/cedula"}]},{"group":"🇸🇻 El Salvador","pages":[{"title":"El Salvador - DUI verification API: Identity Lookup","sidebarTitle":"El Salvador - DUI verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/el-salvador/dui"}]},{"group":"🇫🇮 Finland","pages":[{"title":"Finland Consumer 2 Verification API: Identity Match","sidebarTitle":"Finland Consumer 2","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/finland/consumer-2"},{"title":"Finland National ID Verification API: Data Match","sidebarTitle":"Finland National ID","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/finland/national-id"}]},{"group":"🇫🇷 France","pages":[{"title":"France Phone Verification API: Real-Time ID Lookup","sidebarTitle":"France Phone","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/france/phone"},{"title":"France Residential Verification API: Identity Match","sidebarTitle":"France Residential","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/france/residential"},{"title":"France Utility Verification API: Real-Time Lookup","sidebarTitle":"France Utility","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/france/utility"}]},{"group":"🇩🇪 Germany","pages":[{"title":"Germany Credit Bureau Verification API: Data Match","sidebarTitle":"Germany Credit Bureau","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/germany/credit-bureau"},{"title":"Germany Phone 2 Verification API: Real-Time Lookup","sidebarTitle":"Germany Phone 2","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/germany/phone-2"}]},{"group":"🌐 Global","pages":[{"title":"Global - Core Intelligence Service Verification API","sidebarTitle":"Global - Core Intelligence Service","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/global/intelligence-service"},{"title":"Global - Sim Swap Verification API: Telco Match","sidebarTitle":"Global - Sim Swap","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/global/swap"}]},{"group":"🇬🇹 Guatemala","pages":[{"title":"Guatemala - DPI + face match (RENAP) API: ID Match","sidebarTitle":"Guatemala - DPI + face match (RENAP)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/guatemala/dpi-facial"},{"title":"Guatemala - DPI verification API: Real-Time Lookup","sidebarTitle":"Guatemala - DPI verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/guatemala/dpi"}]},{"group":"🇭🇳 Honduras","pages":[{"title":"Honduras - DNI verification API: Real-Time Lookup","sidebarTitle":"Honduras - DNI verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/honduras/dni"}]},{"group":"🇮🇳 India","pages":[{"title":"India Aadhaar (UIDAI) Verification API: Data Match","sidebarTitle":"India Aadhaar (UIDAI)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/india/aadhaar"},{"title":"India Drivers Licence (RTO) Verification API","sidebarTitle":"India Drivers Licence (RTO)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/india/drivers-licence"},{"title":"India EPIC (Voter's Registration) (ECI) API","sidebarTitle":"India EPIC (Voter's Registration) (ECI)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/india/epic-voter-s-registration"},{"title":"India PAN (Permanent Account Number) (ITD) API","sidebarTitle":"India PAN (Permanent Account Number) (ITD)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/india/pan-permanent-account-number"}]},{"group":"🇮🇩 Indonesia","pages":[{"title":"Indonesia Residential Identity Card Verification API","sidebarTitle":"Indonesia Residential Identity Card","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/indonesia/residential-identity-card"}]},{"group":"🇮🇹 Italy","pages":[{"title":"Italy Credit Bureau Verification API: Header Match","sidebarTitle":"Italy Credit Bureau","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/italy/credit-bureau"},{"title":"Italy Residential Verification API: Identity Lookup","sidebarTitle":"Italy Residential","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/italy/residential"}]},{"group":"🇰🇪 Kenya","pages":[{"title":"Kenya National ID Verification API: Identity Lookup","sidebarTitle":"Kenya National ID","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/kenya/national-id"}]},{"group":"🇲🇾 Malaysia","pages":[{"title":"Malaysia National ID Verification API: Data Match","sidebarTitle":"Malaysia National ID","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/malaysia/national-id"}]},{"group":"🇲🇽 Mexico","pages":[{"title":"Mexico - CURP verification API: Real-Time ID Lookup","sidebarTitle":"Mexico - CURP verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/mexico/curp"},{"title":"Mexico - INE credential validity verification API","sidebarTitle":"Mexico - INE credential validity verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/mexico/ine-vigencia"}]},{"group":"🇳🇱 Netherlands","pages":[{"title":"Netherlands Residential Verification API: ID Match","sidebarTitle":"Netherlands Residential","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/netherlands/residential"}]},{"group":"🇳🇿 New Zealand","pages":[{"title":"DIA - New Zealand Births Verification API: ID Match","sidebarTitle":"DIA - New Zealand Births","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/new-zealand/births"},{"title":"DIA - New Zealand Citizenship Verification API","sidebarTitle":"DIA - New Zealand Citizenship","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/new-zealand/citizenship"},{"title":"DIA - New Zealand Passport Verification API","sidebarTitle":"DIA - New Zealand Passport","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/new-zealand/passport"},{"title":"New Zealand Death Check (BDM) API: Real-Time Lookup","sidebarTitle":"New Zealand Death Check (BDM)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/new-zealand/death-check"},{"title":"New Zealand Drivers Licence (NZTA) Verification API","sidebarTitle":"New Zealand Drivers Licence (NZTA)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/new-zealand/drivers-licence"}]},{"group":"🇳🇬 Nigeria","pages":[{"title":"Nigeria Bank Verification Number (BVN) API","sidebarTitle":"Nigeria Bank Verification Number (BVN)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/nigeria/bank-verification-number"},{"title":"Nigeria Driver's Licence (FRSC) Verification API","sidebarTitle":"Nigeria Driver's Licence (FRSC)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/nigeria/drivers-license"},{"title":"Nigeria International Passport (NIS) API: ID Match","sidebarTitle":"Nigeria International Passport (NIS)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/nigeria/passport"},{"title":"Nigeria National ID (NIMC) Verification API","sidebarTitle":"Nigeria National ID (NIMC)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/nigeria/national-id"},{"title":"Nigeria National ID + Selfie (NIMC) Verification API","sidebarTitle":"Nigeria National ID + Selfie (NIMC)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/nigeria/national-id-facial"}]},{"group":"🇳🇴 Norway","pages":[{"title":"Norway Residential Verification API: Identity Match","sidebarTitle":"Norway Residential","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/norway/residential"}]},{"group":"🇵🇦 Panama","pages":[{"title":"Panama - Cédula with biometric face-match API","sidebarTitle":"Panama - Cédula with biometric face-match (SIB Plus, elevated tier)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/panama/sib-plus"},{"title":"Panama - Cédula with biometric face-match (SIB) API","sidebarTitle":"Panama - Cédula with biometric face-match (SIB)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/panama/sib"}]},{"group":"🇵🇾 Paraguay","pages":[{"title":"Paraguay - CI verification API: Real-Time ID Lookup","sidebarTitle":"Paraguay - CI verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/paraguay/cedula"}]},{"group":"🇵🇪 Peru","pages":[{"title":"Peru - DNI verification API: Real-Time ID Lookup","sidebarTitle":"Peru - DNI verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/peru/dni"},{"title":"Peru Tax Registration (SUNAT) Verification API","sidebarTitle":"Peru Tax Registration (SUNAT)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/peru/tax-registration"}]},{"group":"🇵🇭 Philippines","pages":[{"title":"Philippines Residential Verification API: ID Match","sidebarTitle":"Philippines Residential","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/philippines/residential"}]},{"group":"🇸🇬 Singapore","pages":[{"title":"Singapore Credit Bureau Verification API: ID Match","sidebarTitle":"Singapore Credit Bureau","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/singapore/credit-bureau"},{"title":"Singapore Utility Verification API: Identity Lookup","sidebarTitle":"Singapore Utility","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/singapore/utility"}]},{"group":"🇿🇦 South Africa","pages":[{"title":"South Africa - Bank Account Holder Verification API","sidebarTitle":"South Africa - Bank Account Holder Verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/bank-account-holder"},{"title":"South Africa - Company Directors Lookup API","sidebarTitle":"South Africa - Company Directors Lookup","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/company-directors"},{"title":"South Africa - Company Registry Lookup API","sidebarTitle":"South Africa - Company Registry Lookup","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/company-registry"},{"title":"South Africa - Contactability Lookup API: ID Match","sidebarTitle":"South Africa - Contactability Lookup","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/contactability"},{"title":"South Africa - Criminal Screening by Face API","sidebarTitle":"South Africa - Criminal Screening by Face","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/criminal-face-screening"},{"title":"South Africa - DHA Fingerprint Match API: ID Match","sidebarTitle":"South Africa - DHA Fingerprint Match","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/dha-fingerprint-match"},{"title":"South Africa - DHA Photo Retrieval Verification API","sidebarTitle":"South Africa - DHA Photo Retrieval","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/dha-photo"},{"title":"South Africa - Driving License Verification API","sidebarTitle":"South Africa - Driving License Verification","href":"/api-reference/database-validation/south-africa/drivers-license"},{"title":"South Africa - Fraud Prevention Screening API","sidebarTitle":"South Africa - Fraud Prevention Screening","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/fraud-prevention"},{"title":"South Africa - Person Directorships Lookup API","sidebarTitle":"South Africa - Person Directorships Lookup","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/person-directorships"},{"title":"South Africa - Refugee File Verification API","sidebarTitle":"South Africa - Refugee File Verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/refugee"},{"title":"South Africa - Vehicle Ownership Verification API","sidebarTitle":"South Africa - Vehicle Ownership Verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/vehicle-ownership"},{"title":"South Africa National ID (DHA) Verification API","sidebarTitle":"South Africa National ID (DHA)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/south-africa/national-id"}]},{"group":"🇪🇸 Spain","pages":[{"title":"Spain - DNI/NIE verification API: Real-Time Lookup","sidebarTitle":"Spain - DNI/NIE verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/spain/dni"}]},{"group":"🇸🇪 Sweden","pages":[{"title":"Sweden National ID Verification API: Identity Match","sidebarTitle":"Sweden National ID","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/sweden/national-id"},{"title":"Sweden Phone Verification API: Real-Time ID Lookup","sidebarTitle":"Sweden Phone","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/sweden/phone"}]},{"group":"🇨🇭 Switzerland","pages":[{"title":"Switzerland Credit Bureau Verification API","sidebarTitle":"Switzerland Credit Bureau","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/switzerland/credit-bureau"}]},{"group":"🇹🇭 Thailand","pages":[{"title":"Thailand National ID Verification API: Data Match","sidebarTitle":"Thailand National ID","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/thailand/national-id"}]},{"group":"🇬🇧 United Kingdom","pages":[{"title":"United Kingdom Credit Bureau Verification API","sidebarTitle":"United Kingdom Credit Bureau","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-kingdom/credit-bureau"},{"title":"United Kingdom Financial Services Verification API","sidebarTitle":"United Kingdom Financial Services","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-kingdom/financial-services"},{"title":"United Kingdom Phone 2 Verification API: Data Match","sidebarTitle":"United Kingdom Phone 2","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-kingdom/phone-2"},{"title":"United Kingdom Residential Verification API","sidebarTitle":"United Kingdom Residential","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-kingdom/residential"}]},{"group":"🇺🇸 United States","pages":[{"title":"United States - Driver's License (DMV) API","sidebarTitle":"United States - Driver's License (DMV)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-states/driver-license-dmv"},{"title":"United States Credit Bureau Verification API","sidebarTitle":"United States of America - United States Credit Bureau","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-states/credit-bureau"},{"title":"United States Death Check (SSDMF) API: Data Match","sidebarTitle":"United States of America - United States Death Check (SSDMF)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-states/death-check"},{"title":"United States Financial Services Verification API","sidebarTitle":"United States of America - United States Financial Services","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-states/financial-services"},{"title":"United States Phone 2 Verification API: Data Match","sidebarTitle":"United States of America - United States Phone 2","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-states/phone-2"},{"title":"United States Residential Verification API","sidebarTitle":"United States of America - United States Residential","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/united-states/residential"}]},{"group":"🇺🇾 Uruguay","pages":[{"title":"Uruguay - CI verification API: Real-Time ID Lookup","sidebarTitle":"Uruguay - CI verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/uruguay/cedula"}]},{"group":"🇻🇪 Venezuela","pages":[{"title":"Venezuela - Cédula verification API: Identity Match","sidebarTitle":"Venezuela - Cédula verification","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/venezuela/cedula"}]},{"group":"🌐 Zambia","pages":[{"title":"Zambia NRC (tax register) Verification API","sidebarTitle":"Zambia NRC (tax register)","api":"POST /v3/database-validation/","href":"/api-reference/database-validation/zambia/national-id"}]}]},{"group":"Biometrics \u0026 Face","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/liveness.svg","pages":[{"title":"Passive Liveness API: Deepfake Detection","sidebarTitle":"Passive Liveness","openapi":"openapi-25.json POST /v3/passive-liveness/","href":"/standalone-apis/passive-liveness"},{"title":"Face Match API: 1:1 Face Comparison","sidebarTitle":"Face Match","openapi":"openapi-25.json POST /v3/face-match/","href":"/standalone-apis/face-match"},{"title":"Face Search API: 1:N Facial Dedup \u0026 Fraud Rings","sidebarTitle":"Face Search","openapi":"openapi-25.json POST /v3/face-search/","href":"/standalone-apis/face-search"},{"title":"Age Estimation API: Selfie-Based Age Verification","sidebarTitle":"Age Estimation API","openapi":"openapi-25.json POST /v3/age-estimation/","href":"/standalone-apis/age-estimation"}]},{"group":"Compliance \u0026 Risk","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/aml-screening.svg","pages":[{"title":"AML Screening API: Sanctions, PEP \u0026 Watchlists","sidebarTitle":"AML Screening API","openapi":"openapi-25.json POST /v3/aml/","href":"/standalone-apis/aml-screening"},{"title":"AML Dataset Freshness API","sidebarTitle":"Get AML Dataset Freshness","openapi":"openapi-25.json GET /v3/aml/dataset-freshness/","href":"/standalone-apis/aml-dataset-freshness"},{"title":"Fraud Check API","openapi":"openapi-25.json POST /v3/fraud/checks/","href":"/standalone-apis/fraud-check"},{"title":"Plan a Fraud Check","openapi":"openapi-25.json POST /v3/fraud/checks/plan/","href":"/standalone-apis/fraud-check-plan"},{"title":"Get a Fraud Check","openapi":"openapi-25.json GET /v3/fraud/checks/{check_id}/","href":"/standalone-apis/fraud-check-result"}]},{"group":"Device \u0026 IP Analysis","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/ip-analysis.svg","pages":[{"title":"IP Risk API: Geo, VPN \u0026 Datacenter Signals","sidebarTitle":"IP Risk API","openapi":"openapi-25.json POST /v3/ip/risk/","href":"/standalone-apis/ip-risk"}]},{"group":"KYB Registry","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/businesses.svg","pages":[{"title":"KYB Registry API: Company Search and Select","sidebarTitle":"Overview","href":"/standalone-apis/kyb-registry"},{"title":"KYB Registry Search API - Company Search","sidebarTitle":"KYB Registry Search","openapi":"openapi-25.json POST /v3/kyb/search/","href":"/standalone-apis/kyb-registry-search"},{"title":"KYB Registry Select API: Retrieve Company Profile","sidebarTitle":"KYB Registry Select","openapi":"openapi-25.json POST /v3/kyb/select/","href":"/standalone-apis/kyb-registry-select"},{"title":"KYB Registry Shareholders API","sidebarTitle":"KYB Registry Shareholders","openapi":"openapi-25.json POST /v3/kyb/shareholders/","href":"/standalone-apis/kyb-registry-shareholders"},{"title":"KYB Registry UBO API: Ultimate Beneficial Owners","sidebarTitle":"KYB Registry UBOs","openapi":"openapi-25.json POST /v3/kyb/ubo/","href":"/standalone-apis/kyb-registry-ubo"}]},{"group":"Email Verification","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/sms-tracking.svg","pages":[{"title":"Email Verification API: OTP \u0026 Risk Scoring","sidebarTitle":"Overview","href":"/standalone-apis/email-verification"},{"title":"Send Email OTP API: Email Verification Code","sidebarTitle":"Send Email Code","openapi":"openapi-25.json POST /v3/email/send/","href":"/standalone-apis/email-send"},{"title":"Check Email OTP API: Validate Email Code","sidebarTitle":"Check Email Code","openapi":"openapi-25.json POST /v3/email/check/","href":"/standalone-apis/email-check"},{"title":"Email Risk API: Deliverability \u0026 Breach Signals","sidebarTitle":"Email Risk API","openapi":"openapi-25.json POST /v3/email/risk/","href":"/standalone-apis/email-risk"}]},{"group":"Phone Verification","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/phone-verification.svg","pages":[{"title":"Phone Verification API: SMS OTP \u0026 Risk Signals","sidebarTitle":"Overview","href":"/standalone-apis/phone-verification"},{"title":"Send Phone OTP API: SMS Verification Code","sidebarTitle":"Send Phone Code","openapi":"openapi-25.json POST /v3/phone/send/","href":"/standalone-apis/phone-send"},{"title":"Check Phone OTP API: Validate SMS Code","sidebarTitle":"Check Phone Code","openapi":"openapi-25.json POST /v3/phone/check/","href":"/standalone-apis/phone-check"},{"title":"Phone Risk API: Carrier \u0026 Fraud Signals","sidebarTitle":"Phone Risk API","openapi":"openapi-25.json POST /v3/phone/risk/","href":"/standalone-apis/phone-risk"}]},{"group":"Bank Verification","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/billing.svg","pages":[{"title":"Account Check API: Verify a Payout Bank Account","sidebarTitle":"Account Check API","openapi":"openapi-25.json POST /v3/bank/account-check/","href":"/standalone-apis/bank-account-check"}]}]},{"tab":"User Verification","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/user-verifications.svg","pages":[{"title":"User Verification","href":"/core-technology/liveness/overview"}]},{"tab":"Business Verification","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/business-verifications.svg","pages":[{"title":"Business Verification","href":"/business-verification/overview"}]},{"tab":"Transaction Monitoring","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/transactions.svg","pages":[{"title":"Transaction Monitoring","href":"/transaction-monitoring/overview"}]},{"tab":"Changelog","icon":"https://mintlify.s3.us-west-1.amazonaws.com/didit-0f962782/icons/calendar.svg","pages":[{"title":"Changelog","href":"/changelog"}]}],"global":{"anchors":[{"anchor":"API Reference","icon":"code","href":"/api-reference/overview"},{"anchor":"Business Console","icon":"gauge","href":"https://business.didit.me"},{"anchor":"OpenAPI Spec","icon":"file-code","href":"https://docs.didit.me/openapi-25.json"},{"anchor":"Integration Prompt","icon":"wand-magic-sparkles","href":"/integration/integration-prompt"},{"anchor":"MCP Server","icon":"plug","href":"/integration/mcp/overview"},{"anchor":"Agent Skills","icon":"robot","href":"https://github.com/didit-protocol/skills"}]}},{"language":"es","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Soporte"},{"icon":"signal","href":"https://status.didit.me","label":"Estado"}],"primary":{"type":"button","label":"Iniciar sesión","href":"https://business.didit.me"}},"pages":[{"title":"es","href":"/es/standalone-apis/database-validation"}]},{"language":"pt-BR","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Suporte"},{"icon":"signal","href":"https://status.didit.me","label":"Status"}],"primary":{"type":"button","label":"Entrar","href":"https://business.didit.me"}},"pages":[{"title":"pt-BR","href":"/pt-br/standalone-apis/database-validation"}]},{"language":"ja","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"サポート"},{"icon":"signal","href":"https://status.didit.me","label":"ステータス"}],"primary":{"type":"button","label":"サインイン","href":"https://business.didit.me"}},"pages":[{"title":"ja","href":"/ja/standalone-apis/database-validation"}]},{"language":"de","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Support"},{"icon":"signal","href":"https://status.didit.me","label":"Status"}],"primary":{"type":"button","label":"Anmelden","href":"https://business.didit.me"}},"pages":[{"title":"de","href":"/de/standalone-apis/database-validation"}]},{"language":"fr","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Assistance"},{"icon":"signal","href":"https://status.didit.me","label":"Statut"}],"primary":{"type":"button","label":"Se connecter","href":"https://business.didit.me"}},"pages":[{"title":"fr","href":"/fr/standalone-apis/database-validation"}]},{"language":"it","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Supporto"},{"icon":"signal","href":"https://status.didit.me","label":"Stato"}],"primary":{"type":"button","label":"Accedi","href":"https://business.didit.me"}},"pages":[{"title":"it","href":"/it/standalone-apis/database-validation"}]},{"language":"pt","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Suporte"},{"icon":"signal","href":"https://status.didit.me","label":"Estado"}],"primary":{"type":"button","label":"Iniciar sessão","href":"https://business.didit.me"}},"pages":[{"title":"pt","href":"/pt/standalone-apis/database-validation"}]},{"language":"ca","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Suport"},{"icon":"signal","href":"https://status.didit.me","label":"Estat"}],"primary":{"type":"button","label":"Inicia la sessió","href":"https://business.didit.me"}},"pages":[{"title":"ca","href":"/ca/standalone-apis/database-validation"}]},{"language":"id","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Dukungan"},{"icon":"signal","href":"https://status.didit.me","label":"Status"}],"primary":{"type":"button","label":"Masuk","href":"https://business.didit.me"}},"pages":[{"title":"id","href":"/id/standalone-apis/database-validation"}]},{"language":"ru","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"Поддержка"},{"icon":"signal","href":"https://status.didit.me","label":"Статус"}],"primary":{"type":"button","label":"Вход","href":"https://business.didit.me"}},"pages":[{"title":"ru","href":"/ru/standalone-apis/database-validation"}]},{"language":"ko","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"지원"},{"icon":"signal","href":"https://status.didit.me","label":"상태"}],"primary":{"type":"button","label":"로그인","href":"https://business.didit.me"}},"pages":[{"title":"ko","href":"/ko/standalone-apis/database-validation"}]},{"language":"zh","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"支持"},{"icon":"signal","href":"https://status.didit.me","label":"状态"}],"primary":{"type":"button","label":"登录","href":"https://business.didit.me"}},"pages":[{"title":"zh","href":"/zh/standalone-apis/database-validation"}]},{"language":"ar","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"الدعم"},{"icon":"signal","href":"https://status.didit.me","label":"الحالة"}],"primary":{"type":"button","label":"تسجيل الدخول","href":"https://business.didit.me"}},"pages":[{"title":"ar","href":"/ar/standalone-apis/database-validation"}]},{"language":"hi","navbar":{"links":[{"icon":"comment-dots","href":"https://help.didit.me","label":"सहायता"},{"icon":"signal","href":"https://status.didit.me","label":"स्थिति"}],"primary":{"type":"button","label":"साइन इन करें","href":"https://business.didit.me"}},"pages":[{"title":"hi","href":"/hi/standalone-apis/database-validation"}]}]},"basePath":"","title":"Database Validation API: National ID Match - Didit Docs","buildId":"dpl_4D8r1dHg6bQcRuBgQyL3z9waJJtn","deploymentId":"dpl_4D8r1dHg6bQcRuBgQyL3z9waJJtn","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-dD8DedlW.js","utils-BgJ6PauS.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-m4sNRkou.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dg97LVEU.js","snippetPresets-C6CxWGOo.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-CKiRf67B.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CDY0tBIx.js","shallow-BHHaYlmm.js","getApiPlaygroundDisplay-D6K3-cVX.js","CodeSnippet-BrS3fDep.js","CodeSnippets-Dkf1llUu.js","Page-DOwQSAHT.js","getPastedJson-3JcMsaes.js","icon-CWSTKRsN.js","MethodPill-t_TXGK5I.js","DuplicateIcon-DcjhdAbh.js","createIcon-2JHmGxKn.js","DynamicMarkdown-DMUWO-az.js","SectionHeading-DxvGHAss.js","axios-vUo_bRtp.js","Markdown-cyvaulBW.js","clsx-DzViKcUj.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CU0Gjyt0.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CuigkklY.js"]}