Temporary Registration (Stay) Check
The method is used to verify the validity of a temporary registration (place of stay) for citizens of the Russian Federation.
The following request headers must be passed in every request:
| 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.
Check request
Method: POST
- Production:
https://api.baas.kvell.group/v1/smev3/gismu/reg-validstaying - Stage:
https://api.baas.stage.kvell.group/v1/smev3/gismu/reg-validstaying
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 (patronymic) |
birth_date |
string | Yes | Date of birth in YYYY-MM-DD format |
doc |
json | Yes | Document data: type, series, number, issue date |
∟typ |
string enum | Yes | Document type: passportrf — Russian citizen's internal passport, foreign — Russian citizen's international passport, birthcert — birth certificate, actrecord — birth registration record |
∟series |
string | Conditional | Document series (for all document types except actrecord) |
∟number |
string | Yes | Document number |
∟issue_date |
string | Yes | Passport issue date in YYYY-MM-DD format |
addr |
json | Yes | Address data |
∟region_oktmo |
string | No | Region code per OKTMO |
∟district |
string | No | District |
∟settlement |
string | No | Settlement |
∟street |
string | No | Street |
∟house |
string | No | House |
∟building |
string | No | Building/block |
∟flat |
string | No | Apartment |
∟guid |
string | Yes | Address GUID (FIAS) |
∟from_dt |
string | Yes | Registration start date in YYYY-MM-DD format |
∟to_dt |
string | No | Registration end date in YYYY-MM-DD format |
∟unstructured |
string | No | Unstructured address |
{
"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"
}
}
Building the signature
The X-Signature signature is built by concatenating X-Api-Key, json <request body>, and secret_key, then taking sha256 of the resulting string:
Request response
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-validstaying/{request_id} - Stage:
https://api.baas.stage.kvell.group/v1/smev3/gismu/reg-validstaying/{request_id}
URL request parameters
| Name | Data type | Required | Description |
|---|---|---|---|
request_id |
string | Yes | Request identifier |
Building the signature
The X-Signature signature is built by concatenating X-Api-Key, request_id, and secret_key, then taking sha256 of the resulting string:
Request response
{
"state": "finished",
"request_id": "befe8815-24b0-446b-925c-ea128f39667c",
"response_id": "df65dc1c-fc66-41cd-abbd-87218127fbeb",
"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— request statusin_progress— being processedfinished— completed
request_id— assigned request identifier for SMEV3 (optional)response_id— response identifier in the SMEV3 system, if a response was received from the department's information system (MVD)result— processing result (required ifstate=finishedanderror=null)reg_info— registration dataperson— individual's datadoc— document data: type, series, number, issue dateaddr_type— registration type:LIVING,STAYINGis_valid— registration status:true— registration is valid,false— invalid,null— registration information not found
error— error from the internal service, SMEV, or the department's information system (required ifstate=finishedandresult=null)code— error code (required)desc— error description (required)status_code— SMEV3 status HTTP code (optional)destname— request field containing the error from SMEV (optional)