API docs by Redocly

Account Service (1.0)

Download OpenAPI specification:Download

Account Service API

v1/accounts

Get the Sign In With Frequency configuration

Responses

Response samples

Content type
application/json
{
  • "providerId": "string",
  • "siwfUrl": "string",
  • "frequencyRpcUrl": "string"
}

Request to Sign In With Frequency

Request Body schema: application/json
required
object

The wallet login request information

object (SignUpResponseDto)

Responses

Request samples

Content type
application/json
{
  • "signIn": {
    },
  • "signUp": {
    }
}

Response samples

Content type
application/json
{
  • "referenceId": "string",
  • "msaId": "string",
  • "publicKey": "string"
}

Fetch an account given an MSA Id

path Parameters
msaId
required
string

Responses

Response samples

Content type
application/json
{
  • "msaId": "string",
  • "handle": {
    }
}

Fetch an account given an Account Id

path Parameters
accountId
required
string

Responses

Response samples

Content type
application/json
{
  • "msaId": "string",
  • "handle": {
    }
}

Get a retireMsa unsigned, encoded extrinsic payload.

path Parameters
accountId
required
string

Responses

Response samples

Content type
application/json
{
  • "encodedExtrinsic": "string",
  • "payloadToSign": "string",
  • "accountId": "string"
}

Request to retire an MSA ID.

Request Body schema: application/json
required
encodedExtrinsic
required
string
payloadToSign
required
string
accountId
required
string
signature
required
string

Responses

Request samples

Content type
application/json
{
  • "encodedExtrinsic": "string",
  • "payloadToSign": "string",
  • "accountId": "string",
  • "signature": "string"
}

Response samples

Content type
application/json
{
  • "referenceId": "string"
}

delegations

Get all delegation information associated with an MSA Id

path Parameters
msaId
required
string <int64>

Message Source Account Identifier

Responses

Response samples

Content type
application/json
{
  • "msaId": "string",
  • "delegations": [
    ]
}

Get an MSA's delegation information for a specific provider

path Parameters
msaId
required
string <int64>

Message Source Account Identifier

providerId
string <int64>

Provider ID

Responses

Response samples

Content type
application/json
{
  • "msaId": "string",
  • "delegations": [
    ]
}

delegation

Get the delegation information associated with an MSA Id

path Parameters
msaId
required
string

Responses

Response samples

Content type
application/json
{
  • "providerId": "string",
  • "schemaPermissions": { },
  • "revokedAt": { }
}

Get a properly encoded RevokeDelegationPayload that can be signed

path Parameters
accountId
required
string
providerId
required
string

Responses

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "providerId": "string",
  • "encodedExtrinsic": { },
  • "payloadToSign": { }
}

Request to revoke a delegation

Request Body schema: application/json
required
accountId
required
string
providerId
required
string
encodedExtrinsic
required
object
payloadToSign
required
object
signature
required
object

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "providerId": "string",
  • "encodedExtrinsic": { },
  • "payloadToSign": { },
  • "signature": { }
}

Response samples

Content type
application/json
{
  • "referenceId": "string"
}

v1/handles

Request to create a new handle for an account

Request Body schema: application/json
required
accountId
required
string
required
object (HandlePayloadDto)
proof
required
string

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "payload": {
    },
  • "proof": "string"
}

Request to change a handle

Request Body schema: application/json
required
accountId
required
string
required
object (HandlePayloadDto)
proof
required
string

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "payload": {
    },
  • "proof": "string"
}

Get a properly encoded ClaimHandlePayload that can be signed.

path Parameters
newHandle
required
string

Responses

Fetch a handle given an MSA Id

path Parameters
msaId
required
string

Responses

v1/keys

Add new control keys for an MSA Id

Request Body schema: application/json
required
msaOwnerAddress
required
string
msaOwnerSignature
required
string
newKeyOwnerSignature
required
string
required
object (KeysRequestPayloadDto)

Responses

Request samples

Content type
application/json
{
  • "msaOwnerAddress": "string",
  • "msaOwnerSignature": "string",
  • "newKeyOwnerSignature": "string",
  • "payload": {
    }
}

Fetch public keys given an MSA Id

path Parameters
msaId
required
string

Responses

Get a properly encoded StatefulStorageItemizedSignaturePayloadV2 that can be signed.

query Parameters
msaId
required
string

MSA ID of account to generate a payload for

newKey
required
string

Public key should be a 32 bytes value in hex format!

Responses

Request to add a new public Key

Request Body schema: application/json
required
accountId
required
string
required
object (ItemizedSignaturePayloadDto)
proof
required
string

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "payload": {
    },
  • "proof": "string"
}

health

Check the health status of the service

Responses

Check the live status of the service

Responses

Check the ready status of the service

Responses