Class: Identities
api/client/Identities.Identities
Handles all Identity related functionality
Methods
attestPrimaryKeyRotation
▸ attestPrimaryKeyRotation(args, opts?): Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>
Get CDD Provider's attestation to change primary key
Parameters
| Name | Type |
|---|---|
args | AttestPrimaryKeyRotationParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>
Note
the transaction signer must be a CDD provider
Note
this creates an Authorization Requests which have to be accepted by the targetAccount along with the authorization for RotatingPrimaryKey.
An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived.
Also, an Account or Identity can directly fetch the details of an Authorization Request by calling authorizations.getOne
Note
required role:
- Customer Due Diligence Provider
Note
this method is of type ProcedureMethod, which means you can call attestPrimaryKeyRotation.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
createChild
▸ createChild(args, opts?): Promise<GenericPolymeshTransaction<ChildIdentity, ChildIdentity>>
Creates a child identity and makes the secondaryKey as the primary key of the child identity
Parameters
| Name | Type |
|---|---|
args | CreateChildIdentityParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<ChildIdentity, ChildIdentity>>
Note
the given secondaryKey is removed as secondary key from the signing Identity
Throws
if
- the transaction signer is not the primary account of which the
secondaryKeyis a secondary key - the
secondaryKeycan't be unlinked (can happen when it's part of a multisig with some balance) - the signing account is not a primary key
- the signing Identity is already a child of some other identity
Note
this method is of type ProcedureMethod, which means you can call createChild.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
createPortfolio
▸ createPortfolio(args, opts?): Promise<GenericPolymeshTransaction<NumberedPortfolio[], NumberedPortfolio>>
Create a new Portfolio under the ownership of the signing Identity
Parameters
| Name | Type |
|---|---|
args | Object |
args.name | string |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<NumberedPortfolio[], NumberedPortfolio>>
Note
this method is of type ProcedureMethod, which means you can call createPortfolio.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
createPortfolios
▸ createPortfolios(args, opts?): Promise<GenericPolymeshTransaction<NumberedPortfolio[], NumberedPortfolio[]>>
Creates a set of new Portfolios under the ownership of the signing Identity
Parameters
| Name | Type |
|---|---|
args | Object |
args.names | string[] |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<NumberedPortfolio[], NumberedPortfolio[]>>
Note
this method is of type ProcedureMethod, which means you can call createPortfolios.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
getChildIdentity
▸ getChildIdentity(args): Promise<ChildIdentity>
Create a ChildIdentity instance from a DID
Parameters
| Name | Type |
|---|---|
args | Object |
args.did | string |
Returns
Promise<ChildIdentity>
Throws
if there is no ChildIdentity with the passed DID
Defined in
getIdentity
▸ getIdentity(args): Promise<Identity>
Create an Identity instance from a DID
Parameters
| Name | Type |
|---|---|
args | Object |
args.did | string |
Returns
Promise<Identity>
Throws
if there is no Identity with the passed DID
Defined in
isIdentityValid
▸ isIdentityValid(args): Promise<boolean>
Return whether the supplied Identity/DID exists
Parameters
| Name | Type |
|---|---|
args | Object |
args.identity | string | Identity |
Returns
Promise<boolean>
Defined in
registerIdentity
▸ registerIdentity(args, opts?): Promise<GenericPolymeshTransaction<Identity, Identity>>
Register an Identity, possibly with a CDD claim
Parameters
| Name | Type |
|---|---|
args | RegisterIdentityParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<Identity, Identity>>
Note
the transaction signer must be a CDD provider
Note
this may create Authorization Requests which have to be accepted by the targetAccount.
An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived.
Also, an Account or Identity can directly fetch the details of an Authorization Request by calling authorizations.getOne
Note
required role:
- Customer Due Diligence Provider
Note
this method is of type ProcedureMethod, which means you can call registerIdentity.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
rotatePrimaryKey
▸ rotatePrimaryKey(args, opts?): Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>
Creates an Authorization to rotate primary key of the signing Identity by the targetAccount
Parameters
| Name | Type |
|---|---|
args | RotatePrimaryKeyParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>
Note
this creates an Authorization Requests which have to be accepted by the targetAccount along with the optional CDD authorization generated by CDD provider attesting the rotation of primary key
An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived.
Also, an Account or Identity can directly fetch the details of an Authorization Request by calling authorizations.getOne
Note
this method is of type ProcedureMethod, which means you can call rotatePrimaryKey.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it