Pessoa Física - Plataforma ID

Os datasets de certidões e de status_person são processados apenas no modo assíncrono (POST /person/async), por serem consultas mais demoradas. 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.

Dados básicos (`basic`)

Disponibilidade: sync e async. Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["basic"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`cpf`	string	CPF	`"12345678901"`	CPF da pessoa
`name`	string	—	`"João da Silva"`	Nome completo
`birthDate`	string	ISO 8601	`"1980-05-15T00:00:00Z"`	Data de nascimento
`birthPlace`	string	—	`"Brazil"`	País de nascimento
`gender`	string	`M` Masculino; `F` Feminino; `U` Não informado	`"M"`	Gênero
`nationality`	string	—	`"Brazil"`	Nacionalidade
`motherName`	string	—	`"Maria da Silva"`	Nome da mãe
`fatherName`	string	—	`"José da Silva"`	Nome do pai
`taxIdStatus`	string	ver tabela abaixo	`"REGULAR"`	Status do CPF na Receita Federal
`hasObitIndication`	boolean	`true` / `false`	`false`	Indicação de óbito
`obitIndicationYear`	string	Ano	`"2020"`	Ano de óbito — só retorna quando `hasObitIndication` é `true`
`maritalStatus`	string	—	`"SOLTEIRO"`	Estado civil
`age`	number	Inteiro	`28`	Idade no momento da consulta

Valores de taxIdStatus:

Valor	Significado
`REGULAR`	Documento válido e ativo
`CANCELLED`	Documento cancelado
`SUSPENDED`	Documento suspenso
`INVALID`	Documento inválido
`PENDING`	Pendente de regularização
`DECEASED`	Titular falecido
`INCOMPLETE`	Dados incompletos
`NOT_FOUND`	Documento não existe na base
`DATA_MISMATCH`	Data de nascimento não confere

Exemplo:

{
  "dataset": "basic",
  "data": {
    "cpf": "12345678901",
    "name": "João da Silva",
    "birthDate": "1980-05-15T00:00:00Z",
    "birthPlace": "Brazil",
    "gender": "M",
    "nationality": "Brazil",
    "motherName": "Maria da Silva",
    "fatherName": "José da Silva",
    "taxIdStatus": "REGULAR",
    "hasObitIndication": false,
    "maritalStatus": "SOLTEIRO",
    "age": 45
  }
}

Exemplo de exceções Se a consulta deste dataset falhar, a API ainda responde HTTP 200 — a requisição foi aceita. O resultado não vem na lista de sucessos (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.

Cenário	O que acontece	Exemplo de `reason`
CPF inválido / chave inválida	Não processa o dataset	`Chave inválida: 123456789`
Registro não encontrado na fonte	Falha na consulta	`Registro não encontrado, ou inválido.`
Erro temporário na fonte	Falha na consulta	`Erro ao processar o dataset`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "basic",
      "reason": "Chave inválida: 123456789"
    }
  ]
}

Endereços (`addresses`)

