Obtenir une livraison de webhook (API)

curl

curl -X GET 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/deliveries/66666666-7777-8888-9999-000000000001/' \
  -H 'x-api-key: YOUR_API_KEY'

from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.webhooks.destinations.retrieve_delivery(
    "11111111-2222-3333-4444-555555555555",
    "66666666-7777-8888-9999-000000000001",
)
print(result)

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.webhooks.destinations.retrieveDelivery(
  "11111111-2222-3333-4444-555555555555",
  "66666666-7777-8888-9999-000000000001",
);
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Webhooks.Destinations.RetrieveDelivery(ctx, "11111111-2222-3333-4444-555555555555", "66666666-7777-8888-9999-000000000001")
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.webhooks().destinations().retrieveDelivery("11111111-2222-3333-4444-555555555555", "66666666-7777-8888-9999-000000000001");
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->webhooks->destinations->retrieveDelivery('11111111-2222-3333-4444-555555555555', '66666666-7777-8888-9999-000000000001');
print_r($result->toArray());

require "didit"

# Reads DIDIT_API_KEY.
didit = Didit::Client.new

result = didit.webhooks.destinations.retrieve_delivery(
  "11111111-2222-3333-4444-555555555555",
  "66666666-7777-8888-9999-000000000001"
)
puts result.to_h

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Webhooks.Destinations.RetrieveDeliveryAsync("11111111-2222-3333-4444-555555555555", "66666666-7777-8888-9999-000000000001");
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "uuid": "66666666-7777-8888-9999-000000000001",
  "session_id": "22222222-3333-4444-5555-666666666666",
  "request_url": "https://yourapp.com/webhooks/didit",
  "response_status": 503,
  "response_time_ms": 412,
  "status": "In Progress",
  "webhook_type": "status.updated",
  "created_at": "2026-10-15T09:21:18.412345Z",
  "request_header": "{\"Content-Type\": \"application/json\", \"X-Signature\": \"a5e02a03404e1337a0198e6be15d34abbd053c658a0e51e5d0e78554213ef29b\", \"X-Signature-V2\": \"927e7cb770c94ce745939bff73f04aa200015f3bc64795ba46c2aaf78a6cedc5\", \"X-Signature-Simple\": \"e37b0d4c716c72bb5ae7127b9cc455d28ab4686e9e22312b4ec2327409a73302\", \"X-Timestamp\": \"1792056078\", \"User-Agent\": \"DiditWebhook/2.0 +https://didit.me\"}",
  "request_body": "{\"application_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\"created_at\":1792056057,\"environment\":\"live\",\"event_id\":\"33333333-4444-5555-6666-777777777777\",\"sandbox_scenario\":null,\"session_id\":\"22222222-3333-4444-5555-666666666666\",\"status\":\"In Progress\",\"timestamp\":1792056078,\"vendor_data\":\"user-123\",\"webhook_type\":\"status.updated\",\"workflow_id\":\"44444444-5555-6666-7777-888888888888\",\"workflow_version\":3}"
}

GET

webhook

destinations

{destination_uuid}

deliveries

{delivery_uuid}

curl

curl -X GET 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/deliveries/66666666-7777-8888-9999-000000000001/' \
  -H 'x-api-key: YOUR_API_KEY'

from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.webhooks.destinations.retrieve_delivery(
    "11111111-2222-3333-4444-555555555555",
    "66666666-7777-8888-9999-000000000001",
)
print(result)

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.webhooks.destinations.retrieveDelivery(
  "11111111-2222-3333-4444-555555555555",
  "66666666-7777-8888-9999-000000000001",
);
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Webhooks.Destinations.RetrieveDelivery(ctx, "11111111-2222-3333-4444-555555555555", "66666666-7777-8888-9999-000000000001")
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.webhooks().destinations().retrieveDelivery("11111111-2222-3333-4444-555555555555", "66666666-7777-8888-9999-000000000001");
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->webhooks->destinations->retrieveDelivery('11111111-2222-3333-4444-555555555555', '66666666-7777-8888-9999-000000000001');
print_r($result->toArray());

require "didit"

# Reads DIDIT_API_KEY.
didit = Didit::Client.new

result = didit.webhooks.destinations.retrieve_delivery(
  "11111111-2222-3333-4444-555555555555",
  "66666666-7777-8888-9999-000000000001"
)
puts result.to_h

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Webhooks.Destinations.RetrieveDeliveryAsync("11111111-2222-3333-4444-555555555555", "66666666-7777-8888-9999-000000000001");
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "uuid": "66666666-7777-8888-9999-000000000001",
  "session_id": "22222222-3333-4444-5555-666666666666",
  "request_url": "https://yourapp.com/webhooks/didit",
  "response_status": 503,
  "response_time_ms": 412,
  "status": "In Progress",
  "webhook_type": "status.updated",
  "created_at": "2026-10-15T09:21:18.412345Z",
  "request_header": "{\"Content-Type\": \"application/json\", \"X-Signature\": \"a5e02a03404e1337a0198e6be15d34abbd053c658a0e51e5d0e78554213ef29b\", \"X-Signature-V2\": \"927e7cb770c94ce745939bff73f04aa200015f3bc64795ba46c2aaf78a6cedc5\", \"X-Signature-Simple\": \"e37b0d4c716c72bb5ae7127b9cc455d28ab4686e9e22312b4ec2327409a73302\", \"X-Timestamp\": \"1792056078\", \"User-Agent\": \"DiditWebhook/2.0 +https://didit.me\"}",
  "request_body": "{\"application_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\"created_at\":1792056057,\"environment\":\"live\",\"event_id\":\"33333333-4444-5555-6666-777777777777\",\"sandbox_scenario\":null,\"session_id\":\"22222222-3333-4444-5555-666666666666\",\"status\":\"In Progress\",\"timestamp\":1792056078,\"vendor_data\":\"user-123\",\"webhook_type\":\"status.updated\",\"workflow_id\":\"44444444-5555-6666-7777-888888888888\",\"workflow_version\":3}"
}

