Mobilization Status Check

Provides information about an individual conscripted under partial mobilization, based on the individual's data.

This method is used to request information about an individual conscripted under partial mobilization, in order to resolve questions about providing them with support measures.

The following request headers must be passed in all requests:

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/fns/svedflmob
Stage: https://api.baas.stage.kvell.group/v1/smev3/fns/svedflmob

Request parameters (JSON)

Name	Data type	Required	Description
`id_request`	string (up to 36 characters)	No	End-to-end request identifier
`last_name`	string (up to 60 characters)	Yes	Last name
`first_name`	string (up to 60 characters)	Yes	First name
`middle_name`	string (up to 60 characters)	Yes, if present	Middle name (patronymic)
`birth_date`	string (`YYYY-MM-DD` format)	Yes	Date of birth
`inn`	string (format `[0-9]{1}[1-9]{1}\|[1-9]{1}[0-9]{1})[0-9]{10}`)	No	Individual's INN
`snils`	string (11 digits)	No	SNILS
`doc_type_id`	string enum	No	Identity document type code
`doc_num`	string (1-25 characters)	Yes, if `doc_type_id` is set	Document series and number
`issue_date`	string (`YYYY-MM-DD` format)	Yes, if `doc_type_id` is set	Document issue date
`issuer_name`	string (up to 255 characters)	No, if `doc_type_id` is set	Name of the authority that issued the document
`issuer_code`	string (7 characters)	No, if `doc_type_id` is set	Department code of the issuing authority

The valid values for doc_type_id and the corresponding doc_num format can be found here.

{
  "id_request": "4dd077c2-48b2-446a-95a5-eb91b0e0aa56",
  "last_name": "Иванов",
  "first_name": "Иван",
  "middle_name": "Иванович",
  "birth_date": "2000-01-01",
  "doc_type_id": "21",
  "doc_num": "1234 567890",
  "issue_date": "2018-09-10"
}

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})

Response

{
  "request_id": "1fa6b007-45d6-4926-9fbd-5c1651244f96"
}

request_id — the request identifier, used to retrieve the result.

Retrieving the check result

Method: GET

Production: https://api.baas.kvell.group/v1/smev3/fns/svedflmob/{request_id}
Stage: https://api.baas.stage.kvell.group/v1/smev3/fns/svedflmob/{request_id}

URL request parameters

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

GET /v1/smev3/fns/svedflmob/1fa6b007-45d6-4926-9fbd-5c1651244f96

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})

Response

Example 1Example 2Example 3Example 4Example 5 (HTTP 404)

{
  "state": "in_progress",
  "request_id": "befe8815-24b0-446b-925c-ea128f39667c",
  "response_id": null
}

{
  "state": "finished",
  "request_id": "befe8815-24b0-446b-925c-ea128f39667c",
  "response_id": "df65dc1c-fc66-41cd-abbd-87218127fbeb",
  "result":
  {
    "status": "not_found"
  }
}

{
  "state": "finished",
  "request_id": "befe8815-24b0-446b-925c-ea128f39667c",
  "response_id": "df65dc1c-fc66-41cd-abbd-87218127fbeb",
  "result":
  {
    "status": "found",
    "inn": "061537040128",
    "mob_start": "2022-09-21",
    "fns":
    [
      {"type": "npd_taxpayer", "start": "2022-09-01"}
    ],
    "id_request": "4dd077c2-48b2-446a-95a5-eb91b0e0aa56",
    "actual_at": "2022-10-21"
  }
}

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

{
  "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 department's information system (FNS)
error — an error from the internal service, SMEV, or the department'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)
result — processing result (required if state = finished and error = null)
- status — check result
  - not_found — the individual was not conscripted under partial mobilization
  - found — the individual was conscripted under partial mobilization
- inn — the individual's INN
- mob_start — conscription date (YYYY-MM-DD format)
- mob_end — conscription end date (YYYY-MM-DD format)
- actual_at — date the information is current as of
- id_request — end-to-end request identifier
- fns — data from the FNS (a list of fns_item, see below)

fns_item has the following format:

type — type, can take the following values:
- advocate — registered with the tax authority as an advocate
- notary — registered with the tax authority as a notary
- mediator — registered with the tax authority as a mediator
- bankruptcy_trustee — registered with the tax authority as an insolvency (bankruptcy) trustee
- appraiser — registered with the tax authority as an appraiser
- patent_attorney — registered with the tax authority as a patent attorney
- npd_taxpayer — registered with the tax authority as a payer of the professional income tax (NPD)
- ip — operates as a sole proprietor (IP)
- chief_founder — is the head or founder of a legal entity
start — registration date (YYYY-MM-DD format) (for all type values except ip and chief_founder)
end — deregistration date (YYYY-MM-DD format) (for all type values except ip and chief_founder)
ogrn — the sole proprietor's/legal entity's OGRN (only for type ip and chief_founder)
reg_date — the sole proprietor's/legal entity's registration date (only for type ip and chief_founder)
reg_end — date the sole proprietor/legal entity ceased operations (only for type ip and chief_founder)
msp_include_date — date the legal entity/sole proprietor was included in the SME register (only for type ip and chief_founder)
msp_exclude_date — date the legal entity/sole proprietor was excluded from the SME register (only for type ip and chief_founder)
name — full legal entity name (only for type chief_founder)
inn — legal entity's INN (only for type chief_founder)
participation_start — date the individual's participation in the legal entity started (only for type chief_founder)
participation_end — date the individual's participation in the legal entity ended (only for type chief_founder)
participation_status — participation status (takes one of the values in the range 1-4) (only for type chief_founder)