Data Structures
This page describes the data structures and enumerations used by the Palm X RGB palm recognition interfaces.
Common Business Structures
Image
RGB palm image structure.
| Field | Type | Required | Description |
|---|---|---|---|
Data | String | Yes | Base64-encoded binary content of the palm image (JPEG/PNG). Recommended size ≤ 1 MB per image |
ImageType | ImageType | Yes | Image type enum, see below. The interfaces in this document always use 1 (RGB) |
📸 Capture convention (important): palm images must be uploaded in the front-camera (selfie) view. If the client captures with a rear camera, the image must be horizontally mirrored before upload — otherwise the algorithm will misjudge the left/right palm direction and registration/comparison may fail.
Enum Types
ImageType
Image type.
Returned as Integer.
| Value | Description |
|---|---|
1 | RGB (color image) |
2 | IR (infrared image) — reserved |
PalmDirectionType
Palm direction.
Returned as Integer.
| Value | Description |
|---|---|
1 | LEFT_PALM (left hand) |
2 | RIGHT_PALM (right hand) |
Notes
- Field naming across all requests and responses uses PascalCase (e.g.
UserId,PalmId). - A palmprint is uniquely identified by the
PalmIdreturned from registration, and is always associated with exactly oneUserIdand onePalmDirection.