Skip to main content

User

The root of any queries that require a user token.

type User implements Node {
  id: ID!
  bankAccounts(
    filter: BankAccountFilterInput
  ): [BankAccount!]!
  salaries(
    filter: SalaryFilterInput
  ): SalaryConnection
  income(
    filter: IncomeFilterInput
  ): IncomeConnection
  paymentAuthorization: PaymentAuthorization
  scopes(
    filter: ScopeFilterInput
  ): [Scope!]!
}

Fields​

User.id ● ID! non-null scalar​

User.bankAccounts ● [BankAccount!]! non-null object​

Returns the set of bank accounts that this token is authorized to access.

This field returns *all* authorized accounts

User.bankAccounts.filter ● BankAccountFilterInput input​

User.salaries ● SalaryConnection object​

A collection of different salaries the user may be earning.

Note: The initial version of this field uses a naive algorithm to determine salary values and only supports workers who have a single source of income (i.e. if they're working two jobs, the two sources of income may not be clearly grouped)

User.salaries.filter ● SalaryFilterInput input​

User.income ● IncomeConnection object​

Income is the set of transactions that increase a user's balance, excluding transactions such as inter-account transfers, and other spurious transactions. To further refine the transactions that are considered income, you may use our filtering syntax

User.income.filter ● IncomeFilterInput input​

User.paymentAuthorization ● PaymentAuthorization object​

User.scopes ● [Scope!]! non-null enum​

List of scopes granted by the user to this token

User.scopes.filter ● ScopeFilterInput input​

Interfaces​

Node interface​

An abstract datatype that has a locally unique identifier, allowing a given node to be later queried by id using the node(id: ID!) query.