Skip to main content
POST
/
onboarding
/
api
/
v1
/
steps
/
liveness
Inicia processo de verificação de liveness
curl --request POST \
  --url https://api-hml.valid.com/onboarding/api/v1/steps/liveness \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "cpf": "12345678900",
  "useIntroPage": true,
  "useSuccessPage": true,
  "appRedirect": "/onboarding/liveness-success",
  "webhookUrl": "https://seusistema.com/webhook/liveness",
  "webhookBasicAuth": "usuario:senha"
}
'
{
  "requestProcessUrl": "https://service.onboarding.comz/steps/resource/liveness/{{requestId}}",
  "requestId": "05be75cc-8f8a-414a-891f-434aa9b4e7a5",
  "createdAt": "2023-01-01T12:00:00"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

Dados necessários para iniciar o processo de Liveness.

​
cpf
string
required

CPF do indivíduo.

Example:

"12345678900"

​
useIntroPage
boolean
required

Flag para determinar o uso da página de introdução.

Example:

true

​
useSuccessPage
boolean
required

Flag para determinar o uso da página de sucesso.

Example:

true

​
appRedirect
string

Caminho de redirecionamento do aplicativo após a conclusão.

Example:

"/onboarding/liveness-success"

​
webhookUrl
string<uri>

URL para notificação de webhook com o resultado final.

Example:

"https://seusistema.com/webhook/liveness"

​
webhookBasicAuth
string

Credenciais Basic Auth (usuario:senha) para autenticação do webhook.

Example:

"usuario:senha"

Response

OK

Resposta comum ao iniciar qualquer processo Step.

​
requestProcessUrl
string
required

URL para a próxima etapa ou visualização do recurso.

Example:

"https://service.onboarding.comz/steps/resource/liveness/{{requestId}}"

​
requestId
string
required

ID único da requisição iniciada.

Example:

"05be75cc-8f8a-414a-891f-434aa9b4e7a5"

​
createdAt
string
required

Data e hora de criação da requisição.

Example:

"2023-01-01T12:00:00"