Clique aqui para baixar os datasets disponíveis e os respectivos campos de retorno.
💫 Gold
Os dados dos datasets GOLD são oriundos da Receita Federal e do Cadastro Positivo.
O Cadastro Positivo é um banco de dados que reúne o histórico de pagamento de consumidores e empresas, abrangendo empréstimos, cheque especial, cartões de crédito, consórcios, financiamentos e contas recorrentes. Funciona como um currículo financeiro usado na análise de crédito e é essencial para definir o score de crédito.
![PortalMost.gif](https://api.apidog.com/api/v1/projects/550769/resources/343161/image-preview)
O score de crédito *(field score)* é uma pontuação de 300 a 1000, baseada nos dados positivos nos termos da Lei 12.414/11, dados negativos e dados cadastrais. Quanto maior o score, menor a chance de inadimplência. Ele facilita a análise ao classificar a pontuação em faixas alta, média e baixa, refletindo a probabilidade de um consumidor honrar seus pagamentos.
Indicador *(field segment)* numérico que indica:
1. Com atraso no positivo e com negativo ativo ou baixado
2. Com atraso no positivo e sem negativo ou baixado
3. Sem atraso no positivo e com negativo ativo ou baixado
4. Sem atraso no positivo e sem negativo ativo ou baixado
5. Sem positivo e com negativo ativo ou baixado
6. Sem informações
Score de compromisso de pagamento *(field PaymentCommitmentScore)* que indica o percentual de probabilidade de um cliente honrar com seus compromissos financeiros em dia.
Score de capacidade de pagamento *(field ProfileScore)* que indica o percentual de probabilidade de um cliente honrar com seus compromissos financeiros com base na sua capacidade de pagamento.
- **Code**: **pf_gold_report_pf_488029**
- **Periodicidade de atualização**: Até dois meses.
- **Principais dados**: Apresenta informações cadastrais, indicadores e detalhes de risco de crédito, score, ações judiciais, participações em empresas, CCF.
- **Code**: **pf_gold_bestinfo_report_pf_488029**
- **Periodicidade de atualização**: Até dois meses.
- **Principais dados**: Apresenta informações cadastrais e participações em empresas.
- **Code**: **pf_gold_negative_flag_report_pf_488029**
- **Periodicidade de atualização**: Até dois meses.
- **Principais dados**: Apresenta indicadores de risco de crédito, ações judiciais, CCF.
- **Code**: **pf_gold_negative_info_report_pf_488029**
- **Periodicidade de atualização**: Até dois meses.
- **Principais dados**: Apresenta informações detalhadas de risco de crédito e pendências, ações judiciais, CCF.
- **Code**: **pf_gold_score_report_pf_488029**
- **Periodicidade de atualização**: Até dois meses.
- **Principais dados**: Apresenta informações referentes ao score.
🌐 On-demand
As consultas on-demand são realizadas em tempo real, o que pode ser pontualmente impactado por instabilidades da fonte, alterações ou variações de captcha, flutuações de conectividade, entre outros fatores. Nesse cenário, sugerimos o uso da rota assíncrona/webhook, junto com a implementação de um mecanismo de retry para consultas malsucedidas.
- **Code**: **rf_situacao_cadastral_cpf_ondemand_817669**
- **Parâmetro(s) de entrada**: cpf, data_nascimento.
- **Origem dos dados**: Receita Federal do Brasil.
- **Principais dados**: CPF, nome, data de nascimento, situação cadastral, data de inscrição, dígito verificador, comprovante emitido às, código de controle, comprovante em PDF e qrcode de acesso ao comprovante.
- **Code**: **cenprot_consulta_protestos_cpf_ondemand_817669**
- **Parâmetro(s) de entrada**: cpf
- **Origem dos dados**: Receita Federal e do Cadastro Positivo.
- **Principais dados**: Valor protestado, data do protesto, data de vencimento, nome do cartório, nome do apresentante, número da chave do protesto, etc.
🗂️ Atualização Regular
Os datasets de atualização regular não são consultados em tempo real. Seus dados são previamente coletados e atualizados em intervalos periódicos.
- **Code**: **basic_data_people_862909**
- **Parâmetro(s) de entrada**: cpf
- **Origem dos dados**: Receita Federal, CNIS (Cadastro Nacional de Informações Sociais), processos judiciais, entidades de classe.
- **Periodicidade de atualização**: Mensal.
- **Principais dados**: Nome, CPF, Sexo, Signo, Data de nascimento, Nome da mãe, Idade, Situação Fiscal, Região Fiscal, Óbito e Data de consulta.
- **Code**: **related_people_people_862909**
- **Parâmetro(s) de entrada**: cpf
- **Origem dos dados**: Resultado de um processo de inferência baseada nas informações coletadas de fontes públicas.
- **Periodicidade de atualização**: Mensal.
- **Principais dados**: São retornadas informações como nome, CPF, tipo de relacionamento, nível de relacionamento.
- **Code**: **processes_people_862909**
- **Parâmetro(s) de entrada**: cpf
- **Origem dos dados**: Tribunais de Justiça do Brasil
- **Periodicidade de atualização e cobertura temporal**: Os processos são capturados/atualizados conforme publicações oficiais. Este dataset cobre processos abertos a partir do ano de 2015 ou processos abertos antes de 2015 mas que tiveram tramitação posterior a 2015.
- **Principais dados**: Nome, CPF, Sexo, Signo, Data de nascimento, Nome da mãe, Idade, Situação Fiscal, Região Fiscal, Óbito e Data de consulta.
- **Code**: **kyc_people_862909**
- **Parâmetro(s) de entrada**: cpf
- **Origem dos dados**: CVM - Alerta Suspensão, CVM - Penalidade Temporaria, CVM - Termo Compromisso, Banco Central - Inabilitados, Embargos do Ibama, OFAC, COAF, EU, GOVUK, FBI, INTERPOL, UNSC, CEAF, CNEP, MTE (Trabalho Escravo), Conselho Nacional de Justiça, CEIS, CEPIM, Inidôneos TCU (Tribunal de Contas da União), Acordos de Leniência (Controladoria-Geral da União), Processo Administrativo Disciplinar (BSM Supervisão), Impedidos de Licitar e Contratar Banco, Tribunal de Contas do Estado de São Paulo, SEAPE-DF, Canada Sanctions.
- **Periodicidade de atualização**: Mensal.
- **Principais dados**:
São retornadas informações sobre pessoas politicamente expostas (PPE ou PEP), sanções e restrições em níveis nacional e internacional. Se uma pessoa foi PPE no passado, o registro histórico estará presente, mas o flag não estará marcado. Também temos o conceito de PPE Estendido, que indica se a pessoa é relacionada a um PPE através de relações familiares além do 1º grau ou outros tipos de relacionamento. PPEs de nível 1 são listadas diretamente nas fontes oficiais, enquanto PPEs de nível 2 ou superior têm algum relacionamento, direto ou indireto, com um PPE de nível 1.