Disponibilidade: sync e async. Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["addresses"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`addresses`	array	—	—	Lista de endereços

Cada item de addresses (campos sem valor na fonte não são retornados):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`streetAddress`	string	—	`"Rua das Flores, 123"`	Logradouro completo
`addressLocality`	string	—	`"São Paulo"`	Cidade
`addressRegion`	string	UF	`"SP"`	Estado
`postalCode`	string	CEP	`"01234-567"`	CEP
`addressCountry`	string	—	`"Brazil"`	País
`complement`	string	—	`"AP 6604"`	Complemento
`neighborhood`	string	—	`"COPACABANA"`	Bairro
`isActive`	boolean	`true`	`true`	Endereço ativo — só retorna quando `true`
`isMain`	boolean	`true`	`true`	Endereço principal — só retorna quando `true`

Exemplo:

{
  "dataset": "addresses",
  "data": {
    "addresses": [
      {
        "streetAddress": "Rua das Flores, 123",
        "addressLocality": "São Paulo",
        "addressRegion": "SP",
        "postalCode": "01234-567",
        "addressCountry": "Brazil",
        "complement": "AP 101",
        "neighborhood": "Centro",
        "isActive": true,
        "isMain": true
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
CPF inválido / chave inválida	Não processa o dataset	`Chave inválida: 123456789`
Registro não encontrado na fonte	Falha na consulta	`Registro não encontrado, ou inválido.`
Erro temporário na fonte	Falha na consulta	`Erro ao processar o dataset`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "addresses",
      "reason": "Chave inválida: 123456789"
    }
  ]
}

Telefones (`phones`)

Disponibilidade: sync e async. Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["phones"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`phones`	array	—	—	Lista de telefones

Cada item de phones:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`number`	string	—	`"992***015"`	Número (pode vir mascarado)
`areaCode`	string	DDD	`"47"`	DDD
`countryCode`	string	—	`"55"`	Código do país
`lastValidationDate`	string	ISO 8601	`"2025-05-04T00:00:00Z"`	Última validação
`firstPassageDate`	string	ISO 8601	`"2020-01-15T00:00:00Z"`	Primeira passagem
`lastPassageDate`	string	ISO 8601	`"2025-05-04T00:00:00Z"`	Última passagem
`creationDate`	string	ISO 8601	`"2020-01-15T00:00:00Z"`	Criação do registro
`lastUpdateDate`	string	ISO 8601	`"2025-05-04T00:00:00Z"`	Última atualização

Exemplo:

{
  "dataset": "phones",
  "data": {
    "phones": [
      {
        "number": "992***015",
        "areaCode": "47",
        "countryCode": "55",
        "lastUpdateDate": "2025-05-04T00:00:00Z"
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
CPF inválido / chave inválida	Não processa o dataset	`Chave inválida: 123456789`
Registro não encontrado na fonte	Falha na consulta	`Registro não encontrado, ou inválido.`
Erro temporário na fonte	Falha na consulta	`Erro ao processar o dataset`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "phones",
      "reason": "Chave inválida: 123456789"
    }
  ]
}

E-mails (`emails`)

Disponibilidade: sync e async. Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["emails"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`emails`	array	—	—	Lista de e-mails

Cada item de emails:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`email`	string	—	`"joao@example.com"`	Endereço de e-mail
`isActive`	boolean	`true` / `false`	`true`	E-mail ativo
`isMain`	boolean	`true` / `false`	`true`	E-mail principal
`lastValidationDate`	string	ISO 8601	`"2025-05-04T00:00:00Z"`	Última validação
`firstPassageDate`	string	ISO 8601	`"2020-01-15T00:00:00Z"`	Primeira passagem
`lastPassageDate`	string	ISO 8601	`"2025-05-04T00:00:00Z"`	Última passagem
`creationDate`	string	ISO 8601	`"2020-01-15T00:00:00Z"`	Criação do registro
`lastUpdateDate`	string	ISO 8601	`"2025-05-04T00:00:00Z"`	Última atualização

Exemplo:

{
  "dataset": "emails",
  "data": {
    "emails": [
      {
        "email": "joao@example.com",
        "isActive": true,
        "isMain": true,
        "lastUpdateDate": "2025-05-04T00:00:00Z"
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
CPF inválido / chave inválida	Não processa o dataset	`Chave inválida: 123456789`
Registro não encontrado na fonte	Falha na consulta	`Registro não encontrado, ou inválido.`
Erro temporário na fonte	Falha na consulta	`Erro ao processar o dataset`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "emails",
      "reason": "Chave inválida: 123456789"
    }
  ]
}

Dados Profissionais (`occupations`)

Disponibilidade: sync e async. Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["occupations"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`occupations`	array	—	—	Lista de ocupações

Cada item de occupations:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`jobTitle`	string	—	`"Desenvolvedor de Software"`	Cargo
`worksFor`	string	—	`"Empresa Exemplo LTDA"`	Empresa
`occupationalCategory`	string	—	`"Tecnologia da Informação"`	Categoria ocupacional
`addressLocality`	string	—	`"São Paulo"`	Cidade
`addressRegion`	string	UF	`"SP"`	Estado
`addressCountry`	string	—	`"Brazil"`	País
`companyIdNumber`	string	CNPJ	`"12345678000190"`	CNPJ da empresa
`sector`	string	`PRIVATE` Setor privado; `PUBLIC` Setor público	`"PRIVATE"`	Setor
`status`	string	`ACTIVE` Ativo; `INACTIVE` Inativo	`"ACTIVE"`	Situação empregatícia
`startDate`	string	YYYY-MM-DD	`"2020-01-15"`	Data de início
`endDate`	string	YYYY-MM-DD	`"2023-12-31"`	Data de término
`income`	number	Reais (R$)	`5000`	Renda estimada em reais

Exemplo:

{
  "dataset": "occupations",
  "data": {
    "occupations": [
      {
        "jobTitle": "Desenvolvedor de Software",
        "worksFor": "Empresa Exemplo LTDA",
        "occupationalCategory": "Tecnologia da Informação",
        "sector": "PRIVATE",
        "status": "ACTIVE",
        "startDate": "2020-01-15",
        "income": 5000
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
CPF inválido / chave inválida	Não processa o dataset	`Chave inválida: 123456789`
Registro não encontrado na fonte	Falha na consulta	`Registro não encontrado, ou inválido.`
Erro temporário na fonte	Falha na consulta	`Erro ao processar o dataset`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "occupations",
      "reason": "Chave inválida: 123456789"
    }
  ]
}

Profissões (`professions`)

Disponibilidade: sync e async. Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["professions"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`professions`	array	—	—	Lista de profissões

Cada item de professions usa o mesmo contrato de campos de occupations:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`jobTitle`	string	—	`"Desenvolvedor de Software"`	Cargo
`worksFor`	string	—	`"Empresa Exemplo LTDA"`	Empresa
`occupationalCategory`	string	—	`"Tecnologia da Informação"`	Categoria ocupacional
`addressLocality`	string	—	`"São Paulo"`	Cidade
`addressRegion`	string	UF	`"SP"`	Estado
`addressCountry`	string	—	`"Brazil"`	País
`companyIdNumber`	string	CNPJ	`"12345678000190"`	CNPJ da empresa
`sector`	string	`PRIVATE` Setor privado; `PUBLIC` Setor público	`"PRIVATE"`	Setor
`status`	string	`ACTIVE` Ativo; `INACTIVE` Inativo	`"ACTIVE"`	Situação empregatícia
`startDate`	string	YYYY-MM-DD	`"2020-01-15"`	Data de início
`endDate`	string	YYYY-MM-DD	`"2023-12-31"`	Data de término
`income`	number	Reais (R$)	`5000`	Renda estimada em reais

Exemplo:

{
  "dataset": "professions",
  "data": {
    "professions": [
      {
        "jobTitle": "Desenvolvedor de Software",
        "worksFor": "Empresa Exemplo LTDA",
        "startDate": "2020-01-15",
        "endDate": "2023-12-31",
        "status": "INACTIVE"
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
CPF inválido / chave inválida	Não processa o dataset	`Chave inválida: 123456789`
Registro não encontrado na fonte	Falha na consulta	`Registro não encontrado, ou inválido.`
Erro temporário na fonte	Falha na consulta	`Erro ao processar o dataset`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "professions",
      "reason": "Chave inválida: 123456789"
    }
  ]
}

Carteira Nacional de Habilitação (`cnh`)

Disponibilidade: sync e async. Apenas PF (CPF). Consulta a CNH nacional (versão simples) vinculada ao CPF. Quando usar: Validação de identidade, onboarding, conferência de categoria e validade da habilitação. Parâmetros da consulta:

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["cnh"]
}

Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato	Exemplo
`state`	string	UF de emissão	`"SP"`
`registrationNumber`	string	Número de registro da CNH	`"00000000000"`
`renach`	string	Número RENACH	`"SP000000000"`
`formNumber`	string	Número do formulário	`"0000000000"`
`category`	string	Categoria	`"AB"`
`authorizedCategory`	string	Categoria autorizada	`"AB"`
`expirationDate`	string	DD/MM/YYYY	`"01/01/2030"`
`firstLicenseDate`	string	DD/MM/YYYY	`"01/01/2010"`
`lastIssueDate`	string	DD/MM/YYYY	`"01/06/2020"`
`registrationDate`	string	DD/MM/YYYY	`"01/01/2010"`
`requestType`	string	Tipo da requisição	`"RENOVACAO DE CNH"`
`driver`	object	Dados do condutor	ver tabela abaixo

Campos de driver:

Campo	Tipo	Descrição	Exemplo
`name`	string	Nome do condutor	`"João da Silva"`
`cpf`	string	CPF do condutor	`"12345678901"`
`birthDate`	string	Data de nascimento (DD/MM/YYYY)	`"15/05/1990"`
`gender`	string	Gênero	`"M"`
`motherName`	string	Nome da mãe	`"Maria da Silva"`
`fatherName`	string	Nome do pai	`"José da Silva"`
`documentType`	string	Tipo do documento de identificação	`"CARTEIRA IDENTIDADE"`
`documentNumber`	string	Número do documento	`"00000000000"`
`documentIssuer`	string	Órgão expedidor	`"SSP"`
`documentIssuerState`	string	UF do órgão expedidor	`"SP"`
`pgu`	string	PGU do condutor	`"000000000"`
`nationality`	string	Nacionalidade	`"BRASILEIRO(A)"`
`birthPlace`	string	Local de nascimento	`"SAO PAULO"`

Exemplo:

{
  "dataset": "cnh",
  "data": {
    "state": "SP",
    "registrationNumber": "00000000000",
    "renach": "SP000000000",
    "category": "AB",
    "expirationDate": "01/01/2030",
    "driver": {
      "name": "João da Silva",
      "cpf": "12345678901",
      "birthDate": "15/05/1990"
    }
  }
}

Falhas (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.

Cenário	O que acontece	Exemplo de `reason`
Nenhum registro encontrado	Falha na consulta	`[cnh_nacional_simples_v2] Nenhum registro encontrado.`
Resposta vazia / inválida da fonte	Falha na consulta	`[cnh_nacional_simples_v2] Resposta vazia da fonte de dados.`
HTTP 404/400 da fonte	Falha na consulta	`Registro não encontrado, ou inválido.`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "cnh",
      "reason": "[cnh_nacional_simples_v2] Nenhum registro encontrado."
    }
  ]
}

Carteira Nacional de Habilitação Completa (`cnh_complete`)

Disponibilidade: sync e async. Apenas PF (CPF). Consulta a CNH nacional completa (inclui bloqueios, cursos e exames quando disponíveis). Quando usar: Due diligence de habilitação, análise de restrições/bloqueios, validação aprofundada do condutor. Parâmetros da consulta:

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["cnh_complete"]
}

Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato	Exemplo
`state`	string	UF de emissão	`"SP"`
`registrationNumber`	string	Número de registro	`"00000000000"`
`renach`	string	RENACH	`"SP000000000"`
`cardNumber`	string	Número da cédula	`"000000000"`
`category`	string	Categoria	`"AB"`
`expirationDate`	string	DD/MM/YYYY	`"10/11/2032"`
`firstLicenseDate`	string	DD/MM/YYYY	`"30/03/2007"`
`lastIssueDate`	string	DD/MM/YYYY	`"12/11/2022"`
`address`	string	Endereço do condutor	`"RUA EXEMPLO, 146 - CENTRO - 13084280"`
`city`	string	Cidade	`"CAMPINAS"`
`observations`	string	Observações	`"indisponível"`
`driver`	object	Dados do condutor (mesmos campos da tabela de `driver` em `cnh`)	—
`blocks`	array	Bloqueios com datas válidas (DD/MM/YYYY)	ver tabela abaixo
`courses`	array	Cursos vinculados	—
`exams`	array	Exames (estrutura variável)	—

Campos de blocks:

Campo	Tipo	Descrição	Exemplo
`description`	string	Descrição do bloqueio	`"CASSAÇÃO CNH"`
`blockDate`	string	Data do bloqueio (DD/MM/YYYY)	`"05/02/2025"`
`penaltyStartDate`	string	Início da penalidade	`"05/02/2025"`
`penaltyEndDate`	string	Fim da penalidade	`"04/02/2027"`
`blockReleaseDate`	string	Data de liberação	`"10/02/2027"`
`blockDocument`	string	Documento gerador do bloqueio	`"DECISÃO JUDICIAL"`
`releaseDocument`	string	Documento gerador da liberação	`"DECISÃO JUDICIAL"`
`blockReason`	string	Motivo do bloqueio	`"REINCIDÊNCIA"`
`releaseReason`	string	Motivo da liberação	`"CUMPRIMENTO DE PENALIDADE"`
`responsibleAgency`	string	Órgão responsável	`"DETRAN"`
`penaltyTerm`	number/string	Prazo da penalidade (dias)	`729`
`penaltyTermTotal`	number/string	Prazo total (dias)	`729`
`cnhCollection`	string	Indicativo de recolhimento da CNH	`"SIM"`
`releaseRequirements`	string	Requisitos para liberação	`"QUITAÇÃO DA PENALIDADE"`
`updateType`	string	Tipo de atualização	`"INCLUSÃO"`
`blockDecisionType`	string	Tipo de decisão	`"ADMINISTRATIVA"`
`insertionDate`	string	Data de inserção do registro	`"05/02/2025"`

Só entram em blocks os bloqueios cujas datas de bloqueio, início e fim da penalidade são válidas (DD/MM/YYYY e existentes no calendário).

Exemplo:

{
  "dataset": "cnh_complete",
  "data": {
    "state": "SP",
    "registrationNumber": "00000000000",
    "category": "AB",
    "expirationDate": "10/11/2032",
    "driver": { "name": "João da Silva", "cpf": "12345678901" },
    "blocks": [],
    "courses": [],
    "exams": []
  }
}

Falhas (failedDatasets): mesmo comportamento de cnh (HTTP 200; dataset em failedDatasets).

Cenário	O que acontece	Exemplo de `reason`
Nenhum registro encontrado	Falha na consulta	`[cnh_nacional_completa_v4] Nenhum registro encontrado.`
Resposta vazia / inválida da fonte	Falha na consulta	`[cnh_nacional_completa_v4] Resposta vazia da fonte de dados.`
HTTP 404/400 da fonte	Falha na consulta	`Registro não encontrado, ou inválido.`

Relacionamentos Econômicos (`business_relationships`)

Disponibilidade: sync e async. Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["business_relationships"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`businessRelationships`	array	—	—	Lista de relacionamentos

Cada item de businessRelationships:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`key`	string	CPF/CNPJ	`"12345678000190"`	Documento da entidade relacionada
`name`	string	—	`"Empresa Relacionada LTDA"`	Nome da entidade
`addressCountry`	string	—	`"BRAZIL"`	País de identificação fiscal
`relatedEntityTaxIdType`	string	`CPF`, `CNPJ`	`"CNPJ"`	Tipo de documento
`relationshipName`	string	—	`"Sócio"`	Nome do relacionamento
`relationshipType`	string	`EMPLOYMENT`, `PARTNER`, `OWNERSHIP`, `LEGAL_REPRESENTATIVE`	`"OWNERSHIP"`	Tipo do relacionamento
`startDate`	string	YYYY-MM-DD	`"2020-01-15"`	Início
`endDate`	string	YYYY-MM-DD	`"2023-12-31"`	Término
`isCurrentlyActive`	boolean	`true` / `false`	`true`	Relacionamento ativo

Exemplo:

{
  "dataset": "business_relationships",
  "data": {
    "businessRelationships": [
      {
        "key": "12345678000190",
        "name": "Empresa Relacionada LTDA",
        "relatedEntityTaxIdType": "CNPJ",
        "relationshipName": "Sócio",
        "relationshipType": "OWNERSHIP",
        "startDate": "2020-01-15",
        "isCurrentlyActive": true
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
CPF inválido / chave inválida	Não processa o dataset	`Chave inválida: 123456789`
Registro não encontrado na fonte	Falha na consulta	`Registro não encontrado, ou inválido.`
Erro temporário na fonte	Falha na consulta	`Erro ao processar o dataset`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "business_relationships",
      "reason": "Chave inválida: 123456789"
    }
  ]
}

Informações Financeiras (`financial_data`)

Disponibilidade: sync e async. Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["financial_data"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`totalAssets`	string	`ABAIXO DE 100K`, `100K A 250K`, `250K A 500K`, `500K A 1MM`, `1 A 5MM`, `ACIMA DE 5MM`	`"500K A 1MM"`	Estimativa de patrimônio
`taxReturns`	array	—	—	Histórico de restituições de IR
`creationDate`	string	YYYY-MM-DD	`"2023-05-15"`	Criação do registro
`lastUpdateDate`	string	YYYY-MM-DD	`"2023-05-20"`	Última atualização

Cada item de taxReturns:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`year`	string	—	`"2023"`	Ano da declaração
`status`	string	—	`"CREDITADA"`	Status da restituição
`bank`	string	—	`"BANCO EXEMPLO S.A."`	Banco
`branch`	string	—	`"1234"`	Agência
`batch`	string	—	`"12345"`	Lote
`isVipBranch`	boolean	`true` / `false`	`false`	Segmento premium
`captureDate`	string	YYYY-MM-DD	`"2023-05-15"`	Data de captura
`creationDate`	string	YYYY-MM-DD	`"2023-05-15"`	Criação
`lastUpdateDate`	string	YYYY-MM-DD	`"2023-05-20"`	Atualização

Exemplo:

{
  "dataset": "financial_data",
  "data": {
    "totalAssets": "500K A 1MM",
    "taxReturns": [
      {
        "year": "2023",
        "status": "CREDITADA",
        "bank": "BANCO EXEMPLO S.A.",
        "branch": "1234",
        "batch": "12345",
        "isVipBranch": false
      }
    ],
    "creationDate": "2023-05-15",
    "lastUpdateDate": "2023-05-20"
  }
}

Cenário	O que acontece	Exemplo de `reason`
CPF inválido / chave inválida	Não processa o dataset	`Chave inválida: 123456789`
Registro não encontrado na fonte	Falha na consulta	`Registro não encontrado, ou inválido.`
Erro temporário na fonte	Falha na consulta	`Erro ao processar o dataset`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "financial_data",
      "reason": "Chave inválida: 123456789"
    }
  ]
}

Consulta Score e Dados Completo PF (`score_complete_pf`)

Disponibilidade: sync e async. Apenas PF (CPF). Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["score_complete_pf"]
}

Exemplo de retorno Resposta de sucesso (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.

Campo	Tipo	Formato / enum	Exemplo	Descrição
`hasOptOut`	boolean / string	—	`false`	Indica se o CPF fez opt-out no Cadastro Positivo
`cpStatus`	string	ver tabela abaixo	`"1"`	Status no Cadastro Positivo
`segment`	string	—	`"3"`	Segmento do Cadastro Positivo ou do score de crédito
`hasOnlyMinimumPii`	boolean / string	—	`false`	Indica se o CPF possui apenas dados cadastrais mínimos
`hasCreditLines`	boolean / string	—	`false`	Indica se há histórico de hábitos de pagamento (Cadastro Positivo)
`hasNegativeData`	boolean / string	—	`true`	Indica se há negativação ou restrição cadastral
`hasInquiryData`	boolean / string	—	`false`	Indica se há histórico de consultas ao CPF
`bestInfo`	object	—	—	Dados cadastrais: nome, endereço, e-mail, telefones e históricos
`enterpriseData`	object	—	—	Participações societárias e vínculos empresariais
`score`	object	—	—	Score de crédito e indicadores associados
`negative`	object	—	—	Detalhes restritivos: negativações, ações judiciais e cheques sem fundo (CCF)
`inquiries`	object	—	—	Histórico de consultas recentes ao CPF
`countCreditLines`	number / string	—	`"0"`	Quantidade de linhas de crédito retornadas
`creditLines`	object	—	—	Hábitos de pagamento e linhas de crédito do Cadastro Positivo
`protests`	object	—	—	Protestos em cartório

Valores de cpStatus:

Valor	Significado
`0`	Opt-out explícito
`1`	Dados prontos
`2`	Período de resposta
`3`	Sem comunicação

Exemplo:

{
  "dataset": "score_complete_pf",
  "data": {
    "hasNegativeData": true,
    "hasInquiryData": false,
    "bestInfo": {
      "cpf": "12345678901",
      "cpfStatus": "R",
      "personName": {
        "name": { "full": "JOAO DA SILVA" },
        "dateLastSeen": "2024-03-09"
      },
      "dob": "1990-01-15"
    },
    "score": {
      "score": 750,
      "segment": "3"
    },
    "negative": {
      "pendenciesControlCred": "1",
      "apontamentos": {
        "apontamento": [
          { "companyName": "EMPRESA X", "amount": "100.00" }
        ]
      }
    }
  }
}

Cenário	O que acontece	Exemplo de `reason`
CPF inválido / chave inválida	Não processa o dataset	`Chave inválida: 123456789`
Dataset exclusivo de PF consultado com CNPJ	Não processa o dataset	`Invalid document type: this dataset is only available for individuals (CPF)`
CPF não encontrado na base	Falha na consulta	`[score_complete_pf] CPF não encontrado na base consultada.`
Cliente PEP/VIP — consulta restrita	Falha na consulta	`[score_complete_pf] Cliente PEP/VIP — consulta restrita.`
Cliente com bloqueio judicial	Falha na consulta	`[score_complete_pf] Cliente com bloqueio judicial.`
Cliente com bloqueio administrativo	Falha na consulta	`[score_complete_pf] Cliente com bloqueio administrativo.`
Cliente menor de idade	Falha na consulta	`[score_complete_pf] Cliente menor de idade.`
Cliente falecido	Falha na consulta	`[score_complete_pf] Cliente falecido com dados.` / `... sem dados.`
Módulo sem permissão	Falha na consulta	`[score_complete_pf] Módulo sem permissão na consulta.`
Nenhum registro encontrado	Falha na consulta	`[score_complete_pf] Nenhum registro encontrado.`
Código de negócio desconhecido	Falha na consulta	`[score_complete_pf] Não foi possível obter a consulta (código …).`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "score_complete_pf",
      "reason": "[score_complete_pf] CPF não encontrado na base consultada."
    }
  ]
}

Renda Presumida (`presumed_income`)

Disponibilidade: sync e async. Apenas PF (CPF). Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["presumed_income"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data): Campos sem valor na fonte não são retornados.

Campo	Tipo	Formato / enum	Exemplo	Descrição
`presumedIncome`	string	Reais inteiros ou `"n/a"`	`"5000"`	Renda mensal presumida (ex.: `5000` = R$ 5.000,00). Vem `"n/a"` quando não há renda calculável para o CPF (menor de idade ou óbito)
`hasPositiveData`	boolean	—	`true`	Indica se dados do Cadastro Positivo foram usados no cálculo
`minimumWageRange`	string	`0` a `8`	`"4"`	Faixa da renda em salários mínimos
`minimumWageRangeDescription`	string	—	`"2.64 SM - 4.29 SM"`	Descrição da faixa de renda em salários mínimos
`incomeRange`	string	ver tabela abaixo	`"4"`	Faixa de renda em reais
`incomeRangeDescription`	string	`Renda Baixa`, `Renda Média` ou `Renda Alta`	`"Renda Média"`	Classificação da renda
`referenceDate`	string	YYYY-MM-DD	`"2026-09-28"`	Data de referência usada no cálculo (data da consulta)

Valores de incomeRange:

Valor	Faixa
`0`	Sem faixa
`1`	Até R$ 1.500
`2`	R $1.500 a R$ 2.200
`3`	R $2.200 a R$ 3.200
`4`	R $3.200 a R$ 5.200
`5`	R $5.200 a R$ 7.200
`6`	R $7.200 a R$ 16.200
`7`	R $16.200 a R$ 30.000
`8`	Acima de R$ 30.000

Exemplo:

{
  "dataset": "presumed_income",
  "data": {
    "presumedIncome": "5000",
    "hasPositiveData": true,
    "minimumWageRange": "4",
    "minimumWageRangeDescription": "2.64 SM - 4.29 SM",
    "incomeRange": "4",
    "incomeRangeDescription": "Renda Média",
    "referenceDate": "2026-09-28"
  }
}

Renda não calculável (n/a) Quando o CPF pertence a um menor de idade ou a uma pessoa falecida, não há renda presumida. A consulta é considerada sucesso: o dataset vem em datasets, apenas com presumedIncome: "n/a", e não é cobrada.

{
  "dataset": "presumed_income",
  "data": {
    "presumedIncome": "n/a"
  }
}

Cenário	O que acontece	Exemplo de `reason`
CPF inválido / chave inválida	Não processa o dataset	`Chave inválida: 123456789`
Dataset exclusivo de PF consultado com CNPJ	Não processa o dataset	`Invalid document type: this dataset is only available for individuals (CPF)`
CPF recusado pela fonte	Falha na consulta	`[presumed_income] CPF inválido. Confirme o número informado.`
CPF não encontrado na base	Falha na consulta	`[presumed_income] CPF não encontrado na base consultada.`
Sem informações de renda para o CPF	Falha na consulta	`[presumed_income] Não encontramos informações de renda para o CPF informado.`
Cliente PEP/VIP — consulta restrita	Falha na consulta	`[presumed_income] Cliente PEP/VIP — consulta restrita.`
Cliente com bloqueio judicial	Falha na consulta	`[presumed_income] Cliente com bloqueio judicial.`
Cliente com bloqueio administrativo	Falha na consulta	`[presumed_income] Cliente com bloqueio administrativo.`
Nenhum registro encontrado	Falha na consulta	`[presumed_income] Nenhum registro encontrado.`
Código de negócio desconhecido	Falha na consulta	`[presumed_income] Não foi possível obter a renda presumida (código …).`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "presumed_income",
      "reason": "[presumed_income] Não encontramos informações de renda para o CPF informado."
    }
  ]
}

