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
  • createPortfolio
  • getIdentity
  • isIdentityValid
  • registerIdentity

Was this helpful?

  1. Classes

Identities

PreviousEntityNextIdentity

Last updated 2 years ago

Was this helpful?

Handles all Identity related functionality

Hierarchy

  • Identities

Index

Methods

Methods

createPortfolio

▸ createPortfolio(args: object, opts?: ): Promise‹‹››

Defined in

Create a new Portfolio under the ownership of the signing Identity

Parameters:

▪ args: object

Name
Type

name

string


getIdentity

Create an Identity instance from a DID

throws if there is no Identity with the passed DID

Parameters:

▪ args: object

Name
Type

did

string


isIdentityValid

▸ isIdentityValid(args: object): Promise‹boolean›

Return whether the supplied Identity/DID exists

Parameters:

▪ args: object

Name
Type

identity

Returns: Promise‹boolean›


registerIdentity

Register an Identity

note must be a CDD provider

note required role:

  • Customer Due Diligence Provider

Parameters:

Name
Type

args

opts?

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

▪Optional opts:

Returns: Promise‹‹››

▸ getIdentity(args: object): Promise‹›

Defined in

Returns: Promise‹›

Defined in

| string

▸ registerIdentity(args: , opts?: ): Promise‹‹››

Defined in

note this may create which have to be accepted by the targetAccount. An or can fetch its pending Authorization Requests by calling . Also, an Account or Identity can directly fetch the details of an Authorization Request by calling

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

ProcedureMethod
createPortfolio.checkAuthorization
ProcedureOpts
TransactionQueue
NumberedPortfolio
Identity
src/Identities.ts:70
Identity
src/Identities.ts:77
RegisterIdentityParams
ProcedureOpts
TransactionQueue
Identity
src/Identities.ts:51
ProcedureMethod
registerIdentity.checkAuthorization
TransactionQueue
Identity
ProcedureOpts
TransactionQueue
NumberedPortfolio
src/Identities.ts:61
createPortfolio
getIdentity
isIdentityValid
registerIdentity
Identity
RegisterIdentityParams
ProcedureOpts
Authorization Requests
Account
Identity
authorizations.getReceived
authorizations.getOne