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 Account Holder API

Ledger operations

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

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

This API exposes 11 operations across 5 paths, and defines 27 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.

11 operations 5 paths 27 schemas 1 DELETE3 GET1 PATCH3 POST3 PUT

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 Account Holder API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (APIKeyHeader).

Paths & Operations 11

Across 5 paths, the API surfaces 11 operations — 1 DELETE, 3 GET, 1 PATCH, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Account Holder 11

Ledger operations

POST
/v2/account-holder
Create an account holder.
create_account_holder_v2_account_holder_post body → 200400422
GET
/v2/account-holder
Gets a list of the registered account holders
get_account_holders_v2_account_holder_get 7 params → 200422
PUT
/v2/account-holder/{account_holder_id}
Replace an existing account holder.
replace_account_holder_v2_account_holder__account_holder_id__put 1 param body → 200404422
GET
/v2/account-holder/{account_holder_id}
Retrieve the information of an account holder.
get_account_holder_v2_account_holder__account_holder_id__get 1 param → 200404422
PATCH
/v2/account-holder/{account_holder_id}
Renames an existing account-holder
patch_account_holder_v2_account_holder__account_holder_id__patch 1 param body → 200422
DELETE
/v2/account-holder/{account_holder_id}
Delete an account holder.
delete_account_holder_v2_account_holder__account_holder_id__delete 1 param → 200404422
GET
/v2/account-holder/{account_holder_id}/transactions
List transactions of an account holder.
get_account_holder_transactions_v2_account_holder__account_holder_id__transactions_get 5 params → 200400404422
POST
/v2/account-holder/{account_holder_id}/transactions
Get transactions of an account holder by transaction id.
get_account_holder_transactions_by_id_v2_account_holder__account_holder_id__transactions_post 5 params body → 200400404422
PUT
/v2/account-holder/{account_holder_id}/transactions
Correct any property for multiple transactions.
correct_transactions_v2_account_holder__account_holder_id__transactions_put 1 param body → 200404422
PUT
/v2/account-holder/{account_holder_id}/transactions/{transaction_id}
Correct any transaction property.
correct_transaction_v2_account_holder__account_holder_id__transactions__transaction_id__put 2 params body → 200404422
POST
/v2/account-holder/{account_holder_id}/recurring-payments
Identify existing recurring payments for an account holder's transaction history.
get_account_holder_recurring_payments_v2_account_holder__account_holder_id__recurring_payments_post 1 param → 200400404422

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are AccountHolderTransaction (24 properties), RecurringPaymentsGroup (21 properties), EnrichedTransaction (15 properties), AccountHolderWithCounts (13 properties). Each schema is shown below with its type and property counts.

ValidationError
object
3 properties 3 required
RecurringPaymentsGroup
object
Represents one recurring payments group for an account holder id
21 properties 12 required
Body_patch_account_holder_v2_account_holder__account_holder_id__patch
object
1 property 1 required
PayFrequency
string
TransactionType
string
AccountHolderCompany
object
2 properties 1 required
SortOrder
string
EntryType-Output
string
EnrichedTransactionCorrection
object
11 properties
ReviewState
string
LocationStructuredPublic
object
12 properties
EnrichedTransactionCorrectionList
object
2 properties 2 required
EnrichedTransaction
object
15 properties 1 required
PaginatedAccountHolderTransactions
object
2 properties
AccountHolderTransaction
object
24 properties 6 required
EntityOut
object
4 properties
AccountHolderCreate
object
6 properties 1 required
ntropy_server__schemas__account_holder__AccountHolder
object
12 properties 2 required
HTTPValidationError
object
1 property
AccountHolderWithCounts
object
13 properties 2 required
Status
string
AccountHolderWrite
object
5 properties 1 required
ntropy_core__db__account_holder_type__AccountHolderType
string
RecurrenceGroup
object
9 properties 1 required
LoanState
string
RecurrenceType
string
EmptyResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ntropy-account-holder-api-openapi.yml Raw ↑

Other APIs Ntropy publishes across the network.

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