Unlock Profile

Clears the lock on a face profile after repeated failed authentications. A locked profile rejects every attempt with 2002206 User profile is locked until this endpoint is called.

Endpoint

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

{
  "user_id": "user_00000001"
}

Parameters:

Param	Type	Required	Default	Description
user_id	string	Yes	—	User ID of the customer.

Returns: UnlockProfileResponse

When a Profile Locks

Verify Face Authen enforces two limits. Exceeding the brute-force limit locks the profile:

Field	Type	Description
face_auth_rate_limit_exceeded	2001016	Too many attempts in the window. Transient — the user can retry later.
face_auth_brute_force_limit_exceeded	2001017	Too many failed attempts. The profile locks.
user_profile_locked	2002206	Returned by every subsequent call until unlocked.

A lock also blocks Create Transaction, so a locked user cannot even start a new authentication.

Sample Request

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

Response

{
  "data": {
    "status": "success",
    "request_id": "cfc7b8d5-f2e2-437b-80e5-d600dfad26e2"
  },
  "errors": [],
  "success": true,
  "code": 0,
  "message": "Success"
}

Field	Type	Description
data.status	string	success or failure.
data.request_id	string	Request ID; quote it to CAKE Support when checking logs.

WARNING

The lock is an anti-brute-force control, so unlocking removes a fraud defence. Require an independent identity check — a support callback or a separate authentication factor — before calling this, and record who authorized each unlock.

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.
4041001	User not found.
5001000	Some unexpected error occurs while processing the request.

Code	Description
access_id_not_found	Access ID not found.
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.
user_not_found_exception	User not found.
internal_server_error	Some unexpected error occurs while processing the request.

Next Steps

• Verify Face Authen — retry authentication once unlocked
• FaceAuthen Overview — the full profile lifecycle