Проверка регистрации по месту жительства

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

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

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

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

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

Метод: POST

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

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

Название	Тип данных	Обязательно	Описание
`last_name`	string	Да	Фамилия
`first_name`	string	Да	Имя
`middle_name`	string	Нет	Отчество
`birth_date`	string	Да	Дата рождения в формате `YYYY-MM-DD`
`doc`	json	Да	Данные документа: тип, серия, номер, дата выдачи
∟`typ`	string enum	Да	Тип документа: `passportrf` - Паспорт гражданина РФ, `foreign` - Загранпаспорт гражданина РФ, `birthcert` - Свидетельство о рождении
∟`series`	string	Да	Серия документа
∟`number`	string	Да	Номер документа
∟`issue_date`	string	Да	Дата выдачи паспорта в формате `YYYY-MM-DD`
`addr`	json	Да	Данные документа: тип, серия, номер, дата выдачи
∟`region_oktmo`	string	Нет	Кода региона по ОКТМО
∟`district`	string	Нет	Район
∟`settlement`	string	Нет	Населенный пункт
∟`street`	string	Нет	Улица
∟`house`	string	Нет	Дом
∟`building`	string	Нет	Корпус
∟`flat`	string	Нет	Квартира
∟`guid`	string	Нет	GUID адреса (ФИАС)
∟`from_dt`	string	Да	Дата начала срока регистрации в формате `YYYY-MM-DD`
∟`to_dt`	string	Нет	Дата окончания срока регистрации в формате `YYYY-MM-DD`
∟`unstructured`	string	Нет	Неструктурированный адрес

{
  "last_name": "Пишенина",
  "first_name": "Жанна",
  "middle_name": "Игнатьевна",
  "birth_date": "1971-12-10",
  "doc": {
    "typ": "passportrf",
    "series": "5181",
    "number": "846600",
    "issue_date": "2014-06-15"
  },
  "addr": {
    "region_oktmo": "string",
    "district": "string",
    "settlement": "string",
    "street": "string",
    "house": "string",  
    "building": "string",
    "flat": "string",
    "guid": "4e8bb0d8-6647-41af-9821-b52b20663fa7",
    "from_dt": "2022-03-31",
    "to_dt": "2024-12-12",
    "unstructured": "обл Курганская, р-н Каргапольский, рп Каргаполье, ул Кирова, двлд. 75 к. 75"
  }
}

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

Подпись 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-validliving/{request_id}
Stage: https://api.baas.stage.kvell.group/v1/smev3/gismu/reg-validliving/{request_id}

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

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

GET /v1/smev3/gismu/reg-validliving/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

{
  "state": "in_progress"
}

{
  "state": "finished",
  "result": {
    "reg_info": {
      "region_oktmo": "string",
      "district": "string",
      "settlement": "string",
      "street": "string",
      "house": "string",
      "building": "string",
      "flat": "string",
      "guid": "4e8bb0d8-6647-41af-9821-b52b20663fa7",
      "from_dt": "2022-03-31",
      "to_dt": "2024-12-12",
      "unstructured": "обл Курганская, р-н Каргапольский, рп Каргаполье, ул Кирова, двлд. 75 к. 75"
    },
    "person": {
      "last_name": "Пишенина",
      "first_name": "Жанна",
      "middle_name": "Игнатьевна",
      "birth_date": "1971-12-10"
    },
    "doc": {
      "typ": "passportrf",
      "series": "string",
      "number": "string",
      "issue_date": "string"
    },
    "addr_type": "LIVING",
    "is_valid": true
  }
}

state — статус запроса
- in_progress — в обработке
- finished — завершён
result — результат обработки (в случае state = finished)
- reg_info — данные регистрации
- person — данные физлица
- doc — данные документа: тип, серия, номер, дата выдачи
- addr_type — Тип регистрации: LIVING, STAYING
- is_valid — cтатус регистрации: true - регистрация дейсвительна, false - недействительная, null - информация о регистрации не найдена