Skip to main content

Identification status

Check/{id} method​

To find out the result of checking an individual's profile, use this method.

Add the ID received in response to the ID card details identification request to the request address. You will receive the verification status in the response.

Endpoint​

  • For testing GET https://kyc-stage.bank131.ru/api/v2.0/check/{id}
  • For live testing GET https://kyc.bank131.ru/api/v2.0/check/{id}

Request​

The request body is empty.

Request example​

  -X GET https://kyc.bank131.ru/api/v2.0/check/7 \
  -H 'content-type: application/json' \
  -H 'X-PARTNER-PROJECT: your_project_name' \

Response​

Response parameters​

NameMandatoryTypeDescription
status+stringIdentification status. Possible options: ok, pending, error
data-objectResponse details object
  id-numberCheck request ID
  description-stringRequest status description
error-objectError details object
  code+stringError code
  description+stringError description
Successful response example​
    {
      "status": "ok",
      "data":
        {
          "id": "7", // check request ID
          "description": "valid"
        }
    }
Response example: processing request​

Send another check/{id} request with the same data later.

    {
        "status": "pending",
        "data":
            {
                "id": "7",
                "description": "Check in progress"
               }
    }
Example of a response with an error. Data already verified​
    {
        "status": "error",
        "error": {
            "code": "already_exists",
            "description": "Request with the same data already exists"
        },
        "data": {
            "id": "7" // previous verification ID
           }
    }