Create backup action for key shares using API token authentication

Creates backup locations for wallet key shares. Requires API token authentication. Validates that the user belongs to the environment and that no client key shares exist for the wallet. This endpoint is intended for server-side integrations that need to backup key shares on behalf of users.

POST /environments/{environmentId}/waas/{walletId}/keyShares/backup/locations

Create backup action for key shares using API token authentication

cURL

curl --request POST \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/waas/{walletId}/keyShares/backup/locations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "locations": [
    {
      "keygenId": "An example name",
      "externalKeyShareId": "An example name"
    }
  ],
  "shareSetId": "95b11417-f18f-457f-8804-68e361f9164f"
}
'

201

{
  "locationsWithKeyShares": [
    {
      "externalKeyShareId": "95b11417-f18f-457f-8804-68e361f9164f",
      "keyShareId": "95b11417-f18f-457f-8804-68e361f9164f"
    }
  ],
  "message": "<string>",
  "walletId": "95b11417-f18f-457f-8804-68e361f9164f",
  "shareSetId": "95b11417-f18f-457f-8804-68e361f9164f",
  "walletActive": true
}

Authorizations

Authorization · string · header · required

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

Path Parameters

environmentId · string · required

ID of the environment

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

walletId · string · required

UUID of the wallet

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

Backup locations request with userId

userId · string<uuid> · required

The ID of the user who owns the wallet

locations · object[] · required

Where to store key backup shares — valid values include user, dynamic, googleDrive, iCloud, external

Show child attributes

shareSetId · string

Identifier of the share set (WaasWallets row) being activated. Optional for backwards compatibility — when omitted, the active rootUser share set is resolved from walletId.

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Response

201

application/json

Backup action and event created successfully

locationsWithKeyShares · object[] · required

List of backup locations paired with their key share identifiers

Show child attributes

message · string · required

Human-readable status message for the backup operation

walletId · string · required

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

passwordUpdateStatus · enum<string>

Current status of the password update process

Available options: activated, pending

shareSetId · string

Identifier of the share set that was activated by this backup.

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

shareSetType · enum<string> | null

Role of the active share set for this wallet, or null if no active wallet exists.

Available options: delegated, rootUser, server, businessAccountUser

walletActive · boolean

Whether the wallet has an active root-user share set.