How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.ntropy.com.

8 operations 5 paths 26 schemas 1 DELETE5 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.ntropy.com
Authentication
API Key
Resource Areas
1

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.

Bank statements 8

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…

POST
/datasources/bank_statements
Submit a bank statement PDF for OCR and enrichment
_post_bank_statement_datasources_bank_statements_post 3 params body → 200401415500413429422
GET
/datasources/bank_statements
Check paginated processing status for bank statements
_get_bank_statements_datasources_bank_statements_get 6 params → 200401404500422
GET
/datasources/bank_statements/{uuid}
Check processing status for a bank statement
_get_bank_statement_datasources_bank_statements__uuid__get 1 param → 200401404500422
DELETE
/datasources/bank_statements/{uuid}
Delete a bank statement
_delete_bank_statement_datasources_bank_statements__uuid__delete 1 param → 200401404500422
PATCH
/datasources/bank_statements/{uuid}
Change information of an existing bank statement
patch_statement_datasources_bank_statements__uuid__patch 1 param body → 200401404500422
GET
/datasources/bank_statements/{uuid}/transactions
Gets the enriched transactions for a bank statement
get_bank_statement_transactions_datasources_bank_statements__uuid__transactions_get 5 params → 200401404500422
GET
/datasources/bank_statements/{uuid}/statement-info
Extracts bank and account details for instant file verification and UI enhancements.
get_bank_statement_statement_info_datasources_bank_statements__uuid__statement_info_get 1 param → 200401404500422
GET
/datasources/bank_statements/{uuid}/results
Get Bank Statement Results
_get_bank_statement_results_datasources_bank_statements__uuid__results_get 1 param → 200401404500422

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.

SortOrder
string
StatementInfo
object
5 properties
RecurrenceGroup
object
9 properties 1 required
RecurrenceType
string
BankStatementStatement
object
7 properties
BankStatementExternal
object
14 properties 5 required
BankStatementResults
object
1 property 1 required
Account
object
5 properties
ValidationError
object
3 properties 3 required
BankStatementTransaction
object
8 properties 6 required
LocationStructuredPublic
object
12 properties
DocumentStatus
string
BankStatementFile
object
2 properties 2 required
BankStatementAccount
object
9 properties 1 required
AccountType
string
BankStatementBankAccount
object
4 properties
Address
object
5 properties
Body_patch_statement_datasources_bank_statements__uuid__patch
object
1 property 1 required
Body__post_bank_statement_datasources_bank_statements_post
object
1 property 1 required
TransactionType
string
EntityOut
object
4 properties
HTTPValidationError
object
1 property
AccountHolderTransactionWithErrors
object
26 properties 6 required
ntropy_core__db__statements__AccountHolder
object
3 properties
ntropy_core__db__account_holder_type__AccountHolderType
string
EntryType-Output
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ntropy-bank-statements-api-openapi.yml Raw ↑

Other APIs Ntropy publishes across the network.

Ntropy Account Holder API
Ntropy accountHolders API
Ntropy bankStatements API
Ntropy batches API
Ntropy categories API
Ntropy Enrichment API
Ntropy entities API
Ntropy Labels API
Ntropy Misc API
Ntropy personalization API
Ntropy recurrence API
Ntropy Reporting API
Where this information came from

This is an independent, third-party profile of Ntropy Bank statements API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.