Adicionar signatário

Com este endpoint, você pode facilmente adicionar o signatário ao documento sem precisar gerar um novo contrato. O signatário será incluído no fluxo de assinatura, recebendo uma notificação (dependendo da configuração) para acessar e assinar o documento.

Não são permitidas alterações em documentos que já possuam assinaturas feitas com certificado digital.

---

Exemplo de requisição

Add signer | ZapSign WorkspacePostman

POST https://api.zapsign.com.br/api/v1/docs/{{token_doc}}/add-signer/

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", "assinaturaTela-tokenWhatsApp", "tokenSms", "tokenWhatsApp", "assinaturaTela-tokenSms" e "certificadoDigital". Obs: o "certificadoDigital" e tokenWhatsapp tem um custo de R$ 0,50 por signatário
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 o link do documento ao WhatsApp do signatário. Se false (default), você é quem se encarregará de compartilhar o link de assinatura com o signatário. É obrigatório que o phone_country e phone_number do signatário sejam definidos para uso da função. Cada envio automático via WhatsApp custa R$ 0,50. Adicione créditos em configurações>planos e preços.
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. É 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. É obrigatório que o phone_country e phone_number do signatário sejam definidos para uso da função. Cada envio automático via WhatsApp custa R$ 0,50. Adicione créditos em configurações>planos e preços
selfie_validation_type	String	Métodos avançados de biometria. Os disponíveis atualmente são:“face-match-and-datavalid”,“identity-verification-global”,"liveness-document-match" e "liveness-NXCD"
require_document_photo	Boolean	Você pode pedir que o signatário tire uma foto de seu documento pessoal enquanto assina (ex: RG ou CNH). Default: false
require_selfie_photo	Boolean	Você pode pedir que o signatário tire uma selfie enquanto assina. Default: false
require_cpf	Boolean	Você pedir o CPF do signatário. Se não preencher o número de CPF com o parâmetro "cpf", o signatário preencherá essa informação na assinatura do documento e ela será registrada no relatório de assinaturas.Default: false
cpf	String	Você informar o CPF do signatário. Default: ""
validate_cpf	Boolean	se true valida o CPF, o nome e a data de nascimento na Receita Federal. Para utilizá-lo, é necessário preencher o campo "cpf", e o signatário preencherá a data de nascimento. Default: false.

200 Signatário adicionado com sucesso

{
    "external_id": "",
    "sign_url": "https://app.zapsign.com.br/verificar/b5ade7f0-8bc2-463a-8475-d67eb7f58167",
    "token": "b5ade7f0-8bc2-463a-8475-d67eb7f58167",
    "status": "new",
    "name": "John 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": 0,
    "last_view_at": null,
    "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
}