Skip to main content
POST
/
onboarding
/
api
/
v1
/
know
/
customer
Iniciar Consulta KYC
curl --request POST \
  --url https://api-hml.valid.com/onboarding/api/v1/know/customer \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "cpf": "<string>",
  "dossieFormat": "<string>",
  "datasets": [
    {}
  ],
  "webhookUrl": "<string>",
  "webhookBasicAuth": "<string>"
}
'
{
  "requestId": "<string>",
  "createdAt": "<string>"
}

​
Request Body

​
cpf
string
required
CPF da pessoa a ser consultadaExemplo: 00000000000
​
dossieFormat
string
required
Formato do dossiê a ser retornado - Apenas json por enquantoExemplo: json
​
datasets
array
required
Vetor de strings de objetos com chave “dataset” à serem consultaadosFormato: ARRAYExemplo: [{ "dataset": "foo" }, { "dataset": "bar" }]
​
webhookUrl
string
URL que receberá os resultados quando o processamento for concluídoFormato: URIExemplo: https://seusistema.com/webhook
​
webhookBasicAuth
string
Credenciais Basic Auth para o webhook no formato usuario:senhaExemplo: usuario:senha

​
Response

​
requestId
string
Identificador único da requisiçãoExemplo: 05be75cc-8f8a-414a-891f-434aa9b4e7a5
​
createdAt
string
Data e hora de criação da requisiçãoExemplo: 2023-01-01T12:00:00

​
Webhook Content

O conteúdo será enviado ao webhook configurado quando o processamento for concluído. A estrutura do payload é idêntica à resposta do endpoint GET /onboarding/api/v1/know/customer/.