Assinar em lote via API
Se a sua empresa frequentemente precisa assinar muitos documentos, este endpoint oferece uma maneira eficiente de realizar essas assinaturas sem a necessidade de acessar manualmente cada documento. Com a assinatura em lote, você economiza tempo e automatiza o processo de assinatura de múltiplos documentos!
Assinar em lote via API:
POST https://api.zapsign.com.br/api/v1/sign/
Nesta seção:
Pré-requisitos:
Você só pode assinar via API com usuários dentro da sua conta. Isso significa que os signatários devem estar registrados como usuários na sua conta, configurados na seção Configurações > Organização > Usuários. Não é possível assinar para terceiros ou clientes externos que não sejam usuários da sua conta.
Só é possível assinar documentos que tenham o e-mail do signatário vazio ou igual ao do usuário que está assinando os documentos. Caso o e-mail seja diferente, não será possível assinar.
O usuário deve ter as seguintes informações salvas na seção Configurações > Meu perfil > Dados Pessoais: nome, sobrenome, telefone, assinatura e visto.
A assinatura via API não consome créditos (é gratuita). No entanto, é necessário ter Plano API ativo e add-on de assinatura em lote.
Autenticação suportada:
Autenticação Padrão:
A assinatura em lote só funciona com autenticação padrão: "assinatura na tela".
Autenticações avançadas (são opcionais - se selecionadas na criação do documento):
"CPF Simples"
Não é obrigatório o preenchimento do CPF na criação do documento, mas é obrigatório enviá-lo no body da requisição quandoo essa opção for selecionada.
Requisito: necessário possuir CPF cadastrado em Configurações > Meu Perfil > Informações Pessoais.
"Selfie"
Quando essa opção for selecionada na criação do documento, é obrigatório enviar o campo "selfie_photo" no body da requisição.
"Foto do documento de identidade"
Ao selecionar essa opção na criação do documento, é obrigatório enviar os campos "document_photo_url" e "document_verse_photo_url".
Se o documento tiver qualquer outro método de autenticação avançada não listado acima, não será possível assinar esses documentos.
Headers
Authorization*
string
Api token a frente do texto "Bearer".
Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23
Request Body
user_token*
string
Token do usuário que irá assinar.
signer_tokens[]*
array
Tokens que serão assinados (token do signer em cada documento a ser assinado).
selfie_photo
string
Deve ser uma URL publicamente acessível contendo a imagem da selfie, aceita nos formatos JPG, JPEG ou PNG.
document_photo_url
string
Deve ser uma URL publicamente acessível contendo a imagem frontal do documento, aceita nos formatos JPG, JPEG ou PNG.
document_verse_photo_url
string
Deve ser uma URL publicamente acessível contendo a imagem traseira do documento, aceita nos formatos JPG, JPEG ou PNG.
cpf
string
String que representa o número de CPF do usuário, composta por 11 dígitos numéricos, com ou sem pontuação.
Como utilizar o Postman para assinar em lote
O Postman é um grande aliado para assinar rapidamente seus documentos. Comece configurando o endpoint e adicionando seu API Token na aba Authorization. Depois, acesse seu perfil na plataforma para pegar o user token e reúna os signer tokens dos documentos que serão assinados.
Exemplo de requisição
user_token*
string
Token do usuário que irá assinar.
signer_tokens[]*
array
Tokens que serão assinados (token do signer em cada documento a ser assinado).
selfie_photo
string
Deve ser uma URL acessível publicamente contendo a imagem da selfie, aceita nos formatos JPG, JPEG ou PNG.
document_photo_url
string
Deve ser uma URL acessível publicamente contendo a imagem da frente do documento, aceita nos formatos JPG, JPEG ou PNG.
document_verse_photo_url
string
Deve ser uma URL acessível publicamente contendo a imagem do verso do documento, aceita nos formatos JPG, JPEG ou PNG.
cpf
string
String representando o número do CPF do usuário. Deve conter 11 dígitos numéricos, com ou sem pontuação.
Exemplos de respostas
{"message":"Documento(s) assinado(s) com sucesso. Lembrete: este endpoint é assíncrono, então aguarde os PDF finais ficarem prontos via webhooks ou confira-os daqui alguns minutos."}Como conseguir o user_token?
Para realizar a assinatura via API, é necessário o user_token do usuário que irá assinar os documentos. Siga os passos abaixo:
Faça login no usuário que irá assinar os documentos.
Entre em Configurações>meu perfil
No final da página, habilite a assinatura via API.
Copie o token gerado e cole no parametro user_token, dentro da request.
Como conseguir seu user token
Como Conseguir o signer_token?
Cada signatário (signer) criado na ZapSign possui um token individual. Para obter o token do signatário, siga os passos:
Crie ou acesse um documento.
Adicione o signatário ao documento.
Copie o token gerado para cada signatário.
Atenção: Certifique-se de estar utilizando o signer_token (token do signatário) e não o document_token (token do documento). Em caso de dúvidas, consulte Tipos de tokens e como localizá-los.
Last updated
Was this helpful?