Passer au contenu principal
POST
curl
Ajoutez une entrée à une liste. La valeur est validée selon le type d’entrée de la liste :
  • email : une adresse e-mail valide
  • phone : un numéro de téléphone international valide, stocké au format E.164 (par exemple +14155552671)
  • ip_address : une adresse IP valide ou une plage CIDR (par exemple 192.168.1.1 ou 10.0.0.0/8)
  • device_fingerprint : au moins 8 caractères parmi les lettres, les chiffres, -, _, : et .. Une liste de blocage refuse une empreinte signalée par plusieurs appareils distincts, car son blocage refuserait des personnes sans rapport les unes avec les autres.
  • country : un code pays ISO 3166-1 alpha-3 valide (par exemple USA, GBR, ESP). Les codes alpha-2 (par exemple US) sont acceptés et convertis automatiquement en alpha-3.
  • user, business : le vendor_data de l’utilisateur ou de l’entreprise
  • face, document, wallet_address, bank_account, key : toute chaîne non vide
Toutes les valeurs d’entrée sont insensibles à la casse. Les valeurs que vous envoyez sont normalisées au stockage (numéros de téléphone au format E.164, codes pays en majuscules, le reste en minuscules) et comparées sans tenir compte de la casse lors de la vérification. Par exemple, bloquer User@Example.COM détectera aussi user@example.com. Une liste ne contient chaque valeur qu’une fois : ajouter une valeur déjà présente dans la liste renvoie 400.
Pour un visage, utilisez Téléverser un visage lorsque vous ne disposez que d’une image, ou envoyez un reference_session_id pour reprendre le visage d’une session existante. Une entrée de type visage a besoin d’un visage enregistré auquel se comparer, ce que ne fournit pas une value saisie.

Ajouter depuis une session

Lorsque vous fournissez un reference_session_id, Didit :
  1. Recherche la session (elle doit appartenir à la même application)
  2. Lit la valeur dans l’enregistrement le plus récent de la session pour le type d’entrée de la liste :
    • face : le visage du selfie de détection du vivant ; value est l’UUID du visage
    • document : le numéro du document ; le nom complet, l’État de délivrance, le type de document, la région et le numéro du document sont stockés dans metadata, et display_label prend par défaut le nom du titulaire et le numéro du document
    • phone : le numéro de téléphone
    • email : l’adresse e-mail
    • ip_address : l’adresse IP de la session
    • device_fingerprint : une empreinte qui identifie un appareil, en privilégiant un appareil ayant terminé une étape de vérification. Sur une liste de blocage, Didit refuse une session qui ne possède qu’une empreinte de classe d’appareil, ou une session effectuée sur plusieurs appareils : envoyez alors l’empreinte exacte comme value.
  3. Relie l’entrée à la session (reference_session_id) et à l’enregistrement (reference_object_uuid) pour la traçabilité
Sur les listes de blocage système (visage, document, téléphone et e-mail), l’enregistrement est aussi marqué comme figurant sur une liste de blocage, si bien que les nouvelles sessions qui lui correspondent sont refusées. Pour tout autre type d’entrée, envoyez aussi value. Renvoie 400 si la session est introuvable ou ne contient aucune donnée pour le type d’entrée demandé.

Visages issus du selfie de capture du document

Pendant que l’utilisateur photographie son document, la caméra frontale peut prendre un selfie de lui (les images front_image_camera_front et back_image_camera_front du rapport de vérification d’identité). Ce visage peut être ajouté à la liste de blocage des visages, en plus du visage de détection du vivant : transmettez face_image_source avec l’image souhaitée.
  • L’entrée est créée uniquement dans la liste de blocage des visages du système, et value doit rester vide : Didit prend le visage à partir du selfie de la session.
  • Le selfie doit contenir un seul visage net. Sinon, la requête renvoie 400 et rien n’est ajouté.
  • Chaque selfie ne peut être ajouté qu’une fois. Les champs metadata.face_image_source et metadata.reference_node_id indiquent d’où provient le selfie de l’entrée.
  • Dans un workflow comportant plusieurs étapes de vérification d’identité, reference_node_id désigne l’étape dont le selfie est utilisé. Par défaut, Didit utilise la vérification d’identité la plus récente qui dispose de ce selfie.
  • Ensuite, le visage est contrôlé comme tout visage de liste de blocage : par rapport au selfie de détection du vivant de chaque nouvelle session, et par rapport à chaque nouveau selfie de capture de document (voir FRONT_CAMERA_FACE_IN_BLOCKLIST).
  • La suppression de l’entrée retire le visage de la liste de blocage, et celui-ci ne correspond plus aux nouvelles sessions.

