For the complete documentation index, see llms.txt. This page is also available as Markdown.

Enroll User Blacklist

Registers the face of a new user in the shared blacklist. The userId must be unique within the collection. Only the client that registered the face will be able to retrieve the full userId in search results and delete this entry.

Endpoint

PUT /users/blacklist/{userId}

Authentication

Type
Location
Name

API Key

Header

x-api-key

Request body

Content-Type: application/json

Route parameters

Parameter
Type
Required
Description

userId

string

Yes

Unique user identifier. This ID must be unique within the blacklist collection.

Parameters

Parameter
Type
Required
Description

face

string

Yes

Image of the user's face encoded in Base64. Supported formats are JPEG and PNG. Maximum supported size: 5MB.

Request example

{
  "face": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
}

Responses

200 Success

User successfully registered in the blacklist. This response does not include a body.

400 Bad Request

Response example: duplicate userId

Response example: invalid face image

401 Unauthorized

403 Forbidden

404 Not Found

Last updated