account.verification.documents_required to be notified when uploads are needed, or poll required documents. See Webhook Events.
Example request
Example response (200)
status will remain "pending" while Brale reviews the submitted documents. It transitions to "complete" once KYB passes or "rejected" if declined.
Error responses
| Status | Cause |
|---|---|
400 | doc_submission_ids is empty or missing. |
404 | Account not found. |
422 | Document upload not allowed for this account’s current state. |
Verification webhooks
Subscribe to verification events so your integration is notified when documents are needed or when KYB completes. Create a subscription withPOST /accounts/{account_id}/webhooks and include account.verification.documents_required in the events array. See the Webhooks overview for subscription setup and signature verification.
| Event | When it fires |
|---|---|
account.verification.documents_required | Brale’s KYB review determines one or more documents must be uploaded. |
account.verification.completed | Account verification passes and the account is enabled (status becomes complete). |
- Create the account (
POST /accounts). - Brale reviews the application asynchronously.
- If additional documents are required, Brale sends
account.verification.documents_requiredto your webhook URL. - Stage each required document (use
document_kindandperson_labelfrom the webhook payload or list endpoint when present). - Link staged submissions with this endpoint.
- When KYB passes, Brale sends
account.verification.completed.
Required scope
accounts:write