Profile GraphQL API

The Profile GraphQL API is the primary way to interact with a specific Profile's data. If you're new to GraphQL, please see our overview guide to get started.

API Endpoints

https://api.quiltt.io/v1/graphql

Headers

Authorization: Bearer <SESSION_TOKEN>
Content-Type: application/json

Authorization

To access the Profile GraphQL API, include a Session token in the HTTP Authorization header as a Bearer token. To learn how to obtain a Session token, see the Authentication guide.

Authorization: Bearer <SESSION_TOKEN>

For server-side calls, you can also use Basic Auth by passing a Base64-encoded combination of the Profile ID and API Key secret. See the Authentication guide for more details.

Authorization: Basic <Base64-encoded profileId:API_KEY_SECRET>

Introspection

Many popular GraphQL libraries make use of GraphQL's powerful introspection system to dynamically generate typings, access documentation and more. See the the official GraphQL documentation to learn more.

The introspection system is available out of the box for all authenticated requests. If you need to access introspection outside the context of a particular Profile - say during a build task - you can provide your API Key secret as a Bearer token:

Authorization: Bearer <API_KEY_SECRET>

Queries

`account`

Description

Look up an Account by its ID.

Response

Returns an Account

Arguments

Name	Description
`id` - `ID!`	The ID of the Account.

Example

Query

query account($id: ID!) {
  account(id: $id) {
    balance {
      ...BalanceFragment
    }
    connection {
      ...ConnectionFragment
    }
    currencyCode
    id
    institution {
      ...InstitutionFragment
    }
    mask
    metadata
    name
    provider
    remoteData {
      ...AccountRemoteDataFragment
    }
    state
    transactedFirstOn
    transactedLastOn
    transactions {
      ...TransactionConnectionFragment
    }
    type
    verified
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "account": {
      "balance": Balance,
      "connection": Connection,
      "currencyCode": "USD",
      "id": "acct_12Hz9Dz7vEAuljYvhmPcvM9",
      "institution": Institution,
      "mask": 1234,
      "metadata": {"accountNickname": "My favorite checking account"},
      "name": "Super fancy checking",
      "provider": "AKOYA",
      "remoteData": AccountRemoteData,
      "state": "CLOSED",
      "transactedFirstOn": "2022-01-01",
      "transactedLastOn": "2024-01-10",
      "transactions": TransactionConnection,
      "type": "CHECKING",
      "verified": false
    }
  }
}

Queries

`accounts`

Description

Get a list of Accounts.

You can apply filters, search and sort to refine the list.

Response

Returns [Account!]

Arguments

Name	Description
`filter` - `AccountFilter`
`search` - `SearchQuery`
`sort` - `AccountSort`

Example

Query

query accounts(
  $filter: AccountFilter,
  $search: SearchQuery,
  $sort: AccountSort
) {
  accounts(
    filter: $filter,
    search: $search,
    sort: $sort
  ) {
    balance {
      ...BalanceFragment
    }
    connection {
      ...ConnectionFragment
    }
    currencyCode
    id
    institution {
      ...InstitutionFragment
    }
    mask
    metadata
    name
    provider
    remoteData {
      ...AccountRemoteDataFragment
    }
    state
    transactedFirstOn
    transactedLastOn
    transactions {
      ...TransactionConnectionFragment
    }
    type
    verified
  }
}

Variables

{
  "filter": AccountFilter,
  "search": SearchQuery,
  "sort": "LAST_TRANSACTED_ON_ASC"
}

Response

{
  "data": {
    "accounts": [
      {
        "balance": Balance,
        "connection": Connection,
        "currencyCode": "USD",
        "id": "acct_12Hz9Dz7vEAuljYvhmPcvM9",
        "institution": Institution,
        "mask": 1234,
        "metadata": {"accountNickname": "My favorite checking account"},
        "name": "Super fancy checking",
        "provider": "AKOYA",
        "remoteData": AccountRemoteData,
        "state": "CLOSED",
        "transactedFirstOn": "2022-01-01",
        "transactedLastOn": "2024-01-10",
        "transactions": TransactionConnection,
        "type": "CHECKING",
        "verified": true
      }
    ]
  }
}

Queries

`connection`

Description

Look up a Connection by its ID.

Response

Returns a Connection

Arguments

Name	Description
`id` - `ID!`	The ID of the Connection.

Example

Query

query connection($id: ID!) {
  connection(id: $id) {
    accounts {
      ...AccountFragment
    }
    externallyManaged
    features
    id
    institution {
      ...InstitutionFragment
    }
    metadata
    provider
    remoteData {
      ...ConnectionRemoteDataFragment
    }
    status
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "connection": {
      "accounts": [Account],
      "externallyManaged": true,
      "features": ["ACCOUNT_NUMBERS"],
      "id": "conn_14TJiFDKRJlPiBHuukUIlXZ",
      "institution": Institution,
      "metadata": {"hiddenFromUI": true},
      "provider": "AKOYA",
      "remoteData": ConnectionRemoteData,
      "status": "DISCONNECTED"
    }
  }
}

Queries

`connections`

Description

Get a list of Connections.

You can apply filters to refine the list.

Response

Returns [Connection!]

Arguments

Name	Description
`filter` - `ConnectionFilter`

Example

Query

