Skip to main content

get_seed_phrase_info

Inspects a seed phrase without restoring anything from it, reporting whether the phrase is well formed, whether it is a tracking (watch-only) seed, whether it is password-protected and, when a password is supplied, whether that password is the right one.

This is the call a UI makes while the user is typing a seed phrase into a restore form, so that it can validate the input and decide whether to also ask for a seed password before attempting the actual restore. It is a pure function of its arguments: it does not touch the currently opened wallet and changes nothing on disk.

Request​

{
    "jsonrpc": "2.0",
    "id": 0,
    "method": "get_seed_phrase_info",
    "params": {
        "seed_phrase": "sunset dolphin ivory hollow bracket cobalt marina thunder pigeon walnut cascade oyster granite meadow velvet compass juniper harvest lantern tundra ember quartz driftwood saffron 1a2b3c",
        "seed_password": ""
    }
}

Request parameters​

  • seed_phrase - string; the seed phrase to inspect. Both regular (spend-capable) seed phrases and tracking seeds are accepted. This parameter is required — the method inspects the phrase you give it, not the phrase of the wallet the RPC server has open.
  • seed_password - string; the seed password to verify against the phrase. Only meaningful for password-protected phrases. Pass an empty string when you just want to find out whether a password is required; supply the candidate password to have it checked, and read the answer from hash_sum_matched.

Response​

{
    "id": 0,
    "jsonrpc": "2.0",
    "result": {
        "hash_sum_matched": false,
        "require_password": true,
        "syntax_correct": true,
        "tracking": false
    }
}

Response information​

  • syntax_correct - boolean; true if the phrase is well formed — every word belongs to the word list and the phrase's internal structure is valid. false means the phrase is unusable as typed, and the remaining fields should be ignored. Check this one first.
  • require_password - boolean; true if the phrase is password-protected, meaning a seed password must be supplied in order to restore a wallet from it. Always false for tracking seeds.
  • hash_sum_matched - boolean; true only when require_password is true, a non-empty seed_password was supplied, and that password's checksum matched the phrase — i.e. the password is correct. It stays false when no password was supplied, when the password is wrong, and for phrases that are not password-protected at all (where no password is needed in the first place).
  • tracking - boolean; true if the phrase is a tracking seed, which restores a watch-only wallet that can see incoming transfers but cannot spend. false for an ordinary spend-capable seed phrase.

A malformed phrase is not an error condition for this method: it returns successfully with syntax_correct set to false.