Começar
Integrar / SDKs
Verificação de utilizadores
Verificação de empresas
Monitorização de transações
Registo de alteraçõescurl -X GET 'https://verification.didit.me/v3/webhook/' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.webhooks.retrieve_config()
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.webhooks.retrieveConfig();
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Webhooks.RetrieveConfig(ctx)
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().retrieveConfig();
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->webhooks->retrieveConfig();
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.webhooks.retrieve_config
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.RetrieveConfigAsync();
Console.WriteLine(JsonSerializer.Serialize(result));{
"webhook_url": "https://yourapp.com/webhooks/didit",
"webhook_version": "v3",
"secret_shared_key": "dGhpcy1pcy10aGUtYXBwLWxldmVsLXNlY3JldC0wMDA",
"capture_method": "MOBILE",
"data_retention_months": 24,
"face_retention_policy": "delete_with_session",
"face_retention_days": null,
"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"
}
]
}Obter configuração de webhook (API)
Consulte na API da Didit as definições de webhook: URL e segredo, destinos, eventos, retenção de dados e domínios de retorno da carteira.
curl -X GET 'https://verification.didit.me/v3/webhook/' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.webhooks.retrieve_config()
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.webhooks.retrieveConfig();
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Webhooks.RetrieveConfig(ctx)
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().retrieveConfig();
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->webhooks->retrieveConfig();
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.webhooks.retrieve_config
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.RetrieveConfigAsync();
Console.WriteLine(JsonSerializer.Serialize(result));{
"webhook_url": "https://yourapp.com/webhooks/didit",
"webhook_version": "v3",
"secret_shared_key": "dGhpcy1pcy10aGUtYXBwLWxldmVsLXNlY3JldC0wMDA",
"capture_method": "MOBILE",
"data_retention_months": 24,
"face_retention_policy": "delete_with_session",
"face_retention_days": null,
"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"
}
]
}secret_shared_key. Os campos de nível superior webhook_url, webhook_version e secret_shared_key só são usados enquanto nenhum destino estiver ativado, e nesse caso apenas para status.updated e data.updated.
Autorizações
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.
Resposta
A configuração do webhook.
Configuração de webhooks ao nível da aplicação, política de conservação e anfitriões de retorno de carteira Digital ID, com todos os destinos de webhook.
URL de webhook ao nível da aplicação (legado). O Didit apenas envia para este URL enquanto a aplicação não tiver nenhum destino ativado, e apenas envia status.updated e data.updated. Cada criação, atualização ou eliminação de um destino define-o para o URL do destino ativado mais antigo, ou null quando nenhum estiver ativado.
Versão do payload do webhook_url legado. Cada destino tem o seu próprio webhook_version.
v1, v2, v3 Segredo de assinatura ao nível da aplicação (token de 43 carateres seguro para URL). Assina apenas entregas para o webhook_url legado; cada destino assina com a sua própria secret_shared_key. Chamadas autenticadas com chave de API recebem-no sempre na íntegra; utilizadores da Consola sem read:webhooks recebem uma cadeia de carateres vazia.
Definição legada da aplicação. O fluxo de verificação não a lê: as opções de captura são configuradas por fluxo.
MOBILE, MOBILE_AND_DESKTOP Janela de eliminação automática. As sessões de verificação de utilizadores criadas há mais meses do que este valor (um mês conta como 30 dias) são eliminadas automaticamente, e essa eliminação é irreversível. null significa que as sessões nunca são eliminadas automaticamente. Consulte Conservação de dados.
1 <= x <= 120O que acontece ao embedding facial de uma sessão quando a sessão é eliminada. delete_with_session (predefinição) elimina-o com a sessão. retain_until_user_deleted é a opção de adesão à conservação de templates biométricos: um template biométrico sem imagem associado ao Utilizador é gerido separadamente até que o seu período de conservação termine, o Utilizador seja eliminado ou o elimine definitivamente.
delete_with_session, retain_until_user_deleted Período de conservação, em dias, dos templates biométricos sob retain_until_user_deleted. Obrigatório quando essa política está definida.
1 <= x <= 3650Todos os tipos de eventos que um destino pode subscrever, com uma etiqueta de exibição.
Show child attributes
Show child attributes
Nomes de anfitrião (correspondência exata, apenas HTTPS) para os quais uma verificação autónoma de carteira de Identidade Digital pode reenviar o utilizador com o seu return_url. O seu domínio de marca branca também é sempre permitido. Consulte Registar o seu destino de retorno.
20253Todos os destinos de webhook da aplicação, do mais antigo para o mais recente, cada um com o respetivo segredo de assinatura. Apenas de leitura aqui: faça a gestão dos destinos com os endpoints /v3/webhook/destinations/.
Show child attributes
Show child attributes
Quando o fluxo alojado e os SDKs nativos solicitam à pessoa consentimento biométrico explícito antes de uma captura de rosto. auto (predefinição) solicita apenas quando se aplica um acionador: um estado declarado, o IP da pessoa ou o emissor do documento de identificação situa-se em Illinois, Texas ou Colorado, ou a pessoa aparenta estar nos EUA sem um estado conhecido. always solicita a todas as pessoas cujo fluxo capture um rosto. never nunca apresenta o passo, e recolhe o consentimento por sua conta antes da selfie. Cada alteração é registada no registo de auditoria. Consulte Consentimento biométrico.
auto, always, never Origens (por exemplo https://app.example.com; http apenas para localhost) nas quais o fluxo de verificação alojado pode ser incorporado e para as quais pode redirecionar o utilizador com um retorno de chamada da sessão. As chamadas servidor a servidor não são afetadas. Uma lista vazia significa nenhuma restrição. A Didit armazena cada origem em minúsculas sem uma porta predefinida. Uma entrada inválida falha com 400 em allowed_domains.
50300["https://app.example.com"]