Skip to main content
POST
Create Claim Permission Request

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

network
enum<string>
required

Polkadot network:

  • `mainnet` — Polkadot mainnet.
  • `kusama` — Kusama mainnet.
  • `westend` — Polkadot testnet.
Available options:
mainnet,
kusama,
westend

Body

application/json
stashAccountAddress
string
required

Main stash account address which keeps tokens for bonding.

Example:

"5H6ryBWChC5w7eaQ4GZjo329sEnhvjetSr6MBEt42mZ5tPw5"

permission
enum<string>
default:PermissionlessAll
required

State of the permission to claim rewards:

  • `Permissioned` — user needs to claim, bond or withdraw rewards by themselves.
  • `PermissionlessCompound` — claiming and bonding rewards on behalf of the user are permitted.
  • `PermissionlessWithdraw` — claiming and withdrawing rewards on behalf of the user are permitted.
  • `PermissionlessAll` — claiming, bonding and withdrawing rewards on behalf of the user are permitted.
Available options:
Permissioned,
PermissionlessCompound,
PermissionlessWithdraw,
PermissionlessAll
Example:

"PermissionlessAll"

extended
boolean

Optional boolean parameter indicating whether to include additional metadata in the response.

Example:

false

Response

OK

Standard API success response envelope wrapping the result payload.

error
object | null
required

Error object. Always null on successful responses.

result
object
required

Response payload containing the requested data.