Centre d'aideIntégrations

Pour: Administrateurs

Envoyez des signatures électroniques et lisez les signatures avec une clé de hub

Créez un formulaire de signature électronique pour un dossier à partir d'un modèle, choisissez qui signe chaque champ, publiez-le pour signature et téléchargez la copie verrouillée une fois que tout le monde a signé.

Dans cet article9 sections

Avant de commencer

Cette page traite de la transmission des signatures électroniquesSignature électronique Document envoyé pour signature électronique, signé dans le navigateur., ainsi que de l’utilisation d’une clé de hub pour authentifier ces signatures. Les détails concernant les chemins de transmission se trouvent sous https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.

Appels

AppelCe que cela fait
GET /signs/templatesAffiche les modèles de signature électronique que vous possédez.
POST /signsCrée une signature électronique pour l’affaire en question, sans qu’elle ne soit publiée.
PUT /signs/<sign_id>/schemaChoisit qui signe chaque champ.
PUT /signs/<sign_id>Il change le nom, la date de publication ou les notifications d’information avant de publier le contenu.
PUT /signs/<sign_id>/publishIl le publie, ce qui permet de l’envoyer à ses signataires.
GET /signs?filter=allListe des documents électroniques liés à l’affaire.
GET /signs/<sign_id>Lise un document électronique, en connaissant son état.
DELETE /signs/<sign_id>Je le supprime, ainsi que ses signatures.
GET /signs/<sign_id>/responsesListe de ses signatures
GET /signs/<sign_id>/responses/<response_id>Lise une signature.

Un document électronique est créé en plusieurs étapes : on le crée, on vérifie qui signe chaque champ du document, puis on le publie. Jusqu’à ce qu’il soit publié, les personnes qui signent le document ne le voient pas, et personne n’est informé de son existence. Une fois que le document est publié, rien ne peut plus être modifié à son sujet.

Création d'une signature électronique

GET /signs/templates Affiche les signes électroniques que vous avez publiés. ModèlesModèle Un flux RSS, un formulaire, une signature électronique, une note ou une tâche réutilisable, conservé dans la bibliothèque et copié dans les dossiers., D’abord, les plus anciens. Chacun d’eux… asset_id, title, description, due_mins Combien de minutes après que le message a été envoyé, est-il finalement livré ? notifications, Et… role_field_participants, Les rôles qui correspondent à chaque champ.

POST /signs accepte les valeurs suivantes :

ChampCe que cela faitRequisDéfaut
nameLe titre de l’e-signature : des lettres, des chiffres, des espaces, et & ' - _ ( ) . /. Pas de virgules ni de points-virgues.Oui.—
duration{"due_date": "2026-10-09T17:00:00-04:00"}, avec son décalage horaire. Les signes électroniques ne se répètent pas : une règle de répétition est donc refusée.Oui.—
template{"owner": "host", "template_id": "<asset_id>"} Utiliser le document et les signataires d’un modèle.Non.Aucun.
descriptionUne note accompagnée de l’e-signatureNon.Le modèle est…
notificationsRemarques : {"names": ["days"], "values": [-1440]}. Chaque valeur représente le nombre de minutes restantes avant la date de fin.Non.Le modèle… ou rien du tout.
instant_notifyfalse Ne pas envoyer de demandes lors de la publication ; seules les notifications seront envoyées.Non.Le modèle, ou true
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/signs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Retainer Agreement", "duration": {"due_date": "2026-10-09T17:00:00-04:00"}, "template": {"owner": "host", "template_id": "sign::20260915101500_7a6b5c4d3e2f10"}}'

Cela répond à 201 avec sign_id. Le document du modèle est copié en arrière-plan : lisez le texte écrit jusqu’à ce qu’il ne reste plus de copying.

Pour envoyer votre propre fichier PDF, créez l’e-signature sans template. Ensuite, téléchargez le fichier PDF en tant que document. Attendez que tout soit prêt, puis assignez les champs correspondants au fichier. Pour plus d’informations, consultez Enregistrer et joindre des fichiers avec une clé hub.

Choisir qui signe

D’un modèle, chaque champ correspond aux personnes concernées par l’affaire, celles qui occupent les rôles correspondants lors de la création de l’e-signature. Donc, placez d’abord le client dans l’affaire. Les field_participants de l’e-signature indiquent le résultat : le nom de chaque champ, ainsi que les identifiants des utilisateurs qui signent cet e-signature.

Pour le changer, envoyez l’ensemble de la carte à PUT /signs/<sign_id>/schema.

{"field_participants": {"Client Signature": ["cu-4f1c2a9e8b7d60"], "Attorney Signature": ["cu-9d8c7b6a5f4e30"]}}
  • Toute identité doit être celle de quelqu’un qui est impliqué dans l’affaire. L’assistant virtuel ne peut pas signer.
  • Les noms de champs désignent ceux qui se trouvent dans le document.
  • La carte remplace l’ancienne carte : les zones qui ne sont pas indiquées sur cette nouvelle carte ne contiennent aucun signe de signature.

Édition

