Skip to content

Проверка соответсвия электронной почты и ФИО

verifyEmail

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

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

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

  • 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 Да Дата рождения в формате ДД.ММ.ГГГГ
email String Да Адрес электронной почты

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

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

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

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

{
    "accessKey": "выданный accessKey",
    "secretKey": "выданный secretKey",
    "lastName": "Иванов",
    "firstName": "Иван",
    "midName": "Иванович",
    "birthDate": "01.01.1970",
    "email":"ivanov@mail.ru"
}

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

{
        "resultCode": 0,
        "operationToken": "82e9d6ec643242e348bbefbe4d7b",
        "status":  "Связка ФИО-email подтверждена"
}

Пример успешного ответа, если данные не найдены:

{
        "resultCode": -100,
        "operationToken": "edeee3ec059b429089ba2d963ec4029a",
        "status":  "Связка ФИО-email не подтверждена"
}