Export

Base URL: $BUSINESS_API

The object

idstring · optional
statusstring · optional

one of queued, running, completed, failed

file_namestring · optional
size_bytesinteger · optional
sha256string · optional
audit_chain_verifiedboolean · optional
errorstring · optional
download_urlstring · optional
created_atstring (date-time) · optional
started_atstring (date-time) · optional
completed_atstring (date-time) · optional
The object
{
  "id": "com_2iGtfOIPN6mnFkwXXuCbD6uJj8K",
  "status": "queued",
  "file_name": "Ana Matsinhe",
  "size_bytes": 1,
  "sha256": "sha256",
  "audit_chain_verified": true,
  "error": "error",
  "download_url": "https://example.org/",
  "created_at": "2026-11-19T09:30:00Z",
  "started_at": "2026-11-19T09:30:00Z",
  "completed_at": "2026-11-19T09:30:00Z"
}

Queue an asynchronous compliance export

Logs

POST /export/compliance

Queues a ZIP package of all tenant data (tenant metadata, each dataset as CSV and JSON, the audit chain and its verification result, and a manifest with row counts) and returns the export record with status queued and 202. Only one export may be queued or running per tenant; another request returns 409. The request is recorded in the audit chain and remains allowed after the workspace is closed. Requires the compliance:export permission.

Returns

202 Queue an asynchronous compliance export

Show attributes
idstring · optional
statusstring · optional

one of queued, running, completed, failed

file_namestring · optional
size_bytesinteger · optional
sha256string · optional
audit_chain_verifiedboolean · optional
errorstring · optional
download_urlstring · optional
created_atstring (date-time) · optional
started_atstring (date-time) · optional
completed_atstring (date-time) · optional

Errors 400 · 401 · 403 · 409

Permissions compliance:export · Roles: admin, owner

curl -X POST "$BUSINESS_API/export/compliance" \
  -H "Authorization: Bearer sk_test_..."
Response 202
{
  "id": "com_2iGtfOIPN6mnFkwXXuCbD6uJj8K",
  "status": "queued",
  "file_name": "Ana Matsinhe",
  "size_bytes": 1,
  "sha256": "sha256",
  "audit_chain_verified": true,
  "error": "error",
  "download_url": "https://example.org/",
  "created_at": "2026-11-19T09:30:00Z",
  "started_at": "2026-11-19T09:30:00Z",
  "completed_at": "2026-11-19T09:30:00Z"
}

Get an export status

Logs

GET /export/compliance/status

Get an export status (latest, or by id)

Returns one compliance export, or the tenant's most recent one when no id is given, with status (queued, running, completed or failed), file name, size, SHA-256 digest, whether the audit chain verified and any error. download_url is set only once the export is completed. Returns 404 when no matching export exists; available after the workspace is closed. Requires the compliance:read permission.

Parameters

idstring · query · optional

Optional compliance export identifier; omit it to get the latest export of the tenant.

Returns

200 Get an export status (latest, or by id)

Show attributes
idstring · optional
statusstring · optional

one of queued, running, completed, failed

file_namestring · optional
size_bytesinteger · optional
sha256string · optional
audit_chain_verifiedboolean · optional
errorstring · optional
download_urlstring · optional
created_atstring (date-time) · optional
started_atstring (date-time) · optional
completed_atstring (date-time) · optional

Errors 400 · 401 · 403 · 404

Permissions compliance:read · Roles: admin, owner

curl -X GET "$BUSINESS_API/export/compliance/status" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "id": "com_2iGtfOIPN6mnFkwXXuCbD6uJj8K",
  "status": "queued",
  "file_name": "Ana Matsinhe",
  "size_bytes": 1,
  "sha256": "sha256",
  "audit_chain_verified": true,
  "error": "error",
  "download_url": "https://example.org/",
  "created_at": "2026-11-19T09:30:00Z",
  "started_at": "2026-11-19T09:30:00Z",
  "completed_at": "2026-11-19T09:30:00Z"
}

Download a completed compliance package

Logs

GET /export/compliance/{id}/download

Download a completed compliance package (ZIP)

Streams the completed package as application/zip with an attachment file name, or answers 302 with a short-lived presigned link when the file store supports it. Exports that are not completed return 404. Each download is recorded in the audit chain, and the endpoint stays available after the workspace is closed. Requires the compliance:read permission.

Parameters

idstring · path · required

Identifier of a completed compliance export in the current tenant.

Returns

200 Download a completed compliance package (ZIP)

Errors 400 · 401 · 403 · 404

Permissions compliance:read · Roles: admin, owner

curl -X GET "$BUSINESS_API/export/compliance/{id}/download" \
  -H "Authorization: Bearer sk_test_..."
Response 200

Download a completed compliance package (ZIP)