Result of checking an individual's profile
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.
- 2.0
- 1.0
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
curl -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
Name | Mandatory | Type | Description |
---|---|---|---|
status | + | string | Identification status. Possible options: ok , pending , error |
data | - | object | Response details object |
id | - | number | Check request ID |
description | - | string | Request status description |
error | - | object | Error details object |
code | + | string | Error code |
description | + | string | Error description |
Response examples
- Successful response example
- Processing request
- Example of a response with an error
{
"status": "ok",
"data": {
"id": "7", // check request ID
"description": "valid"
}
}
Send another check/{id}
request with the same data later.
{
"status": "pending",
"data": {
"id": "7",
"description": "Check in progress"
}
}
Data already verified.
{
"status": "error",
"error": {
"code": "already_exists",
"description": "Request with the same data already exists"
},
"data": {
"id": "7" // previous verification ID
}
}
Endpoint
- For testing
GET https://kyc-stage.bank131.ru/api/v1.1/check/{id}
- For live testing
GET https://kyc.bank131.ru/api/v1.1/check/{id}
Request
The request body is empty.
Request example
curl -X GET \
https://kyc.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 | Identification status. Possible options: ok , pending , error |
data | - | Data | Response details object |
id | - | number | Check request ID |
description | - | string | Request status description |
error | - | object | Error details object |
code | + | string | Error code |
description | + | string | Error description |
Response examples
- Successful response example
- Processing request
- Example of a response with an error
{
"status": "ok",
"data": {
"id": "7", // check request ID
"description": "valid"
}
}
Send another check/{id}
request with the same data later.
{
"status": "pending",
"data": {
"id": "7",
"description": "Check in progress"
}
}
Data already verified.
{
"status": "error",
"error": {
"code": "already_exists",
"description": "Request with the same data already exists"
},
"data": {
"id": "7" // previous identification ID
}
}