Skip to main content

Identifier class

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents some properties and relationships of an IIdentifier that are stored in a TypeORM database for the purpose of keeping track of keys and services associated with a DID managed by a Veramo agent.

Signature:

export declare class Identifier extends BaseEntity

Extends: BaseEntity

Properties

Property

Modifiers

Type

Description

alias?

string

(BETA) (Optional)

controllerKeyId?

string

(BETA) (Optional)

did

string

(BETA)

issuedClaims

Claim[]

(BETA)

issuedCredentials

Credential[]

(BETA)

issuedPresentations

Presentation[]

(BETA)

keys

Key[]

(BETA)

provider?

string

(BETA) (Optional)

receivedClaims

Claim[]

(BETA)

receivedCredentials

Credential[]

(BETA)

receivedMessages

Message[]

(BETA)

receivedPresentations

Presentation[]

(BETA)

saveDate

Date

(BETA)

sentMessages

Message[]

(BETA)

services

Service[]

(BETA)

updateDate

Date

(BETA)

Methods

Method

Modifiers

Description

getLatestClaimValue(dbConnection, where)

(BETA) Convenience method to get the most recent information about a subject DID as described by Verifiable Credential claims.

Example:

// get the latest claim value for credentials containing `credentialSubject.name` and this Identifier as subject.
const name = await identifier.getLatestClaimValue({ type: 'name' })

setSaveDate()

(BETA)

setUpdateDate()

(BETA)

shortDid()

(BETA)