Verifications

Endpoints для требований к проверкам, проверки личности, проверки карты и проверок по заявке.

Проверки по заявке

Show verification requirements for an order

get

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Sanctum token in Authorization: Bearer <token> format.

Path parameters

orderstringRequired

Database id, public_id or tracking_id.

Responses

200

Order verification requirements.

application/json

stateinteger · enumRequiredPossible values:

messagestringRequired

404

Standard error envelope.

application/json

get/private/exchange/orders/{order}/verifications

GET /api/v3/private/exchange/orders/{order}/verifications HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "state": 0,
  "message": "text",
  "result": {
    "requirements": {
      "route_id": 1,
      "order": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "identity": {
        "required": true,
        "mode": "text",
        "description": "text",
        "current": {
          "id": 1,
          "key": "not_submitted",
          "label": "text",
          "is_final_approved": true,
          "verification_id": 1
        },
        "create_endpoint": "text"
      },
      "card": {
        "required": true,
        "mode": 1,
        "description": "text",
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "current": {
          "id": 1,
          "key": "not_submitted",
          "label": "text",
          "is_final_approved": true,
          "verification_id": 1
        },
        "create_endpoint": "text"
      },
      "files": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  },
  "meta": {
    "request_id": "text",
    "correlation_id": "text",
    "timestamp": "2026-01-01T00:00:00.000Z",
    "pagination": {
      "mode": "page",
      "current_page": 1,
      "per_page": 1,
      "total": 1,
      "last_page": 1,
      "from": 1,
      "to": 1,
      "cursor": "text",
      "next_cursor": "text",
      "has_more": true
    }
  }
}

Отправить проверку по заявке

Submit verification data for an order

post

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Sanctum token in Authorization: Bearer <token> format.

Path parameters

orderstringRequired

Header parameters

Idempotency-Keystring · min: 8 · max: 191Optional

Makes unsafe requests safely repeatable for 24 hours by default.

X-Correlation-Idstring · max: 128Optional

Client-defined id used to correlate API request and webhook events.

Body

Responses

200

Standard success envelope.

application/json

stateinteger · enumRequiredPossible values:

messagestringRequired

resultany · nullableRequired

422

Standard error envelope.

application/json

post/private/exchange/orders/{order}/verifications/submit

POST /api/v3/private/exchange/orders/{order}/verifications/submit HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "identity": {
    "full_name": "text",
    "file_intents": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  },
  "card": {
    "order": "text",
    "order_id": "text",
    "currency_id": 1,
    "card_number": "text",
    "name": "text",
    "file_intent": "123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "state": 0,
  "message": "text",
  "result": null,
  "meta": {
    "request_id": "text",
    "correlation_id": "text",
    "timestamp": "2026-01-01T00:00:00.000Z",
    "pagination": {
      "mode": "page",
      "current_page": 1,
      "per_page": 1,
      "total": 1,
      "last_page": 1,
      "from": 1,
      "to": 1,
      "cursor": "text",
      "next_cursor": "text",
      "has_more": true
    }
  }
}

Требования к проверке

Show verification requirements for route or order

get

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Sanctum token in Authorization: Bearer <token> format.

Query parameters

orderstringOptional

route_idintegerOptional

income_payment_systemintegerOptional

outcome_payment_systemintegerOptional

Responses

200

Standard success envelope.

application/json

stateinteger · enumRequiredPossible values:

messagestringRequired

resultany · nullableRequired

422

Standard error envelope.

application/json

get/private/verifications/requirements

GET /api/v3/private/verifications/requirements HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "state": 0,
  "message": "text",
  "result": null,
  "meta": {
    "request_id": "text",
    "correlation_id": "text",
    "timestamp": "2026-01-01T00:00:00.000Z",
    "pagination": {
      "mode": "page",
      "current_page": 1,
      "per_page": 1,
      "total": 1,
      "last_page": 1,
      "from": 1,
      "to": 1,
      "cursor": "text",
      "next_cursor": "text",
      "has_more": true
    }
  }
}

Создать identity verification

Create identity verification

post

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Sanctum token in Authorization: Bearer <token> format.

Header parameters

Idempotency-Keystring · min: 8 · max: 191Optional

Makes unsafe requests safely repeatable for 24 hours by default.

X-Correlation-Idstring · max: 128Optional

Client-defined id used to correlate API request and webhook events.

Body

full_namestring · nullableOptional

file_intentsstring · uuid[] · min: 1 · max: 2Required

Responses

201

Standard success envelope.

application/json

stateinteger · enumRequiredPossible values:

messagestringRequired

resultany · nullableRequired

422

Standard error envelope.

application/json

post/private/verifications/identity

POST /api/v3/private/verifications/identity HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "full_name": "text",
  "file_intents": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "state": 0,
  "message": "text",
  "result": null,
  "meta": {
    "request_id": "text",
    "correlation_id": "text",
    "timestamp": "2026-01-01T00:00:00.000Z",
    "pagination": {
      "mode": "page",
      "current_page": 1,
      "per_page": 1,
      "total": 1,
      "last_page": 1,
      "from": 1,
      "to": 1,
      "cursor": "text",
      "next_cursor": "text",
      "has_more": true
    }
  }
}

