Face Comparison Delete API
Delete a face comparison transaction by transactionId.
Use this API to delete a face comparison transaction by transactionId.
- Get an access token: Token Authentication API
- Save the
transactionIdreturned by the face comparison service call
Request Example:
curl -X POST "https://api.advance.ai/intl/openapi/face-identity/v1/face-comparison/delete" \
-H "X-ACCESS-TOKEN: {Your Access Token}" \
-H "Content-Type: application/json" \
--data '{
"transactionId": "{Your Transaction Id}"
}'Request Url
https://api.advance.ai/intl/openapi/face-identity/v1/face-comparison/delete
POST (application/json)https://sg-api.advance.ai/intl/openapi/face-identity/v1/face-comparison/delete
POST (application/json)https://th-api.advance.ai/intl/openapi/face-identity/v1/face-comparison/delete
POST (application/json)https://ph-api.advance.ai/intl/openapi/face-identity/v1/face-comparison/delete
POST (application/json)https://mex-api.advance.ai/intl/openapi/face-identity/v1/face-comparison/delete
POST (application/json)https://nga-api.advance.ai/intl/openapi/face-identity/v1/face-comparison/delete
POST (application/json)https://my-api.advance.ai/intl/openapi/face-identity/v1/face-comparison/delete
POST (application/json)Request Header Parameters
| Parameter | Description |
|---|---|
| X-ACCESS-TOKEN | string Please use Token Authentication API to get your access token. |
Request Parameters
| Parameter | Description |
|---|---|
| transactionId | string The transaction ID for the face comparison service call. |
Response Description
| Parameter | Description |
|---|---|
| code | enum Response's Status Code |
| transactionId | string The request id, the max length is 64 |
| pricingStrategy | enum Whether the request will be charged, enum type: FREE, PAY |
| message | string Status Code Explanation |
| data | object Always return null for this API |
| extra | object Extra response info (Exception Message) |
Response Code
| Status Code | Message |
|---|---|
| SUCCESS | free OK |
| PARAMETER_ERROR | free Parameter should not be empty |
free The transactionId does not exist | |
| REQUEST_IN_PROCESSING | free Your request is currently being processed. Please do not submit it repeatedly |
| ERROR | free Server error |
Response Examples
SUCCESS
{
"code": "SUCCESS",
"message": "OK",
"data": null,
"extra": null,
"transactionId": "a9dc751497286ff3",
"pricingStrategy": "FREE"
}PARAMETER_ERROR
{
"code": "PARAMETER_ERROR",
"message": "Parameter should not be empty",
"data": null,
"extra": null,
"transactionId": "a9dc751497286ff3",
"pricingStrategy": "FREE"
}{
"code": "PARAMETER_ERROR",
"message": "The transactionId does not exist",
"data": null,
"extra": null,
"transactionId": "a9dc751497286ff3",
"pricingStrategy": "FREE"
}REQUEST_IN_PROCESSING
{
"code": "REQUEST_IN_PROCESSING",
"message": "Your request is currently being processed. Please do not submit it repeatedly",
"data": null,
"extra": null,
"transactionId": "a9dc751497286ff3",
"pricingStrategy": "FREE"
}ERROR
{
"code": "ERROR",
"message": "Server error",
"data": null,
"extra": null,
"transactionId": "a9dc751497286ff3",
"pricingStrategy": "FREE"
}Updated about 4 hours ago
