Demander une signature

Pour demander la signature d’un document par une personne physique, vous devez d’abord créer un champ de signature sur le document, puis attribuer un signataire à ce champ.

Créer un champ de signature sur le document

Pour créer un champ, envoyez une requête à POST /v1/transactions/{transaction_id}/documents/{document_id}/fields et transmettez signature dans l’argument type (notez que signature est la valeur par défaut, il n’est donc pas obligatoire de définir le type dans ce cas).

curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/documents/doc_wWz6/fields \
-d type=signature

L’API renvoie un champ avec un ID :

{
    "id": "fld_a998",
    "type": "signature",
    "built_in": false,
    "consents": [],
    "updatable": true,
    "deletable": true
}

Attribuer un participant au champ

Pour attribuer un participant au champ, envoyez une requête à POST /v1/transactions/{transaction_id}/signatures et transmettez l’identifiant du champ et l’email du participant dans l’argument signer :

curl 
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/signatures \
-d [email protected] \
-d field=fld_a998

Si le document peut être signé indifféremment par plusieurs personnes, vous pouvez définir des participants alternatifs. Il vous suffit d’attribuer plusieurs participants au champ. La première personne qui signe le document clôturera la tâche de signature et si d’autres participants tentent d’accéder au document, ils seront informés que la tâche est terminée et qu’aucune autre action n’est requise de leur part.

curl 
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/signatures \
-d [email protected] \
-d [email protected] \
-d [email protected] \
-d field=fld_a998

Désassigner un signataire d’un champ

Vous pouvez désassigner un signataire d’un champ. Pour ce faire, ajoutez l’argument delete à votre requête et définissez-la sur true.

curl 
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/signatures \
-d [email protected] \
-d field=fld_a998 \
-d delete=true

Positionner un champ

Un champ de signature peut être visible ou invisible dans le PDF. Lorsque vous créez un champ de signature, il est invisible par défaut, mais vous pouvez spécifier sa position sur une page du document.

Notez que même si le champ est invisible dans le document, les détails techniques liés à la signature électronique sont toujours visibles dans le panneau de signature d’Adobe.

You can specify the field position by setting its coordinates on the document page or by using an anchor:

Avec des coordonnées

La position d’un champ est définie par le numéro de page ainsi que par les coordonnées horizontales (x) et verticales (y) en pixels. Pour spécifier la position, envoyez une requête à POST /v1/transactions/{transaction_id}/documents/{document_id}/fields/{field_id} et transmettez les arguments de position :

curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/documents/doc_wWz6/fields/fld_a998 \  
-d page=1 \ 
-d x=75 \ 
-d y=200  

Notez que si vous mettez les coordonnées horizontales (x) et verticales (y) à 0, le champ sera positionné en bas à gauche de la page.

Avec une ancre

Universign peut rechercher une chaîne de caractères dans le document et positionner automatiquement le champ de signature en dessous. Le champ sera positionné à la première occurrence de l’ancre.

Pour positionner le champ, envoyez une requête à POST /v1/transactions/{transaction_id}/documents/{document_id}/fields et transmettez la valeur de la chaîne de caractères dans l’argument anchor :

curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/documents/doc_wWz6/fields \
-d anchor=client signature  

Notez que la position d’un champ peut être définie lors de la création du champ via l’endpoint (POST /v1/transactions/{transaction_id}/documents/document{id}/fields), ou lorsque le champ existe déjà via l’endpoint (POST /v1/transactions/{transaction_id}/documents/{document_id}/fields/{field_id}).


Ajouter des consentements
Demander une consultation
Espace Développeur
Guides
Services
Référence API