Processos Judiciais e Administrativos (`processes`)

Disponibilidade: sync e async. Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["processes"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data): Campos sem valor na fonte não são retornados.

Campo	Tipo	Formato / enum	Exemplo	Descrição
`processes`	array	—	—	Lista de processos
`totalProcesses`	number	—	`10`	Total de processos
`totalProcessesAsAuthor`	number	—	`3`	Como parte ativa
`totalProcessesAsDefendant`	number	—	`5`	Como parte passiva
`totalProcessesAsOther`	number	—	`2`	Outro tipo de parte
`firstProcessDate`	string	YYYY-MM-DD	`"2010-01-15"`	Data do primeiro processo
`lastProcessDate`	string	YYYY-MM-DD	`"2023-12-20"`	Data do último processo

Cada item de processes:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`number`	string	—	`"0000123-45.2023.8.26.0100"`	Número do processo
`procedureType`	string	Texto da fonte	`"PROCEDIMENTO DO JUIZADO ESPECIAL CIVEL"`	Classe processual
`subject`	string	Texto da fonte	`"DANO MORAL"`	Assunto principal do processo
`courtLevel`	number	ver tabela abaixo	`1`	Instância do processo
`courtType`	string	`CIVIL`, `CRIMINAL`, `TAX`, `SOCIAL_SECURITY`, `LABOR`, `SPECIAL_CIVIL`, `SPECIAL_CRIMINAL`, `ADMINISTRATIVE`, `ELECTORAL`, `TREASURY`, `SPECIAL_TREASURY`	`"CIVIL"`	Tipo de justiça/vara
`courtName`	string	—	`"TRT2"`	Sigla do tribunal
`partyType`	string	`ACTIVE` polo ativo; `PASSIVE` polo passivo; `NEUTRAL` demais	`"PASSIVE"`	Tipo de parte
`status`	string	`ACTIVE`, `ARCHIVED`, `SUSPENDED`, `CONCLUDED`, `EXTINCT`, `PENDING`, `IN_PROGRESS`, `RES_JUDICATA`	`"IN_PROGRESS"`	Status do processo, padronizado. Só retorna quando o texto da fonte é reconhecido
`statusRaw`	string	Texto da fonte, em maiúsculas	`"EM ANDAMENTO"`	Status do processo como informado pela fonte (retorna mesmo quando `status` não é reconhecido)
`parties`	array	—	—	Partes do processo
`lastMovementDate`	string	YYYY-MM-DD	`"2023-05-15"`	Última movimentação
`noticeDate`	string	YYYY-MM-DD	`"2023-05-10"`	Citação/notificação
`closeDate`	string	YYYY-MM-DD	`"2023-12-31"`	Encerramento
`resJudicataDate`	string	YYYY-MM-DD	`"2023-11-30"`	Trânsito em julgado
`value`	number	Reais (R$)	`50000`	Valor disputado
`captureDate`	string	YYYY-MM-DD	`"2023-05-15"`	Data de captura

Cada item de parties:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`document`	string	CPF/CNPJ, só dígitos	`"12345678901"`	Documento da parte
`name`	string	—	`"JOAO DA SILVA"`	Nome da parte
`polarity`	string	`ACTIVE`, `PASSIVE`, `NEUTRAL`	`"PASSIVE"`	Polo da parte no processo
`type`	string	Texto da fonte, em maiúsculas (ex.: `AUTHOR`, `DEFENDANT`, `CLAIMANT`, `CLAIMED`, `LAWYER`)	`"DEFENDANT"`	Tipo da parte
`isActive`	boolean	`true` / `false`	`true`	Indica se a parte continua ativa no processo

Valores de courtLevel (instância):

Valor	Significado
`1`	1ª Instância — início do processo em Vara ou Juizado, julgado por um juiz singular que analisa provas e profere a primeira sentença
`2`	2ª Instância — fase de recurso nos Tribunais (TJ, TRF, TRT), em que um colegiado de desembargadores mantém, altera ou anula a sentença
`3`	3ª Instância (Tribunais Superiores) — STJ, TST e STF, onde ministros julgam violações à lei federal ou à Constituição, sem reexaminar provas ou fatos

Valores de courtType:

Valor	Significado
`CIVIL`	Cível
`CRIMINAL`	Criminal
`TAX`	Tributária
`SOCIAL_SECURITY`	Previdenciária
`LABOR`	Trabalhista
`SPECIAL_CIVIL`	Especial Cível
`SPECIAL_CRIMINAL`	Especial Criminal
`ADMINISTRATIVE`	Administrativa
`ELECTORAL`	Eleitoral
`TREASURY`	Fazenda
`SPECIAL_TREASURY`	Especial Fazenda

Valores de status:

Valor	Significado
`ACTIVE`	Processo ativo
`IN_PROGRESS`	Processo em andamento
`PENDING`	Processo pendente
`SUSPENDED`	Processo suspenso
`ARCHIVED`	Processo arquivado
`CONCLUDED`	Processo concluído
`EXTINCT`	Processo extinto
`RES_JUDICATA`	Processo com trânsito em julgado

Exemplo:

{
  "dataset": "processes",
  "data": {
    "processes": [
      {
        "number": "0000123-45.2023.8.26.0100",
        "procedureType": "PROCEDIMENTO DO JUIZADO ESPECIAL CIVEL",
        "subject": "DANO MORAL",
        "courtLevel": 1,
        "courtType": "CIVIL",
        "courtName": "TJSP",
        "partyType": "PASSIVE",
        "status": "IN_PROGRESS",
        "statusRaw": "EM ANDAMENTO",
        "parties": [
          {
            "document": "12345678901",
            "name": "JOAO DA SILVA",
            "polarity": "PASSIVE",
            "type": "DEFENDANT",
            "isActive": true
          }
        ],
        "lastMovementDate": "2023-05-15",
        "value": 50000
      }
    ],
    "totalProcesses": 1,
    "totalProcessesAsAuthor": 0,
    "totalProcessesAsDefendant": 1,
    "totalProcessesAsOther": 0,
    "firstProcessDate": "2023-01-10",
    "lastProcessDate": "2023-01-10"
  }
}

Cenário	O que acontece	Exemplo de `reason`
Registro não encontrado na fonte	Falha na consulta	`[processes] Registro não encontrado.`
Fonte temporariamente indisponível (lentidão, tempo de resposta excedido ou dataset desativado temporariamente)	Falha na consulta	`[processes] Consulta temporariamente indisponível. Tente novamente em alguns minutos.`
Erro não recuperável na fonte	Falha na consulta	`[processes] Não foi possível concluir a consulta. Se o erro persistir, contate o suporte.`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "processes",
      "reason": "[processes] Registro não encontrado."
    }
  ]
}

Certidão PGFN (`pgfn_certificate_person`)

