Sending the profile for verification
Check
method
You should use this method to send a beneficiary questionnaire to Bank 131 for identification.
Request API v2 allows you to send profiles of individuals, residents and non-residents of the Russian Federation, for verification. Request API v1 allows you to submit profiles only for residents of the Russian Federation for verification.
The response includes the request ID by which you can learn the verification result.
- API v2
- API v1
Endpoint
For testing
POST https://kyc-stage.bank131.ru/api/v2/check
When testing, no real ID verification is performed, and answer will be emulated. Do not take these results to verify your customers' IDs.
For live testing
POST https://kyc.bank131.ru/api/v2/check
Request
Non-resident individuals can sign their requests using RSA Keys. To enable this functionality, contact your manager in Bank 131.
Request parameters (recipient details)
Name | Mandatory | Type | Description |
---|---|---|---|
type | + | string | Recipient type. Possible values:FL_RESIDENT — resident individual;FL_NONRESIDENT — non-resident individual |
last_name | + | string | Last name |
first_name | + | string | First Name |
patronymic | - | string | Patronymic name (if the individual has no patronymic, do not pass this parameter) |
birthday | + | string | Date of birth as DD.MM.YYYY. Must be 18 years old or older |
birthplace | + | string | Place of birth |
citizenship | + | string | Citizenship in ISO 3166-1 alpha-2 format |
inn | + | string | Taxpayer identification number (INN in Russia), 6 to 14 characters |
phone_number | + | string | Phone number (any format) |
+ | string | Valid email address | |
documents | + | array | Mandatory documents. The set of mandatory documents may vary depending on the beneficiary type and their citizenship according to the following rules: for individuals residents of the Russian Federation — only a Russian passport PASSPORT_RF is required;for individuals non-residents of the Russian Federation — a foreign passport FOREIGN_PASSPORT and any other type of document other than the Russian passport PASSPORT_RF is required;for citizens of the Republic of Belarus — only a foreign passport FOREIGN_PASSPORT is required |
type | + | string | Document type. Possible values:PASSPORT_RF — Russian passport;FOREIGN_PASSPORT — non-Russian passport;MIGRATION_CARD — migration card;RESIDENT_CARD — resident card;REFUGEE_CERTIFICATE — refugee certificate;VISA — visa;ARRIVAL_NOTICE — arrival notice;TEMPORARY_RESIDENCE_PERMIT — temporary residence permit;PATENT — patent |
number | + (not mandatory only for ARRIVAL_NOTICE ) | string | Document number. The minimum number of characters for the type FOREIGN_PASSPORT — 2, and the maximum — 10. There are no restrictions for other types. If there is a series, it should be transmitted together with the number in the SERIESNUMBER format |
issuer_code | - (mandatory only for PASSPORT_RF ) | string | Issuing division code |
issuer | - (mandatory only fo PASSPORT_RF and FOREIGN_PASSPORT ) | string | Issuing division |
expire_date | + (not mandatory only for PASSPORT_RF and FOREIGN_PASSPORT ) | string | Expiration date of the document. The specified date must be strictly greater than the current date. The difference between the issue date and the expiration date must not exceed a certain period, depending on the type:MIGRATION_CARD — 1 year;RESIDENT_CARD — 10 years;REFUGEE_CERTIFICATE — 3 years;VISA — 3 years;ARRIVAL_NOTICE — 180 days;TEMPORARY_RESIDENCE_PERMIT — 3 years;PATENT — 1 year |
issuer_date | + | string | Issuing date as DD.MM.YYYY |
postcode | - | string | ZIP Code |
address | + | string | Address |
agent_contract_number | + | string | Agency Agreement No. |
agent_contract_date | + | string | Agency Agreement Date |
beneficial_owners | + | string | Always: No BO |
public_officials | + | string | Always: No |
Response examples
- For a resident individual
- For a non-resident individual
- For a non-resident individual signed with RSA Keys
curl -X POST \
https://kyc.bank131.ru/api/v2/check/ \
-H 'x-partner-project: test-partner-project' \
-H 'Content-Type: application/json' \
-H 'accept: application/json' \
-d '{
"payload": {
"type": "FL_RESIDENT",
"last_name": "Dmitriev",
"first_name": "Ivan",
"patronymic": "Ivanovich",
"birthday": "01.01.1970",
"birthplace": "Novgorod",
"citizenship": "RU",
"inn": "065553161159",
"phone_number": "+79000000000",
"email": "name@email.com",
"documents": [
{
"type": "PASSPORT_RF ",
"number": "0234567890",
"issuer": "UFMS Russia",
"issuer_date": "01.01.2010",
"issuer_code": "123-000"
}
],
"address": "Novgorod, Pribrezhnaya str., 53",
"postcode": "365826",
"agent_contract_number": "123456789-0",
"agent_contract_date": "01.01.2020",
"beneficial_owners": "No BO",
"public_officials": "No"
},
"signature": "dkQzYwTExRc0RFWk1CY0dBMVVFQnd3UTBMTXVJTkNjMEw3Ug0NCmd..."
}'
curl -X POST 'https://kyc.bank131.ru/api/v2/check/' \
-H 'x-partner-project: test-partner-project' \
-H 'Content-Type: application/json' \
-H 'accept: application/json' \
-d '{
"payload": {
"type": "FL_NONRESIDENT",
"last_name": "Guseinov",
"first_name": "Gusein",
"patronymic": "Guseinovich",
"birthday": "13.01.1990",
"birthplace": "Dushanbe",
"citizenship": "TJ",
"inn": "AA0000000",
"phone_number": "+79000000000",
"email": "name@email.com",
"documents": [
{
"type": "FOREIGN_PASSPORT",
"number": "FA0000000",
"issuer": "UVD Dushanbe",
"issuer_date": "12.02.2020"
},
{
"type": "MIGRATION_CARD",
"number": "11111111111",
"issuer_date": "12.10.2023",
"expire_date": "11.10.2024"
}
],
"address": "Novgorod, Pribrezhnaya str., 53",
"postcode": "365826",
"agent_contract_number": "123456789-0",
"agent_contract_date": "01.01.2020",
"beneficial_owners": "No BO",
"public_officials": "No"
},
"signature": "dkQzYwTExRc0RFWk1CY0dBMVVFQnd3UTBMTXVJTkNjMEw3Ug0NCmd..."
}'
curl -X POST \
https://kyc.bank131.ru/api/v2/check/ \
-H 'x-partner-project: test-partner-project' \
-H 'Content-Type: application/json' \
-H 'accept: application/json' \
-d '{
"type": "FL_NONRESIDENT",
"last_name": "Guseinov",
"first_name": "Gusein",
"patronymic": "Guseinovich",
"birthday": "13.01.1990",
"birthplace": "Dushanbe",
"citizenship": "TJ",
"inn": "AA0000000",
"phone_number": "+79000000000",
"email": "name@email.com",
"address": "Novgorod, Pribrezhnaya str., 53",
"agent_contract_number": "123456789-0",
"agent_contract_date": "01.01.2020",
"beneficial_owners": "No BO",
"public_officials": "No",
"documents": [
{
"type": "FOREIGN_PASSPORT",
"number": "FA0000000",
"issuer": "UVD Dushanbe",
"issuer_date": "12.02.2020"
},
{
"type": "MIGRATION_CARD",
"number": "11111111111",
"issuer_date": "05.12.2023",
"expire_date": "01.12.2024"
}
],
"postcode": "365826"
}'
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 field | status field value |
---|---|
Even, including 0 | ok |
Uneven | error |
Response parameters
Name | Mandatory | Type | Description |
---|---|---|---|
status | + | string | Identification 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 examples
- Successful response example
- Example of a response with an error
{
"status": "ok",
"data": {
"id": "7",
"description": "request added to queue"
}
}
{
"status": "error",
"error": {
"code": "partner_project_not_found",
"description": "partner project not found"
}
}
Endpoint
For testing
POST https://kyc-stage.bank131.ru/api/v1/check
When testing, no real ID identification is performed, and the testing results will be emulated. Don't take these results to identify your customers' IDs.
For live testing
POST https://kyc.bank131.ru/api/v1/check
Request
Request parameters
Recipient's details
Name | Mandatory | Type | Description |
---|---|---|---|
last_name | + | string | Last Name |
first_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), 12 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
curl -X POST \
https://kyc.bank131.ru/api/v1/check/ \
-H 'x-partner-project: test-partner-project' \
-H 'Content-Type: application/json' \
-H 'accept: application/json' \
-d '{
"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..."
}'
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 field | status field value |
---|---|
Even, including 0 | ok |
Uneven | error |
Response parameters
Name | Mandatory | Type | Description |
---|---|---|---|
status | + | string | Identification 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 examples
- Successful response example
- Example of a response with an error
{
"status": "ok",
"data": {
"id": "7",
"description": "request added to queue"
}
}
{
"status": "error",
"error": {
"code": "partner_project_not_found",
"description": "partner project not found"
}
}