Saltar al contingut principal
PATCH
curl

Què fa aquest endpoint

El cribratge AML retorna una llista de coincidències: possibles coincidències amb llistes de sancions, bases de dades de PEP, llistes de vigilància i mitjans adversos. Cada coincidència té un review_status (la seva disposició), que comença com a Unreviewed o False Positive segons la puntuació de coincidència. Aquest endpoint permet a l’equip (o a l’automatització) registrar una decisió sobre cada coincidència, sense canviar la decisió global de la sessió. Trobeu les coincidències i els seus IDs a la decisió de la sessió: l’array hits de la comprovació AML, on l’id de cada coincidència és el hit_id que hi passeu. Un id de coincidència té el format hit_ seguit de 24 caràcters hexadecimals, i es manté igual quan el subjecte es torna a cribrar. Un id de coincidència en el format anterior encara s’accepta; la resposta sempre identifica la coincidència pel seu id actual.

Estats de revisió

Les decisions del revisor es conserven en els recribratges del monitoratge continu: una coincidència que marqueu com a False Positive manté aquest estat quan el proveïdor torna a cribrar l’entitat.

Actualitzar una sola coincidència

PATCH /v3/session/{sessionId}/update-aml-hit-status/
Per a una sessió amb diverses comprovacions AML (fluxos de treball de graf), afegiu ?node_id=feature_aml_1 a la URL o inclogueu "node_id" al cos de la petició per apuntar a una comprovació concreta.

Actualitzar moltes coincidències alhora

PATCH /v3/session/{sessionId}/bulk-update-aml-hit-status/ Passeu hit_updates, una llista de parells { hit_id, review_status }. L’operació és tot o res: si no es troba algun hit_id, la petició retorna 404 i no es canvia cap coincidència.
Una crida massiva satisfactòria dispara un únic webhook data.updated i registra una entrada d’activitat que cobreix tots els canvis.

Què passa després d’una actualització

  • Webhook: es dispara un esdeveniment data.updated a la sessió.
  • Registre d’auditoria: el canvi es registra al registre de revisió de la sessió amb l’actor (clau d’API o usuari), i és visible a la cronologia d’activitat de la consola.
  • L’estat general del pas AML no es modifica: canviar la disposició d’una coincidència no canvia, per si sol, l’estat del pas AML ni la decisió de la sessió. Per canviar l’estat del pas AML (Approved / Declined / In Review), useu update-feature-status. Per canviar la decisió de la sessió, useu update-status.

Compatibilitat amb KYC i KYB

Funciona tant per a sessions de Verificació d’usuaris (KYC) com per a sessions de Verificació d’empreses (KYB): Didit resol el sessionId en tots dos casos. En el cas de KYB, el cribratge AML s’aplica a l’empresa i a les seves persones clau, i cada comprovació AML exposa les seves pròpies coincidències.

Permís

Cal el privilegi write:sessions, amb una clau d’API de client (x-api-key) o amb una capçalera d’autorització d’usuari.

Errors

Relacionat

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.

Paràmetres de ruta

sessionId
string<uuid>
requerit

UUID de la sessió de verificació. Accepta tant IDs de sessió d'usuari (KYC) com d'empresa (KYB); el servei resol l'ID entre tots dos tipus de sessió.

Exemple:

"11111111-2222-3333-4444-555555555555"

Paràmetres de consulta

node_id
string

ID del node del graf del flux de treball. Només és obligatori quan la sessió té múltiples comprovacions AML (una per node); omet-ho per a sessions amb un sol AML.

Exemple:

"feature_aml_1"

Cos

application/json
hit_id
string
requerit

L'id de la coincidència a la matriu hits del cribratge AML (hit_...). Encara s'accepta un id de coincidència retornat en el format anterior.

Exemple:

"hit_7c1e9a40b2d35f86e0a4c912"

review_status
enum<string>
requerit

El nou estat de revisió per a la coincidència.

Opcions disponibles:
Unreviewed,
Confirmed Match,
False Positive,
Inconclusive
Exemple:

"False Positive"

node_id
string

ID opcional del node del graf. Utilitza'l (aquí o com a paràmetre de consulta) quan la sessió tingui múltiples comprovacions d'AML.

Exemple:

"feature_aml_1"

Resposta

Estat de revisió de la coincidència actualitzat.

message
string
requerit

Sempre Hit status updated successfully.

hit_id
string
requerit

L'id de la coincidència actualitzada, tal com el retorna la decisió de la sessió, també quan la sol·licitud ha identificat la coincidència mitjançant un id en el format anterior.

review_status
enum<string>
requerit

L'estat de revisió emmagatzemat actualment a la coincidència.

Opcions disponibles:
Unreviewed,
Confirmed Match,
False Positive,
Inconclusive
Darrera modificació el 7 de novembre del 2026