Commencer
Intégrer / SDK
Vérification des utilisateurs
Vérification d'entreprise
Surveillance des transactions
Journal des modificationscurl -X POST 'https://verification.didit.me/v3/users/create/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"vendor_data": "user-abc-123", "full_name": "John Doe"}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.users.create(
vendor_data="user-abc-123",
full_name="John Doe",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.users.create({
vendor_data: "user-abc-123",
full_name: "John Doe",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Users.Create(ctx, didit.UsersCreateParams{
VendorData: "user-abc-123",
FullName: didit.String("John Doe"),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.UsersCreateParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.users().create(UsersCreateParams.builder()
.vendorData("user-abc-123")
.fullName("John Doe")
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->users->create([
'vendor_data' => 'user-abc-123',
'full_name' => 'John Doe',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.users.create(
vendor_data: "user-abc-123",
full_name: "John Doe"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Users.CreateAsync(new UsersCreateParams
{
VendorData = "user-abc-123",
FullName = "John Doe",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418",
"vendor_data": "user-abc-123",
"display_name": null,
"full_name": "John Doe",
"date_of_birth": null,
"effective_name": "John Doe",
"status": "ACTIVE",
"metadata": {},
"portrait_image_url": null,
"session_count": 0,
"approved_count": 0,
"declined_count": 0,
"in_review_count": 0,
"issuing_states": [],
"approved_emails": [],
"approved_phones": [],
"features": {},
"features_list": [],
"last_session_at": null,
"last_activity_at": "2025-06-15T10:30:00Z",
"first_session_at": null,
"tags": [],
"comments": [],
"created_at": "2025-06-15T10:30:00Z",
"updated_at": "2025-06-15T10:30:00Z",
"verification_link": null
}API de création d'utilisateur : entité User fournisseur
Pré-créez des entités User Didit avant les sessions KYC. Importez des utilisateurs en masse ou pour la surveillance des transactions.
curl -X POST 'https://verification.didit.me/v3/users/create/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"vendor_data": "user-abc-123", "full_name": "John Doe"}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.users.create(
vendor_data="user-abc-123",
full_name="John Doe",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.users.create({
vendor_data: "user-abc-123",
full_name: "John Doe",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Users.Create(ctx, didit.UsersCreateParams{
VendorData: "user-abc-123",
FullName: didit.String("John Doe"),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.UsersCreateParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.users().create(UsersCreateParams.builder()
.vendorData("user-abc-123")
.fullName("John Doe")
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->users->create([
'vendor_data' => 'user-abc-123',
'full_name' => 'John Doe',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.users.create(
vendor_data: "user-abc-123",
full_name: "John Doe"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Users.CreateAsync(new UsersCreateParams
{
VendorData = "user-abc-123",
FullName = "John Doe",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418",
"vendor_data": "user-abc-123",
"display_name": null,
"full_name": "John Doe",
"date_of_birth": null,
"effective_name": "John Doe",
"status": "ACTIVE",
"metadata": {},
"portrait_image_url": null,
"session_count": 0,
"approved_count": 0,
"declined_count": 0,
"in_review_count": 0,
"issuing_states": [],
"approved_emails": [],
"approved_phones": [],
"features": {},
"features_list": [],
"last_session_at": null,
"last_activity_at": "2025-06-15T10:30:00Z",
"first_session_at": null,
"tags": [],
"comments": [],
"created_at": "2025-06-15T10:30:00Z",
"updated_at": "2025-06-15T10:30:00Z",
"verification_link": null
}Vue d’ensemble
Crée explicitement une entité User avant le lancement de toute session. L’entité renvoyée passe au statutACTIVE, sauf indication contraire.
Vous pouvez également faire en sorte que le même appel envoie à la personne un lien de vérification par e-mail (voir Envoyer un lien de vérification).
Quand l’utiliser
- Pré-renseigner les métadonnées (niveau, source d’inscription, étiquettes internes) avant que le client ne procède à sa vérification.
- Migrer depuis un autre prestataire : recréer votre liste d’utilisateurs existants dans Didit afin que l’historique et les analyses partent d’une base de référence connue.
- Importer des visages de profil de confiance : créez d’abord l’utilisateur, puis appelez Téléverser un visage utilisateur avec le
didit_internal_idrenvoyé. - Cas d’usage limités aux transactions : enregistrez un utilisateur avec
vendor_dataafin de soumettre des transactions sans jamais lancer de session de Vérification des utilisateurs (KYC). - Inviter une personne à se vérifier : créez la personne et envoyez-lui un lien de vérification par e-mail en un seul appel.
Coordonnées
Vous pouvez transmettre les coordonnées de la personne en même temps que les champs du profil.first_name et last_name sont concaténés avec un espace dans full_name lorsque vous n’envoyez pas full_name.
email et phone_number sont stockés dans metadata.contact, et country dans metadata.address.
country accepte un code ISO 3166, alpha-2 ou alpha-3 (ES ou ESP), et est stocké en majuscules.
Si la valeur metadata que vous envoyez contient déjà une valeur contact ou address qui n’est pas un objet JSON, Didit ne l’écrase pas : l’appel renvoie 400 pour le champ concerné.
Envoyer un lien de vérification
Définissezsend_verification_link sur true pour inviter la personne à se vérifier dans le même appel.
Didit crée une session de vérification pour la personne selon le workflow indiqué dans workflow_id et lui envoie le lien à l’adresse email.
Utilisez language pour choisir la langue de l’e-mail ; il est en anglais si vous ne le renseignez pas.
curl -X POST https://verification.didit.me/v3/users/create/ \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"vendor_data": "user-abc-789",
"first_name": "Julia",
"last_name": "Martin",
"email": "julia.martin@example.com",
"send_verification_link": true,
"workflow_id": "YOUR_WORKFLOW_ID",
"language": "es"
}'
emailetworkflow_idsont obligatoires avec un lien, et le workflow doit vérifier une personne : un workflow de Vérification d’entreprise (KYB) renvoie400.- La session passe par les mêmes contrôles que Créer une session.
Un
vendor_datafigurant sur une liste de blocage, ou un solde de crédits insuffisant, renvoie400. - La personne et la session sont créées ensemble ou pas du tout. Si un contrôle échoue, rien n’est écrit et aucun e-mail n’est envoyé.
- La réponse contient
verification_linkavec lesession_id, lesession_number, lestatus, l’url, leworkflow_idde la session et l’emailauquel le lien a été envoyé. Sans lien,verification_linkvautnull.
Notes
vendor_dataest obligatoire et doit être unique par application. Tenter de créer un doublon renvoie une erreur de conflit : utilisezPATCH /v3/users/{vendor_data}/pour mettre à jour un utilisateur existant.vendor_dataa une limite stricte de 2000 octets (encodage UTF-8). Une valeur qui dépasse cette limite renvoie une erreur de validation 400 au lieu d’être acceptée.- Les champs normalement issus des sessions vérifiées (
full_name,date_of_birth) peuvent être pré-renseignés ici, mais ils peuvent être écrasés par la première session de Vérification des utilisateurs (KYC) approuvée. - Cet endpoint n’accepte pas les images de visage. Pour associer un visage importé de confiance, utilisez
POST /v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/après que cet endpoint a renvoyédidit_internal_id. - La création elle-même n’envoie aucun webhook. Les modifications ultérieures de l’utilisateur envoient
user.data.updatedouuser.status.updated. - Avec
send_verification_link, la nouvelle session met à jour l’utilisateur dans le même appel, ce qui envoieuser.data.updated.
Autorisations
Le secret principal et les clés API à accès complet peuvent toujours appeler cet endpoint. Une clé à accès personnalisé a besoin de l’autorisation d’écriture sur Personnes (users).
Avec send_verification_link: true, elle a aussi besoin de l’autorisation d’écriture sur les Sessions, car l’appel crée une session et en transmet le lien.
Sans cette autorisation, l’appel renvoie 403 avec le message This API key has no write access to sessions. et rien n’est écrit.
Une clé limitée à certains workflows ou à certaines sessions approuvées ne peut pas accéder à cet endpoint.
Les rôles et autorisations de la Console déterminent ce qu’un membre de l’équipe peut faire dans la Console.
Ils ne sont pas évalués pour les requêtes effectuées avec une clé API.
Liens connexes
- Modèle de données utilisateur
- Téléverser un visage utilisateur
- Liaison des données fournisseur
- Opérations sur les utilisateurs
Autorisations
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.
Corps
Votre identifiant unique pour cet utilisateur (chaîne libre, PAS un UUID). Doit être unique parmi les utilisateurs de l'application ; mis en correspondance exactement tel qu'envoyé.
Nom complet légal de l'utilisateur.
512Nom d'affichage convivial affiché dans la console (prend le pas sur full_name pour l'affichage de l'interface utilisateur).
255Date de naissance au format YYYY-MM-DD.
Statut de cycle de vie initial. La valeur par défaut est ACTIVE.
ACTIVE, FLAGGED, BLOCKED Objet JSON arbitraire que vous associez à l'utilisateur. La valeur par défaut est {}.
Adresses e-mail pré-approuvées pour cet utilisateur, par exemple ["john@example.com"].
Numéros de téléphone pré-approuvés pour cet utilisateur, par exemple ["+14155551234"].
Pays de délivrance pré-enregistrés (ISO 3166-1 alpha-3), par exemple ["USA"].
Prénom. Lorsque full_name n'est pas envoyé, Didit concatène first_name et last_name avec un espace pour former full_name. Non renvoyé sous la forme d'un champ distinct.
255Nom de famille. Combiné avec first_name pour former full_name lorsque full_name n'est pas envoyé. N'est pas renvoyé en tant que champ distinct.
255E-mail de contact, stocké dans metadata.contact.email (il remplace un email que vous envoyez dans metadata.contact). Requis lorsque send_verification_link est défini sur true : le lien est envoyé à cette adresse. Si metadata.contact n'est pas un objet JSON, l'appel renvoie 400 sur ce champ.
Numéro de téléphone de contact, stocké dans metadata.contact.phone_number. Si metadata.contact n'est pas un objet JSON, l'appel renvoie 400 sur ce champ.
32Pays sous forme de code ISO 3166, alpha-2 ou alpha-3 (ES ou ESP). Stocké en majuscules dans metadata.address.country. Si metadata.address n'est pas un objet JSON, l'appel renvoie 400 sur ce champ.
3Lorsque la valeur est true, Didit crée une session de vérification pour la personne sur le workflow workflow_id et lui envoie le lien par e-mail à l'adresse email. Nécessite email et workflow_id. Une clé API restreinte nécessite également les droits d'écriture sur sessions.
Le workflow de la session de vérification. Requis lorsque send_verification_link vaut true. Il doit vérifier une personne : un workflow de Vérification d'entreprise (KYB) est refusé. Ignoré dans le cas contraire.
Langue de l'e-mail de vérification, sous forme de code de langue prise en charge. Anglais en cas d'omission. Ignoré lorsque send_verification_link n'est pas true.
10Réponse
Utilisateur créé. Enregistrement utilisateur complet (même format que Obtenir un utilisateur), plus verification_link : la session de vérification envoyée par e-mail par Didit lorsque send_verification_link était à true, sinon null.
Détails complets de l'utilisateur. Étend UserListItem avec les métadonnées, les commentaires et updated_at.
La session de vérification créée et envoyée par e-mail à la personne par Didit. Toujours présent : null lorsque send_verification_link n'était pas true.
Show child attributes
Show child attributes
UUID interne stable de Didit pour cet utilisateur.
Votre identifiant unique pour cet utilisateur (transmis lors de la création des sessions). Peut être nul si aucun identifiant fournisseur n'a été fourni.
Nom d'affichage personnalisé défini par vous
Nom complet extrait des documents vérifiés
Meilleur nom disponible : display_name s'il est défini, sinon full_name
Statut de cycle de vie de l'enregistrement utilisateur (PAS un statut de session). ACTIVE est la valeur par défaut, FLAGGED signale l'utilisateur pour un examen manuel, BLOCKED empêche de nouvelles sessions pour ce vendor_data.
ACTIVE, FLAGGED, BLOCKED URL pré-signée de la photo de portrait de l'utilisateur (expire après quelques heures)
Nombre total de sessions de vérification pour cet utilisateur
Nombre de sessions approuvées
Nombre de sessions refusées
Nombre de sessions en cours d'examen
Codes ISO 3166-1 alpha-3 des pays de délivrance observés sur les documents d'identité approuvés de cet utilisateur, par ex. ["USA", "ESP"]. Tableau vide s'il n'y en a aucun.
Adresses e-mail vérifiées collectées à partir des sessions approuvées de cet utilisateur, par ex. ["john@example.com"].
Numéros de téléphone vérifiés collectés à partir des sessions approuvées de cet utilisateur, par ex. ["+14155551234"].
Statut agrégé par fonctionnalité sur l'ensemble des sessions de cet utilisateur. Clés possibles : ID_VERIFICATION, NFC, LIVENESS, FACE_MATCH, POA, QUESTIONNAIRE, EMAIL_VERIFICATION, PHONE, AML, IP_ANALYSIS, AGE_ESTIMATION, DATABASE_VALIDATION. Valeurs possibles : Approved, Declined, In Review, Not Finished, Resub Requested.
Mêmes données que features, sous la forme d'un tableau ordonné d'objets {feature, status}.
Show child attributes
Show child attributes
Horodatage de la session la plus récente
Horodatage de la première session
Horodatage de l'activité la plus récente sur cet utilisateur (session, transaction, changement de statut, modification des données, etc.).
Attributions de tags. REMARQUE : sur les réponses détaillées, chaque entrée est un objet de liaison de tag ({uuid, tag: {...}, added_by_email, added_by_name, created_at}), contrairement au format plat {uuid, name, color} utilisé sur les réponses de liste.
Show child attributes
Show child attributes
JSON de métadonnées personnalisées que vous avez associé à cet utilisateur. La valeur par défaut est {}.
Journal d'activité et commentaires pour cet utilisateur (changements de statut, modifications de profil, notes manuelles).
Show child attributes
Show child attributes