Ajouter un champ Paraphe

À propos du champ Paraphe

Le champ Paraphe est l’objet qui contient les initiales de tous les participants d’un document.

Vous ne pouvez ajouter qu’un seul champ Paraphe par document et vous ne pouvez avoir qu’un seul champ d’initiales par page de document.

Notez que le champ Paraphe est ajouté à toutes les pages du document.

Une fois que vous avez ajouté un champ Paraphe au document, il s’affichera sur toutes les autres pages du même document.

Notez que vous ne pouvez pas ajouter de champ Paraphe :

  • sur un document qui a déjà été traité par un participant,
  • sur un document qui contient déjà une signature (avant d’être importé dans la transaction).

Ajouter un champ Paraphe

Pour créer un champ Paraphe, envoyez une requête à POST /v1/transactions/{transaction_id}/documents/{document_id}/initials-fields et transmettez la position verticale dans l’argument y. Vous pouvez éventuellement définir l’argument alignment :

curl
https://api.universign.com/v1/transactions/tx_DwYGle91EQZA/documents/doc_4dn/initials-fields \
-d y=200 \
-d alignment=center \
  • y : coordonnée verticale du champ sur les pages du document (exprimée dans les unités d’espace utilisateur par défaut du PDF). Le point d’origine est le coin inférieur gauche de la page affichée (c’est-à-dire la zone de recadrage du PDF).
  • alignment : alignement du contenu des champs d’initiales. Les valeurs possibles sont left, center ou right. La valeur par défaut est right.

L’API renvoie un sous-objet field contenant la liste des champs Paraphe ajoutés à toutes les pages du document.

[ {
  "id" : "fld_kVlx",
  "position" : {
    "page" : 1,
    "x" : 0,
    "y" : 200,
    "width" : 595,
    "height" : 19
  },
  "type" : "initials",
  "built_in" : false,
  "updatable" : true,
  "deletable" : true,
  "font_size" : 12,
  "alignment" : "center"
}, {
  "id" : "fld_xrA",
  "position" : {
    "page" : 4,
    "x" : 0,
    "y" : 200,
    "width" : 595,
    "height" : 19
  },
  "type" : "initials",
  "built_in" : false,
  "updatable" : true,
  "deletable" : true,
  "font_size" : 12,
  "alignment" : "center"
}, {
  "id" : "fld_rDL7",
  "position" : {
    "page" : 5,
    "x" : 0,
    "y" : 200,
    "width" : 595,
    "height" : 19
  },
  "type" : "initials",
  "built_in" : false,
  "updatable" : true,
  "deletable" : true,
  "font_size" : 12,
  "alignment" : "center"
}, {
  "id" : "fld_9lGa",
  "position" : {
    "page" : 2,
    "x" : 0,
    "y" : 200,
    "width" : 595,
    "height" : 19
  },
  "type" : "initials",
  "built_in" : false,
  "updatable" : true,
  "deletable" : true,
  "font_size" : 12,
  "alignment" : "center"
}, {
  "id" : "fld_ZDDX",
  "position" : {
    "page" : 3,
    "x" : 0,
    "y" : 200,
    "width" : 595,
    "height" : 19
  },
  "type" : "initials",
  "built_in" : false,
  "updatable" : true,
  "deletable" : true,
  "font_size" : 12,
  "alignment" : "center"
} ]

Ajouter un champ de signature/consultation
Ajouter un champ automatique Date de signature
Espace Développeur
Guides
Services
Référence API