Disponibilidade: apenas async. Em consultas sync, o dataset aparece em failedDatasets com a mensagem Dataset disponível apenas na consulta assíncrona. Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["pgfn_certificate_person"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`certificates`	array	—	—	Lista de certidões PGFN

Cada item de certificates:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`origin`	string	—	`"PGFN"`	Fonte dos dados
`protocolNumber`	string	—	`"12345678901234567890"`	Número de protocolo
`fileUrl`	string	URL	`"https://…/api/v1/file/{id}"`	URL absoluta do PDF no Bureau (`GET /bureau/api/v1/file/{id}`). Requer autenticação — veja Obtenha o PDF da certidão
`status`	string	`POSITIVA` possui débito; `NEGATIVA` sem débito	`"NEGATIVA"`	Status simplificado

Exemplo:

{
  "dataset": "pgfn_certificate_person",
  "data": {
    "certificates": [
      {
        "origin": "PGFN",
        "protocolNumber": "12345678901234567890",
        "fileUrl": "https://dev-bureau-platform.services-valid.com.br/api/v1/file/325b2c8e-f85a-42c0-bf22-03fe8d1d2461",
        "status": "NEGATIVA"
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
Consulta sync	Não processa o dataset	`Dataset disponível apenas na consulta assíncrona.`
Registro não encontrado na fonte	Falha na consulta	`Registro não encontrado, ou inválido.`
Erro temporário na fonte	Falha na consulta	`Erro ao processar o dataset`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "pgfn_certificate_person",
      "reason": "Dataset disponível apenas na consulta assíncrona."
    }
  ]
}

Disponibilidade: sync e async. Apenas PF (CPF). Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["social_assistance"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`socialAssistances`	array	—	—	Lista de benefícios de assistência social

Cada item de socialAssistances (campos sem valor na fonte não são retornados):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`programName`	string	—	`"Bolsa Família"`	Nome do programa de benefício
`programState`	string	UF	`"SP"`	Estado em que o programa é aplicado
`assistanceStartDate`	string	YYYY-MM-DD	`"2020-01-15"`	Data em que a pessoa começou a receber o benefício
`assistanceEndDate`	string	YYYY-MM-DD	`"2023-12-31"`	Data em que a pessoa parou de receber o benefício
`assistanceAmount`	number	Reais (R$)	`150`	Valor recebido por mês
`assistanceTotalAmount`	number	Reais (R$)	`7200`	Valor total recebido
`totalInstallments`	number	Inteiro	`48`	Quantidade de parcelas recebidas até o momento

Exemplo:

{
  "dataset": "social_assistance",
  "data": {
    "socialAssistances": [
      {
        "programName": "Bolsa Família",
        "programState": "SP",
        "assistanceStartDate": "2020-01-15",
        "assistanceEndDate": "2023-12-31",
        "assistanceAmount": 150,
        "assistanceTotalAmount": 7200,
        "totalInstallments": 48
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
Dataset exclusivo de PF consultado com CNPJ	Não processa o dataset	`Invalid document type: this dataset is only available for individuals (CPF)`
Consulta não concluída pela fonte (registro não encontrado, resultado vazio ou indisponibilidade)	Falha na consulta	Mensagem com o motivo da falha

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "social_assistance",
      "reason": "Invalid document type: this dataset is only available for individuals (CPF)"
    }
  ]
}

Disponibilidade: sync e async. Apenas PF (CPF). Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["family_social_assistance"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data): Campos sem valor na fonte não são retornados.

Campo	Tipo	Formato / enum	Exemplo	Descrição
`totalMembers`	number	Inteiro	`5`	Número total de pessoas no círculo familiar
`totalBeneficiaries`	number	Inteiro	`4`	Total de beneficiários ao longo do tempo
`totalCurrentBeneficiaries`	number	Inteiro	`3`	Total de beneficiários atualmente
`totalAssistances`	number	Inteiro	`10`	Total de benefícios que a família já recebeu
`totalActiveAssistances`	number	Inteiro	`5`	Total de benefícios que a família recebe atualmente
`totalAmountReceived`	number	Reais (R$)	`50000`	Valor total recebido pela família, somando todas as parcelas
`totalInstallmentsReceived`	number	Inteiro	`120`	Quantidade total de parcelas recebidas
`familyAvgIncomeRange`	string	Faixa	`"1000-2000"`	Faixa de renda média mensal da família
`assistanceIncomePercentageRange`	string	Faixa percentual	`"20-30"`	Faixa percentual da renda que vem de programas de assistência social
`socialAssistances`	array	—	—	Detalhamento dos benefícios recebidos, por programa

Cada item de socialAssistances:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`programName`	string	—	`"Bolsa Família"`	Nome do programa de benefício
`beneficiaries`	number	Inteiro	`3`	Número de beneficiários
`currentBeneficiaries`	number	Inteiro	`2`	Número de beneficiários atualmente
`totalAssistanceAmount`	number	Reais (R$)	`15000`	Valor total recebido pelo programa
`maxAssistanceAmount`	number	Reais (R$)	`500`	Maior valor recebido pelo programa
`minAssistanceAmount`	number	Reais (R$)	`200`	Menor valor recebido pelo programa
`avgAssistanceAmount`	number	Reais (R$)	`350`	Valor médio recebido pelo programa
`totalInstallmentsReceived`	number	Inteiro	`48`	Quantidade de parcelas recebidas até o momento
`firstAssistanceStartDate`	string	YYYY-MM-DD	`"2020-01-15"`	Primeira data em que a família começou a receber o benefício
`lastAssistanceEndDate`	string	YYYY-MM-DD	`"2023-12-31"`	Última data em que a família parou de receber o benefício

Exemplo:

{
  "dataset": "family_social_assistance",
  "data": {
    "totalMembers": 5,
    "totalBeneficiaries": 4,
    "totalCurrentBeneficiaries": 3,
    "totalAssistances": 10,
    "totalActiveAssistances": 5,
    "totalAmountReceived": 50000,
    "familyAvgIncomeRange": "1000-2000",
    "assistanceIncomePercentageRange": "20-30",
    "socialAssistances": [
      {
        "programName": "Bolsa Família",
        "beneficiaries": 3,
        "currentBeneficiaries": 2,
        "totalAssistanceAmount": 15000,
        "maxAssistanceAmount": 500,
        "minAssistanceAmount": 200,
        "avgAssistanceAmount": 350,
        "totalInstallmentsReceived": 48,
        "firstAssistanceStartDate": "2020-01-15",
        "lastAssistanceEndDate": "2023-12-31"
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
Dataset exclusivo de PF consultado com CNPJ	Não processa o dataset	`Invalid document type: this dataset is only available for individuals (CPF)`
Consulta não concluída pela fonte (registro não encontrado, resultado vazio ou indisponibilidade)	Falha na consulta	Mensagem com o motivo da falha

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "family_social_assistance",
      "reason": "Invalid document type: this dataset is only available for individuals (CPF)"
    }
  ]
}

Exposição e Perfil na Mídia (`media_profile_and_exposure`)

Disponibilidade: sync e async. Apenas PF (CPF). Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["media_profile_and_exposure"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data): Campos sem valor na fonte não são retornados.

Campo	Tipo	Formato / enum	Exemplo	Descrição
`mediaExposureLevel`	string	`A` (intensa) a `H` (inexistente)	`"A"`	Nível de exposição na mídia
`celebrityLevel`	string	`A` (alto) a `H` (inexistente)	`"B"`	Nível de celebridade
`unpopularityLevel`	string	`A` (alto) a `H` (inexistente)	`"C"`	Nível de impopularidade (exposição negativa)
`newsItems`	array	—	—	Lista de notícias encontradas

Cada item de newsItems:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`title`	string	—	`"Título da notícia"`	Título da notícia
`sourceName`	string	—	`"Fonte da Notícia"`	Nome do veículo de onde a notícia foi obtida
`url`	string	URL	`"https://exemplo.com/noticia"`	URL original da notícia
`categories`	string[]	—	`["Política", "Economia"]`	Categorias da notícia
`publicationDate`	string	YYYY-MM-DD	`"2023-12-15"`	Data de publicação
`captureDate`	string	YYYY-MM-DD	`"2023-12-16"`	Data em que a notícia foi capturada
`sentimentAnalysis`	object	—	—	Análise de sentimento da notícia (campos abaixo)

Campos de sentimentAnalysis:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`label`	string	ver tabela abaixo	`"POSITIVE"`	Sentimento predominante da notícia
`peopleCount`	number	Inteiro	`2`	Número de pessoas identificadas no conteúdo
`placesCount`	number	Inteiro	`1`	Número de lugares identificados no conteúdo
`organizationsCount`	number	Inteiro	`3`	Número de empresas identificadas no conteúdo

Valores de label:

Valor	Significado
`NEGATIVE`	Predomínio de sentimento negativo
`POSITIVE`	Predomínio de sentimento positivo
`NEUTRAL`	Nenhum sentimento predominante
`UNDEFINED`	Não foi possível inferir o sentimento da notícia
`POLARIZED`	Sentimentos negativos e positivos fortes ao mesmo tempo
`SLIGHTLY_POSITIVE`	Sentimentos neutros e positivos
`SLIGHTLY_NEGATIVE`	Sentimentos neutros e negativos

Exemplo:

{
  "dataset": "media_profile_and_exposure",
  "data": {
    "mediaExposureLevel": "A",
    "celebrityLevel": "B",
    "unpopularityLevel": "C",
    "newsItems": [
      {
        "title": "Título da notícia",
        "sourceName": "Fonte da Notícia",
        "url": "https://exemplo.com/noticia",
        "categories": ["Política", "Economia"],
        "publicationDate": "2023-12-15",
        "captureDate": "2023-12-16",
        "sentimentAnalysis": {
          "label": "POSITIVE",
          "peopleCount": 2,
          "placesCount": 1,
          "organizationsCount": 3
        }
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
Dataset exclusivo de PF consultado com CNPJ	Não processa o dataset	`Invalid document type: this dataset is only available for individuals (CPF)`
Consulta não concluída pela fonte (registro não encontrado, resultado vazio ou indisponibilidade)	Falha na consulta	Mensagem com o motivo da falha

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "media_profile_and_exposure",
      "reason": "Invalid document type: this dataset is only available for individuals (CPF)"
    }
  ]
}

Dados de Candidato Eleitoral (`election_candidate_data`)

Disponibilidade: sync e async. Apenas PF (CPF). Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["election_candidate_data"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data): Campos sem valor na fonte não são retornados.

Campo	Tipo	Formato / enum	Exemplo	Descrição
`hasRunForOffice`	boolean	`true` / `false`	`true`	Indica se a pessoa já participou de uma eleição
`hasBeenElected`	boolean	`true` / `false`	`true`	Indica se a pessoa já foi eleita
`numberOfTimesRanForOffice`	number	Inteiro	`3`	Quantidade de eleições de que a pessoa participou
`numberOfTimesElected`	number	Inteiro	`2`	Quantidade de vezes que a pessoa foi eleita
`lastElectedRole`	string	—	`"Prefeito"`	Último cargo para o qual a pessoa foi eleita
`firstElectionYearRanForOffice`	string	Ano	`"2010"`	Primeiro ano em que a pessoa participou de uma eleição
`lastElectionYearRanForOffice`	string	Ano	`"2022"`	Último ano em que a pessoa participou de uma eleição
`firstElectionYearElected`	string	Ano	`"2012"`	Primeiro ano em que a pessoa foi eleita
`lastElectionYearElected`	string	Ano	`"2020"`	Último ano em que a pessoa foi eleita
`electionData`	array	—	—	Detalhes de cada eleição de que a pessoa participou

Cada item de electionData:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`electionYear`	string	Ano	`"2020"`	Ano da eleição
`electionType`	string	—	`"municipal"`	Tipo de eleição (municipal, estadual ou federal)
`applicationRole`	string	—	`"Prefeito"`	Cargo para o qual a pessoa concorreu
`applicationPlace`	string	—	`"São Paulo"`	Cidade da candidatura
`applicationUf`	string	UF	`"SP"`	Estado da candidatura
`wasElected`	boolean	`true`	`true`	Indica que a pessoa foi eleita nessa eleição. Só retorna quando `true`
`candidateSituation`	string	—	`"Apto"`	Situação do candidato em relação à candidatura
`applicationSituation`	string	—	`"Deferido"`	Situação do pedido de registro da candidatura
`partyNumber`	number	Inteiro	`13`	Número do partido
`partyAcronym`	string	—	`"PT"`	Sigla do partido
`partyName`	string	—	`"Partido dos Trabalhadores"`	Nome do partido

Exemplo:

{
  "dataset": "election_candidate_data",
  "data": {
    "hasRunForOffice": true,
    "hasBeenElected": true,
    "numberOfTimesRanForOffice": 3,
    "numberOfTimesElected": 2,
    "lastElectedRole": "Prefeito",
    "firstElectionYearRanForOffice": "2010",
    "lastElectionYearRanForOffice": "2022",
    "firstElectionYearElected": "2012",
    "lastElectionYearElected": "2020",
    "electionData": [
      {
        "electionYear": "2020",
        "electionType": "municipal",
        "applicationRole": "Prefeito",
        "applicationPlace": "São Paulo",
        "applicationUf": "SP",
        "wasElected": true,
        "candidateSituation": "Apto",
        "applicationSituation": "Deferido",
        "partyNumber": 13,
        "partyAcronym": "PT",
        "partyName": "Partido dos Trabalhadores"
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
Dataset exclusivo de PF consultado com CNPJ	Não processa o dataset	`Invalid document type: this dataset is only available for individuals (CPF)`
Consulta não concluída pela fonte (registro não encontrado, resultado vazio ou indisponibilidade)	Falha na consulta	Mensagem com o motivo da falha

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "election_candidate_data",
      "reason": "Invalid document type: this dataset is only available for individuals (CPF)"
    }
  ]
}

Doações Eleitorais (`electoral_donors`)

Disponibilidade: sync e async. Apenas PF (CPF). Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["electoral_donors"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data): Campos sem valor na fonte não são retornados.

Campo	Tipo	Formato / enum	Exemplo	Descrição
`totalDonationsAmount`	number	Inteiro	`15`	Quantidade total de doações realizadas
`totalDonatedValue`	number	Reais (R$)	`500000`	Soma do valor de todas as doações
`quantityOfDonationsLastElection`	number	Inteiro	`5`	Quantidade de doações no último ciclo eleitoral
`quantityOfDonationsLastTwoElections`	number	Inteiro	`10`	Quantidade de doações nos últimos dois ciclos eleitorais
`quantityOfDonationsLastThreeElection`	number	Inteiro	`15`	Quantidade de doações nos últimos três ciclos eleitorais
`donatedValueLastElection`	number	Reais (R$)	`100000`	Valor doado no último ciclo eleitoral
`donatedValueLastTwoElections`	number	Reais (R$)	`200000`	Valor doado nos últimos dois ciclos eleitorais
`donatedValueLastThreeElection`	number	Reais (R$)	`300000`	Valor doado nos últimos três ciclos eleitorais
`partiesThatReceivedDonation`	string[]	—	`["PT", "PSDB", "MDB"]`	Partidos que já receberam doação da pessoa
`maxDonationValue`	number	Reais (R$)	`100000`	Valor da maior doação individual
`averageDonationValue`	number	Reais (R$)	`33333.33`	Valor médio das doações
`minDonationValue`	number	Reais (R$)	`1000`	Valor da menor doação individual
`electionDonationData`	array	—	—	Detalhes das doações de campanha

Cada item de electionDonationData:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`electionYear`	string	Ano	`"2020"`	Ano da eleição
`applicationRole`	string	—	`"Prefeito"`	Cargo disputado pelo candidato que recebeu a doação
`partyName`	string	—	`"Partido dos Trabalhadores"`	Partido do candidato que recebeu a doação
`totalDonationValue`	number	Reais (R$)	`50000`	Valor total doado a esse candidato nessa campanha
`donationRecipient`	string	`CANDIDATE`, `PARTY`	`"CANDIDATE"`	Tipo de quem recebeu a doação: candidato ou partido
`isCrossDonation`	boolean	`true` / `false`	`true`	Indica se a doação foi feita a um partido que registrou despesas com a pessoa

Exemplo:

{
  "dataset": "electoral_donors",
  "data": {
    "totalDonationsAmount": 15,
    "totalDonatedValue": 500000,
    "quantityOfDonationsLastElection": 5,
    "donatedValueLastElection": 100000,
    "partiesThatReceivedDonation": ["PT", "PSDB", "MDB"],
    "maxDonationValue": 100000,
    "averageDonationValue": 33333.33,
    "minDonationValue": 1000,
    "electionDonationData": [
      {
        "electionYear": "2020",
        "applicationRole": "Prefeito",
        "partyName": "Partido dos Trabalhadores",
        "totalDonationValue": 50000,
        "donationRecipient": "CANDIDATE",
        "isCrossDonation": false
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
Dataset exclusivo de PF consultado com CNPJ	Não processa o dataset	`Invalid document type: this dataset is only available for individuals (CPF)`
Consulta não concluída pela fonte (registro não encontrado, resultado vazio ou indisponibilidade)	Falha na consulta	Mensagem com o motivo da falha

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "electoral_donors",
      "reason": "Invalid document type: this dataset is only available for individuals (CPF)"
    }
  ]
}

KYC e Compliance (`kyc`)

Disponibilidade: sync e async. Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["kyc"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data): Campos sem valor na fonte não são retornados.

Campo	Tipo	Formato / enum	Exemplo	Descrição
`isCurrentlyPEP`	boolean	`true` / `false`	`false`	Indica se a pessoa é PPE atualmente
`isCurrentlySanctioned`	boolean	`true` / `false`	`false`	Indica se a pessoa está sob alguma sanção atualmente
`wasPreviouslySanctioned`	boolean	`true` / `false`	`false`	Indica se a pessoa já esteve sancionada
`last30DaysSanctions`	number	Inteiro	`0`	Sanções encontradas nos últimos 30 dias
`last90DaysSanctions`	number	Inteiro	`0`	Sanções encontradas nos últimos 90 dias
`last180DaysSanctions`	number	Inteiro	`0`	Sanções encontradas nos últimos 180 dias
`last365DaysSanctions`	number	Inteiro	`0`	Sanções encontradas nos últimos 365 dias
`lastYearPEPOccurence`	number	Inteiro	`3`	Registros de PPE no último ano
`last3YearsPEPOccurence`	number	Inteiro	`5`	Registros de PPE nos últimos 3 anos
`last5YearsPEPOccurence`	number	Inteiro	`7`	Registros de PPE nos últimos 5 anos
`last5PlusYearsPEPOccurence`	number	Inteiro	`2`	Registros de PPE há mais de 5 anos
`firstPEPOccurenceDate`	string	YYYY-MM-DD	`"2020-01-15"`	Data do primeiro registro de PPE
`lastPEPOccurenceDate`	string	YYYY-MM-DD	`"2023-12-31"`	Data do último registro de PPE
`firstSanctionDate`	string	YYYY-MM-DD	`"2021-05-10"`	Data do primeiro registro de sanção
`lastSanctionDate`	string	YYYY-MM-DD	`"2023-11-20"`	Data do último registro de sanção
`isCurrentlyElectoralDonor`	boolean	`true` / `false`	`true`	Indica se a pessoa doou para partidos ou candidatos nas últimas 2 eleições
`isHistoricalElectoralDonor`	boolean	`true` / `false`	`true`	Indica se a pessoa tem histórico de doação para partidos ou candidatos
`totalElectoralDonations`	number	Inteiro	`15`	Total de doações para partidos ou candidatos
`totalElectoralDonationAmount`	number	Reais (R$)	`50000`	Valor total doado para partidos ou candidatos
`electoralDonations`	object	—	`{}`	Objeto de doações eleitorais repassado da fonte. Pode vir vazio
`pepHistory`	array	—	—	Histórico de exposição política (PPE)
`sanctionsHistory`	array	—	—	Histórico de sanções e restrições

Cada item de pepHistory:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`level`	string	—	`"DIRECT"`	Nível de relacionamento com o PPE
`jobTitle`	string	—	`"Prefeito"`	Cargo do PPE
`state`	string	UF	`"SP"`	Estado do cargo
`startDate`	string	YYYY-MM-DD	`"2020-01-15"`	Data em que a pessoa passou a ser PPE
`endDate`	string	YYYY-MM-DD	`"2023-12-31"`	Data em que a pessoa deixou de ser PPE
`isElectedJob`	boolean	`true` / `false`	`true`	Indica se o cargo é eletivo
`isCurrentlyPEP`	boolean	`true` / `false`	`false`	Indica se a pessoa é PPE atualmente

Cada item de sanctionsHistory:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`source`	string	—	`"OFAC"`	Fonte da sanção
`type`	string	—	`"Sanction"`	Tipo de sanção, como informado pela fonte
`standardizedSanctionType`	string	—	`"SANCTION"`	Tipo de sanção padronizado
`matchRate`	number	—	`0.95`	Proximidade entre o nome consultado e o nome na lista de sanção
`nameUniquenessScore`	number	—	`72`	Score de unicidade do nome. Ajuda na triagem de falsos positivos
`isCurrentlyPresentOnSource`	boolean	`true` / `false`	`true`	Indica se o registro está presente na fonte atualmente
`wasRecentlyPresentOnSource`	boolean	`true` / `false`	`false`	Indica se o registro esteve presente na fonte recentemente
`startDate`	string	YYYY-MM-DD	`"2020-01-15"`	Data de início da sanção
`endDate`	string	YYYY-MM-DD	`"2023-12-31"`	Data de término da sanção
`creationDate`	string	YYYY-MM-DD	`"2019-06-01"`	Data de criação do registro na fonte
`lastUpdateDate`	string	YYYY-MM-DD	`"2024-01-10"`	Data da última atualização do registro na fonte
`isCurrentlySanctioned`	boolean	`true` / `false`	`true`	Indica se a pessoa está sob a sanção atualmente
`details`	object	—	—	Detalhes da sanção retornados pela fonte (campos abaixo)
`normalizedDetails`	object	—	—	Versão normalizada de `details`, com a mesma estrutura. Em geral traz nome, nacionalidades, datas e score de nascimento

Campos de details e normalizedDetails (todos opcionais):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`originalName`	string	—	`"John Doe"`	Nome original na fonte
`sanctionName`	string	—	`"JOHN DOE"`	Nome na lista de sanção
`birthDate`	string	YYYY-MM-DD	`"1980-05-15"`	Data de nascimento
`standardizedBirthDate`	string	YYYY-MM-DD	`"1980-05-15"`	Data de nascimento padronizada
`sourcePossibleDateOfBirthScore`	number	—	`85`	Score de proximidade entre a data de nascimento e a da fonte
`nationalities`	string[]	—	`["Brazilian"]`	Nacionalidades
`image`	string	URL	`"https://example.com/image.jpg"`	URL externa da imagem (ex.: Interpol). Não é armazenada pelo Bureau
`languageSpoken`	string[]	—	`["Portuguese", "English"]`	Idiomas falados
`charges`	string[]	—	`["Fraud"]`	Acusações
`weight`	string	—	`"80 kg"`	Peso
`height`	string	—	`"1.80 m"`	Altura
`eyesColor`	string	—	`"Brown"`	Cor dos olhos
`hairColor`	string	—	`"Black"`	Cor do cabelo
`distinguishingMarks`	string	—	`"Scar on left arm"`	Marcas distintivas

Exemplo:

{
  "dataset": "kyc",
  "data": {
    "pepHistory": [
      {
        "level": "DIRECT",
        "jobTitle": "Prefeito",
        "state": "SP",
        "startDate": "2020-01-15",
        "endDate": "2023-12-31",
        "isElectedJob": true,
        "isCurrentlyPEP": false
      }
    ],
    "sanctionsHistory": [],
    "isCurrentlyPEP": false,
    "isCurrentlySanctioned": false,
    "wasPreviouslySanctioned": false,
    "last30DaysSanctions": 0,
    "last90DaysSanctions": 0,
    "last180DaysSanctions": 0,
    "last365DaysSanctions": 0,
    "lastYearPEPOccurence": 0,
    "last3YearsPEPOccurence": 1,
    "last5YearsPEPOccurence": 1,
    "last5PlusYearsPEPOccurence": 0,
    "firstPEPOccurenceDate": "2020-01-15",
    "lastPEPOccurenceDate": "2023-12-31",
    "isCurrentlyElectoralDonor": false,
    "isHistoricalElectoralDonor": false,
    "totalElectoralDonations": 0,
    "totalElectoralDonationAmount": 0,
    "electoralDonations": {}
  }
}

Cenário	O que acontece	Exemplo de `reason`
Consulta não concluída pela fonte (registro não encontrado, resultado vazio ou indisponibilidade)	Falha na consulta	Mensagem com o motivo da falha

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "kyc",
      "reason": "Mensagem com o motivo da falha"
    }
  ]
}

Beneficiário Final (`ultimate_beneficial_owner`)

Disponibilidade: sync e async. PF e PJ (mesmo código de dataset). Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["ultimate_beneficial_owner"]
}

Exemplo de retorno Resposta de sucesso (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.

Campo	Tipo	Formato / enum	Exemplo	Descrição
`name`	string	—	`"João da Silva"`	Nome ou razão social do consultado
`registrationDate`	string	ISO 8601	`"2018-01-01"`	Data de cadastro do registro
`lastUpdateDate`	string	ISO 8601	`"2024-12-31"`	Data da última atualização do registro
`isPep`	boolean	`true` / `false`	`false`	Indica se o consultado é pessoa exposta politicamente (PEP)
`companies`	array	—	—	Nós da cadeia societária (empresas e pessoas), até 10 graus

Cada item de companies:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`document`	string	CPF/CNPJ	`"12345678000190"`	Documento do nó
`name`	string	—	`"Empresa Exemplo S.A."`	Nome ou razão social do nó
`isPep`	boolean	`true` / `false`	`false`	Indica se o nó é PEP
`isActive`	boolean	`true` / `false`	`true`	Indica se o registro do nó está ativo
`level`	number	`0` a `10`	`1`	Grau do nó na cadeia societária
`partners`	string[]	—	`["12345678901"]`	Sócios do nó
`history`	array	—	—	Histórico de vínculos societários do nó

Cada item de history:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`startDate`	string	ISO 8601	`"2018-01-01"`	Data de início do vínculo
`endDate`	string	ISO 8601	`"2024-12-31"`	Data de término do vínculo
`isActive`	boolean	`true` / `false`	`true`	Indica se o vínculo está ativo
`role`	string	—	`"SÓCIO"`	Cargo ou função no vínculo

Exemplo:

{
  "dataset": "ultimate_beneficial_owner",
  "data": {
    "name": "João da Silva",
    "registrationDate": "2018-01-01",
    "lastUpdateDate": "2024-12-31",
    "isPep": false,
    "companies": [
      {
        "document": "12345678000190",
        "name": "Empresa Exemplo S.A.",
        "isPep": false,
        "isActive": true,
        "level": 1,
        "partners": ["12345678901"],
        "history": [
          {
            "startDate": "2018-01-01",
            "isActive": true,
            "role": "SÓCIO"
          }
        ]
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
Registro não encontrado / inválido	Falha na consulta	`Registro não encontrado, ou inválido.`
Resposta sem retorno da fonte	Falha na consulta	`[beneficiario_final] Resposta sem retorno da fonte de dados.`
Indisponibilidade da fonte	Falha na consulta	`[beneficiario_final] Consulta temporariamente indisponível. Tente novamente em alguns minutos.`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "ultimate_beneficial_owner",
      "reason": "Registro não encontrado, ou inválido."
    }
  ]
}

Distribuição de Processos Judiciais (`lawsuits_distribution_data`)

Disponibilidade: sync e async. Apenas PF (CPF). Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["lawsuits_distribution_data"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data): Campos sem valor na fonte não são retornados.

Campo	Tipo	Formato / enum	Exemplo	Descrição
`totalLawsuits`	number	Inteiro	`25`	Total de processos da pessoa
`typeDistribution`	array	—	—	Distribuição por tipo de processo
`statusDistribution`	array	—	—	Distribuição por status do processo
`courtTypeDistribution`	array	—	—	Distribuição por tipo de justiça
`courtLevelDistribution`	array	—	—	Distribuição por instância do tribunal
`partyTypeDistribution`	array	—	—	Distribuição por tipo de parte
`stateDistribution`	array	—	—	Distribuição por estado
`courtNameDistribution`	array	—	—	Distribuição por nome do tribunal

Cada item das listas de distribuição:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`value`	string	Veja os valores por lista abaixo	`"TJSP"`	Categoria da distribuição (tipo, status, tribunal, estado etc.)
`count`	number	Inteiro	`10`	Quantidade de processos na categoria

Valores de value por lista. Exceto em courtTypeDistribution, o texto vem como retornado pela fonte e pode incluir valores além dos listados:

Lista	Valores de `value`
`typeDistribution`	Texto livre com o tipo do processo. Ex.: `RITO SUMARISSIMO`
`statusDistribution`	`ATIVO`, `DISTRIBUIDO`, `REDISTRIBUIDO`, `AUTUADO`, `APENSO`, `DECIDIDO`, `JULGADO`, `EXECUCAO`, `EM GRAU DE RECURSO`, `TRANSITADO EM JULGADO`, `SUSPENSO`, `BAIXADO`, `ARQUIVADO`, `FINALIZADO`, `ENCERRADO`, `EXTINTO`, `INDEFINIDO`
`courtTypeDistribution`	Veja a tabela abaixo
`courtLevelDistribution`	`1`, `2` ou `3` (instância do processo)
`partyTypeDistribution`	Veja a tabela abaixo
`stateDistribution`	Sigla da UF. Ex.: `SP`, `MS`
`courtNameDistribution`	Sigla do tribunal. Ex.: `STF`, `STJ`, `TRF1`, `JFSP`, `TJSP`, `TRT24`

Valores de value em courtTypeDistribution (tipos não reconhecidos vêm no texto original da fonte):

Valor	Significado
`CIVIL`	Cível
`CRIMINAL`	Criminal
`TAX`	Tributária
`SOCIAL_SECURITY`	Previdenciária
`LABOR`	Trabalhista
`SPECIAL_CIVIL`	Especial Cível
`SPECIAL_CRIMINAL`	Especial Criminal
`ADMINISTRATIVE`	Administrativa
`ELECTORAL`	Eleitoral
`TREASURY`	Fazenda
`SPECIAL_TREASURY`	Especial Fazenda

Valores de value em partyTypeDistribution:

Valor	Significado
`AUTHOR`	Autor
`DEFENDANT`	Réu
`CLAIMANT`	Requerente
`CLAIMED`	Requerido
`LAWYER`	Advogado
`ATTORNEY`	Procurador
`REPORTER`	Relator
`JUDGE`	Juiz
`WITNESS`	Testemunha
`VICTIM`	Vítima
`INMATE`	Preso
`OTHER`	Outro

Exemplo:

{
  "dataset": "lawsuits_distribution_data",
  "data": {
    "totalLawsuits": 10,
    "typeDistribution": [
      { "value": "RITO SUMARISSIMO", "count": 4 }
    ],
    "statusDistribution": [
      { "value": "ARQUIVADO", "count": 7 },
      { "value": "ATIVO", "count": 3 }
    ],
    "courtTypeDistribution": [
      { "value": "LABOR", "count": 4 },
      { "value": "CIVIL", "count": 6 }
    ],
    "courtLevelDistribution": [
      { "value": "1", "count": 9 },
      { "value": "2", "count": 1 }
    ],
    "partyTypeDistribution": [
      { "value": "AUTHOR", "count": 4 },
      { "value": "DEFENDANT", "count": 6 }
    ],
    "stateDistribution": [
      { "value": "MS", "count": 4 },
      { "value": "SP", "count": 6 }
    ],
    "courtNameDistribution": [
      { "value": "TRT24", "count": 4 },
      { "value": "TJSP", "count": 6 }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
Dataset exclusivo de PF consultado com CNPJ	Não processa o dataset	`Invalid document type: this dataset is only available for individuals (CPF)`
Consulta não concluída pela fonte (registro não encontrado, resultado vazio ou indisponibilidade)	Falha na consulta	Mensagem com o motivo da falha

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "lawsuits_distribution_data",
      "reason": "Invalid document type: this dataset is only available for individuals (CPF)"
    }
  ]
}

Pessoas Relacionadas (`related_people`)

Disponibilidade: sync e async. Apenas PF (CPF). Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["related_people"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data): Campos sem valor na fonte não são retornados.

Campo	Tipo	Formato / enum	Exemplo	Descrição
`totalRelationships`	number	Inteiro	`15`	Total de relacionamentos da pessoa
`totalRelatives`	number	Inteiro	`5`	Total de relacionamentos do tipo `RELATIVE` (parentes)
`totalNeighbors`	number	Inteiro	`3`	Total de relacionamentos do tipo `NEIGHBOR` (vizinhos)
`totalSpouses`	number	Inteiro	`1`	Total de relacionamentos do tipo `SPOUSE` (cônjuges)
`totalCoworkers`	number	Inteiro	`4`	Total de relacionamentos do tipo `COWORKER` (colegas de trabalho)
`totalHousehold`	number	Inteiro	`2`	Total de relacionamentos do tipo `HOUSEHOLD` (mesmo endereço)
`totalPartners`	number	Inteiro	`2`	Total de relacionamentos do tipo `PARTNER` (parceiros)
`totalCollegeClass`	number	Inteiro	`1`	Total de relacionamentos do tipo `COLLEGE_CLASS` (colegas de sala)
`personalRelationships`	array	—	—	Lista de relacionamentos pessoais

Cada item de personalRelationships:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`relatedEntityTaxIdNumber`	string	CPF/CNPJ	`"12345678901"`	Documento da pessoa relacionada
`relatedEntityTaxIdType`	string	`CPF`, `CNPJ`	`"CPF"`	Tipo de documento
`relatedEntityName`	string	—	`"João Silva"`	Nome da pessoa relacionada
`relationshipType`	string	ver tabela abaixo	`"RELATIVE"`	Tipo de relacionamento
`relationshipLevel`	string	`DIRECT` direto; `SECOND-LEVEL` segundo nível; `THIRD-LEVEL` terceiro nível	`"DIRECT"`	Nível do relacionamento
`relationshipStartDate`	string	ISO 8601	`"2020-01-15T00:00:00Z"`	Data de início do relacionamento
`relationshipEndDate`	string	ISO 8601	`"2023-12-31T00:00:00Z"`	Data de término do relacionamento

Valores de relationshipType:

Valor	Significado
`RELATIVE`	Parente
`HOUSEHOLD`	Mesmo endereço
`SPOUSE`	Cônjuge
`PARTNER`	Parceiro
`NEIGHBOR`	Vizinho
`COWORKER`	Colega de trabalho
`COLLEGE_CLASS`	Colega de sala

Exemplo:

{
  "dataset": "related_people",
  "data": {
    "totalRelationships": 2,
    "totalRelatives": 1,
    "totalNeighbors": 1,
    "personalRelationships": [
      {
        "relatedEntityTaxIdNumber": "12345678901",
        "relatedEntityTaxIdType": "CPF",
        "relatedEntityName": "João Silva",
        "relationshipType": "RELATIVE",
        "relationshipLevel": "DIRECT",
        "relationshipStartDate": "2020-01-15T00:00:00Z"
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
Dataset exclusivo de PF consultado com CNPJ	Não processa o dataset	`Invalid document type: this dataset is only available for individuals (CPF)`
Consulta não concluída pela fonte (registro não encontrado, resultado vazio ou indisponibilidade)	Falha na consulta	Mensagem com o motivo da falha

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "related_people",
      "reason": "Invalid document type: this dataset is only available for individuals (CPF)"
    }
  ]
}

Questionário de Endividamento (`indebtedness_question`)

Disponibilidade: sync e async. Apenas PF (CPF). Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["indebtedness_question"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data): Campos sem valor na fonte não são retornados.

Campo	Tipo	Formato / enum	Exemplo	Descrição
`likelyInDebt`	boolean	`true` / `false`	`true`	Indica se a pessoa provavelmente está inadimplente ou negativada
`evidences`	array	—	—	Evidências encontradas

Cada item de evidences:

Campo	Tipo	Formato / enum	Exemplo	Descrição
`id`	string	—	`"evd_123456"`	Identificador da evidência
`source`	string	—	`"SPC"`	Fonte da evidência

Exemplo:

{
  "dataset": "indebtedness_question",
  "data": {
    "likelyInDebt": true,
    "evidences": [
      {
        "id": "evd_123456",
        "source": "SPC"
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
Dataset exclusivo de PF consultado com CNPJ	Não processa o dataset	`Invalid document type: this dataset is only available for individuals (CPF)`
Consulta não concluída pela fonte (registro não encontrado, resultado vazio ou indisponibilidade)	Falha na consulta	Mensagem com o motivo da falha

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "indebtedness_question",
      "reason": "Invalid document type: this dataset is only available for individuals (CPF)"
    }
  ]
}

Cobranças (`collections`)

Disponibilidade: sync e async. Apenas PF (CPF). Exemplo de chamada

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["collections"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data): Campos sem valor na fonte não são retornados. Uma “origem” é um processo de cobrança distinto; uma “ocorrência” é cada registro de cobrança encontrado.

Campo	Tipo	Formato / enum	Exemplo	Descrição
`isCurrentlyOnCollection`	boolean	`true` / `false`	`true`	Indica se a pessoa está em algum processo de cobrança atualmente
`totalCollectionOccurrences`	number	Inteiro	`15`	Total de ocorrências de cobrança em todo o histórico
`totalCollectionOrigins`	number	Inteiro	`5`	Total de origens de cobrança em todo o histórico
`last30DaysCollectionOccurrences`	number	Inteiro	`2`	Ocorrências de cobrança nos últimos 30 dias
`last90DaysCollectionOccurrences`	number	Inteiro	`5`	Ocorrências de cobrança nos últimos 90 dias
`last180DaysCollectionOccurrences`	number	Inteiro	`8`	Ocorrências de cobrança nos últimos 180 dias
`last365DaysCollectionOccurrences`	number	Inteiro	`12`	Ocorrências de cobrança nos últimos 365 dias
`last30DaysCollectionOrigins`	number	Inteiro	`1`	Origens de cobrança nos últimos 30 dias
`last90DaysCollectionOrigins`	number	Inteiro	`3`	Origens de cobrança nos últimos 90 dias
`last180DaysCollectionOrigins`	number	Inteiro	`4`	Origens de cobrança nos últimos 180 dias
`last365DaysCollectionOrigins`	number	Inteiro	`5`	Origens de cobrança nos últimos 365 dias
`totalCollectionMonths`	number	Inteiro	`8`	Total de meses em que a pessoa esteve em pelo menos um processo de cobrança
`currentConsecutiveCollectionMonths`	number	Inteiro	`3`	Meses consecutivos em cobrança até o mês atual, inclusive
`maxConsecutiveCollectionMonths`	number	Inteiro	`6`	Maior sequência de meses consecutivos em cobrança
`firstCollectionDate`	string	ISO 8601	`"2020-01-15T00:00:00Z"`	Data da primeira cobrança registrada
`lastCollectionDate`	string	ISO 8601	`"2023-12-31T00:00:00Z"`	Data da última cobrança registrada

Exemplo:

{
  "dataset": "collections",
  "data": {
    "isCurrentlyOnCollection": true,
    "totalCollectionOccurrences": 15,
    "totalCollectionOrigins": 5,
    "last30DaysCollectionOccurrences": 2,
    "last90DaysCollectionOccurrences": 5,
    "last180DaysCollectionOccurrences": 8,
    "last365DaysCollectionOccurrences": 12,
    "last30DaysCollectionOrigins": 1,
    "last90DaysCollectionOrigins": 3,
    "last180DaysCollectionOrigins": 4,
    "last365DaysCollectionOrigins": 5,
    "totalCollectionMonths": 8,
    "currentConsecutiveCollectionMonths": 3,
    "maxConsecutiveCollectionMonths": 6,
    "firstCollectionDate": "2020-01-15T00:00:00Z",
    "lastCollectionDate": "2023-12-31T00:00:00Z"
  }
}

Cenário	O que acontece	Exemplo de `reason`
Dataset exclusivo de PF consultado com CNPJ	Não processa o dataset	`Invalid document type: this dataset is only available for individuals (CPF)`
Consulta não concluída pela fonte (registro não encontrado, resultado vazio ou indisponibilidade)	Falha na consulta	Mensagem com o motivo da falha

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "collections",
      "reason": "Invalid document type: this dataset is only available for individuals (CPF)"
    }
  ]
}

Certidão Negativa de Débitos Federais (`cnd_federal_person`)

Disponibilidade: sync e async. Apenas PF (CPF). Certidão conjunta RFB/PGFN com código de controle, datas de emissão/validade e PDF via Storage. Quando usar: Compliance fiscal, due diligence, verificação de regularidade tributária federal. Parâmetros da consulta:

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["cnd_federal_person"]
}

Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato	Exemplo
`certificate.origin`	string	Órgãos emissores	`"RFB/PGFN"`
`certificate.contributorDocument`	string	CPF do contribuinte	`"12345678901"`
`certificate.certificateType`	number	Tipo da certidão	`1`
`certificate.controlCode`	string	Código de controle	`"A1B2C3D4E5F6G7H8"`
`certificate.issueDate`	string	Data/hora de emissão	`"2026-07-24T10:56:41"`
`certificate.expirationDate`	string	Validade	`"2027-01-20"`
`certificate.fileUrl`	string	URL do PDF no Bureau	`https://…/api/v1/file/{id}`

fileUrl exige autenticação — veja Obtenha o PDF da certidão. Exemplo:

{
  "dataset": "cnd_federal_person",
  "data": {
    "certificate": {
      "origin": "RFB/PGFN",
      "contributorDocument": "12345678901",
      "certificateType": 1,
      "controlCode": "A1B2C3D4E5F6G7H8",
      "issueDate": "2026-07-24T10:56:41",
      "expirationDate": "2027-01-20",
      "fileUrl": "https://dev-bureau-platform.services-valid.com.br/api/v1/file/325b2c8e-f85a-42c0-bf22-03fe8d1d2461"
    }
  }
}

Falhas (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.

Cenário	O que acontece	Exemplo de `reason`
Contribuinte não encontrado / parâmetros inválidos	Falha na consulta	`[cnd_certidao_v1] …` ou `Registro não encontrado, ou inválido.`
Nenhuma certidão na resposta	Falha na consulta	`[cnd_certidao_v1] Nenhuma certidão encontrada.`
Processamento da certidão excedeu o limite de tentativas	Falha na consulta	`[cnd_certidao_v1] Consulta em processamento excedeu o limite de tentativas.`
Indisponibilidade da fonte	Falha na consulta	mensagem de erro HTTP/rede da consulta

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "cnd_federal_person",
      "reason": "[cnd_certidao_v1] Nenhuma certidão encontrada."
    }
  ]
}

Status Cadastral (`status_person`)

Disponibilidade: apenas async. Em consultas sync, o dataset aparece em failedDatasets com a mensagem Dataset disponível apenas na consulta assíncrona. 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

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["status_person"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`certificates`	array	—	—	Lista de comprovantes de situação cadastral do CPF na Receita Federal

Cada item de certificates (campos sem valor na fonte não são retornados):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`origin`	string	—	`"Receita-Federal Status"`	Fonte dos dados
`fileUrl`	string	URL	—	URL do PDF da certidão. Requer autenticação — veja Obtenha o PDF da certidão

Exemplo:

{
  "dataset": "status_person",
  "data": {
    "certificates": [
      {
        "origin": "Receita-Federal Status",
        "fileUrl": "https://dev-bureau-platform.services-valid.com.br/api/v1/file/325b2c8e-f85a-42c0-bf22-03fe8d1d2461"
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
Consulta sync	Não processa o dataset	`Dataset disponível apenas na consulta assíncrona.`
Dataset exclusivo de PF consultado com CNPJ	Não processa o dataset	`Invalid document type: this dataset is only available for individuals (CPF)`
Certidão não emitida pela fonte (registro não encontrado, resultado vazio ou indisponibilidade)	Falha na consulta	Mensagem com o motivo da falha

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "status_person",
      "reason": "Dataset disponível apenas na consulta assíncrona."
    }
  ]
}

Certidão Nada Consta (`clearance_certificate_person`)

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["clearance_certificate_person"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`certificates`	array	—	—	Lista de certidões Nada Consta de ações judiciais

Cada item de certificates (campos sem valor na fonte não são retornados):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`origin`	string	—	`"NadaConsta"`	Fonte dos dados
`protocolNumber`	string	—	`"2026/000005421989"`	Número de protocolo da certidão
`fileUrl`	string	URL	—	URL do PDF da certidão. Requer autenticação — veja Obtenha o PDF da certidão

Exemplo:

{
  "dataset": "clearance_certificate_person",
  "data": {
    "certificates": [
      {
        "origin": "NadaConsta",
        "protocolNumber": "2026/000005421989",
        "fileUrl": "https://dev-bureau-platform.services-valid.com.br/api/v1/file/325b2c8e-f85a-42c0-bf22-03fe8d1d2461"
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
Consulta sync	Não processa o dataset	`Dataset disponível apenas na consulta assíncrona.`
Dataset exclusivo de PF consultado com CNPJ	Não processa o dataset	`Invalid document type: this dataset is only available for individuals (CPF)`
Certidão não emitida pela fonte (registro não encontrado, resultado vazio ou indisponibilidade)	Falha na consulta	Mensagem com o motivo da falha

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "clearance_certificate_person",
      "reason": "Dataset disponível apenas na consulta assíncrona."
    }
  ]
}

Certidão Trabalhista (`labor_certificate_person`)

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["labor_certificate_person"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`certificates`	array	—	—	Lista de certidões de ações trabalhistas

Cada item de certificates (campos sem valor na fonte não são retornados):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`protocolNumber`	string	—	`"123.456.789.012"`	Número de protocolo da certidão
`fileUrl`	string	URL	—	URL do PDF da certidão. Requer autenticação — veja Obtenha o PDF da certidão

Exemplo:

{
  "dataset": "labor_certificate_person",
  "data": {
    "certificates": [
      {
        "protocolNumber": "123.456.789.012",
        "fileUrl": "https://dev-bureau-platform.services-valid.com.br/api/v1/file/325b2c8e-f85a-42c0-bf22-03fe8d1d2461"
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
Consulta sync	Não processa o dataset	`Dataset disponível apenas na consulta assíncrona.`
Dataset exclusivo de PF consultado com CNPJ	Não processa o dataset	`Invalid document type: this dataset is only available for individuals (CPF)`
Registro não encontrado na fonte	Falha na consulta	`[labor_certificate_person] Registro não encontrado.`
Dados insuficientes na fonte para emitir a certidão	Falha na consulta	`[labor_certificate_person] Dados insuficientes na fonte para gerar o resultado.`
Órgão emissor informa pendências para o documento	Falha na consulta	`[labor_certificate_person] A fonte informou pendências para o documento e não gerou o resultado.`
Órgão emissor ou fonte temporariamente indisponível (lentidão, tempo de resposta excedido, falha na leitura do site do órgão ou dataset desativado temporariamente)	Falha na consulta	`[labor_certificate_person] Consulta temporariamente indisponível. Tente novamente em alguns minutos.`
Falha ao salvar o PDF da certidão	Falha na consulta	`[labor_certificate_person] Não foi possível salvar o arquivo da certidão. Tente novamente em alguns minutos.`
Erro não recuperável na fonte	Falha na consulta	`[labor_certificate_person] Não foi possível concluir a consulta. Se o erro persistir, contate o suporte.`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "labor_certificate_person",
      "reason": "Dataset disponível apenas na consulta assíncrona."
    }
  ]
}

Antecedentes Criminais Federais (`federal_criminal_certificate_person`)

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["federal_criminal_certificate_person"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`certificates`	array	—	—	Lista de certidões de antecedentes criminais da Polícia Federal

Cada item de certificates (campos sem valor na fonte não são retornados):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`origin`	string	—	`"PFAntecedente"`	Fonte dos dados
`protocolNumber`	string	—	`"123456789012"`	Número de protocolo da certidão
`fileUrl`	string	URL	—	URL do PDF da certidão. Requer autenticação — veja Obtenha o PDF da certidão
`status`	string	Texto do órgão emissor	`"NADA CONSTA"`	Situação da certidão, no texto retornado pelo órgão emissor. Veja os textos já observados abaixo

Textos já observados em status (o órgão emissor pode retornar outros):

`status`	Significado
`NADA CONSTA`	Não consta condenação criminal com trânsito em julgado

Exemplo:

{
  "dataset": "federal_criminal_certificate_person",
  "data": {
    "certificates": [
      {
        "origin": "PFAntecedente",
        "protocolNumber": "123456789012",
        "status": "NADA CONSTA",
        "fileUrl": "https://dev-bureau-platform.services-valid.com.br/api/v1/file/325b2c8e-f85a-42c0-bf22-03fe8d1d2461"
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
Consulta sync	Não processa o dataset	`Dataset disponível apenas na consulta assíncrona.`
Dataset exclusivo de PF consultado com CNPJ	Não processa o dataset	`Invalid document type: this dataset is only available for individuals (CPF)`
Registro não encontrado na fonte	Falha na consulta	`[federal_criminal_certificate_person] Registro não encontrado.`
Dados insuficientes na fonte para emitir a certidão	Falha na consulta	`[federal_criminal_certificate_person] Dados insuficientes na fonte para gerar o resultado.`
Órgão emissor informa pendências para o documento	Falha na consulta	`[federal_criminal_certificate_person] A fonte informou pendências para o documento e não gerou o resultado.`
Órgão emissor ou fonte temporariamente indisponível (lentidão, tempo de resposta excedido, falha na leitura do site do órgão ou dataset desativado temporariamente)	Falha na consulta	`[federal_criminal_certificate_person] Consulta temporariamente indisponível. Tente novamente em alguns minutos.`
Falha ao salvar o PDF da certidão	Falha na consulta	`[federal_criminal_certificate_person] Não foi possível salvar o arquivo da certidão. Tente novamente em alguns minutos.`
Erro não recuperável na fonte	Falha na consulta	`[federal_criminal_certificate_person] Não foi possível concluir a consulta. Se o erro persistir, contate o suporte.`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "federal_criminal_certificate_person",
      "reason": "Dataset disponível apenas na consulta assíncrona."
    }
  ]
}

Certidão de Débitos Estaduais (`state_debt_certificate_person`)

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim
`query`	body	string	`uf=` + sigla do estado	`uf=SP`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["state_debt_certificate_person"],
  "query": "uf=SP"
}

Exemplo de retorno Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`certificates`	array	—	—	Lista de certidões de débitos estaduais

Cada item de certificates (campos sem valor na fonte não são retornados):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`origin`	string	—	`"Certidao Negativa de Debitos Estadual"`	Fonte dos dados
`protocolNumber`	string	—	`"123456/2026"`	Número de protocolo da certidão
`fileUrl`	string	URL	—	URL do PDF da certidão. Requer autenticação — veja Obtenha o PDF da certidão
`status`	string	Texto do órgão emissor	`"NEGATIVA"`	Situação da certidão, no texto retornado pelo órgão emissor. Veja os textos já observados abaixo

Textos já observados em status (o órgão emissor pode retornar outros):

`status`	Significado
`NEGATIVA`	Não constam débitos estaduais pendentes

Exemplo:

{
  "dataset": "state_debt_certificate_person",
  "data": {
    "certificates": [
      {
        "origin": "Certidao Negativa de Debitos Estadual",
        "protocolNumber": "123456/2026",
        "status": "NEGATIVA",
        "fileUrl": "https://dev-bureau-platform.services-valid.com.br/api/v1/file/325b2c8e-f85a-42c0-bf22-03fe8d1d2461"
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
Consulta sync	Não processa o dataset	`Dataset disponível apenas na consulta assíncrona.`
Dataset exclusivo de PF consultado com CNPJ	Não processa o dataset	`Invalid document type: this dataset is only available for individuals (CPF)`
`uf` não informado em `query`	Não processa o dataset	`Parâmetro uf obrigatório em query para o dataset state_debt_certificate_person (ex.: query=uf=SP).`
UF não disponível na fonte	Falha na consulta	`[state_debt_certificate_person] UF não disponível para esta consulta.`
Registro não encontrado na fonte	Falha na consulta	`[state_debt_certificate_person] Registro não encontrado.`
Dados insuficientes na fonte para emitir a certidão	Falha na consulta	`[state_debt_certificate_person] Dados insuficientes na fonte para gerar o resultado.`
Órgão emissor informa pendências para o documento	Falha na consulta	`[state_debt_certificate_person] A fonte informou pendências para o documento e não gerou o resultado.`
Órgão emissor ou fonte temporariamente indisponível (lentidão, tempo de resposta excedido, falha na leitura do site do órgão ou dataset desativado temporariamente)	Falha na consulta	`[state_debt_certificate_person] Consulta temporariamente indisponível. Tente novamente em alguns minutos.`
Falha ao salvar o PDF da certidão	Falha na consulta	`[state_debt_certificate_person] Não foi possível salvar o arquivo da certidão. Tente novamente em alguns minutos.`
Erro não recuperável na fonte	Falha na consulta	`[state_debt_certificate_person] Não foi possível concluir a consulta. Se o erro persistir, contate o suporte.`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "state_debt_certificate_person",
      "reason": "Parâmetro uf obrigatório em query para o dataset state_debt_certificate_person (ex.: query=uf=SP)."
    }
  ]
}

Certidão de Débitos Trabalhistas (`labor_debt_certificate_person`)

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["labor_debt_certificate_person"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`certificates`	array	—	—	Lista de certidões de débitos trabalhistas

Cada item de certificates (campos sem valor na fonte não são retornados):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`origin`	string	—	`"Certidao Negativa de Debitos Trabalhistas"`	Fonte dos dados
`protocolNumber`	string	—	`"12345678/2026"`	Número de protocolo da certidão
`fileUrl`	string	URL	—	URL do PDF da certidão. Requer autenticação — veja Obtenha o PDF da certidão
`status`	string	Texto do órgão emissor	`"NAO CONSTA"`	Situação da certidão, no texto retornado pelo órgão emissor. Veja os textos já observados abaixo

Textos já observados em status (o órgão emissor pode retornar outros):

`status`	Significado
`NAO CONSTA`, `NAO CONSTA como inadimplente`	Não consta como inadimplente no Banco Nacional de Devedores Trabalhistas

Exemplo:

{
  "dataset": "labor_debt_certificate_person",
  "data": {
    "certificates": [
      {
        "origin": "Certidao Negativa de Debitos Trabalhistas",
        "protocolNumber": "12345678/2026",
        "status": "NAO CONSTA",
        "fileUrl": "https://dev-bureau-platform.services-valid.com.br/api/v1/file/325b2c8e-f85a-42c0-bf22-03fe8d1d2461"
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
Consulta sync	Não processa o dataset	`Dataset disponível apenas na consulta assíncrona.`
Dataset exclusivo de PF consultado com CNPJ	Não processa o dataset	`Invalid document type: this dataset is only available for individuals (CPF)`
Registro não encontrado na fonte	Falha na consulta	`[labor_debt_certificate_person] Registro não encontrado.`
Dados insuficientes na fonte para emitir a certidão	Falha na consulta	`[labor_debt_certificate_person] Dados insuficientes na fonte para gerar o resultado.`
Órgão emissor informa pendências para o documento	Falha na consulta	`[labor_debt_certificate_person] A fonte informou pendências para o documento e não gerou o resultado.`
Órgão emissor ou fonte temporariamente indisponível (lentidão, tempo de resposta excedido, falha na leitura do site do órgão ou dataset desativado temporariamente)	Falha na consulta	`[labor_debt_certificate_person] Consulta temporariamente indisponível. Tente novamente em alguns minutos.`
Falha ao salvar o PDF da certidão	Falha na consulta	`[labor_debt_certificate_person] Não foi possível salvar o arquivo da certidão. Tente novamente em alguns minutos.`
Erro não recuperável na fonte	Falha na consulta	`[labor_debt_certificate_person] Não foi possível concluir a consulta. Se o erro persistir, contate o suporte.`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "labor_debt_certificate_person",
      "reason": "Dataset disponível apenas na consulta assíncrona."
    }
  ]
}

Certidão de Regularidade IBAMA (`ibama_regularity_certificate_person`)

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["ibama_regularity_certificate_person"]
}

Exemplo de retorno Resposta de sucesso (datasets[].data):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`certificates`	array	—	—	Lista de certidões de regularidade do IBAMA

Cada item de certificates (campos sem valor na fonte não são retornados):

Campo	Tipo	Formato / enum	Exemplo	Descrição
`origin`	string	—	`"Certificado Regularidade Ibama"`	Fonte dos dados
`protocolNumber`	string	—	`"1234567"`	Número de protocolo da certidão
`fileUrl`	string	URL	—	URL do PDF da certidão. Requer autenticação — veja Obtenha o PDF da certidão
`status`	string	Texto do órgão emissor	`"DOCUMENT DOES NOT HAVE A CERTIFICATE OF REGULARITY FROM THE FEDERAL TECHNICAL REGISTER"`	Situação da certidão, no texto retornado pelo órgão emissor. Veja os textos já observados abaixo

Textos já observados em status (o órgão emissor pode retornar outros):

`status`	Significado
`DOCUMENT DOES NOT HAVE A CERTIFICATE OF REGULARITY FROM THE FEDERAL TECHNICAL REGISTER`	A pessoa não possui Certificado de Regularidade no Cadastro Técnico Federal do IBAMA

Exemplo:

{
  "dataset": "ibama_regularity_certificate_person",
  "data": {
    "certificates": [
      {
        "origin": "Certificado Regularidade Ibama",
        "protocolNumber": "1234567",
        "status": "DOCUMENT DOES NOT HAVE A CERTIFICATE OF REGULARITY FROM THE FEDERAL TECHNICAL REGISTER",
        "fileUrl": "https://dev-bureau-platform.services-valid.com.br/api/v1/file/325b2c8e-f85a-42c0-bf22-03fe8d1d2461"
      }
    ]
  }
}

Cenário	O que acontece	Exemplo de `reason`
Consulta sync	Não processa o dataset	`Dataset disponível apenas na consulta assíncrona.`
Dataset exclusivo de PF consultado com CNPJ	Não processa o dataset	`Invalid document type: this dataset is only available for individuals (CPF)`
Registro não encontrado na fonte	Falha na consulta	`[ibama_regularity_certificate_person] Registro não encontrado.`
Dados insuficientes na fonte para emitir a certidão	Falha na consulta	`[ibama_regularity_certificate_person] Dados insuficientes na fonte para gerar o resultado.`
Órgão emissor informa pendências para o documento	Falha na consulta	`[ibama_regularity_certificate_person] A fonte informou pendências para o documento e não gerou o resultado.`
Órgão emissor ou fonte temporariamente indisponível (lentidão, tempo de resposta excedido, falha na leitura do site do órgão ou dataset desativado temporariamente)	Falha na consulta	`[ibama_regularity_certificate_person] Consulta temporariamente indisponível. Tente novamente em alguns minutos.`
Falha ao salvar o PDF da certidão	Falha na consulta	`[ibama_regularity_certificate_person] Não foi possível salvar o arquivo da certidão. Tente novamente em alguns minutos.`
Erro não recuperável na fonte	Falha na consulta	`[ibama_regularity_certificate_person] Não foi possível concluir a consulta. Se o erro persistir, contate o suporte.`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "ibama_regularity_certificate_person",
      "reason": "Dataset disponível apenas na consulta assíncrona."
    }
  ]
}

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

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim
`phoneNumber`	`query`	string	DDD + número, com ou sem `+55`	`11945545665`	Sim
`postalCode`	`query`	string	CEP (com ou sem hífen)	`30110008`	Sim

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["most_frequent_location"],
  "query": "phoneNumber=11945545665&postalCode=30110008"
}

Exemplo de retorno Resposta de sucesso (datasets[].data): Quando a operadora não retorna resultado para o telefone, data vem como {}.

Campo	Tipo	Formato / enum	Exemplo	Descrição
`score`	number	Inteiro `0` a `100`	`86`	Frequência do dispositivo na área do CEP. `0` indica que o dispositivo nunca esteve na área

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:

{
  "dataset": "most_frequent_location",
  "data": { "score": 86 }
}

Cenário	O que acontece	Exemplo de `reason`
Falta `phoneNumber` em `query`	Não chama a operadora	`Parâmetro phonenumber obrigatório em query para o dataset most_frequent_location (ex.: query=phonenumber=SP).`
Falta `postalCode` em `query`	Não chama a operadora	`Parâmetro postalcode obrigatório em query para o dataset most_frequent_location (ex.: query=postalcode=SP).`
Telefone inválido / sem DDD	Não chama a operadora	`[most_frequent_location] Telefone inválido. Informe DDD e número, ex.: phoneNumber=11945545665.`
Telefone não localizado na operadora	Falha na consulta	`[most_frequent_location] Telefone não localizado na operadora. Confirme o número informado.`
CEP inválido	Falha na consulta	`[most_frequent_location] CEP inválido para a consulta. Confirme o valor informado.`
Telefone sem suporte ao serviço	Falha na consulta	`[most_frequent_location] Este telefone não tem suporte para a consulta. Use um número da operadora com o serviço disp...`
Dados rejeitados pela operadora	Falha na consulta	`[most_frequent_location] Não foi possível consultar com os dados informados. Confirme telefone e CEP.`
Indisponibilidade temporária	Falha na consulta	`[most_frequent_location] Consulta temporariamente indisponível. Tente novamente em alguns minutos.`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "most_frequent_location",
      "reason": "[most_frequent_location] CEP inválido para a consulta. Confirme o valor informado."
    }
  ]
}

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

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim
`phoneNumber`	`query`	string	DDD + número, com ou sem `+55`	`11968348958`	Sim
`maxAge`	`query`	number (em string na query)	Inteiro `1` a `2400` (horas). Padrão: `240`	`240`	Não

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["sim_swap"],
  "query": "phoneNumber=11968348958&maxAge=240"
}

Exemplo de retorno Resposta de sucesso (datasets[].data): Quando a operadora não retorna resultado para o telefone, data vem como {}.

Campo	Tipo	Formato / enum	Exemplo	Descrição
`swapped`	boolean	`true` / `false`	`false`	Indica se houve troca de chip nas últimas `maxAge` horas

Exemplo:

{
  "dataset": "sim_swap",
  "data": { "swapped": false }
}

Cenário	O que acontece	Exemplo de `reason`
Falta `phoneNumber` em `query`	Não chama a operadora	`Parâmetro phonenumber obrigatório em query para o dataset sim_swap (ex.: query=phonenumber=SP).`
Telefone inválido / sem DDD	Não chama a operadora	`[sim_swap] Telefone inválido. Informe DDD e número, ex.: phoneNumber=11945545665.`
`maxAge` inválido (fora de 1–2400 ou não inteiro)	Não chama a operadora	`[sim_swap] maxAge inválido. Informe um inteiro entre 1 e 2400 (horas).`
Telefone não localizado na operadora	Falha na consulta	`[sim_swap] Telefone não localizado na operadora. Confirme o número informado.`
Telefone sem suporte ao serviço	Falha na consulta	`[sim_swap] Este telefone não tem suporte para a consulta. Use um número da operadora com o serviço disponível.`
Dados rejeitados pela operadora	Falha na consulta	`[sim_swap] Não foi possível consultar com os dados informados. Confirme telefone e maxAge.`
Indisponibilidade temporária	Falha na consulta	`[sim_swap] Consulta temporariamente indisponível. Tente novamente em alguns minutos.`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "sim_swap",
      "reason": "[sim_swap] Este telefone não tem suporte para a consulta. Use um número da operadora com o serviço disponível."
    }
  ]
}

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

