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 status

Check/{id} method

This request checks the status of the check request and get the response to verification of an individual's passport.

Add, to the request address, the ID received in response to the ID card details verification request. You will receive the verification status in the response.

Endpoint

  • For testing GET: https://kyc-stage.bank131.ru/api/v1.1/check/{id}
  • For live testing POST: https://kyc.bank131.ru/api/v1.1/check/{id}

Request

The request body is empty.

Request example

cURL
  -X GET https://kyc-stage.bank131.ru/api/v1.1/check/7 \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name'

Response

Response parameters

NameMandatoryTypeDescription
status+stringVerification status. Possible options: ok, pending, error
data-DataResponse details object
id-numberCheck request ID
description-stringRequest status description
participant-ParticipantRecipient data
reference-stringRecipient ID
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

The verification was successful. You can now send the money.

Response example
{
  "status": "ok",
  "data":
    {
      "id": "7", // check request ID
      "description": "valid",
      "participant":
        {
          reference": "123"
        }
    }
}

Status Pending

The data have been submitted for verification. To see the result, repeat the check{id} request later.

Response example
{
    "status": "pending",
    "data":
        {
            "id": "7",
            "description": "Check in progress"
           }
}

Status Error

codedescriptionError description
invalid_signSignature verification failureIncorrect check request signature
passport_validation_failure, inn_validation_failurePassport, inn validation failureThe data were not verified. Check the ID card number and taxpayer identification number and start the verification again
already_existsRequest with the same data already existsYou have already submitted these data for verification. To see the result, send the check{id} request with the previous verification's ID that you received in the data.id field.
request_not_foundRequest with given id not foundThe request with the given ID was not found
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. Data already verified
{
    "status": "error",
    "error": {
        "code": "already_exists",
        "description": "Request with the same data already exists"
    }
    "data": {
        "id": "7" // previous verification ID
       }
}
← Verification requestHTTP codes →
  • Check/{id} method
    • Endpoint
  • Request
    • 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