Перейти к основному содержанию
POST
curl

Авторизации

x-api-key
string
header
обязательно

API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в Business Console. Основной ключ имеет полный доступ. Именованный ключ может иметь ограниченную область действия: без доступа, чтение или запись для каждого ресурса, ограничение определенными сценариями или одобренными сессиями, списком IP-адресов и сроком действия. 401 означает, что ключ неверен, отозван или его срок действия истек; 403 означает, что ключ не был передан, у ключа нет доступа к этому ресурсу или действию, либо запрос поступил с адреса вне его списка IP-адресов; 404 на маршруте сессии означает, что сессия не входит в сценарии или статусы ключа. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без прав на запись сессий получает ссылки на сессии и токены как null. См. https://docs.didit.me/console/api-keys.

Заголовки

Idempotency-Key
string

Необязательный ключ защиты от повторных попыток длиной до 255 символов. Повторное использование того же ключа с тем же телом запроса возвращает исходный ответ без запуска и тарификации второго скрининга. Повторное использование ключа с другим телом возвращает 409.

Maximum string length: 255

Тело

application/json
full_name
string
обязательно

Полное имя человека или наименование компании для скрининга. Минимум 2 символа - минимальный порог самого провайдера скрининга. Более короткое или пустое имя вернёт 400 по этому полю до запуска скрининга, поэтому списания средств не произойдёт.

Minimum string length: 2
Пример:

"Antonio Ejemplo Modelo"

entity_type
enum<string>
по умолчанию:person

Тип субъекта для скрининга. По умолчанию person.

Доступные опции:
person,
company
date_of_birth
string<date>

Дата рождения (физические лица) или дата регистрации (компании), YYYY-MM-DD. Повышает точность совпадения за счёт веса даты рождения.

Пример:

"1972-02-29"

nationality
string

Двухбуквенный код страны ISO 3166-1 alpha-2 (например, ES). Недопустимые коды возвращают 400. Повышает точность совпадения за счет веса страны.

Пример:

"ES"

document_number
string

Номер документа, удостоверяющего личность. Не имеет весового коэффициента и выступает в качестве «золотого ключа»: точное совпадение заменяет match_score совпадения на 100, а явное несовпадение снижает его. Отправляется провайдеру скрининга в качестве поискового фильтра, только если содержит 2-50 символов; значение вне этого диапазона принимается и сохраняется, а скрининг всё равно выполняется и тарифицируется, просто без фильтрации по номеру документа.

aml_score_approve_threshold
number
по умолчанию:80

Порог оценки риска, на уровне которого или ниже результат переходит в Approved. Должен быть ≤ aml_score_review_threshold (иначе 400).

Требуемый диапазон: 0 <= x <= 100
aml_score_review_threshold
number
по умолчанию:100

Порог оценки риска, выше которого результат переходит в Declined. Оценки между двумя порогами приводят к In Review.

Требуемый диапазон: 0 <= x <= 100
aml_name_weight
integer
по умолчанию:60

Вес схожести имени в оценке совпадения для каждого совпадения. Сумма трёх весов должна составлять ровно 100 (иначе 400).

Требуемый диапазон: 0 <= x <= 100
aml_dob_weight
integer
по умолчанию:25

Вес даты рождения в оценке совпадения для каждого совпадения.

Требуемый диапазон: 0 <= x <= 100
aml_country_weight
integer
по умолчанию:15

Вес страны/гражданства в оценке совпадения для каждого совпадения.

Требуемый диапазон: 0 <= x <= 100
aml_match_score_threshold
integer
по умолчанию:93

Порог отсечения для совпадений: совпадения с match_score ниже этого значения считаются False Positive (исключаются из оценки риска); со значением равным или выше считаются возможными совпадениями со статусом Unreviewed.

Требуемый диапазон: 0 <= x <= 100
include_adverse_media
boolean
по умолчанию:false

Также искать негативные публикации в СМИ. Добавляет до ~30 с задержки во время сбора результатов — используйте таймаут клиента ≥60 с.

include_ongoing_monitoring
boolean
по умолчанию:false

Продолжать повторный скрининг этого профиля и отправлять изменения через webhook. Требует save_api_request=true (иначе 400).

save_api_request
boolean
по умолчанию:true

Сохранять скрининг как сессию (отображение в консоли, endpoint решений, webhook, проверка срабатываний). Укажите false для проверки без сохранения состояния.

vendor_data
string

Ваш идентификатор пользователя, прошедшего скрининг; возвращается в ответе и сохраняется вместе с сессией.

metadata
object | null

JSON в свободной форме, сохраняемый с запросом и возвращаемый в ответе.

sandbox_scenario
string

Слаг сценария только для песочницы. Принимается, только если API-ключ принадлежит приложению в режиме песочницы; отклоняется для приложений в продакшн-среде. У отдельного скрининга нет сессии для инициализации, поэтому слаг указывается непосредственно в запросе на скрининг: decline_aml_hit возвращает одно совпадение формата продакшна и переводит скрининг в статус Declined, review_aml_possible_match переводит его в статус In Review, а сценарий, не задающий результат AML, оставляет скрининг чистым. См. каталог сценариев в GET /v1/sandbox/scenarios/ или Песочница и тестовые данные.

Пример:

"decline_aml_hit"

Ответ

Скрининг завершён. aml.status отражает ваши пороги; каждое совпадение на уровне или выше внутреннего порога включения перечислено в aml.hits вместе с оценкой совпадения личности match_score, оценкой риска сущности risk_score и объектом score_breakdown, поясняющим совпадение.

request_id
string<uuid>

Идентификатор сохраненной сессии при save_api_request=true (доступен для использования с GET /v3/session/{sessionId}/decision/); в противном случае это временный корреляционный UUID.

aml
object
vendor_data
string | null

Эхо отправленных вами vendor_data.

metadata
object | null

Эхо-значение переданного вами metadata.

created_at
string<date-time>
Последнее изменение 7 ноября 2026 г.