Class IdentityStatementBuilder

Hierarchy

AtomicStatementBuilder<AttributeKey>
- IdentityStatementBuilder

Index

Constructors

Properties

Methods

addAgeInRange addEUNationality addEUResidency addMaximumAge addMembership addMinimumAge addNonMembership addRange documentExpiryNoEarlierThan getStatement revealAttribute

Constructors

constructor

new IdentityStatementBuilder(schema?: CredentialSchemaSubject): IdentityStatementBuilder
Parameters
- Optional schema: CredentialSchemaSubject
Returns IdentityStatementBuilder
Inherited from AtomicStatementBuilder.constructor
- Defined in packages/sdk/src/web3-id/proofs.ts:286

Properties

schema

schema: undefined | CredentialSchemaSubject

statements

Methods

addAgeInRange

addAgeInRange(minAge: number, maxAge: number): IdentityStatementBuilder
Add to the statement that the age is between two given ages. This adds a range statement that the date of birth is between years ago and years ago.

Returns
the updated builder
Parameters
- minAge: number
- maxAge: number
Returns IdentityStatementBuilder
- Defined in packages/sdk/src/web3-id/proofs.ts:406

addEUNationality

addEUNationality(): IdentityStatementBuilder
Add to the statement that the nationality is one of the EU countries

Returns
the updated builder

Returns IdentityStatementBuilder
- Defined in packages/sdk/src/web3-id/proofs.ts:432

addEUResidency

addEUResidency(): IdentityStatementBuilder
Add to the statement that the country of residence is one of the EU countries

Returns
the updated builder

Returns IdentityStatementBuilder
- Defined in packages/sdk/src/web3-id/proofs.ts:424

addMaximumAge

addMaximumAge(age: number): IdentityStatementBuilder
Add to the statement that the age is at maximum the given value. This adds a range statement that the date of birth is between <age + 1> years ago and 1st of january 9999.

Returns
the updated builder
Parameters
- age: number
Returns IdentityStatementBuilder
- Defined in packages/sdk/src/web3-id/proofs.ts:395

addMembership

addMembership(attribute: "firstName" | "lastName" | "sex" | "dob" | "countryOfResidence" | "nationality" | "idDocType" | "idDocNo" | "idDocIssuer" | "idDocIssuedAt" | "idDocExpiresAt" | "nationalIdNo" | "taxIdNo" | "lei" | "legalName" | "legalCountry" | "businessNumber" | "registrationAuth", set: StatementAttributeType[]): IdentityStatementBuilder
Add to the statement, that the given attribute should be one of the values in the given set.

Returns
the updated builder
Parameters
- attribute: "firstName" | "lastName" | "sex" | "dob" | "countryOfResidence" | "nationality" | "idDocType" | "idDocNo" | "idDocIssuer" | "idDocIssuedAt" | "idDocExpiresAt" | "nationalIdNo" | "taxIdNo" | "lei" | "legalName" | "legalCountry" | "businessNumber" | "registrationAuth"
  
  the attribute that should be checked
- set: StatementAttributeType[]
Returns IdentityStatementBuilder
Inherited from AtomicStatementBuilder.addMembership
- Defined in packages/sdk/src/web3-id/proofs.ts:333

addMinimumAge

addMinimumAge(age: number): IdentityStatementBuilder
Add to the statement that the age is at minimum the given value. This adds a range statement that the date of birth is between 1st of january 1800 and years ago.

Returns
the updated builder
Parameters
- age: number
Returns IdentityStatementBuilder
- Defined in packages/sdk/src/web3-id/proofs.ts:385

addNonMembership

addNonMembership(attribute: "firstName" | "lastName" | "sex" | "dob" | "countryOfResidence" | "nationality" | "idDocType" | "idDocNo" | "idDocIssuer" | "idDocIssuedAt" | "idDocExpiresAt" | "nationalIdNo" | "taxIdNo" | "lei" | "legalName" | "legalCountry" | "businessNumber" | "registrationAuth", set: StatementAttributeType[]): IdentityStatementBuilder
Add to the statement, that the given attribute should not be one of the values in the given set.

Returns
the updated builder
Parameters
- attribute: "firstName" | "lastName" | "sex" | "dob" | "countryOfResidence" | "nationality" | "idDocType" | "idDocNo" | "idDocIssuer" | "idDocIssuedAt" | "idDocExpiresAt" | "nationalIdNo" | "taxIdNo" | "lei" | "legalName" | "legalCountry" | "businessNumber" | "registrationAuth"
  
  the attribute that should be checked
- set: StatementAttributeType[]
Returns IdentityStatementBuilder
Inherited from AtomicStatementBuilder.addNonMembership
- Defined in packages/sdk/src/web3-id/proofs.ts:350

addRange

addRange(attribute: "firstName" | "lastName" | "sex" | "dob" | "countryOfResidence" | "nationality" | "idDocType" | "idDocNo" | "idDocIssuer" | "idDocIssuedAt" | "idDocExpiresAt" | "nationalIdNo" | "taxIdNo" | "lei" | "legalName" | "legalCountry" | "businessNumber" | "registrationAuth", lower: StatementAttributeType, upper: StatementAttributeType): IdentityStatementBuilder
Add to the statement, that the given attribute should be in the given range, i.e. that lower <= attribute < upper.

Returns
the updated builder
Parameters
- attribute: "firstName" | "lastName" | "sex" | "dob" | "countryOfResidence" | "nationality" | "idDocType" | "idDocNo" | "idDocIssuer" | "idDocIssuedAt" | "idDocExpiresAt" | "nationalIdNo" | "taxIdNo" | "lei" | "legalName" | "legalCountry" | "businessNumber" | "registrationAuth"
  
  the attribute that should be checked
