Polymesh SDK API Reference
beta
beta
  • Globals
  • Classes
    • Account
    • AccountManagement
    • Asset
    • AssetHolders
    • AssetPermissions
    • Assets
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • CorporateAction
    • CorporateActionBase
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identities
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Network
    • NumberedPortfolio
    • Offering
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • Settlements
    • Subsidy
    • TickerReservation
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Methods
  • Methods
  • addClaims
  • addInvestorUniquenessClaim
  • editClaims
  • getCddClaims
  • getClaimScopes
  • getIdentitiesWithClaims
  • getIdentitiesWithClaimsV2
  • getInvestorUniquenessClaims
  • getIssuedClaims
  • getIssuedClaimsV2
  • getTargetingClaims
  • getTargetingClaimsV2
  • revokeClaims

Was this helpful?

  1. Classes

Claims

PreviousCheckpointsNextCompliance

Last updated 2 years ago

Was this helpful?

Handles all Claims related functionality

Hierarchy

  • Claims

Index

Methods

Methods

addClaims

Add claims to Identities

note required roles:

  • Customer Due Diligence Provider: if there is at least one CDD claim in the arguments

Parameters:

Name
Type

args

opts?


addInvestorUniquenessClaim

Add an Investor Uniqueness Claim to the signing Identity

Parameters:

Name
Type

args

opts?


editClaims

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:

Name
Type

args

opts?


getCddClaims

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 signing Identity)


getClaimScopes

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 signing Identity)


getIdentitiesWithClaims

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?

BigNumber

page size

start?

BigNumber

page offset

targets?

Identities (or Identity IDs) for which to fetch targeting claims. Defaults to all targets

trustedClaimIssuers?

Identity IDs of claim issuers. Defaults to all claim issuers


getIdentitiesWithClaimsV2

Retrieve a list of Identities with claims associated to them. Can be filtered using parameters

note supports pagination

note uses the middleware V2

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?

BigNumber

page size

start?

BigNumber

page offset

targets?

Identities (or Identity IDs) for which to fetch targeting claims. Defaults to all targets

trustedClaimIssuers?

Identity IDs of claim issuers. Defaults to all claim issuers


getInvestorUniquenessClaims

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 signing Identity)


getIssuedClaims

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?

Identity (optional, defaults to the signing Identity)


getIssuedClaimsV2

Retrieve all claims issued by an Identity

note supports pagination

note uses the middlewareV2

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?

Identity (optional, defaults to the signing Identity)


getTargetingClaims

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?

BigNumber

-

start?

BigNumber

-

target?

Identity for which to fetch targeting claims (optional, defaults to the signing Identity)

trustedClaimIssuers?

-


getTargetingClaimsV2

Retrieve all claims issued about an Identity, grouped by claim issuer

note supports pagination

note uses the middlewareV2 (optional)

Parameters:

â–ªDefault value opts: object= {}

Name
Type
Description

includeExpired?

undefined | false | true

whether to include expired claims. Defaults to true

scope?

-

size?

BigNumber

-

start?

BigNumber

-

target?

Identity for which to fetch targeting claims (optional, defaults to the signing Identity)

trustedClaimIssuers?

-


revokeClaims

Revoke claims from Identities

note required roles:

  • Customer Due Diligence Provider: if there is at least one CDD claim in the arguments

Parameters:

Name
Type

args

opts?

▸ addClaims(args: Pick‹, "claims"›, opts?: ): Promise‹‹void››

Defined in

note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and 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 on it to see whether the signing Account and Identity have the required roles and 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 on it to see whether the signing Account and Identity have the required roles and 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‹‹››

▸ getIdentitiesWithClaimsV2(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‹‹››

▸ getIssuedClaimsV2(opts: object): Promise‹‹››

Defined in

string |

Returns: Promise‹‹››

▸ getTargetingClaims(opts: object): Promise‹‹››

Defined in

string |

(string | ‹›)[]

Returns: Promise‹‹››

▸ getTargetingClaimsV2(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 on it to see whether the signing Account and Identity have the required roles and permissions to run it

Pick‹, "claims"›

Returns: Promise‹‹void››

src/Claims.ts:130
ProcedureMethod
addClaims.checkAuthorization
TransactionQueue
AddInvestorUniquenessClaimParams
ProcedureOpts
TransactionQueue
src/Claims.ts:117
ProcedureMethod
addInvestorUniquenessClaim.checkAuthorization
TransactionQueue
src/Claims.ts:143
ProcedureMethod
editClaims.checkAuthorization
TransactionQueue
ClaimData
CddClaim
src/Claims.ts:437
ClaimData
CddClaim
ClaimScope
src/Claims.ts:387
ClaimScope
ResultSet
IdentityWithClaims
src/Claims.ts:234
ResultSet
IdentityWithClaims
ResultSet
IdentityWithClaims
src/Claims.ts:302
ResultSet
IdentityWithClaims
ClaimData
InvestorUniquenessClaim
src/Claims.ts:461
ClaimData
InvestorUniquenessClaim
ResultSet
ClaimData
src/Claims.ts:169
ResultSet
ClaimData
ResultSet
ClaimData
src/Claims.ts:199
ResultSet
ClaimData
ResultSet
IdentityWithClaims
src/Claims.ts:488
ResultSet
IdentityWithClaims
ResultSet
IdentityWithClaims
src/Claims.ts:581
ResultSet
IdentityWithClaims
src/Claims.ts:156
ProcedureMethod
revokeClaims.checkAuthorization
TransactionQueue
addClaims
addInvestorUniquenessClaim
editClaims
getCddClaims
getClaimScopes
getIdentitiesWithClaims
getIdentitiesWithClaimsV2
getInvestorUniquenessClaims
getIssuedClaims
getIssuedClaimsV2
getTargetingClaims
getTargetingClaimsV2
revokeClaims
ProcedureOpts
AddInvestorUniquenessClaimParams
ProcedureOpts
ProcedureOpts
Identity
Identity
Exclude
ClaimType
InvestorUniquenessV2
Scope
Identity
Identity
Exclude
ClaimType
InvestorUniquenessV2
Scope
Identity
Identity
Identity
Identity
Identity
Scope
Identity
Identity
Scope
Identity
Identity
ProcedureOpts
ProcedureOpts
TransactionQueue
ProcedureOpts
TransactionQueue
ProcedureOpts
TransactionQueue
ModifyClaimsParams
ModifyClaimsParams
ModifyClaimsParams
ModifyClaimsParams
ModifyClaimsParams
ModifyClaimsParams