KYC API

KYC API используется для управления процессами KYC Platform: создания заявителей, запуска идентификации по workflow, получения статусов и результатов, работы с заявками и дополнительных сервисных операций.

API относится к платформенному продукту KYC Platform. Он нужен, когда клиент встраивает удалённую идентификацию в свои системы и управляет процессом программно.

Когда использовать

нужно создать или обновить заявителя до запуска идентификации;
нужно запустить идентификацию по заранее настроенному workflow;
нужно получить статус, результат или список заявок;
нужно принять событие завершения через callback или PostMessage;
нужно выполнить сервисные операции: обезличивание, сравнение лиц, подсказки адреса.

Типовой сценарий интеграции

Получить access_token.
Создать заявителя методом POST /applicants, если данные пользователя нужно передать заранее.
Запустить идентификацию методом POST /identifications/workflow-instances.
Передать пользователю ссылку из ответа или встроить модуль в web/mobile‑сценарий.
Получить событие завершения через callback/PostMessage или запросить результат методом получения заявки.
При необходимости выполнить обезличивание данных заявителя.

Base URL

Продуктовая среда:

https://api.mts.ru/rim/2.0/api/v2

Тестовая среда:

https://api.mts.ru/rim-api-prodlike/2.0/api/v2

Общие правила по окружениям см. в разделе Base URLs.

Авторизация

Для вызова методов используется bearer token:

Authorization: Bearer {access_token}

Токен получается через POST https://api.mts.ru/token по client_credentials. Подробности см. в разделе Авторизация.

Методы

Applicants

Метод	Endpoint	Назначение
`POST`	`/applicants`	Создать заявителя.
`PUT`	`/applicants/{externalId}`	Обновить данные заявителя.
`POST`	`/applicants/{externalId}/depersonalize`	Обезличить данные заявителя.

Identifications

Для новых интеграций основной способ запуска заявки — POST /identifications/workflow-instances. Workflow настраивается на стороне платформы, а клиент передаёт в API идентификатор сценария и параметры запуска.

Метод	Endpoint	Назначение
`POST`	`/identifications/workflow-instances`	Создать заявку по workflow. Рекомендуемый способ запуска для новых интеграций.
`GET`	`/applicants/{externalId}/identifications/{requestGuid}`	Получить статус и результат заявки.
`GET`	`/applicants/{externalId}/identifications`	Получить список заявок заявителя.

Дополнительные методы

Метод	Endpoint	Назначение
`POST`	`/faces/match-by-files`	Сравнить два изображения лица.
`POST`	`/address/suggest`	Получить подсказки адреса.

События

Механизм	Когда использовать
Callback	Серверное уведомление о завершении сценария.
PostMessage	Событие из iframe/WebSDK для фронтенда.