compute

POST `/v1/compute/eligibility`

Submit an organisation for verification.

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation billing.payment.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Où insérer l'ID de votre organisation

Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.

L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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> }'

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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.

Paramètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`org_id (query)`	`Uuid`	Non	—

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`legal_name`	`string`	Oui	—
`country`	`string`	Oui	—
`abuse_contact_email`	`string`	Oui	—
`company_number`	`string`	Non	—
`intended_use`	`string`	Non	—

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`state`	`string<not_requested, pending, verified, rejected>`	Oui	⛔ 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`	Oui	True only in `verified`. Read this rather than re-deriving it from `state`.
`legal_name`	`string`	Oui	The legal name of whoever is responsible for the machines.
`country`	`string`	Oui	ISO-3166-1 alpha-2 country of the person or the incorporation.
`company_number`	`string`	Oui	Company registration number, or `""` for an individual — a real answer.
`abuse_contact_email`	`string`	Oui	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`	Oui	What the customer says the machines are for, in their own words.
`rejection_reason`	`string`	Oui	Shown to the customer verbatim when `state` is `rejected`.
`submitted_at`	`string`	Oui	—
`reviewed_at`	`string`	Oui	—

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 422 · 429