Claims
Handles all Claims related functionality
Hierarchy
Claims
Index
Properties
Methods
Properties
addClaims
• addClaims: ProcedureMethod‹Pick‹ModifyClaimsParams, "claims"›, void›
Defined in src/Claims.ts:118
Add claims to Identities
param array of claims to be added
note required roles:
Customer Due Diligence Provider: if there is at least one CDD claim in the arguments
addInvestorUniquenessClaim
• addInvestorUniquenessClaim: ProcedureMethod‹AddInvestorUniquenessClaimParams, void›
Defined in src/Claims.ts:108
Add an Investor Uniqueness Claim to the current Identity
param
editClaims
• editClaims: ProcedureMethod‹Pick‹ModifyClaimsParams, "claims"›, void›
Defined in src/Claims.ts:129
Edit claims associated to Identities (only the expiry date can be modified)
param array of claims to be edited
note required roles:
Customer Due Diligence Provider: if there is at least one CDD claim in the arguments
revokeClaims
• revokeClaims: ProcedureMethod‹Pick‹ModifyClaimsParams, "claims"›, void›
Defined in src/Claims.ts:139
Revoke claims from Identities
param array of claims to be revoked
note required roles:
Customer Due Diligence Provider: if there is at least one CDD claim in the arguments
Methods
getCddClaims
▸ getCddClaims(opts: object): Promise‹ClaimData‹CddClaim›[]›
Defined in src/Claims.ts:294
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?
identity for which to fetch CDD claims (optional, defaults to the current Identity)
Returns: Promise‹ClaimData‹CddClaim›[]›
getClaimScopes
▸ getClaimScopes(opts: object): Promise‹ClaimScope[]›
Defined in src/Claims.ts:244
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?
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:185
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››
getInvestorUniquenessClaims
▸ getInvestorUniquenessClaims(opts: object): Promise‹ClaimData‹InvestorUniquenessClaim›[]›
Defined in src/Claims.ts:318
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?
identity for which to fetch CDD claims (optional, defaults to the current Identity)
Returns: Promise‹ClaimData‹InvestorUniquenessClaim›[]›
getIssuedClaims
▸ getIssuedClaims(opts: object): Promise‹ResultSet‹ClaimData››
Defined in src/Claims.ts:150
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:345
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?
identity for which to fetch targeting claims (optional, defaults to the current Identity)
trustedClaimIssuers?
-
Returns: Promise‹ResultSet‹IdentityWithClaims››
Last updated