Skip to main content
Use the playground below to try this endpoint directly, or review the OpenAPI details in the right panel. Returns the documents Brale currently requires for an account’s KYB verification, including upload status for each. Use this endpoint to poll for required documents instead of relying on the account.verification.documents_required webhook.
For each document with status: "pending_upload", stage the file with Stage a Verification Document (POST /documents), then link it with Link Verification Documents. See Webhook Events for the webhook alternative.

​
Example response (200)

{
  "account_id": "3Ar9BnQCKIrB3SYjKGBzCtFs6XL",
  "documents": [
    {
      "document_kind": "certificate_of_good_standing",
      "document_type": "business_document",
      "display_name": "Certificate of Good Standing",
      "status": "pending_upload",
      "person_label": null
    },
    {
      "document_kind": "government_photo_id",
      "document_type": "individual_document",
      "display_name": "Government-issued photo ID",
      "status": "uploaded",
      "person_label": "Jane Doe"
    }
  ],
  "other_documents_uploaded_count": 1,
  "available_person_labels": ["Jane Doe", "Chief Financial Officer"]
}

​
Response fields

FieldTypeDescription
account_idstring (KSUID)The account ID.
documentsarrayRequired documents and their current status.
documents[].document_kindstringCode to pass as document_kind when staging a upload.
documents[].document_typestringbusiness_document, individual_document, or misc_document.
documents[].display_namestringHuman-readable document name.
documents[].statusstringpending_upload or uploaded.
documents[].person_labelstring | nullPerson this document applies to (individual documents only).
other_documents_uploaded_countintegerCount of miscellaneous (other) documents already uploaded.
available_person_labelsarrayPerson labels on the account’s verification profile — use when staging individual documents.

​
Error responses

StatusCause
401Missing or invalid access token.
403Client lacks accounts:read scope.
404Account not found.

​
Required scope

accounts:read