Atualizar signatário
Imagine que você precisa corrigir o nome ou o telefone de um signatário antes que ele assine o documento. Com este endpoint, você pode atualizar os atributos de um signatário, como nome, e-mail, telefone, ou modificar o modo de autenticação. Também é possível bloquear ou desbloquear esses atributos, dependendo da necessidade.
Esse endpoint só funciona se o signatário ainda não tiver assinado o documento.
Exemplo de requisição
POST https://api.zapsign.com.br/api/v1/signers/{{token_signatario}}/
Headers
Authorization*
string
Api token a frente do texto "Bearer".
Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23
Request Body
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
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" e "certificadoDigital". Obs: o "certificadoDigital" tem um custo de R$ 0,50 por signatário 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 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.
signature_placement
string
Permite posicionar a assinatura no documento usando um texto âncora (sem necessidade de coordenadas x, y). Configure signature_placement: "<<{identificador_da_assinatura}>>" e a assinatura será posicionada onde encontrar esse texto. Se o texto aparecer mais de uma vez, a assinatura será posicionada em todos os locais. Observação: o uso de << >> é altamente recomendado para evitar conflitos com o texto, mas não é obrigatório. Ex: "<>". Default: ""
rubrica_placement
string
Permite posicionar a rubrica no documento usando um texto âncora (sem necessidade de coordenadas x, y). Configure rubrica_placement: "<<{identificador_da_rubrica}>>" e a rubrica será posicionada onde encontrar esse texto. Se o texto aparecer mais de uma vez, a rubrica será posicionada em todos os locais. Observação: o uso de << >> é altamente recomendado para evitar conflitos com o texto, mas não é obrigatório. Ex: "<>". Default: ""
Last updated
Was this helpful?