Валидация персональных данных

verifyPerson

Данный вызов недоступен в личном кабинете

Для подключения обратитесь на support@iidx.ru

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

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

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

• JSON, Content-Type: application/json

Параметры:

Параметр	Тип	Обязательный	Описание
accessKey	String	Да	Ключ доступа, выданный при регистрации в Системе IDX
secretKey	String	Да	Секретный ключ, выданный при регистрации в Системе IDX
personLastName	String	Да	Фамилия
personFirstName	String	Да	Имя
personMidName	String	Нет	Отчество
personBirthDate	String	Нет	Дата рождения в формате ДД.ММ.ГГГГ
passportNumber	String	Нет	Номер паспорта, серия и номер слитно без разделителей
phone	String	Нет	Номер телефона
externalTransactionId	String	Нет	Уникальный ID операции в системе контрагента

В запросе должен обязательно присутствовать один из параметров: passportNumber или phone. Если оба параметра отстутствуют, то выдается ошибка. Если присутствует один из параметров (либо номер паспорта, либо номер телефона), то проверка происходит по паре ФИ-Номер паспорта или ФИ-Номер телефона. Если присутствуют оба параметра (и номер паспорта, и номер телефона), то проверка происходит по связке ФИ-Номер паспорта-Номер телефона.

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

Параметр	Тип	Обязательный	Описание
resultCode	Int	Да	Результат выполнения функции (0 – успешное завершение функции, отличное от 0 значение – ошибка выполнения)
resultMessage	String	Нет	Сообщение об ошибке
operationToken	String	Нет	Уникальный идентификатор операции
operationResult	String	Нет	Результат операции (success - совпадение найдено, fail - совпадений не найдено (например, несовпадения ФИ и паспорта, ошибки в данных и т.д.))

Пример вызова:

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

{
    "accessKey": "выданный accessKey",
    "secretKey": "выданный secretKey",
    "personLastName": "Иванов", 
    "personFirstName": "Иван", 
    "personMidName": "Иванович", 
    "personBirthDate": "1990-01-01", 
    "passportNumber":"1234567890", 
    "phone":"79991112233"
}

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

{
    "resultCode": 0,
    "operationResult": "success"
}

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

{
    "resultCode": 0,
    "operationResult": "fail"
}