Face Comparison Delete API

Delete a face comparison transaction by transactionId.

Use this API to delete a face comparison transaction by transactionId.

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

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

Request Parameters

ParameterDescription
transactionIdstring The transaction ID for the face comparison service call.

Response Description

ParameterDescription
codeenum Response's Status Code
transactionIdstring The request id, the max length is 64
pricingStrategyenum Whether the request will be charged, enum type: FREE, PAY
messagestring Status Code Explanation
dataobject Always return null for this API
extraobject Extra response info (Exception Message)

Response Code

Status CodeMessage
SUCCESSfree OK
PARAMETER_ERRORfree Parameter should not be empty
free The transactionId does not exist
REQUEST_IN_PROCESSINGfree Your request is currently being processed. Please do not submit it repeatedly
ERRORfree 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"
}