Pour vérifier votre code de signature avec une livraison réelle, recalculez X-Signature-V2 à partir de request_body avec le secret_shared_key de la destination, comme décrit dans Vérification de signature. Utilisez une clé avec accès complet pour cela : un corps dont les valeurs sont masquées ne correspond plus à ses signatures. Pour renvoyer la livraison, appelez Renvoyer une livraison de destination de webhook.

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

destination_uuid

string<uuid>

requis

UUID de la destination à laquelle la livraison a été envoyée.

delivery_uuid

string<uuid>

requis

UUID de la livraison : le uuid d'une entrée renvoyée par GET /v3/webhook/destinations/{destination_uuid}/deliveries/.

Réponse

La livraison, avec ses en-têtes et son corps de requête.

Une tentative de livraison vers une destination de webhook, avec exactement les en-têtes et le corps de requête envoyés par Didit.

uuid

string<uuid>

requis

ID de livraison, pour les appels de consultation détaillée et de renvoi.

session_id

string<uuid> | null

requis

Session de vérification d'utilisateur concernée par l'événement. null pour les événements de session d'entreprise, ainsi que pour les événements utilisateur, entreprise, de transaction, de Travel Rule et de workflow.

request_url

string<uri> | null

requis

URL à laquelle la livraison a été envoyée : l'URL de la destination au moment où l'événement a été généré.

response_status

integer | null

requis

Code d'état HTTP renvoyé par votre endpoint. null tant que la livraison est en file d'attente et n'a pas encore été tentée. Lorsqu'aucune réponse HTTP n'a été reçue, Didit enregistre son propre statut : 504 lorsque votre endpoint n'a pas répondu dans un délai de 5 secondes, 503 en cas d'échec de connexion, 400 lorsque l'URL a été rejetée car non sécurisée (par exemple une adresse privée ou interne), et 404 pour toute autre erreur de requête. Un code supérieur ou égal à 400 est considéré comme une livraison échouée.

response_time_ms

integer | null

requis

Durée de la tentative, en millisecondes. null tant que la livraison est dans la file d'attente.

Plage requise: x >= 0

status

string | null

requis

Statut signalé par l'événement lors de sa génération : le statut de la session pour les événements de session (par exemple Approved ou In Review), le statut de la personne ou de l'entreprise pour les événements utilisateur et entreprise, et le statut de la transaction pour les événements de transaction. null pour les événements ne comportant aucun statut.

webhook_type

enum<string>

requis

Nom d'événement webhook pris en charge. Utilisez ces chaînes exactes dans subscribed_events ; les valeurs non prises en charge sont rejetées.

Options disponibles:

status.updated,

data.updated,

user.status.updated,

user.data.updated,

business.status.updated,

business.data.updated,

activity.created,

transaction.created,

transaction.status.updated,

travel_rule.status.updated,

workflow.compliance_changed,

transaction_rule_suggestions.created,

auth.signup,

auth.login,

auth.login_failed,

auth.password_reset_requested,

auth.password_reset_completed,

auth.mfa_changed,

auth.new_device,

auth.account_locked,

investigator.report.ready,

investigator.decision.automated,

investigator.decision.overridden,

investigator.decision.contested,

investigator.question.raised,

investigator.automation.paused,

investigator.rfi.answered,

investigator.rfi.overdue,

investigator.drift.detected,

investigator.sla.breached,

investigator.qa.failed,

investigator.external.report.ready

created_at

string<date-time>

requis

Date et heure de création de la livraison.

request_header

string

requis

Texte JSON (une chaîne de caractères) des en-têtes de requête envoyés par Didit : Content-Type, X-Signature, X-Signature-V2, X-Signature-Simple, X-Timestamp et User-Agent. Analysez-le avec un parseur JSON. Il contient les signatures, jamais le secret de signature.

request_body

string

requis

Texte JSON (une chaîne de caractères) du payload exact envoyé par Didit, clés triées, comprenant event_id et timestamp. Analysez-le avec un parseur JSON ; voir Format du payload. Pour une clé restreinte sans media: read, les URL de médias qu'il contient sont null ; sans sessions: write, les tokens de session et les liens de vérification hébergés sont null. Un corps modifié de cette manière ne correspond plus à ses signatures. Didit n'enregistre pas le corps de réponse renvoyé par votre endpoint.

Dernière modification le 7 novembre 2026