Создать заявителя
Описание
Метод создаёт заявителя в KYC Platform. Заявитель — это сущность, которая связывает данные пользователя, заявки на идентификацию, статусы и результаты проверок.
Создавайте заявителя до запуска идентификации, если хотите заранее передать известные данные пользователя или связать несколько заявок с одним внешним идентификатором.
Эндпоинт
POST https://api.mts.ru/rim/2.0/api/v2/applicants
Prodlike:
POST https://api.mts.ru/rim-api-prodlike/2.0/api/v2/applicants
Авторизация
Authorization: Bearer {access_token}
Content-Type: application/json
Тело запроса
{
"externalId": "client-user-12345",
"email": "user@example.com",
"phoneNumber": "79000000000",
"firstName": "Иван",
"middleName": "Иванович",
"surname": "Иванов",
"birthdate": "1983-10-10"
}
Параметры запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
externalId | string | Да | Внешний идентификатор заявителя в системе клиента. Должен быть уникальным в рамках клиента. |
email | string | Нет | Email заявителя. |
phoneNumber | string | Нет | Номер телефона заявителя. |
firstName | string | Нет | Имя. |
middleName | string | Нет | Отчество. |
surname | string | Нет | Фамилия. |
birthdate | string | Нет | Дата рождения. |
Ответ
202 Accepted
Заявитель принят в обработку или создан.
{
"externalId": "client-user-12345"
}
Ошибки
| Код | Когда возникает |
|---|---|
400 Bad Request | Некорректные параметры или формат тела запроса. |
401 Unauthorized | Не передан или недействителен access token. |
409 Conflict | Заявитель с таким внешним идентификатором уже существует или данные конфликтуют с текущим состоянием. |
Что дальше
- Чтобы запустить идентификацию по сценарию, используйте Workflow instances.
- Чтобы изменить данные заявителя, используйте Обновить заявителя.
- Чтобы обезличить данные, используйте Обезличить заявителя.