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
  • 1. Criar um check de pessoa ou empresa
  • 2. Utilizar o webhook de resultados
  • 3. Consultar os resultados

Was this helpful?

  1. Antecedentes

Criar uma Consulta (Check)

PreviousEntendendo o ResultadoNextConsulta de Pessoa

Last updated 21 days ago

Was this helpful?

Se você está integrando os checks de antecedentes via API da ZapSign, este é o fluxo que recomendamos seguir para uma implementação correta e uma melhor experiência:

1. Criar um check de pessoa ou empresa

O primeiro passo é fazer uma solicitação ao nosso endpoint de criação de check. Após o envio, o check entra em processo de verificação.

⏱ Tempo estimado de processamento: entre 2 minutos e 2 horas, dependendo das bases de dados consultadas e do país.

2.

Recomendamos configurar um webhook para receber automaticamente uma notificação quando o check for concluído.

  • Quando o check for finalizado, a ZapSign enviará uma notificação HTTP POST para o webhook configurado no seu sistema, informando que os resultados estão prontos para consulta.

  • Assim, você evita a necessidade de fazer múltiplas requisições de consulta (polling) ao servidor.

3. Consultar os resultados

Após receber o webhook ou passado o tempo estimado de processamento, você pode obter os resultados através dos nossos endpoints:

  • Este endpoint retorna o JSON completo com todas as informações encontradas, incluindo:

    • Score global

    • Detalhes por dataset

    • Severidades associadas a cada achado

  • Se precisar de uma versão legível e pronta para compartilhamento, é possível baixar o PDF do check.

Dica: Utilizar o webhook junto com os endpoints de consulta garante um fluxo mais eficiente e automatizado, evitando esperas desnecessárias e chamadas redundantes à API.

Utilizar o webhook de resultados
Detalhe do Check
Consultar Check