...

Additional element definitions such as labels, default text, font setting, sizing or offset may follow.

Parameters

Signature Fields

Note: The following signature types are supported: Click2Sign, Draw2Sign, Type2Sign, RemoteSignature, BiometricSignature, LocalCertificateSignature, DisposableCertificate, OtpSignature (as of October 2019, eSAW 3.6) and additionally SwissComOnDemandCertificate since eSAW 21.27.

...

 "Range": {
                 "From": "-300,00 €",
                 "To": "5.000,00 €"
          },

You can type in any numbers. If you define the same number for “FROM” and “TO” you can only type in the given number. For example if you define 400,00 for “FROM” and “TO” the recipient can only type in this number into the Text Field.

Workflow

The following steps (including the optional use of the advanced document tag) are necessary for the API call:

1. Prepare a document with advanced document tags
   1. First, create or prepare a document with advanced document tags. These tags

...

1. 1. are placeholders within the document that will be replaced with specific data or values. Make sure to format the tags correctly so that they can be recognized and replaced appropriately.
2. Upload document
   1. Start by uploading the prepared document that contains the advanced document tags using the appropriate API endpoint. Make sure to note the FileId returned from this call as you will need it later.
3. Prepare file
   
   1. Before sending the document, you need to prepare the file. Please see JSON configuration below. With this configuration it is possible to clear the advanced document tags from the document with this variable set to true: ClearAdvancedDocumentTags
      This will remove any existing advanced document tags from the document.
4. Define recipient
   
   1. Define the specific recipient for the envelope, as in a standard envelope sending process. Proved recipient details such as name, email, and any other relevant information.
5. Send envelope
   1. Now, with the document prepared and the recipient defined, send the envelope using the send envelope api call. Use the FileId obtained from the initial document upload call to associate the correct document with the envelope.

Please also see the developer mode for this tutorial here: Visit the developer mode.

Prepare a document with advanced document tags

For this case you can use the following document which includes one text field and one checkbox:

Download the document advanced_document.pdf.

Upload the document

Make sure you upload a document which contains advanced document tags to see the differences in preparing the envelope.

Preparing the

...

file

If you are using the Advanced Tags via API you have to call file/prepare to use them.

For this call you need the File Id which you got from the upload file call and the following sample configuration:

{
  "FileIds": [
    "

string"
  ],
  "

ClearAdvancedDocumentTags": true,
  "SigStringConfigurations": [
    {
      "StartPattern": "string",
      "EndPattern": "string",
      "ClearSigString": true,
      "SearchEntireWordOnly": true
    }
  ]
}

[[*myText:signer2:text(maxLength=100,password=1,multiline=true):default("default text"):font(name=Arial, color=#FF0000, size=12):alignment(left):size(width=10,height=10)]]

...