API Index
IdentityWallet SDK implements the 3ID protocol, which specifies the methods below. 3ID is used for user identity, encryption, and data authorization.
This page contains the full 3ID API specification, but certain restricted methods are only available to wallets but not to apps. This is for security purposes. These restricted methods will be noted below.
​Initialize​
​new IdentityWallet​
​Auth​
​Sign​
​identityWallet.signClaim​
​Encrypt/Decrypt​
​identityWallet.encrypt​
​identityWallet.decrypt​
Creates an instance of IdentityWallet
Returns: this - An IdentityWallet instance
Param | Type | Description |
config |
| The configuration to be used |
config.seed |
| The seed of the identity, 32 hex string |
config.authSecret |
| The authSecret to use, 32 hex string |
config.ethereumAddress |
| The ethereumAddress of the identity |
Authenticate to given spaces
Kind: instance method of IdentityWallet
Returns: Object - The public keys for the requested spaces of this identity
Param | Type | Description |
spaces |
| The desired spaces |
opts |
| Optional parameters |
opts.authData |
| The authData for this identity |
Check if authenticated to given spaces
Kind: instance method of IdentityWallet
Returns: Boolean - True if authenticated
Param | Type | Description |
spaces |
| The desired spaces |
Add a new authentication method for this identity.
Note: This restricted method is only available to wallets, but not applications.
Kind: instance method of IdentityWallet
Param | Type | Description |
authSecret |
| A 32 byte hex string used as authentication secret |
Sign a verifiable credential. The format of the credential is did-jwt.
Kind: instance method of IdentityWallet
Returns: String - The signed claim encoded as a JWT
Param | Type | Description |
payload |
| The payload of the claim |
opts |
| Optional parameters |
opts.DID |
| The DID used as the issuer of this claim |
opts.space |
| The space used to sign the claim |
opts.expiresIn |
| Set an expiry date for the claim as unix timestamp |
Encrypt a message
Kind: instance method of IdentityWallet
Returns: Object - The encrypted object (ciphertext and nonce)
Param | Type | Description |
message |
| The message to be encrypted |
space |
| The space used for encryption |
opts |
| Optional parameters |
opts.nonce |
| The nonce used to encrypt the message |
opts.blockSize |
| The blockSize used for padding (default 24) |
Decrypt a message
Kind: instance method of IdentityWallet
Returns: String - The decrypted message
Param | Type | Description |
encryptedObject |
| The encrypted object (ciphertext and nonce) |
space |
| The space used for encryption |
