Consulta de Empresa

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

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

Header

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

Request Body

Nome	Tipo	Descrição
country*	string	BR | CO | MX. Mais detalhes sobre consultas disponíveis clique aqui.
type*	string	company, credit_company_co, credit_company_br. Mais detalhes sobre consultas disponíveis clique aqui.
user_authorized*	boolean	Indica se a empresa autorizou a validação. Deve ser true para prosseguir.
force_creation	boolean	Se true, força a criação de uma nova consulta de antecedentes, mesmo que já exista um resultado anterior. Se false, retorna o resultado da consulta anterior.
tax_id*	string	Documento de identificação oficial da empresa (RUT, CNPJ, RFC).
company_name	string	Nome da empresa. Se especificado, realiza uma consulta adicional em bases internacionais para detalhar os resultados.
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": "company",
    "country": "CO",
    "tax_id": "11111111"
}

Resposta

200 - Criado 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": "",
    "foreign_id": "",
    "tax_id": "11111111",
    "country": "CO",
    "native_country": "",
    "check_type": "company",
    "lang": "es",
    "region": "",
    "created_at": "2025-03-28T17:49:43.363416Z",
    "last_update_at": "2025-03-28T17:49:43.363435Z"
}