Add an email automatic field

A field is the object that bears the action to be performed by a participant. A field has a type which can be either:

• signature (for a signature request by a physical person),
• visa (for a consultation request by a physical person),
• text (for a text field to be filled by the participant),
• label (for a read only text added by the transaction creator on a document),
• checkbox_group (for a group of checkboxes to be checked by the participant),
• checkbox (for a checkbox to be checked by the participant),
• radio_group (for a group of radio buttons to be checked by the participant),
• radiobutton (for a radio button to be checked by the participant),
• dropdown (for a dropdown list where the participant needs to select an option).
• image (for an image field where the participant needs to import an image file),
• signature_date (for a field that displays the date and hour when the participant signed the document),
• email (for a field that displays the participant full name),
• email (for a field that displays the participant email),
• company_name (for a field that displays the participant company name),
• job_title (for a field that displays the participant job title).

You can also add initials fields.

About email automatic fields

An email automatic field allows you to retrieve the participant’s email from your workspace contact list and display it on the transaction document.

Note that you can’t add email automatic 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).

Create an email automatic field

To create an email automatic field, send a request to POST /v1/transactions/{transaction_id}/documents/{document_id}/fields and pass email in the type argument.

You can set other optional arguments:

curl
https://api.universign.com/v1/transactions/tx_DwYGle91EQZA/documents/doc_4dn/fields \
-d type=email \
-d page=1 \
-d x=328 \
-d y=580 \
-d width=200 \
-d height=19

• name: The full name field name.
• page: The page number on which you want to position the full name field.
• x: The full name field horizontal coordinate on the document page (in pixels).
• y: The full name field vertical coordinate on the document page (in pixels).
• copy_from: Use to copy the field. Expected value is the ID of the field you want to copy. This creates a new field with no position on the document. Do not pass if you pass the move_from argument.
• move_from: Use to move a field to another document. Expected value is the ID of the field you want to move. Do not pass if you pass the copy_from argument.
• height: The height of the field (expressed in PDF’s default user space units). Default value is 19.
• width: The width of the field (expressed in PDF’s default user space units). Default value is 200.
• font_size: The font size of the field content. Possible values between 7 and 12. Default value is 12.

The API response returns a field sub-object.

{
  "id" : "fld_4zlL",
  "type" : "email",
  "position" : {
    "page" : 1,
    "x" : 328,
    "y" : 580,
    "width" : 200,
    "height" : 19
  },
  "font_size" : 12,
  "updatable" : true,
  "deletable" : false,
  "required" : false,
  "built_in" : false
}

Update an email automatic field

To update an email automatic field, send a request to POST /v1/transactions/{transaction_id}/documents/{document_id}/fields/{field_id}.

curl
https://api.universign.com/v1/transactions/tx_DwYGle91EQZA/documents/doc_4dn/fields \
-d type=email \
-d page=2 \
-d x=200 \
-d y=200 \
-d width=250 \
-d height=35

The API response returns a field sub-object as it was last updated.

{
  "id" : "fld_4zlL",
  "type" : "email",
  "position" : {
    "page" : 2,
    "x" : 200,
    "y" : 200,
    "width" : 250,
    "height" : 35
  },
  "font_size" : 12,
  "updatable" : true,
  "deletable" : false,
  "required" : true,
  "built_in" : false
}

---

Add a full name automatic field

← Previous

Add a company automatic field

Next →