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 | ⛔ Four states, not a boolean. `not_requested` and `rejected` both refuse an order and the customer's next action differs completely: one is "tell us who you are", the other is "… |
may_order | boolean | Yes | True only in `verified`. Read this rather than re-deriving it from `state`. |
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 wit… |
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