PUT /signs/<sign_id>/publish ne prend aucun corps et renvoie 200. Au moins un champ doit avoir un signataire ; un champ sans signataire reste vide.

  • Chaque signataire reçoit par e-mail une demande de signature. Si son adresse e-mail n’est pas confirmée, il est également contacté par texto. Cela se fait immédiatement, à moins que… instant_notify C’est. false. Il apparaît sur leurs… À faireFaire La liste des choses qui vous attendent, comme des formulaires à remplir, des documents à signer ou des événements à confirmer. Et également dans les notifications affichées sur leur portail.
  • Les rappels sont envoyés à chaque fois, dans le format notifications, et continueront ainsi jusqu’à ce que les personnes concernées signent leurs documents.
  • Quelqu’un qui est éloigné de l’affaire arrête de le tenir en main.

Suite aux signatures

L’écriture électronique… status Lire completed Une fois que tout le monde a signé, et… completed_on Indique quand cela se produira, en UTC. 2026-10-06T21:42:10.123456+00:00. Jusqu’à présent, il n’en dispose pas du tout. responses Chaque signataire qui a signé son nom… response_id.

GET /signs/<sign_id>/responses La liste présente les signatures de chaque signataire, en ordre décroissant d’âge, toutes sur une seule page. Chaque signature est accompagnée du nom du signataire qui l’a apposée. user_id, Lorsqu’ils ont signé, les champs qu’ils ont remplis étaient… response.formFieldValues, Signer sous leurs noms. response.annotations, Avec n’importe quelle image de signature en bas. response.attachments, Et l’adresse IP dont ils ont signé le contrôle. response.ip.

Chaque fois qu’une personne signe le document, le personnel chargé de l’affaire est informé. De même, lorsque la copie signée est prête, ils sont également informés. Toute personne qui signe le document est également prévenue au moment où la copie signée est prête.

La copie verrouillée

Une fois que tous les signatures ont été reçues, une copie verrouillée contenant toutes les signatures est créée. L’entrée du document sous media.schemas.items obtient la valeur flat, ainsi que le chemin de la copie, et aussi les valeurs flat_status, SUCCEEDED ou FAILED. Vous pouvez télécharger ce fichier en tant que fichier standard ; voir Enregistrer et joindre des fichiers avec une clé hub.

Liste et suppression

GET /signs nécessite filter : all liste tous les signes électroniques présents dans le cas, y compris ceux qui ne sont pas encore publiés. Les plus récents sont listés en premier. self liste ceux envoyés par l’assistant virtuel, que ce soit via une de vos clés ou via des automatisations. completed et uncompleted listent les signes électroniques provenant du appelant lui-même. Donc, ces champs restent toujours vides pour une clé donnée. Il est préférable de vérifier les valeurs de status et completed_on pour chaque signe électronique.

DELETE /signs/<sign_id> supprime un e-sign à tout moment, ainsi que toutes les signatures associées à celui-ci. Ce signe est alors retiré de la liste des tâches à accomplir pour tout le monde. Personne n’est informé de cette action.

Si un appel est refusé

StatutmessagePourquoi
400SchemaFieldsExceptionUn champ est manquant ou n’est pas valide. Par exemple, une virgule dans name, une règle de répétition, ou un signataire qui n’est pas inclus dans l’ensemble des signataires ; errors indique le nom de ce champ.
400SchemaFieldsException, avec ItemCopyNotAllowedException à templateLe modèle n’est pas publié, il n’est pas accessible aux bots, ou ses fichiers sont encore en cours de traitement.
403PublishAlreadyPublishedExceptionIl est déjà publié, donc il ne peut pas être modifié.
403PublishAlreadyAnsweredExceptionQuelqu’un l’a déjà signé.
403PublishParticipantsMissingExceptionAucun champ ne possède de signataire.
403PublishMediaMissingExceptionIl n’y a encore aucun document correspondant.
403PublishMediaNotReadyExceptionSon document est toujours en cours de copie ou de conversion.
403PublishMediaFailedExceptionSon document n’a pas pu être converti.
403PublishDocumentUnreadableExceptionSon document ne peut pas être lu : supprimez l’écriture électronique et créez-le à nouveau.
403PublishDueTimePassedExceptionLa date de réception de ce document est déjà passée.
403BotNotAllowedExceptionUne clé a essayé de signer ce document, ou de supprimer la signature de quelqu’un.
403CaseClosedExceptionL’affaire est close.
404ItemNotFoundExceptionL’écriture ou la signature électronique n’existe pas.

Pour les corps d’erreur et le reste des codes, veuillez consulter la section Gestion des erreurs et des codes de statut.

Articles connexes

Comprendre les possibilités de l'APIDécouvrez ce que permettent chacune une clé de gestion et une clé de hub, pourquoi chaque clé agit comme un assistant virtuel et où trouver la liste technique complète.IntégrationsEnvoyez des formulaires et consultez les réponses grâce à une clé de hub.Créez un formulaire à partir d'un modèle, publiez-le à l'intention des personnes concernées et lisez leurs réponses.IntégrationsTéléversez et joignez des fichiers à l'aide d'une clé de hub.Obtenez une adresse de téléchargement, téléchargez un fichier, joignez-le à une publication, une note, une tâche, un formulaire ou une signature électronique, et téléchargez les fichiers d'un dossier.IntégrationsGérer les erreurs et les codes d'état de l'APILisez le corps de l'erreur, ce que signifient les codes 400, 401, 403, 404, 500 et 503, et pourquoi un élément que votre clé ne peut pas voir renvoie la réponse 404.Intégrations