Campo	Onde	Tipo	Formato	Exemplo	Obrigatório
`key`	body	string	CPF (11 dígitos; com ou sem máscara)	`12345678901`	Sim
`phoneNumber`	`query`	string	DDD + número, com ou sem `+55`	`34991476508`	Sim
`maxAge`	`query`	number (em string na query)	Inteiro `1` a `2400` (horas). Padrão: `240`	`240`	Não

Exemplo de body:

{
  "key": "12345678901",
  "datasets": ["device_swap"],
  "query": "phoneNumber=34991476508&maxAge=240"
}

Exemplo de retorno Resposta de sucesso (datasets[].data): Quando a operadora não retorna resultado para o telefone, data vem como {}.

Campo	Tipo	Formato / enum	Exemplo	Descrição
`swapped`	boolean	`true` / `false`	`true`	Indica se o chip foi instalado em outro aparelho nas últimas `maxAge` horas

Exemplo:

{
  "dataset": "device_swap",
  "data": { "swapped": true }
}

Cenário	O que acontece	Exemplo de `reason`
Falta `phoneNumber` em `query`	Não chama a operadora	`Parâmetro phonenumber obrigatório em query para o dataset device_swap (ex.: query=phonenumber=SP).`
Telefone inválido / sem DDD	Não chama a operadora	`[device_swap] Telefone inválido. Informe DDD e número, ex.: phoneNumber=11945545665.`
`maxAge` inválido (fora de 1–2400 ou não inteiro)	Não chama a operadora	`[device_swap] maxAge inválido. Informe um inteiro entre 1 e 2400 (horas).`
Telefone não localizado na operadora	Falha na consulta	`[device_swap] Telefone não localizado na operadora. Confirme o número informado.`
Telefone sem suporte ao serviço	Falha na consulta	`[device_swap] Este telefone não tem suporte para a consulta. Use um número da operadora com o serviço disponível.`
Dados rejeitados pela operadora	Falha na consulta	`[device_swap] Não foi possível consultar com os dados informados. Confirme telefone e maxAge.`
Indisponibilidade temporária	Falha na consulta	`[device_swap] Consulta temporariamente indisponível. Tente novamente em alguns minutos.`

