ZapSign API
Português
Português
  • Informações gerais
  • Como começar
  • Ambiente de testes
  • Todas as requisições prontas!
  • Autenticação
    • Token estático (Api Token)
    • JWT (recomendado)
      • Obter token de acesso
      • Atualize seu token de acesso
  • Tipos de Tokens e Como Localizá-los
  • Versionamento da API
  • Políticas de Rate Limit
  • Alerta de incidentes
  • Ambiente de produção: Como funciona o pagamento
  • Status de erros
  • Conta
    • Informações do Plano
    • Listar usuários da conta
    • Criar usuários na conta
    • Excluir usuário da conta
  • Documentos
    • Criar documento via Upload
    • OneClick (ClickWrap)
      • Criar documento (OneClick)
    • Criar documento via Modelo
    • Adicionar anexo (documento extra)
    • Adicionar anexo (documento extra) via Modelo
    • Detalhar documento
    • Listar documentos
    • Excluir documento
    • Histórico de atividades do documento
    • Opcional: Posicionar assinaturas
    • Reprovar documentos
    • Validação de assinaturas
  • Signatários
    • Detalhar signatário
    • Atualizar signatário
    • Adicionar signatário
    • Excluir signatário
    • Grupo de signatários
      • Definir grupos de signatários
      • Excluir grupos de signatários
    • Assinar em lote via API
    • Reprovar documentos pelo usuário
  • Modelos
    • Criar modelo DOCX
      • Atualizar formulario
    • Listar modelos
    • Detalhar modelo
    • Atualizar modelo
    • Excluir modelo
  • Antecedentes
    • Introdução
    • Entendendo o Resultado
    • Criar uma Consulta (Check)
      • Consulta de Pessoa
      • Consulta de Empresa
  • Consultar Check
  • Detalhe do Check
  • Parcerias
    • Atualizar status de pagamento
  • Criar conta
  • CARIMBO DE TEMPO
    • Como funciona Carimbo de Tempo?
    • Carimbo de Tempo padrão
    • Carimbo de tempo preservando a assinatura original
  • Webhooks
    • Como funcionam os Webhooks
    • Testando Webhooks
    • Criar webhook
    • Logs de Webhooks
    • Eventos
      • Documento
        • Documento criado
        • Documento removido
        • Signatário criado
      • Signatário
        • Notificação de assinatura
        • Documento visualizado
        • Confirmação de leitura
        • Documento assinado
        • Documento recusado
        • Email bounce
        • Falha na Validação
      • Antecedentes
        • Consulta concluída
    • Reprocessamento de Documentos e Webhooks
    • Deletar webhook
  • Widget
    • Como funciona o Widget
Powered by GitBook
On this page

Was this helpful?

  1. Facilitadores
  2. SDKs
  3. SDK em Java
  4. Classes Usadas
  5. Response

Signer (Response)

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

Last updated 2 years ago

Was this helpful?

Essa classe é a mesma de , 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

send_automatic_whatsapp

boolean

order_group

int

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

int

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

Se true, a ZapSign irá enviar um e-mail ao signatário com o link para assinar o documento. Se false (default), , 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.

Se true, a ZapSign irá enviar uma mensagem por WhatsApp ao signatário com o link para assinar o documento. Se false (default), , 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 . Funcionalidade exclusiva para clientes Brasil.

Signer
você é quem se encarregará de compartilhar o link de assinatura com o signatário
você é quem se encarregará de compartilhar o link de assinatura com o signatário
Configurações > Plano