Перейти к основному содержанию
POST
cURL
Запускайте верификацию gov.br из своего бэкенда, используя API-ключ вашего приложения. Сценарий и workflow_id не нужны. Ответ на запуск описывает следующее действие аутентификации. Это не одобренный результат проверки личности.

Покрытие и активация

Активация кошелька отделена от развёртывания API и от права вашего приложения на использование. Документированный endpoint не активирует кошелёк, помеченный как «Скоро». Актуальные тарифы см. в разделе цены на цифровые ID-кошельки.

Что делает пользователь

Выполните следующее действие, которое вернул запрос на запуск. Способ аутентификации кошелька определяет, будет ли пользователь использовать браузер, другое устройство или приложение.

Получение результата

Следуйте руководству по API цифровых ID-кошельков, чтобы отслеживать верификацию и получать её результат. Считайте доказательством того, что кошелёк аутентифицировал пользователя, только завершённый и подтверждённый результат. Набор возвращаемых атрибутов личности зависит от кошелька. Не предполагайте, что адрес, портрет или все запрошенные атрибуты будут присутствовать.

Связанные материалы

Авторизации

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 idempotency_key_reused.

Тело

Запустить верификацию gov.br (BRA).

return_url
string<uri>
обязательно

URL https, на который браузер пользователя возвращается после кошелька, с добавленными параметрами request_id и result. Его хост должен быть зарегистрирован в allowed_return_hosts приложения (или являться его доменом White label). Никогда не полагайтесь только на result: получайте результат с помощью GET .../verifications/{request_id}/ или через webhook.

Required string length: 1 - 2048
vendor_data
string | null

Ваш собственный референс этой верификации (например, идентификатор пользователя). Возвращается в результатах и webhook.

metadata
object | null

Необязательный объект JSON, сохраняемый вместе с верификацией и возвращаемый в результатах и webhook.

sandbox_scenario
string

Только для приложений в песочнице: имитируемый результат - 'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error'; любой другой сценарий (или его отсутствие) проходит верификацию. Отклоняется для приложений в продакшн-среде. Полный каталог доступен по адресу GET /v1/sandbox/scenarios/.

Minimum string length: 1
country
enum<string>
по умолчанию:BRA

Код страны ISO 3166-1 alpha-3 для удостоверения gov.br. По умолчанию используется BRA, единственная обслуживаемая страна.

  • BRA - BRA
Доступные опции:
BRA
device
enum<string>
по умолчанию:same_device

same_device, если пользователь выполняет вход на устройстве, отображающем вашу страницу; cross_device, если он использует другое устройство (например, QR-код BankID).

  • same_device - same_device
  • cross_device - cross_device
Доступные опции:
same_device,
cross_device

Ответ

Одна отдельная верификация кошелька в том виде, в котором её возвращает каждый endpoint для кошельков.

request_id
string<uuid>
обязательно
wallet_verification
object
обязательно
vendor_data
string | null
обязательно
metadata
object | null
обязательно

Объект метаданных, переданный при запуске, или null.

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