Authorizations
The API key. For more details, refer to API key.
In the API playground, enter your API secret, and your API key will be accordingly calculated.
Path Parameters
The vault ID, which you can retrieve by calling List all vaults.
Body
The request body to create a TSS request.
The TSS request type. Possible values include:
-
KeyGen
: This is a key generation request to create a root extended public key and key shares for your Main Group after you've created the Main Group with Create key share holder group. You only need to do this once per organization. -
KeyGenFromKeyGroup
: This is a request to use the Main Group to create key shares for your Signing Group or Recovery Group after you've created these key share holder groups with Create key share holder group. -
Recovery
: This is a request to create key shares using the Recovery Group for a key share holder in the Main Group if their key share has been lost (e.g. by losing their phone).
KeyGen
, KeyGenFromKeyGroup
, Recovery
"Recovery"
The target key share holder group ID.
"a1bf161f-8b60-4f61-9c35-6434b8654437"
The source key share holder group.
Note: source_key_share_holder_group
is used only when type
is set to either KeyGenfromKeyGroup
or Recovery
. This is to specify the key share holder group to be used as the source key share holder group to create key shares for the target_key_share_holder_group
.
The description of the TSS request.
"This is a request to create key shares using the Recovery Group for a key share holder in the Main Group if their key share has been lost (e.g. by losing their phone)."
Response
mpc vault successfully created
The information about the TSS request.
The TSS request ID.
"20240711114129000132315000003970"
The source key share holder group.
Note: source_key_share_holder_group
is used only when type
is set to either KeyGenfromKeyGroup
or Recovery
. This is to specify the key share holder group to be used as the source key share holder group to create key shares for the target_key_share_holder_group
.
The target key share holder group ID.
"fd9519ae-507b-4605-b108-04d4e5ffcdd3"
The TSS request type. Possible values include:
-
KeyGen
: This is a key generation request to create a root extended public key and key shares for your Main Group after you've created the Main Group with Create key share holder group. You only need to do this once per organization. -
KeyGenFromKeyGroup
: This is a request to use the Main Group to create key shares for your Signing Group or Recovery Group after you've created these key share holder groups with Create key share holder group. -
Recovery
: This is a request to create key shares using the Recovery Group for a key share holder in the Main Group if their key share has been lost (e.g. by losing their phone).
KeyGen
, KeyGenFromKeyGroup
, Recovery
"Recovery"
The TSS request status. Possible values include:
-
PendingKeyHolderConfirmation
: The action done to the TSS request is currently pending enough key share holders to approve. -
KeyHolderConfirmationFailed
: Key share holders failed to approve the the action to be done to the TSS request. -
KeyGenerating
: The key share is currently being generated for the action to be done to the TSS request. -
MPCProcessing
: The TSS request approval is waiting to be started.- For MPC Wallets (User-Controlled Wallets), you need to use the Client App and call the UCW SDK to start the TSS request approval process.
- For MPC Wallets (Organization-Controlled Wallets):
- If you are using the server co-signer, this status indicates that the TSS Node will soon request the callback server to start the risk controls check. No further action is required from you at this stage.
- If you are using the mobile co-signer, key share holders need to use their Cobo Guard to approve the TSS request and participate in the signing process.
-
KeyGeneratingFailed
: The key share generation process has failed for the action to be done to the TSS request. -
Success
: The action done to the TSS request has been completed successfully. If you see this status while running Cancel TSS request, this mean the specified TSS request has been successfully canceled.
PendingKeyHolderConfirmation
, KeyHolderConfirmationFailed
, KeyGenerating
, MPCProcessing
, KeyGeneratingFailed
, Success
"Success"
The description of the TSS request.
"This is a request to create key shares using the Recovery Group for a key share holder in the Main Group if their key share has been lost (e.g. by losing their phone)."
The TSS request's creation time in Unix timestamp format, measured in milliseconds.
1701396866000