Detalhe do Check

Este endpoint retorna todas as informações completas de uma consulta de antecedentes, incluindo:

  • Os datasets que foram consultados.

  • As informações encontradas em cada base de dados.

  • As severidades associadas a cada achado.

A resposta inclui um JSON estruturado com todos os dados disponíveis, permitindo que você os analise e tome decisões automatizadas ou manuais conforme suas necessidades.

Recomendamos ler primeiro a seção Entendendo o Resultado para compreender como interpretar o score, os datasets, as severidades e como utilizar essas informações de forma eficaz.

GET https://api.zapsign.com.br/api/v1/checks/{{check_id}}/details/

Nome
Tipo
Descrição

Authorization*

string

Token da API com o prefixo "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Parâmetros de Path

Nome
Tipo
Descrição

check_id

string

Identificador da consulta

Parâmetros de Query

Nome
Tipo
Descrição

lang

string

Idioma dos resultados. Se não for especificado, os resultados estarão no idioma original das fontes. Valores possíveis: es, en, pt-br.

start_key

string

Paginação dos resultados. O parâmetro next na resposta indica a próxima página.

Possíveis estados de cada base de dados (result)

  • not_started: A coleta de dados da fonte foi ativada.

  • skipped: A fonte de dados foi ignorada por falta de informações suficientes para realizar a consulta.

  • delayed: A base de dados está demorando para responder.

  • completed: Os dados foram obtidos com sucesso.

  • error: Não foi possível obter dados da fonte.

  • expired: A fonte de dados estava indisponível no momento da consulta.

Response

Last updated

Was this helpful?