query connections($filter: ConnectionFilter) {
  connections(filter: $filter) {
    accounts {
      ...AccountFragment
    }
    externallyManaged
    features
    id
    institution {
      ...InstitutionFragment
    }
    metadata
    provider
    remoteData {
      ...ConnectionRemoteDataFragment
    }
    status
  }
}

Variables

{"filter": ConnectionFilter}

Response

{
  "data": {
    "connections": [
      {
        "accounts": [Account],
        "externallyManaged": false,
        "features": ["ACCOUNT_NUMBERS"],
        "id": "conn_14TJiFDKRJlPiBHuukUIlXZ",
        "institution": Institution,
        "metadata": {"hiddenFromUI": true},
        "provider": "AKOYA",
        "remoteData": ConnectionRemoteData,
        "status": "DISCONNECTED"
      }
    ]
  }
}

Queries

`profile`

Description

Access information about the authenticated Profile.

Response

Returns a Profile!

Example

Query

query profile {
  profile {
    address {
      ...ProfileAddressFragment
    }
    dateOfBirth
    email
    id
    metadata
    name
    names {
      ...ProfileNameFragment
    }
    phone
    remoteData {
      ...ProfileRemoteDataFragment
    }
    uuid
  }
}

Response

{
  "data": {
    "profile": {
      "address": ProfileAddress,
      "dateOfBirth": "2007-12-03",
      "email": "xyz789",
      "id": "p_1hyoxpVVFib1HngGwKAzIr",
      "metadata": {
        "firebaseId": "4Wz7x0QkPdNNzgRgjZ4iIzMKjXo2",
        "avatar": "https://www.gravatar.com/avatar/5658ffccee7f0ebfda2b226238b1eb6e",
        "favoriteColor": "Purple"
      },
      "name": "abc123",
      "names": ProfileName,
      "phone": "abc123",
      "remoteData": ProfileRemoteData,
      "uuid": "174ec567-2492-4498-a706-504a79437235"
    }
  }
}

Queries

`transaction`

Description

Look up a Transaction by its ID.

Response

Returns a Transaction

Arguments

Name	Description
`id` - `ID!`	The ID of the Transaction.

Example

Query

query transaction($id: ID!) {
  transaction(id: $id) {
    account {
      ...AccountFragment
    }
    amount
    currencyCode
    date
    description
    entryType
    id
    logo {
      ...ImageFragment
    }
    metadata
    provider
    remoteData {
      ...TransactionRemoteDataFragment
    }
    status
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "transaction": {
      "account": Account,
      "amount": 987.65,
      "currencyCode": "AED",
      "date": "2007-12-03",
      "description": "xyz789",
      "entryType": "CREDIT",
      "id": "txn_11VgTOO9DR1vbAZxb6zBLdb",
      "logo": Image,
      "metadata": {"userDefinedName": "My favorite transaction"},
      "provider": "AKOYA",
      "remoteData": TransactionRemoteData,
      "status": "PENDING"
    }
  }
}

Queries

`transactions`

Description

Get a paginated list of up to 100 Transactions.

You can apply filters, search and sort to refine the list.

Response

Returns a TransactionConnection!

Arguments

Name	Description
`after` - `String`	Returns the elements in the list that come after the specified cursor.
`before` - `String`	Returns the elements in the list that come before the specified cursor.
`filter` - `TransactionFilter`
`first` - `Int`	Returns the first n elements from the list.
`last` - `Int`	Returns the last n elements from the list.
`search` - `SearchQuery`
`sort` - `TransactionSort`	Default = `DATE_DESC`

Example

Query

