Accounts

An Account in Quiltt represents the accounting of a banking relationship. Accounts are typically associated with a Connection from a data provider like Plaid or MX, and provide access to balances, transactions and other data.

Link to this section#Schemas & Types

Link to this section#GraphQL Queries

Account queries allow you to fetch data about a specific Account or a list of Accounts associated with the Profile, or a Connection.

Link to this section#account

Looks up a Account by its ID:

query {
  account(id: "acct_12tgD1YP33AwEvbdmSrcRY") {
    id
    name
    type
    verified
    metadata
    institution {
      name
    }
    connection {
      id
      provider
    }
  }
}

{
  "data": {
    "account": {
      "id": "acct_12tgD1YP33AwEvbdmSrcRY",
      "name": "Credit Card",
      "type": "CREDIT",
      "verified": false,
      "metadata": null,
      "institution": {
        "name": "MX Bank"
      },
      "connection": {
        "id": "conn_12tgD1WgzFgsy9fqKpW9b3",
        "provider": "MX"
      }
    }
  }
}

Link to this section#accounts

Lists and filters the Accounts associated with the Profile:

query GetAccounts {
  accounts {
    id
    name
    type
    verified
    metadata
    institution {
      name
    }
  }
}

{
  "data": {
    "accounts": [
      {
        "id": "acct_12tgD1YSYYFtFGYQDz21fk",
        "name": "Savings",
        "type": "SAVINGS",
        "verified": false,
        "metadata": null,
        "institution": {
          "name": "MX Bank"
        }
      },
      {
        "id": "acct_12tErBqz5oPva4qlsZ9Po8",
        "name": "Plaid Bronze Standard 0.2% Interest CD",
        "type": "SAVINGS",
        "verified": false,
        "metadata": null,
        "institution": {
          "name": "Tartan Bank"
        }
      },
      ...
    ]
  }
}

The accounts query supports various filtering options:

Link to this section#Filter by Connection Status

Filter Accounts belonging to Connections that need to be repaired or reconnected:

query {
  accounts(filter: {connection_status: [ERROR_REPAIRABLE, DISCONNECTED]}) {
    id
    kind
    name
    connection {
      id
      status
    }
  }
}

Link to this section#Filter by Verified

Filters for verified Accounts ready for money movement:

query {
  accounts(filter: {verified: true}) {
    id
    name
    type
    verified
  }
}

Link to this section#Filter by Kind

Filters for depository and credit Accounts:

query {
  accounts(filter: {kind: [DEPOSITORY, CREDIT]}) {
    id
    name
    type
    kind
  }
}

Link to this section#GraphQL Mutations

Account mutations allow you to update an individual Account.

Link to this section#accountUpdate

Updates an Account with new metadata. This is useful for storing additional information about the Account, such as a user-friendly name:

mutation AccountUpdate {
  accountUpdate(
    input: { id: "acct_12v1nh5epXlyU8vr7QB8PJ", metadata: { nickname: "My Checking Account" } }
  ) {
    success
    record {
      id
      metadata
    }
  }
}

{
  "data": {
    "accountUpdate": {
      "success": true,
      "record": {
        "id": "acct_12v1nh5epXlyU8vr7QB8PJ",
        "metadata": {
          "nickname": "My Checking Account"
        }
      }
    }
  }
}

Link to this section#Webhooks

Link to this section#account.created

This event is fired when a new Account is registered on a Profile.

Link to this section#account.owners_verified

This event is fired when an Account's owners have been identified and become available in GraphQL.

Link to this section#account.reconnected

This event is fired when an existing Account has been associated with a new Connection. This can occur when you reconnect to an Institution you had previously connected.

Link to this section#account.verified

This event is fired when an Account becomes verified for money movement and ACH Numbers become available via the REST API.