Retrieve the extraction results

curl https://api.ntropy.com/v3/bank_statements/id/results \
     -H "X-Api-Key: <apiKey>" \
     -H "Content-Type: application/json"

{
  "accounts": [
    {
      "transactions": [
        {
          "id": "txn_001a2b3c",
          "description": "Payroll Deposit - ACME Corp",
          "date": "2023-01-05",
          "amount": 1200,
          "entry_type": "incoming",
          "currency": "USD",
          "running_balance": 3700.75,
          "page_number": 1
        },
        {
          "id": "txn_004d5e6f",
          "description": "Electricity Bill Payment",
          "date": "2023-01-15",
          "amount": 150.25,
          "entry_type": "outgoing",
          "currency": "USD",
          "running_balance": 3550.5,
          "page_number": 1
        },
        {
          "id": "txn_007g8h9i",
          "description": "Grocery Store Purchase",
          "date": "2023-01-20",
          "amount": 350,
          "entry_type": "outgoing",
          "currency": "USD",
          "running_balance": 3200.5,
          "page_number": 2
        }
      ],
      "number": "123456789012",
      "name": "Primary Checking Account",
      "opening_balance": 2500.75,
      "closing_balance": 3200.5,
      "start_date": "2023-01-01",
      "end_date": "2023-01-31",
      "is_balance_reconciled": true,
      "total_incoming": 1200,
      "total_outgoing": 500.25
    }
  ]
}

Return the extracted account information and associated transactions from a bank statement PDF. The results are accessible once the statement’s status is completed.

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

idstringRequired

Response

Successful Response

accountslist of objects

List of accounts in the bank statement.

Errors

404

Not Found Error

422

Unprocessable Entity Error