For the complete documentation index, see llms.txt. This page is also available as Markdown.

Face liveness (deprecated)

Face liveness

post

It checks whether the uploaded photo is authentic, detecting if it is not a photo or video.

Query parameters
shouldSignResponsebooleanOptional

Specifies whether the request should be signed. The default is false. e.g. shouldSignResponse=true.

Default: false
Header parameters
AuthorizationstringRequired

Your access token. See more in the 'Authentication' topic of this section.

Body
imageUrlstringOptional

URL of the image to be tested.

Responses
200

Success

application/json
requestIdstringRequired

Unique identifier of request.

Example: 2b8f373-c462-4bbf-9a4f-8aeb7d71ec53
isAlivebooleanRequired

Indicates whether or not the person in the photo has passed the liveness.

Example: true
attemptIdstringRequired

Identifier of the attempt.

Example: 6021a21b3811c35ecb8dea20
messagestringOptional

Reproval reason. Possible messages are 'Sua foto deve conter apenas um rosto', 'Seu rosto está muito próximo da câmera', 'Não encontramos nenhum rosto na imagem', 'Seu rosto está muito pequeno' or 'Seu rosto não está alinhado à câmera'.

post/faces/liveness

Last updated