get
https://sandbox.onebrick.io/v2/ocr/bank-statement/extract
Use this endpoint to submit bank statement PDF files for OCR extraction.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Use this endpoint to submit bank statement PDF files for OCR extraction.
Brick processes the submitted statement and returns an extraction transaction ID that can be used to track or reconcile the OCR result. 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 |