Entities

Enumerated Values

Parameter

Value

Description

didMethod

"spherity"

DID method "spherity"

hierarchy

"NONE"

No wallet hierarchy inside vault

hierarchy

BIP44

BIP44-based HD Wallet inside vault

keyManagement

"ECS"

Encrypted Cloud Storage

keyManagement

"MPC"

Multi-Party Computation

keyManagement

"HSM"

Hardware Security Module

(supported in next release)

Identity Vault

Name

Description

Type

Optional

_id

Identity Vault Id

String

no

name

Identity Vault name

String

no

description

Identity Vault description

String

no

parentID

Identity Vault parent Id

String

yes (if provided at creation)

hierarchy

Identity Vault hierarchy

String

no

mnemonic

Identity Vault's mnemonic (encrypted)

String

yes (ECS + BIP44 only)

keyManagement

Identity Vault key management

String

no

status

Identity Vault status

String

no

walletConfig

Config template for Identity Wallet(s)

Object

no

didMethod

Identity Wallet DID method

String

yes (if provided at creation)

apiUrl

API host for DID document update

String

yes (if provided at creation)

txsInput

Details for DID document update

Array

yes (if provided at creation)

service

DID document service

Object

yes (if provided at creation)

name

Service name

String

yes (if provided at creation)

value

Service value i.e. URL

String

yes (if provided at creation)

validity

Service validity offset in ms

Number

yes (if provided at creation)

delegate

DID document delegate

Object

yes (if provided at creation)

address

Delegate address i.e. Ethereum address

String

yes (if provided at creation)

validity

Delegate validity offset in ms

Number

yes (if provided at creation)

newOwner

New DID owner address i.e. Ethereum address

String

yes (if provided at creation)

wallets

Identity Wallets

Array

no

vaultId

Identity Vault Id

String

no

isHDWallet

Is BIP44 or a plain key-pair

Boolean

no

index

Identity Wallet's index

Number

yes (BIP44 Vault only)

privateKeyHex

Identity Wallet's private key HEX (encrypted)

String

yes (ECS Vault only)

publicKeyDER

Identity Wallet's public key DER-encoded

String

yes (MPC Vault only)

ethereumAddress

Identity Wallet's ethereum address

String

no

didMethod

Identity Wallet's DID method

String

no

did

Identity Wallet's DID

String

no

alias

Identity Wallet's human-readable alias

String

no

created

Identity Wallet's creation date

String

no

_id

Identity Wallet's id

String

no

mpcAccountID

Identity Vault's MPC account Id

String

yes (MPC Vault only)

mpcVault

body

Object

yes (MPC Vault only)

id

body

String

yes (MPC Vault only)

Identity Wallet

Parameter

Description

Type

Optional

Restrictions

vaultId

Parent Identity Vault Id

String

yes

Vault generated only

isHDWallet

Is HD Wallet or a plain key-pair

Boolean

no

-

index

Index of wallet from HD Wallet

Number

yes

BIP44 only

privateKeyHex

Identity Wallet's private key HEX (encrypted)

String

yes

ECS only

publicKeyDER

Identity Wallet's public key DER-encoded

String

yes

MPC only

publicKeyHex

Identity Wallet's public key HEX

String

no

-

ethereumAddress

Identity Wallet's ethereum address

String

no

-

didMethod

Identity Wallet's DID method

String

no

-

did

Identity Wallet's DID

String

no

-

alias

Identity Wallet's human-readable alias

String

no

-

created

Identity Wallet's creation date

String

no

-

_id

Identity Wallet's db Id

String

no

-

Identity Wallet Configuration

Parameter

Description

Type

Optional

Restrictions

didMethod

DID method

String

no

-

apiUrl

API host URL for DID document update

String

no

-

txsInput

Details for DID document update

Array

no

-

newOwner

New DID owner address i.e. Ethereum address

String

no

-

service

DID document service

Object

no

-

name

Service name

String

yes

-

value

Service value i.e. URL

String

yes

-

validity

Service validity offset in ms

Number

yes

-

delegate

DID document delegate

Object

no

-

address

Delegate address i.e. Ethereum address

String

no

-

validity

Delegate validity offset in ms

Number

yes

-

walletConfig

Config template for Identity Wallet(s)

Object

no

-

didMethod

DID method

String

no

"spherity"

apiUrl

API host URL for DID document update

String

no

self host

txsInput

Details for DID document update

Array

no

-

service

DID document service

Object

no

-

name

Service name

String

no

-

value

Service value i.e. URL

String

no

-

validity

Service validity offset in ms

Number

no

-

delegate

DID document delegate

Object

no

-

address

Delegate address i.e. Ethereum address

String

no

generated-on-fly

validity

Delegate validity offset in ms

Number

no

-

newOwner

DID of a new owner

String

no

-