Skip to main content

​
Usage

Copy the code block, replace YOUR_API_KEY with your API key, then process documents quickly.
from abbyy_document_ai import DocumentAi

with DocumentAi(api_key_auth=YOUR_API_KEY) as document_ai:
  res = document_ai.models.bank_statement.begin_field_extraction(input_source={
    "url": "https://example.com/document.pdf",
  })

  assert res.documents is not None
  doc_id = res.documents[0].id

  processed = False
  while not processed:
      time.sleep(3)  # Wait 3 seconds between checks
      res = document_ai.models.bank_statement.get_extracted_fields(
          document_id=doc_id
      )
      processed = res.bank_statement.meta.status == "Processed"

  print(res.bank_statement.fields)

​
Extracted Fields

Field NameDescription
Bank InformationInformation about the bank.
  NameThe name of the bank.
  AddressThe bank’s address.
  StateThe bank’s state.
  CityThe bank’s city.
  StreetThe bank’s street address.
  Postal CodeThe bank’s postal code.
  CountryThe bank’s country.
Account InformationInformation about the bank account.
  Account NumberThe account number.
  Account TypeThe type of account (e.g., checking, savings).
  Account NameThe name on the account.
  CurrencyThe currency of the account.
Statement InformationInformation about the statement period.
  Statement DateThe date of the statement.
  Statement Period StartThe start date of the statement period.
  Statement Period EndThe end date of the statement period.
Balance InformationInformation about account balances.
  Opening BalanceThe balance at the start of the statement period.
  Closing BalanceThe balance at the end of the statement period.
  Total CreditsThe total amount of credits during the statement period.
  Total DebitsThe total amount of debits during the statement period.
Transactions (repeating group)Information about individual transactions.
  Transaction DateThe date of the transaction.
  Value DateThe date when the transaction was processed.
  DescriptionA description of the transaction.
  Reference NumberThe reference number for the transaction.
  AmountThe amount of the transaction.
  TypeThe type of transaction (e.g., credit, debit).
  BalanceThe account balance after the transaction.
  CategoryThe category of the transaction (e.g., utilities, groceries).
  NotesAdditional notes or details about the transaction.

​
Validation Rules

RuleDescription
Required Fields CheckValidates that the following fields are not empty: Account Owner Name, Account Owner Address, Ending Balance of the Period, Ending Balance Date.

​
Supported Languages

CountriesLanguages
USAEnglish
⌘I