Polymesh SDK API Reference
v5.0.0
v5.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • ProposalStage
    • RoleType
    • ScopeType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • AccountData
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • HistoricSettlement
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetPercentageTransferRestrictionsParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SimpleEnumTransactionArgument
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • TaxWithholding
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenCaaRole
    • TokenDocument
    • TokenIdentifier
    • TokenOwnerRole
    • TokenPiaRole
    • TransferBreakdown
    • TransferPolyXParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • addClaims
  • addInvestorUniquenessClaim
  • editClaims
  • revokeClaims
  • Methods
  • getCddClaims
  • getClaimScopes
  • getIdentitiesWithClaims
  • getInvestorUniquenessClaims
  • getIssuedClaims
  • getTargetingClaims

Was this helpful?

  1. Classes

Claims

PreviousCheckpointsNextCompliance

Last updated 3 years ago

Was this helpful?

Handles all Claims related functionality

Hierarchy

  • Claims

Index

Properties

Methods

Properties

addClaims

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

Add an Investor Uniqueness Claim to the current Identity

param

editClaims

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

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

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)

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 current 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?

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

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 current 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?

undefined | number

-

start?

undefined | number

-

target?

identity (optional, defaults to the current 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?

undefined | number

-

start?

undefined | number

-

target?

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

trustedClaimIssuers?

-

• addClaims: ProcedureMethod‹Pick‹, "claims"›, void›

Defined in

• addInvestorUniquenessClaim: ProcedureMethod‹, void›

Defined in

• editClaims: ProcedureMethod‹Pick‹, "claims"›, void›

Defined in

• revokeClaims: ProcedureMethod‹Pick‹, "claims"›, void›

Defined in

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

src/Claims.ts:118
AddInvestorUniquenessClaimParams
src/Claims.ts:108
src/Claims.ts:129
src/Claims.ts:139
src/Claims.ts:294
ClaimScope
src/Claims.ts:244
ClaimScope
ResultSet
IdentityWithClaims
src/Claims.ts:185
ResultSet
IdentityWithClaims
src/Claims.ts:318
ResultSet
ClaimData
src/Claims.ts:150
ResultSet
ClaimData
ResultSet
IdentityWithClaims
src/Claims.ts:345
ResultSet
IdentityWithClaims
addClaims
addInvestorUniquenessClaim
editClaims
revokeClaims
getCddClaims
getClaimScopes
getIdentitiesWithClaims
getInvestorUniquenessClaims
getIssuedClaims
getTargetingClaims
Identity
Identity
Scope
Identity
Identity
Identity
Identity
Scope
Identity
Identity
ClaimData
ClaimData
ClaimData
ClaimData
ClaimType
Exclude
InvestorUniquenessV2
ModifyClaimsParams
ModifyClaimsParams
ModifyClaimsParams
CddClaim
CddClaim
InvestorUniquenessClaim
InvestorUniquenessClaim