Delete Palmprint

Delete palmprints of a specific user. Supports deleting by palm side (left/right) individually or both at once. After deletion, the corresponding palmprint can no longer be matched by 1:1 comparison or 1:N search.

Item	Value
Method	`POST`
URL	`https://open.intl.palm.tencent.com/palm/openai/delete_palm`
Content-Type	`application/json; charset=utf-8`
Authorization	`Bearer <api_key>`
Default rate limit	20 requests/sec

Deletion is idempotent: deleting a palm direction that does not exist does not raise an error.

Request Parameters

Parameter	Required	Type	Description
`UserId`	Yes	String	Unique user identifier
`PalmDirectionList`	Yes	Array<Integer>	Palm sides to delete, see PalmDirectionType. Pass both `[1, 2]` for both hands, or a single side; an empty array `[]` deletes all directions of the user

Response Parameters (`data`)

No business fields — data is an empty object {}. Success means deletion completed.

Example

Request (delete both hands)

POST /palm/openai/delete_palm HTTP/1.1
Host: open.intl.palm.tencent.com
Content-Type: application/json; charset=utf-8
Authorization: Bearer ak_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

{
  "UserId": "user001",
  "PalmDirectionList": [1, 2]
}

Response

{
  "code": 0,
  "message": "ok",
  "requestId": "4d5912a82af144f8a982c2da031c1035",
  "data": {}
}

cURL

curl -X POST "https://open.intl.palm.tencent.com/palm/openai/delete_palm" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "Authorization: Bearer ak_xxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -d '{
    "UserId": "user001",
    "PalmDirectionList": [1, 2]
  }'

Notes

Deleted palmprints free up your application's palmprint capacity.
Verify the caller's identity on your side before deletion — Palm X only executes the delete operation and does not manage your business-side user state.

Request Parameters​

Response Parameters (data)​

Example​

Request (delete both hands)​

Response​

cURL​

Notes​