Exemplo de retorno com falha:

{
  "datasets": [],
  "failedDatasets": [
    {
      "dataset": "device_swap",
      "reason": "[device_swap] Este telefone não tem suporte para a consulta. Use um número da operadora com o serviço disponível."
    }
  ]
}

Uso no request

Sync e async usam a mesma URI em cada modo. Escolha o body conforme a forma de selecionar os datasets:

Objetivo	URI	Campo obrigatório no body
Escolher datasets específicos	`POST /bureau/api/v1/bureau/person/sync` ou `/async`	`datasets`
Reutilizar um pacote de datasets	`POST /bureau/api/v1/bureau/person/sync` ou `/async`	`datasetPackageId`

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.

Exemplos

Consulta por datasets específicos:

{
  "datasets": ["basic", "addresses", "kyc"]
}

Consulta por pacote de datasets:

{
  "datasetPackageId": "05be75cc-8f8a-414a-891f-434aa9b4e7a5"
}

Consulta com parâmetros complementares (query), por exemplo para certidão estadual:

{
  "datasets": ["basic", "state_debt_certificate_person"],
  "query": "uf=SP"
}

​Dados básicos (basic)

​Endereços (addresses)

​Telefones (phones)

​E-mails (emails)

​Dados Profissionais (occupations)

