Supported Interfaces
API, Kafka, and SFTP options for regular series detection and batch run results.
Regular series batch detection runs at 5,000 TPS (approximately 3.5 accounts / second with a 1-year history) as standard.
You need at least 3 months of transactions for an account before regular series start being detected.
| Interface | Use Case |
|---|---|
| API | Low-frequency retrievals of batch-run results for a single account. |
| Apache Kafka | Full batch run results transfer |
| SFTP | Full batch run results transfer |
Interface Considerations
API
This interface is only for retrieving the series for an account or user.
The API reference is available here.
Apache Kafka
We connect to your Kafka broker, which hosts the topics where we write regular series detection results and (optionally) trigger affordability reports. Alternatively, we offer an Apache Kafka service, enabling you to produce and consume messages on its topics.
Encryption through TLS, and we authenticate with your broker via two-way TLS (mTLS) or SASL.
The detect and result message schemas are detailed here. Configuration options for orchestrator batching (per account vs per user on the detect topic) and automatic affordability triggering are described in the Configuration section of that document, and summarised in List of configurable features.
SFTP
We host an SFTP server where we output the regular series detection results.
Updated 15 days ago
