compute
POST /v1/compute/eligibility
Submit an organisation for verification.
प्रमाणन
बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास billing.payment.manage अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।
जहां आपकी संगठन आईडी आती है
यह एंडपॉइंट org_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 कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव 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