Get KYB document

Production

GET

/v1/brl/kyb/documents/{documentId}

Reads readiness and upload status for an owned KYB document.

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Header Params

Responses

🟢200

application/json

Document status.

Bodyapplication/json

🟠400

🟠404

🔴502

🟠401ManagedSelectorUnauthorized

🟠403BrlaManagedSelectorForbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/brl/kyb/documents/?subAccountId=' \
--header 'X-Managed-Profile-Id;' \
--header 'X-API-Key: <api-key>'

Response Example

200 - Example 1

{
    "document": {
        "documentType": "ID",
        "id": "string",
        "ready": true,
        "uploadErrorBack": "string",
        "uploadErrorFront": "string",
        "uploadStatusBack": "string",
        "uploadStatusFront": "string"
    }
}

Modified at 2026-08-19 18:12:56

Create KYB document

Submit API-driven KYB