Saltar al contingut principal
POST
curl
Afegeix una entrada a una llista. El valor es valida segons el tipus d’entrada de la llista:
  • email: una adreça de correu electrònic vàlida
  • phone: un número de telèfon internacional vàlid, desat en E.164 (per exemple +14155552671)
  • ip_address: una adreça IP vàlida o un rang CIDR (p. ex. 192.168.1.1 o 10.0.0.0/8)
  • device_fingerprint: com a mínim 8 caràcters entre lletres, dígits, -, _, : i .. Una llista de bloqueig rebutja una empremta que diversos dispositius diferents han reportat, perquè bloquejar-la rebutjaria persones no relacionades.
  • country: un codi de país ISO 3166-1 alpha-3 vàlid (p. ex. USA, GBR, ESP). Els codis alpha-2 (p. ex. US) s’accepten i es converteixen automàticament a alpha-3.
  • user, business: el vendor_data de l’usuari o de l’empresa
  • face, document, wallet_address, bank_account, key: qualsevol cadena no buida
Tots els valors de les entrades són insensibles a majúscules i minúscules: els valors que envies es normalitzen en desar-los (els números de telèfon a E.164, els codis de país a majúscules i la resta a minúscules) i es comparen sense distingir majúscules durant la verificació. Per exemple, bloquejar User@Example.COM també detectarà user@example.com. Una llista conté cada valor una sola vegada: afegir un valor que ja hi és retorna 400.
Per a una cara, usa Pujar cara quan només tinguis una imatge, o envia un reference_session_id per prendre la cara d’una sessió existent. Una entrada de cara necessita una cara desada amb la qual comparar, cosa que un value escrit no proporciona.

Afegir des d’una sessió

Quan proporciones un reference_session_id, Didit:
  1. Cerca la sessió (ha de pertànyer a la mateixa aplicació)
  2. Llegeix el valor del registre més recent de la sessió del tipus d’entrada de la llista:
    • face: la cara de la selfie de prova de vida; value és l’UUID de la cara
    • document: el número del document; el nom complet, l’estat emissor, el tipus de document, la regió i el número del document es desen a metadata, i display_label agafa per defecte el nom del titular i el número del document
    • phone: el número de telèfon
    • email: l’adreça de correu electrònic
    • ip_address: l’adreça IP de la sessió
    • device_fingerprint: una empremta que identifica un dispositiu, preferint un dispositiu que hagi completat un pas de verificació. En una llista de bloqueig, Didit rebutja una sessió que només té una empremta de classe de dispositiu, o una completada en més d’un dispositiu: en aquest cas, envia l’empremta exacta com a value.
  3. Enllaça l’entrada a la sessió (reference_session_id) i al registre (reference_object_uuid) per a la traçabilitat
A les llistes de bloqueig del sistema de cares, documents, telèfons i correus, el registre també es marca com a inclòs a la llista de bloqueig, de manera que les noves sessions que hi coincideixin es rebutgen. Per a qualsevol altre tipus d’entrada, envia també value. Retorna 400 si no es troba la sessió o si no conté dades del tipus d’entrada sol·licitat.

Cares de la selfie de captura del document

Mentre l’usuari fotografia el seu document, la càmera frontal pot fer-li una selfie (les imatges front_image_camera_front i back_image_camera_front de l’informe de verificació d’identitat). Aquesta cara es pot afegir a la llista de bloqueig de cares, igual que la cara de la selfie de la prova de vida: passa face_image_source amb la imatge que vulguis.
  • L’entrada només es crea a la llista de bloqueig de cares del sistema, i value ha de quedar buit: Didit pren la cara de la selfie de la sessió.
  • La selfie ha de contenir una sola cara nítida. Si no és així, la sol·licitud retorna 400 i no s’afegeix res.
  • Cada selfie es pot afegir una sola vegada. metadata.face_image_source i metadata.reference_node_id indiquen de quina selfie procedeix l’entrada.
  • En un flux de treball amb més d’un pas de verificació d’identitat, reference_node_id tria el pas la selfie del qual s’ha d’usar. Per defecte, Didit usa la verificació d’identitat més recent que tingui aquesta selfie.
  • A partir d’aleshores, la cara es comprova com qualsevol altra cara bloquejada: amb la selfie de prova de vida de cada nova sessió i amb cada nova selfie de captura del document (vegeu FRONT_CAMERA_FACE_IN_BLOCKLIST).
  • Eliminar l’entrada suprimeix la cara de la llista de bloqueig, i deixa de coincidir amb les noves sessions.

