Update Passphrase

PUT /wallets/{walletId}/passphrase

status: stable

Path parameters

  • walletId string(hex) Required

    Minimum length is 40, maximum length is 40.

application/json

Body object Required

One of:
providing old passphrase object providing mnemonic object
  • old_passphrase string Required

    The current master passphrase.

    Minimum length is 10, maximum length is 255.

  • new_passphrase string Required

    A master passphrase to lock and protect the wallet for sensitive operation (e.g. sending funds).

    Minimum length is 10, maximum length is 255.

Responses

  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • message string Required

      May occur when a request is not well-formed; that is, it fails to parse successfully. This could be the case when some required parameters are missing or, when malformed values are provided.

    • code string Required

      Value is bad_request.
  • 403 application/json

    Forbidden

    One of:
    no_root_key object wrong_encryption_passphrase object wrong_mnemonics object
    Hide attributes Show attributes
    • message string Required

      May occur when an action require a signing key but the wallet has only access to verification keys.

    • code string Required

      Value is no_root_key.
  • 404 application/json

    Not Found

    Hide response attributes Show response attributes object
    • message string Required

      May occur when a given walletId does not match with any known wallets (because it has been deleted, or has never existed).

    • code string Required

      Value is no_such_wallet.
  • 406 application/json

    Not Acceptable

    Hide response attributes Show response attributes object
    • message string Required

      May occur when providing an invalid 'Accept' header.

    • code string Required

      Value is not_acceptable.
  • 415 application/json

    Unsupported Media Type

    Hide response attributes Show response attributes object
    • message string Required

      May occur when providing an invalid 'Content-Type' header.

    • code string Required

      Value is unsupported_media_type.
  • 204

    No Content

PUT /wallets/{walletId}/passphrase 
curl \
 -X PUT https://localhost:8090/v2/wallets/{walletId}/passphrase \
 -H "Content-Type: application/json" \
 -d '{"old_passphrase":"Secure Passphrase","new_passphrase":"Secure Passphrase"}'
Request examples 
{
  "old_passphrase": "Secure Passphrase",
  "new_passphrase": "Secure Passphrase"
}
{
  "mnemonic_second_factor": [
    "squirrel",
    "material",
    "silly",
    "twice",
    "direct",
    "slush",
    "pistol",
    "razor",
    "become"
  ],
  "mnemonic_sentence": [
    "squirrel",
    "material",
    "silly",
    "twice",
    "direct",
    "slush",
    "pistol",
    "razor",
    "become",
    "junk",
    "kingdom",
    "flee",
    "squirrel",
    "silly",
    "twice"
  ],
  "new_passphrase": "Secure Passphrase"
}
Response examples (400) 
{
  "message": "string",
  "code": "bad_request"
}
Response examples (403) 
{
  "message": "string",
  "code": "no_root_key"
}
{
  "message": "string",
  "code": "wrong_encryption_passphrase"
}
{
  "message": "string",
  "code": "wrong_mnemonic"
}
Response examples (404) 
{
  "message": "string",
  "code": "no_such_wallet"
}
Response examples (406) 
{
  "message": "string",
  "code": "not_acceptable"
}
Response examples (415) 
{
  "message": "string",
  "code": "unsupported_media_type"
}