account

Overview

This query gets the information for an owned account from the current login session.

Special Considerations

  • Ubo data is required if it's a business account and the country requires it.
  • You must have already created an account (locally) for this query to work (you don't specify the userID, rather, the query fetches the account on record for the current login sesssion).

Inputs

None.

Returns

Promise<PrivateAccount>

A promise containing the following object / data:

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 {
  account {
    id
    slug
    status
    name
    displayName
    phoneCountryCode
    phone
    addressLine1
    addressLine2
    city
    zoneCode
    postalCode
    currency
    accountType
    country
    identificationType
    industry
    businessType
    businessTaxId
    preferredBankAccountId
    incorporationDocumentFilename
    paymentSavingTotal
    beneficiarySavingTotal
    uboInfoRequired
    redirectUrl
  }

}

Gives us:

{
    "data": {
        "account": {
          "id": "ckb6sbpms000o0829cvrcqjd0",
          "slug": null,
          "status": "NOT_SETUP",
          "name": null,
          "displayName": null,
          "phoneCountryCode": null,
          "phone": null,
          "addressLine1": null,
          "addressLine2": null,
          "city": null,
          "zoneCode": null,
          "postalCode": null,
          "currency": "USD",
          "accountType": "PERSONAL",
          "country": "US",
          "identificationType": null,
          "industry": null,
          "businessType": null,
          "businessTaxId": null,
          "preferredBankAccountId": null,
          "incorporationDocumentFilename": null,
          "paymentSavingTotal": null,
          "beneficiarySavingTotal": null,
          "uboInfoRequired": false,
          "redirectUrl": null
        }
    }
}

Common Errors

N/A

← Previousaccounts →