Sessions amb diversos registres del mateix tipus

Una sessió pot tenir més d’un registre d’un tipus, per exemple dos números de telèfon en un flux de treball de diversos passos. Didit sempre llegeix el registre més recent. Si envies value juntament amb reference_session_id, l’entrada desa el teu value però continua enllaçada a aquest registre més recent, i en una llista de bloqueig del sistema és aquest registre el que es marca. Per afegir un valor d’un registre anterior, afegeix-lo només amb value, sense reference_session_id:

Referenciar transaccions, usuaris i empreses

Quan bloquegis dades d’una transacció o d’un usuari o empresa de proveïdor, passa l’UUID de l’entitat com a reference_object_uuid i indica el tipus d’origen a metadata:
Això et permet anar de l’entrada de la llista a la transacció, l’usuari o l’empresa original a la consola. Didit desa les claus de metadata que enviïs, excepte reference_image_url i front_image_url, que només Didit estableix. Per a una entrada llegida d’una sessió, Didit afegeix les seves pròpies claus a les teves, i les seves claus prevalen. A les llistes de bloqueig del sistema Usuari i Empresa, Didit també posa com a BLOCKED els usuaris o les empreses corresponents: aquells el vendor_data dels quals és igual a value, o aquells el didit_internal_id dels quals és igual a reference_object_uuid. Consulta Llista de bloqueig d’usuaris i Llista de bloqueig d’empreses.

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

list_uuid
string<uuid>
requerit

UUID de la llista a la qual cal afegir. Per a una cara que només tinguis com a imatge, fes servir Pujar una cara a una llista.

Cos

application/json

Envia value, reference_session_id, o tots dos. Els camps aplicables depenen del valor de entry_type de la llista.

value
string

El valor que s'ha d'incloure a la llista, validat contra l'entry_type de la llista: email una adreça de correu electrònic vàlida; phone un número internacional vàlid, emmagatzemat en E.164; ip_address una adreça IP o rang CIDR (per exemple 10.0.0.0/8); device_fingerprint almenys 8 caràcters entre lletres, dígits, -, _, : i . (una llista de bloqueig rebutja una empremta que diversos dispositius diferents hagin reportat); country un codi ISO 3166-1 alpha-2 o alpha-3, emmagatzemat com a alpha-3; user i business el vendor_data; qualsevol altre tipus una cadena no buida. S'emmagatzema en minúscules excepte els números de telèfon i els codis de país, i una llista conté cada valor una sola vegada (sense distingir majúscules de minúscules). Obligatori tret que s'enviï reference_session_id; s'ha de deixar buit amb un face_image_source de captura de documents.

reference_session_id
string<uuid>

Una sessió de verificació de persona o empresa de la teva aplicació d'on extreure el valor. Didit llegeix el registre més recent de la sessió del tipus d'entrada de la llista (face, document, phone, email, ip_address o device_fingerprint), enllaça l'entrada a la sessió i a aquest registre, i emplena display_label i metadata per als documents. Per a una llista de bloqueig de device_fingerprint, es rebutja una sessió que només té una empremta digital de classe de dispositiu o que s'ha completat en més d'un dispositiu: envia l'empremta digital exacta com a value. Per a altres tipus d'entrada, o quan la sessió no té cap registre d'aquest tipus, envia també value; el teu value s'emmagatzema i l'entrada continua enllaçada a la sessió.

reference_object_uuid
string<uuid>

UUID del registre que representa l'entrada quan no prové d'una sessió: un UUID de transacció, o el didit_internal_id d'un usuari o empresa. Emparella'l amb metadata.reference_type. Se substitueix pel registre de la sessió quan reference_session_id en proporciona un.

