DELETE
/
faces
Delete a face from collection
curl --request DELETE \
  --url https://idverify-api.argosidentity.com/modules/faces \
  --header 'x-api-key: <api-key>'
{
  "message": "Face deleted successfully"
}
This API endpoint allows you to delete a specific face from a collection. You need to provide both the collection ID and the face ID to successfully remove the face from the collection.

​
Request

​
Headers

​
x-api-key
string
required
The API key used for authentication and access control. This header parameter is required for authorization to delete a face from a collection.

​
Query Parameters

​
collectionId
string
required
The unique identifier of the collection that contains the face you wish to delete.
​
faceId
string
required
The unique identifier of the face submission that you want to remove.

​
Response

​
Success Response (200)

​
message
string
A message indicating the success or error result of the deletion operation.

​
Error Responses

​
Bad Request (400)

​
errorCode
string
Identifies the specific error for troubleshooting:
  • 6010: CollectionId is required
  • 6011: WorkspaceId is required
  • 6012: Fail to add face
  • 6013: Cannot find collection info
  • 6014: This collection is unavailable
  • 6015: Failed to validate liveness of a face
  • 6016: Image Size is too large
  • 6017: Unsupported image format
​
message
string
Briefly describes the error. Please refer to the error code for details.

​
Forbidden (403)

​
errorCode
string
Identifies the specific error for troubleshooting:
  • 6039: API Key is required
  • 6040: Access Denied: API Key is unavailable
​
message
string
Briefly describes the error. Please refer to the error code for details.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
collectionId
string
required

Unique identifier of the collection

​
faceId
string
required

Unique identifier of the face to delete

Response

200
application/json

Face successfully deleted from collection

The response is of type object.