compute

POST `/v1/compute/eligibility`

Submit an organisation for verification.

Pagpapatotoo

Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na billing.payment.manage; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.

Kung saan mapupunta ang id ng iyong organisasyon

Tinatanggap ng endpoint na ito ang org_id bilang parameter ng query. Huwag itong isama at saklaw ng tawag ang buong subtree ng iyong tenancy; ipadala ito para paliitin ang tawag sa isang organisasyon.

Ang id ng iyong organisasyon ay nasa screen ng mga API key sa iyong dashboard, sa tabi mismo ng key. Ito ang parehong id sa bawat tawag na gagawin mo.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong 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> }'

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

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.

Mga Parameter

Pangalan	Uri	Kailangan	Ano ito
`org_id (query)`	`Uuid`	Hindi	—

Katawan ng kahilingan

Pangalan	Uri	Kailangan	Ano ito
`legal_name`	`string`	Oo	—
`country`	`string`	Oo	—
`abuse_contact_email`	`string`	Oo	—
`company_number`	`string`	Hindi	—
`intended_use`	`string`	Hindi	—

Tugon

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

Mga error na maibabalik ng endpoint na ito

401 · 403 · 422 · 429