accounts

Overview

This query gets all owned accounts info based on login session.

Special Considerations

  • You must have already created an account (locally) for this query to work.

Inputs

None.

Returns

Promise<PrivateAccount[]>

A promise containing an array of PrivateAccount's, in which every PrivateAccount contains:

PrivateAccount: {
  id: ID
  slug: string
  status: AccountStatus
  name: string
  displayName: string
  phoneCountryCode: Country
  phone: string
  addressLine1: string
  addressLine2: string
  city: string
  zoneCode: string
  postalCode: string
  currency: Currency
  accountType: accountType
  country: Country
  identificationType: string
  industry: string
  businessType: string
  businessTaxId: string
  preferredBankAccountId: string
  incorporationDocumentFilename: string
  paymentSavingTotal: float
  beneficiarySavingTotal: float
  uboInfoRequired: boolean
  redirectUrl: string
  uboInfoRequired: isUboInfoRequired && !hasUboInfoBeenUploaded
}

Example

Running this query:

query {
  accounts {
    id
    phoneCountryCode
    identificationType
  }
}

Gives us:

{
  "data": {
    "accounts": [
      {
        "id": "ckb6sbpms000o0829cvrcqjd0",
        "phoneCountryCode": "AU",
        "identificationType": "EmployerIdentificationNumber_EIN"
      }
}

Common Errors

When running this query some of the common errors encountered include:

  • "Invalid email or password. Please try again. (I-4101)"
    • Login failed.
← accountbankAccounts →