Get the machine-checkable residency assertion
Returns Dairo's data-residency posture as a machine-checkable JSON object your compliance automation can assert on in CI.
Returns Dairo's data-residency posture as a machine-checkable JSON object your compliance automation can assert on in CI. The response reports the primary region, an EU data-residency assertion with no cross-region egress, the controlling legal entity, an honest US CLOUD Act posture (cloudActExposed plus the specific US-incorporated subprocessors it applies to), and the full active subprocessor list. subprocessorListVersion is a monotonically increasing integer and subprocessorListUpdatedAt its last-change timestamp — pin the version in a test and it only moves when the list actually changes. checkedAt timestamps the response, and the subprocessor list is organization-wide rather than key-specific. Requires the account:read scope.
Scope: account:read. Send the API key as a bearer token; Scopes lists what each one reaches.
Request
Response
200 Success. Body: application/json, ResidencyResponse.
| Field | Type | Required | Description |
|---|---|---|---|
type | string | yes | |
primaryRegion | string | yes | |
dataResidency | string | yes | |
noUsEgress | boolean | yes | |
controllerParent | string | no | |
cloudActExposed | boolean | no | |
enforcement | object | no | |
subprocessors | array of Subprocessor | yes | |
subprocessorListVersion | integer | yes | |
subprocessorListUpdatedAt | string (date-time) or null | no | |
checkedAt | string (date-time) | yes |
Errors
Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.
| Status | Meaning |
|---|---|
400 | The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch). |
401 | The API key is missing or invalid. |
403 | The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted). |
404 | No such resource in this account (resource_not_found). |
422 | The request is well-formed but a field failed validation (validation_failed). |
429 | Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached). |
500 | An unexpected error; retry with backoff, then contact support (internal_error). |
Get the letter layout spec and starter templates
Returns the machine-readable compliance spec for physical letters: the exact A4 geometry (address windows, franking/edge/corner keep-outs, all in mm from the top-left corner), the PDF rules (embed fonts, no encryption, A4 portrait), the recommended verify→price→dryRun→send workflow, and ready-made COMPLIANT starter templates whose html can be stored via POST /v1/letters/templates verbatim.
Export the tamper-evident hash-chained audit ledger
Returns the caller's audit-log rows in ascending chainSeq order — each row carrying a prevHash and rowHash that link it to the one before — together with an EdDSA-signed manifest committing to the window bounds, rowCount, and head rowHash.