Add Complex Text Tags to a document

Text tags - specific combinations of symbols and letters that represent fillable fields.

Complex Text Tags can be added to a document in any text editor. They convert to fillable fields when users upload a document to SignNow.

To add a Complext Text Tag to a document, just type the tag name in double curly braces where you’d like to put a fillable field, like so: {{tag_name}}. Then, make a request to POST /document/fieldextract. In your request body, specify parameters of the field you saved place for with your {{tag_name}}.

Required parameters for a Complex Text Tag:

“tag_name” - duplicates the name without curly braces, e.g. tag_name

“role” - which role the field is assigned to, e.g. Signer_1

“label” - hint for the signer inside a fillable field about the field type, e.g. first_name or text_1; once the field is filled in, the value automatically appears in all the fields with the same label

“required” - whether the field is mandatory to fill in, e.g. true/false

“type” - could be “text”, “signature”, “initials”, “checkbox”, “radiobutton”, or “enumeration” (stands for a dropdown menu)

“prefilled_text” - editable text that appears in the field when the signer opens the document, e.g. Lucy

“validator_id” - data validation format for a field.

Check for available formats in Data Validators.

“width” - how many pixels wide the field is

“height” - how many pixels high the field is

Popular Field Sizes

Field Type Purpose Width & Height, Font Size 10 Width & Height, Font Size 12 Width & Height, Font Size 10
Text field name
Text field email address
Text field US phone number
Signature field for signing a document
Hint

Equivalent A4 paper dimensions in pixels at 300 dpi or 72 dpi resolution respectively are: 2480 ⨯ 3508 pixels and 595 ⨯ 842 pixels.

Steps:

▶ Add Complex Text Tags to your document in any text editor, i.e. {{email}}, {{name}}

Upload a document with complex tags to signNow:

curl -X POST \
  https://api-eval.signnow.com/document/fieldextract \
  -H 'Authorization: Bearer {{acceess_token}}' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@/path/to /your/file/pdf-test.pdf' \
  -F 'Tags=[
          {
              "tag_name":"email", 
              "role":"owner",
              "label":"email",
              "required":true,
              "type":"text",
              "prefilled_text":"test@example.com",
              "validator_id":"7cd795fd64ce63b670b52b2e83457d59ac796a39",
              "height":15,
              "width":100
          },
          {
              "tag_name":"name",
              "role":"user",
              "label":"name",
              "required":true,
              "type":"text",
              "height":15,
              "width":100
          }
      ]'

Full list of text tags and the most popular combinations is available here.