v1/keys

Get a properly encoded StatefulStorageItemizedSignaturePayloadV2 that can be signed.

Changed on
get/v1/keys/publicKeyAgreements/getAddKeyPayload

Request

  • The document declares no server URL.
  • Auth: none declared

Query parameters

msaIdstring required
Example:3

MSA Id representing the target of this request

newKeystring required
Example:0x0ed2f8c714efcac51ca2325cfe95637e5e0b898ae397aa365978b7348a717d0b

New public key to be added to the account (32-byte value in hex format)

Response

Returned an encoded StatefulStorageItemizedSignaturePayloadV2 for signing

encodedPayloadstring required

Raw encodedPayload to be signed

Example response

{
  "payload": {
    "actions": [
      {
        "type": "ADD_ITEM",
        "encodedPayload": "0x1122"
      }
    ],
    "schemaId": 1,
    "targetHash": 1234,
    "expiration": 1
  },
  "encodedPayload": "0x1234"
}

Changes

    • ▲

      the /// response's property type changed from string to no type for status

    • ○

      api operation id KeysControllerV1_getPublicKeyAgreementsKeyPayload removed and replaced with KeysControllerV1_getPublicKeyAgreementsKeyPayload_v1

    • ○

      added to the /// response property allOf list for the response status

    • ○

      removed the ADD_ITEM enum value from the /// response property for the response status

    • ○

      removed the DELETE_ITEM enum value from the /// response property for the response status

    • ○

      added the media type application/json for the response with the status