PalmID SDK API Definitions
initialize
Initializes the PalmID Standard SDK with required service configuration.
Contact PalmID through https://palmid.com/#Contact-Us to obtain your PalmServer entrypoint and project ID.
Call
initialize(config)
Parameters
Parameter | Required | Description |
|---|---|---|
| Yes | PalmServer API entrypoint used for enroll, verify, identify, and delete. |
| Yes | Project identifier used by the backend service. |
| No | AppServer API entrypoint used to create and validate sessions. |
| No | Number of captures required for enrollment. The minimum is |
API_KEY is not an SDK initialization parameter. Keep it on your App Server.
enroll
Enrolls a new user by capturing and registering palm models.
Call
enroll(appServerMessage?)
appServerMessage is optional.
verify
Verifies a captured palm against an existing user.
Call
verify(userId, appServerMessage?)
verify requires a userId returned by a previous successful enroll or identify. appServerMessage is optional.
identify
Identifies a captured palm and returns the matched userId.
Call
identify(appServerMessage?)
appServerMessage is optional.
deleteUser
Removes a registered user from PalmServer.
Call
deleteUser(userId)
PalmIdStandardResult
SDK calls return PalmIdStandardResult.
Main fields:
sessionId is present only when appServerEntrypoint is configured. score is present for verify and identify. meta.sidedness is optional and is returned only when the result includes successful capture models.