Claims
Last updated
Was this helpful?
Last updated
Was this helpful?
Handles all Claims related functionality
Claims
Add claims to Identities
note
required roles:
Customer Due Diligence Provider: if there is at least one CDD claim in the arguments
Parameters:
args
opts?
Add an Investor Uniqueness Claim to the current Identity
Parameters:
args
opts?
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
Parameters:
args
opts?
Retrieve the list of CDD claims for a target Identity
Parameters:
â–ªDefault value
opts: object= {}
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)
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= {}
target?
identity for which to fetch claim scopes (optional, defaults to the current Identity)
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= {}
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
Retrieve the list of InvestorUniqueness claims for a target Identity
Parameters:
â–ªDefault value
opts: object= {}
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)
Retrieve all claims issued by an Identity
note
supports pagination
note
uses the middleware
Parameters:
â–ªDefault value
opts: object= {}
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)
Retrieve all claims issued about an Identity, grouped by claim issuer
note
supports pagination
note
uses the middleware (optional)
Parameters:
â–ªDefault value
opts: object= {}
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?
-
Revoke claims from Identities
note
required roles:
Customer Due Diligence Provider: if there is at least one CDD claim in the arguments
Parameters:
args
opts?
â–¸ addClaims(args
: Pick‹, "claims"›, opts?
: ): Promise‹‹void››
Defined in
note
this method is of type , which means you can call addClaims.checkAuthorization
on it to see whether the Current Account has the required permissions to run it
Pick‹, "claims"›
Returns: Promise‹‹void››
â–¸ addInvestorUniquenessClaim(args
: , opts?
: ): Promise‹‹void››
Defined in
note
this method is of type , which means you can call addInvestorUniquenessClaim.checkAuthorization
on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
â–¸ editClaims(args
: Pick‹, "claims"›, opts?
: ): Promise‹‹void››
Defined in
note
this method is of type , which means you can call editClaims.checkAuthorization
on it to see whether the Current Account has the required permissions to run it
Pick‹, "claims"›
Returns: Promise‹‹void››
â–¸ getCddClaims(opts
: object): Promise‹‹›[]›
Defined in
string |
Returns: Promise‹‹›[]›
â–¸ getClaimScopes(opts
: object): Promise‹[]›
Defined in
string |
Returns: Promise‹[]›
â–¸ getIdentitiesWithClaims(opts
: object): Promise‹‹››
Defined in
‹, ›[]
(string | ‹›)[]
(string | ‹›)[]
Returns: Promise‹‹››
â–¸ getInvestorUniquenessClaims(opts
: object): Promise‹‹›[]›
Defined in
string |
Returns: Promise‹‹›[]›
â–¸ getIssuedClaims(opts
: object): Promise‹‹››
Defined in
string |
Returns: Promise‹‹››
â–¸ getTargetingClaims(opts
: object): Promise‹‹››
Defined in
string |
(string | ‹›)[]
Returns: Promise‹‹››
â–¸ revokeClaims(args
: Pick‹, "claims"›, opts?
: ): Promise‹‹void››
Defined in
note
this method is of type , which means you can call revokeClaims.checkAuthorization
on it to see whether the Current Account has the required permissions to run it
Pick‹, "claims"›
Returns: Promise‹‹void››