Начало работы
Интеграция / SDK
Проверка пользователей
Верификация бизнеса
Мониторинг транзакций
Журнал изменений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"
}
]
}Обновление конфигурации webhook в API
Обновите webhook приложения в Didit: смените секрет, задайте хранение данных и биометрических шаблонов, добавьте хосты возврата для Digital ID.
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 перевыпускает только секрет уровня приложения, которым подписываются доставки на устаревший webhook_url. Каждый адрес назначения webhook подписывает доставки собственным secret_shared_key, и этот вызов его не меняет.allowed_return_hosts описан в разделе Регистрация адреса возврата.
biometric_consent_mode (auto, always или never) определяет, когда сценарий верификации запрашивает явное биометрическое согласие перед захватом лица. См. Биометрическое согласие.
Чтобы сначала прочитать текущие значения, вызовите Получить конфигурацию webhook.Авторизации
API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в Business Console. Основной ключ имеет полный доступ. Именованный ключ может иметь ограниченную область действия: без доступа, чтение или запись для каждого ресурса, ограничение определенными сценариями или одобренными сессиями, списком IP-адресов и сроком действия. 401 означает, что ключ неверен, отозван или его срок действия истек; 403 означает, что ключ не был передан, у ключа нет доступа к этому ресурсу или действию, либо запрос поступил с адреса вне его списка IP-адресов; 404 на маршруте сессии означает, что сессия не входит в сценарии или статусы ключа. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без прав на запись сессий получает ссылки на сессии и токены как null. См. https://docs.didit.me/console/api-keys.
Тело
Отправляйте только те поля, которые нужно изменить. Адреса назначения здесь не настраиваются.
Устаревший URL webhook на уровне приложения. Didit использует его только тогда, когда у приложения нет включённого адреса назначения, и только для status.updated и data.updated. Он не создаёт адрес назначения, и следующее создание, обновление или удаление адреса назначения заменяет его. Чтобы получать webhook, создайте адрес назначения с помощью POST /v3/webhook/destinations/ вместо этого.
2000Версия payload устаревшего webhook_url.
v1, v2, v3 true немедленно заменяет secret_shared_key на уровне приложения новым случайным значением; новое значение возвращается в ответе. Секреты адресов назначения не изменяются. Каждый вызов с true генерирует новый секрет, поэтому операция не является идемпотентной.
Устаревшая настройка приложения. Сценарий верификации её не считывает.
MOBILE, MOBILE_AND_DESKTOP Окно автоматического удаления в месяцах (месяц считается как 30 дней) или null для отключения автоматического удаления. Изменение применяется и к существующим сессиям: каждая сессия проверки пользователей старше нового окна удаляется автоматически, и это удаление необратимо.
1 <= x <= 120Что происходит с эмбеддингом лица сессии при удалении сессии. Для retain_until_user_deleted требуется параметр face_retention_days в том же запросе или уже установленный ранее. Изменение применяется ко всем последующим удалениям сессий; оно не создаёт и не удаляет существующие биометрические шаблоны.
delete_with_session, retain_until_user_deleted Срок хранения биометрических шаблонов в днях согласно политике retain_until_user_deleted.
1 <= x <= 3650Когда размещённый сценарий и нативные SDK запрашивают у человека явное биометрическое согласие перед захватом лица. Значение auto (по умолчанию) запрашивает согласие только при срабатывании триггера: указанный штат, IP-адрес пользователя или эмитент документа, удостоверяющего личность, относятся к Иллинойсу, Техасу или Колорадо, либо пользователь предположительно находится в США без определённого штата. Значение always запрашивает согласие у каждого человека, чей сценарий включает захват лица. Значение never никогда не показывает этот шаг, и вы собираете согласие самостоятельно перед селфи. Каждое изменение фиксируется в журнале аудита. См. Biometric consent.
auto, always, never Заменяет весь список хостов возврата кошелька Digital ID. Только «чистые» имена хостов, например shop.example.com: без схемы, порта, пути или масок (wildcard). Значения приводятся к нижнему регистру, а дубликаты удаляются. Отправьте [], чтобы очистить список.
20253Заменяет весь список разрешённых источников. Источники (например, https://app.example.com; http только для localhost), в которые может быть встроен размещённый сценарий верификации и на которые он может вернуть пользователя через callback сессии. Межсерверные вызовы не затрагиваются. Пустой список означает отсутствие ограничений. Didit сохраняет каждый источник в нижнем регистре без порта по умолчанию. Некорректная запись завершается ошибкой 400 для allowed_domains. Отправьте [], чтобы снять ограничение.
50300["https://app.example.com"]
Ответ
Полная конфигурация после обновления в том же формате, что и в GET /v3/webhook/. Если вы выполнили ротацию секрета, сохраните новый secret_shared_key, прежде чем отбросить ответ.
Конфигурация webhook уровня приложения, политика хранения данных и хосты возврата кошелька Digital ID вместе со всеми адресами назначения webhook.
URL webhook уровня приложения (устаревший). Didit отправляет на него запросы только до тех пор, пока у приложения нет включённого адреса назначения webhook, и только события status.updated и data.updated. Любое создание, обновление или удаление адреса назначения webhook устанавливает его в URL самого старого включённого адреса назначения webhook или в null, если ни один не включён.
Версия payload устаревшего webhook_url. У каждого адреса назначения своя webhook_version.
v1, v2, v3 Секрет подписи уровня приложения (43-символьный URL-безопасный токен). Он подписывает только доставку на устаревший webhook_url; каждый адрес назначения подписывает со своим secret_shared_key. При вызове с API-ключом он всегда возвращается полностью; пользователи консоли без разрешения read:webhooks получают пустую строку.
Устаревшая настройка приложения. Сценарий верификации её не считывает: параметры захвата настраиваются для каждого сценария отдельно.
MOBILE, MOBILE_AND_DESKTOP Окно автоматического удаления. Сессии проверки пользователей, созданные более указанного количества месяцев назад (месяц считается как 30 дней), удаляются автоматически, и это удаление необратимо. null означает, что сессии никогда не удаляются автоматически. См. раздел Хранение данных.
1 <= x <= 120Что происходит с эмбеддингом лица сессии при удалении сессии. delete_with_session (по умолчанию) удаляет его вместе с сессией. retain_until_user_deleted представляет собой подключаемое хранение биометрических шаблонов: биометрический шаблон без изображения, привязанный к пользователю, администрируется отдельно до окончания срока его хранения, удаления пользователя или принудительной очистки вами.
delete_with_session, retain_until_user_deleted Срок хранения биометрических шаблонов в днях согласно политике retain_until_user_deleted. Обязателен, если задана эта политика.
1 <= x <= 3650Каждый тип события, на который может подписаться адрес назначения, с отображаемой меткой.
Show child attributes
Show child attributes
Имена хостов (точное совпадение, только HTTPS), на которые автономная верификация кошелька Digital ID может вернуть пользователя через return_url. Ваш White label домен также всегда разрешён. См. Зарегистрируйте адрес назначения для возврата.
20253Каждый адрес назначения webhook приложения, начиная с самых старых, каждый со своим секретом подписи. Здесь доступен только просмотр: управляйте адресами назначения с помощью endpoint /v3/webhook/destinations/.
Show child attributes
Show child attributes
Когда размещённый сценарий и нативные SDK запрашивают у человека явное биометрическое согласие перед захватом лица. Значение auto (по умолчанию) запрашивает согласие только при срабатывании триггера: указанный штат, IP-адрес пользователя или эмитент документа, удостоверяющего личность, относятся к Иллинойсу, Техасу или Колорадо, либо пользователь предположительно находится в США без определённого штата. Значение always запрашивает согласие у каждого человека, чей сценарий включает захват лица. Значение never никогда не показывает этот шаг, и вы собираете согласие самостоятельно перед селфи. Каждое изменение фиксируется в журнале аудита. См. Biometric consent.
auto, always, never Источники (origins, например https://app.example.com; http разрешен только для localhost), в которые может быть встроен размещенный сценарий верификации и куда пользователь может быть перенаправлен с помощью обратного вызова сессии. На вызовы между серверами ограничение не распространяется. Пустой список означает отсутствие ограничений. Didit сохраняет каждый origin в нижнем регистре без порта по умолчанию. Недопустимая запись приводит к ошибке 400 в allowed_domains.
50300["https://app.example.com"]