post
https://api.credify.com.br/backgroundcheckpf
Esta API realiza a consulta completa de Background Check para Pessoa Física (CPF). O sistema acessa em tempo real múltiplas fontes de dados, consolidando informações cadastrais, vínculos societários, pendências financeiras e registros jurídicos do indivíduo. A resposta retorna dados cadastrais detalhados, score de crédito, analise bureau e relatório jurídico com processos vinculados. É uma ferramenta indispensável para análise de crédito individual, prevenção a fraudes e onboarding de clientes pessoa física.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
TABELA DE CAMPOS DE REQUISIÇÃO
| Campo | Descrição | Formato | Obrigatório (Sim / Não) |
|---|---|---|---|
| IdConsulta | Identificador único da consulta | string | Sim |
| CPF | CPF do indivíduo a ser consultado | string | Sim |
| TipoPessoa | Tipo de pessoa — sempre "F" para Pessoa Física | string | Sim |
TABELA DE CAMPOS DE RETORNO
| Campo | Descrição | Formato |
|---|---|---|
| CONSULTA.CODIGORESPOSTA | Código de resposta da requisição | string |
| CONSULTA.DATAHORA | Data e hora em que a consulta foi realizada | string |
| CONSULTA.LOGON | Código/Logon do usuário que realizou a consulta | string |
| CONSULTA.IDCONSULTA | Identificador único da consulta realizada | string |
| RESPOSTA.CODIGO | Lista de códigos de status de retorno | array de strings |
| RESPOSTA.DADOSCADASTRAIS.CPFCNPJ | Número do CPF ou CNPJ do consultado | string |
| RESPOSTA.DADOSCADASTRAIS.NOMERAZAO | Nome completo ou Razão Social | string |
| RESPOSTA.DADOSCADASTRAIS.NASCFUND | Data de nascimento ou fundação | string |
| RESPOSTA.DADOSCADASTRAIS.SEXO | Sexo biológico do titular | string |
| RESPOSTA.DADOSCADASTRAIS.NOMEMAE | Nome completo da mãe | string |
| RESPOSTA.DADOSCADASTRAIS.SIGNO | Signo astrológico | string |
| RESPOSTA.DADOSCADASTRAIS.IDADE | Idade do indivíduo | string |
| RESPOSTA.OBS.OBS | Observações gerais relacionadas ao cadastro | string |
| RESPOSTA.ENDERECOS.REGISTRO_X.TP_LOGRADOURO | Tipo do logradouro (Ex: AV, R, AL) do endereço principal | string |
| RESPOSTA.ENDERECOS.REGISTRO_X.LOGRADOURO | Nome do logradouro do endereço principal | string |
| RESPOSTA.ENDERECOS.REGISTRO_X.NUMERO | Número do endereço principal | string |
| RESPOSTA.ENDERECOS.REGISTRO_X.COMPLEMENTO | Complemento do endereço principal | string |
| RESPOSTA.ENDERECOS.REGISTRO_X.BAIRRO | Bairro do endereço principal | string |
| RESPOSTA.ENDERECOS.REGISTRO_X.CIDADE | Cidade do endereço principal | string |
| RESPOSTA.ENDERECOS.REGISTRO_X.UF | Unidade Federativa (estado) do endereço principal | string |
| RESPOSTA.ENDERECOS.REGISTRO_X.CEP | CEP do endereço principal | string |
| RESPOSTA.PFVINCULO | Informações sobre vínculos com pessoas físicas | string |
| RESPOSTA.ENDERECOSADICIONAIS.REGISTRO_X | Estrutura de endereços adicionais (mesmos campos do endereço) | objeto |
| RESPOSTA.TELEFONES.REGISTRO_X.TIPO_CONTATO_TELEFONE | Classificação do telefone (Ex: RESIDENCIAL) | string |
| RESPOSTA.TELEFONES.REGISTRO_X.WHATSAPP | Indica se o número possui chave de WhatsApp vinculada | string |
| RESPOSTA.TELEFONES.REGISTRO_X.DDD | Código de Discagem Direta a Distância (DDD) do telefone | string |
| RESPOSTA.TELEFONES.REGISTRO_X.TELEFONE | Número do telefone | string |
| RESPOSTA.EMAIL.REGISTRO_X.EMAIL | Endereço de e-mail associado ao indivíduo | string |
| RESPOSTA.PARTICIPACAOSOCIETARIA | Informações sobre participação societária em empresas | string |
| RESPOSTA.BOLSAFAMILIA | Indicação se o CPF é ou foi beneficiário do Bolsa Família | string |
| RESPOSTA.ESPORTISTA | Estrutura com dados de vínculo esportivo (modalidade, equipe, etc) | objeto |
| RESPOSTA.PEPPARENTESCO | Estrutura com dados sobre ser Pessoa Politicamente Exposta (PEP) | objeto |
| RESPOSTA.RELATORIOJURIDICO.DATA.CONTAGEM | Quantidade total de processos jurídicos localizados | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_X.NUMEROPROCESSOUNICO | Número único do processo na justiça (padrão CNJ) | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_X.AREA | Área do direito a que se refere o processo (Ex: CIVEL) | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_X.TRIBUNAL | Sigla do tribunal onde tramita o processo | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_X.CLASSEPROCESSUAL.NOME | Classificação da ação jurídica (Ex: DESPEJO, EXECUÇÃO) | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_X.VALORCAUSA.VALOR | Valor atribuído à causa do processo | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_X.DATADISTRIBUICAO | Data de distribuição do processo na justiça | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_X.STATUSPREDICTUS.STATUSPROCESSO | Status atual de andamento do processo (Ex: EM TRAMITACAO) | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_X.PARTES | Lista de partes (nome, documento, polo) envolvidas na ação | array de objetos |
| RESPOSTA.RELATORIOJURIDICO.DATA.[civel/trabalhista/criminal/etc] | Contagem sumarizada de processos por cada esfera do direito | string |
| RESPOSTA.PESQUISAQUODPFSCORE.QUODREPORTRESPONSEEX.RESPONSE.RECORDS.RECORD.REGISTRO_0.QUODSCORE.SCORE | Pontuação de crédito (Score) retornada pelo bureau Quod | string |
| RESPOSTA.PESQUISACREDNETLIGHT.DADOS_CONSULTA.DOCUMENTO | Documento alvo da consulta na base de proteção ao crédito | string |
| RESPOSTA.PESQUISACREDNETLIGHT.CONFIRMEI.SITUACAO_CPFCNPJ | Situação cadastral do documento na Receita Federal (Ex: ATIVA) | string |
| RESPOSTA.PESQUISACREDNETLIGHT.PEFIN.REGISTRO.REGISTRO_X.DATA_OCORRENCIA | Data da ocorrência de pendência financeira | string |
| RESPOSTA.PESQUISACREDNETLIGHT.PEFIN.REGISTRO.REGISTRO_X.VALOR | Valor da pendência financeira (PEFIN) | string |
| RESPOSTA.PESQUISACREDNETLIGHT.PEFIN.REGISTRO.REGISTRO_X.ORIGEM | Nome do credor responsável pela anotação de débito | string |
| RESPOSTA.PESQUISACREDNETLIGHT.PROTESTOS.REGISTRO.REGISTRO_X.VALOR | Valor do título protestado em cartório | string |
| RESPOSTA.PESQUISACREDNETLIGHT.PROTESTOS.REGISTRO.REGISTRO_X.CARTORIO | Número ou nome do cartório onde consta o protesto | string |
| RESPOSTA.PESQUISACREDNETLIGHT.RESUMO_OCORRENCIAS | Estrutura contendo o resumo numérico e financeiro das dívidas e protestos | objeto |
| RESPOSTA.BACKGROUNDCHECK | Códigos ou IDs das pesquisas de background efetuadas no relatório | objeto |
Lógica de Resposta (Vetor de Status)
A API utiliza um sistema de mapeamento posicional dentro do array RESPOSTA.CODIGO. Esse array serve como um "sumário de integridade", permitindo identificar quais blocos de dados retornaram informações válidas e quais estão vazios, sem a necessidade de percorrer todo o objeto JSON.
| Código | Descrição |
|---|---|
| 1 | Bloco processado com sucesso e contém dados. |
| 2 | Bloco processado, mas não foram encontrados dados para o documento consultado. |
Bad Request
Unauthorized