Passer au contenu principal
POST
cURL

Autorisations

Authorization
string
header
requis

Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.

Paramètres de chemin

enrollment
string
requis

L'ID de l'inscription du signataire, tel qu'affiché par GET /api/v1/inventory/signers.

Corps

application/json

Retrait de l'inscription d'un membre pour signer des actions de stock avec témoin, avec la raison et ce qui s'est passé.

reason
enum<string>
requis

Pourquoi l'inscription est retirée : withdrawn, security_key_lost ou pin_compromised.

Options disponibles:
withdrawn,
security_key_lost,
pin_compromised
Exemple:

"pin_compromised"

note
string
requis

Ce qui s'est passé, de 10 à 500 caractères.

Required string length: 10 - 500
Exemple:

"A colleague saw the PIN being entered."

Réponse

SignerEnrollmentResource

data
SignerEnrollmentResource · object
requis

L'inscription d'un signataire : comment son identité a été vérifiée, par qui et si elle a été retirée.