compute
POST /v1/compute/eligibility
Submit an organisation for verification.
認証
ベアラー トークンとして API キーを送信します。キーには billing.payment.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 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 "we… |
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… |
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