For the complete documentation index, see llms.txt. This page is also available as Markdown.

Signature Placement

Signature placement allows you to define where participant-related information will appear on the document’s pages. These elements are added through each signer’s positions property.

When positions are configured, the elements are automatically inserted at the specified locations after the participant completes their action. This eliminates the need to manually choose where to sign.

Placement can be configured when creating the document with CreateDocument.

Example:

{
  "signers": [
    {
      "email": "signer@example.com",
      "action": "SIGN",
      "positions": [
        {
          "x": "5.0",
          "y": "90.0",
          "z": 1,
          "angle": 0,
          "scale": 1.0,
          "element": "SIGNATURE"
        }
      ]
    }
  ]
}

Each item in the positions array represents an element to be displayed in the document.

Field
Description

x

The element’s horizontal position, expressed as a percentage of the page width.

y

The element’s vertical position, expressed as a percentage of the page height.

z

The page on which the element will be displayed.

angle

The element’s rotation angle.

scale

The element’s scale.

element

The type of element to insert.

The following element types are available:

Element
Description

SIGNATURE

The participant’s signature.

INITIALS

The participant’s initials.

NAME

The participant’s full name.

CPF

The participant’s CPF number.

DATE

The signature date.

You can position multiple elements for the same participant:

The x and y values use percentage-based coordinates ranging from 0 to 100, allowing the placement to remain proportional to the page dimensions.

The angle value represents the element’s rotation in degrees and ranges from 0 to 360.

The scale value is a multiplier applied to the element’s size. The default scale is 1.0, with a minimum of 0.5 and a maximum of 4.0.

Note: If no placements are provided, the document can still be signed normally through the platform’s signing page. In this case, no elements are automatically inserted into the PDF pages.

Last updated