Polymesh SDK API Reference
v3.0.0
v3.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Claims
    • Compliance
    • Context
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • SecurityToken
    • Settlements
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • ProposalStage
    • RoleType
    • ScopeType
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferStatus
    • VenueType
  • Interfaces
    • AccountBalance
    • AccountData
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • ArrayTransactionArgument
    • CddProviderRole
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • Leg
    • MiddlewareConfig
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RegisterIdentityParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • Scope
    • SecondaryKey
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCustodianParams
    • SetTokenDocumentsParams
    • SimpleEnumTransactionArgument
    • TickerOwnerRole
    • TickerReservationDetails
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenDocument
    • TokenHolderOptions
    • TokenHolderProperties
    • TokenIdentifier
    • TokenOwnerRole
    • TransferPolyXParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Methods
  • Methods
  • addClaims
  • addInvestorUniquenessClaim
  • editClaims
  • getCddClaims
  • getClaimScopes
  • getIdentitiesWithClaims
  • getIssuedClaims
  • getTargetingClaims
  • revokeClaims

Was this helpful?

  1. Classes

Claims

PreviousAuthorizationsNextCompliance

Last updated 4 years ago

Was this helpful?

Handles all Claims related functionality

Hierarchy

  • Claims

Index

Methods

Methods

addClaims

Add claims to Identities

Parameters:

Name

Type

args

addInvestorUniquenessClaim

Add an Investor Uniqueness Claim to the current Identity

Parameters:

Name

Type

Description

args

AddInvestorUniquenessClaimParams

editClaims

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

getCddClaims

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)

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

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)

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

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

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?

-

revokeClaims

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

src/Claims.ts:59
TransactionQueue
TransactionQueue
src/Claims.ts:48
TransactionQueue
src/Claims.ts:68
TransactionQueue
ResultSet
ClaimData
src/Claims.ts:230
ResultSet
ClaimData
ClaimScope
src/Claims.ts:192
ClaimScope
ResultSet
IdentityWithClaims
src/Claims.ts:129
ResultSet
IdentityWithClaims
ResultSet
ClaimData
src/Claims.ts:92
ResultSet
ClaimData
ResultSet
IdentityWithClaims
src/Claims.ts:263
ResultSet
IdentityWithClaims
src/Claims.ts:77
TransactionQueue
addClaims
addInvestorUniquenessClaim
editClaims
getCddClaims
getClaimScopes
getIdentitiesWithClaims
getIssuedClaims
getTargetingClaims
revokeClaims
Identity
Identity
ClaimType
Scope
Identity
Identity
Identity
Scope
Identity
Identity
TransactionQueue
TransactionQueue
TransactionQueue
ModifyClaimsParams
ModifyClaimsParams
ModifyClaimsParams
ModifyClaimsParams
ModifyClaimsParams
ModifyClaimsParams