Fast verification

In addition to the main extraction process, we also provide a low-latency extractor that looks at the first page of the bank statement and returns key identification details such as underlying bank institution and account holder.

This can be used for UX improvements through instant verification of correct file upload, for UI improvements like returning bank names and logos, or for logging information about a file upon upload.

POST

/v3/bank_statements/:id/verify

1 curl -X "POST" \
2     "https://api.ntropy.com/v3/bank_statements/7f8dceac-2848-472d-b5c3-55cdbaf35a9b/verify" \
3     -H "Accept: application/json" \
4     -H "X-API-KEY: cd1H...Wmhl"

Try it

See the full raw output

Response

1 {
2   "institution": "Well's Fargo",
3   "start_date": "2024-01-01",
4   "end_date": "2024-02-01",
5   "account_holder": {
6     "type": "consumer",
7     "name": "John Doe",
8     "address": {
9       "street": "601 Rosebud Avenue",
10       "postcode": "77901",
11       "city": "Victoria",
12       "state": "Texas",
13       "country": "United States"
14     }
15   },
16   "accounts": [
17     {
18       "type": "checking",
19       "number": "83721",
20       "opening_balance": 1000,
21       "closing_balance": 1500,
22       "iso_currency_code": "USD"
23     }
24   ]
25 }

1	curl -X "POST" \
2	"https://api.ntropy.com/v3/bank_statements/7f8dceac-2848-472d-b5c3-55cdbaf35a9b/verify" \
3	-H "Accept: application/json" \
4	-H "X-API-KEY: cd1H...Wmhl"

1	{
2	"institution": "Well's Fargo",
3	"start_date": "2024-01-01",
4	"end_date": "2024-02-01",
5	"account_holder": {
6	"type": "consumer",
7	"name": "John Doe",
8	"address": {
9	"street": "601 Rosebud Avenue",
10	"postcode": "77901",
11	"city": "Victoria",
12	"state": "Texas",
13	"country": "United States"
14	}
15	},
16	"accounts": [
17	{
18	"type": "checking",
19	"number": "83721",
20	"opening_balance": 1000,
21	"closing_balance": 1500,
22	"iso_currency_code": "USD"
23	}
24	]
25	}