Passer au contenu principal
POST
curl

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.

En-têtes

Idempotency-Key
string

Clé de sécurité de nouvelle tentative optionnelle, jusqu'à 255 caractères. La réutilisation de la même clé avec le même corps de requête renvoie la réponse d'origine sans exécuter ni facturer un second filtrage. La réutilisation de la clé avec un corps différent renvoie 409.

Maximum string length: 255

Corps

application/json
full_name
string
requis

Nom complet de la personne ou de l'entreprise à filtrer. Minimum 2 caractères - seuil plancher propre au fournisseur de filtrage. Un nom plus court ou vide renvoie 400 sur ce champ avant tout filtrage, de sorte que rien n'est facturé.

Minimum string length: 2
Exemple:

"Antonio Ejemplo Modelo"

entity_type
enum<string>
défaut:person

Type d'entité à filtrer. Valeur par défaut : person.

Options disponibles:
person,
company
date_of_birth
string<date>

Date de naissance (personnes) ou date de constitution (entreprises), YYYY-MM-DD. Améliore la précision de la correspondance via le poids de la date de naissance.

Exemple:

"1972-02-29"

nationality
string

Code pays ISO 3166-1 alpha-2 (par exemple ES). Les codes invalides renvoient 400. Améliore la précision de correspondance grâce au poids attribué au pays.

Exemple:

"ES"

document_number
string

Numéro du document d'identité. Non pondéré — agit comme une clé déterminante : une correspondance exacte remplace le match_score du résultat par 100, une discordance stricte le pénalise. Envoyé au fournisseur de filtrage comme filtre de recherche uniquement lorsqu'il comporte 2-50 caractères ; une valeur en dehors de cette plage est acceptée et stockée, et le filtrage s'exécute et est facturé normalement, mais n'est simplement pas affiné par le numéro de document.

aml_score_approve_threshold
number
défaut:80

Seuil de score de risque auquel ou en dessous duquel le résultat est Approved. Doit être ≤ aml_score_review_threshold (sinon 400).

Plage requise: 0 <= x <= 100
aml_score_review_threshold
number
défaut:100

Seuil de score de risque au-dessus duquel le résultat est Declined. Les scores situés entre les deux seuils produisent In Review.

Plage requise: 0 <= x <= 100
aml_name_weight
integer
défaut:60

Poids de la similarité de nom dans le score de correspondance par correspondance. La somme des trois poids doit être exactement égale à 100 (sinon 400).

Plage requise: 0 <= x <= 100
aml_dob_weight
integer
défaut:25

Poids de la date de naissance dans le score de correspondance par correspondance.

Plage requise: 0 <= x <= 100
aml_country_weight
integer
défaut:15

Poids du pays/de la nationalité dans le score de correspondance par correspondance.

Plage requise: 0 <= x <= 100
aml_match_score_threshold
integer
défaut:93

Seuil par résultat : les résultats avec un match_score inférieur à cette valeur sont False Positive (exclus de l'évaluation du risque) ; ceux atteignant ou dépassant cette valeur sont des correspondances possibles Unreviewed.

Plage requise: 0 <= x <= 100
include_adverse_media
boolean
défaut:false

Rechercher également la presse négative dans les médias d'information. Ajoute jusqu'à ~30 s de latence pendant la collecte des résultats — utilisez un délai d'expiration client ≥ 60 s.

include_ongoing_monitoring
boolean
défaut:false

Continuer à filtrer ce profil et transmettre les modifications par webhook. Nécessite save_api_request=true (sinon 400).

save_api_request
boolean
défaut:true

Conserver le filtrage en tant que session (visibilité dans la console, endpoint de décision, webhooks, examen des correspondances). Définissez sur false pour une vérification sans état.

vendor_data
string

Votre identifiant pour l'utilisateur filtré ; renvoyé en écho et conservé avec la session.

metadata
object | null

JSON libre stocké avec la requête et renvoyé en écho.

sandbox_scenario
string

Identifiant de scénario réservé à la sandbox. Accepté uniquement lorsque la clé API appartient à une application en mode sandbox ; rejeté sur les applications en production. Un filtrage autonome n'ayant pas de session à armer, le slug est directement transmis dans la requête de filtrage : decline_aml_hit renvoie une correspondance conforme au format de production et clôture le filtrage avec le statut Declined, review_aml_possible_match le clôture avec le statut In Review, et un scénario n'armant aucun résultat AML laisse le filtrage vierge. Consultez le catalogue des scénarios à GET /v1/sandbox/scenarios/ ou Sandbox et données de test.

Exemple:

"decline_aml_hit"

Réponse

Filtrage terminé. aml.status reflète vos seuils ; chaque résultat atteignant ou dépassant le seuil minimal interne d'inclusion est listé dans aml.hits avec son match_score d'identité, son risk_score d'entité et une décomposition score_breakdown expliquant la correspondance.

request_id
string<uuid>

Identifiant de session persistante lorsque save_api_request=true (utilisable avec GET /v3/session/{sessionId}/decision/) ; sinon un UUID de corrélation temporaire.

aml
object
vendor_data
string | null

Valeur renvoyée de vendor_data que vous avez envoyé.

metadata
object | null

Écho des metadata que vous avez envoyées.

created_at
string<date-time>
Dernière modification le 7 novembre 2026