government_photo_id, with the person_label from the webhook payload or the list endpoint. Then link the staged IDs to the individual’s account_id with this endpoint.
During verification review, Brale may request additional documents. Subscribe to 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 verification passes or "rejected" if declined. Brale may also send account.verification.documents_required again if it needs more documents. Stage and link those the same way.
Error responses
Verification webhooks
Subscribe to verification events so your integration is notified when documents are needed or when verification 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.
Typical reactive flow (documents requested after initial submission):
- 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.
- Brale reviews the documents. It may send
account.verification.documents_requiredagain, in which case repeat steps 4 and 5. - When verification passes, Brale sends
account.verification.completed. If verification is declined, Brale sendsaccount.verification.rejected.
Required scope
accounts:write