diff --git a/docs/account/index.html b/docs/account/index.html
index ff92fc1a..7bbe3a0f 100644
--- a/docs/account/index.html
+++ b/docs/account/index.html
@@ -12,340 +12,340 @@
margin: 0;
}
-
-
+ " fill="currentColor">
Account Service (1.0)
Download OpenAPI specification:Download
Get the Sign In With Frequency configuration
Responses
Response samples
Content typeapplication/json
Request to Sign In With Frequency
Request Body schema: application/json
required
| object The wallet login request information
+ |
| object (SignUpResponseDto) |
Request samples
Content typeapplication/json
{"signIn":
{"siwsPayload":
{"message": "0x1234567890abcdef",
"signature": "0x64f8dd8846ba72cbb1954761ec4b2e44b886abb4b4ef7455b869355f17b4ce4a601ad26eabc57a682244a97bc9a2001b59469ae76fea105b724e988967d4928d"
},
},
}
Response samples
Content typeapplication/json
{"referenceId": "string",
"msaId": "string",
"publicKey": "string"
}
Fetch an account given an Account Id
path Parameters
accountId required | string Example: 1LSLqpLWXo7A7xuiRdu6AQPnBPNJHoQSu8DBsUYJgsNEJ4N AccountId in hex or SS58 format
+ |
/v1/accounts/account/{accountId}
Response samples
Content typeapplication/json
Get a retireMsa unsigned, encoded extrinsic payload.
path Parameters
accountId required | string Example: 1LSLqpLWXo7A7xuiRdu6AQPnBPNJHoQSu8DBsUYJgsNEJ4N AccountId in hex or SS58 format
+ |
/v1/accounts/retireMsa/{accountId}
Response samples
Content typeapplication/json
{"encodedExtrinsic": "0x1234",
"payloadToSign": "0x1234",
"accountId": "1LSLqpLWXo7A7xuiRdu6AQPnBPNJHoQSu8DBsUYJgsNEJ4N"
}
Request to retire an MSA ID.
Request Body schema: application/json
required
encodedExtrinsic required | string Hex-encoded representation of the "RetireMsa" extrinsic
+ |
payloadToSign required | |
accountId required | string AccountId in hex or SS58 format
+ |
signature required | |
Responses
Request samples
Content typeapplication/json
{"encodedExtrinsic": "0x1234",
"payloadToSign": "0x1234",
"accountId": "1LSLqpLWXo7A7xuiRdu6AQPnBPNJHoQSu8DBsUYJgsNEJ4N",
"signature": "0x065d733ca151c9e65b78f2ba77348224d31647e6913c44ad2765c6e8ba06f834dc21d8182447d01c30f84a41d90a8f2e58001d825c6f0d61b0afe89f984eec85"
}
Response samples
Content typeapplication/json
Get all delegation information associated with an MSA Id
path Parameters
msaId required | string Example: 3 MSA Id of the user requesting the delegation
+ |
Responses
Response samples
Content typeapplication/json
{"msaId": "string",
"delegations":
[{"providerId": "string",
"schemaDelegations":
[{"schemaId": 0,
"revokedAtBlock": 0
}
], "revokedAtBlock": 0
}
]
}
Get an MSA's delegation information for a specific provider
path Parameters
msaId required | string Example: 3 MSA Id of the user requesting the delegation
+ |
providerId | string Example: 1 MSA Id of the provider to whom the requesting user wishes to delegate
+ |
Responses
/v2/delegations/{msaId}/{providerId}
Response samples
Content typeapplication/json
{"msaId": "string",
"delegations":
[{"providerId": "string",
"schemaDelegations":
[{"schemaId": 0,
"revokedAtBlock": 0
}
], "revokedAtBlock": 0
}
]
}
Get the delegation information associated with an MSA Id
path Parameters
msaId required | string Example: 2 Msa Id of requested account
+ |
Responses
Response samples
Content typeapplication/json
Get a properly encoded RevokeDelegationPayload that can be signed
path Parameters
accountId required | string Example: 1LSLqpLWXo7A7xuiRdu6AQPnBPNJHoQSu8DBsUYJgsNEJ4N AccountId in hex or SS58 format
+ |
providerId required | |
Responses
/v1/delegation/revokeDelegation/{accountId}/{providerId}
Response samples
Content typeapplication/json
{"accountId": "1LSLqpLWXo7A7xuiRdu6AQPnBPNJHoQSu8DBsUYJgsNEJ4N",
"providerId": "3",
"encodedExtrinsic": "0x1234",
"payloadToSign": "0x1234"
}
Request to revoke a delegation
Request Body schema: application/json
required
accountId required | string AccountId in hex or SS58 format
+ |
providerId required | string MSA Id of the provider to whom the requesting user wishes to delegate
+ |
encodedExtrinsic required | string Hex-encoded representation of the "revokeDelegation" extrinsic
+ |
payloadToSign required | |
signature required | |
Responses
/v1/delegation/revokeDelegation
Request samples
Content typeapplication/json
{"accountId": "1LSLqpLWXo7A7xuiRdu6AQPnBPNJHoQSu8DBsUYJgsNEJ4N",
"providerId": "3",
"encodedExtrinsic": "0x1234",
"payloadToSign": "0x1234",
"signature": "0x065d733ca151c9e65b78f2ba77348224d31647e6913c44ad2765c6e8ba06f834dc21d8182447d01c30f84a41d90a8f2e58001d825c6f0d61b0afe89f984eec85"
}
Response samples
Content typeapplication/json
Request to create a new handle for an account
Request Body schema: application/json
required
accountId required | string AccountId in hex or SS58 format
+ |
required | object (HandlePayloadDto) |
proof required | string proof is the signature for the payload
+ |
Responses
Request samples
Content typeapplication/json
{"accountId": "1LSLqpLWXo7A7xuiRdu6AQPnBPNJHoQSu8DBsUYJgsNEJ4N",
"payload":
{"baseHandle": "handle",
"expiration": "1"
}, "proof": "0x065d733ca151c9e65b78f2ba77348224d31647e6913c44ad2765c6e8ba06f834dc21d8182447d01c30f84a41d90a8f2e58001d825c6f0d61b0afe89f984eec85"
}
Request to change a handle
Request Body schema: application/json
required
accountId required | string AccountId in hex or SS58 format
+ |
required | object (HandlePayloadDto) |
proof required | string proof is the signature for the payload
+ |
Responses
Request samples
Content typeapplication/json
{"accountId": "1LSLqpLWXo7A7xuiRdu6AQPnBPNJHoQSu8DBsUYJgsNEJ4N",
"payload":
{"baseHandle": "handle",
"expiration": "1"
}, "proof": "0x065d733ca151c9e65b78f2ba77348224d31647e6913c44ad2765c6e8ba06f834dc21d8182447d01c30f84a41d90a8f2e58001d825c6f0d61b0afe89f984eec85"
}
Get a properly encoded ClaimHandlePayload that can be signed.
path Parameters
newHandle required | string >= 3 characters Example: handle newHandle in the request
+ |
Responses
/v1/handles/change/{newHandle}
Fetch a handle given an MSA Id
path Parameters
msaId required | string Example: 2 Msa Id of requested account
+ |
Add new control keys for an MSA Id
Request Body schema: application/json
required
msaOwnerAddress required | string msaOwnerAddress representing the target of this request
+ |
msaOwnerSignature required | string msaOwnerSignature is the signature by msa owner
+ |
newKeyOwnerSignature required | string newKeyOwnerSignature is the signature with new key
+ |
required | object (KeysRequestPayloadDto) |
Request samples
Content typeapplication/json
{"msaOwnerAddress": "1LSLqpLWXo7A7xuiRdu6AQPnBPNJHoQSu8DBsUYJgsNEJ4N",
"msaOwnerSignature": "0x065d733ca151c9e65b78f2ba77348224d31647e6913c44ad2765c6e8ba06f834dc21d8182447d01c30f84a41d90a8f2e58001d825c6f0d61b0afe89f984eec85",
"newKeyOwnerSignature": "0x065d733ca151c9e65b78f2ba77348224d31647e6913c44ad2765c6e8ba06f834dc21d8182447d01c30f84a41d90a8f2e58001d825c6f0d61b0afe89f984eec85",
}
Fetch public keys given an MSA Id
path Parameters
msaId required | string Example: 2 Msa Id of requested account
+ |
Get a properly encoded StatefulStorageItemizedSignaturePayloadV2 that can be signed.
query Parameters
msaId required | string Example: msaId=3 MSA Id representing the target of this request
+ |
newKey required | string Example: newKey=0x0ed2f8c714efcac51ca2325cfe95637e5e0b898ae397aa365978b7348a717d0b New public key to be added to the account (32-byte value in hex format)
+ |
Responses
/v1/keys/publicKeyAgreements/getAddKeyPayload
Request to add a new public Key
Request Body schema: application/json
required
accountId required | string AccountId in hex or SS58 format
+ |
required | object (ItemizedSignaturePayloadDto) |
proof required | string proof is the signature for the payload
+ |
Responses
/v1/keys/publicKeyAgreements
Request samples
Content typeapplication/json
{"accountId": "1LSLqpLWXo7A7xuiRdu6AQPnBPNJHoQSu8DBsUYJgsNEJ4N",
"payload":
{"schemaId": "1",
"targetHash": "1234",
"expiration": "1",
}, "proof": "0x065d733ca151c9e65b78f2ba77348224d31647e6913c44ad2765c6e8ba06f834dc21d8182447d01c30f84a41d90a8f2e58001d825c6f0d61b0afe89f984eec85"
}
Check the health status of the service
Check the live status of the service
Check the ready status of the service
+
+
+
+
+
+ Transaction Notification API (1.0.0)
Download OpenAPI specification:Download
Notify transaction
Request Body schema: application/json
required
One of providerId required | |
referenceId required | |
msaId required | |
| "CREATE_HANDLE" (string) or "CHANGE_HANDLE" (string) |
handle required | |
Responses
Request samples
Content typeapplication/json
Example
+
+
+
+