OCR Bank Statement

Server

Submit bank statement files to Brick OCR and retrieve extracted financial data. This endpoint supports Financial Insight workflows that need structured transaction data from uploaded statements.

Extract Bank Statement OCR

GET

https://sandbox.onebrick.io

/v2/ocr/bank-statement/extract

publicAccessToken (header)

Submit a supported bank statement file to Brick OCR and retrieve structured extraction results for Financial Insight workflows. Use this endpoint when your product needs transaction data from uploaded PDF statements without manual data entry. The response can support underwriting, reconciliation, affordability checks, or financial analysis after you validate file type and user consent.

Extract Bank Statement OCR › Headers

publicAccessToken

string · required

Bearer token for authentication. Format: Bearer

Extract Bank Statement OCR › Request Body

files

string · binary · required

Bank statement file in PDF format only, maximum size 5 MB per file.

email

string

Email destination to receive OCR result notification.

client_request_id

string

Client-generated ID for idempotency / tracing. Recommended to prevent duplicate processing.

Extract Bank Statement OCR › Responses

200

status

integer

Default: 0

error

message

string

object

GET/v2/ocr/bank-statement/extract

curl https://sandbox.onebrick.io/v2/ocr/bank-statement/extract \
  --header 'Content-Type: application/json' \
  --header 'publicAccessToken: <api-key>' \
  --data '{
  "files": "<binary>",
  "email": "email",
  "client_request_id": "client_request_id"
}'

Example Request Body

{
  "files": "<binary>",
  "email": "email",
  "client_request_id": "client_request_id"
}

json

Example Responses

{
    "status": 200,
    "error": null,
    "message": "",
    "metadata": {
        "source": "API",
        "entity": "Experience"
    },
    "data": {
        "transactions": [
            {
                "transaction_id": "{{transaction_id}}",
                "third_party_transaction_id": "",
                "status": "PROCESSING",
                "filename": "{{filename}}.pdf"
            }
        ]
    }
}

json

application/json

Bank Account Validation B2C Subaccount

Extract Bank Statement OCR

GET

https://sandbox.onebrick.io

/v2/ocr/bank-statement/extract

publicAccessToken (header)

Extract Bank Statement OCR › Headers

publicAccessToken

string · required

Bearer token for authentication. Format: Bearer

Extract Bank Statement OCR › Request Body

files

string · binary · required

Bank statement file in PDF format only, maximum size 5 MB per file.

email

string

Email destination to receive OCR result notification.

client_request_id

string

Client-generated ID for idempotency / tracing. Recommended to prevent duplicate processing.

Extract Bank Statement OCR › Responses

200

status

integer

Default: 0

error

message

string

object