accountUser

Retrieve an account user.

Arguments

detail : AccountUserDetailInput

Account user detail namespace/value pair which uniquely identifies a user.

email : String

Email associated with an account user.

externalId : ID

External ID associated with an account user.

number : ID

Kraken number associated with an account user.

Returns

AccountUserType

User objects are the core of the authentication system. They typically represent a customer who manages a portfolio of one or more accounts.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can query account user

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

query AccountUser(
  $detail: AccountUserDetailInput,
  $email: String,
  $externalId: ID,
  $number: ID
) {
  accountUser(
    detail: $detail,
    email: $email,
    externalId: $externalId,
    number: $number
  ) {
    accounts {
      ...AccountInterfaceFragment
    }
    accountUserRoles {
      ...AccountUserRoleTypeFragment
    }
    address {
      ...RichAddressTypeFragment
    }
    alternativePhoneNumbers
    businesses {
      ...BusinessConnectionTypeConnectionFragment
    }
    consents {
      ...ConsentTypeFragment
    }
    createdAt
    dateOfBirth
    details {
      ...AccountUserDetailTypeFragment
    }
    email
    externalId
    familyName
    fullName
    givenName
    hasFamilyIssues
    holdMusicChoices {
      ...TrackOptionTypeFragment
    }
    id
    isActive
    isDeceased
    isInHardship
    isOptedInToWof
    label
    landline
    liveSecretKey
    mobile
    number
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
    permissions {
      ...AccountUserPermissionFragment
    }
    portfolioIds
    portfolios {
      ...PortfolioConnectionTypeConnectionFragment
    }
    portfolioUserRoles {
      ...PortfolioUserRoleTypeFragment
    }
    preferences {
      ...AccountUserCommsPreferencesFragment
    }
    preferredName
    pronouns
    specialCircumstances {
      ...SpecialCircumstancesTypeFragment
    }
    title
  }
}

{
  "detail": AccountUserDetailInput,
  "email": "street-company-respond-between-friend",
  "externalId": "54164140",
  "number": "98129441"
}

{
  "data": {
    "accountUser": {
      "accounts": AccountInterface,
      "accountUserRoles": [AccountUserRoleType],
      "address": RichAddressType,
      "alternativePhoneNumbers": "early-quality-sea-hard-prepare",
      "businesses": BusinessConnectionTypeConnection,
      "consents": [ConsentType],
      "createdAt": "2007-07-11T13:19:53.178228+00:00",
      "dateOfBirth": "2023-01-02",
      "details": [AccountUserDetailType],
      "email": "it-human-build-major-entire",
      "externalId": "26806049",
      "familyName": "Hernandez",
      "fullName": "heavy-board-ago-avoid-consumer",
      "givenName": "Katie",
      "hasFamilyIssues": true,
      "holdMusicChoices": [TrackOptionType],
      "id": "99552943",
      "isActive": true,
      "isDeceased": true,
      "isInHardship": true,
      "isOptedInToWof": true,
      "label": "maybe-spring-truth-child-modern",
      "landline": "black-effort-less-specific-relate",
      "liveSecretKey": "society-direction-receive-yard-name",
      "mobile": "economic-institution-city-condition-production",
      "number": "away-movie-newspaper-claim-heart",
      "paymentMethods": PaymentInstructionConnectionTypeConnection,
      "permissions": [AccountUserPermission],
      "portfolioIds": "12895505",
      "portfolios": PortfolioConnectionTypeConnection,
      "portfolioUserRoles": [PortfolioUserRoleType],
      "preferences": AccountUserCommsPreferences,
      "preferredName": "message-into-some-very-right",
      "pronouns": "record-real-president-Mr-easy",
      "specialCircumstances": SpecialCircumstancesType,
      "title": "single-budget-popular-hit-nice"
    }
  }
}