​Profissões (professions)

​Carteira Nacional de Habilitação (cnh)

​Carteira Nacional de Habilitação Completa (cnh_complete)

​Relacionamentos Econômicos (business_relationships)

​Informações Financeiras (financial_data)

​Consulta Score e Dados Completo PF (score_complete_pf)

​Renda Presumida (presumed_income)

​Processos Judiciais e Administrativos (processes)

​Certidão PGFN (pgfn_certificate_person)

​Assistência Social (social_assistance)

​Assistência Social Familiar (family_social_assistance)

​Exposição e Perfil na Mídia (media_profile_and_exposure)

​Dados de Candidato Eleitoral (election_candidate_data)

​Doações Eleitorais (electoral_donors)

​KYC e Compliance (kyc)

​Beneficiário Final (ultimate_beneficial_owner)

​Distribuição de Processos Judiciais (lawsuits_distribution_data)

​Pessoas Relacionadas (related_people)

​Questionário de Endividamento (indebtedness_question)

​Cobranças (collections)

​Certidão Negativa de Débitos Federais (cnd_federal_person)

​Status Cadastral (status_person)

​Certidão Nada Consta (clearance_certificate_person)

​Certidão Trabalhista (labor_certificate_person)

​Antecedentes Criminais Federais (federal_criminal_certificate_person)

