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
- 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 | + | number | Taxpayer Identification Number (INN in Russia), 10 digits |
ID Card (Passport)
Name | Mandatory | Type | Description |
---|---|---|---|
identity_document | + | string | Type of ID. Always: Паспорт РФ |
passport_number | + | number | 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 | + | number | 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: - |
create_participant | - | bool | Creates recipient |
Request example
-X POST https://kyc-stage.bank131.ru/api/v1.1/check \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-d '{
"payload": {
"inn": "123456789012",
"email": "name@email.com",
"issuer": "ОТДЕЛОМ УФМС РОССИИ",
"address": "п. Сосьва (Хант.), алл. Прибрежная, д. 53 стр. 9, 365826",
"birthday": "28.02.1990",
"postcode": "365826",
"last_name": "Дмитриев",
"birthplace": "с. Ербогачен, пер. Павлика Морозова, д. 86 к. 267, 531558",
"first_name": "Иван",
"patronymic": "Герасимович",
"citizenship": "РФ",
"issuer_code": "123-000",
"issuer_date": "01.01.2010",
"phone_number": "+79000000000",
"migration_card": "-",
"passport_number": "1234567890",
"public_officials": "Нет",
"beneficial_owners": "БВ отсутствует",
"identity_document": "Паспорт гражданина РФ",
"agent_contract_date": "01.01.2020",
"right_to_stay_in_rf": "-",
"agent_contract_number": "123456789",
"create_participant": true
},
"signature": "dkQzYwTExRc0RFWk1CY0dBMVVFQnd3UTBMTXVJTkNjMEw3Ug0NCmd..."
}'
Response
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 |
Response content
Content of the Data
and Error
objects returned with the HTTP code 200
is described below. View all response HTTP response codes
OK
Status Verification request created. To see the result, send the check{id}
request with the ID from the id
field.
Response example
{
"status": "ok",
"data":
{
"id": "7",
"description": "request added to queue"
}
}
Error
Status code | description | Error description |
---|---|---|
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
{
"status": "error",
"error": {
"code": "partner_project_not_found",
"description": "partner project not found"
}
}