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

Was this helpful?

  1. Antecedentes
  2. Criar uma Consulta (Check)

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

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.

Exemplo de Requisição

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

Resposta

{
    "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"
}
PreviousCriar uma Consulta (Check)NextConsulta de Empresa

Last updated 14 days ago

Was this helpful?

person, credit_person_co, credit_person_br, . Mais detalhes sobre consultas disponíveis .

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
clique aqui