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>'
{
  "cpf": "<string>",
  "nome": "<string>",
  "tipo": "<string>",
  "datasets": [
    {
      "typeAlias": "<string>",
      "listKeys": [
        {}
      ],
      "descricao": "<string>",
      "origem": "<string>"
    }
  ]
}

​
Path Parameters

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

​
Response

​
cpf
string
required
CPF consultado
​
nome
string
required
Nome da pessoa
​
tipo
string
required
Tipo do dossiêValor: DOSSIÊ DE PESSOA FÍSICA
​
datasets
array
Array contendo os datasets processados

​
Exemplo de Resposta

{
  "cpf": "String",
  "nome": "String",
  "tipo": "DOSSIÊ DE PESSOA FÍSICA",
  "datasets": [
    {
      "typeAlias": "DADOS CADASTRAIS BÁSICOS",
      "listKeys": [
        {
          "chave": "String",
          "valor": "String",
          "ordem": Integer
        }
      ],
      "descricao": "String",
      "origem": "String"
    },
    {
      "typeAlias": "KYC E COMPLIANCE - PPE",
      "listKeys": [
        {
          "chave": "String",
          "valor": "String",
          "ordem": Integer
        }
      ],
      "descricao": "String",
      "origem": "String"
    }
  ]
}
Os nomes dos datasets (typeAlias) retornados correspondem aos datasets solicitados. Para o mapeamento completo entre dataset codes e typeAlias, consulte a página de Datasets.