Get Passphrase State

Get the passphraseState of the device

Prompts the user to enter their passphrase (on-device or via software), then returns a passphraseState string — the public hidden-wallet fingerprint. Persist deviceId + passphraseState. Do not persist firmware session_id.

See Wallet Sessions.

Pass passphraseState on later address / signing calls so they stay on that hidden wallet. It is a wallet fingerprint, not firmware session_id. Do not persist session_id.

  getPassphraseState(connectId)   ← user enters passphrase once
    → passphraseState = "<fingerprint>"

  evmGetAddress(..., { passphraseState })
  btcGetAddress(..., { passphraseState })

Error 112 (passphrase state mismatch): the binding does not match the wallet currently unlocked (device locked, seed changed, or stale fingerprint). Stop the operation and let the user select the intended wallet again with openWalletSession. Confirm the recovered binding before a new request; do not bypass the check or automatically replay signing.

const response = await HardwareSDK.getPassphraseState(connectId);

Params

Optional common params

Example

const response = await HardwareSDK.getPassphraseState(connectId);

Result

{
    success: true,
    payload: string | null | undefined
}

Error

{
    success: false,
    payload: {
        error: string, // error message
        code?: string | number // error code
    }
}

A hidden-wallet fingerprint is a non-empty string. Compatibility flows can return undefined on V1 when protection is disabled, or null for a standard V2 wallet; do not persist these as a hidden-wallet binding.