Consulta de Pessoa

Este endpoint é utilizado para criar uma consulta de pessoa ou de histórico de crédito de pessoa.

Os parâmetros que você deve enviar variam conforme o país e o tipo de consulta. Além disso, existem parâmetros opcionais que podem melhorar os resultados consultando mais bases de dados e ajudando a filtrar homônimos em alguns casos.

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

Header

Campo	Tipo	Descrição
Authorization*	string	Token da API com prefixo "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-xxxxxx

Request Body

Campo	Tipo	Descrição
country*	string	BR | CO | CL | MX | PE. Mais detalhes sobre consultas disponíveis [clique aqui].
type*	string	person, credit_person_co, credit_person_br, . Mais detalhes sobre consultas disponíveis clique aqui.
user_authorized*	boolean	Indica se a pessoa autorizou a validação. Deve ser true para prosseguir.
force_creation	boolean	Se true, força a criação de uma nova consulta mesmo se já houver uma anterior. Se false, retorna o resultado existente.
national_id	string	Documento de identidade oficial. Deve ser enviado national_id, foreign_id, ptp ou ppt.
foreign_id	string	Documento de identidade de estrangeiro. Deve ser enviado um dos seguintes: national_id, foreign_id, ptp ou ppt. Disponível para CO, CL, MX e PE.
first_name	string	Nome da pessoa. Ajuda a buscar em bases de dados internacionais para detalhes adicionais.
last_name	string	Sobrenome da pessoa. Também usado para buscas internacionais.
region	string	Obrigatório para BR. Região para consulta de antecedentes. Pode ser uma região específica ou ALL para consulta nacional (consultas nacionais podem levar até 24h). Ex: DF, SP, RJ, ALL, etc.
ptp	string	Permissão de Proteção Temporária no Peru (PE).
ppt	string	Permissão de Proteção Temporária na Colômbia (CO).
date_of_birth	string	Data de nascimento no formato YYYY-MM-DD. Obrigatório para estrangeiros (foreign_id) em CL e CO, e para documentos nacionais em PE e BR. Em outros casos, ajuda a melhorar os resultados.
issue_number	string	Número de emissão do documento no Chile (CL), usado para mais detalhes.
custom_input	string	Identificador externo opcional (até 128 caracteres).
state_id	string	RG (Registro Geral) no Brasil. Necessário para antecedentes completos. Omite caracteres especiais.
verification_code	string	Código de verificação para registros criminais no Peru e Chile.
issue_date	DateTime	Data de emissão do documento no formato YYYY-MM-DD. Aplica para CL e CO.
observers	array<string>	Representa os observadores da consulta de antecedentes (limite de 20), ou seja, endereços de e-mail que serão notificados quando a consulta de antecedentes for concluída. É um array de strings.

Importante: Cada consulta de antecedentes gera um custo adicional conforme o tipo de consulta. Você pode recarregar sua conta no painel acessando: Planos e Preços > Créditos

Exemplo de Requisição

{
    "user_authorized": true,
    "force_creation": true,
    "type": "person",
    "country": "BR",
    "national_id": "111.111.111-11"
}

Resposta

200 - Consulta criada com sucesso

{
    "check_id": "CHK682a755bb7135140248cc8dd1d290a01",
    "status": "not_started",
    "company_name": "",
    "full_name": "",
    "first_name": "",
    "last_name": "",
    "date_of_birth": null,
    "issue_date": null,
    "national_id": "111.111.111-1",
    "foreign_id": "",
    "tax_id": "",
    "country": "BR",
    "native_country": "",
    "check_type": "person",
    "lang": "es",
    "region": "",
    "created_at": "2025-03-28T17:49:43.363416Z",
    "last_update_at": "2025-03-28T17:49:43.363435Z"
}