Sessions avec plusieurs enregistrements du même type

Une session peut contenir plusieurs enregistrements d’un même type, par exemple deux numéros de téléphone issus d’un workflow en plusieurs étapes. Didit lit toujours le plus récent. Si vous envoyez value avec reference_session_id, l’entrée stocke votre value mais reste liée à cet enregistrement le plus récent, et sur une liste de blocage système, c’est cet enregistrement qui est marqué. Pour inscrire une valeur provenant d’un enregistrement antérieur, ajoutez-la uniquement avec value, sans reference_session_id :

Référencer des transactions, des utilisateurs et des entreprises

Lorsque vous ajoutez à une liste de blocage des données issues d’une transaction, d’un utilisateur du fournisseur ou d’une entreprise du fournisseur, transmettez l’UUID de l’entité comme reference_object_uuid et indiquez le type de source dans metadata :
Cela vous permet d’accéder, depuis l’entrée de la liste de blocage, à la transaction, à l’utilisateur ou à l’entreprise d’origine dans la console. Didit conserve vos clés metadata, à l’exception de reference_image_url et front_image_url, que seul Didit définit. Pour une entrée issue d’une session, Didit ajoute ses propres clés aux vôtres, et ses clés prévalent. Sur les listes de blocage système Utilisateur et Entreprise, Didit passe aussi au statut BLOCKED les utilisateurs ou entreprises correspondants : ceux dont le vendor_data est égal à value, ou dont le didit_internal_id est égal à reference_object_uuid. Voir Liste de blocage des utilisateurs et Liste de blocage des entreprises.

Autorisations

x-api-key
string
header
requis

La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.

Paramètres de chemin

list_uuid
string<uuid>
requis

UUID de la liste à laquelle ajouter l'élément. Pour un visage dont vous ne disposez que sous forme d'image, utilisez plutôt Téléverser un visage dans une liste.

Corps

application/json

Envoyez value, reference_session_id, ou les deux. Les champs applicables dépendent du entry_type de la liste.

value
string

La valeur à inscrire sur la liste, validée selon l'entry_type de la liste : email une adresse e-mail valide ; phone un numéro international valide, stocké au format E.164 ; ip_address une adresse IP ou une plage CIDR (par exemple 10.0.0.0/8) ; device_fingerprint au moins 8 caractères parmi lettres, chiffres, -, _, : et . (une liste de blocage refuse une empreinte signalée par plusieurs appareils distincts) ; country un code ISO 3166-1 alpha-2 ou alpha-3, stocké en alpha-3 ; user et business le vendor_data ; tout autre type une chaîne non vide. Stocké en minuscules sauf pour les numéros de téléphone et les codes pays, et une liste conserve chaque valeur une seule fois (insensible à la casse). Requis sauf si reference_session_id est envoyé ; doit être laissé vide avec un face_image_source de capture de document.

reference_session_id
string<uuid>

Une session de vérification d'utilisateur ou d'entreprise de votre application depuis laquelle extraire la valeur. Didit lit l'enregistrement le plus récent de la session correspondant au type d'entrée de la liste (face, document, phone, email, ip_address ou device_fingerprint), associe l'entrée à la session ainsi qu'à cet enregistrement, et remplit display_label et metadata pour les documents. Pour une liste de blocage device_fingerprint, une session qui ne comporte qu'une empreinte de classe d'appareil, ou qui a été complétée sur plusieurs appareils, est refusée : envoyez l'empreinte exacte dans value. Pour les autres types d'entrées, ou lorsque la session ne contient pas un tel enregistrement, envoyez également value ; votre value est alors stockée et l'entrée reste associée à la session.

reference_object_uuid
string<uuid>