query transactions(
  $after: String,
  $before: String,
  $filter: TransactionFilter,
  $first: Int,
  $last: Int,
  $search: SearchQuery,
  $sort: TransactionSort
) {
  transactions(
    after: $after,
    before: $before,
    filter: $filter,
    first: $first,
    last: $last,
    search: $search,
    sort: $sort
  ) {
    count
    edges {
      ...TransactionEdgeFragment
    }
    nodes {
      ...TransactionFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}

Variables

{
  "after": "abc123",
  "before": "abc123",
  "filter": TransactionFilter,
  "first": 987,
  "last": 987,
  "search": SearchQuery,
  "sort": "DATE_DESC"
}

Response

{
  "data": {
    "transactions": {
      "count": 123,
      "edges": [TransactionEdge],
      "nodes": [Transaction],
      "pageInfo": PageInfo
    }
  }
}

Mutations

`accountUpdate`

Description

Update an Account's metadata.

Response

Returns an AccountUpdatePayload

Arguments

Name	Description
`input` - `AccountUpdateInput!`	Parameters for AccountUpdate

Example

Query

mutation accountUpdate($input: AccountUpdateInput!) {
  accountUpdate(input: $input) {
    clientMutationId
    errors {
      ...ErrorFragment
    }
    record {
      ...AccountFragment
    }
    success
  }
}

Variables

{"input": AccountUpdateInput}

Response

{
  "data": {
    "accountUpdate": {
      "clientMutationId": "abc123",
      "errors": [Error],
      "record": Account,
      "success": false
    }
  }
}

Mutations

`connectionDisconnect`

Description

Disconnect a Connection.

Response

Returns a ConnectionDisconnectPayload

Arguments

Name	Description
`input` - `ConnectionDisconnectInput!`	Parameters for ConnectionDisconnect

Example

Query

mutation connectionDisconnect($input: ConnectionDisconnectInput!) {
  connectionDisconnect(input: $input) {
    clientMutationId
    errors {
      ...ErrorFragment
    }
    record {
      ...ConnectionFragment
    }
    success
  }
}

Variables

{"input": ConnectionDisconnectInput}

Response

{
  "data": {
    "connectionDisconnect": {
      "clientMutationId": "abc123",
      "errors": [Error],
      "record": Connection,
      "success": true
    }
  }
}

Mutations

`connectionPlaidImport`

Description

Import an existing Plaid Item as a Connection in Quiltt.

Response

Returns a ConnectionPlaidImportPayload

Arguments

Name	Description
`input` - `ConnectionPlaidImportInput!`	Parameters for ConnectionPlaidImport

Example

Query

mutation connectionPlaidImport($input: ConnectionPlaidImportInput!) {
  connectionPlaidImport(input: $input) {
    clientMutationId
    errors {
      ...PlaidMutationErrorFragment
    }
    record {
      ...ConnectionFragment
    }
    success
  }
}

Variables

{"input": ConnectionPlaidImportInput}

Response

{
  "data": {
    "connectionPlaidImport": {
      "clientMutationId": "xyz789",
      "errors": [PlaidMutationError],
      "record": Connection,
      "success": true
    }
  }
}

Mutations

`connectionSimulateError`

Description

Put an active Connection into a repairable error state. This allows you to simulate repairing Connection errors by passing the Connection ID to the Quiltt Connector.

Note that this mutation is not available in DEVELOPMENT or PRODUCTION environments.

Response

Returns a ConnectionSimulateErrorPayload

Arguments

Name	Description
`input` - `ConnectionSimulateErrorInput!`	Parameters for ConnectionSimulateError

Example

Query

mutation connectionSimulateError($input: ConnectionSimulateErrorInput!) {
  connectionSimulateError(input: $input) {
    clientMutationId
    errors {
      ...ErrorFragment
    }
    record {
      ...ConnectionFragment
    }
    success
  }
}

Variables

{"input": ConnectionSimulateErrorInput}

Response

{
  "data": {
    "connectionSimulateError": {
      "clientMutationId": "xyz789",
      "errors": [Error],
      "record": Connection,
      "success": true
    }
  }
}

Mutations

`connectionUpdate`

Description

Update a Connection's metadata.

Response

Returns a ConnectionUpdatePayload

Arguments

Name	Description
`input` - `ConnectionUpdateInput!`	Parameters for ConnectionUpdate

Example

Query

mutation connectionUpdate($input: ConnectionUpdateInput!) {
  connectionUpdate(input: $input) {
    clientMutationId
    errors {
      ...ErrorFragment
    }
    record {
      ...ConnectionFragment
    }
    success
  }
}

Variables

{"input": ConnectionUpdateInput}

Response

{
  "data": {
    "connectionUpdate": {
      "clientMutationId": "xyz789",
      "errors": [Error],
      "record": Connection,
      "success": false
    }
  }
}

Mutations

`connectorAkoyaClose`

Description

Create or update a Akoya-sourced Connection from a successful Akoya Connector submission.

Response

Returns a ConnectorAkoyaClosePayload

Arguments

Name	Description
`input` - `ConnectorAkoyaCloseInput!`	Parameters for ConnectorAkoyaClose

Example

Query

mutation connectorAkoyaClose($input: ConnectorAkoyaCloseInput!) {
  connectorAkoyaClose(input: $input) {
    clientMutationId
    errors {
      ...ErrorFragment
    }
    record {
      ...ConnectionFragment
    }
    success
  }
}

Variables

{"input": ConnectorAkoyaCloseInput}

Response

{
  "data": {
    "connectorAkoyaClose": {
      "clientMutationId": "abc123",
      "errors": [Error],
      "record": Connection,
      "success": false
    }
  }
}

Mutations

`connectorAkoyaInitialize`

Description

Generate a Akoya Connector token.

Response

Returns a ConnectorAkoyaInitializePayload

Arguments

Name	Description
`input` - `ConnectorAkoyaInitializeInput!`	Parameters for ConnectorAkoyaInitialize

Example

Query

mutation connectorAkoyaInitialize($input: ConnectorAkoyaInitializeInput!) {
  connectorAkoyaInitialize(input: $input) {
    clientMutationId
    errors {
      ...ErrorFragment
    }
    record {
      ...AkoyaConnectorSessionFragment
    }
    success
  }
}

Variables

{"input": ConnectorAkoyaInitializeInput}

Response

{
  "data": {
    "connectorAkoyaInitialize": {
      "clientMutationId": "abc123",
      "errors": [Error],
      "record": AkoyaConnectorSession,
      "success": true
    }
  }
}

Mutations

`connectorMockClose`

Description

Create or update a Mock-sourced Connection from a successful Mock Connector submission.

Response

Returns a ConnectorMockClosePayload

Arguments

Name	Description
`input` - `ConnectorMockCloseInput!`	Parameters for ConnectorMockClose

Example

Query

mutation connectorMockClose($input: ConnectorMockCloseInput!) {
  connectorMockClose(input: $input) {
    clientMutationId
    errors {
      ...ErrorFragment
    }
    record {
      ...ConnectionFragment
    }
    success
  }
}

Variables

{"input": ConnectorMockCloseInput}

Response

{
  "data": {
    "connectorMockClose": {
      "clientMutationId": "abc123",
      "errors": [Error],
      "record": Connection,
      "success": true
    }
  }
}

Mutations

`connectorMockInitialize`

Description

Generate a Mock Connector token.

Response

Returns a ConnectorMockInitializePayload

Arguments

Name	Description
`input` - `ConnectorMockInitializeInput!`	Parameters for ConnectorMockInitialize

Example

Query

mutation connectorMockInitialize($input: ConnectorMockInitializeInput!) {
  connectorMockInitialize(input: $input) {
    clientMutationId
    errors {
      ...ErrorFragment
    }
    record {
      ...MockConnectorSessionFragment
    }
    success
  }
}

Variables

{"input": ConnectorMockInitializeInput}

Response

{
  "data": {
    "connectorMockInitialize": {
      "clientMutationId": "xyz789",
      "errors": [Error],
      "record": MockConnectorSession,
      "success": true
    }
  }
}

Mutations

`connectorMxClose`

Description

Create or update an MX-sourced Connection from a successful MX Connect submission.

Response

Returns a ConnectorMxClosePayload

Arguments

Name	Description
`input` - `ConnectorMxCloseInput!`	Parameters for ConnectorMxClose

Example

Query

mutation connectorMxClose($input: ConnectorMxCloseInput!) {
  connectorMxClose(input: $input) {
    clientMutationId
    errors {
      ...MxMutationErrorFragment
    }
    record {
      ...ConnectionFragment
    }
    success
  }
}

Variables

{"input": ConnectorMxCloseInput}

Response

{
  "data": {
    "connectorMxClose": {
      "clientMutationId": "xyz789",
      "errors": [MxMutationError],
      "record": Connection,
      "success": false
    }
  }
}

Mutations

`connectorMxInitialize`

Description

Generate a widget URL to initialize MX Connect.

Response

Returns a ConnectorMxInitializePayload

Arguments

Name	Description
`input` - `ConnectorMxInitializeInput!`	Parameters for ConnectorMxInitialize

Example

Query

mutation connectorMxInitialize($input: ConnectorMxInitializeInput!) {
  connectorMxInitialize(input: $input) {
    clientMutationId
    errors {
      ...MxMutationErrorFragment
    }
    record {
      ...MxConnectorSessionFragment
    }
    success
  }
}

Variables

{"input": ConnectorMxInitializeInput}

Response

{
  "data": {
    "connectorMxInitialize": {
      "clientMutationId": "abc123",
      "errors": [MxMutationError],
      "record": MxConnectorSession,
      "success": true
    }
  }
}

Mutations

`connectorPlaidClose`

Description

Create or update a Plaid-sourced Connection from a successful Plaid Link submission.

Response

Returns a ConnectorPlaidClosePayload

Arguments

Name	Description
`input` - `ConnectorPlaidCloseInput!`	Parameters for ConnectorPlaidClose

Example

Query

mutation connectorPlaidClose($input: ConnectorPlaidCloseInput!) {
  connectorPlaidClose(input: $input) {
    clientMutationId
    errors {
      ...PlaidMutationErrorFragment
    }
    record {
      ...ConnectionFragment
    }
    success
  }
}

Variables

{"input": ConnectorPlaidCloseInput}

Response

{
  "data": {
    "connectorPlaidClose": {
      "clientMutationId": "xyz789",
      "errors": [PlaidMutationError],
      "record": Connection,
      "success": false
    }
  }
}

Mutations

`connectorPlaidInitialize`

Description

Generate a Plaid Link token to initialize Plaid Link.

Response

Returns a ConnectorPlaidInitializePayload

Arguments

Name	Description
`input` - `ConnectorPlaidInitializeInput!`	Parameters for ConnectorPlaidInitialize

Example

Query

mutation connectorPlaidInitialize($input: ConnectorPlaidInitializeInput!) {
  connectorPlaidInitialize(input: $input) {
    clientMutationId
    errors {
      ...PlaidMutationErrorFragment
    }
    record {
      ...PlaidConnectorSessionFragment
    }
    success
  }
}

Variables

{"input": ConnectorPlaidInitializeInput}

Response

{
  "data": {
    "connectorPlaidInitialize": {
      "clientMutationId": "xyz789",
      "errors": [PlaidMutationError],
      "record": PlaidConnectorSession,
      "success": true
    }
  }
}

Mutations

`connectorUpgrade`

Description

Attempt to upgrade a Connection.

Response

Returns a ConnectorUpgradePayload

Arguments

Name	Description
`input` - `ConnectorUpgradeInput!`	Parameters for ConnectorUpgrade

Example

Query

mutation connectorUpgrade($input: ConnectorUpgradeInput!) {
  connectorUpgrade(input: $input) {
    clientMutationId
    errors {
      ...ErrorFragment
    }
    record {
      ...ConnectorUpgradeFragment
    }
    success
  }
}

Variables

{"input": ConnectorUpgradeInput}

Response

{
  "data": {
    "connectorUpgrade": {
      "clientMutationId": "abc123",
      "errors": [Error],
      "record": ConnectorUpgrade,
      "success": true
    }
  }
}

Mutations

`profileUpdate`

Description

Update Profile information.

Response

Returns a ProfileUpdatePayload

Arguments

Name	Description
`input` - `ProfileUpdateInput!`	Parameters for ProfileUpdate

Example

Query

mutation profileUpdate($input: ProfileUpdateInput!) {
  profileUpdate(input: $input) {
    clientMutationId
    errors {
      ...ErrorFragment
    }
    record {
      ...ProfileFragment
    }
    success
  }
}

Variables

{"input": ProfileUpdateInput}

Response

{
  "data": {
    "profileUpdate": {
      "clientMutationId": "abc123",
      "errors": [Error],
      "record": Profile,
      "success": false
    }
  }
}

Mutations

`transactionUpdate`

Description

Update a transaction's metadata.

Response

Returns a TransactionUpdatePayload

Arguments

Name	Description
`input` - `TransactionUpdateInput!`	Parameters for TransactionUpdate

Example

Query

mutation transactionUpdate($input: TransactionUpdateInput!) {
  transactionUpdate(input: $input) {
    clientMutationId
    errors {
      ...ErrorFragment
    }
    record {
      ...TransactionFragment
    }
    success
  }
}

Variables

{"input": TransactionUpdateInput}

Response

{
  "data": {
    "transactionUpdate": {
      "clientMutationId": "xyz789",
      "errors": [Error],
      "record": Transaction,
      "success": false
    }
  }
}

Subscriptions

`accountVerified`

Description

An Account was verified for money movement.

Response

Returns an AccountVerifiedPayload!

Arguments

Name	Description
`accountId` - `ID`	The ID of the Account.

Example

Query

subscription accountVerified($accountId: ID) {
  accountVerified(accountId: $accountId) {
    account {
      ...AccountFragment
    }
  }
}

Variables

{"accountId": "4"}

Response

{"data": {"accountVerified": {"account": Account}}}

Subscriptions

`connectionCreated`

Description

A Connection was created.

Response

Returns a ConnectionCreatedPayload!

Example

Query

subscription connectionCreated {
  connectionCreated {
    connection {
      ...ConnectionFragment
    }
  }
}

Response

{
  "data": {
    "connectionCreated": {"connection": Connection}
  }
}

Subscriptions

`connectionUpdated`

Description

A Connection was updated.

Response

Returns a ConnectionUpdatedPayload!

Arguments

Name	Description
`connectionId` - `ID`	The ID of the Connection.

Example

Query

subscription connectionUpdated($connectionId: ID) {
  connectionUpdated(connectionId: $connectionId) {
    connection {
      ...ConnectionFragment
    }
  }
}

Variables

{"connectionId": 4}

Response

{
  "data": {
    "connectionUpdated": {"connection": Connection}
  }
}

Types

Account

Description

An Account represents the accounting of a banking relationship.

Fields

Field Name	Description
`balance` - `Balance`	The most recent Balance for the Account.
`connection` - `Connection`	The primary Connection for this Account.
`currencyCode` - `CurrencyCode`	The ISO-4217 currency code of the Account
`id` - `ID!`	The ID of the Account.
`institution` - `Institution!`	The Institution where the Account is held.
`mask` - `String`	A mostly unique identifier, typically the last 4 numbers of the Account.
`metadata` - `JSON`	Custom metadata about the Account, stored in a 'key-value' format. See the Custom Metadata guide for more information and examples.
`name` - `String!`	The Name of the Account
`provider` - `ConnectionProvider!`	The original provider of the Account.
`remoteData` - `AccountRemoteData`	The Remote Data associated with the Account. See the Remote Data guide for more information.
`state` - `AccountState!`	The State of the Account
`transactedFirstOn` - `Date`	The date of the earliest known Transaction.
`transactedLastOn` - `Date`	The date of the most recent known Transaction.
`transactions` - `TransactionConnection!`	A paginated list of Transactions.
Arguments `after` - `String` Returns the elements in the list that come after the specified cursor. `before` - `String` Returns the elements in the list that come before the specified cursor. `filter` - `TransactionFilter` `first` - `Int` Returns the first n elements from the list. `last` - `Int` Returns the last n elements from the list. `search` - `SearchQuery` `sort` - `TransactionSort`
`type` - `AccountType!`	Represents the classification of an Account.
`verified` - `Boolean!`	Specifies whether the Account has been verified for money movement.

Example

{
  "balance": Balance,
  "connection": Connection,
  "currencyCode": "USD",
  "id": "acct_12Hz9Dz7vEAuljYvhmPcvM9",
  "institution": Institution,
  "mask": 1234,
  "metadata": {"accountNickname": "My favorite checking account"},
  "name": "Super fancy checking",
  "provider": "AKOYA",
  "remoteData": AccountRemoteData,
  "state": "CLOSED",
  "transactedFirstOn": "2022-01-01",
  "transactedLastOn": "2024-01-10",
  "transactions": TransactionConnection,
  "type": "CHECKING",
  "verified": true
}

Input Field	Description
`metadata` - `JSON`	Filter by the contents of Account `metadata`.
`remoteData` - `AccountRemoteDataFilter`	Specifies the Remote Data of the Account.
`transactedFirstOn` - `Date`	The date of the earliest known Transaction.
`transactedFirstOn_gt` - `Date`	Greater than the date of the earliest known Transaction.
`transactedFirstOn_gte` - `Date`	Greater than or equal to the date of the earliest known Transaction.
`transactedFirstOn_lt` - `Date`	Less than the date of the earliest known Transaction.
`transactedFirstOn_lte` - `Date`	Less than or equal to the date of the earliest known Transaction.
`transactedLastOn` - `Date`	The date of the most recent known Transaction.
`transactedLastOn_gt` - `Date`	Greater than the date of the most recent known Transaction.
`transactedLastOn_gte` - `Date`	Greater than or equal to the date of the most recent known Transaction.
`transactedLastOn_lt` - `Date`	Less than the date of the most recent known Transaction.
`transactedLastOn_lte` - `Date`	Less than or equal to the date of the most recent known Transaction.
`type` - `[AccountType!]`	The Account classifications to include, supplied as an array or a single value.
`type_not` - `[AccountType!]`	The Account classifications to exclude, supplied as an array or a single value.
`verified` - `Boolean`	Filter by whether Accounts have been verified for money movement.

Field Name	Description
`mock` - `AccountRemoteDataMock`	The Mock remote data associated with the Account.
`mx` - `AccountRemoteDataMx`	The MX remote data associated with the Account.
`plaid` - `AccountRemoteDataPlaid`	The Plaid remote data associated with the Account.

Input Field	Description
`mock` - `AccountRemoteDataMockFilter`	Mock Account Remote Data.
`mx` - `AccountRemoteDataMxFilter`	MX Account Remote Data.
`plaid` - `AccountRemoteDataPlaidFilter`	Plaid Account Remote Data.

Field Name	Description
`response` - `MockAccount`	The response body.
`timestamp` - `DateTime!`	The date and time when the data was fetched.

Field Name	Description
`response` - `MxAccount`	The response body.
`timestamp` - `DateTime!`	The date and time when the data was fetched.

Input Field	Description
`accountNumber` - `String`	The account number associated with the account. This will typically be a masked or partial account number.
`accountOwnership` - `String`
`annuityPolicyToDate` - `String`
`annuityProvider` - `String`
`annuityTermYear` - `Float`
`apr` - `Float`	The annual percentage rate associated with the account.
`apy` - `Float`	The annual percentage yield associated with the account.
`availableBalance` - `Float`	The balance that is available for use in asset accounts like checking and savings. PENDING transactions are typically taken into account with the available balance, but this may not always be the case. available_balance will usually be a positive value for all account types, determined in the same way as the balance field.
`availableCredit` - `Float`	The amount of credit available for use in liability accounts like credit cards and lines of credit. PENDING transactions are typically taken into account with available credit, but this may not always be the case. available_credit will usually be a positive value for all account types, determined in the same way as the balance field.
`balance` - `Float`	The current balance of the account. PENDING transactions are typically not taken into account with the current balance, but this may not always be the case. This is the value used for the account balance displayed in MX UIs. The balance will usually be a positive value for all account types. Asset-type accounts (CHECKING, SAVINGS, INVESTMENT) may have a negative balance if they are in overdraft. Debt-type accounts (CREDIT_CARD, LOAN, LINE_OF_CREDIT, MORTGAGE) may have a negative balance if they are overpaid.
`cashBalance` - `Float`	The cash balance of the account.
`cashSurrenderValue` - `Float`	The sum of money paid to the policyholder or annuity holder in the event the policy is voluntarily terminated before it matures, or the insured event occurs.
`createdAt` - `String`	The date and time at which the account was created on the MX Platform.
`creditLimit` - `Float`	The credit limit associated with the account.
`currencyCode` - `String`	The three-character ISO 4217 currency code.
`dayPaymentIsDue` - `Int`	The day of the month the payment is due. For example, the 14th is passed as 14.
`deathBenefit` - `Int`	The amount paid to the beneficiary of the account upon death of the account owner.
`guid` - `String`	The unique identifier for the account. Defined by MX.
`holdingsValue` - `Float`	The sum of all long holdings within this account, not including any that are shorted and not including cash.
`id` - `String`	The unique partner-defined identifier for the account
`importedAt` - `String`	The date and time at which the account was last successfully aggregated and received data.
`institutionCode` - `String`	A unique identifier for the institution associated with this account. Defined by MX.
`insuredName` - `String`	The name of the insured individual.
`interestRate` - `Float`	The interest rate associated with the account.
`isClosed` - `Boolean`	This indicates whether an account has been closed.
`isHidden` - `Boolean`	This indicates whether the account is hidden. Defaults to `false`.
`isManual` - `Boolean`
`lastPayment` - `Float`	The date and time of the most recent payment on the account.
`lastPaymentAt` - `String`	The amount of the most recent payment on the account.
`loanAmount` - `Float`	The amount of the loan associated with the account.
`marginBalance` - `Float`
`maturesOn` - `String`	The date on which the account matures.
`memberGuid` - `String`	The unique identifier for the member associated with the account. Defined by MX.
`memberId` - `String`	The unique, partner-defined, identifier for the member associated with this account.
`memberIsManagedByUser` - `Boolean`	This indicates whether the associated member is managed by the user or the MX partner. Members created with the managed member feature will have this field set to false.
`metadata` - `String`	Additional information a partner can store on the account.
`minimumBalance` - `Float`	The minimum balance associated with the account.
`minimumPayment` - `Float`	The minimum payment required for an account. This can apply to any debt account.
`name` - `String`	The human-readable name for the account.
`nickname` - `String`	An alternate name for the account.
`originalBalance` - `Float`	The original balance associated with the account. This will always be positive.
`payOutAmount` - `Float`	The amount paid out to the insured individual or beneficiary under the conditions of the insurance policy.
`paymentDueAt` - `String`	The date and time at which the next payment is due on the account.
`payoffBalance` - `Float`	The payoff balance for a debt account. This will normally be a positive number.
`premiumAmount` - `Float`	The insurance policy’s premium amount.
`propertyType` - `String`
`routingNumber` - `String`	The routing number for the account.
`startedOn` - `String`	The date on which a debt account was started.
`subtype` - `String`	The account’s subtype, e.g., PLAN_401_K, MONEY_MARKET, or HOME_EQUITY.
`todayUglAmount` - `Float`
`todayUglPercentage` - `Float`
`totalAccountValue` - `Float`	The total value of the account.
`type` - `String`	The general or parent type of the account.
`updatedAt` - `String`	The date and time at which the account was most recently updated.
`userGuid` - `String`	The unique identifier for the user associated with the account. Defined by MX.
`userId` - `String`	The unique, partner-defined, identifier for the user associated with this account.

Field Name	Description
`response` - `PlaidAccount`	The response body.
`timestamp` - `DateTime!`	The date and time when the data was fetched.

Input Field	Description
`accountId` - `String`	Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new `account_id` will be assigned to the account. The `account_id` can also change if the `access_token` is deleted and the same credentials that were used to generate that `access_token` are used to generate a new `access_token` on a later date. In that case, the new `account_id` will be different from the old `account_id`. If an account with a specific `account_id` disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API. Like all Plaid identifiers, the `account_id` is case sensitive.
`mask` - `String`	The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.
`name` - `String`	The name of the account, either assigned by the user or by the financial institution itself
`officialName` - `String`	The official name of the account as given by the financial institution
`persistentAccountId` - `String`	A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This is currently an opt-in field and only supported for Chase Items.
`subtype` - `String`	See the Account type schema for a full listing of account types and corresponding subtypes.
`type` - `String`	`investment:` Investment account. In API versions 2018-05-22 and earlier, this type is called `brokerage` instead. `credit:` Credit card `depository:` Depository account `loan:` Loan account `other:` Non-specified account type See the Account type schema for a full listing of account types and corresponding subtypes.
`verificationStatus` - `String`	The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only. `pending_automatic_verification`: The Item is pending automatic verification `pending_manual_verification`: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the two amounts. `automatically_verified`: The Item has successfully been automatically verified `manually_verified`: The Item has successfully been manually verified `verification_expired`: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link. `verification_failed`: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.

Enum Value	Description
`LAST_TRANSACTED_ON_ASC`	Oldest First, Pending Last.
`LAST_TRANSACTED_ON_DESC`	Newest First, Pending First.

Enum Value	Description
`CHECKING`	Checking and cash management.
`CREDIT`	Credit cards.
`INVESTMENT`	Brokerage, retirement and other investments.
`LOAN`	Lines of credit, mortgage, student and installment loans.
`OTHER`	All other Account types.
`SAVINGS`	Savings and money market.

Enum Value	Description
`CLOSED`	Terminated
`OPEN`	Open

Input Field	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`id` - `ID!`	The ID of the Account to be updated.
`metadata` - `JSON`	Customizable metadata.

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[Error!]`	List of errors from an unsuccessful mutation.
`record` - `Account`	The updated Account.
`success` - `Boolean!`	Specifies whether the mutation was successful.

Field Name	Description
`connectorStatus` - `ConnectorStatus!`	The status of the Akoya Connector Session.
`connectorToken` - `String`	The unique token for the Akoya Connector Session.
`url` - `String`	OAuth Flow URL.

Field Name	Description
`at` - `DateTime!`	The timestamp of the Account Balance record.
`available` - `Float`	The amount of funds accounting for pending Transactions.
`current` - `Float`	The amount of funds based on posted Transactions.
`id` - `ID!`	The ID of the Balance.
`limit` - `Float`	The amount of funds that may be overdraft or spent on credit.

Field Name	Description
`accounts` - `[Account!]!`	A list of Accounts.
Arguments `filter` - `AccountFilter` `search` - `SearchQuery` `sort` - `AccountSort`
`externallyManaged` - `Boolean!`	Specifies whether this Connection is managed by an external system.
`features` - `[ConnectionFeature!]!`	The features currently enabled on the Connection.
`id` - `ID!`	The ID of the Connection.
`institution` - `Institution!`	The Institution of the Connection.
`metadata` - `JSON`	Custom metadata about the Connection, stored in a 'key-value' format. See the Custom Metadata guide for more information and examples.
`provider` - `ConnectionProvider!`	Represents a data provider for the Connection.
`remoteData` - `ConnectionRemoteData`	The Remote Data associated with the Connection. See the Remote Data guide for more information.
`status` - `ConnectionStatus!`	The status of the Connection.

Enum Value	Description
`ACCOUNT_NUMBERS`	Verify account numbers to support money movement operations. With this feature enabled, eligible accounts will be enabled for the Account Numbers and Processor Tokens endpoints.
`ACCOUNT_OWNERS`	Verify account-holder information. With this feature enabled, account-holder information will become available in Remote Data.
`BALANCES`	Access Balance data.
`INVESTMENTS`	Access to Investments account data, this may be included by default or incure additional costs depending on the provider.
`LIABILITIES`	Access to Liabilities account data, this may be included by default or incure additional costs depending on the provider.
`TRANSACTIONS`	Access up to 24 months of transaction history, depending on the provider. Note that for MX, full history is a "premium" feature that incurs a one-time per-Connection fee. Contact Quiltt support to enable this capability.

Input Field	Description
`metadata` - `JSON`	Filter by the contents of Connection `metadata`.
`provider` - `[ConnectionProvider!]`
`remoteData` - `ConnectionRemoteDataFilter`	Specifies the Remote Data of the Connection.
`status` - `[ConnectionStatus!]`	The Connection statuses to include.
`status_not` - `[ConnectionStatus!]`	The Connection statuses to exclude.

Input Field	Description
`accessToken` - `String!`	The `access_token` of the Plaid Item to be imported.
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`externallyManaged` - `Boolean`	Specifies whether the Connection will be managed by an external system. Default = `false`

Field Name	Description
`clientMutationId` - `String`	A unique identifier for the client performing the mutation.
`errors` - `[PlaidMutationError!]`	A list of Plaid API errors from the mutation.
`record` - `Connection`	The imported Connection.
`success` - `Boolean!`	Specifies whether the mutation was successful.

Enum Value	Description
`AKOYA`	Akoya
`DISCONNECTED`	Disconnected
`MOCK`	Mock data
`MX`	MX
`PLAID`	Plaid

Field Name	Description
`mock` - `ConnectionRemoteDataMock`	The Mock remote data associated with the Connection.
`mx` - `ConnectionRemoteDataMx`	The MX remote data associated with the Connection.
`plaid` - `ConnectionRemoteDataPlaid`	The Plaid remote data associated with the Connection.

Input Field	Description
`mock` - `ConnectionRemoteDataMockFilter`	Mock Connection Remote Data.
`mx` - `ConnectionRemoteDataMxFilter`	MX Member Remote Data.
`plaid` - `ConnectionRemoteDataPlaidFilter`	Plaid Item Remote Data.

Field Name	Description
`response` - `MockConnection`	The response body.
`timestamp` - `DateTime!`	The date and time when the data was fetched.

Field Name	Description
`accountOwners` - `ConnectionRemoteDataMxAccountOwners`	The Account Owners data from MX.
`connection` - `ConnectionRemoteDataMxConnection`	The base Connection data from MX.

Field Name	Description
`response` - `[MxAccountOwner!]`	The response body.
`timestamp` - `DateTime!`	The date and time when the data was fetched.

Field Name	Description
`response` - `MxConnection`	The response body.
`timestamp` - `DateTime!`	The date and time when the data was fetched.

Input Field	Description
`aggregatedAt` - `String`	The date and time the most recent aggregation-type job was started, given in ISO 8601 format with a time component. A job will automatically be started when a member is created or its credentials are updated, unless the `skip_aggregation` parameter is used. Jobs can also be started via manual aggregations, background aggregations, API endpoints, or when opening an MX widget. A job can be a normal aggregation, or a premium job such as identification, verification, fetching statements, or fetching an extended transaction history.
`backgroundAggregationIsDisabled` - `Boolean`	This indicates whether background aggregation is disabled for the member.
`connectionStatus` - `String`	This indicates the state of a member’s aggregation. See member connection statuses for more information.
`guid` - `String`	The unique identifier for the member. Defined by MX.
`id` - `String`	The partner-defined unique identifier for the member.
`institutionCode` - `String`	The unique identifier for the institution associated with the member. Defined by MX.
`isBeingAggregated` - `Boolean`	This indicates whether the member was being aggregated at the time of the request.
`isManagedByUser` - `Boolean`	This indicates whether the member is managed by the user or the MX partner. Members created with the managed member feature will have this field set to false.
`isOauth` - `Boolean`	This indicates whether the member uses OAuth to authenticate. Defaults to `false`.
`metadata` - `String`	Additional information you can store on this member.
`name` - `String`	The name of the member.
`oauthWindowUri` - `String`
`successfullyAggregatedAt` - `String`	The date and time the member was last successfully aggregated.
`userGuid` - `String`	The unique identifier for the user associated with the member. Defined by MX.
`userId` - `String`	The unique partner-defined identifier for the user associated with the member.

Field Name	Description
`accountOwners` - `ConnectionRemoteDataPlaidAccountOwners`	The Account Owners data from Plaid.
`connection` - `ConnectionRemoteDataPlaidConnection`	The base Connection data from Plaid.
`investments` - `ConnectionRemoteDataPlaidInvestments`	The Investments data from Plaid.
`liabilities` - `ConnectionRemoteDataPlaidLiabilities`	The Liabilities data from Plaid.

Field Name	Description
`response` - `[PlaidAccountIdentity!]`	The response body.
`timestamp` - `DateTime!`	The date and time when the data was fetched.

Field Name	Description
`response` - `PlaidConnection`	The response body.
`timestamp` - `DateTime!`	The date and time when the data was fetched.