Signer
Class to create signers
Last updated
Class to create signers
Last updated
name
string
You can set the signer's name.
string
You can set the signer's email.
auth_mode
string
You can choose the signer's authentication method. Possible values are: "assinaturaTela" (default) (signature on screen), "tokenEmail", "assinaturaTela-tokenEmail", "tokenSms" and "assinaturaTela-tokenSms". They correspond to the same methods available in the web interface.
send_automatic_email
boolean
If true, ZapSign will send an email to the signer with the link to sign the document. If false (default), you will be responsible for sharing the subscription link with the signatory, whether through your website, widget, WhatsApp, SMS, email, chat etc. Note: For this to work, it is mandatory that the signer's email address is defined.
send_automatic_whatsapp
boolean
If true, ZapSign will send a whatsapp to the signer with the link to sign the document. If false (default), you will be responsible for sharing the subscription link with the signatory, whether through your website, widget, WhatsApp, SMS, email, chat etc. Note: For this to work, it is mandatory that the signer's cell phone is defined.
order_group
int
In case "signature_order_active" is active in the document, this field controls the signing order. Example: If the field is set to 1, then this signer will be the first to sign. If the field is set to 2, then this signer will be the second to sign and so on.
custom_message
string
(only relevant if send_automatic_email: true). The custom_message is the personalized message that you can insert in the email sent by ZapSign to the signer. Example: "Hello So-and-so, \n This is your employment contract. \n Hugs, Team XPTO". The \n symbol serves to "skip a line" in the email text. Default: ""
phone_country
string
You can set the phone (country code) of the signer. Default: "" (ie. US is "1")
phone_number
string
You can set the phone number of the signer. Example: "11998989222". Default: ""
lock_email
boolean
You can lock changes to the signer's email. Default: false
blank_email
boolean
You may not request the signer's email. Default: false
hide_email
boolean
You can hide the signer's email in the signatures report. Default: false
lock_phone
boolean
You can lock changes to the signer's phone. Default: false
blank_phone
boolean
You may not ask for the signer's phone number. Default: false
hide_phone
boolean
You can hide the signer's phone number in the signature report.
Default: false
lock_name
boolean
You can lock changes to the signer's name.
Default: false
require_selfie_photo
boolean
You can ask the signer to take a selfie while signing. Default: false.
selfie_validation_type
string
You can ask the signer to take a photo of your personal document while signing. Default: falseIf you want to use facial recognition (liveness+document match validation) provided by Truora, please also define this field as "liveness-document-match".
Default: "none". Note that this feature has an extra cost, please contact sales.
qualification
string
Qualification to appear in the signatures report. Ex: "Witness" value will result in "Signed as a witness". Default: ""
external_id
string
ID of the signer in your application.
Default: ""
redirect_link
string
link to redirect after signer signs. For example: "https://www.seusite.com.br/agracimento". It will appear as a "CONTINUE" button below the "Download Original" and "Download Signed" buttons. Remember to insert http:// or https:// at the beginning of the link. Default: ""