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 Cadastrais Básicos (basic)
Informações cadastrais fundamentais da pessoa física.
Quando usar: Validação de identidade, processos de cadastro, verificação de dados fornecidos.
- cpf (string): CPF
- name (string): Nome completo
- birthDate (string): Data de nascimento
- birthPlace (string): País de nascimento
- gender (string): Gênero
- nationality (string): Nacionalidade
- motherName (string): Nome da mãe
- fatherName (string): Nome do pai
- taxIdStatus (string): Status do CPF na Receita Federal
- hasObitIndication (boolean): Indicação de óbito
- obitIndicationYear (string): Ano de óbito
- maritalStatus (string): Estado civil
- age (number): Idade
Endereços (addresses)
Retorna informações detalhadas sobre endereços associados ao CPF.
Quando usar: Validação de endereço, análise de estabilidade residencial, verificação de consistência cadastral.
- streetAddress (string): Logradouro completo
- addressLocality (string): Cidade
- addressRegion (string): Estado
- postalCode (string): CEP
- addressCountry (string): País
- complement (string): Complemento
- neighborhood (string): Bairro
- isActive (boolean): Endereço ativo
- isMain (boolean): Endereço principal
Telefones (phones)
Fornece dados sobre telefones vinculados ao CPF.
Quando usar: Validação de contato, análise de canais de comunicação, detecção de inconsistências.
- number (string): Número de telefone
- areaCode (string): Código de área
- countryCode (string): Código de país
E-mails (emails)
E-mails vinculados ao CPF com informações de validade.
Quando usar: Validação de canal de comunicação digital, verificação de identidade online
- email (string): E-mail
- isActive (boolean): E-mail ativo
- isMain (boolean): E-mail principal
Dados Profissionais (occupations)
Histórico de empregos e atividades profissionais.
Quando usar: Verificação de renda, análise de capacidade de pagamento, validação de informações profissionais.
- jobTitle (string): Cargo
- worksFor (string): Empresa
- occupationalCategory (string): Categoria
- startDate (string): Data início
- endDate (string): Data término
- income (number): Renda
Profissões (professions)
Informações sobre a atividade profissional declarada ou registrada da pessoa:
Quando usar: Validação de perfil profissional, análise de consistência cadastral, avaliação socioeconômica.
- jobTitle (string): Cargo
- worksFor (string): Empresa
- startDate (string): Data início
- endDate (string): Data término
Relacionamentos Econômicos (business_relationships)
Relações com empresas e participações societárias:
Quando usar: Análise de exposição a riscos, mapeamento de vínculos empresariais, due diligence.
- key (string): CPF/CNPJ da entidade
- name (string): Nome da entidade
- relationshipType (string): Tipo de relacionamento
- startDate (string): Data início
- endDate (string): Data término
- isCurrentlyActive (boolean): Ativo
Informações Financeiras (financial_data)
Indicadores financeiros e estimativas de patrimônio:
Quando usar: Análise de crédito, definição de limites, avaliação de capacidade de pagamento.
- totalAssets (string): Estimativa de patrimônio
- taxReturns (array): Restituições de Imposto de Renda. Cada item do array possui:
- year (string): Ano da declaração
- status (string): Status da restituição
- bank (string): Banco
- branch (string): Agência
- batch (string): Lote
- creationDate (string): Data de criação
- lastUpdateDate (string): Data de atualização
Processos Judiciais e Administrativos (processes)
Histórico completo de processos envolvendo a pessoa física:
Quando usar: Avaliação de riscos jurídicos, verificação de antecedentes, due diligence.
- processes (array): Lista de processos. O array contém objetos com:
- number (string): Número do processo
- courtLevel (string): Nível do tribunal
- partyType (string): Tipo de parte no processo
- status (string): Situação do processo
- lastMovementDate (string): Data do último andamento
- noticeDate (string): Data da intimação/citação
- closeDate (string): Data de encerramento
- resJudicataDate (string): Data do trânsito em julgado
- value (number): Valor do processo
- captureDate (string): Data de captura da informação
- totalProcesses (number): Total de processos
- totalProcessesAsAuthor (number): Processos como parte ativa (autor, requerente, reclamante)
- totalProcessesAsDefendant (number): Processos como parte passiva (réu, requerido, executado)
- totalProcessesAsOther (number): Processos com outro tipo de parte
- firstProcessDate (string): Data do primeiro processo
- lastProcessDate (string): Data do último processo
Certidão PGFN (pgfn_certificate_person)
Disponibilidade: apenas assíncrono (POST /person/async).
Consulta on-demand de débitos tributários federais.
Quando usar: Análise de compliance fiscal, verificação de regularidade tributária, processos de crédito.
- origin (string): Origem
- protocolNumber (string): Protocolo
- fileUrl (string): URL do resultado
- status (string): Status
Assistência Social (social_assistance)
Registros de participação em programas de assistência social:
Quando usar: Avaliação socioeconômica, validação de informações declaradas.programName (string): Nome do programa
- programState (string): Estado
- assistanceAmount (number): Valor mensal
- assistanceTotalAmount (number): Total recebido
Assistência Social Familiar (family_social_assistance)
Benefícios de assistência social do núcleo familiar.
Quando usar: Avaliação socioeconômica familiar, validação de renda indireta.
- totalMembers (number): Total de membros
- totalBeneficiaries (number): Total de beneficiários
- totalAssistances (number): Total de assistências
- totalAmountReceived (number): Valor total recebido
- socialAssistances (array): Lista de assistências sociais familiares. Cada item possui:
- programName (string): Nome do programa
- beneficiaries (number): Número de beneficiários
- totalAssistanceAmount (number): Valor total recebido
Exposição e Perfil na Mídia (media_profile_and_exposure)
Análise de presença em notícias e mídia.
Quando usar: Análise de reputação, monitoramento de imagem, due diligence reputacional.
- mediaExposureLevel (string): Nível de exposição
- celebrityLevel (string): Nível de celebridade
- unpopularityLevel (string): Nível de impopularidade
- newsItems (array): Cada item possui os seguintes campos:
- title (string): Título da notícia
- sourceName (string): Nome da fonte
- url (string): URL da notícia
- publicationDate (string): Data de publicação
Dados de Candidato Eleitoral (election_candidate_data)
Participação em eleições.
Quando usar: Identificação de exposição política, análise de risco reputacional, compliance.
- hasRunForOffice (boolean): Participou de eleição
- hasBeenElected (boolean): Foi eleito
- numberOfTimesRanForOffice (number): Vezes que participou
- electionData (array): Cada item contém:
- electionYear (number): Ano da eleição
- electionType (string): Tipo de eleição
- applicationRole (string): Cargo pleiteado
- wasElected (boolean): Foi eleito
- partyName (string): Nome do partido
Doações Eleitorais (electoral_donors)
Registros de doações para campanhas eleitorais:
Quando usar: Identificação de exposição política, análise reputacional, due diligence.
- totalDonationsAmount (number): Quantidade de doações
- totalDonatedValue (number): Valor total doado
- electionDonationData (array): Cada item possui:
- electionYear (number): Ano da eleição
- applicationRole (string): Cargo
- totalDonationValue (number): Valor total doado
KYC e Compliance (kyc)
Informações regulatórias e de compliance
Quando usar: Processos de KYC/compliance, prevenção à lavagem de dinheiro (PLD), análise de risco reputacional.
- isCurrentlyPEP (boolean): É PPE atualmente
- isCurrentlySanctioned (boolean): Sancionado atualmente
- pepHistory (array): Histórico de PPE. Cada item possui:
- level (string): Nível do PPE
- jobTitle (string): Cargo
- state (string): Estado
- isCurrentlyPEP (boolean): É PPE atualmente
- sanctionsHistory (array): Histórico de sanções. Cada item possui:
- source (string): Fonte da sanção
- type (string): Tipo de sanção
- isCurrentlySanctioned (boolean): Sancionado atualmente
Distribuição de Processos Judiciais (lawsuits_distribution_data)
Informações sobre a distribuição de processos judiciais:
Quando usar: Due diligence jurídica, análise de histórico judicial, monitoramento de novos processos.
- totalLawsuits (number): Total de processos
- typeDistribution (array): Distribuição por tipo. Cada item possui:
- value (string): Valor/tipo do processo
- count (number): Quantidade de processos deste tipo
- statusDistribution (array): Distribuição por status. Cada item possui:
- value (string): Status do processo
- count (number): Quantidade de processos com este status
Pessoas Relacionadas (related_people)
Mapeamento de vínculos entre a pessoa consultada e outras pessoas físicas ou jurídicas:
Quando usar: Análise de rede de relacionamento, identificação de vínculos indiretos, investigações de risco.
- relatedEntityTaxIdNumber (string): CPF/CNPJ relacionado
- relatedEntityName (string): Nome
- relationshipType (string): Tipo de relacionamento
- relationshipLevel (string): Nível
- totalRelationships (number): Total de relacionamentos
Questionário de Endividamento (indebtedness_question)
Informações sobre situação de endividamento.
Quando usar: Avaliação de crédito, análise financeira, concessão de crédito.
- likelyInDebt (boolean): Provavelmente inadimplente
- evidences (array): Cada item: id, source (fonte)
Cobranças (collections)
Registros de cobrança e recuperação de crédito:
Quando usar: Avaliação de risco de crédito, análise de inadimplência.
- isCurrentlyOnCollection (boolean): Em cobrança atualmente
- totalCollectionOccurrences (number): Total de ocorrências
- totalCollectionOrigins (number): Total de origens
Status Cadastral (status_person)
Disponibilidade: apenas assíncrono (POST /person/async).
Situação cadastral da pessoa em registros oficiais:
Quando usar: Validação cadastral, onboarding, verificação de consistência.
- origin (string): Origem
- fileUrl (string): URL
- status (string): Status
Certidão Nada Consta (clearance_certificate_person)
Disponibilidade: apenas assíncrono (POST /person/async).
Certidão de ausência de pendências em ações judiciais:
Quando usar: Verificação de regularidade administrativa, processos de contratação.
- origin (string): Origem
- protocolNumber (string): Protocolo
- fileUrl (string): URL
- status (string): Status
Certidão Trabalhista (labor_certificate_person)
Disponibilidade: apenas assíncrono (POST /person/async).
Certidões de ações trabalhistas.
Quando usar: Due diligence trabalhista, verificação de pendências legais.
- protocolNumber (string): Protocolo
- fileUrl (string): URL
- status (string): Status
Antecedentes Criminais Federais (federal_criminal_certificate_person)
Disponibilidade: apenas assíncrono (POST /person/async).
Certidão de antecedentes criminais emitida pela Polícia Federal.
Quando usar: Processos seletivos, contratações, verificação de background.
- origin (string): Origem
- protocolNumber (string): Protocolo
- fileUrl (string): URL
- status (string): Status
Certidão de Débitos Estaduais (state_debt_certificate_person)
Certidão de ausência de débito por estado
Quando usar: Verificação de regularidade fiscal estadual, compliance.
- origin (string): Origem
- protocolNumber (string): Protocolo
- fileUrl (string): URL
- status (string): Status
Certidão de Débitos Trabalhistas (labor_debt_certificate_person)
Disponibilidade: apenas assíncrono (POST /person/async).
Certidão de ausência de débito trabalhista.
Quando usar: Due diligence trabalhista, verificação de regularidade legal.
- origin (string): Origem
- protocolNumber (string): Protocolo
- fileUrl (string): URL
- status (string): Status
Certidão de Regularidade IBAMA (ibama_regularity_certificate_person)
Disponibilidade: apenas assíncrono (POST /person/async).
Certidão de regularidade ambiental perante o IBAMA.
Quando usar: Due diligence ambiental, compliance regulatório.
- origin (string): Origem
- protocolNumber (string): Protocolo
- fileUrl (string): URL
- status (string): Status
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 |
failedDatasets.