Get Video API

📘

Call this API to get a liveness detection's video evidence.

  • only for Native App SDK.
  • contract us to enable video recording first.

Request Example:

curl -X GET \
-H "X-ACCESS-TOKEN: {Your Access Token}" \

"https://api.advance.ai/liveness/ext/v1/get-video?livenessId=ddsd-9e6-dcc9-4ca1-bdfe-9f001c05f1b1"

Request Url

The endpoint URI may vary by country.

Regional Liveness Detection

https://api.advance.ai/liveness/ext/v1/get-video
GET
https://my-api.advance.ai/intl/openapi/liveness/ext/v1/get-video
GET
https://th-api.advance.ai/intl/openapi/liveness/ext/v1/get-video
GET
https://ph-api.advance.ai/intl/openapi/liveness/ext/v1/get-video
GET
https://mex-api.advance.ai/intl/openapi/liveness/ext/v1/get-video
GET
https://col-api.advance.ai/intl/openapi/liveness/ext/v1/get-video
GET
https://nga-api.advance.ai/intl/openapi/liveness/ext/v1/get-video
GET

Global Liveness Detection

https://sg-api.advance.ai/intl/openapi/liveness/ext/v1/get-video
GET
https://api.advance.ai/intl/openapi/liveness/ext/v1/get-video
GET
https://th-api.advance.ai/intl/openapi/liveness/ext/v1/get-video
GET

Request Header Parameters

ParameterDescription
X-ACCESS-TOKENstring Please use Token Authentication API to get your access token

Request Parameters

ParameterDescription
livenessIdstring optional The livenessId of the liveness detection.
signatureIdstring optional The signatureId of the liveness detection.

Response Description

ParameterDescription
codeH5 Document Verification Status Code
transactionIdThe request id, the max length is 64
pricingStrategyDeprecated, Always return FREE
messageStatus Code Explanation
datavideoUrl the url of the video. this value is a link that will be expired in 1 day; if the link is expired ,you need to re query this endpoint to get a new link.
extraExtra response info (Exception Message)

Response Code

Status CodeMessage
SUCCESSOK
PARAMETER_ERRORParameter error, please check you input.
ERRORServer error

Response Examples

SUCCESS

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "videoUrl": "https://xxx.xxx.xxx"
  },
  "extra": null,
  "transactionId": "ac66706068e737b5",
  "pricingStrategy": "FREE"
}

PARAMETER_ERROR

{
    "code":"PARAMETER_ERROR",
    "message":"Parameter error, please check your request whether has illegal parameters",
    "data":null,
    "extra":null,
    "transactionId":"a2190c8682344303",
    "pricingStrategy":"FREE"
}

ERROR

{
    "code":"ERROR",
    "message":"Server error",
    "data":null,
    "extra":null,
    "transactionId":"1deae5a13ef2bd5e",
    "pricingStrategy":"FREE"
}