Document and Registration Address Check

This method is used to check whether a document and registration address match.

All requests must include the following request headers:

Name	Type	Required	Description
`X-Api-Key`	string	Yes	Unique shop identifier
`X-Signature`	string	Yes	Request signature

The signature is generated using secret_key — the secret key found in the merchant's shop settings.

Verification request

Method: POST

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

Request parameters (JSON)

Name	Data type	Required	Description
`last_name`	string	Yes	Last name
`first_name`	string	Yes	First name
`middle_name`	string	No	Middle name
`doc_type_id`	string enum	No	Document type code: `21` — Russian citizen's passport, `03` — birth certificate, `22` — Russian citizen's foreign travel passport (old or new format), `01` — passport of a citizen of the former USSR
`doc_series`	string	No	Document series
`doc_number`	string	Yes	Document number
`issue_date`	string	Yes	Document issue date in `YYYY-MM-DD` format
`birth_date`	string	Yes	Date of birth in `YYYY-MM-DD` format
`addr_type`	string enum	Yes	Registration address type: `fact` — registration at the place of stay (temporary, e.g. rented apartment, hotel, dormitory, etc.), `reg` — registration at the place of residence (where the citizen resides permanently or predominantly)
`addr_guid`	string	Yes	Address GUID (FIAS)
`addr_full`	string	Yes	Full address
`from_dt`	string	No	From date in `YYYY-MM-DD` format
`to_dt`	string	No	To date in `YYYY-MM-DD` format

{
  "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"
}

Building the signature

The X-Signature signature is generated by concatenating X-Api-Key, json <request body> and secret_key. sha256 is computed from the resulting string:

sha256({x-api-key}{json <request body>}{secret_key})

Request response

200: OK

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

request_id — request identifier, used to retrieve the result.

Retrieving the check result

Method: 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 parameters

Name	Data type	Required	Description
`request_id`	string	Yes	Request identifier

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

Building the signature

The X-Signature signature is generated by concatenating X-Api-Key, request_id and secret_key. sha256 is computed from the resulting string:

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

Request response

Example 1Example 2Example 3Example 4Example 5Example 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"
  }
}

{
  "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": "error"
  }
}

{
  "state": "finished",
  "request_id": "6ed9f77b-c150-4cdb-adcf-9d70d167f6ab",
  "response_id": null,
  "error": {
    "code": "internal",
    "desc": "Error connecting to SMEV"
  }
}

{
  "error": "request not found"
}

state — request status
- in_progress — in progress
- finished — completed
request_id — the request identifier assigned for SMEV3 (optional)
response_id — the response identifier in the SMEV3 system, if a response was received from the agency's information system (MVD)
result — processing result (required if state = finished and error = null)
- status — check result
  - valid — the data matches
  - invalid — the data does not match
  - error — the request was not processed (retry later)
error — error from the internal service, SMEV, or the agency's information system (required if state = finished and result = null)
- code — error code (required)
- desc — error description (required)
- status_code — HTTP status code from SMEV3 (optional)
- destname — request field containing the error from SMEV (optional)