Claims
Last updated
Was this helpful?
Last updated
Was this helpful?
Handles all Claims related functionality
Claims
Add claims to Identities
Parameters:
Name
Type
args
Add an Investor Uniqueness Claim to the current Identity
Parameters:
Name
Type
Description
args
AddInvestorUniquenessClaimParams
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
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)
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)
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
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)
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?
-
Revoke claims from Identities
Parameters:
Name
Type
args
â–¸ addClaims(args
: Omit‹, "operation"›): Promise‹‹void››
Defined in
Omit‹, "operation"›
Returns: Promise‹‹void››
â–¸ addInvestorUniquenessClaim(args
: AddInvestorUniquenessClaimParams): Promise‹‹void››
Defined in
Returns: Promise‹‹void››
â–¸ editClaims(args
: Omit‹, "operation"›): Promise‹‹void››
Defined in
Omit‹, "operation"›
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‹‹››
â–¸ getIssuedClaims(opts
: object): Promise‹‹››
Defined in
string |
Returns: Promise‹‹››
â–¸ getTargetingClaims(opts
: object): Promise‹‹››
Defined in
string |
(string | ‹›)[]
Returns: Promise‹‹››
â–¸ revokeClaims(args
: Omit‹, "operation"›): Promise‹‹void››
Defined in
Omit‹, "operation"›
Returns: Promise‹‹void››