Retrieve the extraction results

GET

https://api.ntropy.com/v3/bank_statements/:id/results

GET

/v3/bank_statements/:id/results

1 from ntropy_sdk import SDK
2 
3 sdk = SDK("cd1H...Wmhl")
4 bs = sdk.bank_statements.get("7f8dceac-2848-472d-b5c3-55cdbaf35a9b")
5 results = sdk.bank_statements.wait_for_results("7f8dceac-2848-472d-b5c3-55cdbaf35a9b")

Try it

1 {
2   "accounts": [
3     {
4       "transactions": [
5         {
6           "id": "xbx8YP14g565Xk",
7           "description": "SQ* STARBUCKS 10 Union Sq",
8           "date": "2024-03-30",
9           "amount": 200,
10           "entry_type": "outgoing",
11           "currency": "USD",
12           "running_balance": 400,
13           "page_number": 1
14         }
15       ],
16       "number": "972913289",
17       "opening_balance": 400,
18       "closing_balance": 200,
19       "start_date": "2024-01-01",
20       "end_date": "2024-02-01",
21       "is_balance_reconciled": true,
22       "total_incoming": 0,
23       "total_outgoing": 200
24     }
25   ]
26 }

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.

Authentication

Path Parameters

Response

Errors