Check details

This endpoint returns the full details of a background check, including:

  • The datasets that were queried

  • The information found in each database

  • The severity levels associated with each finding

The response includes a structured JSON containing all available data, allowing you to analyze it and make automated or manual decisions based on your needs.

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

Path parameters

Nombre
Tipo
Descripción

check_id

string

Unique identifier of the check

Query parameters

Nombre
Tipo
Descripción

lang

string

Language of the results. If not specified, results are returned in the original language of the databases. Possible values: es, en, pt-br.

start_key

string

Used for pagination. The response includes a next parameter indicating the next page of results.

Nombre
Tipo
Descripción

Authorization*

string

API token prefixed with the word "Bearer". Example: Bearer c7f35c84-xxxx

Possible Statuses for Each Dataset (result field)

Status
Description

not_started

Data collection from the source has been triggered.

skipped

The source was skipped because there was not enough information to perform the check.

delayed

The source is taking longer than expected to return data.

completed

Data was successfully retrieved from the source.

error

Data could not be retrieved from the source.

expired

The data source was unavailable and could not be queried in time.

Response

Last updated

Was this helpful?