Skip to main content

Search RGB Palmprint

Upload an RGB palm image and search it 1:N across all palmprints registered under your application, returning the most similar user. Suitable for account-less palm login, palm attendance, and similar scenarios.

ItemValue
MethodPOST
URLhttps://open.intl.palm.tencent.com/palm/openai/search_rgb_palm
Content-Typeapplication/json; charset=utf-8
AuthorizationBearer <api_key>
Default rate limit20 requests/sec

Unlike CompareRgbPalm (1:1), this interface does not require a UserId in the request. If the gallery is empty or no user is matched, a business error code (2080010) is returned with an empty data.UserId.

Request Parameters

ParameterRequiredTypeDescription
RgbImageYesImageRGB palm image; Data and ImageType are required

Response Parameters (data)

ParameterTypeDescription
UserIdStringUser ID of the matched palmprint (the UserId passed at registration)
ScoreIntegerSimilarity score, 0–100
AlgorithmVersionStringAlgorithm version used for this search
PalmDirectionIntegerPalm side of the matched palmprint, see PalmDirectionType
SessionIdStringTemporary query credential for this search (UUID, valid 2 hours)

Example

Request

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

{
"RgbImage": {
"Data": "base64encodedRgbImageData...",
"ImageType": 1
}
}

Response

{
"code": 0,
"message": "ok",
"requestId": "4d5912a82af144f8a982c2da031c1035",
"data": {
"UserId": "user001",
"Score": 93,
"AlgorithmVersion": "v2.0",
"PalmDirection": 1,
"SessionId": "3f2b1a6d-8c4e-4b7a-9d5f-1e2c3a4b5c6d"
}
}

cURL

curl -X POST "https://open.intl.palm.tencent.com/palm/openai/search_rgb_palm" \
-H "Content-Type: application/json; charset=utf-8" \
-H "Authorization: Bearer ak_xxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-d '{
"RgbImage": {
"Data": "'"$(base64 -w0 palm.jpg)"'",
"ImageType": 1
}
}'

Notes

  • Search accuracy and latency depend on gallery size.
  • A no-match result returns 2080010 (user not found in search) — a normal business outcome, not a system error.