Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ntropy bankStatements API

The bankStatements API from Ntropy — 4 operation(s) for bankstatements.

Ntropy bankStatements API is one of 16 APIs that Ntropy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include bankStatements. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, and defines 21 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.

6 operations 4 paths 21 schemas 1 DELETE3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Ntropy bankStatements API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (APIKeyHeader).

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

bankStatements 6
POST
/v3/bank_statements
Submit a bank statement PDF
post-bank-statement-v-3-bank-statements-post 1 param body → 200422
GET
/v3/bank_statements
List all bank statements
get-bank-statements-v-3-bank-statements-get 6 params → 200422
GET
/v3/bank_statements/{id}
Retrieve a bank statement
get-bank-statement-v-3-bank-statements-id-get 2 params → 200404422
DELETE
/v3/bank_statements/{id}
Deletes a bank statement
delete-bank-statement-v-3-bank-statements-id-delete 2 params → 204404422
GET
/v3/bank_statements/{id}/results
Retrieve the extraction results
get-bank-statement-result-v-3-bank-statements-id-results-get 2 params → 200404422
POST
/v3/bank_statements/{id}/verify
Quickly extract account holder, institution and first account
get-bank-statement-statement-info-v-3-bank-statements-id-verify-post 2 params → 200404422

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are BankStatementAccount (10 properties), BankStatementTransaction (8 properties), BankStatement (6 properties), Address (5 properties). Each schema is shown below with its type and property counts.

ValidationError
object
3 properties 3 required
BankStatementFile
object
2 properties 1 required
BankStatementTransaction
object
8 properties 6 required
BankStatement
object
Represents a bank statement with details about the file and its status.
6 properties 4 required
Address
object
5 properties
PagedResponse_BankStatement
object
2 properties 2 required
DocumentStatus
string
Account
object
5 properties
EntryType
string
BankStatementAccount
object
10 properties 1 required
BankStatementError
object
2 properties 2 required
Currency
string
StatementInfo
object
5 properties
ValidationErrorLocItems
HTTPValidationError
object
1 property
BankStatementResults
object
1 property 1 required
AccountHolder
object
3 properties
AccountType
string
BankStatementStatus
string
Bank statements_delete_bank_statement_v3_bank_statements__id__delete_Response_204
object
Empty response body
BankStatementErrorCode
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ntropy-bankstatements-api-openapi.yml Raw ↑

Other APIs Ntropy publishes across the network.

Ntropy Account Holder API
Ntropy accountHolders API
Ntropy Bank statements 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