​🆔 Identity API methods allows developers to perform various user identity and account functionalities, such as getting the identity (DID) of a user (address), linking new addresses to the DID, and adding new authentication methods to the DID.

Static

• ​Box.getConfig​

• ​Box.idUtils.verifyClaim​

• ​Box.idUtils.isMuportDID​

• ​Box.idUtils.isClaim​

Stateful

• ​box.DID​

• ​box._3id.signJWT​

• ​box.linkAddress​

• ​box.isAddressLinked​

• ​box.listAddressLinks​

• ​box.removeAddressLink​

Static

Box.getConfig(address, opts)

Get the configuration of a 3Box.

Kind: static method of Box Returns: Object - An object containing the 3Box configuration for the given user. The object contains address links and DIDs for spaces.

Example:

const config = await Box.getConfig(0x234...)
console.log(config)

Output:

{
  "spaces": {
    "spaceName1": {
      "DID": "did:3:bafyreig4tg..."
    },
    "spaceName2": {
      "DID": "did:3:bafyjfr982d..."
    }
  },
  "links": [{
      "type": "ethereum-eoa",
      "message": "Create a new 3Box profile...",
      "version": 1,
      "signature": "0x04501e914651...",
      "timestamp": 1563976242
  }]
}

Box.idUtils.verifyClaim(claim, opts)

Verify a claim and return its content. See https://github.com/uport-project/did-jwt/ for more details.

Kind: static property of idUtils Returns: Object - The validated claim

Box.idUtils.isMuportDID(address)

Check if a string is a muport DID.

Kind: static method of idUtils Returns: * | boolean - If the address is a muport DID

Box.idUtils.isClaim(claim, opts)

Check if a string is a valid claim.

Kind: static method of idUtils Returns: Promise.<boolean> - If the parameter is a verifiable claim

Stateful

box.DID

Get the DID of a 3Box.

Kind: instance property of Box Properties

box._3id.signJWT(claim)

Signs a JWT claim which can be verified by the did-jwt library.

Kind: instance method of Box Returns: String - A JWT string

box.linkAddress([link])

Creates a proof that links an ethereum address to a 3Box account (DID). If given proof, it will simply be added to the root store.

Kind: instance method of Box​

box.isAddressLinked([query])

Checks if there is a proof that links an external account to the 3Box account (DID). If no params given and any link exists, this will return true.

Kind: instance method of Box​

box.listAddressLinks()

Lists address links associated to a 3Box account (DID).

Kind: instance method of Box Returns: Array - An array of link objects

box.removeAddressLink(address)

Remove given address link. Returns true if successful.

Kind: instance method of Box​