Documentation

PII Data Retention API

Call this API to delete a liveness detection's PII Data.

Request Example:

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

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

Request Url

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

The endpoint URI may vary by country.

Request Header Parameters

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

Request Parameters

ParameterDescription
livenessIdstring The livenessId which you want to clean up

Response Description

ParameterDescription
codeH5 Document Verification Status Code
transactionIdThe request id, the max length is 64
pricingStrategyDeprecated, Always return FREE
messageStatus Code Explanation
datanull
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":null,
    "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"
}