Documentation

Documentation

  • Bank 131 API
  • Languages iconEnglish
    • Русский

›Passport Verification

131 Documentation

  • API features
  • Where to begin

Introduction to API

  • Interaction
  • API libraries
  • Testing
  • Version history

How Payouts Work

  • Features
  • How it all works
  • Main payout scenario
  • Payout refunds
  • The Self-employed

    • Payouts to the self-employed
    • Linking the self-employed

    Payout Methods

    • To a Russian bank card
    • To a foreign bank card
    • To a Russian bank account
    • To a QIWI Wallet
    • To a YooMoney (Yandex.Money)
    • To the Russian Federal Tax Agency

    Payout Scenarios

    • Payout to a card via widget
    • Single-request payout
    • Payout to a card with PCI DSS
    • Payout to a self-employed person with fiscal receipt

How Payments Work

  • Features
  • Payment process
  • Payments via bank card
  • Payments with later capture
  • Refunds
  • Recurring payments
  • Split Payments

    • Features and options
    • Split payments out of the box
    • Split payments using API

    Payment Scenarios

    • Paying via payment form
    • Paying with PCI DSS
    • Single-request payment

Widgets

  • Widget to get card details
  • Payment form widget
  • Widget for linking a self-employed person to the Bank

Passport Verification

  • Features
  • Interaction
  • Verification request
  • Verification status
  • HTTP codes

Reports

  • Payouts report
  • Payments report
  • Monthly report

API Reference

  • Objects
  • Methods
  • Webhooks
  • Error codes

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

NameMandatoryTypeDescription
first_name+stringLast Name
last_name+stringName
patronymic-stringPatronymic (if any)
birthday+stringDate of Birth
birthplace+stringPlace of Birth
inn+numberTaxpayer Identification Number (INN in Russia), 10 digits

ID Card (Passport)

NameMandatoryTypeDescription
identity_document+stringType of ID. Always: Паспорт РФ
passport_number+numberSerial number (no spaces). Example: 1234567890
issuer+stringIssued By
issuer_code+stringIssuer Code
issuer_date+stringDate Issued DD.MM.YYYY
citizenship+stringCitizenship. Always: РФ

Registration

NameMandatoryTypeDescription
postcode+numberZIP Code
address+stringAddress

Recipient's Contact Info

NameMandatoryTypeDescription
e-mail+stringValid email address
phone_number+stringPhone (any format)

Additional Info

NameMandatoryTypeDescription
agent_contract_number+stringAgency Agreement No.
agent_contract_date+stringAgency Agreement Date
beneficial_owners+stringAlways: БВ отсутствует
public_officials+stringAlways Нет
migration_card+stringAlways: -
right_to_stay_in_rf+stringAlways: -
create_participant-boolCreates recipient

Request example

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

NameMandatoryTypeDescription
status+stringVerification status. Possible options: ok, error
data-DataResponse details object
id-numberCheck request ID
description-stringRequest status description
error-ErrorError details object
code+stringError code
description+stringError 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

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

Status Error

codedescriptionError description
partner_project_not_foundpartner project not foundThe 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"
    }
}
← InteractionVerification status →
  • Check method
    • Endpoint
  • Request
    • Request parameters
    • Request example
  • Response
    • Response parameters
    • Response content
Documentation
Documentation
PayoutsPaymentsAPI Reference
Step by step
Payout to a card via widgetPayout to a card with PCI DSSPayout to the self-employed Paying via payment form
Get in touch
Ideas and partnerships — partners@131.ruMedia — press@131.ru
© 2021 Bank 131