Passer au contenu principal
GET
curl
Cet endpoint renvoie le webhook au niveau de l’application, datant d’avant l’existence des destinations, ainsi que la liste des destinations. Didit envoie les webhooks vers vos destinations de webhook, chacune signée avec son propre secret_shared_key ; les champs de premier niveau webhook_url, webhook_version et secret_shared_key ne sont utilisés que tant qu’aucune destination n’est activée, et uniquement pour status.updated et data.updated.
La réponse contient tous les secrets de signature de votre application. Ne la faites pas figurer dans les journaux ni dans le code côté client.
Pour modifier ces paramètres, utilisez Mettre à jour la configuration du webhook. Pour la vérification de signature et les payloads, consultez le guide des webhooks. Pour les champs de conservation, consultez Conservation des données.

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.

Réponse

La configuration du webhook.

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.

webhook_url
string<uri> | null
requis

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.

webhook_version
enum<string>
requis

Version du payload de l'ancien webhook_url. Chaque destination possède sa propre webhook_version.

Options disponibles:
v1,
v2,
v3
secret_shared_key
string
requis

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.

capture_method
enum<string>
requis

Paramètre d'application obsolète. Le workflow de vérification ne le lit pas : les options de capture sont configurées par workflow.

Options disponibles:
MOBILE,
MOBILE_AND_DESKTOP
data_retention_months
integer | null
requis

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.

Plage requise: 1 <= x <= 120
face_retention_policy
enum<string>
requis

Ce 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.

Options disponibles:
delete_with_session,
retain_until_user_deleted
face_retention_days
integer | null
requis

Durée de conservation, en jours, des gabarits biométriques sous retain_until_user_deleted. Requis lorsque cette politique est définie.

Plage requise: 1 <= x <= 3650
available_events
object[]
requis

Chaque type d'événement auquel une destination peut s'abonner, avec un libellé d'affichage.

allowed_return_hosts
string[]
requis

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.

Maximum array length: 20
Maximum string length: 253
endpoints
object[]
requis

Chaque 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/.

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.

Options disponibles:
auto,
always,
never
allowed_domains
string[]

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.

Maximum array length: 50
Maximum string length: 300
Exemple:
Dernière modification le 7 novembre 2026