compute
POST /v1/compute/eligibility
Submit an organisation for verification.
Autentificare
Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea billing.payment.manage; o cheie care nu o are va fi respinsă cu 403, nu 404.
Unde merge ID-ul organizației tale
Acest punct final acceptă org_id ca parametru de interogare. Omiteți-l și apelul va acoperi întregul subarbore al chiriașului dvs.; trimiteți-l pentru a restrânge apelul la o singură organizație.
ID-ul organizației tale se află pe ecranul cheilor API din panoul de control, lângă cheia însăși. Este același ID în fiecare apel pe care îl faci.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
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> }'Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
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.
Parametri
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
org_id (query) | Uuid | Nu | — |
Corp cerere
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
legal_name | string | Da | — |
country | string | Da | — |
abuse_contact_email | string | Da | — |
company_number | string | Nu | — |
intended_use | string | Nu | — |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
state | string<not_requested, pending, verified, rejected> | Da | ⛔ 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 | Da | True only in `verified`. Read this rather than re-deriving it from `state`. |
legal_name | string | Da | The legal name of whoever is responsible for the machines. |
country | string | Da | ISO-3166-1 alpha-2 country of the person or the incorporation. |
company_number | string | Da | Company registration number, or `""` for an individual — a real answer. |
abuse_contact_email | string | Da | 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 | Da | What the customer says the machines are for, in their own words. |
rejection_reason | string | Da | Shown to the customer **verbatim** when `state` is `rejected`. |
submitted_at | string | Da | — |
reviewed_at | string | Da | — |
Erori pe care le poate returna acest punct final
401 · 403 · 422 · 429