Liveness Streaming [application/json]

POST

https://mostqiapi.com/liveness/streaming/async

Last modified:2025-05-15 14:23:07

This route requests the generation of a link to start the Liveness Streaming evaluation, creating an asynchronous process.
You can configure the following elements to provide a fully personalized experience for your users:

Primary color.

Theme.

Welcome title at the beginning.

Success message at the end of the process.

Failure message at the end of the process.

Languages: pt-BR, en, es, and fr.

URL for redirection after completing the proof of life.

In addition, you can define a callback endpoint to receive notifications when the process is completed.

Request

Header Params

Authorization

string

optional

Authorization token obtained from the user/authenticate method.

Example:

Bearer {{bearer_token}}

Body Params application/json

webhook

object

optional

url

string

optional

It is the URL that will be called when the asynchronous process is finished.

fallbackUrl

string

optional

Parameter that allows specifying another URL in case of a communication failure when calling the URL specified in the webhookUrl or webhook.fallbackUrl parameter.

authorization

object

optional

uiCustomization

object

optional

Object that defines the language, theme, and custom messages settings for the interface displayed to the user during the liveness process.

defaultLanguage

string

optional

Defines the default language of the interface. Accepted values:

pt-BR

If not specified, the default language will be en (English).

Example:

pt-BR

theme

string

optional

Defines the interface theme. Accepted values:

light

dark

If not specified, the default theme will be light.

Example:

dark

primaryColor

string

optional

Defines the primary color of the interface in hexadecimal format.

Example:

#1B406A

hideTopbar

boolean

optional

Define true ou false para exibir ou ocultar a barra superior (que apresenta as opções de tema e idiomas) na interface inicial do Liveness Streaming.

welcomeMessage

object

optional

Message displayed as the title on the home screen of the liveness verification process. It is possible to define a custom message for each language.

successMessage

object

optional

Success message displayed at the end of the liveness verification process. You can define a message for each language if you wish to personalize the user experience.

failureMessage

object

optional

Message displayed at the end of the process when the liveness verification is not successful. You can customize this message for each language if desired.

redirectUrl

string

optional

Defines the URL to which the application should redirect the user after completing the proof of life.

Examples

ExampleExample 2

{
    "webhook": {
        "url": "",
        "fallbackUrl": "",
        "authorization": {
            "headers": [
                {
                    "name": "",
                    "value": ""
                },
                {
                    "name": "",
                    "value": ""
                }
            ],
            "queryStrings": [
                {
                    "name": "",
                    "value": ""
                },
                {
                    "name": "",
                    "value": ""
                },
                {
                    "name": "",
                    "value": ""
                }
            ]
        }
    },
    "uiCustomization": {
        "defaultLanguage": "",
        "theme": "",
        "primaryColor": "",
        "hideTopbar": true,
        "welcomeMessage": {
            "ptBR": "",
            "en": "",
            "es": "",
            "fr": ""
        },
        "successMessage": {
            "ptBR": "",
            "en": "",
            "es": "",
            "fr": ""
        },
        "failureMessage": {
            "ptBR": "",
            "en": "",
            "es": "",
            "fr": ""
        }
    },
    "redirectUrl": ""
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

ExampleExample 2

curl --location --request POST 'https://mostqiapi.com/liveness/streaming/async' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "webhook": {
        "url": "",
        "fallbackUrl": "",
        "authorization": {
            "headers": [
                {
                    "name": "",
                    "value": ""
                },
                {
                    "name": "",
                    "value": ""
                }
            ],
            "queryStrings": [
                {
                    "name": "",
                    "value": ""
                },
                {
                    "name": "",
                    "value": ""
                },
                {
                    "name": "",
                    "value": ""
                }
            ]
        }
    },
    "uiCustomization": {
        "defaultLanguage": "",
        "theme": "",
        "primaryColor": "",
        "hideTopbar": true,
        "welcomeMessage": {
            "ptBR": "",
            "en": "",
            "es": "",
            "fr": ""
        },
        "successMessage": {
            "ptBR": "",
            "en": "",
            "es": "",
            "fr": ""
        },
        "failureMessage": {
            "ptBR": "",
            "en": "",
            "es": "",
            "fr": ""
        }
    },
    "redirectUrl": ""
}'

Responses

🟢200Success

application/json

Body

result

object

required

List containing the result of the method.

processId

string

required

ID related to the asynchronous Liveness Streaming request process, called "processId". This ID will be used to check the status of the process and access the result of the liveness verification.

sessionUrl

string

required

Unique link to access the web page where the liveness verification will be performed. This link is valid for only one verification, ensuring the security and integrity of the process. After use, the link becomes invalid.

urlExpiresAt

string

required

Date and time of expiration of the generated link, represented in UTC. After this period, the link can no longer be used, even if the liveness verification has not been completed.

requestId

string

required

Unique identification code of the request to the server, which will be recorded in the service consumption history.

elapsedMilliseconds

integer

required

Processing duration time in milliseconds.

status

object

required

Object containing the status code and message of the response.

message

string

required

Internal status code. See the possible values in the mostQI error messages.

code

string

required

Status return message. See the possible values in the mostQI error messages.

errors

object | null

required

List of Error objects, the format is variable.

Example

{
    "result": {
        "processId": "eb2bf100-0376-46f9-8147-1b7ed36a39f0",
        "sessionUrl": "https://liveness.mostqi.com/?session=ImV5SmhiR2NpT2lKQk1USTRTMWNpTENKbGJtTWl...",
        "urlExpiresAt": "2025-03-11T19:36:41Z"
    },
    "requestId": "IRHJGf2pmp2HKbD44Uus5",
    "elapsedMilliseconds": 3488,
    "status": {
        "message": "Ok",
        "code": "200",
        "errors": null
    }
}

🟠401R117 Invalid authorization data

🔴500E100 The request could not be processed

Modified at 2025-05-15 14:23:07

Web Interface for proof of life

Liveness Streaming Status [application/json]