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

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

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

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

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

entities 4
GET
/v3/entities/{id}
Retrieve an entity
get-entity-by-id-v-3-entities-id-get 2 params → 200400404422
POST
/v3/entities/resolve
Resolves an entity
search-entity-v-3-entities-resolve-post 1 param body → 200400422423
GET
/v2/entities
Search for entities
search_entity_v2_entities_get 3 params → 200400423422
GET
/v2/entities/{id}
Retrieve an entity by its ID
get_entity_by_id_v2_entities__id__get 1 param → 200400404422

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are LocationStructured (12 properties), LocationStructuredPublic (12 properties), EntityResponse (10 properties), EntitySearchOut (7 properties). Each schema is shown below with its type and property counts.

ValidationErrorLocItems
EntityResponse
object
10 properties
HTTPValidationError
object
1 property
ValidationError_2
object
3 properties 3 required
EntitySearchOut
object
7 properties
ValidationError
object
3 properties 3 required
EntityQuery
object
3 properties
LocationStructured
object
12 properties
LocationStructuredPublic
object
12 properties
Location
object
2 properties
EntityParent
object
6 properties
HTTPValidationError_2
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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