Handles all Claims related functionality

Hierarchy

• Claims

Index

Properties

• ​addClaims​

• ​addInvestorUniquenessClaim​

• ​editClaims​

• ​revokeClaims​

Methods

• ​getCddClaims​

• ​getClaimScopes​

• ​getIdentitiesWithClaims​

• ​getInvestorUniquenessClaims​

• ​getIssuedClaims​

• ​getTargetingClaims​

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‹ClaimData‹CddClaim›[]›

Defined in src/Claims.ts:288​

Retrieve the list of CDD claims for a target Identity

Parameters:

▪Default value opts: object= {}

Returns: Promise‹ClaimData‹CddClaim›[]›

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= {}

Returns: Promise‹ClaimScope[]›

getIdentitiesWithClaims

▸ getIdentitiesWithClaims(opts: object): Promise‹ResultSet‹IdentityWithClaims››

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= {}

Returns: Promise‹ResultSet‹IdentityWithClaims››

getInvestorUniquenessClaims

▸ getInvestorUniquenessClaims(opts: object): Promise‹ClaimData‹InvestorUniquenessClaim›[]›

Defined in src/Claims.ts:312​

Retrieve the list of InvestorUniqueness claims for a target Identity

Parameters:

▪Default value opts: object= {}

Returns: Promise‹ClaimData‹InvestorUniquenessClaim›[]›

getIssuedClaims

▸ getIssuedClaims(opts: object): Promise‹ResultSet‹ClaimData››

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= {}

Returns: Promise‹ResultSet‹ClaimData››

getTargetingClaims

▸ getTargetingClaims(opts: object): Promise‹ResultSet‹IdentityWithClaims››

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= {}

Returns: Promise‹ResultSet‹IdentityWithClaims››