compute
POST /v1/compute/eligibility
Submit an organisation for verification.
Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Кілтте billing.payment.manage рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.
Ұйымыңыздың идентификаторы орналасатын жер
Бұл соңғы нүкте сұрау параметрі ретінде 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.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
org_id (query) | Uuid | Жоқ | — |
Сұрау денесі
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
legal_name | string | Иә | — |
country | string | Иә | — |
abuse_contact_email | string | Иә | — |
company_number | string | Жоқ | — |
intended_use | string | Жоқ | — |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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