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 accountHolders API

The accountHolders API from Ntropy — 2 operation(s) for accountholders.

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

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

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

4 operations 2 paths 8 schemas 1 DELETE2 GET1 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 accountHolders API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (APIKeyHeader).

Paths & Operations 4

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

accountHolders 4
POST
/v3/account_holders
Create an account holder.
create-account-holder-v-3-account-holders-post 1 param body → 200400422
GET
/v3/account_holders
List all account holders.
get-account-holders-v-3-account-holders-get 5 params → 200422
GET
/v3/account_holders/{id}
Retrieve an account holder.
get-account-holder-v-3-account-holders-id-get 2 params → 200404422
DELETE
/v3/account_holders/{id}
Deletes an account holder and their transactions
delete-account-holder-v-3-account-holders-id-delete 2 params → 204404422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are AccountHolderExternal (5 properties), AccountHolderCreate (4 properties), ValidationError (3 properties), PagedResponse_AccountHolderExternal (2 properties). Each schema is shown below with its type and property counts.

AccountHolderCreate
object
4 properties 2 required
ValidationErrorLocItems
HTTPValidationError
object
1 property
ValidationError
object
3 properties 3 required
PagedResponse_AccountHolderExternal
object
2 properties 2 required
AccountHolderExternal
object
5 properties 3 required
AccountHolderType
string
Account Holders_delete_account_holder_v3_account_holders__id__delete_Response_204
object
Empty response body

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ntropy-accountholders-api-openapi.yml Raw ↑

Other APIs Ntropy publishes across the network.

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