Saltar al contenido principal
POST
curl

Autorizaciones

x-api-key
string
header
requerido

La clave de API de tu aplicación, que encontrarás en Developers -> API keys en la Business Console. La clave principal tiene acceso completo. Una clave con nombre puede tener un alcance limitado: ninguno, lectura o escritura por recurso, limitada a algunos flujos o a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad. 401 significa que la clave es incorrecta, se revocó o expiró; 403 significa que no se envió ninguna clave, que la clave no tiene acceso a este recurso o acción, o que la solicitud provino de una dirección fuera de su lista de IP; 404 en una ruta de sesión significa que la sesión está fuera de los flujos o estados de la clave. Una clave sin acceso a contenido multimedia recibe las URL de imágenes, videos y PDF como null, y una clave sin permiso de escritura en sesiones recibe los enlaces y tokens de sesión como null. Consulta https://docs.didit.me/console/api-keys.

Encabezados

Idempotency-Key
string

Clave opcional para reintentar de forma segura, de hasta 255 caracteres. Si reutilizas la misma clave con el mismo cuerpo de solicitud, se devuelve la respuesta original sin ejecutar ni facturar un segundo análisis. Si reutilizas la clave con un cuerpo distinto, se devuelve 409.

Maximum string length: 255

Cuerpo

application/json
full_name
string
requerido

Nombre completo de la persona o empresa que se va a analizar. Mínimo 2 caracteres, el mínimo que exige el propio proveedor de análisis. Un nombre más corto o vacío devuelve 400 en este campo antes de que se ejecute ningún análisis, por lo que no se factura nada.

Minimum string length: 2
Ejemplo:

"Antonio Ejemplo Modelo"

entity_type
enum<string>
predeterminado:person

Tipo de entidad que se va a analizar. El valor predeterminado es person.

Opciones disponibles:
person,
company
date_of_birth
string<date>

Fecha de nacimiento (personas) o fecha de constitución (empresas), YYYY-MM-DD. Mejora la precisión de la coincidencia mediante el peso de la fecha de nacimiento.

Ejemplo:

"1972-02-29"

nationality
string

Código de país ISO 3166-1 alfa-2 (p. ej. ES). Los códigos no válidos devuelven 400. Mejora la precisión de la coincidencia mediante el peso del país.

Ejemplo:

"ES"

document_number
string

Número del documento de identidad. No tiene ponderación; actúa como clave maestra: una coincidencia exacta eleva a 100 el match_score del resultado y una discrepancia clara lo penaliza. Se envía al proveedor de análisis como filtro de búsqueda solo cuando tiene entre 2 y 50 caracteres; un valor fuera de ese rango se acepta y se almacena, y el análisis se ejecuta y se factura igualmente, solo que sin acotarlo por número de documento.

aml_score_approve_threshold
number
predeterminado:80

Umbral de puntuación de riesgo igual o por debajo del cual el resultado es Approved. Debe ser ≤ aml_score_review_threshold (de lo contrario, 400).

Rango requerido: 0 <= x <= 100
aml_score_review_threshold
number
predeterminado:100

Umbral de puntuación de riesgo por encima del cual el resultado es Declined. Las puntuaciones entre los dos umbrales dan como resultado In Review.

Rango requerido: 0 <= x <= 100
aml_name_weight
integer
predeterminado:60

Peso de la similitud del nombre en la puntuación de coincidencia de cada resultado. Los tres pesos deben sumar exactamente 100 (de lo contrario, 400).

Rango requerido: 0 <= x <= 100
aml_dob_weight
integer
predeterminado:25

Peso de la fecha de nacimiento en la puntuación de coincidencia de cada resultado.

Rango requerido: 0 <= x <= 100
aml_country_weight
integer
predeterminado:15

Peso del país o la nacionalidad en la puntuación de coincidencia de cada resultado.

Rango requerido: 0 <= x <= 100
aml_match_score_threshold
integer
predeterminado:93

Umbral por coincidencia: las coincidencias con match_score inferior a este valor son False Positive (se excluyen de la evaluación de riesgo); las que lo igualan o superan son posibles coincidencias Unreviewed.

Rango requerido: 0 <= x <= 100
include_adverse_media
boolean
predeterminado:false

Busca también cobertura negativa en medios de comunicación. Añade hasta ~30 s de latencia mientras se recopilan los resultados: usa un tiempo de espera del cliente de ≥60 s.

include_ongoing_monitoring
boolean
predeterminado:false

Sigue volviendo a analizar este perfil y envía los cambios mediante webhook. Requiere save_api_request=true (de lo contrario, 400).

save_api_request
boolean
predeterminado:true

Guarda el análisis como una sesión (visible en la consola, con endpoint de decisión, webhooks y revisión de coincidencias). Establécelo en false para una comprobación sin estado.

vendor_data
string

Tu identificador del usuario analizado; se devuelve en la respuesta y se almacena con la sesión.

metadata
object | null

JSON libre que se guarda con la solicitud y se devuelve en la respuesta.

sandbox_scenario
string

Slug de escenario exclusivo de sandbox. Solo se acepta cuando la clave de API pertenece a una aplicación en modo sandbox; se rechaza en aplicaciones en producción. Un análisis independiente no tiene una sesión que preparar, así que el slug va en la propia solicitud de análisis: decline_aml_hit devuelve una coincidencia con la misma estructura que en producción y cierra el análisis como Declined, review_aml_possible_match lo cierra como In Review, y un escenario que no prepara ningún resultado AML deja el análisis limpio. Consulta el catálogo de escenarios en GET /v1/sandbox/scenarios/ o Sandbox y datos de prueba.

Ejemplo:

"decline_aml_hit"

Respuesta

Análisis completado. aml.status refleja tus umbrales. Cada coincidencia igual o superior al umbral mínimo interno de inclusión aparece en aml.hits con su match_score de identidad, su risk_score de entidad y un score_breakdown que explica la coincidencia.

request_id
string<uuid>

ID de la sesión guardada cuando save_api_request=true (se puede usar con GET /v3/session/{sessionId}/decision/); en caso contrario, un UUID de correlación temporal.

aml
object
vendor_data
string | null

Devuelve el vendor_data que enviaste.

metadata
object | null

Devuelve el metadata que enviaste.

created_at
string<date-time>
Última modificación el 1 de noviembre de 2026