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

Transaction enrichment.

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

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

This API exposes 3 operations across 3 paths, and defines 14 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.

3 operations 3 paths 14 schemas 1 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 Enrichment API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (APIKeyHeader).

Paths & Operations 3

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

Enrichment 3

Transaction enrichment.

POST
/v2/transactions/sync
Enrich and add transactions to the ledger of account holders synchronously.
enrich_transactions_sync_v2_transactions_sync_post body → 200400404422
POST
/v2/transactions/async
Enrich and add transactions to the ledger of account holders asynchronously.
enrich_transactions_async_v2_transactions_async_post body → 202400404422
GET
/v2/transactions/async/{id}
Fetch the result of a batch transaction enrichment.
get_async_enrichment_result_v2_transactions_async__id__get 1 param → 200404422

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are EnrichedTransaction (15 properties), Transaction (12 properties), LocationStructuredPublic (12 properties), RecurrenceGroup (9 properties). Each schema is shown below with its type and property counts.

EntityOut
object
4 properties
Transaction
object
A transaction
12 properties 6 required
TransactionError
object
Transaction that returned with error.
3 properties 2 required
HTTPValidationError
object
1 property
ValidationError
object
3 properties 3 required
BatchStatus
string
LocationStructuredPublic
object
12 properties
EnrichedTransaction
object
15 properties 1 required
MissingAccountHoldersError
object
2 properties
RecurrenceGroup
object
9 properties 1 required
ntropy_core__db__account_holder_type__AccountHolderType
string
RecurrenceType
string
TransactionType
string
BatchResult
object
Batch transaction enrichment status.
7 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ntropy-enrichment-api-openapi.yml Raw ↑

Other APIs Ntropy publishes across the network.

Ntropy Account Holder API
Ntropy accountHolders API
Ntropy Bank statements API
Ntropy bankStatements API
Ntropy batches API
Ntropy categories API
Ntropy entities API
Ntropy Labels API
Ntropy Misc API
Ntropy personalization API
Ntropy recurrence API
Ntropy Reporting API