Проверка соответствия СНИЛС и ФИО¶
checkSnils¶
Тип HTTP запроса: POST
URL вызова: https://api.id-x.org/idx/api2/checkSnils
Поддерживаются следующие форматы передачи параметров:
-
JSON, Content-Type: application/json
-
Form submit, Content-Type: application/x-www-form-urlencoded
Параметры:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| accessKey | String | Да | Ключ доступа, выданный при регистрации в Системе IDX |
| secretKey | String | Да | Секретный ключ, выданный при регистрации в Системе IDX |
| lastName | String | Да | Фамилия |
| firstName | String | Да | Имя |
| midName | String | Нет | Отчество (при наличии) |
| birthDate | String | Да | Дата рождения в формате DD.MM.YYYY |
| snils | String | Да | СНИЛС |
Функция возвращает:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| resultCode | Int | Да | Результат выполнения функции (0 – успешное завершение функции, отличное от 0 значение – ошибка выполнения) |
| resultMessage | String | Нет | Сообщение об ошибке |
| operationToken | String | Нет | Уникальный идентификатор операции |
| startMoment | String | Нет | Момент начала обработки запроса |
| stopMoment | String | Нет | Момент окончания обработки запроса |
| isValid | Boolean | Нет | True - данные соответствуют, False – не соответствуют |
Пример вызова:
POST /idx/api2/checkSnils
Host: api.id-x.org
Content-Type: application/json
Accept: application/json
{
"accessKey": "выданный accessKey",
"secretKey": "выданный secretKey",
"lastName": "Иванов",
"firstName": "Иван",
"midName": "Иванович",
"birthDate": "10.10.1970",
"snils": "12345678901"
}
Пример успешного ответа:
{
"resultCode": 0,
"operationToken": "71778eeb3b8c4b91b96f07ed17a1ccc9",
"startMoment": "11.05.2021 12:50:20 +0300",
"stopMoment": "11.05.2021 12:50:20 +0300",
"isValid": true
}
Пример неуспешного ответа:
{
"resultCode": 0,
"operationToken": "71778eeb3b8c4b91b96f07ed17a1ccc9",
"startMoment": "11.05.2021 12:50:20 +0300",
"stopMoment": "11.05.2021 12:50:20 +0300",
"isValid": false
}