Claims

Handles all Claims related functionality

Hierarchy

  • Claims

Index

Properties

Methods

Properties

addClaims

addClaims: ProcedureMethod‹Pick‹ModifyClaimsParams, "claims"›, void›

Defined in src/Claims.ts:112

Add claims to Identities

param array of claims to be added

note required role if at least one claim is CDD type:

  • Customer Due Diligence Provider

addInvestorUniquenessClaim

addInvestorUniquenessClaim: ProcedureMethod‹AddInvestorUniquenessClaimParams, void›

Defined in src/Claims.ts:102

Add an Investor Uniqueness Claim to the current Identity

param

editClaims

editClaims: ProcedureMethod‹Pick‹ModifyClaimsParams, "claims"›, void›

Defined in src/Claims.ts:123

Edit claims associated to Identities (only the expiry date can be modified)

param array of claims to be edited

note required role if at least one claim is CDD type:

  • Customer Due Diligence Provider

revokeClaims

revokeClaims: ProcedureMethod‹Pick‹ModifyClaimsParams, "claims"›, void›

Defined in src/Claims.ts:133

Revoke claims from Identities

param array of claims to be revoked

note required role if at least one claim is CDD type:

  • Customer Due Diligence Provider

Methods

getCddClaims

getCddClaims(opts: object): Promise‹ClaimDataCddClaim›[]›

Defined in src/Claims.ts:288

Retrieve the list of CDD claims for a target Identity

Parameters:

Default value opts: object= {}

Name

Type

Description

includeExpired?

undefined | false | true

whether to include expired claims. Defaults to true

target?

string | Identity

identity for which to fetch CDD claims (optional, defaults to the current Identity)

Returns: Promise‹ClaimDataCddClaim›[]›

getClaimScopes

getClaimScopes(opts: object): Promise‹ClaimScope[]›

Defined in src/Claims.ts:238

Retrieve all scopes in which claims have been made for the target Identity. If the scope is an asset DID, the corresponding ticker is returned as well

Parameters:

Default value opts: object= {}

Name

Type

Description

target?

string | Identity

identity for which to fetch claim scopes (optional, defaults to the current Identity)

Returns: Promise‹ClaimScope[]›

getIdentitiesWithClaims

getIdentitiesWithClaims(opts: object): Promise‹ResultSetIdentityWithClaims››

Defined in src/Claims.ts:179

Retrieve a list of Identities with claims associated to them. Can be filtered using parameters

note supports pagination

note uses the middleware

Parameters:

Default value opts: object= {}

Name

Type

Description

claimTypes?

ClaimType[]

types of the claims to fetch. Defaults to any type

includeExpired?

undefined | false | true

whether to include expired claims. Defaults to true

scope?

Scope

scope of the claims to fetch. Defaults to any scope

size?

undefined | number

page size

start?

undefined | number

page offset

targets?

(string | Identity‹›)[]

identities (or Identity IDs) for which to fetch claims (targets). Defaults to all targets

trustedClaimIssuers?

(string | Identity‹›)[]

identity IDs of claim issuers. Defaults to all claim issuers

Returns: Promise‹ResultSetIdentityWithClaims››

getInvestorUniquenessClaims

getInvestorUniquenessClaims(opts: object): Promise‹ClaimDataInvestorUniquenessClaim›[]›

Defined in src/Claims.ts:312

Retrieve the list of InvestorUniqueness claims for a target Identity

Parameters:

Default value opts: object= {}

Name

Type

Description

includeExpired?

undefined | false | true

whether to include expired claims. Defaults to true

target?

string | Identity

identity for which to fetch CDD claims (optional, defaults to the current Identity)

Returns: Promise‹ClaimDataInvestorUniquenessClaim›[]›

getIssuedClaims

getIssuedClaims(opts: object): Promise‹ResultSetClaimData››

Defined in src/Claims.ts:144

Retrieve all claims issued by an Identity

note supports pagination

note uses the middleware

Parameters:

Default value opts: object= {}

Name

Type

Description

includeExpired?

undefined | false | true

whether to include expired claims. Defaults to true

size?

undefined | number

-

start?

undefined | number

-

target?

string | Identity

identity (optional, defaults to the current Identity)

Returns: Promise‹ResultSetClaimData››

getTargetingClaims

getTargetingClaims(opts: object): Promise‹ResultSetIdentityWithClaims››

Defined in src/Claims.ts:339

Retrieve all claims issued about an Identity, grouped by claim issuer

note supports pagination

note uses the middleware (optional)

Parameters:

Default value opts: object= {}

Name

Type

Description

includeExpired?

undefined | false | true

whether to include expired claims. Defaults to true

scope?

Scope

-

size?

undefined | number

-

start?

undefined | number

-

target?

string | Identity

identity for which to fetch targeting claims (optional, defaults to the current Identity)

trustedClaimIssuers?

(string | Identity‹›)[]

-

Returns: Promise‹ResultSetIdentityWithClaims››