Claims
Handles all Claims related functionality

Hierarchy

  • Claims

Index

Methods

Methods

addClaims

addClaims(args: Pick‹ModifyClaimsParams, "claims"›, opts?: ProcedureOpts): 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 signing Account and Identity have the required roles and permissions to run it
Parameters:
Name
Type
args
Pick‹ModifyClaimsParams, "claims"›
opts?
Returns: Promise‹TransactionQueue‹void››

addInvestorUniquenessClaim

addInvestorUniquenessClaim(args: AddInvestorUniquenessClaimParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Defined in src/Claims.ts:113
Add an Investor Uniqueness Claim to the signing Identity
note this method is of type ProcedureMethod, which means you can call addInvestorUniquenessClaim.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Parameters:
Returns: Promise‹TransactionQueue‹void››

editClaims

editClaims(args: Pick‹ModifyClaimsParams, "claims"›, opts?: ProcedureOpts): 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 signing Account and Identity have the required roles and permissions to run it
Parameters:
Name
Type
args
Pick‹ModifyClaimsParams, "claims"›
opts?
Returns: Promise‹TransactionQueue‹void››

getCddClaims

getCddClaims(opts: object): Promise‹ClaimDataCddClaim›[]›
Defined in src/Claims.ts:310
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 signing Identity)
Returns: Promise‹ClaimDataCddClaim›[]›

getClaimScopes

getClaimScopes(opts: object): Promise‹ClaimScope[]›
Defined in src/Claims.ts:260
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 signing 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
scope of the claims to fetch. Defaults to any scope
size?
BigNumber
page size
start?
BigNumber
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:334
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 signing 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?
BigNumber
-
start?
BigNumber
-
target?
string | Identity
Identity (optional, defaults to the signing Identity)
Returns: Promise‹ResultSetClaimData››

getTargetingClaims

getTargetingClaims(opts: object): Promise‹ResultSetIdentityWithClaims››
Defined in src/Claims.ts:361
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?
BigNumber
-
start?
BigNumber
-
target?
string | Identity
Identity for which to fetch targeting claims (optional, defaults to the signing Identity)
trustedClaimIssuers?
(string | Identity‹›)[]
-
Returns: Promise‹ResultSetIdentityWithClaims››

revokeClaims

revokeClaims(args: Pick‹ModifyClaimsParams, "claims"›, opts?: ProcedureOpts): 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 signing Account and Identity have the required roles and permissions to run it
Parameters:
Name
Type
args
Pick‹ModifyClaimsParams, "claims"›
opts?
Returns: Promise‹TransactionQueue‹void››