Comment on page
Add signer
post
https://api.zapsign.com.br
/api/v1/docs/{{doc_token}}/add-signer/
Add signer
Add a signer to a document.
Parameters
Header
Authorization*
string
apiToken ahead of the "Bearer" text.
Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23
Body
redirect_link
string
Redirect link after signer signs. Remember to insert http:// or https:// at the beginning of the link.
Default: ""
name
string
Signer fullname
email
string
Signer email
phone_country
string
Country code of the signer's phone (Ex: US is 1)
phone_number
string
Signer's phone (Ex: 11989118800)
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.
lock_name
boolean
Block name change by signer.
lock_email
boolean
Block email change by signer.
lock_phone
boolean
Block phone change by signer.
qualification
string
How he will appear on the signature report.
Ex: value "witness" will result in "Signed as a witness"
external_id
string
External ID of your app.
send_automatic_email
boolean
f 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 message to the signer with the link to sign the document.
Note: For this to work, it is mandatory that the signer's phone number is defined. each automatic sending via WhatsApp (tokenWhatsapp) costs 0,1 USD. Buy credits in Configuration > Plan.
Responses
200
Signer added successfully
Last modified 1mo ago