Commencer
Intégrer / SDK
Vérification des utilisateurs
Vérification d'entreprise
Surveillance des transactions
Journal des modificationscurl -X PATCH 'https://verification.didit.me/v3/webhook/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.webhooks.update_config(
face_retention_policy="retain_until_user_deleted",
face_retention_days=365,
biometric_consent_mode="auto",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.webhooks.updateConfig({
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto",
});
console.log(result);import me.didit.Didit;
import me.didit.types.WebhooksUpdateConfigParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.webhooks().updateConfig(WebhooksUpdateConfigParams.builder()
.faceRetentionPolicy(WebhooksUpdateConfigParams.FaceRetentionPolicy.of("retain_until_user_deleted"))
.faceRetentionDays(365L)
.biometricConsentMode(WebhooksUpdateConfigParams.BiometricConsentMode.of("auto"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->webhooks->updateConfig([
'face_retention_policy' => 'retain_until_user_deleted',
'face_retention_days' => 365,
'biometric_consent_mode' => 'auto',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.webhooks.update_config(
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Webhooks.UpdateConfigAsync(new WebhooksUpdateConfigParams
{
FaceRetentionPolicy = new WebhooksUpdateConfigParamsFaceRetentionPolicy("retain_until_user_deleted"),
FaceRetentionDays = 365,
BiometricConsentMode = new WebhooksUpdateConfigParamsBiometricConsentMode("auto"),
});
Console.WriteLine(JsonSerializer.Serialize(result));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://verification.didit.me/v3/webhook/"
payload := strings.NewReader("{\n \"face_retention_policy\": \"retain_until_user_deleted\",\n \"face_retention_days\": 365,\n \"biometric_consent_mode\": \"auto\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"webhook_url": "https://yourapp.com/webhooks/didit",
"webhook_version": "v3",
"secret_shared_key": "dGhpcy1pcy10aGUtYXBwLWxldmVsLXNlY3JldC0wMDA",
"capture_method": "MOBILE",
"data_retention_months": 24,
"face_retention_policy": "retain_until_user_deleted",
"face_retention_days": 365,
"biometric_consent_mode": "auto",
"available_events": [
{
"value": "status.updated",
"label": "Session status updated"
},
{
"value": "data.updated",
"label": "Session data updated"
},
{
"value": "user.status.updated",
"label": "User status updated"
},
{
"value": "user.data.updated",
"label": "User data updated"
},
{
"value": "business.status.updated",
"label": "Business status updated"
},
{
"value": "business.data.updated",
"label": "Business data updated"
},
{
"value": "activity.created",
"label": "Activity created"
},
{
"value": "transaction.created",
"label": "Transaction created"
},
{
"value": "transaction.status.updated",
"label": "Transaction status updated"
},
{
"value": "travel_rule.status.updated",
"label": "Travel Rule Status Updated"
},
{
"value": "workflow.compliance_changed",
"label": "Workflow Compliance Changed"
}
],
"allowed_return_hosts": [
"shop.example.com"
],
"endpoints": [
{
"uuid": "11111111-2222-3333-4444-555555555555",
"label": "Production session webhooks",
"url": "https://yourapp.com/webhooks/didit",
"enabled": true,
"webhook_version": "v3",
"secret_shared_key": "dGhpcy1pcy1hbi1leGFtcGxlLXNlY3JldC0wMDAwMDA",
"subscribed_events": [
"status.updated",
"data.updated"
],
"created_at": "2026-01-04T08:00:00.000000Z",
"updated_at": "2026-04-22T14:09:11.523671Z"
}
]
}Mise à jour de la configuration webhook API
Modifiez le webhook de l’application Didit, faites tourner son secret, réglez la rétention des données et ajoutez les hôtes de retour.
curl -X PATCH 'https://verification.didit.me/v3/webhook/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.webhooks.update_config(
face_retention_policy="retain_until_user_deleted",
face_retention_days=365,
biometric_consent_mode="auto",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.webhooks.updateConfig({
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto",
});
console.log(result);import me.didit.Didit;
import me.didit.types.WebhooksUpdateConfigParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.webhooks().updateConfig(WebhooksUpdateConfigParams.builder()
.faceRetentionPolicy(WebhooksUpdateConfigParams.FaceRetentionPolicy.of("retain_until_user_deleted"))
.faceRetentionDays(365L)
.biometricConsentMode(WebhooksUpdateConfigParams.BiometricConsentMode.of("auto"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->webhooks->updateConfig([
'face_retention_policy' => 'retain_until_user_deleted',
'face_retention_days' => 365,
'biometric_consent_mode' => 'auto',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.webhooks.update_config(
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Webhooks.UpdateConfigAsync(new WebhooksUpdateConfigParams
{
FaceRetentionPolicy = new WebhooksUpdateConfigParamsFaceRetentionPolicy("retain_until_user_deleted"),
FaceRetentionDays = 365,
BiometricConsentMode = new WebhooksUpdateConfigParamsBiometricConsentMode("auto"),
});
Console.WriteLine(JsonSerializer.Serialize(result));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://verification.didit.me/v3/webhook/"
payload := strings.NewReader("{\n \"face_retention_policy\": \"retain_until_user_deleted\",\n \"face_retention_days\": 365,\n \"biometric_consent_mode\": \"auto\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"webhook_url": "https://yourapp.com/webhooks/didit",
"webhook_version": "v3",
"secret_shared_key": "dGhpcy1pcy10aGUtYXBwLWxldmVsLXNlY3JldC0wMDA",
"capture_method": "MOBILE",
"data_retention_months": 24,
"face_retention_policy": "retain_until_user_deleted",
"face_retention_days": 365,
"biometric_consent_mode": "auto",
"available_events": [
{
"value": "status.updated",
"label": "Session status updated"
},
{
"value": "data.updated",
"label": "Session data updated"
},
{
"value": "user.status.updated",
"label": "User status updated"
},
{
"value": "user.data.updated",
"label": "User data updated"
},
{
"value": "business.status.updated",
"label": "Business status updated"
},
{
"value": "business.data.updated",
"label": "Business data updated"
},
{
"value": "activity.created",
"label": "Activity created"
},
{
"value": "transaction.created",
"label": "Transaction created"
},
{
"value": "transaction.status.updated",
"label": "Transaction status updated"
},
{
"value": "travel_rule.status.updated",
"label": "Travel Rule Status Updated"
},
{
"value": "workflow.compliance_changed",
"label": "Workflow Compliance Changed"
}
],
"allowed_return_hosts": [
"shop.example.com"
],
"endpoints": [
{
"uuid": "11111111-2222-3333-4444-555555555555",
"label": "Production session webhooks",
"url": "https://yourapp.com/webhooks/didit",
"enabled": true,
"webhook_version": "v3",
"secret_shared_key": "dGhpcy1pcy1hbi1leGFtcGxlLXNlY3JldC0wMDAwMDA",
"subscribed_events": [
"status.updated",
"data.updated"
],
"created_at": "2026-01-04T08:00:00.000000Z",
"updated_at": "2026-04-22T14:09:11.523671Z"
}
]
}rotate_secret_key ne fait pivoter que le secret au niveau de l’application, qui signe les envois vers l’ancien webhook_url. Chaque destination de webhook signe avec son propre secret_shared_key, que cet appel ne modifie pas.allowed_return_hosts est décrit dans Enregistrer votre destination de retour.
biometric_consent_mode (auto, always ou never) définit le moment où le flux de vérification demande un consentement biométrique explicite avant une capture faciale. Consultez Consentement biométrique.
Pour lire d’abord les valeurs actuelles, appelez Obtenir la configuration du webhook.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
Envoyez uniquement les champs à modifier. Les destinations ne sont pas gérées ici.
URL de webhook au niveau de l'application obsolète. Didit l'utilise uniquement tant que l'application n'a aucune destination activée, et seulement pour status.updated et data.updated. Cela ne crée pas de destination, et la prochaine création, mise à jour ou suppression d'une destination la remplace. Pour recevoir des webhooks, créez plutôt une destination avec POST /v3/webhook/destinations/.
2000Version du payload de l'ancien webhook_url.
v1, v2, v3 true remplace immédiatement la valeur secret_shared_key au niveau de l'application par une nouvelle valeur aléatoire ; la nouvelle valeur figure dans la réponse. Les secrets des destinations ne sont pas modifiés. Chaque appel avec true génère un nouveau secret, il n'est donc pas idempotent.
Paramètre d'application obsolète. Le workflow de vérification ne le lit pas.
MOBILE, MOBILE_AND_DESKTOP Fenêtre de suppression automatique en mois (un mois compte pour 30 jours), ou null pour aucune suppression automatique. Une modification s'applique également aux sessions existantes : chaque session de vérification d'un utilisateur plus ancienne que la nouvelle période est supprimée automatiquement, et cette suppression est irréversible.
1 <= x <= 120Ce qui advient de l'embedding facial d'une session lorsque la session est supprimée. retain_until_user_deleted nécessite face_retention_days dans la même requête ou déjà défini. Une modification s'applique aux suppressions de session à partir de ce moment ; elle ne crée ni ne purge aucun gabarit biométrique existant.
delete_with_session, retain_until_user_deleted Durée de conservation, en jours, des gabarits biométriques sous retain_until_user_deleted.
1 <= x <= 3650Moment où le flux hébergé et les SDK natifs demandent à la personne son consentement biométrique explicite avant une capture faciale. auto (par défaut) ne le demande que lorsqu'un déclencheur s'applique : un État déclaré, l'IP de la personne ou l'émetteur du document d'identité se trouve dans l'Illinois, au Texas ou au Colorado, ou la personne semble être aux États-Unis sans État connu. always le demande à chaque personne dont le workflow capture un visage. never n'affiche jamais l'étape, et vous recueillez vous-même le consentement avant le selfie. Chaque modification est enregistrée dans le journal d'audit. Voir Consentement biométrique.
auto, always, never Remplace l'ensemble de la liste des hôtes de redirection pour le portefeuille Digital ID. Noms d'hôte simples uniquement, par exemple shop.example.com : pas de protocole, port, chemin ni caractère générique. Les valeurs sont converties en minuscules et les doublons sont supprimés. Envoyez [] pour vider la liste.
20253Remplace l'ensemble de la liste des origines autorisées. Origines (par exemple https://app.example.com ; http uniquement pour localhost) au sein desquelles le flux de vérification hébergé peut être intégré et vers lesquelles il peut rediriger l'utilisateur avec un rappel de session. Les appels de serveur à serveur ne sont pas affectés. Une liste vide signifie qu'aucune restriction n'est appliquée. Didit enregistre chaque origine en minuscules sans port par défaut. Une entrée non valide échoue avec une erreur 400 sur allowed_domains. Envoyez [] pour supprimer la restriction.
50300["https://app.example.com"]
Réponse
La configuration complète après la mise à jour, sous la même forme que GET /v3/webhook/. Si vous avez renouvelé le secret, enregistrez la nouvelle secret_shared_key avant d'écarter la réponse.
Configuration des webhooks au niveau de l'application, politique de conservation et hôtes de retour de portefeuille Digital ID, avec chaque destination de webhook.
URL de webhook (héritée) au niveau de l'application. Didit n'envoie vers celle-ci que lorsque l'application ne dispose d'aucune destination activée, et uniquement status.updated et data.updated. Chaque création, mise à jour ou suppression d'une destination la définit sur l'URL de la destination activée la plus ancienne, ou sur null lorsqu'aucune n'est activée.
Version du payload de l'ancien webhook_url. Chaque destination possède sa propre webhook_version.
v1, v2, v3 Secret de signature au niveau de l'application (token de 43 caractères compatible URL). Il signe uniquement les livraisons vers la webhook_url héritée ; chaque destination signe avec son propre secret_shared_key. Les appelants utilisant une clé API le reçoivent toujours dans son intégralité ; les utilisateurs de la console sans read:webhooks reçoivent une chaîne vide.
Paramètre d'application obsolète. Le workflow de vérification ne le lit pas : les options de capture sont configurées par workflow.
MOBILE, MOBILE_AND_DESKTOP Délai de suppression automatique. Les sessions de vérification des utilisateurs créées il y a plus de ce nombre de mois (un mois correspond à 30 jours) sont supprimées automatiquement, et cette suppression est irréversible. null signifie que les sessions ne sont jamais supprimées automatiquement. Voir Conservation des données.
1 <= x <= 120Ce qui advient de l'embedding facial d'une session lorsque la session est supprimée. delete_with_session (par défaut) le supprime avec la session. retain_until_user_deleted correspond à l'option de conservation des gabarits biométriques : un gabarit biométrique sans image lié à l'User est géré séparément jusqu'à ce que sa période de conservation prenne fin, que l'User soit supprimé ou que vous le purgiez.
delete_with_session, retain_until_user_deleted Durée de conservation, en jours, des gabarits biométriques sous retain_until_user_deleted. Requis lorsque cette politique est définie.
1 <= x <= 3650Chaque type d'événement auquel une destination peut s'abonner, avec un libellé d'affichage.
Show child attributes
Show child attributes
Noms d'hôte (correspondance exacte, HTTPS uniquement) vers lesquels une vérification de portefeuille Digital ID autonome peut renvoyer l'utilisateur avec son return_url. Votre domaine en marque blanche est également toujours autorisé. Voir Enregistrer votre destination de retour.
20253Chaque destination de webhook de l'application, de la plus ancienne à la plus récente, chacune avec son secret de signature. En lecture seule ici : gérez les destinations avec les endpoints /v3/webhook/destinations/.
Show child attributes
Show child attributes
Moment où le flux hébergé et les SDK natifs demandent à la personne son consentement biométrique explicite avant une capture faciale. auto (par défaut) ne le demande que lorsqu'un déclencheur s'applique : un État déclaré, l'IP de la personne ou l'émetteur du document d'identité se trouve dans l'Illinois, au Texas ou au Colorado, ou la personne semble être aux États-Unis sans État connu. always le demande à chaque personne dont le workflow capture un visage. never n'affiche jamais l'étape, et vous recueillez vous-même le consentement avant le selfie. Chaque modification est enregistrée dans le journal d'audit. Voir Consentement biométrique.
auto, always, never Origines (par exemple https://app.example.com ; http uniquement pour localhost) dans lesquelles le flux de vérification hébergé peut être intégré et vers lesquelles il peut rediriger l'utilisateur avec un rappel de session. Les appels de serveur à serveur ne sont pas affectés. Une liste vide signifie qu'il n'y a aucune restriction. Didit enregistre chaque origine en minuscules sans port par défaut. Une entrée non valide échoue avec une erreur 400 sur allowed_domains.
50300["https://app.example.com"]