compute
POST /v1/compute/eligibility
Submit an organisation for verification.
การยืนยันตัวตน
ส่ง API key ในรูปแบบ bearer token คีย์ดังกล่าวต้องมีสิทธิ์ billing.payment.manage หากไม่มีสิทธิ์ ระบบจะปฏิเสธด้วยรหัส 403 แทนที่จะเป็น 404
ตำแหน่งสำหรับใส่รหัสองค์กรของคุณ
พอยต์ข้อมูลนี้รับ org_id เป็นพารามิเตอร์คิวรี หากเว้นว่างไว้ การเรียกใช้งานจะครอบคลุมย่อยของเทแนนท์ทั้งหมดของคุณ แต่หากระบุค่า จะช่วยจำกัดขอบเขตการเรียกให้เหลือเพียงองค์กรเดียว
รหัสองค์กรของคุณจะแสดงอยู่บนหน้าคีย์ API ในแดชบอร์ดของคุณ โดยอยู่ถัดจากคีย์นั้นๆ รหัสนี้จะเป็นรหัสเดิมในการเรียกใช้งานทุกครั้งของคุณ
ทดลองใช้เลย
แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ
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 ในแดชบอร์ดของคุณจะเติมรหัสองค์กรจริงและคีย์ของคุณเองโดยอัตโนมัติ และทำการส่งคำขอไปยัง 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> | ใช่ | The ID check's own state. ⛔ Four states, not a boolean: not_requested and rejected differ completely — one is "tell us who you are" (only when id_check_required), the other… |
blockers | string<email_unverified, card_required, id_check_required, id_check_pending, id_check_rejected>[] | ใช่ | What stands between the account and a server, in the order it can act on them. Empty exactly when may_order is true. |
email_verified | boolean | ใช่ | Whether an owner of the organisation has a verified email address. |
card_verified | boolean | ใช่ | Whether a card confirmed with the issuer (a succeeded setup) is on the account, in date and chargeable. A PayPal agreement or a crypto balance is not a card. |
id_check_required | boolean | ใช่ | Whether an ID check stands between the account and its next server. False for almost every account — it is raised only by a fraud signal or by staff. |
id_document_uploaded | boolean | ใช่ | Whether an identity document has been registered for the check. |
standing | string<new, established, custom> | ใช่ | Which limits apply. new until the account is 30 days old and has paid for something; custom when staff set this account's limits. |
limits | ComputeLimits | ใช่ | What one account may run at once on our cloud. |
usage | ComputeUsage | ใช่ | What the account runs now, measured the way ComputeLimits bounds it. |
may_order | boolean | ใช่ | True exactly when blockers is empty. Read this rather than re-deriving it. |
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