compute

POST `/v1/compute/eligibility`

Submit an organisation for verification.

所有 compute 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 billing.payment.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

您的组织 ID 应填在此处

此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树；发送该参数则将调用范围缩小到一个组织。

您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

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

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

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.

参数

名称	类型	必填	内容简介
`org_id (query)`	`Uuid`	否	—

请求正文

名称	类型	必填	内容简介
`legal_name`	`string`	是	—
`country`	`string`	是	—
`abuse_contact_email`	`string`	是	—
`company_number`	`string`	否	—
`intended_use`	`string`	否	—

响应

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

此端点可能返回的错误

401 · 403 · 422 · 429