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

التفاصيل

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

POST /v1/compute/eligibility