Ingest Transactions V2

This endpoint initiates a 'blocking' transaction ingestion and enrichment process. It will return partially enriched transactions and a Task ID which would then be used for finding out the current status of the full enrichment process. The complete enrichment services applied to the data will depend upon the relevant scopes assigned to your Client ID.

If a 'X-Disable-Synchronous' header is present and set to true, the process will be entirely 'non-blocking', with the returned Task ID providing access to the status of the full enrichment process.

There are a number of ingest schemas that can be used with this endpoint. These are described in the Body Params below. You will need to ensure the content-type header matches the schema used.

Note

Compared to the V1 ingest endpoints, the data validation is performed up-front. As such if this endpoints returns a 200 or 202 then the data is correctly formatted.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
Headers
string
required

The API Client Identifier (Service Application Identifier).

string
enum
required

Define the transactions' format for this request.

Allowed:
string
enum

If provided as true, the task will not be processed synchronously.

If false or the header is not included, the task will be processed synchronously.

Allowed:
Responses

401

Unauthorized (BearerToken in 'Authorization' header fails the authentication)

503

An unexpected error occurred on the enrichment server. Sync Only

504

An unexpected timeout occurred on the enrichment server. Sync Only

5XX

An unexpected error occurred on the server side

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json