Claims

Handles all Claims related functionality

Hierarchy

  • Claims

Index

Methods

Methods

addClaims

addClaims(args: Omit‹ModifyClaimsParams, "operation"›): Promise‹TransactionQueue‹void››

Defined in src/Claims.ts:46

Add claims to Identities

Parameters:

Returns: Promise‹TransactionQueue‹void››

editClaims

editClaims(args: Omit‹ModifyClaimsParams, "operation"›): Promise‹TransactionQueue‹void››

Defined in src/Claims.ts:55

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

  • @param args.claims - array of claims to be edited

Parameters:

Returns: Promise‹TransactionQueue‹void››

getCddClaims

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

Defined in src/Claims.ts:217

Retrieve the list of CDD claims for a target Identity

note supports pagination

note uses the middleware

Parameters:

Default value opts: object= {}

Returns: Promise‹ResultSetClaimData››

getClaimScopes

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

Defined in src/Claims.ts:179

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

note a null scope means the Identity has scopeless claims (like CDD for example)

note uses the middleware

Parameters:

Default value opts: object= {}

Returns: Promise‹ClaimScope[]›

getIdentitiesWithClaims

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

Defined in src/Claims.ts:116

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

getIssuedClaims

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

Defined in src/Claims.ts:79

Retrieve all claims issued by an Identity

note supports pagination

note uses the middleware

Parameters:

Default value opts: object= {}

Returns: Promise‹ResultSetClaimData››

getTargetingClaims

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

Defined in src/Claims.ts:250

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

note supports pagination

note uses the middleware

Parameters:

Default value opts: object= {}

Returns: Promise‹ResultSetIdentityWithClaims››

revokeClaims

revokeClaims(args: Omit‹ModifyClaimsParams, "operation"›): Promise‹TransactionQueue‹void››

Defined in src/Claims.ts:64

Revoke claims from Identities

Parameters:

Returns: Promise‹TransactionQueue‹void››

Last updated