On this page

latest contributor to this doc

Last Edit:

@gcharang

Get Mnemonic

API-v2get_mnemonic

The get_mnemonic method returns the user's mnemonic seed phrase, in encrypted or plain text format.

Parameter* = requiredTypeDescription
format
string
default: encrypted
Optional. Either encrypted or plaintext.
password
string
Optional. The password to decrypt your stored mnemonic phrase. Only required if plaintext format is requested.

Parameter* = requiredTypeDescription
format*
string
Same as the input format parameter.
encrypted_mnemonic_data
object
Optional. For encrypted requests, the encrypted format and ciphertext for the mnemonic seed phrase.
mnemonic
string
Optional. For plaintext requests, the decrypted mnemonic seed phrase.

Example (encrypted output)

POST
get_mnemonic
{
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "method": "get_mnemonic",
  "params": {
    "format": "encrypted"
  },
  "id": 0
}

{
    "mmrpc": "2.0",
    "result": {
        "format": "encrypted",
        "encrypted_mnemonic_data": {
            "encryption_algorithm": "AES256CBC",
            "key_derivation_details": {
                "Argon2": {
                    "params": {
                        "algorithm": "Argon2id",
                        "version": "0x13",
                        "m_cost": 65536,
                        "t_cost": 2,
                        "p_cost": 1
                    },
                    "salt_aes": "CqkfcntVxFJNXqOKPHaG8w",
                    "salt_hmac": "i63qgwjc+3oWMuHWC2XSJA"
                }
            },
            "iv": "mNjmbZLJqgLzulKFBDBuPA==",
            "ciphertext": "tP2vF0hRhllW00pGvYiKysBI0vl3acLj+aoocBViTTByXCpjpkLuaMWqe0Vs02cb1wvgPsVqZkE4MPg4sCQxbd18iS7Er6+BbVY3HQ2LSig=",
            "tag": "TwWXhIFQl1TSdR4cJpbkK2oNXd9zIEhJmO6pML1uc2E="
        }
    },
    "id": null
}

Example (plain text output)

POST
get_mnemonic
{
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "method": "get_mnemonic",
  "params": {
    "format": "plaintext",
    "password": "Q^wJZg~Ck3.tPW~asnM-WrL"
  },
  "id": 0
}

{
    "mmrpc": "2.0",
    "result": {
        "format": "plaintext",
        "mnemonic": "unique spy ugly child cup sad capital invest essay lunch doctor know"
    },
    "id": null
}

You can update the password with the change_mnemonic_password method.