- lower: StatementAttributeType
- upper: StatementAttributeType
Returns IdentityStatementBuilder
Inherited from AtomicStatementBuilder.addRange
- Defined in packages/sdk/src/web3-id/proofs.ts:315

documentExpiryNoEarlierThan

documentExpiryNoEarlierThan(earliestDate: string): IdentityStatementBuilder
Add to the statement that the user's document expiry is atleast the given date. This adds a range statement that the idDocExpiresAt is between the given date and 1st of january 9999 .

Returns
the updated builder
Parameters
- earliestDate: string
Returns IdentityStatementBuilder
- Defined in packages/sdk/src/web3-id/proofs.ts:416

getStatement

getStatement(): AtomicStatementV2<"firstName" | "lastName" | "sex" | "dob" | "countryOfResidence" | "nationality" | "idDocType" | "idDocNo" | "idDocIssuer" | "idDocIssuedAt" | "idDocExpiresAt" | "nationalIdNo" | "taxIdNo" | "lei" | "legalName" | "legalCountry" | "businessNumber" | "registrationAuth">[]
Outputs the built statement.

Returns AtomicStatementV2<"firstName" | "lastName" | "sex" | "dob" | "countryOfResidence" | "nationality" | "idDocType" | "idDocNo" | "idDocIssuer" | "idDocIssuedAt" | "idDocExpiresAt" | "nationalIdNo" | "taxIdNo" | "lei" | "legalName" | "legalCountry" | "businessNumber" | "registrationAuth">[]
Inherited from AtomicStatementBuilder.getStatement
- Defined in packages/sdk/src/web3-id/proofs.ts:294

revealAttribute

revealAttribute(attribute: "firstName" | "lastName" | "sex" | "dob" | "countryOfResidence" | "nationality" | "idDocType" | "idDocNo" | "idDocIssuer" | "idDocIssuedAt" | "idDocExpiresAt" | "nationalIdNo" | "taxIdNo" | "lei" | "legalName" | "legalCountry" | "businessNumber" | "registrationAuth"): IdentityStatementBuilder
Add to the statement, that the given attribute should be revealed. The proof will contain the value.

Returns
the updated builder
Parameters
- attribute: "firstName" | "lastName" | "sex" | "dob" | "countryOfResidence" | "nationality" | "idDocType" | "idDocNo" | "idDocIssuer" | "idDocIssuedAt" | "idDocExpiresAt" | "nationalIdNo" | "taxIdNo" | "lei" | "legalName" | "legalCountry" | "businessNumber" | "registrationAuth"
  
  the attribute that should be revealed
Returns IdentityStatementBuilder
Inherited from AtomicStatementBuilder.revealAttribute
- Defined in packages/sdk/src/web3-id/proofs.ts:367

Class IdentityStatementBuilder

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional schema: CredentialSchemaSubject

Returns IdentityStatementBuilder

Properties

schema

statements

Methods

addAgeInRange

Returns

Parameters

minAge: number

maxAge: number

Returns IdentityStatementBuilder

addEUNationality

Returns

Returns IdentityStatementBuilder

addEUResidency

Returns

Returns IdentityStatementBuilder

addMaximumAge

Returns

Parameters

age: number

Returns IdentityStatementBuilder

addMembership

Returns

Parameters

attribute: "firstName" | "lastName" | "sex" | "dob" | "countryOfResidence" | "nationality" | "idDocType" | "idDocNo" | "idDocIssuer" | "idDocIssuedAt" | "idDocExpiresAt" | "nationalIdNo" | "taxIdNo" | "lei" | "legalName" | "legalCountry" | "businessNumber" | "registrationAuth"

set: StatementAttributeType[]

Returns IdentityStatementBuilder

addMinimumAge

Returns

Parameters

age: number

Returns IdentityStatementBuilder

addNonMembership

Returns

Parameters

attribute: "firstName" | "lastName" | "sex" | "dob" | "countryOfResidence" | "nationality" | "idDocType" | "idDocNo" | "idDocIssuer" | "idDocIssuedAt" | "idDocExpiresAt" | "nationalIdNo" | "taxIdNo" | "lei" | "legalName" | "legalCountry" | "businessNumber" | "registrationAuth"

set: StatementAttributeType[]

Returns IdentityStatementBuilder

addRange

Returns

Parameters

attribute: "firstName" | "lastName" | "sex" | "dob" | "countryOfResidence" | "nationality" | "idDocType" | "idDocNo" | "idDocIssuer" | "idDocIssuedAt" | "idDocExpiresAt" | "nationalIdNo" | "taxIdNo" | "lei" | "legalName" | "legalCountry" | "businessNumber" | "registrationAuth"

lower: StatementAttributeType

upper: StatementAttributeType

Returns IdentityStatementBuilder

documentExpiryNoEarlierThan

Returns

Parameters

earliestDate: string

Returns IdentityStatementBuilder

getStatement

Returns AtomicStatementV2<"firstName" | "lastName" | "sex" | "dob" | "countryOfResidence" | "nationality" | "idDocType" | "idDocNo" | "idDocIssuer" | "idDocIssuedAt" | "idDocExpiresAt" | "nationalIdNo" | "taxIdNo" | "lei" | "legalName" | "legalCountry" | "businessNumber" | "registrationAuth">[]

revealAttribute

Returns

Parameters

attribute: "firstName" | "lastName" | "sex" | "dob" | "countryOfResidence" | "nationality" | "idDocType" | "idDocNo" | "idDocIssuer" | "idDocIssuedAt" | "idDocExpiresAt" | "nationalIdNo" | "taxIdNo" | "lei" | "legalName" | "legalCountry" | "businessNumber" | "registrationAuth"

Returns IdentityStatementBuilder

Settings

Member Visibility

Theme

`Optional` schema: CredentialSchemaSubject