Saltar al contingut principal
POST
curl

Autoritzacions

x-api-key
string
header
requerit

La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.

Capçaleres

Idempotency-Key
string

Clau opcional de seguretat per a reintents, de fins a 255 caràcters. Reutilitzar la mateixa clau amb el mateix cos de sol·licitud retorna la resposta original sense executar ni facturar un segon cribratge. Reutilitzar la clau amb un cos diferent retorna 409.

Maximum string length: 255

Cos

application/json
full_name
string
requerit

Nom complet de la persona o empresa a sotmetre a cribratge. Mínim 2 caràcters: el límit mínim del propi proveïdor de cribratge. Un nom més curt o en blanc retorna 400 en aquest camp abans que s'executi cap cribratge, de manera que no es factura res.

Minimum string length: 2
Exemple:

"Antonio Ejemplo Modelo"

entity_type
enum<string>
predeterminat:person

Tipus d'entitat que s'ha de cribrar. El valor per defecte és person.

Opcions disponibles:
person,
company
date_of_birth
string<date>

Data de naixement (persones) o data de constitució (empreses), YYYY-MM-DD. Millora la precisió de la coincidència mitjançant la ponderació de la data de naixement.

Exemple:

"1972-02-29"

nationality
string

Codi de país ISO 3166-1 alfa-2 (p. ex. ES). Els codis no vàlids retornen 400. Millora la precisió de coincidència mitjançant la ponderació per país.

Exemple:

"ES"

document_number
string

Número del document d'identitat. No ponderat: actua com a clau mestra: una coincidència exacta substitueix el match_score de la coincidència a 100, i una discrepància clara el penalitza. S'envia al proveïdor de cribratge com a filtre de cerca només quan té entre 2 i 50 caràcters; si té un valor fora d'aquest interval, s'accepta i s'emmagatzema, i el cribratge s'executa i es factura igualment, però sense filtrar pel número de document.

aml_score_approve_threshold
number
predeterminat:80

Llindar de la puntuació de risc igual o per sota del qual el resultat és Approved. Ha de ser ≤ aml_score_review_threshold (en cas contrari, 400).

Rang requerit: 0 <= x <= 100
aml_score_review_threshold
number
predeterminat:100

Llindar de la puntuació de risc per sobre del qual el resultat és Declined. Les puntuacions entre els dos llindars produeixen In Review.

Rang requerit: 0 <= x <= 100
aml_name_weight
integer
predeterminat:60

Pes de la similitud del nom en la puntuació de coincidència per hit. Els tres pesos han de sumar exactament 100 (en cas contrari, 400).

Rang requerit: 0 <= x <= 100
aml_dob_weight
integer
predeterminat:25

Pes de la data de naixement en la puntuació de coincidència per coincidència.

Rang requerit: 0 <= x <= 100
aml_country_weight
integer
predeterminat:15

Pes del país/nacionalitat en la puntuació de coincidència per coincidència.

Rang requerit: 0 <= x <= 100
aml_match_score_threshold
integer
predeterminat:93

Punt de tall per coincidència: les coincidències amb un match_score inferior a aquest es consideren False Positive (excloses de l'avaluació de risc); les que siguin iguals o superiors són possibles coincidències Unreviewed.

Rang requerit: 0 <= x <= 100
include_adverse_media
boolean
predeterminat:false

Cerca també mitjans de comunicació per detectar cobertura negativa. Afegeix fins a ~30 s de latència mentre es recopilen els resultats; utilitza un temps d'espera del client de ≥60 s.

include_ongoing_monitoring
boolean
predeterminat:false

Continua tornant a cribrar aquest perfil i envia els canvis mitjançant webhook. Requereix save_api_request=true (si no, 400).

save_api_request
boolean
predeterminat:true

Persisteix el cribratge com una sessió (visibilitat a la consola, endpoint de decisió, webhooks, revisió de coincidències). Estableix-ho a false per a una comprovació sense estat.

vendor_data
string

El teu identificador per a l'usuari sotmès a cribratge; es retorna tal com s'ha enviat i s'emmagatzema amb la sessió.

metadata
object | null

JSON de format lliure emmagatzemat amb la sol·licitud i retornat com a resposta.

sandbox_scenario
string

Identificador d'escenari només per a sandbox. Només s'accepta quan la clau d'API pertany a una aplicació en mode sandbox; es rebutja en aplicacions en producció. Un cribratge independent no té cap sessió per activar, de manera que l'identificador s'inclou a la mateixa sol·licitud de cribratge: decline_aml_hit retorna una coincidència amb estructura de producció i resol el cribratge com a Declined, review_aml_possible_match el resol com a In Review, i un escenari que no activi cap resultat d'AML deixa el cribratge net. Consulta el catàleg d'escenaris a GET /v1/sandbox/scenarios/ o a Sandbox i dades de prova.

Exemple:

"decline_aml_hit"

Resposta

Cribratge completat. aml.status reflecteix els teus llindars; cada coincidència que iguali o superi el mínim intern d'inclusió s'indica a aml.hits amb el seu match_score d'identitat, el risk_score de l'entitat i un score_breakdown que explica la coincidència.

request_id
string<uuid>

ID de sessió persistida quan save_api_request=true (utilitzable amb GET /v3/session/{sessionId}/decision/); en cas contrari, un UUID de correlació transitori.

aml
object
vendor_data
string | null

Ressò del vendor_data que has enviat.

metadata
object | null

Ressò de les metadata que has enviat.

created_at
string<date-time>
Darrera modificació el 7 de novembre del 2026