BRbrale
Accounts

List required verification documents

Changed on
get/accounts/{account_id}/verification/documents

Request

  • Base URL
    https://api.brale.xyz
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.brale.xyz/oauth2/token scopes: accounts:read

Path parameters

account_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Account ID

Response

OK

account_idstring required

ID of the resource

available_person_labelsstring[] required
other_documents_uploaded_countinteger required

Example response

{
  "account_id": "2VZvtmVc2j3gQ80CTlcuQXbGrwC",
  "available_person_labels": [
    "Jane Doe"
  ],
  "documents": [
    {
      "display_name": "Government-issued photo ID",
      "person_label": "Jane Doe"
    }
  ]
}

Changes

  • 81b7a9dcca32Revision changes
    • warning

      added the new aml_program enum value to the // response property for the response status

    • warning

      added the new entity_registration enum value to the // response property for the response status

    • warning

      added the new regulatory_license enum value to the // response property for the response status

  • d934fd29acc3Revision changes
    • info

      endpoint added