Ntropy Bank statements API
The bank statements API allows you to view and enrich transactions found in bank statements. Below is a table withthe description of each of the statuses and steps that each bank statement goes through:| Status | Description ||----------|----------------------------------------------------------------||QUEUED |The document is queued for processing ||PROCESSING|OCR is in progress ||PROCESSED |The document was successfully processed ||FAILED |An error occurred during processing of any of the previous steps|A list of error codes for the `FAILED` status can be found below:|Code| Description ||---:|------------------------------------------------|| 301|Failed to parse document as bank statement. || 301|Failed to enrich transactions in bank statement.|| 500|Unexpected error. Please contact support. |
Ntropy Bank statements API is one of 16 APIs that Ntropy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Bank statements. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 8 operations across 5 paths, and defines 26 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against a single base URL, https://api.ntropy.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Ntropy Bank statements API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-Api-Key (APIKeyHeader).
Paths & Operations 8
Across 5 paths, the API surfaces 8 operations — 1 DELETE, 5 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
The bank statements API allows you to view and enrich transactions found in bank statements. Below is a table with the description of each of the statuses and steps that each bank…
Schemas 26
The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are AccountHolderTransactionWithErrors (26 properties), BankStatementExternal (14 properties), LocationStructuredPublic (12 properties), RecurrenceGroup (9 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Ntropy 12
Other APIs Ntropy publishes across the network.