Skip to content

Комплексная проверка паспорта

passportComplexCheck

Данный метод поддерживает режим асинхронного выполнения (параметр async). Подробнее, см. асинхронный режим выполнения запросов

Также, вы можете использовать тут callback вызов. Подробнее, см. особенности выполнения callback-вызова

Тип HTTP запроса: POST

URL вызова: https://api.id-x.org/idx/api2/passportComplexCheck

Поддерживаются следующие форматы передачи параметров:

  • 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 Да Дата рождения в формате ДД.ММ.ГГГГ
passportNumber String Да Номер паспорта, серия и номер слитно без разделителей
issueDate String Да Дата выдачи паспорта, в формате ДД.ММ.ГГГГ
async Boolean Нет Признак асинхронного запроса (true – запрос запускается в асинхронном режиме, false – стандартный синхронный запрос)
asyncCallback String Нет Адрес callback вызова по окончании асинхронного запроса

Параметр "Отчество" является обязательным при его наличии. В случае если параметр "Отчество" оставить пустым или указать "Нет" или "Отсутсвует", проверка будет производиться без отчества.

Функция возвращает:

Параметр Тип Обязательный Описание
resultCode Int Да Результат выполнения функции (0 – успешное завершение функции, отличное от 0 значение – ошибка выполнения)
resultMessage String Нет Сообщение об ошибке
operationToken String Нет Уникальный идентификатор операции
score Int Нет Числовой результат проверки. Варианты результатов см. расшифровка скоринга
issueDateVerified Boolean Нет Статус проверки даты выдачи паспорта (true – номер паспорта и дата выдачи были проверены и подтверждены, false – дата выдачи не была найдена, проверялся только номер паспорта)
description String Нет Текстовое описание результата

Пример синхронного вызова:

POST /idx/api2/passportComplexCheck
Host: api.id-x.org
Content-Type: application/json
Accept: application/json

{
    "accessKey": "выданный accessKey",
    "secretKey": "выданный secretKey",
    "lastName": "Иванов",
    "firstName": "Иван",
    "midName": "Иванович",
    "birthDate": "01.01.1970",
    "passportNumber": "1234567890",
    "issueDate": "01.01.2010"
}

Пример успешного ответа:

{
        "resultCode": 0,
        "resultMessage": "",
        "operationToken": "82e9d6ec643242e348bbefbe4d7b",
        "score": 100,
        "issueDateVerified": true,
        "description": "Верифицирована связка ФИО-дата рождения-номер паспорта, паспорт действителен"
}

Пример асинхронного вызова с передачей callback-url:

{
    "accessKey": "выданный accessKey",
    "secretKey": "выданный secretKey",
    "lastName": "Иванов",
    "firstName": "Иван",
    "midName": "Иванович",
    "birthDate": "01.01.1970",
    "passportNumber": "1234567890",
    "issueDate": "01.01.2010"
    "async": true,
    "asyncCallback": "URL callback receiver-а вашего API"
}

Пример ответа на асинхронный запрос: 

{
    "resultCode": 0,
    "operationToken": "82e9d47328947457353543565349",
    "resultMessage": " "
}

operationToken используется для вызова getAsyncResult (подробнее см. getAsyncResult) для получения результата.

Пример отправки callback на ваше API с авторизацией через token:

POST /api/callbackReceiver HTTP/1.1
Host: callback.host
Content-Type: application/json
Accept: application/json
Authorization: Token 10542d94fd96bae142bc99ff90d92e12b480176738884af91bd5615

{
    "resultCode": 0,
    "resultMessage": "",
    "operationToken": "82e9d47328947457353543565349",
    "score": 100,
    "issueDateVerified": true,
    "description": "Верифицирована связка ФИО-дата рождения-номер паспорта, паспорт действителен"
}

Расшифровка скоринга

Значение Описание
100 Верифицирована связка ФИО-дата рождения-номер паспорта, паспорт действителен
80 Связка [ФИО-Номер паспорта] подтверждена, номер паспорта верифицирован, паспорт действителен, в дате рождения возможны опечатки
50 Связка [Фамилия-Имя-Номер паспорта] подтверждена, номер паспорта верифицирован, паспорт действителен
10 Сведения о паспорте не были найдены
0 Паспорт недействителен