Verification status

Check/{id} method

This request checks the status of the check request and get the response to verification of an individual's passport.

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

Endpoint

• For testing GET: https://kyc-stage.bank131.ru/api/v1.1/check/{id}
• For live testing POST: https://kyc.bank131.ru/api/v1.1/check/{id}

Request

The request body is empty.

Request example

cURL

  -X GET https://kyc-stage.bank131.ru/api/v1.1/check/7 \
  -H 'Content-Type: application/json' \
  -H 'X-PARTNER-PROJECT: your_project_name'

Response

Response parameters

Name	Mandatory	Type	Description
status	+	string	Verification status. Possible options: ok, pending, error
data	-	Data	Response details object
id	-	number	Check request ID
description	-	string	Request status description
participant	-	Participant	Recipient data
reference	-	string	Recipient ID
error	-	Error	Error details object
code	+	string	Error code
description	+	string	Error description

Response content

Content of the Data and Error objects returned with the HTTP code 200 is described below. View all response HTTP response codes

Status OK

The verification was successful. You can now send the money.

Response example

{
  "status": "ok",
  "data":
    {
      "id": "7", // check request ID
      "description": "valid",
      "participant":
        {
          reference": "123"
        }
    }
}

Status Pending

The data have been submitted for verification. To see the result, repeat the check{id} request later.

Response example

{
    "status": "pending",
    "data":
        {
            "id": "7",
            "description": "Check in progress"
           }
}

Status Error

code	description	Error description
invalid_sign	Signature verification failure	Incorrect check request signature
passport_validation_failure, inn_validation_failure	Passport, inn validation failure	The data were not verified. Check the ID card number and taxpayer identification number and start the verification again
already_exists	Request with the same data already exists	You have already submitted these data for verification. To see the result, send the check{id} request with the previous verification's ID that you received in the data.id field.
request_not_found	Request with given id not found	The request with the given ID was not found
partner_project_not_found	partner project not found	The project ID sent in the header X-PARTNER-PROJECT does not exist

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