KausateKausate Docs
Viewing API version 2025-04-01. View the latest version.

Async & Sync Processing

Async and sync request patterns for API version 2025-04-01

This page documents API version 2025-04-01. In this version, the company identifier is part of the URL and synchronous execution uses ?sync=true.

Registry-backed requests can run asynchronously or synchronously. Async mode is recommended for production because registry timeouts and maintenance windows do not hold the client connection open.

Async request

Call the operation without sync=true. The API returns an orderId immediately:

curl -X POST https://api.kausate.com/v2/companies/co_de_7KGHtucR88u2omSx3KhaoH/report \
  -H "X-API-Key: your_api_key" \
  -H "Kausate-Version: 2025-04-01" \
  -H "Content-Type: application/json" \
  -d '{"customerReference": "kyc-check-456"}'

Poll the workflow-family run endpoint returned by the operation, or configure a webhook to receive the completed ExecutionResponse.

curl https://api.kausate.com/v2/companies/report/runs/ord_xyz789 \
  -H "X-API-Key: your_api_key" \
  -H "Kausate-Version: 2025-04-01"

Sync request

Append ?sync=true to the same operation URL. The request waits up to five minutes and returns the completed result inline:

curl -X POST "https://api.kausate.com/v2/companies/co_de_7KGHtucR88u2omSx3KhaoH/report?sync=true" \
  -H "X-API-Key: your_api_key" \
  -H "Kausate-Version: 2025-04-01" \
  -H "Content-Type: application/json" \
  -d '{"customerReference": "kyc-check-456"}'

Sync mode is intended for testing and one-off requests. Production systems should use async requests with webhooks or polling.

Daily deduplication

Equivalent requests on the same UTC day reuse the existing order. Set bypassCache: true in the request body when a fresh registry request is required.

Last updated on

On this page