Skip to content
WardenTrace
Developer resourcesIngest API
Open dashboard

Get started

Your first API request

Send customer and transaction files from your backend. Learn how to format your data, send it securely, and confirm which records were added to WardenTrace.

This is a file-ingestion API, not a general-purpose API for operational records. It accepts multipart files, not JSON records.

  1. Get your connection details

    Ask WardenTrace for your environment URL and ingest key. Confirm whether automatic application and monitoring are enabled for your key. Keep production credentials in your backend secret manager.

    Authentication
  2. Send customers, then transactions

    Start with the customer template. Use upsert for customer refreshes. Apply customers before sending transactions that reference them. Give each file a stable Idempotency-Key.

    POST /api/ingest
  3. Verify your delivery

    Save the uploadId from the response, then check delivery status with that ID. If it appears in appliedUploadIds, your records were applied. HTTP 200 alone does not confirm application or monitoring.

    GET /api/ingest/status
Download a template

Templates include synthetic example data. Replace it before your real delivery.

Accepted does not always mean applied

Without an auto-apply grant, a clean file waits in Data → Upload history. An authorised person must apply it using the original file. Transaction Monitoring is a separate, asynchronous step.

Understand the delivery lifecycle