API para obter entrega de webhook

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}"
}

Para verificar o seu código de assinatura com uma entrega real, recalcule X-Signature-V2 a partir de request_body com o secret_shared_key do destino, tal como descrito em Verificação da assinatura. Para isto, use uma chave com acesso total: um corpo com valores ocultados deixa de corresponder às respetivas assinaturas. Para enviar a entrega novamente, chame Reenviar entrega do destino do webhook.

Autorizações

x-api-key

string

header

obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

destination_uuid

string<uuid>

obrigatório

UUID do destino para o qual a entrega foi enviada.

delivery_uuid

string<uuid>

obrigatório

UUID da entrega: o uuid de uma entrada retornada por GET /v3/webhook/destinations/{destination_uuid}/deliveries/.

Resposta

A entrega, com os respetivos cabeçalhos e corpo do pedido.

Uma tentativa de entrega para um destino do webhook, com os cabeçalhos e corpo do pedido exatos enviados pela Didit.

uuid

string<uuid>

obrigatório

ID de entrega, para as chamadas de detalhe e reenvio.

session_id

string<uuid> | null

obrigatório

Sessão de verificação de utilizadores a que o evento se refere. null para eventos de sessão de empresa, utilizador, empresa, transação, Travel Rule e fluxo.

request_url

string<uri> | null

obrigatório

URL para onde a entrega foi enviada: o URL do destino quando o evento foi gerado.

response_status

integer | null

obrigatório

Código de estado HTTP devolvido pelo seu endpoint. null enquanto a entrega está na fila e ainda não foi tentada. Quando não foi recebida nenhuma resposta HTTP, a Didit regista um código de estado próprio: 504 quando o seu endpoint não respondeu no prazo de 5 segundos, 503 para uma falha de ligação, 400 quando o URL foi recusado por não ser seguro (por exemplo, um endereço privado ou interno) e 404 para qualquer outro erro no pedido. Valores iguais ou superiores a 400 contam como uma entrega com falha.

response_time_ms

integer | null

obrigatório

Tempo que a tentativa demorou, em milissegundos. null enquanto a entrega estiver na fila.

Intervalo necessário: x >= 0

status

string | null

obrigatório

Estado comunicado pelo evento quando foi gerado: o estado da sessão para eventos de sessão (por exemplo, Approved ou In Review), o estado da pessoa ou da empresa para eventos de utilizador e de empresa, e o estado da transação para eventos de transação. null para eventos que não possuem estado.

webhook_type

enum<string>

obrigatório

Nome de evento de webhook suportado. Utilize estas strings exatas em subscribed_events; valores não suportados são rejeitados.

Opções disponíveis:

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>

obrigatório

Quando a entrega foi criada.

request_header

string

obrigatório

Texto JSON (uma string) dos cabeçalhos do pedido que a Didit enviou: Content-Type, X-Signature, X-Signature-V2, X-Signature-Simple, X-Timestamp e User-Agent. Efetue o parse com um analisador de JSON. Contém assinaturas, nunca o segredo de assinatura.

request_body

string

obrigatório

Texto JSON (uma string) do payload exato que a Didit enviou, com chaves ordenadas, incluindo event_id e timestamp. Efetue o parse com um analisador de JSON; consulte Formato do payload. Para uma chave com âmbito sem media: read, os URLs de multimédia no seu interior são null; sem sessions: write, os tokens de sessão e as ligações de verificação alojadas são null. Um corpo alterado dessa forma já não coincide com as suas assinaturas. A Didit não regista o corpo da resposta que o seu endpoint devolveu.

Última modificação em 7 de novembro de 2026