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
GEThttps://my-api.advance.ai/intl/openapi/liveness/ext/v1/get-video
GEThttps://th-api.advance.ai/intl/openapi/liveness/ext/v1/get-video
GEThttps://ph-api.advance.ai/intl/openapi/liveness/ext/v1/get-video
GEThttps://mex-api.advance.ai/intl/openapi/liveness/ext/v1/get-video
GEThttps://col-api.advance.ai/intl/openapi/liveness/ext/v1/get-video
GEThttps://nga-api.advance.ai/intl/openapi/liveness/ext/v1/get-video
GETGlobal Liveness Detection
https://sg-api.advance.ai/intl/openapi/liveness/ext/v1/get-video
GEThttps://api.advance.ai/intl/openapi/liveness/ext/v1/get-video
GEThttps://th-api.advance.ai/intl/openapi/liveness/ext/v1/get-video
GETRequest Header Parameters
| Parameter | Description |
|---|---|
| X-ACCESS-TOKEN | string Please use Token Authentication API to get your access token |
Request Parameters
| Parameter | Description |
|---|---|
| livenessId | string optional The livenessId of the liveness detection. |
| signatureId | string optional The signatureId of the liveness detection. |
Response Description
| Parameter | Description |
|---|---|
| code | H5 Document Verification Status Code |
| transactionId | The request id, the max length is 64 |
| pricingStrategy | Deprecated, Always return FREE |
| message | Status Code Explanation |
| data | videoUrl 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. |
| extra | Extra response info (Exception Message) |
Response Code
| Status Code | Message |
|---|---|
| SUCCESS | OK |
| PARAMETER_ERROR | Parameter error, please check you input. |
| ERROR | Server 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"
}Updated 1 day ago
