Verification request
Check
method
This method helps verify ID details of the individual that receives a payout.
The response includes the request ID by which you can learn the verification result.
Endpoint
For testing
POST https://kyc-stage.bank131.ru/api/v1.1/check
When testing, no real ID verificatrion is performed, and the testing results will be emulated. Don't take these results to verify your customers' IDs.
For live testing
POST https://kyc.bank131.ru/api/v1.1/check
Request
Request parameters
Recipient's details
Name | Mandatory | Type | Description |
---|---|---|---|
first_name | + | string | Last Name |
last_name | + | string | Name |
patronymic | - | string | Patronymic (if any) |
birthday | + | string | Date of Birth |
birthplace | + | string | Place of Birth |
inn | + | string | Taxpayer Identification Number (INN in Russia), 10 digits |
ID Card (Passport)
Name | Mandatory | Type | Description |
---|---|---|---|
identity_document | + | string | Type of ID. Always: Паспорт гражданина РФ |
passport_number | + | string | Serial number (no spaces). Example: 1234567890 |
issuer | + | string | Issued By |
issuer_code | + | string | Issuer Code |
issuer_date | + | string | Date Issued DD.MM.YYYY |
citizenship | + | string | Citizenship. Always: РФ |
Registration
Name | Mandatory | Type | Description |
---|---|---|---|
postcode | + | string | ZIP Code |
address | + | string | Address |
Recipient's Contact Info
Name | Mandatory | Type | Description |
---|---|---|---|
+ | string | Valid email address | |
phone_number | + | string | Phone (any format) |
Additional Info
Name | Mandatory | Type | Description |
---|---|---|---|
agent_contract_number | + | string | Agency Agreement No. |
agent_contract_date | + | string | Agency Agreement Date |
beneficial_owners | + | string | Always: ВБ отсутствует |
public_officials | + | string | Always Нет |
migration_card | + | string | Always: - |
right_to_stay_in_rf | + | string | Always: - |
Request example
'{
"payload":
{
"inn":"065553161159",
"email":"name@email.com",
"issuer":"ОТДЕЛОМ УФМС РОССИИ",
"address":"г. Бобруйск, алл. Прибрежная, д. 53 стр. 9, 365826",
"birthday":"01.01.1970",
"postcode":"365826",
"birthplace":"г. Бобруйск",
"last_name":"Дмитриев",
"first_name":"Иван",
"patronymic":"Герасимович",
"citizenship":"РФ",
"issuer_code":"123-000",
"issuer_date":"01.01.2010",
"phone_number":"+79000000000",
"migration_card":"-",
"passport_number":"0234567890",
"public_officials":"Нет",
"beneficial_owners":"ВБ отсутствует",
"identity_document":"Паспорт гражданина РФ",
"agent_contract_date":"01.01.2020",
"right_to_stay_in_rf":"-",
"agent_contract_number":"123456789-0"
},
"signature":"dkQzYwTExRc0RFWk1CY0dBMVVFQnd3UTBMTXVJTkNjMEw3Ug0NCmd..."}' --compressed
Response
For testing, the value of the
status
field sent in the response strictly depends on the last digit in ID number of thepassport_number
field sent in the request.
Last digit of passport_number
fieldstatus
field valueEven, including 0 ok
Uneven error
Response parameters
Name | Mandatory | Type | Description |
---|---|---|---|
status | + | string | Verification status. Possible options: ok , error |
data | - | Data | Response details object |
id | - | number | Check request ID |
description | - | string | Request status description |
error | - | Error | Error details object |
code | + | string | Error code |
description | + | string | Error description |
Successful response example
{
"status": "ok",
"data":
{
"id": "7",
"description": "request added to queue"
}
}
Example of a response with an error
{
"status": "error",
"error": {
"code": "partner_project_not_found",
"description": "partner project not found"
}
}