compute

POST `/v1/compute/eligibility/document`

Get a presigned upload slot for the ID-check document.

Authentication

Send an API key as a bearer token. The key must carry the billing.payment.manage permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/compute/eligibility/document \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "content_type": <string<image/jpeg, image/png, application/pdf>>, "size_bytes": <integer> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

The bytes go straight from the browser to the private identity-document bucket and never through the engine: PUT the file to upload.url with upload.headers before upload.expires_at, then submit the check. ⛔ Refused 422 unless an ID check is required and not already under review — an identity document nobody asked for is one we would be holding without a purpose. JPEG, PNG or PDF, up to 10 MB. 503 when document storage is not configured (nothing is stored). Requires billing.payment.manage.

Parameters

Name	Type	Required	What it is
`org_id (query)`	`Uuid`	No	—

Request body

Name	Type	Required	What it is
`content_type`	`string<image/jpeg, image/png, application/pdf>`	Yes	—
`size_bytes`	`integer`	Yes	—

Response

Name	Type	Required	What it is
`upload`	`object`	Yes	—

Errors this endpoint can return

401 · 403 · 422 · 429 · 503