Atualizar signatário

Atualize o signatário de um documento (somente se ele ainda não assinou o documento).

Atualizar signatário

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

Atualize atributos do signatário como nome, e-mail e telefone, ou mude seu modo de autenticação, bloqueie e desbloqueie atributos. Endpoint só funciona se signatário ainda não assinou o documento.

Headers

Name	Type	Description
Authorization*	string	Api token a frente do texto "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Name	Type	Description
redirect_link	string	Link para redirecionamento após signatário assinar. Lembre-se de inserir o http:// ou https:// no começo do link. Default: ""
name	string	Nome completo do signatário
email	string	E-mail do signatário
phone_country	string	Código do país do telefone do signatário (Ex: Brasil é 55)
phone_number	string	Telefone (com DDD) do signatário (Ex: 11989118800)
auth_mode	string	Você pode escolher o método de autenticação do signatário. Valores possíveis são: "assinaturaTela" (default), "tokenEmail", "assinaturaTela-tokenEmail", "tokenSms", "assinaturaTela-tokenSms" , "certificadoDigital" e "CPF" . Correspondem aos mesmos métodos disponíveis na interface web. Obs: o "certificadoDigital" tem um custo de R$ 0,50 por signatário que assinar com certificadoDigital e CPF tem o custo de R$1,00 por assinatura realizada com sucesso.
lock_name	boolean	Bloquear alteração do nome pelo signatário.
lock_email	boolean	Bloquear alteração do e-mail pelo signatário.
lock_phone	boolean	Bloquear alteração do telefone pelo signatário.
qualification	string	Qualificação para aparecer no relatório de assinaturas. Ex: valor "testemunha" irá resultar em "Assinou como testemunha"
external_id	string	ID externo do signatário na sua aplicação.
send_automatic_whatsapp	boolean	Se true, a ZapSign irá enviar uma mensagem por WhatsApp ao signatário com o link para assinar o documento. Se false (default), você é quem se encarregará de compartilhar o link de assinatura com o signatário, seja pelo seu site, widget, WhatsApp, SMS, e-mail, chat etc. Observação: para isso funcionar, é obrigatório que o phone_country e phone_number do signatário sejam definidos e cada envio automático via WhatsApp custa R$ 0,50. Adicione créditos em Configurações > Plano.
send_automatic_email	boolean	Se true, a ZapSign irá enviar um e-mail ao signatário com o link para assinar o documento. Se false (default), você é quem se encarregará de compartilhar o link de assinatura com o signatário, seja pelo seu site, widget, WhatsApp, SMS, e-mail, chat etc. Observação: para isso funcionar, é obrigatório que o email do signatário seja definido.
send_automatic_whatsapp_signed_file	boolean	Se true, a ZapSign irá enviar uma mensagem por WhatsApp ao signatário com o link para o arquivo assinado. Se false (default), você é quem se encarregará de compartilhar o arquivo assinado com o signatário, seja pelo seu site, widget, WhatsApp, SMS, e-mail, chat etc. Observação: para isso funcionar, é obrigatório que o phone_country e phone_number do signatário sejam definidos e cada envio automático via WhatsApp custa R$ 0,50. Adicione créditos em Configurações > Plano.

200 Signatário atualizado com sucesso

{
    "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",
    "send_automatic_whatsapp_signed_file": null,
}

Exemplo de requisição

Update signer | ZapSign WorkspacePostman