post
https://api.credify.com.br/kycrh
Esta API realiza a consulta completa de KYC (Know Your Customer) para pessoas físicas. O sistema agrega em uma única chamada múltiplas fontes de dados: dados cadastrais, endereços, telefones, e-mails, vínculos societários e familiares, participação societária, relatório jurídico completo, score de crédito, exposição pública em mídia e verificação de sanções internacionais (Interpol, FBI, DDTC). A resposta retorna o score de força de vínculo (SCOREFORCAVINCULO) — que valida a correspondência dos dados informados com os dados cadastrais —, o SCORE de crédito (0 a 1000) e o histórico de processos judiciais por área. É uma ferramenta indispensável para due diligence em processos admissionais (RH), análise de crédito, prevenção à fraude e conformidade regulatória (KYC/AML).
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 |
|---|---|---|---|
| IdConsulta | Identificador único da consulta gerado pelo cliente | string | Sim |
| CpfCnpj | CPF da pessoa física consultada (somente números) | string | Sim |
| Nome | Nome completo da pessoa física | string | Sim |
| TipoPessoa | Tipo de pessoa. Valor fixo: "F" para Física | string | Sim |
| Logradouro | Logradouro do endereço. Aumenta precisão do SCOREFORCAVINCULO | string | Não |
| Cep | CEP do endereço (somente números). Aumenta precisão do SCOREFORCAVINCULO | string | Não |
| Telefone | Telefone com DDD (somente números). Aumenta precisão do SCOREFORCAVINCULO | string | Não |
| E-mail do consultado. Aumenta precisão do SCOREFORCAVINCULO | string | Não |
TABELA DE CAMPOS DE RETORNO
| Campo | Descrição | Formato |
|---|---|---|
| CONSULTA.CODIGORESPOSTA | Código interno de resposta gerado pela Credify | string |
| CONSULTA.DATAHORA | Data e hora da consulta no formato DD/MM/AAAA HH:MM:SS | string |
| CONSULTA.LOGON | Identificador do usuário que realizou a consulta | string |
| CONSULTA.IDCONSULTA | Identificador da consulta enviado na requisição | string |
| RESPOSTA.CODIGO | Códigos de retorno de cada dataset consultado | array |
| RESPOSTA.DADOSCADASTRAIS.CPFCNPJ | CPF da pessoa | string |
| RESPOSTA.DADOSCADASTRAIS.NOMERAZAO | Nome completo | string |
| RESPOSTA.DADOSCADASTRAIS.NASCFUND | Data de nascimento no formato DD/MM/AAAA | string |
| RESPOSTA.DADOSCADASTRAIS.SEXO | Sexo (M/F) | string |
| RESPOSTA.DADOSCADASTRAIS.NOMEMAE | Nome da mãe | string |
| RESPOSTA.DADOSCADASTRAIS.SIGNO | Signo do zodíaco | string |
| RESPOSTA.DADOSCADASTRAIS.IDADE | Idade em anos | string |
| RESPOSTA.OBS.OBS | SIM se há observações restritivas, NAO caso contrário | string |
| RESPOSTA.ENDERECOS.REGISTRO_N.TP_LOGRADOURO | Tipo de logradouro | string |
| RESPOSTA.ENDERECOS.REGISTRO_N.LOGRADOURO | Nome do logradouro | string |
| RESPOSTA.ENDERECOS.REGISTRO_N.NUMERO | Número | string |
| RESPOSTA.ENDERECOS.REGISTRO_N.BAIRRO | Bairro | string |
| RESPOSTA.ENDERECOS.REGISTRO_N.CIDADE | Cidade | string |
| RESPOSTA.ENDERECOS.REGISTRO_N.UF | Estado (sigla) | string |
| RESPOSTA.ENDERECOS.REGISTRO_N.CEP | CEP | string |
| RESPOSTA.PFVINCULO.REGISTRO_N.CPF | CPF do vinculado | string |
| RESPOSTA.PFVINCULO.REGISTRO_N.NOME | Nome do vinculado | string |
| RESPOSTA.PFVINCULO.REGISTRO_N.GRAU_VINCULO | Grau do vínculo (SOCIO, PAI, MAE, etc.) | string |
| RESPOSTA.ENDERECOSADICIONAIS.REGISTRO_N.LOGRADOURO | Nome do logradouro (histórico) | string |
| RESPOSTA.ENDERECOSADICIONAIS.REGISTRO_N.NUMERO | Número (histórico) | string |
| RESPOSTA.ENDERECOSADICIONAIS.REGISTRO_N.BAIRRO | Bairro (histórico) | string |
| RESPOSTA.ENDERECOSADICIONAIS.REGISTRO_N.CIDADE | Cidade (histórico) | string |
| RESPOSTA.ENDERECOSADICIONAIS.REGISTRO_N.UF | Estado (histórico) | string |
| RESPOSTA.ENDERECOSADICIONAIS.REGISTRO_N.CEP | CEP (histórico) | string |
| RESPOSTA.TELEFONES.REGISTRO_N.TIPO_CONTATO_TELEFONE | Tipo do contato (COMERCIAL, RESIDENCIAL, RECADO) | string |
| RESPOSTA.TELEFONES.REGISTRO_N.WHATSAPP | Indica se o número tem WhatsApp (SIM/NAO) | string |
| RESPOSTA.TELEFONES.REGISTRO_N.DDD | DDD do telefone | string |
| RESPOSTA.TELEFONES.REGISTRO_N.TELEFONE | Número do telefone sem DDD | string |
| RESPOSTA.EMAIL.REGISTRO_N.EMAIL | Endereço de e-mail | string |
| RESPOSTA.PARTICIPACAOSOCIETARIA.REGISTRO_N.CNPJ | CNPJ da empresa | string |
| RESPOSTA.PARTICIPACAOSOCIETARIA.REGISTRO_N.RAZAOSOCIAL | Razão social da empresa | string |
| RESPOSTA.PARTICIPACAOSOCIETARIA.REGISTRO_N.PERCENTUAL | Percentual de participação societária | string |
| RESPOSTA.PARTICIPACAOSOCIETARIA.REGISTRO_N.DATA | Data de entrada na sociedade | string |
| RESPOSTA.PARTICIPACAOSOCIETARIA.REGISTRO_N.QUALIFICACAO | Qualificação societária | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.CONTAGEM | Total de processos encontrados | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.civel | Quantidade de processos cíveis | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.trabalhista | Quantidade de processos trabalhistas | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.criminal | Quantidade de processos criminais | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.fiscal | Quantidade de processos fiscais | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_N._ID | Identificador único do processo | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_N.NUMEROPROCESSOUNICO | Número único do processo (CNJ) | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_N.AREA | Área do direito (CIVEL, TRABALHISTA, CRIMINAL, FISCAL) | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_N.TRIBUNAL | Tribunal onde o processo tramita | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_N.CLASSEPROCESSUAL.NOME | Classe processual | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_N.GRAUPROCESSO | Grau do processo (1 = 1ª instância, 2 = 2ª) | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_N.VALORCAUSA.VALOR | Valor da causa em reais | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_N.DATADISTRIBUICAO | Data de distribuição do processo | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_N.STATUSPREDICTUS.STATUSPROCESSO | Status atual do processo | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_N.PARTES.CPF | CPF da parte | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_N.PARTES.CNPJ | CNPJ da parte | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_N.PARTES.TIPO | Tipo de participação no processo | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_N.PARTES.NOME | Nome da parte | string |
| RESPOSTA.RELATORIOJURIDICO.DATA.LISTLAWSUIT.REGISTRO_N.PARTES.POLO | Polo processual (ATIVO ou PASSIVO) | string |
| RESPOSTA.PESQUISAQUODPFSCORE.QUODREPORTRESPONSEEX.RESPONSE.HEADER.STATUS | Status da consulta QUOD (0 = sucesso) | string |
| RESPOSTA.PESQUISAQUODPFSCORE.QUODREPORTRESPONSEEX.RESPONSE.HEADER.TRANSACTIONID | ID de transação QUOD | string |
| RESPOSTA.PESQUISAQUODPFSCORE.QUODREPORTRESPONSEEX.RESPONSE.RECORDS.RECORD.REGISTRO_N.CPSTATUS | Status do CPF na base QUOD | string |
| RESPOSTA.PESQUISAQUODPFSCORE.QUODREPORTRESPONSEEX.RESPONSE.RECORDS.RECORD.REGISTRO_N.SEGMENT | Segmento de perfil de crédito | string |
| RESPOSTA.PESQUISAQUODPFSCORE.QUODREPORTRESPONSEEX.RESPONSE.RECORDS.RECORD.REGISTRO_N.QUODSCORE.SCORE | Score de crédito QUOD (0 a 1000) | string |
| RESPOSTA.PESQUISAQUODPFSCORE.QUODREPORTRESPONSEEX.RESPONSE.RECORDS.RECORD.REGISTRO_N.QUODSCORE.PAYMENTCOMMITMENTSCORE | Score de comprometimento de pagamento (0 a 100) | string |
| RESPOSTA.PESQUISAQUODPFSCORE.QUODREPORTRESPONSEEX.RESPONSE.RECORDS.RECORD.REGISTRO_N.QUODSCORE.PROFILESCORE | Score de perfil (0 a 100) | string |
| RESPOSTA.DADOSPUBLICOS.NIVEL_DE_EXPOSICAO_NA_MIDIA | Nível de exposição na mídia (H=Alto, M=Médio, L=Baixo) | string |
| RESPOSTA.DADOSPUBLICOS.NIVEL_DE_CELEBRIDADE | Nível de celebridade (H=Alto, M=Médio, L=Baixo) | string |
| RESPOSTA.DADOSPUBLICOS.NIVEL_DE_IMPOPULARIDADE | Nível de impopularidade (H=Alto, M=Médio, L=Baixo) | string |
| RESPOSTA.DADOSPUBLICOS.ESTATISTICAS_DE_NOTICIAS.TOTAL_NOTICIAS | Total de notícias encontradas | string |
| RESPOSTA.DADOSPUBLICOS.ESTATISTICAS_DE_NOTICIAS.NOTICIAS_ULTIMOS_7_DIAS | Notícias nos últimos 7 dias | string |
| RESPOSTA.DADOSPUBLICOS.ESTATISTICAS_DE_NOTICIAS.NOTICIAS_ULTIMOS_30_DIAS | Notícias nos últimos 30 dias | string |
| RESPOSTA.DADOSPUBLICOS.ESTATISTICAS_DE_NOTICIAS.NOTICIAS_ULTIMOS_90_DIAS | Notícias nos últimos 90 dias | string |
| RESPOSTA.DADOSPUBLICOS.ESTATISTICAS_DE_NOTICIAS.NOTICIAS_ULTIMOS_180_DIAS | Notícias nos últimos 180 dias | string |
| RESPOSTA.DADOSPUBLICOS.ESTATISTICAS_DE_NOTICIAS.NOTICIAS_ULTIMOS_365_DIAS | Notícias nos últimos 365 dias | string |
| RESPOSTA.SCOREFORCAVINCULO.REGISTRO_N.NOMESCORE | Score de correspondência do nome (0 a 300) | string |
| RESPOSTA.SCOREFORCAVINCULO.REGISTRO_N.EMAILSCORE | Score de correspondência do e-mail (0 a 300) | string |
| RESPOSTA.SCOREFORCAVINCULO.REGISTRO_N.TELEFONESCORE | Score de correspondência do telefone (0 a 300) | string |
| RESPOSTA.SCOREFORCAVINCULO.REGISTRO_N.ENDERECOSCORE | Score de correspondência do endereço (0 a 300) | string |
| RESPOSTA.SCOREFORCAVINCULO.REGISTRO_N.TOTAL | Score total de força de vínculo (soma dos scores) | string |
| RESPOSTA.SANCOES.RESULT.REGISTER.MATCHKEYS | Chave de busca utilizada | string |
| RESPOSTA.SANCOES.RESULT.REGISTER.KYCDATA.ISCURRENTLYPEP | Indica se é PEP atualmente (true/false) | string |
| RESPOSTA.SANCOES.RESULT.REGISTER.KYCDATA.SANCTIONSHISTORY.REGISTER.SOURCE | Fonte da sanção (interpol, fbi, ddtc, etc.) | string |
| RESPOSTA.SANCOES.RESULT.REGISTER.KYCDATA.SANCTIONSHISTORY.REGISTER.TYPE | Tipo de sanção | string |
| RESPOSTA.SANCOES.RESULT.REGISTER.KYCDATA.SANCTIONSHISTORY.REGISTER.STANDARDIZEDSANCTIONTYPE | Tipo padronizado (ARREST WARRANTS, FINANCIAL CRIMES, etc.) | string |
| RESPOSTA.SANCOES.RESULT.REGISTER.KYCDATA.SANCTIONSHISTORY.REGISTER.MATCHRATE | Taxa de correspondência com o nome consultado (0 a 100) | string |
| RESPOSTA.SANCOES.RESULT.REGISTER.KYCDATA.SANCTIONSHISTORY.REGISTER.DETAILS.SANCTIONNAME | Nome encontrado na lista de sanção | string |
| RESPOSTA.SANCOES.RESULT.REGISTER.KYCDATA.SANCTIONSHISTORY.REGISTER.DETAILS.BIRTHDATE | Data de nascimento do sancionado | string |
| RESPOSTA.SANCOES.RESULT.REGISTER.KYCDATA.SANCTIONSHISTORY.REGISTER.DETAILS.NATIONALITIES | Nacionalidade do sancionado | string |
| RESPOSTA.SANCOES.RESULT.REGISTER.KYCDATA.SANCTIONSHISTORY.REGISTER.DETAILS.CHARGES | Acusações ou crimes imputados | string |
| RESPOSTA.SANCOES.RESULT.REGISTER.KYCDATA.SANCTIONSHISTORY.REGISTER.ISCURRENTLYPRESENTONSOURCE | Indica se ainda está na lista (true/false) | string |
| RESPOSTA.SANCOES.RESULT.REGISTER.KYCDATA.SANCTIONSHISTORY.REGISTER.WASRECENTLYPRESENTONSOURCE | Indica se esteve recentemente na lista (true/false) | string |
| RESPOSTA.SANCOES.RESULT.REGISTER.KYCDATA.ISCURRENTLYSANCTIONED | Indica se está sancionado atualmente (true/false) | string |
| RESPOSTA.SANCOES.RESULT.REGISTER.KYCDATA.WASPREVIOUSLYSANCTIONED | Indica se foi sancionado anteriormente (true/false) | string |
| RESPOSTA.SANCOES.RESULT.REGISTER.KYCDATA.LAST30DAYSSANCTIONS | Ocorrências de sanção nos últimos 30 dias | string |
| RESPOSTA.SANCOES.RESULT.REGISTER.KYCDATA.LAST90DAYSSANCTIONS | Ocorrências de sanção nos últimos 90 dias | string |
| RESPOSTA.SANCOES.RESULT.REGISTER.KYCDATA.ISCURRENTLYELECTORALDONOR | Indica se é doador eleitoral atual (true/false) | string |
| RESPOSTA.SANCOES.QUERYID | ID único da consulta de sanções | string |
| RESPOSTA.SANCOES.QUERYDATE | Data e hora da consulta de sanções (ISO 8601) | string |
| RESPOSTA.SANCOES.STATUS.KYC.REGISTER.CODE | Código de retorno (0 = OK) | string |
| RESPOSTA.SANCOES.STATUS.KYC.REGISTER.MESSAGE | Mensagem de retorno | string |
| RESPOSTA.KYCRH.PFPESQUISA | ID interno do dataset de pesquisa PF | string |
| RESPOSTA.KYCRH.RELATORIOJURIDICO | ID interno do dataset de relatório jurídico | string |
| RESPOSTA.KYCRH.PESQUISAQUODPFSCORE | ID interno do dataset de score QUOD | string |
| RESPOSTA.KYCRH.PESQUISAEXPOSICAOPUBLICA | ID interno do dataset de exposição pública | string |
| RESPOSTA.KYCRH.PESQUISASCOREFORCAVINCULO | ID interno do dataset de score de força de vínculo | string |
| RESPOSTA.KYCRH.SANCOES | ID interno do dataset de sanções | string |
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 .