GET
/
v1-preview
/
models
/
bank-statement
/
{documentId}
from abbyy_document_ai import DocumentAi
import os


with DocumentAi(
    api_key_auth=os.getenv("DOCUMENTAI_API_KEY_AUTH", ""),
) as document_ai:

    res = document_ai.models.bank_statement.get_extracted_fields(document_id="wh23anb5xjf0ntw5taase5qz")

    assert res.bank_statement is not None

    # Handle response
    print(res.bank_statement)
{
  "meta": {
    "id": "wh23anb5xjf0ntw5taase5qz",
    "name": "document.jpg",
    "createdAt": "2025-02-07T17:44:06.949Z",
    "model": "bank-statement",
    "status": "Processed",
    "pageCount": 10,
    "errors": [
      {
        "message": "Total is required"
      }
    ]
  },
  "fields": {
    "bankName": "Chase Bank",
    "accountNumber": "1234-5678-9012-3456",
    "accountOwnerName": "John A. Smith",
    "accountOwnerAddress": "456 Home Street, San Francisco, CA 94105",
    "accountCoOwnerName": [
      {
        "accountCoOwnerName": "Jane B. Smith"
      }
    ],
    "currency": "USD",
    "dateOfBankStatement": "2024-01-15",
    "endingBalanceOfThePeriod": 5000,
    "endingBalanceDate": "2024-01-31"
  }
}

Authorizations

​
Authorization
string
header
required

Our API offers authentication via API keys. You can obtain an API key from https://developer.abbyy.com

Path Parameters

​
documentId
string
required

The id of the document

Response

200
application/json

Extracted Bank Statement Data Response

​
meta
object
required

Represents a document that has been submitted for processing.

Example:
{
  "id": "wh23anb5xjf0ntw5taase5qz",
  "name": "document.jpg",
  "createdAt": "2025-02-07T17:44:06.949Z",
  "model": "image-to-text",
  "status": "Processed",
  "pageCount": 10,
  "errors": [{ "message": "Total is required" }]
}
​
fields
object

Fields extracted from a bank statement

Example:
{
  "bankName": "Chase Bank",
  "accountNumber": "1234-5678-9012-3456",
  "accountOwnerName": "John A. Smith",
  "accountOwnerAddress": "456 Home Street, San Francisco, CA 94105",
  "accountCoOwnerName": [{ "accountCoOwnerName": "Jane B. Smith" }],
  "currency": "USD",
  "dateOfBankStatement": "2024-01-15",
  "endingBalanceOfThePeriod": 5000,
  "endingBalanceDate": "2024-01-31"
}
​
validationErrors
object[]

An array of validation errors that occurred while processing the document. These typically do not prevent field extraction, but rather indicate issues extracting key fields.

Was this page helpful?