Skip to main content
This flow uploads one complete customer dataset. It creates three documents, one customer, one customer-linked account, one transaction, two outcomes, and one KYB dossier through the same routes used by every integration.

Prerequisites

  • A Karsa API base URL provisioned for your organization.
  • A source-bound bearer credential.
  • Stable source identifiers for the customer and related records.
  • Base64-encoded bytes and metadata for each document.
Start with https://api.sandbox.useasterisk.com and a sandbox credential, using synthetic data. Production uses https://api.useasterisk.com and a separately provisioned credential. See environment and credential boundaries.

Upload order

The dossier uses the Customer versionId returned by request 4 and the three Document versionId values. The account uses the Customer resourceId. The transaction uses the Account resourceId; both customer outcomes use the Customer resourceId. Every request includes Authorization, Idempotency-Key, and Content-Type headers. Each model page includes a complete cURL request and response. The API Reference contains the exact field contract and error responses.

What success looks like

  • 201 CREATED: the stable resource and first immutable version were created.
  • 200 VERSION_CREATED: the same source record received a changed immutable snapshot.
  • 200 UNCHANGED: the submitted snapshot already matches the current version.

Inspect the result

The tenant’s API page shows each accepted request, its route, status, and the fields that were present or omitted. The Customer record page shows the uploaded customer together with its linked documents, transaction, and outcomes.