Проверка паспорта

Во всех запросах необходимо передавать заголовки запроса:

Название	Тип	Обязательно	Описание
`X-Api-Key`	string	Да	Уникальный идентификатор магазина
`X-Signature`	string	Да	Подпись запроса

При формировании подписи используется secret_key - секретный ключ, который находится в настройках магазина мерчанта.

Проверка действительности паспорта

Метод используется для отправки на проверку в МВД действительности паспорта РФ по его данным.

Запрос на проверку

Метод: POST

Production: https://api.baas.kvell.group/v1/smev3/gismu/rfp-actual
Stage: https://api.baas.stage.kvell.group/v1/smev3/gismu/rfp-actual

Параметры запроса (JSON)

Название	Тип данных	Обязательно	Описание
`seriya`	string (4 цифры)	Да	Серия паспорта
`number`	string (6 цифр)	Да	Номер паспорта
`issue_date`	string (формат `YYYY-MM-DD`)	Да	Дата выдачи

{
  "seriya": "7801",
  "number": "601601",
  "issue_date": "2010-10-10"
}

Формирование подписи

Подпись X-Signature формируется конкатенацией X-Api-Key, json <тело запроса> и secret_key. Формируется sha256 от полученной строки:

sha256({x-api-key}{json <тело запроса>}{secret_key})

Ответ запроса

200: OK

{
  "request_id": "b934283c-7afb-46b5-afb7-51f9aaff4ada"
}

request_id — идентификатор запроса, используется для получения результата.

Получение результата проверки

Метод: GET

Production: https://api.baas.kvell.group/v1/smev3/gismu/rfp-actual/{request_id}
Stage: https://api.baas.stage.kvell.group/v1/smev3/gismu/rfp-actual/{request_id}

Параметры запроса в URL

Название	Тип данных	Обязательно	Описание
`request_id`	string	Да	Идентификатор запроса

GET /v1/smev3/gismu/rfp-actual/b934283c-7afb-46b5-afb7-51f9aaff4ada

Формирование подписи

Подпись X-Signature формируется конкатенацией X-Api-Key, request_id и secret_key. Формируется sha256 от полученной строки:

sha256({x-api-key}{request_id}{secret_key})

Ответ запроса

Пример 1Пример 2Пример 3Пример 4Пример 5Пример 6 (HTTP 404)

{
  "state": "in_progress"
  "request_id": "6ed9f77b-c150-4cdb-adcf-9d70d167f6ab",
  "response_id": null
}

{
  "state": "finished",
  "request_id": "6ed9f77b-c150-4cdb-adcf-9d70d167f6ab",
  "response_id": "ac91f7a8-c1ab-4e28-90a2-4abb4786f95cs",
  "result": {
    "status": "invalid",
    "reason": "Истёк срок действия",
    "date": "2001-01-01"
  }
}

{
  "state": "finished",
  "request_id": "6ed9f77b-c150-4cdb-adcf-9d70d167f6ab",
  "response_id": "ac91f7a8-c1ab-4e28-90a2-4abb4786f95cs",
  "result": {
    "status": "valid"
  }
}

{
  "state": "finished",
  "request_id": "6ed9f77b-c150-4cdb-adcf-9d70d167f6ab",
  "response_id": "ac91f7a8-c1ab-4e28-90a2-4abb4786f95cs",
  "result": {
    "status": "not_found"
  }
}

{
  "state": "finished",
  "request_id": "6ed9f77b-c150-4cdb-adcf-9d70d167f6ab",
  "response_id": null,
  "error": {
    "code": "internal",
    "desc": "Ошибка соединения со СМЭВ"
  }
}

{
  "error": "request not found"
}

state — статус запроса
- in_progress — в обработке
- finished — завершён
request_id — назначенный идентификатор запроса для СМЭВ3 (опционально)
response_id — идентификатор ответа в системе СМЭВ3, если был получен ответ от ИС ведомства (МВД)
result — результат обработки (обязательно, если state = finished и error = null)
- status — результат проверки
  - valid — паспорт действителен
  - not_found — паспорт не найден
  - invalid — паспорт не действителен
- reason — причина недействительности паспорта (в случае status = invalid)
- date — дата регистрации недействительности паспорта (в случае status = invalid)
error — ошибка от внутреннего сервиса, СМЭВ или МВД (обязательно, если state = finished и result = null)
- code — код ошибки (обязательно)
- desc — описание ошибки (обязательно)
- status_code — статусный HTTP-код от СМЭВ3 (опционально)
- destname — поле запроса, содержащее ошибку от СМЭВ (опционально)

Расширенная проверка действительности паспорта

Метод используется для отправки на проверку в МВД действительности паспорта РФ по его расширенным данным.

Запрос на проверку

Метод: POST

