Signer (Response)

Signatário com todas as informações vindas da resposta

Essa classe é a mesma de Signer, mas contem mais propriedades quando vinda da resposta da requisição

Propriedades:

nome
tipo
descrição

name

string

nome do signatário

email

string

email do signatário

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", "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.

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

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. Funcionalidade exclusiva para clientes Brasil.

order_group

number

Caso "signature_order_active" esteja ativo no document, esse campo controla a ordem de assinatura. Exemplo: Se o order_group é 0, esse será o primeiro a assinar, se o order_group for 1 esse será o segundo a assinar e assim por diante.

custom_message

string

(apenas relevante caso send_automatic_email: true). 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: ""

phone_country

string

Você pode definir o telefone (código do país) do signatário. Default: "" (sugestão: utilizar "55" para código do Brasil)

phone_number

string

Você pode definir o telefone (DDD + número) do signatário. Exemplo: "11998989222". Default: ""

lock_email

boolean

Você pode bloquear alterações ao e-mail do signatário. Default: false

blank_email

boolean

Você pode não solicitar o email do signatário. Default: false

hide_email

boolean

Você pode ocultar o email do signatário no relatório de assinaturas. Default: false

lock_phone

boolean

Você pode bloquear alterações ao telefone do signatário. Default: false

blank_phone

boolean

Você pode não solicitar o telefone do signatário. Default: false

hide_phone

boolean

Você pode ocultar o telefone do signatário no relatório de assinaturas. Default: false

lock_name

boolean

Você pode bloquear alterações ao nome do signatário. Default: false

require_cpf

boolean

COLOCAR NO SDK

cpf

boolean

COLOCAR NO SDK

require_selfie_photo

boolean

Você pode pedir que o signatário tire uma selfie enquanto assina. Default: false

require_document_photo

boolean

COLOCAR NO SDK

selfie_validation_type

string

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.

qualification

string

Qualificação para aparecer no relatório de assinaturas. Ex: valor "testemunha" irá resultar em "Assinou como testemunha". Default: ""

external_id

string

ID do signatário na sua aplicação. Default: ""

redirect_link

string

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: ""

sign_url

string

url para o signatário assinar o documento

token

string

token do signatário

status

string

status do signatário: "novo", "abriu-link" ou "assinou"

times_viewed

number

quantas vezes o signatário viu o documento

last_view_at

string

data da ultima vez que o signatário viu o documento

signed_at

string

data de quando o signatário assinou o documento

geo_latitude

string

latitude de onde o signatário assinou o documento (se ele permitir)

geo_longitude

string

longitude de onde o signatário assinou o documento (se ele permitir)

signature_image

string

imagem contendo a assinatura do signatário

visto_image

string

imagem contendo o visto do signatário

document_photo_url

string

url contendo a foto do documento do signatário

document_verse_photo_url

string

url contendo o verso da foto do signatário

selfie_photo_url

string

url contendo a foto da selfie do signatário

selfie_photo_url2

string

url contendo a foto da selfie do signatário

send_via

string

como o documento foi enviado para o signatário: "email", "whatsapp" ou null

Last updated