Sign in

v1

latestOpenAPI 3.0.22026-07-2432112226.7 KB
Face

Sanbox - Delete Enrolled Face

This method helps you to delete enrolled image<br>

The following table describes subject_id option to be used as input.

subject_idDescription
SUB_EXISTsubject_id exist in respected App-ID
SUB_NOT_EXISTsubject_id does not exist in respected App-ID
<br> You will receive a response consists of message and an error code if the request fails to process. The following is a list of error codes. <br>
Error codeDescription
INVALID_SANDBOX_SUBJECT_IDsubject_id not exist in image code sandbox
INVALID_PAYLOAD_SUBJECT_IDsubject id not valid / subject id is not found
INVALID_PAYLOAD_SUBJECT_ID_MISSINGSubject id payload is empty/null
MISSING_PAYLOAD_SUBJECT_IDSubject id payload is missing
INTERNAL_SERVER_ERRORinternal server error
delete/v1/face/enroll

Query parameters

subject_idstring required

Subject ID to be deleted (choose from available option)

Headers

App-IDstring required
API-Keystring required

Response

Successful Response

status_codestring

Status Code

messagestring required

Message

Example response

{
  "status_code": "FACE-1",
  "message": "Collection subject id xxx from collection successfuly deleted"
}