​Certidão de Débitos Estaduais (state_debt_certificate_person)

​Certidão de Débitos Trabalhistas (labor_debt_certificate_person)

​Certidão de Regularidade IBAMA (ibama_regularity_certificate_person)

​Localização mais frequente (most_frequent_location)

​Troca de chip — SIM Swap (sim_swap)

​Troca de aparelho — Device Swap (device_swap)

​Uso no request

​Exemplos

Dados básicos (`basic`)

Endereços (`addresses`)

Telefones (`phones`)

E-mails (`emails`)

Dados Profissionais (`occupations`)

Profissões (`professions`)

Carteira Nacional de Habilitação (`cnh`)

Carteira Nacional de Habilitação Completa (`cnh_complete`)

Relacionamentos Econômicos (`business_relationships`)

Informações Financeiras (`financial_data`)

Consulta Score e Dados Completo PF (`score_complete_pf`)

Renda Presumida (`presumed_income`)

Processos Judiciais e Administrativos (`processes`)

Certidão PGFN (`pgfn_certificate_person`)

Assistência Social (`social_assistance`)

Assistência Social Familiar (`family_social_assistance`)

Exposição e Perfil na Mídia (`media_profile_and_exposure`)

Dados de Candidato Eleitoral (`election_candidate_data`)

Doações Eleitorais (`electoral_donors`)

KYC e Compliance (`kyc`)

Beneficiário Final (`ultimate_beneficial_owner`)

Distribuição de Processos Judiciais (`lawsuits_distribution_data`)

Pessoas Relacionadas (`related_people`)

Questionário de Endividamento (`indebtedness_question`)

Cobranças (`collections`)

Certidão Negativa de Débitos Federais (`cnd_federal_person`)

Status Cadastral (`status_person`)

Certidão Nada Consta (`clearance_certificate_person`)

Certidão Trabalhista (`labor_certificate_person`)

Antecedentes Criminais Federais (`federal_criminal_certificate_person`)

Certidão de Débitos Estaduais (`state_debt_certificate_person`)

Certidão de Débitos Trabalhistas (`labor_debt_certificate_person`)

Certidão de Regularidade IBAMA (`ibama_regularity_certificate_person`)

Localização mais frequente (`most_frequent_location`)

Troca de chip — SIM Swap (`sim_swap`)

Troca de aparelho — Device Swap (`device_swap`)

Uso no request

Exemplos