Проверка использования телефонного номера конкретным физлицом.¶
verifyPhone¶
Тип HTTP запроса: POST
URL вызова: https://api.id-x.org/idx/api2/verifyPhone
Поддерживаются следующие форматы передачи параметров:
-
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 |
| personLastName | String | Да | Фамилия |
| personFirstName | String | Да | Имя |
| personMidName | String | Нет | Отчество (при наличии) |
| personBirthDate | String | Нет | Дата рождения в формате ДД.ММ.ГГГГ |
| phone | String | Да | Номер телефона |
Функция возвращает:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| resultCode | Int | Да | Результат выполнения функции (0 – успешное завершение функции, отличное от 0 значение – ошибка выполнения) |
| operationToken | String | Нет | Уникальный идентификатор операции |
| operationResult | String | Нет | Результат операции |
| validationScorePhone | Int | Нет | Оценка актуальности телефонного номера, возможные значения см. ниже |
Значения параметра актуальности телефонного номера:¶
| Оценка | Описание |
|---|---|
| 5 | Высокий уровень соответствия, подтверждение в период 180+ дней |
| 4 | Средний уровень соответствия, подтверждение в период 90-180 дней, отсутствие несоответствий за последние 60 дней |
| 3 | Низкий уровень соответствия, подтверждение в период 0-90 дней, наличие несоответствий за последние 60 дней |
| 2 | Средний риск несоответствия, подтверждение в период 0-90 дней, наличие несоответствий за последние 60 дней |
| 1 | Высокий риск несоответствия, отсутствие подтверждения в период 0+ дней и наличие несоответствий за последние 60 дней |
| 0 | Нет данных |
Пример вызова:
POST /idx/api2/verifyPhone
Host: api.id-x.org
Content-Type: application/json
Accept: application/json
{
"accessKey": "выданный accessKey",
"secretKey": "выданный secretKey",
"personLastName": "Иванов",
"personFirstName": "Иван",
"personMidName": "Иванович",
"personBirthDate": "1990-01-01",
"phone":"79161234567"
}
Пример успешного ответа:
{
"resultCode": 0,
"operationToken": "5c47cd0b6c0d4dsaa25bd394far37f21",
"validationScorePhone": 5,
"operationResult": "success"
}
Пример неуспешного ответа:
{
"resultCode": 0,
"operationToken": "a09062d0a75847b39f427b335c84da9b",
"validationScorePhone": 0,
"operationResult": "fail"
}