Passer au contenu principal
POST
curl
Importez une image de visage encodée en base64 dans une liste de blocage ou d’autorisation faciale. Didit détecte les visages présents dans l’image, conserve le plus grand, stocke l’image et un recadrage de ce visage, puis calcule le gabarit biométrique facial auquel les nouvelles sessions sont comparées. La valeur (value) de la nouvelle entrée est l’UUID de ce visage. Disponible uniquement pour les listes avec entry_type: face et list_type: blocklist ou list_type: allowlist.
Si vous souhaitez ajouter à une liste de blocage ou d’autorisation un visage provenant d’une session existante, utilisez plutôt Créer une entrée avec reference_session_id : l’entrée renvoie à la session.
L’image doit contenir un visage clairement visible et ne pas dépasser 2 Mo une fois décodée. Si aucun visage n’est détecté, la requête renvoie 400 et aucune entrée n’est créée. Si l’analyse faciale est temporairement indisponible, elle renvoie 503 : réessayez plus tard.
Pour retirer le visage de la liste, supprimez son entrée : il ne correspondra plus aux nouvelles sessions.

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 d'une liste avec entry_type: face et list_type: blocklist ou allowlist.

Corps

application/json
image
string<byte>
requis

JPEG ou PNG encodé en Base64, d'au plus 2 Mo une fois décodé, montrant un visage clairement visible. Envoyez la chaîne base64 brute, sans préfixe data:image/...;base64,.

comment
string
défaut:""

Note en texte libre optionnelle, telle que le motif de l'inscription sur la liste.

Réponse

L'entrée faciale 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