Проверка документа и адреса регистрации

Метод используется для проверки соответствия документа и адреса регистрации.

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

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

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

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

Метод: POST

Production: https://api.baas.kvell.group/v1/smev3/gismu/reg-checkliving
Stage: https://api.baas.stage.kvell.group/v1/smev3/gismu/reg-checkliving

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

Название	Тип данных	Обязательно	Описание
`last_name`	string	Да	Фамилия
`first_name`	string	Да	Имя
`middle_name`	string	Нет	Отчество
`doc_type_id`	string enum	Нет	Код типа документа: `21` - паспорт гражданина РФ, `03` - свидетельство о рождении, `22` - заграничный гражданина РФ (старого или нового образца), `01` - Паспорт гражданина бывшего СССР
`doc_series`	string	Нет	Серия документа
`doc_number`	string	Да	Номер документа
`issue_date`	string	Да	Дата выдачи документа в формате `YYYY-MM-DD`
`birth_date`	string	Да	Дата рождения в формате `YYYY-MM-DD`
`addr_type`	string enum	Да	Тип адреса регистрационного учёта: `fact` - регистрация по месту пребывания (временная, например, арендованная квартира, гостиница, общежитие и т.д.), `reg` - регистрация по месту жительства (там, где гражданин проживает постоянно или преимущественно)
`addr_guid`	string	Да	GUID адреса (ФИАС)
`addr_full`	string	Да	Полный адрес
`from_dt`	string	Нет	С даты в формате `YYYY-MM-DD`
`to_dt`	string	Нет	До даты в формате `YYYY-MM-DD`

{
  "last_name": "Пишенина",
  "first_name": "Жанна",
  "middle_name": "Игнатьевна",
  "doc_type_id": "21",
  "doc_series": "5422",
  "doc_number": "434670",
  "issue_date": "2014-06-15",
  "birth_date": "1971-12-10",
  "addr_type": "fact",
  "addr_guid": "4e8bb0d8-6647-41af-9821-b52b20663fa7",
  "addr_full": "обл Курганская, р-н Каргапольский, рп Каргаполье, ул Кирова, двлд. 75 к. 75",
  "from_dt": "2022-03-31",
  "to_dt": "2024-12-12"
}

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

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

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

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

200: OK

{
  "request_id": "7663de3c-f5dc-4938-a379-b63834287b8a"
}

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

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

Метод: GET

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

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

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

GET /v1/smev3/gismu/reg-checkliving/7663de3c-f5dc-4938-a379-b63834287b8a

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

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

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

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

Пример 1Пример 2Пример 3Пример 4

{
  "state": "in_progress"
}

{
  "state": "finished",
  "result": {
    "status": "invalid"
  }
}

{
  "state": "finished",
  "result": {
    "status": "valid"
  }
}

{
  "state": "finished",
  "result": {
    "status": "error"
  }
}

state — статус запроса
- in_progress — в обработке
- finished — завершён
result — результат обработки (в случае state = finished)
- status — результат проверки
  - valid — данные соответствуют
  - invalid — данные не соответствуют
  - error — запрос не обработан (повторить запрос позднее)