compute
POST /v1/compute/eligibility
Submit an organisation for verification.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso billing.payment.manage; una clave que no lo tenga se rechazará con un código 403, no 404.
Donde va el ID de tu organización
Este endpoint acepta org_id como parámetro de consulta. Omítelo y la llamada abarcará todo tu subárbol de inquilinos; envíalo para acotar la llamada a una sola organización.
El id de tu organización se encuentra en la pantalla de claves de API en tu panel de control, junto a la propia clave. Es el mismo id en cada llamada que realices.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
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> }'¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
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.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
org_id (query) | Uuid | No | — |
Cuerpo de la solicitud
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
legal_name | string | Sí | — |
country | string | Sí | — |
abuse_contact_email | string | Sí | — |
company_number | string | No | — |
intended_use | string | No | — |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
state | string<not_requested, pending, verified, rejected> | Sí | ⛔ 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 | Sí | True only in `verified`. Read this rather than re-deriving it from `state`. |
legal_name | string | Sí | The legal name of whoever is responsible for the machines. |
country | string | Sí | ISO-3166-1 alpha-2 country of the person or the incorporation. |
company_number | string | Sí | Company registration number, or `""` for an individual — a real answer. |
abuse_contact_email | string | Sí | 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 | Sí | What the customer says the machines are for, in their own words. |
rejection_reason | string | Sí | Shown to the customer **verbatim** when `state` is `rejected`. |
submitted_at | string | Sí | — |
reviewed_at | string | Sí | — |
Errores que este endpoint puede devolver
401 · 403 · 422 · 429