Datasets de Pessoa Jurídica
Os datasets de certidões e o dataset
economic_group_relationships são processados apenas no modo assíncrono (POST /person/async), por serem consultas mais demoradas (e, no caso do grupo econômico, com payload potencialmente grande). Em consultas sync, eles aparecem em failedDatasets com a mensagem Dataset disponível apenas na consulta assíncrona. Os demais datasets da lista podem ser usados em sync e async.datasets) e no retorno (campo result.datasets[].dataset).
Dados básicos (basic)
Disponibilidade: sync e async.
Exemplo de chamada
Exemplo de body:
datasets[].data):
Campos sem valor na fonte não são retornados.
Campos de
legalNature:
Cada item de
activities:
Valores de
taxIdStatus:
Valores de
taxRegime:
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
Endereços (addresses)
Disponibilidade: sync e async.
Exemplo de chamada
Exemplo de body:
datasets[].data):
Cada item de
addresses (campos sem valor na fonte não são retornados):
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
Telefones (phones)
Disponibilidade: sync e async.
Exemplo de chamada
Exemplo de body:
datasets[].data):
Cada item de
phones (campos sem valor na fonte não são retornados):
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
E-mails (emails)
Disponibilidade: sync e async. PF e PJ (mesmo código de dataset).
E-mails vinculados ao CNPJ, com indicadores de atividade e principalidade.
Quando usar: Validação de canal de comunicação digital, enriquecimento cadastral, verificação de contato corporativo.
Parâmetros da consulta:
Não há parâmetros em
query.
Exemplo de body:
datasets[].data):
Cada item de
emails:
Exemplo:
failedDatasets): a porta responde HTTP 200; o dataset entra em failedDatasets e não aparece em datasets. Os demais datasets da mesma requisição seguem normalmente.
Não confundir com
related_people_emails, que retorna e-mails de pessoas relacionadas (não os e-mails da própria empresa).Indicadores de atividade (activity_indicators)
Disponibilidade: sync e async. Apenas PJ (CNPJ).
Exemplo de chamada
Exemplo de body:
datasets[].data):
Campos sem valor na fonte não são retornados.
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
Grupo econômico de primeiro nível (economic_group_first_level)
Disponibilidade: sync e async. Apenas PJ (CNPJ).
Exemplo de chamada
Exemplo de body:
datasets[].data):
Campos sem valor na fonte não são retornados.
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
Relacionamentos do grupo econômico (economic_group_relationships)
Disponibilidade: apenas async. Em consultas sync, o dataset aparece em failedDatasets com a mensagem Dataset disponível apenas na consulta assíncrona. Apenas PJ (CNPJ).
Retorna os relacionamentos do grupo econômico (atuais e históricos) com totais. A consulta pode levar mais de 30 segundos e o retorno pode ter vários megabytes.
Exemplo de chamada
Exemplo de body:
datasets[].data):
Campos sem valor na fonte não são retornados.
Cada item de
relationships, currentRelationships e historicalRelationships:
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
Relacionamentos (relationships)
Disponibilidade: sync e async. Apenas PJ (CNPJ).
Retorna o quadro societário (QSA) atual da empresa, apenas com os relacionamentos diretos.
Exemplo de chamada
Exemplo de body:
datasets[].data):
Neste dataset, data é uma lista de relacionamentos (não um objeto). Quando a fonte não traz sócios, data vem como {}.
Cada item de data (campos sem valor na fonte não são retornados):
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
E-mails de pessoas relacionadas (related_people_emails)
Disponibilidade: sync e async. Apenas PJ (CNPJ).
Exemplo de chamada
Exemplo de body:
datasets[].data):
Cada item de
emails (campos sem valor na fonte não são retornados):
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
Telefones de pessoas relacionadas (related_people_phones)
Disponibilidade: sync e async. Apenas PJ (CNPJ).
Exemplo de chamada
Exemplo de body:
datasets[].data):
Cada item de
phones (campos sem valor na fonte não são retornados):
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
KYC e Compliance (kyc)
Disponibilidade: sync e async.
Exemplo de chamada
Exemplo de body:
datasets[].data):
Campos sem valor na fonte não são retornados.
Cada item de
pepHistory:
Cada item de
sanctionsHistory:
Campos de
details e normalizedDetails (todos opcionais):
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
Processos Judiciais e Administrativos (processes)
Disponibilidade: sync e async.
Exemplo de chamada
Exemplo de body:
datasets[].data):
Campos sem valor na fonte não são retornados.
Cada item de
processes:
Cada item de
parties:
Valores de
courtLevel (instância):
Valores de
courtType:
Valores de
status:
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
Certidão de Regularidade do FGTS (fgts_company)
Disponibilidade: apenas async. Em consultas sync, o dataset aparece em failedDatasets com a mensagem Dataset disponível apenas na consulta assíncrona. Apenas PJ (CNPJ).
Cada certidão inclui o PDF emitido pelo órgão, disponível em fileUrl. Para baixar, veja Obtenha o PDF da certidão.
Exemplo de chamada
Exemplo de body:
datasets[].data):
Cada item de
certificates (campos sem valor na fonte não são retornados):
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
Certidão Negativa de Débitos Trabalhistas (labor_debt_certificate_company)
Disponibilidade: apenas async. Em consultas sync, o dataset aparece em failedDatasets com a mensagem Dataset disponível apenas na consulta assíncrona. Apenas PJ (CNPJ).
Cada certidão inclui o PDF emitido pelo órgão, disponível em fileUrl. Para baixar, veja Obtenha o PDF da certidão.
Exemplo de chamada
Exemplo de body:
datasets[].data):
Cada item de
certificates (campos sem valor na fonte não são retornados):
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
Certidão Negativa de Débitos Federais (cnd_federal_company)
Disponibilidade: sync e async. Apenas PJ (CNPJ).
Certidão conjunta RFB/PGFN com código de controle, datas de emissão/validade e PDF via Storage. Mesmo contrato de cnd_federal_person, com chave CNPJ.
Quando usar: Compliance fiscal, due diligence, verificação de regularidade tributária federal da empresa.
Parâmetros da consulta:
Não há parâmetros em
query.
Exemplo de body:
datasets[].data):
fileUrl exige autenticação — veja Obtenha o PDF da certidão.
Exemplo:
failedDatasets): a porta responde HTTP 200; o dataset entra em failedDatasets e não aparece em datasets. Os demais datasets da mesma requisição seguem normalmente.
Exemplo de retorno com falha:
Certidão PGFN (pgfn_certificate_company)
Disponibilidade: apenas async. Em consultas sync, o dataset aparece em failedDatasets com a mensagem Dataset disponível apenas na consulta assíncrona. Apenas PJ (CNPJ).
Cada certidão inclui o PDF emitido pelo órgão, disponível em fileUrl. Para baixar, veja Obtenha o PDF da certidão.
Exemplo de chamada
Exemplo de body:
datasets[].data):
Cada item de
certificates (campos sem valor na fonte não são retornados):
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
Certidão Negativa IBAMA (ibama_cert_negativa_company)
Disponibilidade: apenas async. Em consultas sync, o dataset aparece em failedDatasets com a mensagem Dataset disponível apenas na consulta assíncrona. Apenas PJ (CNPJ).
Cada certidão inclui o PDF emitido pelo órgão, disponível em fileUrl. Para baixar, veja Obtenha o PDF da certidão.
Exemplo de chamada
Exemplo de body:
datasets[].data):
Cada item de
certificates (campos sem valor na fonte não são retornados):
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
Beneficiário Final (ultimate_beneficial_owner)
Disponibilidade: sync e async. PF e PJ (mesmo código de dataset).
Exemplo de chamada
Exemplo de body:
datasets[].data):
O documento consultado não vem em data — use o key da requisição. companies: [] é retorno de sucesso (não há nós na cadeia). Campos sem valor na fonte não são retornados.
Cada item de
companies:
Cada item de
history:
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
Localização mais frequente (most_frequent_location)
Disponibilidade: sync e async. PF e PJ (mesmo código de dataset).
Verifica se o dispositivo associado ao telefone esteve com frequência na área do CEP informado.
Exemplo de chamada
Exemplo de body:
datasets[].data):
Quando a operadora não retorna resultado para o telefone, data vem como {}.
O score mais baixo indica que este número esteve pouco ou raramente no local, ou pode estar associado a baixa cobertura de rede pela operadora nos locais consultados.
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
Troca de chip — SIM Swap (sim_swap)
Disponibilidade: sync e async. PF e PJ (mesmo código de dataset).
Indica se houve troca de chip (SIM swap) no período consultado.
Exemplo de chamada
Exemplo de body:
datasets[].data):
Quando a operadora não retorna resultado para o telefone, data vem como {}.
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
Troca de aparelho — Device Swap (device_swap)
Disponibilidade: sync e async. PF e PJ (mesmo código de dataset).
Indica se o chip foi instalado em outro aparelho (device swap) no período consultado.
Exemplo de chamada
Exemplo de body:
datasets[].data):
Quando a operadora não retorna resultado para o telefone, data vem como {}.
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
Consulta Score e Dados Completo PJ (score_complete_pj)
Documentação técnica
Disponibilidade: sync e async. Apenas PJ (CNPJ).
Exemplo de chamada
Exemplo de body:
datasets[].data):
Objetos aninhados (bestInfo, score, negative, etc.) vêm em camelCase. Datas no formato { Year, Month, Day } da fonte são convertidas para YYYY-MM-DD.
Valores de
cpStatus:
Exemplo:
datasets); ele aparece em failedDatasets, com o nome do dataset e o motivo em reason. Os outros datasets da mesma chamada que tiverem sucesso continuam em datasets normalmente.
Exemplo de retorno com falha:
Uso no request
Sync e async usam a mesma URI em cada modo. Escolha o body conforme a forma de selecionar os datasets:
No modo sync, datasets marcados como apenas assíncrono não são processados: os demais datasets da requisição seguem normalmente e os async-only retornam em
failedDatasets.