Update signer

Update the signer of a document (only if he hasn't signed the document yet).

Update signer

POST https://api.zapsign.com.br/api/v1/signers/{{signer_token}}/

Update signer attributes like name, email and phone, or change their authentication mode, lock and unlock attributes. This endpoint only works if signer has not signed the document.

Headers

Name	Type	Description
Authorization*	string	apiToken ahead of the "Bearer" text. Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Name	Type	Description
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	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 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.
send_automatic_whatsapp_signed_file	boolean	If true, ZapSign will send a whatsapp message to the signer with the link to the signed 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.
selfie_validation_type	String	Advanced biometric methods. The currently available options are: "liveness-document-match" and "identity-verification"
require_document_photo	Boolean	You can request that the signer takes a photo of their personal document while signing. Default:False

200 Signer updated successfully

{
    "external_id": "",
    "sign_url": "https://app.zapsign.com.br/verificar/b5ade7f0-8bc2-463a-8475-d67eb7f58167",
    "token": "b5ade7f0-8bc2-463a-8475-d67eb7f58167",
    "status": "link-opened",
    "name": "Jane Doe",
    "lock_name": false,
    "email": "",
    "lock_email": false,
    "hide_email": false,
    "blank_email": false,
    "phone_country": "55",
    "phone_number": "",
    "lock_phone": false,
    "hide_phone": false,
    "blank_phone": false,
    "times_viewed": 2,
    "last_view_at": "2023-07-06T05:34:37.776131Z",
    "signed_at": null,
    "auth_mode": "assinaturaTela",
    "qualification": "",
    "require_selfie_photo": false,
    "require_document_photo": false,
    "geo_latitude": null,
    "geo_longitude": null,
    "redirect_link": "",
    "signature_image": null,
    "visto_image": null,
    "document_photo_url": "",
    "document_verse_photo_url": "",
    "selfie_photo_url": "",
    "selfie_photo_url2": "",
    "send_via": "email"
}

Request

Update signer | ZapSign WorkspacePostman