compute

POST `/v1/compute/eligibility`

Submit an organisation for verification.

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění billing.payment.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Parametry

Název	Typ	Požadováno	Co to je
`org_id (query)`	`Uuid`	Ne	—

Tělo požadavku

Název	Typ	Požadováno	Co to je
`legal_name`	`string`	Ano	—
`country`	`string`	Ano	—
`abuse_contact_email`	`string`	Ano	—
`company_number`	`string`	Ne	—
`intended_use`	`string`	Ne	—

Odpověď

Název	Typ	Požadováno	Co to je
`state`	`string<not_requested, pending, verified, rejected>`	Ano	⛔ 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`	Ano	True only in `verified`. Read this rather than re-deriving it from `state`.
`legal_name`	`string`	Ano	The legal name of whoever is responsible for the machines.
`country`	`string`	Ano	ISO-3166-1 alpha-2 country of the person or the incorporation.
`company_number`	`string`	Ano	Company registration number, or `""` for an individual — a real answer.
`abuse_contact_email`	`string`	Ano	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`	Ano	What the customer says the machines are for, in their own words.
`rejection_reason`	`string`	Ano	Shown to the customer verbatim when `state` is `rejected`.
`submitted_at`	`string`	Ano	—
`reviewed_at`	`string`	Ano	—

Chyby, které může tento koncový bod vrátit

401 · 403 · 422 · 429