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

The batches API from Ntropy — 3 operation(s) for batches.

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

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

This API exposes 4 operations across 3 paths, and defines 26 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 3 paths 26 schemas 3 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 batches 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 3 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

batches 4
POST
/v3/batches
Submit a batch of requests
post-batch-v-3-batches-post 1 param body → 200422
GET
/v3/batches
List all batches
get-batches-v-3-batches-get 6 params → 200422
GET
/v3/batches/{id}
Retrieve a batch
get-single-batch-v-3-batches-id-get 2 params → 200404422
GET
/v3/batches/{id}/results
Retrieve the results of a batch
get-batch-results-v-3-batches-id-results-get 2 params → 200404422

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are LocationStructured (12 properties), Counterparty (10 properties), Intermediary (9 properties), TransactionInput (8 properties). Each schema is shown below with its type and property counts.

TransactionError
object
2 properties 2 required
ValidationError
object
3 properties 3 required
BatchInput
object
2 properties 2 required
Location
object
2 properties
LocationInput
object
Location of where the transaction has taken place. This can greatly improve entity identification, especially under ambiguity.
2 properties
TransactionInput
object
8 properties 6 required
CounterpartyType
string
Batch
object
The Batch object represents the status and progress of an asynchronous batch enrichment job.
7 properties 7 required
BatchOperation
string
PagedResponse_Batch
object
2 properties 2 required
Country
string
Intermediary
object
9 properties
EntityParent
object
6 properties
Counterparty
object
10 properties 1 required
EntryType
string
EnrichedTransaction
object
6 properties 2 required
Currency
string
Categories
object
2 properties 1 required
BatchResult
object
The BatchResult object represents the result of a batch enrichment job, including its status and enriched transactions.
4 properties 4 required
ValidationErrorLocItems
HTTPValidationError
object
1 property
BatchStatus
string
AccountingCategory
string
TransactionErrorCode
string
LocationStructured
object
12 properties
Entities
object
Entities found by identity identification
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ntropy-batches-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 categories API
Ntropy Enrichment API
Ntropy entities API
Ntropy Labels API
Ntropy Misc API
Ntropy personalization API
Ntropy recurrence API
Ntropy Reporting API