compute

POST `/v1/compute/eligibility`

Submit an organisation for verification.

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს billing.payment.manage ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.

სwhere your organisation id goes-ის ადგილი

ეს ენდპოინტი იყენებს პარამეტრად org_id. მისი გამოტოვების შემთხვევაში ზარი ფარავს თქვენი იჯარის მთელ ქვეხეს, ხოლო გაგზავნისას ზარი შეიზღუდება მხოლოდ ერთ ორგანიზაციამდე.

თქვენი ორგანიზაციის ID მითითებულია თქვენი სამართავი პანელის API გასაღებების ეკრანზე, თავად გასაღებთან ახლოს. ის ერთნაირია თქვენ მიერ განხორციელებულ ყველა გამოძახებაში.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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

POST /v1/compute/eligibility