Skip to main content
GET
/
onboarding
/
api
/
v1
/
know
/
customer
/
{requestId}
Consultar Resultados KYC
curl --request GET \
  --url https://api-hml.valid.com/onboarding/api/v1/know/customer/{requestId} \
  --header 'x-api-key: <api-key>'
{
  "result": {},
  "result.requestId": "<string>",
  "result.key": "<string>",
  "result.datasets": [
    {}
  ],
  "result.datasets[].dataset": "<string>",
  "result.datasets[].data": {}
}

​
Path Parameters

​
requestId
string
required
Identificador único da requisição obtido ao iniciar a consultaFormato: UUIDExemplo: 05be75cc-8f8a-414a-891f-434aa9b4e7a5

​
Response

A resposta retorna um objeto result com os dados estruturados da consulta KYC (Pessoa Física).
​
result
object
Dados estruturados do resultado da consulta KYC (Pessoa Física).
​
result.requestId
string
ID da requisição no onboardingExemplo: 05be75cc-8f8a-414a-891f-434aa9b4e7a5
​
result.key
string
CPF consultadoExemplo: 12345678900
​
result.datasets
array
Lista de datasets de Pessoa Física. Cada item possui dataset (identificador da consulta) e data (objeto com os dados).
​
result.datasets[].dataset
string
Identificador do tipo de dataset (ex: basic, kyc, addresses)Exemplo: basic
​
result.datasets[].data
object
Dados do dataset; a estrutura varia conforme o valor de dataset. Os tipos possíveis (KYC PF) estão listados na seção abaixo.

​
Estrutura de data por tipo de dataset (KYC PF)

O campo result.datasets[].data pode ser um dos objetos abaixo, conforme o dataset retornado.
Dados básicos da pessoa física.
  • 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
Lista de endereços. O array contém objetos com:
  • 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
Lista de telefones. O array contém objetos com:
  • number (string): Número de telefone
  • areaCode (string): Código de área
  • countryCode (string): Código de país
Lista de e-mails. O array contém objetos com:
  • email (string): E-mail
  • isActive (boolean): E-mail ativo
  • isMain (boolean): E-mail principal
Ocupações e cargos. O array contém objetos com:
  • jobTitle (string): Cargo
  • worksFor (string): Empresa
  • occupationalCategory (string): Categoria
  • startDate (string): Data início
  • endDate (string): Data término
  • income (number): Renda
Profissões. O array contém objetos com:
  • jobTitle (string): Cargo
  • worksFor (string): Empresa
  • startDate (string): Data início
  • endDate (string): Data término
Relacionamentos de negócio. O array contém objetos com:
  • 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
Dados financeiros e fiscais.
  • 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.
  • 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ões PGFN. O array contém objetos com:
  • origin (string): Origem
  • protocolNumber (string): Protocolo
  • fileUrl (string): URL do resultado
  • status (string): Status
Assistência social. O array contém objetos com:
  • programName (string): Nome do programa
  • programState (string): Estado
  • assistanceAmount (number): Valor mensal
  • assistanceTotalAmount (number): Total recebido
Assistência social familiar.
  • 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
Mídia e exposição.
  • 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 candidatura a eleições.
  • 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
Doadores eleitorais.
  • 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, PEP e sanções.
  • 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.
  • 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
Indicação de inadimplência.
  • likelyInDebt (boolean): Provavelmente inadimplente
  • evidences (array): Cada item: id, source (fonte)
Cobrança.
  • isCurrentlyOnCollection (boolean): Em cobrança atualmente
  • totalCollectionOccurrences (number): Total de ocorrências
  • totalCollectionOrigins (number): Total de origens
Certidões de situação na Receita Federal (PF). O array contém objetos com:
  • origin (string): Origem
  • fileUrl (string): URL
  • status (string): Status
Certidões de Nada Consta – Ações Judiciais (PF). O array contém objetos com:
  • origin (string): Origem
  • protocolNumber (string): Protocolo
  • fileUrl (string): URL
  • status (string): Status
Certidões de Ações Trabalhistas (PF). O array contém objetos com:
  • protocolNumber (string): Protocolo
  • fileUrl (string): URL
  • status (string): Status
Certidões de Antecedentes Criminais – Polícia Federal (PF). O array contém objetos com:
  • origin (string): Origem
  • protocolNumber (string): Protocolo
  • fileUrl (string): URL
  • status (string): Status
Certidão de ausência de débito por estado (PF). O array contém objetos com:
  • origin (string): Origem
  • protocolNumber (string): Protocolo
  • fileUrl (string): URL
  • status (string): Status
Certidão de ausência de débito trabalhista (PF). O array contém objetos com:
  • origin (string): Origem
  • protocolNumber (string): Protocolo
  • fileUrl (string): URL
  • status (string): Status
Certidão de regularidade IBAMA (PF). O array contém objetos com:
  • origin (string): Origem
  • protocolNumber (string): Protocolo
  • fileUrl (string): URL
  • status (string): Status

​
Exemplo de resposta

{
  "result": {
    "requestId": "05be75cc-8f8a-414a-891f-434aa9b4e7a5",
    "key": "12345678900",
    "datasets": [
      {
        "dataset": "basic",
        "data": {
          "cpf": "12345678900",
          "name": "João da Silva",
          "birthDate": "1980-05-15",
          "birthPlace": "Brazil",
          "gender": "M",
          "nationality": "Brasileira",
          "motherName": "Maria da Silva",
          "fatherName": "José da Silva",
          "taxIdStatus": "REGULAR",
          "hasObitIndication": false,
          "maritalStatus": "CASADO",
          "age": 44
        }
      },
      {
        "dataset": "kyc",
        "data": {
          "isCurrentlyPEP": false,
          "isCurrentlySanctioned": false,
          "pepHistory": [],
          "sanctionsHistory": []
        }
      }
    ]
  }
}