User | ZumoKit

User instance, obtained via ZumoKit.signIn method, provides methods for managing user wallet and accounts.

Refer to Manage User Wallet, Create Fiat Account, View User Accounts and Get Account Data guides for usage details.

Hierarchy

User

Properties

accounts

accounts: Array<Account>

User accounts.

hasWallet

hasWallet: boolean

Indicator if user has wallet.

id

id: string

User identifier.

Methods

addAccountDataListener

addAccountDataListener(listener: (snapshots: Array<AccountDataSnapshot>) => void): void

- Defined in src/User.ts:334
Listen to all account data changes.

Parameters
- listener: (snapshots: Array<AccountDataSnapshot>) => void
  
  interface to listen to user changes
  - - (snapshots: Array<AccountDataSnapshot>): void
    - Parameters
      - snapshots: Array<AccountDataSnapshot>
      Returns void
Returns void

createCard

createCard(fiatAccountId: string, cardType: CardType, mobileNumber: string, knowledgeBase: Array<KbaAnswer>): Promise<Card>

- Defined in src/User.ts:249
Create card for a fiat account.

At least one Knowledge-Based Authentication (KBA) answers should be defined, answers are limited to 256 characters and cannot be null or empty and only one answer per question type should be provided.

Parameters
- fiatAccountId: string
  
  fiat account identifier
- cardType: CardType
  
  'VIRTUAL' or 'PHYSICAL'
- mobileNumber: string
  
  card holder mobile number, starting with a '+', followed by the country code and then the mobile number, or null
- knowledgeBase: Array<KbaAnswer>
  
  list of KBA answers
Returns Promise<Card>

createFiatAccount

createFiatAccount(network: Network, currencyCode: CurrencyCode): Promise<Account>

- Defined in src/User.ts:210
Create fiat account on specified network and currency code. User must already be fiat customer on specified network.

Parameters
- network: Network
  
  'MAINNET' or 'TESTNET'
- currencyCode: CurrencyCode
  
  country code in ISO 4217 format, e.g. 'GBP'
Returns Promise<Account>

createWallet

createWallet(mnemonic: string, password: string): Promise<Wallet>

- Defined in src/User.ts:106
Create user wallet seeded by provided mnemonic and encrypted with user's password.

Mnemonic can be generated by Utils.generateMnemonic utility method.

Parameters
- mnemonic: string
  
  mnemonic seed phrase
- password: string
  
  user provided password
Returns Promise<Wallet>

fetchAuthenticationConfig

fetchAuthenticationConfig(): Promise<AuthenticationConfig>

- Defined in src/User.ts:234
Fetch Strong Customer Authentication (SCA) config.

Returns Promise<AuthenticationConfig>

getAccount

getAccount(currencyCode: CurrencyCode, network: Network, type: AccountType): undefined | Account

- Defined in src/User.ts:155
Get account in specific currency, on specific network, with specific type.

Parameters
- currencyCode: CurrencyCode
  
  currency code, e.g. 'BTC', 'ETH' or 'GBP'
- network: Network
  
  network type, e.g. 'MAINNET', 'TESTNET' or 'RINKEBY'
- type: AccountType
  
  account type, e.g. 'STANDARD', 'COMPATIBILITY' or 'SEGWIT'
Returns undefined | Account

getNominatedAccountFiatProperties

getNominatedAccountFiatProperties(accountId: string): Promise<null | AccountFiatProperties>

- Defined in src/User.ts:222
Get nominated account details for specified account if it exists. Refer to Create Fiat Account for explanation about nominated account.

Parameters
- accountId: string
  
  Account identifier
Returns Promise<null | AccountFiatProperties>

isFiatCustomer

isFiatCustomer(network: Network): Promise<boolean>

- Defined in src/User.ts:168
Check if user is a fiat customer on 'MAINNET' or 'TESTNET' network.

Parameters
- network: Network
  
  'MAINNET' or 'TESTNET'
Returns Promise<boolean>

isRecoveryMnemonic

isRecoveryMnemonic(mnemonic: string): Promise<boolean>

- Defined in src/User.ts:145
Check if mnemonic seed phrase corresponds to user's wallet. This is useful for validating seed phrase before trying to recover wallet.

Parameters
- mnemonic: string
  
  mnemonic seed phrase
Returns Promise<boolean>

makeFiatCustomer

makeFiatCustomer(network: Network, firstName: string, middleName: string | null, lastName: string, dateOfBirth: string, email: string, phone: string, address: Address): Promise<void>

- Defined in src/User.ts:183
Make user fiat customer on specified network by providing user's personal details.

Parameters
- network: Network
  
  'MAINNET' or 'TESTNET'
- firstName: string
  
  first name
- middleName: string | null
  
  middle name or null
- lastName: string
  
  last name
- dateOfBirth: string
  
  date of birth in ISO 8601 format, e.g '2020-08-12'
- email: string
  
  email
- phone: string
  
  phone number
- address: Address
  
  home address
Returns Promise<void>

recoverWallet

recoverWallet(mnemonic: string, password: string): Promise<Wallet>

