configure to restore wallet state, issue ID tokens, and manage credential access. The underlying native SDKs persist completed wallet-session metadata and signing state with platform storage.
Get Wallet Address
Read the active wallet address after configuration and session restore.Promise<string | null>.
Get Session
Read completed wallet-session metadata.Promise<OmsClientSessionState>.
| Field | Type | Description |
|---|---|---|
walletAddress | string or null | Active wallet address, when a session is restored. |
expiresAt | string or null | Session expiration timestamp. |
loginType | 'Email', 'GoogleAuth', 'Oidc', or null | Login method for the session. |
sessionEmail | string or null | Email address associated with the session when available. |
On Session Expired
Subscribe to native wallet session expiration events. The listener receives the expired session snapshot so your app can route the user back to sign-in or prefill re-authentication UI.| Parameter | Type | Description |
|---|---|---|
listener | (event: OmsClientSessionExpiredEvent) => void | Callback invoked when the native wallet session expires. |
EventSubscription.
| Field | Type | Description |
|---|---|---|
session | OmsClientSessionState | Expired session snapshot. |
expiredAt | string | Expiration event timestamp. |
Get ID Token
Request an ID token for the active wallet session. Send this token to your backend when using backend wallet verification.| Parameter | Type | Description |
|---|---|---|
ttlSeconds | number, null, or undefined | Optional token lifetime in seconds. |
customClaims | Record<string, unknown>, null, or undefined | Optional custom claims to include in the token. |
Promise<string>.
List Access
List credentials that currently have access to the active wallet.| Parameter | Type | Description |
|---|---|---|
pageSize | number, null, or undefined | Optional page size used while following Wallet API cursors. |
Promise<OmsCredentialInfo[]>.
List Access Pages
UselistAccessPages when your UI should render credential access one page at a time.
| Parameter | Type | Description |
|---|---|---|
pageSize | number, null, or undefined | Optional page size for each Wallet API request. |
AsyncGenerator<OmsListAccessResponse, void, void>.
List Access Page
Fetch one credential access page with an optional cursor.| Parameter | Type | Description |
|---|---|---|
pageSize | number, null, or undefined | Optional page size for this Wallet API request. |
cursor | string, null, or undefined | Cursor returned by a previous page. |
Promise<OmsListAccessResponse>.
| Field | Type | Description |
|---|---|---|
credentials | OmsCredentialInfo[] | Credentials returned for the page. |
page | OmsAccessPage or null | Pagination metadata, including limit and next cursor. |
Revoke Access
Revoke another credential’s access to the active wallet.| Parameter | Type | Description |
|---|---|---|
targetCredentialId | string | Credential ID returned by listAccess. |
Promise<void>.
Sign Out
Clear the active wallet session.Promise<void>.