# Signer

### Propriedades:

<table><thead><tr><th>Nome</th><th width="148.33333333333331" align="center">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>name</td><td align="center">string</td><td>nome do signatário</td></tr><tr><td>email</td><td align="center">string</td><td>email do signatário</td></tr><tr><td>auth_mode</td><td align="center">string</td><td>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", "assinaturaTela-tokenWhatsapp", "tokenWhatsapp" e "certificadoDigital". 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. Cada mensagem enviada por WhatsApp tem o custo de R$ 0,50.</td></tr><tr><td>send_automatic_email</td><td align="center">boolean</td><td>Se <strong>true</strong>, a ZapSign irá enviar um e-mail ao signatário com o link para assinar o documento. Se <strong>false</strong> (default), <a href="https://docs.zapsign.com.br/documentos/criar-documento#o-que-fazer-com-a-resposta">você é quem se encarregará de compartilhar o link de assinatura com o signatário</a>, 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.</td></tr><tr><td>send_automatic_whatsapp</td><td align="center">boolean</td><td>Se <strong>true</strong>, a ZapSign irá enviar uma mensagem por WhatsApp ao signatário com o link para assinar o documento. Se <strong>false</strong> (default), <a href="https://docs.zapsign.com.br/documentos/criar-documento#o-que-fazer-com-a-resposta">você é quem se encarregará de compartilhar o link de assinatura com o signatário</a>, 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 <strong>cada envio automático via WhatsApp custa R$ 0,50. Adicione créditos em</strong> <a href="https://app.zapsign.com.br/conta/configuracoes?tab=plans"><strong>Configurações > Plano</strong></a><strong>. </strong><mark style="background-color:orange;"><strong>Funcionalidade exclusiva para clientes Brasil.</strong></mark></td></tr><tr><td>order_group</td><td align="center">int</td><td>Caso "signature_order_active" esteja ativo no document, esse campo controla a ordem de assinatura. Exemplo: Se o order_group é 1, esse será o primeiro a assinar, se o order_group for 2 esse será o segundo a assinar e assim por diante.</td></tr><tr><td>custom_message</td><td align="center">string</td><td>(apenas relevante caso <strong>send_automatic_email: true</strong>). A custom_message é a mensagem personalizada que você pode inserir no e-mail enviado pela ZapSign ao signatário. Exemplo: "Olá Fulano, \n Este é o seu contrato de trabalho. \n Abraços, Equipe XPTO". O símbolo \n serve para "pular uma linha" no texto do e-mail. Default: ""</td></tr><tr><td>phone_country</td><td align="center">string</td><td>Você pode definir o telefone (código do país) do signatário. Default: "" (sugestão: utilizar "55" para código do Brasil)</td></tr><tr><td>phone_number</td><td align="center">string</td><td>Você pode definir o telefone (DDD + número) do signatário. Exemplo: "11998989222". Default: ""</td></tr><tr><td>lock_email</td><td align="center">boolean</td><td>Você pode bloquear alterações ao e-mail do signatário. Default: false</td></tr><tr><td>blank_email</td><td align="center">boolean</td><td>Você pode não solicitar o email do signatário. Default: false</td></tr><tr><td>hide_email</td><td align="center">boolean</td><td>Você pode ocultar o email do signatário no relatório de assinaturas. Default: false</td></tr><tr><td>lock_phone</td><td align="center">boolean</td><td>Você pode bloquear alterações ao telefone do signatário. Default: false</td></tr><tr><td>blank_phone</td><td align="center">boolean</td><td>Você pode não solicitar o telefone do signatário. Default: false</td></tr><tr><td>hide_phone</td><td align="center">boolean</td><td>Você pode ocultar o telefone do signatário no relatório de assinaturas. Default: false</td></tr><tr><td>lock_name</td><td align="center">boolean</td><td>Você pode bloquear alterações ao nome do signatário. Default: false</td></tr><tr><td>require_cpf</td><td align="center">boolean</td><td>Você pedir o CPF do signatário. Default: false</td></tr><tr><td>cpf</td><td align="center">string</td><td>Você informar o CPF do signatário. Default: null</td></tr><tr><td>require_selfie_photo</td><td align="center">boolean</td><td>Você pode pedir que o signatário tire uma selfie enquanto assina. Default: false</td></tr><tr><td>require_document_photo</td><td align="center">boolean</td><td>Você pode pedir que o signatário tire uma foto de seu documento pessoal enquanto assina (ex: RG ou CNH). Default: false</td></tr><tr><td>selfie_validation_type</td><td align="center">string</td><td>Se você quiser usar o reconhecimento facial (liveness + validação de documento), fornecido pela Truora, defina este campo como "liveness-document-match". Default: "none". Atenção: existe um custo extra de R$ 1,50 por validação de reconhecimento facial, de forma pré-paga. Adicione créditos na sua conta em Configurações > Plano ou converse com a nossa equipe comercial.</td></tr><tr><td>qualification</td><td align="center">string</td><td>Qualificação para aparecer no relatório de assinaturas. Ex: valor "testemunha" irá resultar em "Assinou como testemunha". Default: ""</td></tr><tr><td>external_id</td><td align="center">string</td><td>ID do signatário na sua aplicação. Default: ""</td></tr><tr><td>redirect_link</td><td align="center">string</td><td>link para redirecionamento após signatário assinar. Por exemplo: "https://www.seusite.com.br/agradecimento". Irá aparecer como um botão "CONTINUAR" abaixo dos botões "Baixar original" e "Baixar assinado". Lembre-se de inserir o http:// ou https:// no começo do link. Default: "" </td></tr></tbody></table>