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
  • 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
  • Requisitos prévios:
  • Como utilizar o Postman para assinar em lote
  • Exemplo de requisição
  • Como conseguir o user_token?
  • Como Conseguir o signer_token?

Was this helpful?

  1. Signatários

Assinar em lote via API

PreviousExcluir grupos de signatáriosNextReprovar documentos pelo usuário

Last updated 2 months ago

Was this helpful?

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! Nesta seção:


Requisitos prévios:

  • 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 : nome, sobrenome, telefone, assinatura e visto.

  • A assinatura via API não consome créditos (é gratuita). No entanto, é necessário ter um Plano API ativo para usar esse endpoint, incluindo o add-on de assinatura em lote.

  • A assinatura em lote só funciona com autenticação por "assinatura na tela", "selfie" e "foto do documento de identidade" e "CPF Simples" sem preencher o CPF na criação do documento. Se o documento possuir outro método de autenticação, não será possível assinar esses documentos.

Com essa funcionalidade, você poderá economizar tempo e tornar o processo de assinatura mais eficiente para sua equipe! 🚀

POST https://api.zapsign.com.br/api/v1/sign

Headers

Name
Type
Description

Authorization*

string

Api token a frente do texto "Bearer".

Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Name
Type
Description

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

Name
Type
Description

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

Caso você tente realizar uma requisição com user_token ou signer_tokens que não existam, você receberá uma response 404 (não encontrado).


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:

  1. Faça login no usuário que irá assinar os documentos.

  2. Entre em Configurações>meu perfil

  3. No final da página, habilite a assinatura via API.

  4. Copie o token gerado e cole no parametro user_token, dentro da request.


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:

  1. Crie ou acesse um documento.

  2. Adicione o signatário ao documento.

  3. Copie o token gerado para cada signatário.

Este endpoint é assíncrono, isto é, você irá pedir a assinatura dos documentos e receberá uma resposta quase imediata da ZapSign. Conforme os documentos forem ficando prontos, você irá receber os webhooks em sua aplicação um por vez. Recomendamos o envio de 100 documentos por vez.

Usuário assinando um documento via endpoint de assinatura em lote.
Como conseguir seu user token

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

Assinatura em API
Tipos de tokens e como localizá-los.
Configurações > Meu perfil > Dados Pessoais
Como utilizar o Postman para assinar em lote;
Como conseguir o user_token;
Como conseguir o signers_token;
LogoSign in batch | ZapSign WorkspacePostman