On this page

Submit bank statements

Choose the input that matches the data you have.

InputApplication fields
One PDF, CSV, or TXT filebank_statement in a multipart request. File limit of 20 MiB.
One base64-encoded PDF, CSV, or TXTbank_statement_base64 in JSON. Supply bank_statement_format explicitly, especially for TXT. Without it, Vector detects PDF and otherwise defaults to CSV.
One set of structured transactionstransactions, with optional statement_period and opening_balance.
Multiple account-linked statementsbank_statements with at least two entries. Each entry supplies an account and either a PDF upload, a base64 PDF, or a JSON ledger.
One PDF with several accountsA single PDF with bank_statement_account_scope=all to request combined account analysis.

Upload a CSV or TXT#

Use the application quickstart and replace [email protected] with [email protected] or [email protected]. Use a real statement export with transaction rows. Renaming another file type leaves its contents unchanged.

Upload a password-protected PDF#

For a single PDF, send the PDF's password in bank_statement_password, in the same multipart or JSON request. For an entry in bank_statements, send password on that entry. The separate parser uses password as a multipart field. Keep the PDF and password out of logs and error trackers.

Send multiple PDFs#

Use one multipart entry per PDF. Include the application fields from the quickstart. Replace the single statement field with these fields:

text
bank_statements[0][bank_code]       058
bank_statements[0][account_number] 0123456789
bank_statements[0][file]            @statement-a.pdf
bank_statements[1][bank_code]       044
bank_statements[1][account_number] 0987654321
bank_statements[1][file]            @statement-b.pdf

When you also send bank_accounts, every statement account must match an account in that list. Provide either file, base64, or ledger per entry. Keep statement periods and balances on each structured ledger. A raw CSV or TXT must be converted into a structured ledger before it can be included in this list.

Mix a PDF and a structured ledger#

For a JSON application request, include the following bank_statements array alongside the application fields. Replace the base64 placeholder with the actual PDF bytes encoded as base64.

json
{
  "bank_statements": [
    {
      "bank_code": "058",
      "account_number": "0123456789",
      "base64": "<BASE64_PDF>"
    },
    {
      "bank_code": "044",
      "account_number": "0987654321",
      "ledger": {
        "currency": "NGN",
        "statement_period": {"from": "2026-10-01", "to": "2026-10-31"},
        "opening_balance": 10000,
        "closing_balance": 12500,
        "transactions": [
          {"date": "2026-10-04", "credit": 2500, "balance": 12500, "narration": "Transfer"}
        ]
      }
    }
  ]
}

A ledger needs a currency, period, opening balance, closing balance, and at least one transaction. Each row needs a date and running balance. Debit and credit values, when supplied, must be nonnegative. Verify that the running balance and closing balance reconcile before sending it.

Parse a statement separately#

Use POST /api/v1/bank-statements with multipart applicationId and file. You can supply password for a PDF. This endpoint requires an existing application in your institution. It accepts PDF, CSV, or TXT files up to 20 MiB and returns HTTP 202 with a statement ID and status. Fetch GET /api/v1/bank-statements/{id} to check processing and read any failure reason.

Troubleshoot a statement#

If extraction or reconciliation fails, check that the export is complete and readable. For a combined PDF, check whether it contains several accounts and use the account scope intended for that file. For a structured ledger, verify each row against the previous balance and verify that the last balance matches the closing balance. Include the application or statement ID when requesting support. Share any sensitive file through your agreed support channel.