Primers passos
Integració / SDK
Verificació d'usuaris
Verificació d'empreses
Monitoratge de transaccions
Registre de canviscurl -X PATCH 'https://verification.didit.me/v3/webhook/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.webhooks.update_config(
face_retention_policy="retain_until_user_deleted",
face_retention_days=365,
biometric_consent_mode="auto",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.webhooks.updateConfig({
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto",
});
console.log(result);import me.didit.Didit;
import me.didit.types.WebhooksUpdateConfigParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.webhooks().updateConfig(WebhooksUpdateConfigParams.builder()
.faceRetentionPolicy(WebhooksUpdateConfigParams.FaceRetentionPolicy.of("retain_until_user_deleted"))
.faceRetentionDays(365L)
.biometricConsentMode(WebhooksUpdateConfigParams.BiometricConsentMode.of("auto"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->webhooks->updateConfig([
'face_retention_policy' => 'retain_until_user_deleted',
'face_retention_days' => 365,
'biometric_consent_mode' => 'auto',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.webhooks.update_config(
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto"
)
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.UpdateConfigAsync(new WebhooksUpdateConfigParams
{
FaceRetentionPolicy = new WebhooksUpdateConfigParamsFaceRetentionPolicy("retain_until_user_deleted"),
FaceRetentionDays = 365,
BiometricConsentMode = new WebhooksUpdateConfigParamsBiometricConsentMode("auto"),
});
Console.WriteLine(JsonSerializer.Serialize(result));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://verification.didit.me/v3/webhook/"
payload := strings.NewReader("{\n \"face_retention_policy\": \"retain_until_user_deleted\",\n \"face_retention_days\": 365,\n \"biometric_consent_mode\": \"auto\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"webhook_url": "https://yourapp.com/webhooks/didit",
"webhook_version": "v3",
"secret_shared_key": "dGhpcy1pcy10aGUtYXBwLWxldmVsLXNlY3JldC0wMDA",
"capture_method": "MOBILE",
"data_retention_months": 24,
"face_retention_policy": "retain_until_user_deleted",
"face_retention_days": 365,
"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"
}
]
}Actualitzar la configuració del webhook: API
Canvia el webhook de l’aplicació a Didit, rota el secret, defineix la retenció de dades i plantilles biomètriques i registra hosts de retorn.
curl -X PATCH 'https://verification.didit.me/v3/webhook/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.webhooks.update_config(
face_retention_policy="retain_until_user_deleted",
face_retention_days=365,
biometric_consent_mode="auto",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.webhooks.updateConfig({
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto",
});
console.log(result);import me.didit.Didit;
import me.didit.types.WebhooksUpdateConfigParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.webhooks().updateConfig(WebhooksUpdateConfigParams.builder()
.faceRetentionPolicy(WebhooksUpdateConfigParams.FaceRetentionPolicy.of("retain_until_user_deleted"))
.faceRetentionDays(365L)
.biometricConsentMode(WebhooksUpdateConfigParams.BiometricConsentMode.of("auto"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->webhooks->updateConfig([
'face_retention_policy' => 'retain_until_user_deleted',
'face_retention_days' => 365,
'biometric_consent_mode' => 'auto',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.webhooks.update_config(
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto"
)
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.UpdateConfigAsync(new WebhooksUpdateConfigParams
{
FaceRetentionPolicy = new WebhooksUpdateConfigParamsFaceRetentionPolicy("retain_until_user_deleted"),
FaceRetentionDays = 365,
BiometricConsentMode = new WebhooksUpdateConfigParamsBiometricConsentMode("auto"),
});
Console.WriteLine(JsonSerializer.Serialize(result));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://verification.didit.me/v3/webhook/"
payload := strings.NewReader("{\n \"face_retention_policy\": \"retain_until_user_deleted\",\n \"face_retention_days\": 365,\n \"biometric_consent_mode\": \"auto\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"webhook_url": "https://yourapp.com/webhooks/didit",
"webhook_version": "v3",
"secret_shared_key": "dGhpcy1pcy10aGUtYXBwLWxldmVsLXNlY3JldC0wMDA",
"capture_method": "MOBILE",
"data_retention_months": 24,
"face_retention_policy": "retain_until_user_deleted",
"face_retention_days": 365,
"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"
}
]
}rotate_secret_key rota només el secret de nivell d’aplicació, que signa els lliuraments enviats a l’antic webhook_url. Cada destinació del webhook signa amb el seu propi secret_shared_key, que aquesta crida no canvia.allowed_return_hosts es descriu a Registra la teva destinació de retorn.
biometric_consent_mode (auto, always o never) estableix quan el flux de verificació demana consentiment biomètric explícit abans de la captura facial. Consulta Consentiment biomètric.
Per llegir primer els valors actuals, crida Obté la configuració del webhook.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.
Cos
Envia només els camps que vulguis canviar. Les destinacions no es gestionen aquí.
URL de webhook antiga a nivell d'aplicació. Didit només la utilitza mentre l'aplicació no tingui cap destinació activada, i aleshores només per a status.updated i data.updated. No crea cap destinació, i la propera creació, actualització o eliminació d'una destinació la substituirà. Per rebre webhooks, crea una destinació amb POST /v3/webhook/destinations/.
2000Versió del payload de la webhook_url heretada.
v1, v2, v3 true substitueix immediatament la secret_shared_key a nivell d'aplicació per un valor nou aleatori; el valor nou es troba a la resposta. Els secrets de les destinacions no es modifiquen. Cada crida amb true genera un secret nou, de manera que no és idempotent.
Configuració antiga de l'aplicació. El flux de verificació no la llegeix.
MOBILE, MOBILE_AND_DESKTOP Finestra d'eliminació automàtica en mesos (un mes compta com a 30 dies), o null per no aplicar eliminació automàtica. Un canvi també s'aplica a les sessions existents: cada sessió de verificació d'usuaris més antiga que la nova finestra s'elimina automàticament, i aquesta eliminació és irreversible.
1 <= x <= 120Què passa amb l'embedding facial d'una sessió quan se suprimeix la sessió. retain_until_user_deleted requereix face_retention_days a la mateixa sol·licitud o ja establert prèviament. Un canvi s'aplica a les supressions de sessions a partir d'aquell moment; no crea ni purga cap plantilla biomètrica existent.
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.
1 <= x <= 3650Quan 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 Substitueix tota la llista de noms d'amfitrió de retorn de carteres de Digital ID. Només noms d'amfitrió simples, com ara shop.example.com: sense esquema, port, ruta ni caràcters comodí. Els valors es converteixen a minúscules i s'eliminen els duplicats. Envia [] per buidar la llista.
20253Substitueix tota la llista d'orígens permesos. Orígens (per exemple https://app.example.com; http només per a localhost) en què 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 que no hi ha cap restricció. Didit emmagatzema cada origen en minúscules sense un port per defecte. Una entrada no vàlida falla amb 400 a allowed_domains. Envia [] per eliminar la restricció.
50300["https://app.example.com"]
Resposta
La configuració completa després de l'actualització, amb la mateixa estructura que GET /v3/webhook/. Si has rotat el secret, desa el nou secret_shared_key abans de descartar la resposta.
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"]