UUID de l'enregistrement représenté par l'entrée lorsqu'elle ne provient pas d'une session : un UUID de transaction, ou le didit_internal_id d'un utilisateur ou d'une entreprise. Associez-le à metadata.reference_type. Remplacé par l'enregistrement de la session lorsque reference_session_id en fournit un.

face_image_source
enum<string>
défaut:liveness

Listes de visages avec reference_session_id : image de la session à partir de laquelle le visage est extrait. liveness (par défaut) correspond au selfie de détection du vivant. front_image_camera_front et back_image_camera_front correspondent aux selfies pris par la caméra frontale pendant que l'utilisateur photographiait le recto ou le verso de son document : acceptés uniquement sur la liste de blocage de visages du système, avec reference_session_id et une value vide. Chaque selfie ne peut être ajouté qu'une seule fois et doit présenter un seul visage net.

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

Avec un face_image_source de capture de document : le nœud de vérification d'identité dont le selfie doit être utilisé, pour les workflows qui en comportent plusieurs. Par défaut, il s'agit de la vérification d'identité la plus récente disposant de cette image. Refusé avec liveness.

Maximum string length: 100
display_label
string

Libellé lisible par l'humain. Lorsqu'il est vide, Didit en déduit un à partir de la session dans la mesure du possible (par exemple le nom du titulaire et le numéro de document).

Maximum string length: 512
comment
string

Note en texte libre, telle que le motif d'inscription sur la liste.

metadata
object

JSON libre stocké avec l'entrée et renvoyé tel quel. Utilisez reference_type et reference_id afin que la console crée un lien vers la source. reference_image_url et front_image_url sont définis par Didit uniquement et sont ignorés si vous les envoyez. Pour une entrée lue depuis une session, les clés de Didit sont fusionnées avec les vôtres.

Réponse

L'entrée a été créée.

Une valeur dans une liste.

uuid
string<uuid>
requis

Identifiant d'entrée. Utilisez-le comme entry_uuid dans Supprimer une entrée de liste.

value
string
requis

La valeur répertoriée : un numéro de téléphone au format E.164, une adresse e-mail, un numéro de document, une adresse IP ou une plage CIDR, une empreinte d'appareil, une adresse, un compte bancaire, un code pays ISO 3166-1 alpha-3, une vendor_data, toute chaîne de caractères sur une liste de type key, ou l'UUID du visage enregistré sur une liste de visages. Les valeurs que vous envoyez sont stockées en minuscules, à l'exception des numéros de téléphone et des codes pays. La recherche de correspondance est insensible à la casse.

display_label
string | null
requis

Libellé lisible par l'humain. Didit le renseigne pour les entrées issues d'une session (par exemple le nom du titulaire et le numéro de document) lorsque vous n'en transmettez aucun.

Maximum string length: 512
comment
string
requis

Note en texte libre. Chaîne vide lorsqu'elle n'est pas définie.

added_by
string | null
requis

Qui a ajouté l'entrée : api (une clé API), l'adresse e-mail d'un utilisateur de la console ou console, system ou migration (entrées créées par Didit), ou rule (une action de règle de transaction ou de surveillance).

reference_session_id
string<uuid> | null
requis

Session de vérification dont provient l'entrée. null lorsque l'entrée a été ajoutée par valeur.

reference_session_number
integer | null
requis

Numéro de cette session propre à l'application, tel qu'affiché dans la console.

reference_session_type
enum<string> | null
requis

kyc pour une session de vérification de personne, kyb pour une session de vérification d'entreprise, null lorsqu'il n'y a pas de session.

Options disponibles:
kyc,
kyb,
null
reference_object_uuid
string<uuid> | null
requis

L'enregistrement que l'entrée représente : l'enregistrement de visage, de document, de téléphone ou d'e-mail lu à partir d'une session, le visage créé par Charger un visage dans une liste, ou l'UUID que vous avez envoyé (par exemple un UUID de transaction ou le didit_internal_id d'un utilisateur).

metadata
object | null
requis

Contexte supplémentaire. Contient les clés définies par Didit (listées ici) fusionnées avec les metadata que vous avez envoyées lors de la création de l'entrée, renvoyées telles quelles. null lorsqu'il n'y en a pas.

created_at
string<date-time>
requis

Date et heure d'ajout de l'entrée.

Dernière modification le 7 novembre 2026