Skip to main content
POST
/
api
/
v1
/
steps
/
liveness
Inicia o processo de liveness
curl --request POST \
  --url https://flex-hml.flexdoc-apis.com.br/services/api/v1/steps/liveness \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cpf": 12345678900,
  "appRedirect": "https://example.com/redirect ou /path",
  "useIntroPage": "true",
  "useSuccessPage": "true",
  "webhookUrl": "https://seusistema.com/webhook",
  "webhookBasicAuth": "usuario:senha"
}
'
{
  "requestProcessUrl": "<string>",
  "requestId": "05be75cc-8f8a-414a-891f-434aa9b4e7a5",
  "createdAt": "2023-01-01T12:00:00"
}

Authorizations

​
Authorization
string
header
required

Autentica o acesso a partir de usuário e senha e retorna o Bearer token JWT. Copie o access_token retornado e utilize-o no header Authorization para acessar os endpoints da API.

Body

application/json

Payload para o processo de verificação de liveness.

​
cpf
string
required

CPF

Example:

12345678900

​
appRedirect
string
required

URL completa ou path para uma rota da aplicação.

Example:

"https://example.com/redirect ou /path"

​
useIntroPage
boolean
default:true
required

Indica se a página de introdução será exibida.

​
useSuccessPage
boolean
default:true
required

Indica se a página de sucesso será exibida.

​
webhookUrl
string

URL de callback (WebHook).

Example:

"https://seusistema.com/webhook"

​
webhookBasicAuth
string

Basic Authorization (WebHook).

Example:

"usuario:senha"

Response

Recurso solicitado com sucesso

Resposta do processo.

​
requestProcessUrl
string

URL do processo solicitado.

​
requestId
string

Identificador único da solicitação (UUID).

Example:

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

​
createdAt
string<date-time>

Data e hora de criação do processo.

Example:

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