Подтверждение связки ФИО-телефон¶
verifyPhoneNew¶
Тип HTTP запроса: POST
URL вызова: https://api.id-x.org/idx/api2/verifyPhoneNew
Поддерживаются следующие форматы передачи параметров:
-
JSON, Content-Type: application/json
-
XML, Content-Type: application/xml
-
Form submit, Content-Type: application/x-www-form-urlencoded
Параметры:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| accessKey | String | Да | Ключ доступа, выданный при регистрации в Системе IDX |
| secretKey | String | Да | Секретный ключ, выданный при регистрации в Системе IDX |
| lastName | String | Да | Фамилия |
| firstName | String | Да | Имя |
| midName | String | Нет | Отчество (при наличии) |
| phone | String | Да | Номер телефона |
| birthDate | String | Нет | Дата рождения в формате ДД.ММ.ГГГГ |
| passportNumber | String | Нет | Номер паспорта, серия и номер слитно без разделителей |
Дата рождения и номер паспорта не являются обязательными параметрами, но добавление каждого запускает проверку в дополнительных источниках, что может повысить результативность запросов.
Функция возвращает:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| resultCode | Int | Да | Результат выполнения функции (0 – успешное завершение функции, отличное от 0 значение – ошибка выполнения) |
| resultMessage | String | Нет | Сообщение об ошибке |
| operationToken | String | Нет | Уникальный идентификатор операции |
| operationResult | String | Нет | Результат операции |
| operationMessage | String | Нет | Сообщение операции |
Пример вызова:
POST /idx/api2/verifyPhoneNew
Host: api.id-x.org
Content-Type: application/json
Accept: application/json
{
"accessKey": "выданный accessKey",
"secretKey": "выданный secretKey",
"lastName": "Иванов",
"firstName": "Иван",
"midName": "Иванович",
"phone": "9991112233",
"passportNumber": "1234567890",
"birthDate": "27.03.1970"
}
Пример успешного ответа:
{
"resultCode": 0,
"operationToken": "a09062d0a75847b39f427b335c84da9b",
"operationResult": "success",
"operationMessage": "Связка ФИО+телефон подтверждена."
}
Пример неуспешного ответа:
{
"resultCode": 0,
"operationToken": "a09062d0a75847b39f427b335c84da9b",
"operationResult": "fail",
"operationMessage": "Связка ФИО+телефон не подтверждена."
}