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:59
Add claims to Identities
Parameters:
Name
Type
args
Returns: Promise‹TransactionQueue‹void››
addInvestorUniquenessClaim
▸ addInvestorUniquenessClaim(args: AddInvestorUniquenessClaimParams): Promise‹TransactionQueue‹void››
Defined in src/Claims.ts:48
Add an Investor Uniqueness Claim to the current Identity
Parameters:
Name
Type
Description
args
AddInvestorUniquenessClaimParams
Returns: Promise‹TransactionQueue‹void››
editClaims
▸ editClaims(args: Omit‹ModifyClaimsParams, "operation"›): Promise‹TransactionQueue‹void››
Defined in src/Claims.ts:68
Edit claims associated to Identities (only the expiry date can be modified)
@param args.claims - array of claims to be edited
Parameters:
Name
Type
args
Returns: Promise‹TransactionQueue‹void››
getCddClaims
▸ getCddClaims(opts: object): Promise‹ResultSet‹ClaimData››
Defined in src/Claims.ts:230
Retrieve the list of CDD claims for a target 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
page size
start?
undefined | number
page offset
target?
identity for which to fetch CDD claims (optional, defaults to the current Identity)
Returns: Promise‹ResultSet‹ClaimData››
getClaimScopes
▸ getClaimScopes(opts: object): Promise‹ClaimScope[]›
Defined in src/Claims.ts:192
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= {}
Name
Type
Description
target?
identity for which to fetch claim scopes (optional, defaults to the current Identity)
Returns: Promise‹ClaimScope[]›
getIdentitiesWithClaims
▸ getIdentitiesWithClaims(opts: object): Promise‹ResultSet‹IdentityWithClaims››
Defined in src/Claims.ts:129
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?
identities (or Identity IDs) for which to fetch claims (targets). Defaults to all targets
trustedClaimIssuers?
identity IDs of claim issuers. Defaults to all claim issuers
Returns: Promise‹ResultSet‹IdentityWithClaims››
getIssuedClaims
▸ getIssuedClaims(opts: object): Promise‹ResultSet‹ClaimData››
Defined in src/Claims.ts:92
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?
identity (optional, defaults to the current Identity)
Returns: Promise‹ResultSet‹ClaimData››
getTargetingClaims
▸ getTargetingClaims(opts: object): Promise‹ResultSet‹IdentityWithClaims››
Defined in src/Claims.ts:263
Retrieve all claims issued about an Identity, grouped by claim issuer
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
scope?
-
size?
undefined | number
-
start?
undefined | number
-
target?
identity for which to fetch targeting claims (optional, defaults to the current Identity)
trustedClaimIssuers?
-
Returns: Promise‹ResultSet‹IdentityWithClaims››
revokeClaims
▸ revokeClaims(args: Omit‹ModifyClaimsParams, "operation"›): Promise‹TransactionQueue‹void››
Defined in src/Claims.ts:77
Revoke claims from Identities
Parameters:
Name
Type
args
Returns: Promise‹TransactionQueue‹void››
Last updated