OCR Bank Statement
Extract Bank Statement OCR
Extract Bank Statement OCR is the API endpoint for submitting supported bank statement PDF files to Brick OCR Bank Statement. Brick processes the submitted statement and returns an extraction transaction ID that can be used to track, reconcile, or retrieve the OCR result.
Use this endpoint when your application needs to upload bank statements programmatically instead of using the Brick Dashboard. The endpoint supports PDF files up to 5 MB per file.
Before You Submit
- Generate a new public access token and send it in the
publicAccessTokenheader. - Prepare the bank statement file in PDF format.
- Include a
client_request_idwhen you need idempotency or easier troubleshooting. - Include an email address if your workflow expects OCR result notification by email.
Recommended Usage
Store the returned transaction id, the uploaded file names, and your client_request_id. These values help your team trace OCR processing and support customer inquiries.
Request Parameters
| Key Parameters | Data type | Description |
|---|---|---|
| user_id | String | Unique ID for each user |
| files | File | The financial statement must be submitted in PDF format and must not exceed 5 MB in size. |
Response Parameters
| Key Parameters | Data Type | Description |
|---|---|---|
| id | String | Unique ID for each transaction generated by Brick |
| user_id | String | Unique ID for each user |
| fileNames | String | The name of the financial statement file |
Last modified on