Elliptic Customers API
The customers endpoints are used to manage customers which you have associated analysis with, via the `customer_reference` analysis subject attribute.Currently, the customers endpoints only refer to customers with [Transaction Analysis](#tag/Transaction-Analyses).Customers with only [Wallet Analysis](#tag/Wallet-Analyses) will not yield responses from these endpoints
Elliptic Customers API is one of 16 APIs that Elliptic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and rate-limit docs.
This API exposes 6 operations across 6 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.
Requests are made against a single base URL, https://aml-api.elliptic.co/v2.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Elliptic Customers API declares
4 security schemes
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 2 scopes.
An API key is passed in the header as x-access-key (apiKey).
An API key is passed in the header as x-access-sign (signature).
An API key is passed in the header as x-access-timestamp (timestamp).
By default, every request must be authenticated.
apiKey— API Keysignature— (Request Time, HTTP Method, Lowercase Path, Request Payload) signed with API Secret
Paths & Operations 6
Across 6 paths, the API surfaces 6 operations — 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
The customers endpoints are used to manage customers which you have associated analysis with, via the customerreference analysis subject attribute. Currently, the customers endpoi…
Schemas 10
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Customer (13 properties), ErrorResponse (4 properties), CustomerTxInfo (3 properties), NotFoundError (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elliptic 12
Other APIs Elliptic publishes across the network.