- Defined in src/User.ts:118
Recover user wallet with mnemonic seed phrase corresponding to user's wallet. This can be used if user forgets his password or wants to change his wallet password.

Parameters
- mnemonic: string
  
  mnemonic seed phrase corresponding to user's wallet
- password: string
  
  user provided password
Returns Promise<Wallet>

removeAccountDataListener

removeAccountDataListener(listener: (snapshot: Array<AccountDataSnapshot>) => void): void

- Defined in src/User.ts:348
Remove listener to state changes.

Parameters
- listener: (snapshot: Array<AccountDataSnapshot>) => void
  
  interface to listen to state changes
  - - (snapshot: Array<AccountDataSnapshot>): void
    - Parameters
      - snapshot: Array<AccountDataSnapshot>
      Returns void
Returns void

revealCardDetails

revealCardDetails(cardId: string): Promise<CardDetails>

- Defined in src/User.ts:288
Reveals sensitive card details.

Parameters
- cardId: string
  
  card identifier
Returns Promise<CardDetails>

revealMnemonic

revealMnemonic(password: string): Promise<string>

- Defined in src/User.ts:136
Reveal mnemonic seed phrase used to seed user wallet.

Parameters
- password: string
  
  user provided password
Returns Promise<string>

revealPin

revealPin(cardId: string): Promise<number>

- Defined in src/User.ts:297
Reveal card PIN.

Parameters
- cardId: string
  
  card identifier
Returns Promise<number>

setAuthentication

setAuthentication(cardId: string, knowledgeBase: Array<KbaAnswer>): Promise<void>

- Defined in src/User.ts:322
Add KBA answers to a card without SCA.

This endpoint is used to set Knowledge-Based Authentication (KBA) answers to a card without Strong Customer Authentication (SCA). Once it is set SCA flag on corresponding card is set to true.
At least one answer should be defined, answers are limited to 256 characters and cannot be null or empty and only one answer per question type should be provided.

Parameters
- cardId: string
  
  card id
- knowledgeBase: Array<KbaAnswer>
  
  list of KBA answers
Returns Promise<void>

setCardStatus

setCardStatus(cardId: string, cardStatus: CardStatus, pan?: string | null, cvv2?: string | null): Promise<void>

- Defined in src/User.ts:275
Set card status to 'ACTIVE', 'BLOCKED' or 'CANCELLED'.
- To block card, set card status to 'BLOCKED'.
- To activate a physical card, set card status to 'ACTIVE' and provide PAN and CVC2 fields.
- To cancel a card, set card status to 'CANCELLED'.
- To unblock a card, set card status to 'ACTIVE.'.
Parameters
- cardId: string
  
  card identifier
- cardStatus: CardStatus
  
  new card status
- Default value pan: string | null = null
  
  PAN when activating a physical card, null otherwise (defaults to null)
- Default value cvv2: string | null = null
  
  CVV2 when activating a physical card, null otherwise (defaults to null)
Returns Promise<void>

unblockPin

unblockPin(cardId: string): Promise<void>

- Defined in src/User.ts:305
Unblock card PIN.

Parameters
- cardId: string
  
  card identifier
Returns Promise<void>

unlockWallet

unlockWallet(password: string): Promise<Wallet>

- Defined in src/User.ts:127
Unlock user wallet with user's password.

Parameters
- password: string
  
  user provided password
Returns Promise<Wallet>

Generated using TypeDoc

Hierarchy

Index

Properties

Methods

Properties

accounts

hasWallet

id

Methods

addAccountDataListener

Parameters

listener: (snapshots: Array<AccountDataSnapshot>) => void

Parameters

snapshots: Array<AccountDataSnapshot>

Returns void

Returns void

createCard

Parameters

fiatAccountId: string

cardType: CardType

mobileNumber: string

knowledgeBase: Array<KbaAnswer>

Returns Promise<Card>

createFiatAccount

Parameters

network: Network

currencyCode: CurrencyCode

Returns Promise<Account>

createWallet

Parameters

mnemonic: string

password: string

Returns Promise<Wallet>

fetchAuthenticationConfig

Returns Promise<AuthenticationConfig>

getAccount

Parameters

currencyCode: CurrencyCode

network: Network

type: AccountType

Returns undefined | Account

getNominatedAccountFiatProperties

Parameters

accountId: string

Returns Promise<null | AccountFiatProperties>

isFiatCustomer

Parameters

network: Network

Returns Promise<boolean>

isRecoveryMnemonic

Parameters

mnemonic: string

Returns Promise<boolean>

makeFiatCustomer

Parameters

network: Network

firstName: string

middleName: string | null

lastName: string

dateOfBirth: string

email: string

phone: string

address: Address

Returns Promise<void>

recoverWallet

Parameters

mnemonic: string

password: string

Returns Promise<Wallet>

removeAccountDataListener

Parameters

listener: (snapshot: Array<AccountDataSnapshot>) => void

Parameters

snapshot: Array<AccountDataSnapshot>

Returns void

Returns void

revealCardDetails

Parameters

cardId: string

Returns Promise<CardDetails>