face_image_source
enum<string>
predeterminat:liveness

Llistes facials amb reference_session_id: de quina de les imatges de la sessió s'extreu la cara. liveness (per defecte) és la selfie de prova de vida. front_image_camera_front i back_image_camera_front són les selfies que la càmera frontal va fer mentre l'usuari fotografiava l'anvers o el revers del seu document: acceptades només a la llista de bloqueig facial del sistema, amb reference_session_id i un value buit. Cada selfie es pot afegir un cop i ha de mostrar una única cara clara.

Opcions disponibles:
liveness,
front_image_camera_front,
back_image_camera_front
reference_node_id
string | null

Amb un face_image_source de captura de documents: el node de verificació d'identitat la selfie del qual s'ha d'utilitzar, per a fluxos de treball amb més d'un node. Per defecte, la verificació d'identitat més recent que conté aquesta imatge. Es rebutja amb liveness.

Maximum string length: 100
display_label
string

Etiqueta fàcil de llegir. Quan està buida, Didit en dedueix una a partir de la sessió quan és possible (per exemple, el nom del titular i el número de document).

Maximum string length: 512
comment
string

Nota de text lliure, com ara el motiu de la inclusió a la llista.

metadata
object

JSON de format lliure emmagatzemat amb l'entrada i retornat tal com s'ha desat. Fes servir reference_type i reference_id perquè el tauler enllaci amb l'origen. reference_image_url i front_image_url només els estableix Didit i s'ometen si els envies. Per a una entrada llegida des d'una sessió, les claus de Didit es fusionen amb les teves.

Resposta

S'ha creat l'entrada.

Un valor en una llista.

uuid
string<uuid>
requerit

Identificador de l'entrada. Utilitza'l com a entry_uuid a l'operació «Eliminar una entrada de llista».

value
string
requerit

El valor llistat: un número de telèfon en E.164, una adreça de correu electrònic, un número de document, una adreça IP o rang CIDR, una empremta digital de dispositiu, una adreça de cartera, un compte bancari, un codi de país ISO 3166-1 alfa-3, un vendor_data, qualsevol cadena en una llista key, o l'UUID de la cara emmagatzemada en una llista de cares. Els valors que envies s'emmagatzemen en minúscules, excepte els números de telèfon i els codis de país. La coincidència no distingeix entre majúscules i minúscules.

display_label
string | null
requerit

Etiqueta fàcil de llegir. Didit l'emplena per a entrades extretes d'una sessió (per exemple, el nom del titular i el número de document) quan no n'envies cap.

Maximum string length: 512
comment
string
requerit

Nota de text lliure. Cadena buida si no s'ha definit.

added_by
string | null
requerit

Qui ha afegit l'entrada: api (una clau d'API), l'adreça de correu electrònic d'un usuari de la consola o console, system o migration (entrades creades per Didit) o rule (una acció de regla de transacció o de monitoratge).

reference_session_id
string<uuid> | null
requerit

Sessió de verificació d'on s'ha extret l'entrada. null quan l'entrada s'ha afegit per valor.

reference_session_number
integer | null
requerit

Número d'aquesta sessió en l'àmbit de l'aplicació, tal com es mostra a la consola.

reference_session_type
enum<string> | null
requerit

kyc per a una sessió de verificació de persona, kyb per a una sessió de verificació d'empresa, null quan no hi ha cap sessió.

Opcions disponibles:
kyc,
kyb,
null
reference_object_uuid
string<uuid> | null
requerit

El registre que representa l'entrada: el registre de rostre, document, telèfon o correu electrònic llegit d'una sessió, el rostre creat per Upload a face to a list, o l'UUID que has enviat (per exemple, un UUID de transacció o el didit_internal_id d'un usuari).

metadata
object | null
requerit

Context addicional. Conté les claus que estableix Didit (llistades aquí) combinades amb qualsevol metadata que hagis enviat en crear l'entrada, retornades tal com s'han desat. null quan no n'hi ha cap.

created_at
string<date-time>
requerit

Quan es va afegir l'entrada.

Darrera modificació el 7 de novembre del 2026