Получить identity verification

Show identity verification

get

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Sanctum token in Authorization: Bearer <token> format.

Path parameters

verificationstringRequired

Responses

200

Standard success envelope.

application/json

stateinteger · enumRequiredPossible values:

messagestringRequired

resultany · nullableRequired

404

Standard error envelope.

application/json

get/private/verifications/identity/{verification}

GET /api/v3/private/verifications/identity/{verification} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "state": 0,
  "message": "text",
  "result": null,
  "meta": {
    "request_id": "text",
    "correlation_id": "text",
    "timestamp": "2026-01-01T00:00:00.000Z",
    "pagination": {
      "mode": "page",
      "current_page": 1,
      "per_page": 1,
      "total": 1,
      "last_page": 1,
      "from": 1,
      "to": 1,
      "cursor": "text",
      "next_cursor": "text",
      "has_more": true
    }
  }
}

Действия по identity verification

Show identity verification actions

get

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Sanctum token in Authorization: Bearer <token> format.

Path parameters

verificationstringRequired

Responses

200

Standard success envelope.

application/json

stateinteger · enumRequiredPossible values:

messagestringRequired

resultany · nullableRequired

get/private/verifications/identity/{verification}/actions

GET /api/v3/private/verifications/identity/{verification}/actions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Standard success envelope.

{
  "state": 0,
  "message": "text",
  "result": null,
  "meta": {
    "request_id": "text",
    "correlation_id": "text",
    "timestamp": "2026-01-01T00:00:00.000Z",
    "pagination": {
      "mode": "page",
      "current_page": 1,
      "per_page": 1,
      "total": 1,
      "last_page": 1,
      "from": 1,
      "to": 1,
      "cursor": "text",
      "next_cursor": "text",
      "has_more": true
    }
  }
}

Создать card verification

Create card/account verification

post

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Sanctum token in Authorization: Bearer <token> format.

Header parameters

Idempotency-Keystring · min: 8 · max: 191Optional

Makes unsafe requests safely repeatable for 24 hours by default.

X-Correlation-Idstring · max: 128Optional

Client-defined id used to correlate API request and webhook events.

Body

orderstring · nullableOptional

order_idstring · nullableOptional

currency_idinteger · nullableOptional

card_numberstringRequired

namestring · nullableOptional

file_intentstring · uuidRequired

Responses

201

Standard success envelope.

application/json

stateinteger · enumRequiredPossible values:

messagestringRequired

resultany · nullableRequired

422

Standard error envelope.

application/json

post/private/verifications/cards

POST /api/v3/private/verifications/cards HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "order": "text",
  "order_id": "text",
  "currency_id": 1,
  "card_number": "text",
  "name": "text",
  "file_intent": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "state": 0,
  "message": "text",
  "result": null,
  "meta": {
    "request_id": "text",
    "correlation_id": "text",
    "timestamp": "2026-01-01T00:00:00.000Z",
    "pagination": {
      "mode": "page",
      "current_page": 1,
      "per_page": 1,
      "total": 1,
      "last_page": 1,
      "from": 1,
      "to": 1,
      "cursor": "text",
      "next_cursor": "text",
      "has_more": true
    }
  }
}

Получить card verification

Show card/account verification

get

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Sanctum token in Authorization: Bearer <token> format.

Path parameters

verificationstringRequired

Responses

200

Standard success envelope.

application/json

stateinteger · enumRequiredPossible values:

messagestringRequired

resultany · nullableRequired

404

Standard error envelope.

application/json

get/private/verifications/cards/{verification}

GET /api/v3/private/verifications/cards/{verification} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "state": 0,
  "message": "text",
  "result": null,
  "meta": {
    "request_id": "text",
    "correlation_id": "text",
    "timestamp": "2026-01-01T00:00:00.000Z",
    "pagination": {
      "mode": "page",
      "current_page": 1,
      "per_page": 1,
      "total": 1,
      "last_page": 1,
      "from": 1,
      "to": 1,
      "cursor": "text",
      "next_cursor": "text",
      "has_more": true
    }
  }
}

Действия по card verification

Show card/account verification actions

get

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Sanctum token in Authorization: Bearer <token> format.

Path parameters

verificationstringRequired

Responses

200

Standard success envelope.

application/json

stateinteger · enumRequiredPossible values:

messagestringRequired

resultany · nullableRequired

get/private/verifications/cards/{verification}/actions

GET /api/v3/private/verifications/cards/{verification}/actions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Standard success envelope.

{
  "state": 0,
  "message": "text",
  "result": null,
  "meta": {
    "request_id": "text",
    "correlation_id": "text",
    "timestamp": "2026-01-01T00:00:00.000Z",
    "pagination": {
      "mode": "page",
      "current_page": 1,
      "per_page": 1,
      "total": 1,
      "last_page": 1,
      "from": 1,
      "to": 1,
      "cursor": "text",
      "next_cursor": "text",
      "has_more": true
    }
  }
}