compute
POST /v1/compute/eligibility
Submit an organisation for verification.
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 \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "legal_name": <string>, "country": <string>, "abuse_contact_email": <string> }'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
Moves the organisation to pending for a human to review. 202, because the answer is a decision somebody makes rather than something this call performs. ⛔ An organisation that is already verified, or already pending, is refused 422 rather than silently re-queued: resubmitting would otherwise let a customer suspend their own verification, and let a rejected applicant re-enter the queue for ever. Requires billing.payment.manage — ⛔ not billing.entitlement.manage, a staff key no customer role holds, which is what this said until D10689.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
legal_name | string | Yes | — |
country | string | Yes | — |
abuse_contact_email | string | Yes | — |
company_number | string | No | — |
intended_use | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
state | string<not_requested, pending, verified, rejected> | Yes | The ID check's own state. ⛔ Four states, not a boolean: not_requested and rejected differ completely — one is "tell us who you are" (only when id_check_required), the other… |
blockers | string<no_owner, email_unverified, card_required, id_check_required, id_check_pending, id_check_rejected>[] | Yes | What stands between the account and a server, in the order it can act on them. Empty exactly when may_order is true. |
email_verified | boolean | Yes | Whether an owner of the organisation has a verified email address. |
card_verified | boolean | Yes | Whether a card confirmed with the issuer (a succeeded setup) is on the account, in date and chargeable. A PayPal agreement or a crypto balance is not a card. |
has_owner | boolean | Yes | Whether the organisation has an owner membership at all. A platform or reseller-created organisation can have none, and the first-server steps are about an owner — so no_owner… |
id_check_required | boolean | Yes | Whether an ID check stands between the account and its next server. False for almost every account — it is raised only by a fraud signal or by staff. |
id_document_uploaded | boolean | Yes | Whether an identity document has been registered for the check. |
standing | string<new, established, custom> | Yes | Which limits apply. new until the account is 30 days old and has paid for something; custom when staff set this account's limits. |
limits | ComputeLimits | Yes | What one account may run at once on our cloud. |
usage | ComputeUsage | Yes | What the account runs now, measured the way ComputeLimits bounds it. |
may_order | boolean | Yes | True exactly when blockers is empty. Read this rather than re-deriving it. |
legal_name | string | Yes | The legal name of whoever is responsible for the machines. |
country | string | Yes | ISO-3166-1 alpha-2 country of the person or the incorporation. |
company_number | string | Yes | Company registration number, or "" for an individual — a real answer. |
abuse_contact_email | string | Yes | A monitored address an abuse report can be forwarded to and answered from. We are the account holder of record, so a complaint reaches us first and has to reach the customer… |
intended_use | string | Yes | What the customer says the machines are for, in their own words. |
rejection_reason | string | Yes | Shown to the customer verbatim when state is rejected. |
submitted_at | string | Yes | — |
reviewed_at | string | Yes | — |
Errors this endpoint can return
401 · 403 · 422 · 429