Claims

Handles all Claims related functionality

Hierarchy

  • Claims

Index

Methods

Methods

addClaims

addClaims(args: Pick‹ModifyClaimsParams, "claims"›): Promise‹TransactionQueue‹void››

Defined in src/Claims.ts:126

Add claims to Identities

note required roles:

  • Customer Due Diligence Provider: if there is at least one CDD claim in the arguments

note this method is of type ProcedureMethod, which means you can call addClaims.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name

Type

args

Pick‹ModifyClaimsParams, "claims"›

Returns: Promise‹TransactionQueue‹void››

addInvestorUniquenessClaim

addInvestorUniquenessClaim(args: AddInvestorUniquenessClaimParams): Promise‹TransactionQueue‹void››

Defined in src/Claims.ts:113

Add an Investor Uniqueness Claim to the current Identity

note this method is of type ProcedureMethod, which means you can call addInvestorUniquenessClaim.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name

Type

Description

Returns: Promise‹TransactionQueue‹void››

editClaims

editClaims(args: Pick‹ModifyClaimsParams, "claims"›): Promise‹TransactionQueue‹void››

Defined in src/Claims.ts:139

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

note required roles:

  • Customer Due Diligence Provider: if there is at least one CDD claim in the arguments

note this method is of type ProcedureMethod, which means you can call editClaims.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name

Type

args

Pick‹ModifyClaimsParams, "claims"›

Returns: Promise‹TransactionQueue‹void››

getCddClaims

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

Defined in src/Claims.ts:309

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:259

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:200

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?

types of the claims to fetch. Defaults to any type

includeExpired?

undefined | false | true

whether to include expired claims. Defaults to true

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:333

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:165

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:360

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?

-

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››

revokeClaims

revokeClaims(args: Pick‹ModifyClaimsParams, "claims"›): Promise‹TransactionQueue‹void››

Defined in src/Claims.ts:152

Revoke claims from Identities

note required roles:

  • Customer Due Diligence Provider: if there is at least one CDD claim in the arguments

note this method is of type ProcedureMethod, which means you can call revokeClaims.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name

Type

args

Pick‹ModifyClaimsParams, "claims"›

Returns: Promise‹TransactionQueue‹void››

Last updated