BRbrale
Accounts

Stage a verification document for later linking

Changed on
post/documents

Request

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

Request body multipart/form-data

document_kind'aml_program' | 'articles_of_incorporation' | 'certificate_of_good_standing' | 'ein_letter' | 'entity_registration' | 'government_photo_id' | 'other' | 'regulatory_license' required
filestring binary required

The document image or PDF. For a two-sided identity document, its front.

file_backstring binary nullable

The reverse side of a two-sided identity document. Required when identity_document_type is one of: DRIVER_LICENSE, NATIONAL_ID, ID_CARD, VOTER_ID_CARD, RESIDENT_CARD. Accepted for any other identity document type but not required. Not accepted for a business document.

identity_document_type'PASSPORT' | 'DRIVER_LICENSE' | 'NATIONAL_ID' | 'PAN_CARD' | 'ID_CARD' | 'VOTER_ID_CARD' | 'RESIDENT_CARD' | 'GHANA_CARD' | 'GHANA_SSNIT_CARD' | 'KENYA_ALIEN_CARD' | 'COLOMBIA_PPT'
person_labelstring nullable

Example request

{
  "identity_document_type": "DRIVER_LICENSE"
}

Response

Created

doc_submission_idstring required

ID of the resource

Example response

{
  "doc_submission_id": "2VZvtmVc2j3gQ80CTlcuQXbGrwC"
}

Changes

  • 81b7a9dcca32Revision changes
    • info

      added the new aml_program enum value to the request property

    • info

      added the new entity_registration enum value to the request property

    • info

      added the new regulatory_license enum value to the request property

  • 7cab43b2d26bRevision changes
    • info

      added the new optional request property

    • info

      added the non-success response with the status