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
Parameter | Description |
---|---|
X-ACCESS-TOKEN | string Please use Token Authentication API to get your access token |
Request Parameters
Parameter | Description |
---|---|
livenessId | string The livenessId which you want to clean up |
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 | null |
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":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"
}
Updated 12 days ago