PalmID SDK API Definitions

initialize

Initializes the PalmID SDK engine with required credentials and configuration.

Call

initialize()

Parameter:

Parameter	Value / Type	Description
`palmServerEntrypoint`	`String` URL or `null`	PalmID Server endpoint; pass `null` to use the default.
`appServerEntrypoint`	`String` URL or `null`	App Server endpoint; pass `null` to use the default.
`projectId`	`String` (e.g., `PROJECT_ID`)	Required. Project identifier for service segregation; must not be null.
`requiredEnrollmentScans`	`Integer` or `null`	Optional number of scans for enrollment; `null` uses the SDK default.

enroll

Enrolls a new user by capturing and registering their palm print.

Call

enroll()

Parameters

Parameter	Value / Type	Description
`loadController`	`Object` or `null`	Optional custom loading UI controller; pass `null` to use the default UI.
`result`	`PalmIDNativeSDKResult`	Callback invoked with enrollment outcome (success/failure status).

verify

Verifies a user's palm model against the registered palm models.

Call

verify()

Parameters

Parameter	Value / Type	Description
`palmId`	`String`	Pre-registered unique identifier `user_id` to verify against.
`result`	`PalmIDNativeSDKResult`	Callback invoked with verification outcome (success/failure and metadata).

deleteUser

Permanently removes the user's palm models from the PalmID Server.

Call

deleteUser()

Parameters

Parameter	Value / Type	Description
`palmId`	`String`	Unique identifier `user_id` of the user to remove.
`result`	`PalmIDNativeSDKResult`	Callback invoked with deletion outcome (success/fail).

release

Release the PalmID SDK engine resources

Call

release()

PalmIDNativeSDKResult

Result of API calls. Depending on the type of API call, certain fields can be empty.

public

class PalmIDNativeResult {
    private int
    errorCode;
    @Nullable
    private PalmIDNativeResultData
    data;
}

public

class PalmIDNativeResultData {
    @NonNull
    private String
    palmId;
    private double
    score;
    @Nullable
    private String
    sessionId; // Only has value when appServerEntrypoint is specified during initialization
}

13 August 2025