v1

latestOpenAPI 3.1.02026-08-04127114.4 KB

Webhooks

Enrichment Notification Webhook

Non-data-rich Transaction Enrichment webhook. When transaction enrichment completes, you will receive a POST request containing a batch_request_id that you can use to fetch the enriched results.

This webhook type (ENRICHMENT_NOTIFICATION) sends only a notification with identifiers. You must fetch the actual enrichment data from /cleanup/{batch_request_id} endpoint using the provided batch_request_id.

Use this webhook type when you prefer smaller webhook payloads and want to fetch results on-demand.

postWebhookenrichmentNotification

Headers

X-Webhook-Verificationstring

A SHA-256 HMAC signature of the webhook payload that can be used to verify the authenticity of the webhook.

Payload

batch_request_idstring uuid

The ID of the request that this webhook is associated with.

client_idstring nullable

The ID of the client that this webhook is associated with.

tenant_idstring nullable

The ID of the tenant that this webhook is associated with, if the webhook is from a tenant environment.

Example payload

{
  "batch_request_id": "5f4b1b9b-4b7d-4b7d-4b7d-4b7d4b7d4b7d",
  "client_id": "client-123",
  "tenant_id": "TNT-5f4b1b9b-4b7d-4b7d-4b7d-4b7d4b7d4b7d"
}

Response

Success