Skip to main content
POST

Authorizations

X-API-Key
string
header
required

Public API key

Headers

Idempotency-Key
string
required

Required retry identity. X-Idempotency-Key is also accepted and must match when both are sent.

Required string length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]{1,64}$

Body

application/json
title
string
required

Raw transaction description from the bank statement.

Required string length: 1 - 256
country
string
required

ISO 3166-1 alpha-2 country code (e.g., US, GB, DE). Both upper and lowercase are accepted; the API normalizes to uppercase.

Pattern: ^[A-Za-z]{2}$
type
enum<string>
required
Available options:
expense,
income
options
object

Optional enrichment controls. Use filters to skip specific entity types, or pre-fill known entity data to improve accuracy and reduce latency.

Mutual exclusivity: a filter flag (e.g. noMerchant) cannot be combined with pre-filled data for the same entity type.

Response

Enrichment completed

success
enum<boolean>
required
Available options:
true
partial
boolean
required
data
object
required
meta
object
required