Delete Face Authen

Deregisters a user's face profile, removing the enrolled template from the system. Use it to honour erasure requests and to undo an enrolment made in error.

Deleting a profile does not revoke signing credentials: they belong to the device, not to the user. Revoke a device's keys with Revoke Signing Credential if needed.

Endpoint

POST /v1/delete_face_auth
Content-Type: application/json

{
  "user_id": "user_00000001"
}

Parameters:

Param	Type	Required	Default	Description
user_id	string	Yes	—	The registered customer user ID.

Returns: DeleteFaceAuthResponse

Sample Request

curl -X POST \
  '<BASE_URL>/v1/delete_face_auth' \
  -H 'Authorization: ATV <ACCESS_ID>:<SIGNATURE>' \
  -H 'X-TV-Timestamp: <TIMESTAMP>' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": "user_00000001"
  }'

Response

{
  "data": {
    "request_id": "d4493ff5-e41f-4d10-a291-6a9727050b4c",
    "status": "success"
  },
  "errors": [],
  "success": true,
  "code": 0,
  "message": "Success"
}

Field	Type	Description
data.request_id	string	ID of the request (UUID).
data.status	string	Status of the response — success or failure.

WARNING

Deletion is irreversible and immediately breaks authentication for that user — every subsequent Verify Face Authen call will fail until they re-register. Confirm the user_id before calling.

Errors

Code	Message
2001010	Access ID not found.
401100	You are not authorized to perform the action.
4001000	Input parameter violates a constraint.
4001001	The X-TV-Timestamp header is expired, need a newer one.
4041000	The image ID is not found in DB.
4041002	The profile of user not found.
4291000	The number of requests exceeded your throughput limit.
5001000	Some unexpected error occurs while processing the request.

Code	Description
access_denied_exception	You are not authorized to perform the action.
invalid_parameter_exception	Input parameter violates a constraint.
request_time_too_skewed	The X-TV-Timestamp header is expired, need a newer one.
image_not_found_exception	The image ID is not found in DB.
user_profile_not_found_exception	The profile of user not found.
rate_limit_exception	The number of requests exceeded your throughput limit.
internal_server_error	Some unexpected error occurs while processing the request.

Next Steps

• Register Faces — re-enrol a user after deletion
• FaceAuthen Overview — the full profile lifecycle