Identities
Handles all Identity related functionality
Hierarchy
Identities
Index
Methods
Methods
createPortfolio
▸ createPortfolio(args: object, opts?: ProcedureOpts): Promise‹TransactionQueue‹NumberedPortfolio››
Defined in src/Identities.ts:61
Create a new Portfolio under the ownership of the signing Identity
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
Parameters:
▪ args: object
name
string
▪Optional opts: ProcedureOpts
Returns: Promise‹TransactionQueue‹NumberedPortfolio››
getIdentity
▸ getIdentity(args: object): Promise‹Identity›
Defined in src/Identities.ts:70
Create an Identity instance from a DID
throws if there is no Identity with the passed DID
Parameters:
▪ args: object
did
string
Returns: Promise‹Identity›
isIdentityValid
▸ isIdentityValid(args: object): Promise‹boolean›
Defined in src/Identities.ts:77
Return whether the supplied Identity/DID exists
Parameters:
▪ args: object
identity
Identity | string
Returns: Promise‹boolean›
registerIdentity
▸ registerIdentity(args: RegisterIdentityParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹Identity››
Defined in src/Identities.ts:51
Register an Identity
note 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
Parameters:
opts?
Returns: Promise‹TransactionQueue‹Identity››
Last updated
Was this helpful?