Primers passos
Integració / SDK
Verificació d'usuaris
Verificació d'empreses
Monitoratge de transaccions
Registre de canviscurl -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"
}
]
}Obtenir la configuració de webhooks de l'API
Consulta a Didit la configuració de webhooks de la teva aplicació: URL i secret heretats, destinacions, esdeveniments, retenció de dades i hosts de cartera.
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. Els camps de nivell superior webhook_url, webhook_version i secret_shared_key només s’utilitzen mentre cap destinació estigui habilitada, i en aquest cas només per a status.updated i data.updated.
Autoritzacions
La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.
Resposta
La configuració del webhook.
Configuració de webhook a nivell d'aplicació, política de conservació i amfitrions de retorn de la cartera de Digital ID, amb totes les destinacions de webhook.
URL de webhook a nivell d'aplicació (heretada). Didit només hi fa enviaments mentre l'aplicació no tingui cap destinació activada, i en aquest cas només envia status.updated i data.updated. Cada creació, actualització o eliminació d'una destinació l'estableix a la URL de la destinació activada més antiga, o a null si no n'hi ha cap d'activada.
Versió del payload de la webhook_url heretada. Cada destinació té la seva pròpia webhook_version.
v1, v2, v3 Secret de signatura a nivell d'aplicació (token de 43 caràcters segur per a URL). Només signa els lliuraments a la webhook_url heretada; cada destinació signa amb la seva pròpia secret_shared_key. Els clients que cridin amb clau d'API sempre el reben complet; els usuaris de la consola sense read:webhooks reben una cadena buida.
Configuració antiga de l'aplicació. El flux de verificació no la llegeix: les opcions de captura es configuren per flux de treball.
MOBILE, MOBILE_AND_DESKTOP Finestra d'eliminació automàtica. Les sessions de verificació d'usuaris creades fa més d'aquest nombre de mesos (un mes compta com a 30 dies) s'eliminen automàticament, i aquesta eliminació és irreversible. null significa que les sessions no s'eliminen mai automàticament. Consulta Conservació de dades.
1 <= x <= 120Què passa amb l'embedding facial d'una sessió quan se suprimeix la sessió. delete_with_session (per defecte) el suprimeix amb la sessió. retain_until_user_deleted és la conservació de la plantilla biomètrica opcional: una plantilla biomètrica sense imatges vinculada a l'usuari es gestiona per separat fins que finalitza el seu període de conservació, se suprimeix l'usuari o bé la purges.
delete_with_session, retain_until_user_deleted Període de conservació de dades, en dies, de les plantilles biomètriques sota retain_until_user_deleted. Obligatori quan s'estableix aquesta política.
1 <= x <= 3650Tots els tipus d'esdeveniments als quals es pot subscriure una destinació, amb una etiqueta que es mostra.
Show child attributes
Show child attributes
Noms d'amfitrió (coincidència exacta, només HTTPS) als quals una verificació independent de cartera de Digital ID pot retornar l'usuari amb el seu return_url. El teu domini de marca blanca també està permès sempre. Consulta Registra la teva destinació de retorn.
20253Totes les destinacions del webhook de l'aplicació, de la més antiga a la més recent, cadascuna amb el seu secret de signatura. Aquí només es poden consultar: gestiona les destinacions amb els endpoints /v3/webhook/destinations/.
Show child attributes
Show child attributes
Quan el flux allotjat i els SDK natius demanen a la persona el consentiment biomètric explícit abans d'una captura facial. auto (per defecte) només el demana quan s'aplica un activador: un estat declarat, la IP de la persona o l'emissor del document d'identitat es troba a Illinois, Texas o Colorado, o la persona sembla ser als EUA sense un estat conegut. always el demana a cada persona el flux de treball de la qual captura una cara. never no mostra mai el pas, i recopiles el consentiment pel teu compte abans de la selfie. Cada canvi es registra al registre d'auditoria. Consulta Consentiment biomètric.
auto, always, never Orígens (per exemple https://app.example.com; http només per a localhost) on es pot incrustar el flux de verificació allotjat i als quals es pot redirigir l'usuari amb un callback de sessió. Les crides de servidor a servidor no es veuen afectades. Una llista buida significa sense restriccions. Didit emmagatzema cada origen en minúscules sense cap port per defecte. Una entrada no vàlida falla amb 400 a allowed_domains.
50300["https://app.example.com"]