Add initials fields

Initials fields is the object that bears the field containing the initials of all participants of a transaction document.

You can request initials fields only once per document.

Note that initials fields are added to all pages of the document.

For more details about other field types, visit Add a signature/visa field, Add a label field, Add a text field, Add checkbox fields, Add radio button fields and Add dropdown list fields.

About initials fields

Initials fields contain the initials of all participants of a transaction document.

You can add initials fields only once per document and you can have only one initials field per document page.

Once you add an initials field to the document, it will display on all the other pages of the same document.

Note that you can’t add initials fields:

• on a document that has already been processed by a participant,
• on a document that already contains a signature (before being imported to the transaction).

Add initials fields

To create initials fields, send a request to POST /v1/transactions/{transaction_id}/documents/{document_id}/initials-fields and pass the vertical position in the y argument. You can optionally set the alignment argument:

curl
https://api.universign.com/v1/transactions/tx_DwYGle91EQZA/documents/doc_4dn/initials-fields \
-d y=200 \
-d alignment=center \

• y: The field vertical coordinate on the document pages (expressed in the PDF’s default user space units). The origin point is the bottom left hand corner of the displayed page (i.e the PDF’s cropbox).
• alignment: The alignment of the initials fields content. Possible values are left, center or right. Default vlaue is right.

The API response returns a field sub-object with the list of initials fields added to all document pages.

[ {
  "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"
} ]

---

Add an image field

← Previous

Add checkbox fields

Next →