Add a text 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).

You can also add initials fields.

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

Note that only signature and visa fields are set by default on your workspace. Before you can add other field types, ensure with us that their respective features are activated in your account.

Create a text field

To create a text field, send a request to POST /v1/transactions/{transaction_id}/documents/{document_id}/fields and pass text 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=text \
-d name=TextField \
-d page=1 \
-d x=75 \
-d y=200 \
-d tooltip="Please add your comments here."

• name: The text field name.
• page: The page number on which you want to position the text field.
• x: The text field horizontal coordinate on the document page (in pixels).
• y: The text 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). If not provided, the height is set to font height.
• width: The width of the field (expressed in PDF’s default user space units). Default value is 200.
• tooltip: Tooltips about the text the participant needs to add to the document during signature process. Set only if field type is text. Max 100 characters.

The API response returns a field object.

{
  "id" : "fld_DL4x",
  "name" : "TextField",
  "position" : {
    "page" : 1,
    "x" : 75,
    "y" : 200,
    "width" : 200,
    "height" : 19
  },
  "built_in" : false,
  "updatable" : true,
  "deletable" : true,
  "max_length" : 27,
  "tooltip" : "Please add your comments here.",
  "required" : true,
  "font_size" : 12,
  "type" : "text"
}

Update a text field

To update a text 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/fld_DL4x \
-d type=text \
-d name=UpdatedTextField \
-d page=2 \
-d x=75 \
-d y=200 \
-d tooltip="Please add extra information here."

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

{
  "id" : "fld_DL4x",
  "name" : "UpdatedTextField",
  "position" : {
    "page" : 2,
    "x" : 75,
    "y" : 200,
    "width" : 200,
    "height" : 19
  },
  "built_in" : false,
  "updatable" : true,
  "deletable" : true,
  "max_length" : 27,
  "tooltip" : "Please add extra information here.",
  "required" : true,
  "font_size" : 12,
  "type" : "text"
}

---

Add a signature/visa field

← Previous

Add a label field

Next →