compute

POST `/v1/compute/eligibility`

Submit an organisation for verification.

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie billing.payment.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Miejsce na identyfikator organizacji

Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.

Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

Nazwa	Typ	Wymagane	Co to jest
`org_id (query)`	`Uuid`	Nie	—

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`legal_name`	`string`	Tak	—
`country`	`string`	Tak	—
`abuse_contact_email`	`string`	Tak	—
`company_number`	`string`	Nie	—
`intended_use`	`string`	Nie	—

Odpowiedź

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

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 422 · 429