Get Policy Key

GET /wallets/{walletId}/policy-key

status: stable

Return a policy key for a derivation index = 0.

To get a hash of the policy key instead of the policy key, use query parameter hash=true.

Path parameters

  • walletId string(hex) Required

    Minimum length is 40, maximum length is 40.

Responses

  • 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.
  • 404 application/json

    Not Found

    Hide response attributes Show response attributes object
    • message string Required

      A descriptive error message.

    • code string Required

      A specific error code for this error, more precise than HTTP ones.
  • 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:
    invalid_wallet_type object missing_policy_public_key object
  • 200 application/json

    Ok

    Format should match the following pattern: ^((policy_vk)|(policy_vkh))1[0-9a-z]*$.
GET /wallets/{walletId}/policy-key 
curl \
 --request GET https://localhost:8090/v2/wallets/{walletId}/policy-key
Response examples (406) 
{
  "message": "string",
  "code": "not_acceptable"
}
Response examples (404) 
{
  "message": "string",
  "code": "an_error_code"
}
Response examples (400) 
{
  "message": "string",
  "code": "bad_request"
}
Response examples (403) 
{
  "message": "string",
  "code": "invalid_wallet_type"
}
{
  "message": "string",
  "code": "missing_policy_public_key"
}
Response examples (200) 
string