Production: https://api.baas.kvell.group/v1/smev3/gismu/rfp-actual-full
Stage: https://api.baas.stage.kvell.group/v1/smev3/gismu/rfp-actual-full

Параметры запроса (JSON)

Название	Тип	Обязательно	Описание
`seriya`	string (4 цифры)	Да	Серия паспорта
`number`	string (6 цифр)	Да	Номер паспорта
`issue_date`	string (формат YYYY-MM-DD)	Нет	Дата выдачи
`issuer_code`	string (формат \d{3}-\d{3} или \d{6})	Нет	Код подразделения
`last_name`	string (не более 64 символов)	Да	Фамилия
`first_name`	string (не более 64 символов)	Да	Имя
`middle_name`	string (не более 64 символов)	Да, при наличии	Отчество
`birth_date`	string (формат YYYY-MM-DD)	Да	Дата рождения

{
  "seriya": "4998",
  "number": "476351",
  "last_name": "Иванов",
  "first_name": "Иван",
  "middle_name": "Иванович",
  "birth_date": "1993-03-05",
  "issue_date": "2010-10-10",
  "issuer_code": "450-021"
}

Формирование подписи

Подпись X-Signature формируется конкатенацией X-Api-Key, json <тело запроса> и secret_key. Формируется sha256 от полученной строки:

sha256({x-api-key}{json <тело запроса>}{secret_key})

Ответ запроса

200: OK

{
  "request_id": "9fb12efc-a3d8-4660-87b1-5bcb00f952ef"
}

request_id — идентификатор запроса, используется для получения результата.

Получение результата проверки

Метод: GET

Production: https://api.baas.kvell.group/v1/smev3/gismu/rfp-actual-full/{request_id}
Stage: https://api.baas.stage.kvell.group/v1/smev3/gismu/rfp-actual-full/{request_id}

Параметры запроса в URL

Название	Тип данных	Обязательно	Описание
`request_id`	string	Да	Идентификатор запроса

GET /v1/smev3/gismu/rfp-actual-full/9fb12efc-a3d8-4660-87b1-5bcb00f952ef

Формирование подписи

Подпись X-Signature формируется конкатенацией X-Api-Key, request_id и secret_key. Формируется sha256 от полученной строки:

sha256({x-api-key}{request_id}{secret_key})

Ответ запроса

Пример 1Пример 2Пример 3Пример 4Пример 5Пример 6 (HTTP 404)

{
  "state": "in_progress",
  "request_id": "6ed9f77b-c150-4cdb-adcf-9d70d167f6ab",
  "response_id": null
}

{
  "state": "finished",
  "request_id": "6ed9f77b-c150-4cdb-adcf-9d70d167f6ab",
  "response_id": "ac91f7a8-c1ab-4e28-90a2-4abb4786f95cs",
  "result": {
    "status": "invalid",
    "reason": "Истёк срок действия",
    "date": "2001-01-01"
  }
}

{
  "state": "finished",
  "request_id": "6ed9f77b-c150-4cdb-adcf-9d70d167f6ab",
  "response_id": "ac91f7a8-c1ab-4e28-90a2-4abb4786f95cs",
  "result": {
    "status": "valid"
  }
}

{
  "state": "finished",
  "request_id": "6ed9f77b-c150-4cdb-adcf-9d70d167f6ab",
  "response_id": "ac91f7a8-c1ab-4e28-90a2-4abb4786f95cs",
  "result": {
    "status": "not_found"
  }
}

{
  "state": "finished",
  "request_id": "6ed9f77b-c150-4cdb-adcf-9d70d167f6ab",
  "response_id": "ac91f7a8-c1ab-4e28-90a2-4abb4786f95cs",
  "error": {
    "code": "ACCESS_DENIED",
    "desc": "Access denied"
  }
}

{
  "error": "request not found"
}

state — статус запроса:
- in_progress — в обработке
- finished — завершён
request_id — назначенный идентификатор запроса для СМЭВ3 (опционально)
response_id — идентификатор ответа в системе СМЭВ3, если был получен ответ от ИС ведомства (МВД)
result — результат обработки (обязательно, если state = finished и error = null)
- status — результат проверки
  - valid — паспорт действителен
  - not_found — паспорт не найден
  - invalid — паспорт не действителен
- reason — причина недействительности паспорта (в случае status = invalid)
- date — дата регистрации недействительности паспорта (в случае status = invalid)
error — ошибка от внутреннего сервиса, СМЭВ или МВД (обязательно, если state = finished и result = null)
- code — код ошибки (обязательно)
- desc — описание ошибки (обязательно)
- status_code — статусный HTTP-код от СМЭВ3 (опционально)
- destname — поле запроса, содержащее ошибку от СМЭВ (опционально)