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/graphqlHeaders
Authorization: Bearer <SESSION_TOKEN>
Content-Type: application/jsonAuthorization
To access the Profile GraphQL API, you can use Basic Auth or Session Tokens, passed in via the HTTP Authorization header of your request.
Basic Auth is the best approach for server-to-server API calls, using a Base64-encoded combination of the Profile ID and API Key secret. See the Basic Auth documentation for more details.
Authorization: Basic <Base64-encoded profileId:API_KEY_SECRET>
Session tokens allow client-side access to the API, and must be generated for each Profile. See the Session Tokens guide for more information.
Authorization: Bearer <SESSION_TOKEN>
Introspection
Many popular GraphQL libraries make use of GraphQL's powerful introspection system to dynamically generate typings, access documentation and more. See 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>
TypeScript
If you're using TypeScript in your project, you can leverage introspection to automatically generate typings as part of your build process. One popular approach is to use the GraphQL Codegen tool. See a tutorial on how to set up GraphQL Codegen with Quiltt here: https://www.quiltt.dev/get-started/tutorials/graphql-tooling
Queries
account
Example
Query
query account($id: ID!) {
account(id: $id) {
at
balance {
...BalanceFragment
}
connection {
...ConnectionFragment
}
currencyCode
holdings {
...AccountHoldingConnectionFragment
}
id
institution {
...InstitutionFragment
}
kind
mask
metadata
name
owners {
...AccountOwnerFragment
}
provider
remoteData {
...AccountRemoteDataFragment
}
state
statements {
...StatementConnectionFragment
}
taxonomy
transactedFirstOn
transactedLastOn
transactions {
...TransactionConnectionFragment
}
verified
}
}
Variables
{"id": "acct_12Hz9Dz7vEAuljYvhmPcvM9"}
Response
{
"data": {
"account": {
"at": "2026-01-22T14:15:22Z",
"balance": Balance,
"connection": Connection,
"currencyCode": "USD",
"holdings": AccountHoldingConnection,
"id": "acct_12Hz9Dz7vEAuljYvhmPcvM9",
"institution": Institution,
"kind": "DEPOSITORY",
"mask": "3141",
"metadata": {"accountNickname": "My favorite checking account"},
"name": "Super fancy checking",
"owners": [AccountOwner],
"provider": "MX",
"remoteData": AccountRemoteData,
"state": "OPEN",
"statements": StatementConnection,
"taxonomy": ["ASSET", "DEPOSITORY", "SPENDING"],
"transactedFirstOn": "2023-10-01",
"transactedLastOn": "2025-04-15",
"transactions": TransactionConnection,
"verified": true
}
}
}
accounts
Description
Get a list of Accounts. You can apply filters, search and sort to refine the list.
See the Accounts guide for more information and examples.
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
) {
at
balance {
...BalanceFragment
}
connection {
...ConnectionFragment
}
currencyCode
holdings {
...AccountHoldingConnectionFragment
}
id
institution {
...InstitutionFragment
}
kind
mask
metadata
name
owners {
...AccountOwnerFragment
}
provider
remoteData {
...AccountRemoteDataFragment
}
state
statements {
...StatementConnectionFragment
}
taxonomy
transactedFirstOn
transactedLastOn
transactions {
...TransactionConnectionFragment
}
verified
}
}
Variables
{
"filter": AccountFilter,
"search": SearchQuery,
"sort": "LAST_TRANSACTED_ON_ASC"
}
Response
{
"data": {
"accounts": [
{
"at": "2026-01-22T14:15:22Z",
"balance": Balance,
"connection": Connection,
"currencyCode": "USD",
"holdings": AccountHoldingConnection,
"id": "acct_12Hz9Dz7vEAuljYvhmPcvM9",
"institution": Institution,
"kind": "DEPOSITORY",
"mask": "3141",
"metadata": {"accountNickname": "My favorite checking account"},
"name": "Super fancy checking",
"owners": [AccountOwner],
"provider": "MX",
"remoteData": AccountRemoteData,
"state": "OPEN",
"statements": StatementConnection,
"taxonomy": ["ASSET", "DEPOSITORY", "SPENDING"],
"transactedFirstOn": "2023-10-01",
"transactedLastOn": "2025-04-15",
"transactions": TransactionConnection,
"verified": true
}
]
}
}
connection
Description
Look up a Connection by its ID.
See the Connections guide for more information and examples.
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
}
at
externallyManaged
id
institution {
...InstitutionFragment
}
metadata
oauth
products
provider
remoteData {
...ConnectionRemoteDataFragment
}
status
}
}
Variables
{"id": "conn_14TJiFDKRJlPiBHuukUIlXZ"}
Response
{
"data": {
"connection": {
"accounts": [Account],
"at": "2025-09-24T14:15:22Z",
"externallyManaged": false,
"id": "conn_14TJiFDKRJlPiBHuukUIlXZ",
"institution": Institution,
"metadata": {"hiddenFromUI": true},
"oauth": true,
"products": ["ACCOUNT_BALANCES_AND_TRANSACTIONS"],
"provider": "MX",
"remoteData": ConnectionRemoteData,
"status": "SYNCED"
}
}
}
connections
Description
Get a list of Connections. You can apply filters to refine the list.
See the Connections guide for more information and examples.
Response
Returns [Connection!]
Arguments
| Name | Description |
|---|---|
filter - ConnectionFilter |
Example
Query
query connections($filter: ConnectionFilter) {
connections(filter: $filter) {
accounts {
...AccountFragment
}
at
externallyManaged
id
institution {
...InstitutionFragment
}
metadata
oauth
products
provider
remoteData {
...ConnectionRemoteDataFragment
}
status
}
}
Variables
{"filter": ConnectionFilter}
Response
{
"data": {
"connections": [
{
"accounts": [Account],
"at": "2025-09-24T14:15:22Z",
"externallyManaged": false,
"id": "conn_14TJiFDKRJlPiBHuukUIlXZ",
"institution": Institution,
"metadata": {"hiddenFromUI": true},
"oauth": false,
"products": ["ACCOUNT_BALANCES_AND_TRANSACTIONS"],
"provider": "MX",
"remoteData": ConnectionRemoteData,
"status": "SYNCED"
}
]
}
}
holding
Example
Query
query holding($id: ID!) {
holding(id: $id) {
at
costBasis
id
position
price
quantity
security {
...SecurityFragment
}
value
}
}
Variables
{"id": "hld_12Hz9Dz7vEvM9AuljYvhmPc"}
Response
{
"data": {
"holding": {
"at": "2025-01-24T14:15:22Z",
"costBasis": 987.65,
"id": "hld_12Hz9Dz7vEvM9AuljYvhmPc",
"position": "LONG",
"price": 123.45,
"quantity": 987.65,
"security": Security,
"value": 987.65
}
}
}
holdings
Description
Get a paginated list of up to 100 Holdings.
See the Holdings guide and the Pagination guide for more information and examples.
Response
Returns a HoldingConnection!
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. |
first - Int | Returns the first n elements from the list. |
last - Int | Returns the last n elements from the list. |
Example
Query
query holdings(
$after: String,
$before: String,
$first: Int,
$last: Int
) {
holdings(
after: $after,
before: $before,
first: $first,
last: $last
) {
count
edges {
...HoldingEdgeFragment
}
nodes {
...HoldingFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"first": 123,
"last": 123
}
Response
{
"data": {
"holdings": {
"count": 987,
"edges": [HoldingEdge],
"nodes": [Holding],
"pageInfo": PageInfo
}
}
}
profile
Description
Access information about the authenticated Profile.
See the Profile guide for more information and examples.
Response
Returns a Profile!
Example
Query
query profile {
profile {
address {
...ProfileAddressFragment
}
at
createdAt
dateOfBirth
email
id
metadata
name
names {
...ProfileNameFragment
}
phone
remoteData {
...ProfileRemoteDataFragment
}
uuid
}
}
Response
{
"data": {
"profile": {
"address": ProfileAddress,
"at": "2026-01-22T14:15:22Z",
"createdAt": "2007-12-03T10:15:30Z",
"dateOfBirth": "2007-12-03",
"email": "name@example.com",
"id": "p_1hyoxpVVFib1HngGwKAzIr",
"metadata": {
"firebaseId": "4Wz7x0QkPdNNzgRgjZ4iIzMKjXo2",
"avatar": "https://www.gravatar.com/avatar/5658ffccee7f0ebfda2b226238b1eb6e",
"favoriteColor": "Purple"
},
"name": "Quiltty",
"names": ProfileName,
"phone": "+14155552671",
"remoteData": ProfileRemoteData,
"uuid": "174ec567-2492-4498-a706-504a79437235"
}
}
}
statement
Description
Look up a Statement by its ID.
See the Statements guide for more information and examples.
Example
Query
query statement($id: ID!) {
statement(id: $id) {
account {
...AccountFragment
}
at
endOn
id
startOn
url
}
}
Variables
{"id": "stmt_11zBVgTOO9DR1vbAZxb6Ldb"}
Response
{
"data": {
"statement": {
"account": Account,
"at": "2026-01-22T14:15:22Z",
"endOn": "2007-12-03",
"id": "stmt_11zBVgTOO9DR1vbAZxb6Ldb",
"startOn": "2007-12-03",
"url": "http://www.test.com/"
}
}
}
statements
Description
Get a paginated list of up to 100 Statements. You can apply filters and sort to refine the list.
See the Statements guide and the Pagination guide for more information and examples.
Response
Returns a StatementConnection!
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 - StatementFilter | |
first - Int | Returns the first n elements from the list. |
sort - StatementSort | Default = DATE_DESC |
Example
Query
query statements(
$after: String,
$before: String,
$filter: StatementFilter,
$first: Int,
$sort: StatementSort
) {
statements(
after: $after,
before: $before,
filter: $filter,
first: $first,
sort: $sort
) {
count
edges {
...StatementEdgeFragment
}
nodes {
...StatementFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"filter": StatementFilter,
"first": 987,
"sort": "DATE_DESC"
}
Response
{
"data": {
"statements": {
"count": 987,
"edges": [StatementEdge],
"nodes": [Statement],
"pageInfo": PageInfo
}
}
}
transaction
Description
Look up a Transaction by its ID.
See the Transactions guide for more information and examples.
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
fees
id
kind
logo {
...ImageFragment
}
metadata
price
provider
quantity
remoteData {
...TransactionRemoteDataFragment
}
security {
...SecurityFragment
}
status
}
}
Variables
{"id": "txn_11VgTOO9DR1vbAZxb6zBLdb"}
Response
{
"data": {
"transaction": {
"account": Account,
"amount": 123.45,
"currencyCode": "USD",
"date": "2007-12-03",
"description": "Chipotle Mexican Grill",
"entryType": "CREDIT",
"fees": 987.65,
"id": "txn_11VgTOO9DR1vbAZxb6zBLdb",
"kind": "DEPOSITORY",
"logo": Image,
"metadata": {"userDefinedName": "My favorite transaction"},
"price": 123.45,
"provider": "AKOYA",
"quantity": 987.65,
"remoteData": TransactionRemoteData,
"security": Security,
"status": "POSTED"
}
}
}
transactions
Description
Get a paginated list of up to 100 Transactions. You can apply filters, search and sort to refine the list.
See the Transactions guide and the Pagination guide for more information and examples.
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": "xyz789",
"before": "xyz789",
"filter": TransactionFilter,
"first": 987,
"last": 987,
"search": SearchQuery,
"sort": "DATE_DESC"
}
Response
{
"data": {
"transactions": {
"count": 987,
"edges": [TransactionEdge],
"nodes": [Transaction],
"pageInfo": PageInfo
}
}
}
Mutations
accountUpdate
Response
Returns an AccountUpdatePayload
Arguments
| Name | Description |
|---|---|
input - AccountUpdateInput! | Parameters for AccountUpdate |
Example
Query
mutation accountUpdate($input: AccountUpdateInput!) {
accountUpdate(input: $input) {
errors {
...ErrorFragment
}
record {
...AccountFragment
}
success
}
}
Variables
{"input": AccountUpdateInput}
Response
{
"data": {
"accountUpdate": {
"errors": [Error],
"record": Account,
"success": true
}
}
}
connectionDisconnect
Description
Enqueue a Connection to be disconnected. This will begin the process of disconnecting the Connection from the upstream provider and change the Connection's status. to DISCONNECTED.
See the Connections guide for more information and examples.
Response
Returns a ConnectionDisconnectPayload
Arguments
| Name | Description |
|---|---|
input - ConnectionDisconnectInput! | Parameters for ConnectionDisconnect |
Example
Query
mutation connectionDisconnect($input: ConnectionDisconnectInput!) {
connectionDisconnect(input: $input) {
record {
...ConnectionFragment
}
success
}
}
Variables
{"input": ConnectionDisconnectInput}
Response
{
"data": {
"connectionDisconnect": {
"record": Connection,
"success": true
}
}
}
connectionSimulateError
Description
Put an active Connection into a user-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 PRODUCTION environments.
See the Reconnect guide for more information and examples.
Response
Returns a ConnectionSimulateErrorPayload
Arguments
| Name | Description |
|---|---|
input - ConnectionSimulateErrorInput! | Parameters for ConnectionSimulateError |
Example
Query
mutation connectionSimulateError($input: ConnectionSimulateErrorInput!) {
connectionSimulateError(input: $input) {
errors {
...ErrorFragment
}
record {
...ConnectionFragment
}
success
}
}
Variables
{"input": ConnectionSimulateErrorInput}
Response
{
"data": {
"connectionSimulateError": {
"errors": [Error],
"record": Connection,
"success": false
}
}
}
connectionUpdate
Description
Update a Connection's metadata.
See the Connections guide for more information and examples.
Note that updating a Connection's products requires the end-user going through the Connector Reconnect flow.
Response
Returns a ConnectionUpdatePayload
Arguments
| Name | Description |
|---|---|
input - ConnectionUpdateInput! | Parameters for ConnectionUpdate |
Example
Query
mutation connectionUpdate($input: ConnectionUpdateInput!) {
connectionUpdate(input: $input) {
errors {
...ErrorFragment
}
record {
...ConnectionFragment
}
success
}
}
Variables
{"input": ConnectionUpdateInput}
Response
{
"data": {
"connectionUpdate": {
"errors": [Error],
"record": Connection,
"success": false
}
}
}
profileUpdate
Description
Update Profile information like the name, email or metadata.
See the Profiles guide for more information and examples.
Response
Returns a ProfileUpdatePayload
Arguments
| Name | Description |
|---|---|
input - ProfileUpdateInput! | Parameters for ProfileUpdate |
Example
Query
mutation profileUpdate($input: ProfileUpdateInput!) {
profileUpdate(input: $input) {
errors {
...ErrorFragment
}
record {
...ProfileFragment
}
success
}
}
Variables
{"input": ProfileUpdateInput}
Response
{
"data": {
"profileUpdate": {
"errors": [Error],
"record": Profile,
"success": true
}
}
}
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) {
errors {
...ErrorFragment
}
record {
...TransactionFragment
}
success
}
}
Variables
{"input": TransactionUpdateInput}
Response
{
"data": {
"transactionUpdate": {
"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}}}
connectionCreated
Description
A Connection was created.
Response
Returns a ConnectionCreatedPayload!
Example
Query
subscription connectionCreated {
connectionCreated {
connection {
...ConnectionFragment
}
}
}
Response
{
"data": {
"connectionCreated": {"connection": Connection}
}
}
connectionSynced
Description
A Connection was synced.
Response
Returns a ConnectionSyncedPayload!
Arguments
| Name | Description |
|---|---|
connectionId - ID | The ID of the Connection. |
Example
Query
subscription connectionSynced($connectionId: ID) {
connectionSynced(connectionId: $connectionId) {
connection {
...ConnectionFragment
}
}
}
Variables
{"connectionId": 4}
Response
{"data": {"connectionSynced": {"connection": Connection}}}
Types
Account
Description
An Account represents the accounting of a banking relationship.
Fields
| Field Name | Description |
|---|---|
at - DateTime! | The UTC date and time of the most recently known state of the Account. This typically represents the time when data was last successfully synced with the upstream provider. |
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 |
holdings - AccountHoldingConnection | Get a paginated list of up to 100 Holdings. See the Holdings guide and the Pagination guide for more information and examples. |
id - ID! | The ID of the Account. |
institution - Institution! | The Institution where the Account is held. |
kind - AccountKind | Represents the classification of an Account. Note that this enum is extensible and new values may be added over time. |
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 |
owners - [AccountOwner!] | The Account's list of Account Owners. |
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! | Represents the current state of an Account. Accounts that are marked as |
statements - StatementConnection | Get a paginated list of up to 100 Statements. You can apply filters and sort to refine the list. See the Statements guide and the Pagination guide for more information and examples. |
Arguments
| |
taxonomy - [AccountTaxonomyMember!]! | Represents the taxonomic hierarchy of an Account, as an array of Taxonomy Members.
|
transactedFirstOn - Date | The date of the earliest known Transaction. |
transactedLastOn - Date | The date of the most recent known Transaction. |
transactions - TransactionConnection! | Get a paginated list of up to 100 Transactions. You can apply filters, search and sort to refine the list. See the Transactions guide and the Pagination guide for more information and examples. |
Arguments
| |
verified - Boolean! | Specifies whether the Account has been verified for money movement. |
Example
{
"at": "2026-01-22T14:15:22Z",
"balance": Balance,
"connection": Connection,
"currencyCode": "USD",
"holdings": AccountHoldingConnection,
"id": "acct_12Hz9Dz7vEAuljYvhmPcvM9",
"institution": Institution,
"kind": "DEPOSITORY",
"mask": "3141",
"metadata": {"accountNickname": "My favorite checking account"},
"name": "Super fancy checking",
"owners": [AccountOwner],
"provider": "MX",
"remoteData": AccountRemoteData,
"state": "OPEN",
"statements": StatementConnection,
"taxonomy": ["ASSET", "DEPOSITORY", "SPENDING"],
"transactedFirstOn": "2023-10-01",
"transactedLastOn": "2025-04-15",
"transactions": TransactionConnection,
"verified": false
}
AccountFilter
Description
Options for filtering Accounts.
Fields
| Input Field | Description |
|---|---|
connection_status - [ConnectionStatus!] | Filter accounts by the status of its Connection. Examples:
|
connection_status_not - [ConnectionStatus!] | Exclude accounts by the status of its Connection. Examples:
|
kind - [AccountKind!] | The Account classifications to include, supplied as an array or a single value. |
kind_not - [AccountKind!] | The Account classifications to exclude, supplied as an array or a single value. |
metadata - JSON | Filter by the contents of Account Examples:
|
state - [AccountState!] | The Account states to include, supplied as an array or a single value. |
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. |
verified - Boolean | Filter by whether Accounts have been verified for money movement. |
Example
{
"connection_status": ["SYNCED"],
"connection_status_not": ["INITIALIZING", "SYNCING"],
"kind": ["DEPOSITORY"],
"kind_not": ["INSURANCE"],
"metadata": {},
"state": ["OPEN"],
"transactedFirstOn": "2007-12-03",
"transactedFirstOn_gt": "2007-12-03",
"transactedFirstOn_gte": "2007-12-03",
"transactedFirstOn_lt": "2007-12-03",
"transactedFirstOn_lte": "2007-12-03",
"transactedLastOn": "2007-12-03",
"transactedLastOn_gt": "2007-12-03",
"transactedLastOn_gte": "2007-12-03",
"transactedLastOn_lt": "2007-12-03",
"transactedLastOn_lte": "2007-12-03",
"verified": false
}
AccountHolding
Description
Represents an Investment Holding for an Account.
Fields
| Field Name | Description |
|---|---|
account - Account! | The Account that is holding the securities. |
at - DateTime! | The timestamp of the Holding record. |
costBasis - Float | The total original cost basis of the holding |
id - ID! | The ID of the Account Holding. |
position - HoldingPosition! | Indicates whether the holding lot position is long or short |
price - Float | The latest per-share price for the holding |
quantity - Float | The number of shares being held |
remoteData - HoldingRemoteData | The Remote Data associated with the Account Holding. See the Remote Data guide for more information. |
security - Security | The Security associated with the Investment Holding. |
value - Float | The total value of the holding |
Example
{
"account": Account,
"at": "2025-01-24T14:15:22Z",
"costBasis": 123.45,
"id": "hld_12Hz9Dz7vEvM9AuljYvhmPc",
"position": "LONG",
"price": 987.65,
"quantity": 123.45,
"remoteData": HoldingRemoteData,
"security": Security,
"value": 123.45
}
AccountHoldingConnection
Description
The connection type for AccountHolding.
Fields
| Field Name | Description |
|---|---|
count - Int! | The total number of records. |
edges - [AccountHoldingEdge] | A list of edges. |
nodes - [AccountHolding] | A list of nodes. |
pageInfo - PageInfo! | Information to aid in pagination. |
Example
{
"count": 987,
"edges": [AccountHoldingEdge],
"nodes": [AccountHolding],
"pageInfo": PageInfo
}
AccountHoldingEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String! | A cursor for use in pagination. |
node - AccountHolding | The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": AccountHolding
}
AccountKind
Description
Represents the classification of an Account.
Note that this enum is extensible and new values may be added over time.
Values
| Enum Value | Description |
|---|---|
|
| Checking, Savings and cash management. |
|
| Brokerage, retirement and other investments. |
|
| Credit cards, and Lines of Credit. |
|
| Mortgage, student and installment loans. |
|
| Term life, whole life, and other insurance policies. |
Example
"DEPOSITORY"
AccountOwner
Description
Represents the registered details of an Account Owner.
Fields
| Field Name | Description |
|---|---|
addresses - [Address!] | The registered addresses of the Account Owner. |
at - DateTime! | The UTC date and time of the most recently known state of the Account Owner. |
emails - [Email!] | The registered email addresses of the Account Owner. |
id - ID! | The ID of the Account Owner. |
names - [Name!] | The registered legal names of the Account Owner. |
phones - [Phone!] | The registered phone numbers of the Account Owner. |
remoteData - AccountOwnerRemoteData | The Remote Data associated with an Account Owner. |
Example
{
"addresses": [Address],
"at": "2026-01-22T14:15:22Z",
"emails": [Email],
"id": "12Hz9Dz7vEAuljYvhmPcvM9",
"names": [Name],
"phones": [Phone],
"remoteData": AccountOwnerRemoteData
}
AccountOwnerRemoteData
Description
Remote data associated with an Account Owner.
Fields
| Field Name | Description |
|---|---|
akoya - AccountOwnerRemoteDataAkoya | The Akoya Remote Data associated with the Account Owner. |
finicity - AccountOwnerRemoteDataFinicity | The Finicity Remote Data associated with the Account Owner. |
mock - AccountOwnerRemoteDataMock | The Mock Remote Data associated with the Account Owner. |
mx - AccountOwnerRemoteDataMx | The MX Remote Data associated with the Account Owner. |
plaid - AccountOwnerRemoteDataPlaid | The Plaid Remote Data associated with the Account Owner. |
Example
{
"akoya": AccountOwnerRemoteDataAkoya,
"finicity": AccountOwnerRemoteDataFinicity,
"mock": AccountOwnerRemoteDataMock,
"mx": AccountOwnerRemoteDataMx,
"plaid": AccountOwnerRemoteDataPlaid
}
AccountOwnerRemoteDataAkoya
Description
The Akoya Remote Data associated with the Account Owner.
Fields
| Field Name | Description |
|---|---|
owner - AccountRemoteDataAkoyaOwner | Akoya Account Owner Remote Data |
Example
{"owner": AccountRemoteDataAkoyaOwner}
AccountOwnerRemoteDataFinicity
Description
The Finicity Remote Data associated with the Account Owner.
Fields
| Field Name | Description |
|---|---|
owner - AccountRemoteDataFinicityOwner | Finicity Account Owner Remote Data |
Example
{"owner": AccountRemoteDataFinicityOwner}
AccountOwnerRemoteDataMock
Description
The Mock Remote Data associated with the Account Owner.
Fields
| Field Name | Description |
|---|---|
owner - AccountRemoteDataMockOwner | Mock Account Owner Remote Data |
Example
{"owner": AccountRemoteDataMockOwner}
AccountOwnerRemoteDataMx
Description
The MX Remote Data associated with the Account Owner.
Fields
| Field Name | Description |
|---|---|
owner - AccountRemoteDataMxOwner | MX Account Owner Remote Data |
Example
{"owner": AccountRemoteDataMxOwner}
AccountOwnerRemoteDataPlaid
Description
The Plaid Remote Data associated with the Account Owner.
Fields
| Field Name | Description |
|---|---|
owner - AccountRemoteDataPlaidOwner | Plaid Account Owner Remote Data |
Example
{"owner": AccountRemoteDataPlaidOwner}
AccountRemoteData
Description
Remote data associated with an Account.
Fields
| Field Name | Description |
|---|---|
akoya - AccountRemoteDataAkoya | The Akoya remote data associated with the Account. |
finicity - AccountRemoteDataFinicity | The Finicity remote data associated with the Account. |
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. |
Example
{
"akoya": AccountRemoteDataAkoya,
"finicity": AccountRemoteDataFinicity,
"mock": AccountRemoteDataMock,
"mx": AccountRemoteDataMx,
"plaid": AccountRemoteDataPlaid
}
AccountRemoteDataAkoya
Description
Account-level data from Akoya.
Fields
| Field Name | Description |
|---|---|
account - AccountRemoteDataAkoyaAccount | The base Account data from Akoya. |
Example
{"account": AccountRemoteDataAkoyaAccount}
AccountRemoteDataAkoyaAccount
Description
The Account data from Akoya.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Akoya ID. |
response - RemoteDataAkoyaAccount | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "abc123",
"response": RemoteDataAkoyaAccount,
"timestamp": "2025-03-24T12:25:12Z"
}
AccountRemoteDataAkoyaOwner
Description
The Owner data from Akoya.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Akoya ID. |
response - RemoteDataAkoyaAccountHolder | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "abc123",
"response": RemoteDataAkoyaAccountHolder,
"timestamp": "2025-03-24T12:25:12Z"
}
AccountRemoteDataFinicity
Description
Account-level data from Finicity.
Fields
| Field Name | Description |
|---|---|
account - AccountRemoteDataFinicityAccount | The base Account data from Finicity. |
Example
{"account": AccountRemoteDataFinicityAccount}
AccountRemoteDataFinicityAccount
Description
The Account data from Finicity.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Finicity ID. |
response - RemoteDataFinicityCustomerAccount | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "abc123",
"response": RemoteDataFinicityCustomerAccount,
"timestamp": "2025-03-24T12:25:12Z"
}
AccountRemoteDataFinicityOwner
Description
The Owner data from Finicity.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Finicity ID. |
response - RemoteDataFinicityAccountOwnerDetails | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "abc123",
"response": RemoteDataFinicityAccountOwnerDetails,
"timestamp": "2025-03-24T12:25:12Z"
}
AccountRemoteDataMock
Description
Account-level data from Mock.
Fields
| Field Name | Description |
|---|---|
account - AccountRemoteDataMockAccount | The base Account data from Mock. |
Example
{"account": AccountRemoteDataMockAccount}
AccountRemoteDataMockAccount
Description
The Account data from Mock.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Mock ID. |
response - RemoteDataMockAccount | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "abc123",
"response": RemoteDataMockAccount,
"timestamp": "2025-03-24T12:25:12Z"
}
AccountRemoteDataMockOwner
Description
The Owner data from Mock.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Mock ID. |
response - RemoteDataMockOwner | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "abc123",
"response": RemoteDataMockOwner,
"timestamp": "2025-03-24T12:25:12Z"
}
AccountRemoteDataMx
Description
Account-level data from MX.
Fields
| Field Name | Description |
|---|---|
account - AccountRemoteDataMxAccount | The base Account data from MX. |
Example
{"account": AccountRemoteDataMxAccount}
AccountRemoteDataMxAccount
Description
The Account data from Mx.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Mx ID. |
response - RemoteDataMxAccount | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "abc123",
"response": RemoteDataMxAccount,
"timestamp": "2025-03-24T12:25:12Z"
}
AccountRemoteDataMxOwner
Description
The Owner data from Mx.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Mx ID. |
response - RemoteDataMxAccountOwner | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "abc123",
"response": RemoteDataMxAccountOwner,
"timestamp": "2025-03-24T12:25:12Z"
}
AccountRemoteDataPlaid
Description
Account-level data from Plaid.
Fields
| Field Name | Description |
|---|---|
account - AccountRemoteDataPlaidAccount | The base Account data from Plaid. |
Example
{"account": AccountRemoteDataPlaidAccount}
AccountRemoteDataPlaidAccount
Description
The Account data from Plaid.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Plaid ID. |
response - RemoteDataPlaidAccount | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "xyz789",
"response": RemoteDataPlaidAccount,
"timestamp": "2025-03-24T12:25:12Z"
}
AccountRemoteDataPlaidOwner
Description
The Owner data from Plaid.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Plaid ID. |
response - RemoteDataPlaidOwner | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "abc123",
"response": RemoteDataPlaidOwner,
"timestamp": "2025-03-24T12:25:12Z"
}
AccountSort
Description
Options for sorting Accounts.
Values
| Enum Value | Description |
|---|---|
|
| Least-recently used first, most-recently used last |
|
| Most-recently used first, least-recently used last |
Example
"LAST_TRANSACTED_ON_ASC"
AccountState
Description
Represents the current state of an Account.
Values
| Enum Value | Description |
|---|---|
|
| Open |
|
| Terminated |
Example
"OPEN"
AccountTaxonomyMember
Description
Represents a member of the Account classification taxonomy
Note that this enum is extensible and new values may be added over time.
Values
| Enum Value | Description |
|---|---|
|
| Level 1: A financial resource expected to provide future benefits. This typically includes cash and investments, but can also include credit accounts with positive balances. |
|
| Level 1: A financial obligation or debt owed to another party. This typically includes loan and credit accounts, but can also include depository accounts with overdrafts or negative balances. |
|
| Level 1: The balance sheet classification is unknown. This typically includes accounts that have not been fully synced or are missing balance information. |
|
| Level 2: Checking, Savings and cash management. |
|
| Level 2: Brokerage, retirement and other investments. |
|
| Level 2: Credit cards, and Lines of Credit. |
|
| Level 2: Mortgage, student and installment loans. |
|
| Level 2: Term life, whole life, and other insurance policies. |
|
| Level 3+: Depository > Spending |
|
| Level 3+: Depository > Spending > Cash Management |
|
| Level 3+: Depository > Spending > Prepaid |
|
| Level 3+: Depository > Spending > Electronic Benefit Transfer |
|
| Level 3+: Depository or Investment > Savings |
|
| Level 3+: Depository > Savings > Money Market |
|
| Level 3+: Depository > Savings > Certificate Of Deposit |
|
| Level 3+: Investment > Retirement |
|
| Level 3+: Investment > Custodial |
|
| Level 3+: Investment > Savings > Health Savings Account |
|
| Level 3+: Insurance > Life |
|
| Level 3+: Credit > Card |
|
| Level 3+: Credit > Line Of Credit |
|
| Level 3+: Loan > Student |
|
| Level 3+: Loan > Home Equity |
|
| Level 3+: Loan > Mortgage |
|
| Level 3+: Loan > Auto |
Example
"ASSET"
AccountUpdateInput
Description
Autogenerated input type of AccountUpdate
Fields
| Input Field | Description |
|---|---|
id - ID! | The ID of the Account to be updated. |
metadata - JSON | Custom metadata about the Account, stored in a 'key-value' format. See the Custom Metadata guide for more information and examples. |
Example
{"id": "acct_12Hz9Dz7vEAuljYvhmPcvM9", "metadata": {}}
AccountUpdatePayload
Description
Autogenerated return type of AccountUpdate.
Example
{
"errors": [Error],
"record": Account,
"success": true
}
AccountVerifiedPayload
Description
Autogenerated return type of AccountVerified.
Fields
| Field Name | Description |
|---|---|
account - Account | The verified Account |
Example
{"account": Account}
Address
Description
The legal address associated with the record.
Fields
| Field Name | Description |
|---|---|
city - String | The city. |
country - String | The short name of the country. |
countryCode - AddressCountryCode | ISO 3166-1 alpha-3 country code. |
line1 - String | The first line of the address. |
line2 - String | The second line of the address. |
line3 - String | The third line of the address. |
postalCode - String | The postal code or zip code. |
region - String | The state or province. |
regionCode - String | The two letter state or province code if available |
Example
{
"city": "Dallas",
"country": "USA",
"countryCode": "USA",
"line1": "1412 Main St",
"line2": "Suite 100",
"line3": "null",
"postalCode": "75202",
"region": "Texas",
"regionCode": "TX"
}
AddressCountryCode
Description
ISO 3166-1 alpha-3 country code.
Values
| Enum Value | Description |
|---|---|
|
| Andorra |
|
| United Arab Emirates |
|
| Afghanistan |
|
| Antigua and Barbuda |
|
| Anguilla |
|
| Albania |
|
| Armenia |
|
| Angola |
|
| Antarctica |
|
| Argentina |
|
| American Samoa |
|
| Austria |
|
| Australia |
|
| Aruba |
|
| Åland Islands |
|
| Azerbaijan |
|
| Bosnia and Herzegovina |
|
| Barbados |
|
| Bangladesh |
|
| Belgium |
|
| Burkina Faso |
|
| Bulgaria |
|
| Bahrain |
|
| Burundi |
|
| Benin |
|
| Saint Barthélemy |
|
| Bermuda |
|
| Brunei Darussalam |
|
| Bolivia (Plurinational State of) |
|
| Bonaire, Sint Eustatius and Saba |
|
| Brazil |
|
| Bahamas |
|
| Bhutan |
|
| Bouvet Island |
|
| Botswana |
|
| Belarus |
|
| Belize |
|
| Canada |
|
| Cocos (Keeling) Islands |
|
| Congo (Democratic Republic of the) |
|
| Central African Republic |
|
| Congo |
|
| Switzerland |
|
| Côte d'Ivoire |
|
| Cook Islands |
|
| Chile |
|
| Cameroon |
|
| China |
|
| Colombia |
|
| Costa Rica |
|
| Cuba |
|
| Cabo Verde |
|
| Curaçao |
|
| Christmas Island |
|
| Cyprus |
|
| Czechia |
|
| Germany |
|
| Djibouti |
|
| Denmark |
|
| Dominica |
|
| Dominican Republic |
|
| Algeria |
|
| Ecuador |
|
| Estonia |
|
| Egypt |
|
| Western Sahara |
|
| Eritrea |
|
| Spain |
|
| Ethiopia |
|
| Finland |
|
| Fiji |
|
| Falkland Islands (Malvinas) |
|
| Micronesia (Federated States of) |
|
| Faroe Islands |
|
| France |
|
| Gabon |
|
| United Kingdom of Great Britain and Northern Ireland |
|
| Grenada |
|
| Georgia |
|
| French Guiana |
|
| Guernsey |
|
| Ghana |
|
| Gibraltar |
|
| Greenland |
|
| Gambia |
|
| Guinea |
|
| Guadeloupe |
|
| Equatorial Guinea |
|
| Greece |
|
| South Georgia and the South Sandwich Islands |
|
| Guatemala |
|
| Guam |
|
| Guinea-Bissau |
|
| Guyana |
|
| Hong Kong |
|
| Heard Island and McDonald Islands |
|
| Honduras |
|
| Croatia |
|
| Haiti |
|
| Hungary |
|
| Indonesia |
|
| Ireland |
|
| Israel |
|
| Isle of Man |
|
| India |
|
| British Indian Ocean Territory |
|
| Iraq |
|
| Iran (Islamic Republic of) |
|
| Iceland |
|
| Italy |
|
| Jersey |
|
| Jamaica |
|
| Jordan |
|
| Japan |
|
| Kenya |
|
| Kyrgyzstan |
|
| Cambodia |
|
| Kiribati |
|
| Comoros |
|
| Saint Kitts and Nevis |
|
| Korea (Democratic People's Republic of) |
|
| Korea (Republic of) |
|
| Kuwait |
|
| Cayman Islands |
|
| Kazakhstan |
|
| Lao People's Democratic Republic |
|
| Lebanon |
|
| Saint Lucia |
|
| Liechtenstein |
|
| Sri Lanka |
|
| Liberia |
|
| Lesotho |
|
| Lithuania |
|
| Luxembourg |
|
| Latvia |
|
| Libya |
|
| Morocco |
|
| Monaco |
|
| Moldova (Republic of) |
|
| Montenegro |
|
| Saint Martin (French part) |
|
| Madagascar |
|
| Marshall Islands |
|
| North Macedonia |
|
| Mali |
|
| Myanmar |
|
| Mongolia |
|
| Macao |
|
| Northern Mariana Islands |
|
| Martinique |
|
| Mauritania |
|
| Montserrat |
|
| Malta |
|
| Mauritius |
|
| Maldives |
|
| Malawi |
|
| Mexico |
|
| Malaysia |
|
| Mozambique |
|
| Namibia |
|
| New Caledonia |
|
| Niger |
|
| Norfolk Island |
|
| Nigeria |
|
| Nicaragua |
|
| Netherlands |
|
| Norway |
|
| Nepal |
|
| Nauru |
|
| Niue |
|
| New Zealand |
|
| Oman |
|
| Panama |
|
| Peru |
|
| French Polynesia |
|
| Papua New Guinea |
|
| Philippines |
|
| Pakistan |
|
| Poland |
|
| Saint Pierre and Miquelon |
|
| Pitcairn |
|
| Puerto Rico |
|
| Palestine, State of |
|
| Portugal |
|
| Palau |
|
| Paraguay |
|
| Qatar |
|
| Réunion |
|
| Romania |
|
| Serbia |
|
| Russian Federation |
|
| Rwanda |
|
| Saudi Arabia |
|
| Solomon Islands |
|
| Seychelles |
|
| Sudan |
|
| Sweden |
|
| Singapore |
|
| Saint Helena, Ascension and Tristan da Cunha |
|
| Slovenia |
|
| Svalbard and Jan Mayen |
|
| Slovakia |
|
| Sierra Leone |
|
| San Marino |
|
| Senegal |
|
| Somalia |
|
| Suriname |
|
| South Sudan |
|
| Sao Tome and Principe |
|
| El Salvador |
|
| Sint Maarten (Dutch part) |
|
| Syrian Arab Republic |
|
| Eswatini |
|
| Turks and Caicos Islands |
|
| Chad |
|
| French Southern Territories |
|
| Togo |
|
| Thailand |
|
| Tajikistan |
|
| Tokelau |
|
| Timor-Leste |
|
| Turkmenistan |
|
| Tunisia |
|
| Tonga |
|
| Türkiye |
|
| Trinidad and Tobago |
|
| Tuvalu |
|
| Taiwan, Province of China |
|
| Tanzania, United Republic of |
|
| Ukraine |
|
| Uganda |
|
| United States Minor Outlying Islands |
|
| United States of America |
|
| Uruguay |
|
| Uzbekistan |
|
| Holy See |
|
| Saint Vincent and the Grenadines |
|
| Venezuela (Bolivarian Republic of) |
|
| Virgin Islands (British) |
|
| Virgin Islands (U.S.) |
|
| Viet Nam |
|
| Vanuatu |
|
| Wallis and Futuna |
|
| Samoa |
|
| Yemen |
|
| Mayotte |
|
| South Africa |
|
| Zambia |
|
| Zimbabwe |
Example
"AND"
Balance
Description
Represents an Account Balance.
Fields
| Field Name | Description |
|---|---|
at - DateTime! | The timestamp of the Account Balance record. |
available - Float | The amount of funds accounting for pending Transactions. For asset accounts (checking, savings, investment), a positive balance indicates money in the account and a negative balance indicates the account holder owing the institution. For liability accounts (credit cards, loans), a negative balance indicates the amount owed and a positive amount indicates the lender owing the account holder. |
current - Float | The amount of funds based on posted Transactions. For asset accounts (checking, savings, investment), a positive balance indicates money in the account and a negative balance indicates the account holder owing the institution. For liability accounts (credit cards, loans), a negative balance indicates the amount owed and a positive amount indicates the lender owing the account holder. |
id - ID! | The ID of the Balance. |
limit - Float | The amount of funds that may be overdraft or spent on credit. |
source - BalanceSource! | The source of the Balance data. Note that this enum is extensible and new values may be added over time. |
Example
{
"at": "2025-01-24T14:15:22Z",
"available": 31.41,
"current": 314.15,
"id": "bal_12vXOdjpsZIgB3Ae80Y7Pl",
"limit": 3141.59,
"source": "REFRESH"
}
BalanceSource
Description
Represents the source of the Balance data.
Values
| Enum Value | Description |
|---|---|
|
| Initial value from the provider. |
|
| Regular sync with the provider. |
|
| Provider response from a triggered Refresh Balance call. |
Example
"INITIAL"
BigInt
Description
Represents non-fractional signed whole numeric values. Since the value may exceed the size of a 32-bit integer, it's encoded as a string.
Example
{}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
Connection
Description
A Connection represents the data source for a Profile's accounts and transactions, such as a Finicity Institution Login, MX Member or Plaid Item.
The easiest way to register connections is with the Quiltt Connector, which handles the configuration for Finicity Connect, MX Connect and Plaid Link.
Fields
| Field Name | Description |
|---|---|
accounts - [Account!]! | A list of Accounts. |
Arguments
| |
at - DateTime! | The UTC date and time of the most recently known state of the Connection. For active Connections, this is when data was last successfully synced with the upstream provider. For disconnected Connections, this is the time of the disconnection from the upstream provider. |
externallyManaged - Boolean! | Specifies whether this Connection is managed by an external system. When a Connection is imported as externally-managed, Quiltt will sync it, but disconnecting it will not revoke access from the upstream provider. |
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. |
oauth - Boolean | Whether the Connection is established via OAuth. |
products - [ConnectionProduct!]! | The products currently enabled on the Connection. |
provider - ConnectionProvider! | Represents the data provider for the Connection. |
remoteData - ConnectionRemoteData | The Remote Data associated with the Connection. See the Remote Data guide for more information. |
status - ConnectionStatus! | Represents the current state of a Connection. See the Connection docs for help troubleshooting error statuses. Note that this enum is extensible and new values may be added over time. |
Example
{
"accounts": [Account],
"at": "2025-09-24T14:15:22Z",
"externallyManaged": false,
"id": "conn_14TJiFDKRJlPiBHuukUIlXZ",
"institution": Institution,
"metadata": {"hiddenFromUI": true},
"oauth": false,
"products": ["ACCOUNT_BALANCES_AND_TRANSACTIONS"],
"provider": "MX",
"remoteData": ConnectionRemoteData,
"status": "SYNCED"
}
ConnectionCreatedPayload
Description
Autogenerated return type of ConnectionCreated.
Fields
| Field Name | Description |
|---|---|
connection - Connection | The newly created Connection. |
Example
{"connection": Connection}
ConnectionDisconnectInput
Description
Autogenerated input type of ConnectionDisconnect
Fields
| Input Field | Description |
|---|---|
id - ID! | The ID of the Connection to be disconnected. |
Example
{"id": "conn_14TJiFDKRJlPiBHuukUIlXZ"}
ConnectionDisconnectPayload
Description
Autogenerated return type of ConnectionDisconnect.
Fields
| Field Name | Description |
|---|---|
record - Connection! | The Connection to be disconnected. |
success - Boolean! | Specifies whether the mutation was successful. |
Example
{"record": Connection, "success": false}
ConnectionFilter
Description
Options for filtering Connections.
Fields
| Input Field | Description |
|---|---|
metadata - JSON | Filter by the contents of Connection Examples:
|
provider - [ConnectionProvider!] | Filter Connections by provider. |
status - [ConnectionStatus!] | Filter Connections by one or more statuses. Examples:
|
status_not - [ConnectionStatus!] | Filter out Connections by one or more statuses. Examples:
|
Example
{
"metadata": {},
"provider": ["MX", "FINICITY"],
"status": ["ERROR_REPAIRABLE"],
"status_not": ["INITIALIZING", "SYNCING"]
}
ConnectionProduct
Description
Represents a product of a Connection.
Note that this enum is extensible and new values may be added over time.
Values
| Enum Value | Description |
|---|---|
|
| Access to Account Balances and Transaction with up to 24 months of history, depending on the provider. Note that, by default, MX and Finicity provide 3 and 6 months of history respectively. Accessing 24 months of history incurs a one-time per-Connection fee. You can configure whether Quiltt should attempt to sync full history on corresponding Integration pages in the Dashboard |
|
| Access to verified account numbers to support money movement operations. When this product is provisioned, eligible accounts will be enabled for the Account Numbers and Processor Tokens endpoints. |
|
| Access to account-holder information to validate identity and account ownership. When this product is provisioned, account-holder information will become available via Remote Data. |
|
| Access to historical account statements in PDF format. |
|
| Access to account investments holdings and transactions. Note that for some providers like MX, this product may be provisioned automatically. |
|
| Access to detailed account liabilities data. Note that for some providers like MX, this product may be provisioned automatically. |
|
| The ability to trigger live refreshes of account balances. |
|
| The ability to trigger live refreshes of account transactions. Note that this product is currently in closed beta. Contact Quiltt Support to request early access. |
Example
"ACCOUNT_BALANCES_AND_TRANSACTIONS"
ConnectionProvider
Description
Represents the data provider for the Connection.
Values
| Enum Value | Description |
|---|---|
|
| Akoya |
|
| Finicity |
|
| Mock data |
|
| MX |
|
| Plaid |
|
| Disconnected |
Example
"AKOYA"
ConnectionRemoteData
Description
Remote data associated with a Connection.
Fields
| Field Name | Description |
|---|---|
akoya - ConnectionRemoteDataAkoya | The Akoya remote data associated with the Connection. |
finicity - ConnectionRemoteDataFinicity | The Finicity remote data associated with the Connection. |
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. |
Example
{
"akoya": ConnectionRemoteDataAkoya,
"finicity": ConnectionRemoteDataFinicity,
"mock": ConnectionRemoteDataMock,
"mx": ConnectionRemoteDataMx,
"plaid": ConnectionRemoteDataPlaid
}
ConnectionRemoteDataAkoya
Description
Connection-level data from Akoya.
Fields
| Field Name | Description |
|---|---|
connection - ConnectionRemoteDataAkoyaConnection | The Connection data from Akoya. |
Example
{"connection": ConnectionRemoteDataAkoyaConnection}
ConnectionRemoteDataAkoyaConnection
Description
The Connection data from Akoya.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Akoya ID. |
response - RemoteDataAkoyaToken | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "xyz789",
"response": RemoteDataAkoyaToken,
"timestamp": "2025-03-24T12:25:12Z"
}
ConnectionRemoteDataFinicity
Description
Connection-level data from Finicity.
Fields
| Field Name | Description |
|---|---|
connection - ConnectionRemoteDataFinicityConnection | The Connection data from Finicity. |
Example
{"connection": ConnectionRemoteDataFinicityConnection}
ConnectionRemoteDataFinicityConnection
Description
The Connection data from Finicity.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Finicity ID. |
response - RemoteDataFinicityConnectionDetails | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "abc123",
"response": RemoteDataFinicityConnectionDetails,
"timestamp": "2025-03-24T12:25:12Z"
}
ConnectionRemoteDataMock
Description
Connection-level data from Mock.
Fields
| Field Name | Description |
|---|---|
connection - ConnectionRemoteDataMockConnection | The Connection data from Mock. |
Example
{"connection": ConnectionRemoteDataMockConnection}
ConnectionRemoteDataMockConnection
Description
The Connection data from Mock.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Mock ID. |
response - RemoteDataMockConnection | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "xyz789",
"response": RemoteDataMockConnection,
"timestamp": "2025-03-24T12:25:12Z"
}
ConnectionRemoteDataMx
Description
Connection-level data from MX.
Fields
| Field Name | Description |
|---|---|
connection - ConnectionRemoteDataMxConnection | The base Connection data from MX. |
Example
{"connection": ConnectionRemoteDataMxConnection}
ConnectionRemoteDataMxConnection
Description
The Connection data from Mx.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Mx ID. |
response - RemoteDataMxMember | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "xyz789",
"response": RemoteDataMxMember,
"timestamp": "2025-03-24T12:25:12Z"
}
ConnectionRemoteDataPlaid
Description
Connection-level data from Plaid.
Fields
| Field Name | Description |
|---|---|
connection - ConnectionRemoteDataPlaidConnection | The base Connection data from Plaid. |
liabilities - ConnectionRemoteDataPlaidLiabilities | The Liabilities data from Plaid. |
Example
{
"connection": ConnectionRemoteDataPlaidConnection,
"liabilities": ConnectionRemoteDataPlaidLiabilities
}
ConnectionRemoteDataPlaidConnection
Description
The Connection data from Plaid.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Plaid ID. |
response - RemoteDataPlaidItem | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "abc123",
"response": RemoteDataPlaidItem,
"timestamp": "2025-03-24T12:25:12Z"
}
ConnectionRemoteDataPlaidLiabilities
Description
The Liabilities data from Plaid.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Plaid ID. |
response - RemoteDataPlaidLiabilitiesObject | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "xyz789",
"response": RemoteDataPlaidLiabilitiesObject,
"timestamp": "2025-03-24T12:25:12Z"
}
ConnectionSimulateErrorInput
Description
Autogenerated input type of ConnectionSimulateError
Fields
| Input Field | Description |
|---|---|
id - ID! | The ID of the Connection to be put in a repairable state. |
Example
{"id": "conn_14TJiFDKRJlPiBHuukUIlXZ"}
ConnectionSimulateErrorPayload
Description
Autogenerated return type of ConnectionSimulateError.
Fields
| Field Name | Description |
|---|---|
errors - [Error!] | List of errors from an unsuccessful mutation. |
record - Connection | The Connection put in a repairable state. |
success - Boolean! | Specifies whether the mutation was successful. |
Example
{
"errors": [Error],
"record": Connection,
"success": true
}
ConnectionStatus
Description
Represents the current state of a Connection.
See the Connection docs for help troubleshooting error statuses.
Note that this enum is extensible and new values may be added over time.
Values
| Enum Value | Description |
|---|---|
|
| The Connection is being initialized and will begin syncing soon. |
|
| The Connection is currently syncing with the provider. |
|
| The Connection is synced and up to date with the provider. |
|
| The Connection must be re-authenticated to resume syncing. Quiltt will keep trying to sync this Connection until it is re-authenticated. |
|
| The Connection provider is reporting an error from the user's Institution. Quiltt will keep trying to sync this Connection until the error is resolved. |
|
| The Connection provider is reporting an error with the Connection. Quiltt will keep trying to sync this Connection until the error is resolved. |
|
| Quiltt is experiencing an internal error attempting to sync this Connection. The Quiltt team has been notified and the Connection will be retried automatically once the issue is resolved. |
|
| The Connection is in the process of being disconnected from its provider. |
|
| The Connection has been fully disconnected from the provider. Accounts and associated data will remain on the Profile, but no new data will be synced until another Connection is established to the same Institution. You can leverage the Connector Reconnect flow to prompt the user to re-establish the Connection. |
Example
"INITIALIZING"
ConnectionSyncedPayload
Description
Autogenerated return type of ConnectionSynced.
Fields
| Field Name | Description |
|---|---|
connection - Connection | The synced Connection |
Example
{"connection": Connection}
ConnectionUpdateInput
Description
Autogenerated input type of ConnectionUpdate
Fields
| Input Field | Description |
|---|---|
id - ID! | The ID of the Connection to be updated. |
metadata - JSON | Custom metadata about the Connection, stored in a 'key-value' format. See the Custom Metadata guide for more information and examples. |
Example
{"id": "conn_14TJiFDKRJlPiBHuukUIlXZ", "metadata": {}}
ConnectionUpdatePayload
Description
Autogenerated return type of ConnectionUpdate.
Fields
| Field Name | Description |
|---|---|
errors - [Error!] | List of errors from an unsuccessful mutation. |
record - Connection | The updated Connection. |
success - Boolean! | Specifies whether the mutation was successful. |
Example
{
"errors": [Error],
"record": Connection,
"success": true
}
CurrencyCode
Description
Represents a supported ISO-4217 currency code.
Values
| Enum Value | Description |
|---|---|
|
| United States Dollar |
|
| Euro |
|
| British Pound |
|
| Australian Dollar |
|
| Canadian Dollar |
|
| Japanese Yen |
|
| Belarusian Ruble |
|
| Botswana Pula |
|
| Qatari Riyal |
|
| Romanian Leu |
|
| Serbian Dinar |
|
| Russian Ruble |
|
| Rwandan Franc |
|
| Saudi Riyal |
|
| Solomon Islands Dollar |
|
| Seychellois Rupee |
|
| Sudanese Pound |
|
| Swedish Krona |
|
| Singapore Dollar |
|
| Saint Helenian Pound |
|
| Slovak Koruna |
|
| New Leone |
|
| Sierra Leonean Leone |
|
| Somali Shilling |
|
| Surinamese Dollar |
|
| South Sudanese Pound |
|
| Macanese Pataca |
|
| Mauritanian Ouguiya |
|
| Mauritian Rupee |
|
| Maldivian Rufiyaa |
|
| Malawian Kwacha |
|
| Mexican Peso |
|
| Malaysian Ringgit |
|
| Mozambican Metical |
|
| Namibian Dollar |
|
| Nigerian Naira |
|
| Nicaraguan Córdoba |
|
| Norwegian Krone |
|
| Nepalese Rupee |
|
| New Zealand Dollar |
|
| Omani Rial |
|
| Panamanian Balboa |
|
| Peruvian Sol |
|
| Papua New Guinean Kina |
|
| Philippine Peso |
|
| Pakistani Rupee |
|
| Polish Złoty |
|
| Paraguayan Guaraní |
|
| Samoan Tala |
|
| Central African Cfa Franc |
|
| Silver (Troy Ounce) |
|
| Gold (Troy Ounce) |
|
| European Composite Unit |
|
| European Monetary Unit |
|
| European Unit of Account 9 |
|
| European Unit of Account 17 |
|
| East Caribbean Dollar |
|
| Caribbean Guilder |
|
| Special Drawing Rights |
|
| West African Cfa Franc |
|
| Palladium |
|
| Cfp Franc |
|
| Platinum |
|
| Codes specifically reserved for testing purposes |
|
| Yemeni Rial |
|
| South African Rand |
|
| Zambian Kwacha |
|
| Zambian Kwacha |
|
| Zimbabwe Gold |
|
| São Tomé and Príncipe Dobra |
|
| São Tomé and Príncipe Second Dobra |
|
| Salvadoran Colón |
|
| Syrian Pound |
|
| Swazi Lilangeni |
|
| Thai Baht |
|
| Tajikistani Somoni |
|
| Turkmenistani Manat |
|
| Tunisian Dinar |
|
| Tongan Paʻanga |
|
| Turkish Lira |
|
| Trinidad and Tobago Dollar |
|
| New Taiwan Dollar |
|
| Tanzanian Shilling |
|
| Ukrainian Hryvnia |
|
| Ugandan Shilling |
|
| Uruguayan Peso |
|
| Uzbekistan Som |
|
| Venezuelan Bolívar Soberano |
|
| Vietnamese Đồng |
|
| Vanuatu Vatu |
|
| Belarusian Ruble |
|
| Belize Dollar |
|
| Congolese Franc |
|
| Swiss Franc |
|
| Unidad de Fomento |
|
| Chilean Peso |
|
| Chinese Renminbi Yuan |
|
| Colombian Peso |
|
| Costa Rican Colón |
|
| Cuban Convertible Peso |
|
| Cuban Peso |
|
| Cape Verdean Escudo |
|
| Czech Koruna |
|
| Djiboutian Franc |
|
| Danish Krone |
|
| Dominican Peso |
|
| Algerian Dinar |
|
| Egyptian Pound |
|
| Eritrean Nakfa |
|
| Ethiopian Birr |
|
| United Arab Emirates Dirham |
|
| Afghan Afghani |
|
| Albanian Lek |
|
| Armenian Dram |
|
| Netherlands Antillean Gulden |
|
| Angolan Kwanza |
|
| Argentine Peso |
|
| Aruban Florin |
|
| Azerbaijani Manat |
|
| Bosnia and Herzegovina Convertible Mark |
|
| Barbadian Dollar |
|
| Bangladeshi Taka |
|
| Bulgarian Lev |
|
| Bahraini Dinar |
|
| Burundian Franc |
|
| Bermudian Dollar |
|
| Brunei Dollar |
|
| Bolivian Boliviano |
|
| Brazilian Real |
|
| Bahamian Dollar |
|
| Bhutanese Ngultrum |
|
| Kenyan Shilling |
|
| Kyrgyzstani Som |
|
| Cambodian Riel |
|
| Comorian Franc |
|
| North Korean Won |
|
| South Korean Won |
|
| Kuwaiti Dinar |
|
| Cayman Islands Dollar |
|
| Kazakhstani Tenge |
|
| Lao Kip |
|
| Lebanese Pound |
|
| Sri Lankan Rupee |
|
| Liberian Dollar |
|
| Lesotho Loti |
|
| Libyan Dinar |
|
| Moroccan Dirham |
|
| Moldovan Leu |
|
| Malagasy Ariary |
|
| Macedonian Denar |
|
| Myanmar Kyat |
|
| Mongolian Tögrög |
|
| Fijian Dollar |
|
| Falkland Pound |
|
| Georgian Lari |
|
| Ghanaian Cedi |
|
| Gibraltar Pound |
|
| Gambian Dalasi |
|
| Guinean Franc |
|
| Guatemalan Quetzal |
|
| Guyanese Dollar |
|
| Hong Kong Dollar |
|
| Honduran Lempira |
|
| Haitian Gourde |
|
| Hungarian Forint |
|
| Indonesian Rupiah |
|
| Israeli New Shekel |
|
| Indian Rupee |
|
| Iraqi Dinar |
|
| Iranian Rial |
|
| Icelandic Króna |
|
| Jamaican Dollar |
|
| Jordanian Dinar |
Example
"USD"
Date
Description
Represents an ISO 8601-encoded date string (e.g. "2025-10-21").
Example
"2007-12-03"
DateMonth
DateRange
DateTime
Description
Represents an ISO 8601-encoded datetime string (e.g. "2025-10-21T15:30:00Z").
Example
"2007-12-03T10:15:30Z"
Description
The details of an email address
Fields
| Field Name | Description |
|---|---|
address - String | The email address |
Example
{"address": "name@domain.com"}
Error
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
Holding
Description
Represents a rolled-up Investment Holding belonging to a Profile, derived from all accounts.
Fields
| Field Name | Description |
|---|---|
at - DateTime! | The timestamp of the Holding record. |
costBasis - Float | The total original cost basis of the holding |
id - ID! | The ID of the Holding. |
position - HoldingPosition! | Indicates whether the holding lot position is long or short |
price - Float | The latest per-share price for the holding |
quantity - Float | The number of shares being held |
security - Security | The Security associated with the Investment Holding. |
value - Float | The total value of the holding |
Example
{
"at": "2025-01-24T14:15:22Z",
"costBasis": 987.65,
"id": "hld_12Hz9Dz7vEvM9AuljYvhmPc",
"position": "LONG",
"price": 987.65,
"quantity": 123.45,
"security": Security,
"value": 123.45
}
HoldingConnection
Description
The connection type for Holding.
Fields
| Field Name | Description |
|---|---|
count - Int! | The total number of records. |
edges - [HoldingEdge] | A list of edges. |
nodes - [Holding] | A list of nodes. |
pageInfo - PageInfo! | Information to aid in pagination. |
Example
{
"count": 123,
"edges": [HoldingEdge],
"nodes": [Holding],
"pageInfo": PageInfo
}
HoldingEdge
HoldingPosition
Description
Represents whether a holding position is long or short.
Values
| Enum Value | Description |
|---|---|
|
| Long position |
|
| Short position |
Example
"LONG"
HoldingRemoteData
Description
Remote data associated with a Investment Holding.
Fields
| Field Name | Description |
|---|---|
akoya - HoldingRemoteDataAkoya | The Akoya remote data associated with the Investment Holding. |
finicity - HoldingRemoteDataFinicity | The Finicity remote data associated with the Investment Holding. |
plaid - HoldingRemoteDataPlaid | The Plaid remote data associated with the Investment Holding. |
Example
{
"akoya": HoldingRemoteDataAkoya,
"finicity": HoldingRemoteDataFinicity,
"plaid": HoldingRemoteDataPlaid
}
HoldingRemoteDataAkoya
Description
Remote Data from Akoya
Fields
| Field Name | Description |
|---|---|
holding - HoldingRemoteDataAkoyaHolding | Akoya's Holding Remote Data |
Example
{"holding": HoldingRemoteDataAkoyaHolding}
HoldingRemoteDataAkoyaHolding
Description
The Holding data from Akoya.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Akoya ID. |
response - RemoteDataAkoyaHolding | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "xyz789",
"response": RemoteDataAkoyaHolding,
"timestamp": "2025-03-24T12:25:12Z"
}
HoldingRemoteDataFinicity
Description
Remote Data from Finicity
Fields
| Field Name | Description |
|---|---|
holding - HoldingRemoteDataFinicityHolding | Finicity's Holding Remote Data |
Example
{"holding": HoldingRemoteDataFinicityHolding}
HoldingRemoteDataFinicityHolding
Description
The Holding data from Finicity.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Finicity ID. |
response - RemoteDataFinicityCustomerAccountPosition | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "abc123",
"response": RemoteDataFinicityCustomerAccountPosition,
"timestamp": "2025-03-24T12:25:12Z"
}
HoldingRemoteDataPlaid
Description
Remote Data from Plaid
Fields
| Field Name | Description |
|---|---|
holding - HoldingRemoteDataPlaidHolding | Plaids's Investments Holding Remote Data |
security - HoldingRemoteDataPlaidSecurity | Plaids's Investments Security Remote Data |
Example
{
"holding": HoldingRemoteDataPlaidHolding,
"security": HoldingRemoteDataPlaidSecurity
}
HoldingRemoteDataPlaidHolding
Description
The Holding data from Plaid.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Plaid ID. |
response - RemoteDataPlaidHolding | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "abc123",
"response": RemoteDataPlaidHolding,
"timestamp": "2025-03-24T12:25:12Z"
}
HoldingRemoteDataPlaidSecurity
Description
The Security data from Plaid.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Plaid ID. |
response - RemoteDataPlaidSecurity | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "xyz789",
"response": RemoteDataPlaidSecurity,
"timestamp": "2025-03-24T12:25:12Z"
}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
Image
Description
Represents an Image.
Fields
| Field Name | Description |
|---|---|
url - URL | The URL for the Image. |
Example
{"url": "https://upload.wikimedia.org/wikipedia/commons/a/ab/Logo_TV_2015.png"}
Institution
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
JSON
Description
Represents untyped JSON
Example
{}
Name
Description
The details of a name
Example
{
"first": "John",
"full": "John Quincy Doe Jr.",
"last": "Doe",
"middle": "Quincy",
"prefix": "Mr.",
"suffix": "Jr."
}
PageInfo
Description
Information about pagination in a connection.
Fields
| Field Name | Description |
|---|---|
endCursor - String | When paginating forwards, the cursor to continue. |
hasNextPage - Boolean! | When paginating forwards, are there more items? |
hasPreviousPage - Boolean! | When paginating backwards, are there more items? |
startCursor - String | When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
Phone
Description
The details of a phone number
Fields
| Field Name | Description |
|---|---|
number - String | The phone number |
Example
{"number": "+14155552671"}
Profile
Description
A Profile represents an entity with data in a Quiltt Environment, typically a physical person or company end-user of your application.
Fields
| Field Name | Description |
|---|---|
address - ProfileAddress | The legal address associated with the Profile. |
at - DateTime! | The UTC date and time of the most recently known state of the Profile. This typically represents the time when Profile was last updated or synced with an upstream provider. |
createdAt - DateTime! | The timestamp when the Profile was created in Quiltt. |
dateOfBirth - Date | A physical person's date of birth. |
email - String | The email associated with the Profile. This field can be used to power passwordless authentication in the Connector. |
id - ID! | The ID of the Profile. |
metadata - JSON | Custom metadata about the Profile, stored in a 'key-value' format. See the Custom Metadata guide for more information and examples. |
name - String | A common name or nickname for the Profile. |
names - ProfileName | A physical person's legal name. |
phone - String | The phone number associated with the Profile, in E164 Format. This field can be used to power passwordless authentication in the Connector. |
remoteData - ProfileRemoteData | The Remote Data associated with the Profile. See the Remote Data guide for more information. |
uuid - ID! | The UUID of the Profile. |
Example
{
"address": ProfileAddress,
"at": "2026-01-22T14:15:22Z",
"createdAt": "2007-12-03T10:15:30Z",
"dateOfBirth": "2007-12-03",
"email": "name@example.com",
"id": "p_1hyoxpVVFib1HngGwKAzIr",
"metadata": {
"firebaseId": "4Wz7x0QkPdNNzgRgjZ4iIzMKjXo2",
"avatar": "https://www.gravatar.com/avatar/5658ffccee7f0ebfda2b226238b1eb6e",
"favoriteColor": "Purple"
},
"name": "Quiltty",
"names": ProfileName,
"phone": "+14155552671",
"remoteData": ProfileRemoteData,
"uuid": "174ec567-2492-4498-a706-504a79437235"
}
ProfileAddress
Description
The legal address associated with the Profile.
Example
{
"city": "xyz789",
"countryCode": "AND",
"line1": "xyz789",
"line2": "xyz789",
"postalCode": "abc123",
"state": "xyz789"
}
ProfileAddressInput
Description
Attributes for setting an address.
Example
{
"city": "xyz789",
"countryCode": "AND",
"line1": "abc123",
"line2": "abc123",
"postalCode": "xyz789",
"state": "abc123"
}
ProfileName
Description
A physical person's legal name.
Example
{"first": "Quiltty", "full": "Quiltty McQuilttface", "last": "McQuilttface"}
ProfileNameInput
ProfileRemoteData
Description
Remote data associated with a Profile.
Fields
| Field Name | Description |
|---|---|
fingoal - ProfileRemoteDataFingoal | The FinGoal remote data associated with the Profile. |
Example
{"fingoal": ProfileRemoteDataFingoal}
ProfileRemoteDataFingoal
Description
Profile-level data from FinGoal.
Fields
| Field Name | Description |
|---|---|
insights - ProfileRemoteDataFingoalInsights | The Insights data from FinGoal. |
Example
{"insights": ProfileRemoteDataFingoalInsights}
ProfileRemoteDataFingoalInsights
Description
The Insights data from Fingoal.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Fingoal ID. |
response - RemoteDataFingoalUser | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "xyz789",
"response": RemoteDataFingoalUser,
"timestamp": "2025-03-24T12:25:12Z"
}
ProfileUpdateInput
Description
Autogenerated input type of ProfileUpdate
Fields
| Input Field | Description |
|---|---|
address - ProfileAddressInput | Mailing address. |
dateOfBirth - Date | Birthday. |
email - String | Email. |
metadata - JSON | Custom metadata about the Profile, stored in a 'key-value' format. See the Custom Metadata guide for more information and examples. |
name - String | Common or nickname. |
names - ProfileNameInput | Legal name. |
phone - String | Cellphone in E164 Format. |
Example
{
"address": ProfileAddressInput,
"dateOfBirth": "2007-12-03",
"email": "xyz789",
"metadata": {},
"name": "abc123",
"names": ProfileNameInput,
"phone": "abc123"
}
ProfileUpdatePayload
Description
Autogenerated return type of ProfileUpdate.
Example
{
"errors": [Error],
"record": Profile,
"success": false
}
RemoteDataAkoyaAccount
Description
Akoya Account data.
Fields
| Field Name | Description |
|---|---|
annuityAccount - RemoteDataAkoyaAnnuityAccount | Annuity Account |
depositAccount - RemoteDataAkoyaDepositAccount | Deposit Account |
insuranceAccount - RemoteDataAkoyaInsuranceAccount | Insurance Account |
investmentAccount - RemoteDataAkoyaInvestmentAccount | Investment Account |
loanAccount - RemoteDataAkoyaLoanAccount | Loan Account |
locAccount - RemoteDataAkoyaLocAccount | Line of Credit Account |
Example
{
"annuityAccount": RemoteDataAkoyaAnnuityAccount,
"depositAccount": RemoteDataAkoyaDepositAccount,
"insuranceAccount": RemoteDataAkoyaInsuranceAccount,
"investmentAccount": RemoteDataAkoyaInvestmentAccount,
"loanAccount": RemoteDataAkoyaLoanAccount,
"locAccount": RemoteDataAkoyaLocAccount
}
RemoteDataAkoyaAccountHolder
Description
Akoya Owner data.
Extends Customer and adds a relationship field to define the customer's relationship with an account
Fields
| Field Name | Description |
|---|---|
accounts - [RemoteDataAkoyaAccounts!] | List of accounts related to this end-user |
addresses - [RemoteDataAkoyaAddress!] | An array of the customer's physical mail addresses |
businessCustomer - RemoteDataAkoyaBusinessCustomerentity | Customers that are commercial in nature are affiliated with a business entity |
customerId - String | Long-term persistent identity of the end-user. This identity must be unique to the owning institution |
email - [String!] | An array of the end-user's electronic mail addresses |
name - RemoteDataAkoyaCustomerName | customerName |
relationship - String | Types of relationships between accounts and holders. Suggested values |
telephones - [RemoteDataAkoyaTelephones!] |
Example
{
"accounts": [RemoteDataAkoyaAccounts],
"addresses": [RemoteDataAkoyaAddress],
"businessCustomer": RemoteDataAkoyaBusinessCustomerentity,
"customerId": "abc123",
"email": ["xyz789"],
"name": RemoteDataAkoyaCustomerName,
"relationship": "xyz789",
"telephones": [RemoteDataAkoyaTelephones]
}
RemoteDataAkoyaAccounts
RemoteDataAkoyaAddress
Description
Postal address
Fields
| Field Name | Description |
|---|---|
city - String | City |
country - String | ISO 3166 Country Code |
line1 - String | Address line 1. May contain full address if not separated |
line2 - String | Address line 2 |
line3 - String | Address line 3 |
postalCode - String | Postal code |
region - String | State or province or territory. Replaces "state" property |
state - String | State or province. Deprecated, will remove in FDX V6.0 |
type - String | Type of address location. One of BUSINESS, HOME, MAILING |
Example
{
"city": "abc123",
"country": "xyz789",
"line1": "abc123",
"line2": "abc123",
"line3": "xyz789",
"postalCode": "abc123",
"region": "abc123",
"state": "abc123",
"type": "xyz789"
}
RemoteDataAkoyaAnnuityAccount
Description
Annuity Account
Fields
| Field Name | Description |
|---|---|
accountId - String | Long-term persistent identity of the account. Not an account number. This identity must be unique to the owning institution. |
accountNumberDisplay - String | Account display number for the end user’s handle at owning institution. This is to be displayed by the Interface Provider. |
accountType - String | The type of an account. For instance, CHECKING, SAVINGS, 401K, etc. |
annuityProductType - String | |
annuityValueBasis - String | |
balanceType - String | ASSET (positive transaction amount increases balance), LIABILITY (positive transaction amount decreases balance) |
currency - RemoteDataAkoyaCurrencyEntity | Indicates the currency code used by the account. May also include currency rate. |
description - String | |
error - RemoteDataAkoyaErrorEntity | An error entity which can be used at the API level for error responses or at the account level to indicate a problem specific to a particular account. |
fiAttributes - [RemoteDataAkoyaFiAttributeEntity!] | |
interestRate - Float | Interest Rate of Account |
interestRateAsOf - DateTime | Date of account’s interest rate |
interestRateType - String | The type of interest rate. FIXED or VARIABLE. |
lastActivityDate - DateTime | Date that last transaction occurred on account |
lineOfBusiness - String | The line of business, such as consumer, consumer joint, small business, corporate, etc. |
micrNumber - String | MICR Number |
nickname - String | Name given by the user. Used in UIs to assist in account selection |
parentAccountId - String | Long-term persistent identity of the parent account. This is used to group accounts. |
paymentFrequency - String | |
priorInterestRate - Float | Previous Interest Rate of Account |
productName - String | Marketed product name for this account. Used in UIs to assist in account selection |
status - String | The status of an account. |
transferIn - Boolean | Account is eligible for incoming transfers |
transferOut - Boolean | Account is eligible for outgoing transfers |
Example
{
"accountId": "abc123",
"accountNumberDisplay": "xyz789",
"accountType": "xyz789",
"annuityProductType": "abc123",
"annuityValueBasis": "xyz789",
"balanceType": "xyz789",
"currency": RemoteDataAkoyaCurrencyEntity,
"description": "abc123",
"error": RemoteDataAkoyaErrorEntity,
"fiAttributes": [RemoteDataAkoyaFiAttributeEntity],
"interestRate": 987.65,
"interestRateAsOf": "2007-12-03T10:15:30Z",
"interestRateType": "xyz789",
"lastActivityDate": "2007-12-03T10:15:30Z",
"lineOfBusiness": "abc123",
"micrNumber": "abc123",
"nickname": "xyz789",
"parentAccountId": "xyz789",
"paymentFrequency": "abc123",
"priorInterestRate": 987.65,
"productName": "abc123",
"status": "abc123",
"transferIn": true,
"transferOut": true
}
RemoteDataAkoyaAssetClasses
RemoteDataAkoyaBusinessCustomerentity
Description
Customers that are commercial in nature are affiliated with a business entity
Fields
| Field Name | Description |
|---|---|
domicile - RemoteDataAkoyaDomicile | The country and region of the business customer's location |
industryCode - RemoteDataAkoyaIndustryCode | Industry code and type |
name - String | Name of business customer |
registeredAgents - [RemoteDataAkoyaCustomerName!] | A list of registered agents who act on behalf of the business customer |
registeredId - String | The registered tax identification number (TIN) or other identifier of business customer |
Example
{
"domicile": RemoteDataAkoyaDomicile,
"industryCode": RemoteDataAkoyaIndustryCode,
"name": "abc123",
"registeredAgents": [RemoteDataAkoyaCustomerName],
"registeredId": "xyz789"
}
RemoteDataAkoyaCurrencyEntity
Description
Indicates the currency code used by the account. May also include currency rate.
Example
{
"currencyCode": "abc123",
"currencyRate": 987.65,
"originalCurrencyCode": "xyz789"
}
RemoteDataAkoyaCustomerName
Description
RemoteData Akoya CustomerName
Example
{
"company": "abc123",
"first": "abc123",
"last": "xyz789",
"middle": "abc123",
"prefix": "abc123",
"suffix": "xyz789"
}
RemoteDataAkoyaDebtSecurityEntity
Description
Information about the debt security specific to the type of security
Fields
| Field Name | Description |
|---|---|
bondMaturityDate - DateTime | Bond Maturity date |
callDate - DateTime | Next call date |
callPrice - Float | Bond call price |
callType - String | Type of next call |
couponDate - DateTime | Maturity date for next coupon |
couponMatureFrequency - String | When coupons mature |
couponRate - Float | Bond coupon rate for next closest call date |
debtClass - String | Classification of debt |
debtType - String | Debt type |
parValue - Float | Par value amount |
yieldToCall - Float | Yield to next call |
yieldToMaturity - Float | Yield to maturity |
Example
{
"bondMaturityDate": "2007-12-03T10:15:30Z",
"callDate": "2007-12-03T10:15:30Z",
"callPrice": 123.45,
"callType": "abc123",
"couponDate": "2007-12-03T10:15:30Z",
"couponMatureFrequency": "abc123",
"couponRate": 987.65,
"debtClass": "xyz789",
"debtType": "xyz789",
"parValue": 123.45,
"yieldToCall": 987.65,
"yieldToMaturity": 123.45
}
RemoteDataAkoyaDepositAccount
Description
Deposit Account
Fields
| Field Name | Description |
|---|---|
accountId - String | Long-term persistent identity of the account. Not an account number. This identity must be unique to the owning institution. |
accountNumberDisplay - String | Account display number for the end user’s handle at owning institution. This is to be displayed by the Interface Provider. |
accountType - String | The type of an account. For instance, CHECKING, SAVINGS, 401K, etc. |
annualPercentageYield - Float | Annual Percentage Yield. If account type = CD, required. |
balanceType - String | ASSET (positive transaction amount increases balance), LIABILITY (positive transaction amount decreases balance) |
currency - RemoteDataAkoyaCurrencyEntity | Indicates the currency code used by the account. May also include currency rate. |
description - String | |
error - RemoteDataAkoyaErrorEntity | An error entity which can be used at the API level for error responses or at the account level to indicate a problem specific to a particular account. |
fiAttributes - [RemoteDataAkoyaFiAttributeEntity!] | |
interestRate - Float | Interest Rate of Account |
interestRateAsOf - DateTime | Date of account’s interest rate |
interestRateType - String | The type of interest rate. FIXED or VARIABLE. |
lastActivityDate - DateTime | Date that last transaction occurred on account |
lineOfBusiness - String | The line of business, such as consumer, consumer joint, small business, corporate, etc. |
maturityDate - DateTime | Maturity date for CDs. If account type = CD, required. |
micrNumber - String | MICR Number |
nickname - String | Name given by the user. Used in UIs to assist in account selection |
parentAccountId - String | Long-term persistent identity of the parent account. This is used to group accounts. |
priorInterestRate - Float | Previous Interest Rate of Account |
productName - String | Marketed product name for this account. Used in UIs to assist in account selection |
status - String | The status of an account. |
term - Int | Term of CD in months |
transferIn - Boolean | Account is eligible for incoming transfers |
transferOut - Boolean | Account is eligible for outgoing transfers |
Example
{
"accountId": "xyz789",
"accountNumberDisplay": "abc123",
"accountType": "abc123",
"annualPercentageYield": 987.65,
"balanceType": "xyz789",
"currency": RemoteDataAkoyaCurrencyEntity,
"description": "abc123",
"error": RemoteDataAkoyaErrorEntity,
"fiAttributes": [RemoteDataAkoyaFiAttributeEntity],
"interestRate": 123.45,
"interestRateAsOf": "2007-12-03T10:15:30Z",
"interestRateType": "xyz789",
"lastActivityDate": "2007-12-03T10:15:30Z",
"lineOfBusiness": "xyz789",
"maturityDate": "2007-12-03T10:15:30Z",
"micrNumber": "xyz789",
"nickname": "xyz789",
"parentAccountId": "xyz789",
"priorInterestRate": 123.45,
"productName": "abc123",
"status": "abc123",
"term": 987,
"transferIn": false,
"transferOut": true
}
RemoteDataAkoyaDepositTransaction
Description
Deposit transaction
Fields
| Field Name | Description |
|---|---|
accountId - String | Corresponds to AccountId in Account |
amount - Float | The amount of money in the account currency. If balanceType is
If balanceType is
|
category - String | Transaction category, preferably MCC or SIC. |
checkNumber - Int | Check Number |
debitCreditMemo - String | Akoya will ensure that this is correctly populated with one of DEBIT or CREDIT and matches the sign of the status field. |
description - String | The description of the transaction |
fiAttributes - [RemoteDataAkoyaFiAttributeEntity!] | Array of FI-specific attributes |
foreignAmount - Float | The amount of money in the foreign currency |
foreignCurrency - String | The ISO 4217 code of the foreign currency |
imageIds - [String!] | Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt. |
lineItem - [RemoteDataAkoyaLineItem!] | Breakdown of the transaction details |
links - [RemoteDataAkoyaHATEOASLink!] | Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs |
memo - String | Secondary transaction description |
payee - String | Payee name |
postedTimestamp - DateTime | The date and time that the transaction was posted to the account. If not provided then TransactionTimestamp can be used as PostedTimeStamp. |
reference - String | A tracking reference identifier |
referenceTransactionId - String | Akoya ensures that this field is populated for all transactions which are reversals, otherwise it is null. Either way it is always present. For reverse postings, the identity of the transaction being reversed. For the correction transaction, the identity of the reversing post. For credit card posting transactions, the identity of the authorization transaction. |
status - String | AUTHORIZATION, MEMO, PENDING, or POSTED |
subCategory - String | Transaction category detail |
transactionId - String | Long term persistent identity of the transaction (unique to account). Transaction IDs should:
|
transactionTimestamp - DateTime | The date and time that the transaction was added to the server backend systems. Akoya ensures that this field is populated for all transactions to which it applies, otherwise it is null. Either way it is always present. |
transactionType - String | DepositTransaction Type |
Example
{
"accountId": "abc123",
"amount": 987.65,
"category": "xyz789",
"checkNumber": 987,
"debitCreditMemo": "xyz789",
"description": "xyz789",
"fiAttributes": [RemoteDataAkoyaFiAttributeEntity],
"foreignAmount": 987.65,
"foreignCurrency": "abc123",
"imageIds": ["abc123"],
"lineItem": [RemoteDataAkoyaLineItem],
"links": [RemoteDataAkoyaHATEOASLink],
"memo": "abc123",
"payee": "xyz789",
"postedTimestamp": "2007-12-03T10:15:30Z",
"reference": "abc123",
"referenceTransactionId": "xyz789",
"status": "abc123",
"subCategory": "abc123",
"transactionId": "xyz789",
"transactionTimestamp": "2007-12-03T10:15:30Z",
"transactionType": "abc123"
}
RemoteDataAkoyaDomicile
RemoteDataAkoyaErrorEntity
Description
An error entity which can be used at the API level for error responses or at the account level to indicate a problem specific to a particular account.
Example
{"code": 987, "message": "xyz789"}
RemoteDataAkoyaFiAssetClasses
RemoteDataAkoyaFiAttributeEntity
RemoteDataAkoyaHATEOASLink
Description
REST application constraint (Hypermedia As The Engine Of Application State)
Example
{
"action": "xyz789",
"href": "xyz789",
"types": ["xyz789"]
}
RemoteDataAkoyaHolding
Description
Akoya Holding data.
Fields
| Field Name | Description |
|---|---|
assetClasses - [RemoteDataAkoyaAssetClasses!] | Percent breakdown by asset class. |
averageCost - Boolean | Cost is average of all purchases for holding. |
cashAccount - Boolean | If true, indicates that this holding is used to maintain proceeds from sales, dividends, and other cash postings to the investment account. |
changeInPrice - Float | Change in current price compared to previous day's close |
currency - RemoteDataAkoyaCurrencyEntity | Indicates the currency code used by the account. May also include currency rate. |
currentUnitPrice - Float | |
currentUnitPriceDate - DateTime | Current unit price as of date |
debtSecurity - RemoteDataAkoyaDebtSecurityEntity | Information about the debt security specific to the type of security |
description - String | Description of the holding |
expirationDate - DateTime | For CDs, bonds, and other time-based holdings. |
faceValue - Float | Required for bonds. Face value at the time of data retrieved. |
fiAssetClasses - [RemoteDataAkoyaFiAssetClasses!] | Percent breakdown by FI-specific asset class percentage breakdown |
fiAttributes - [RemoteDataAkoyaFiAttributeEntity!] | |
heldInAccount - String | Sub-account |
holdingId - String | Long term persistent identity of the holding |
holdingName - String | Holding name or security name |
holdingSubType - String | |
holdingType - String | |
inv401kSurce - String | Source for money for this security. |
marketValue - Float | Market value at the time of data retrieved |
mutualFundSecurity - RemoteDataAkoyaMutualFundSecurityEntity | Information about the mutual fund security specific to the type of security |
optionSecurity - RemoteDataAkoyaOptionSecurityEntity | Information about the option security specific to the type of security |
originalPurchaseDate - DateTime | Date of original purchase |
otherSecurity - RemoteDataAkoyaOtherSecurityEntity | Information about the security specific to the type of security |
positionType - String | |
purchasedPrice - Float | Price of holding at the time of purchase |
rate - Float | For CDs, bonds, and other rate based holdings. |
securityId - String | Unique identifier of security |
securityIdType - String | Security identifier type |
stockSecurity - RemoteDataAkoyaStockSecurityEntity | Information about the stock security specific to the type of security |
sweepSecurity - RemoteDataAkoyaSweepSecurityEntity | Information about the sweep security specific to the type of security |
symbol - String | Ticker / Market symbol |
taxLots - [RemoteDataAkoyaTaxLots!] | Breakdown by tax lot. |
units - Float | Required for stock, mutual funds. Number of shares (with decimals). |
Example
{
"assetClasses": [RemoteDataAkoyaAssetClasses],
"averageCost": false,
"cashAccount": false,
"changeInPrice": 123.45,
"currency": RemoteDataAkoyaCurrencyEntity,
"currentUnitPrice": 123.45,
"currentUnitPriceDate": "2007-12-03T10:15:30Z",
"debtSecurity": RemoteDataAkoyaDebtSecurityEntity,
"description": "abc123",
"expirationDate": "2007-12-03T10:15:30Z",
"faceValue": 123.45,
"fiAssetClasses": [RemoteDataAkoyaFiAssetClasses],
"fiAttributes": [RemoteDataAkoyaFiAttributeEntity],
"heldInAccount": "xyz789",
"holdingId": "xyz789",
"holdingName": "xyz789",
"holdingSubType": "xyz789",
"holdingType": "abc123",
"inv401kSurce": "xyz789",
"marketValue": 987.65,
"mutualFundSecurity": RemoteDataAkoyaMutualFundSecurityEntity,
"optionSecurity": RemoteDataAkoyaOptionSecurityEntity,
"originalPurchaseDate": "2007-12-03T10:15:30Z",
"otherSecurity": RemoteDataAkoyaOtherSecurityEntity,
"positionType": "xyz789",
"purchasedPrice": 987.65,
"rate": 987.65,
"securityId": "abc123",
"securityIdType": "xyz789",
"stockSecurity": RemoteDataAkoyaStockSecurityEntity,
"sweepSecurity": RemoteDataAkoyaSweepSecurityEntity,
"symbol": "abc123",
"taxLots": [RemoteDataAkoyaTaxLots],
"units": 123.45
}
RemoteDataAkoyaIndustryCode
RemoteDataAkoyaInsuranceAccount
Description
Insurance Account
Fields
| Field Name | Description |
|---|---|
accountCategory - String | The account category of the insurance account. Possible enums: DEPOSIT_ACCOUNT, INVESTMENT_ACCOUNT, LOAN_ACCOUNT, LOC_ACCOUNT, INSURANCE_ACCOUNT |
accountId - String | Long-term persistent identity of the account. Not an account number. This identity must be unique to the owning institution. |
accountNumberDisplay - String | Account display number for the end user’s handle at owning institution. This is to be displayed by the Interface Provider. |
accountType - String | The type of an account. For instance, CHECKING, SAVINGS, 401K, etc. |
balanceType - String | ASSET (positive transaction amount increases balance), LIABILITY (positive transaction amount decreases balance) |
currency - RemoteDataAkoyaCurrencyEntity | Indicates the currency code used by the account. May also include currency rate. |
description - String | |
error - RemoteDataAkoyaErrorEntity | An error entity which can be used at the API level for error responses or at the account level to indicate a problem specific to a particular account. |
fiAttributes - [RemoteDataAkoyaFiAttributeEntity!] | |
interestRate - Float | Interest Rate of Account |
interestRateAsOf - DateTime | Date of account’s interest rate |
interestRateType - String | The type of interest rate. FIXED or VARIABLE. |
lastActivityDate - DateTime | Date that last transaction occurred on account |
lineOfBusiness - String | The line of business, such as consumer, consumer joint, small business, corporate, etc. |
micrNumber - String | MICR Number |
nickname - String | Name given by the user. Used in UIs to assist in account selection |
parentAccountId - String | Long-term persistent identity of the parent account. This is used to group accounts. |
priorInterestRate - Float | Previous Interest Rate of Account |
productName - String | Marketed product name for this account. Used in UIs to assist in account selection |
status - String | The status of an account. |
transferIn - Boolean | Account is eligible for incoming transfers |
transferOut - Boolean | Account is eligible for outgoing transfers |
Example
{
"accountCategory": "xyz789",
"accountId": "abc123",
"accountNumberDisplay": "abc123",
"accountType": "abc123",
"balanceType": "xyz789",
"currency": RemoteDataAkoyaCurrencyEntity,
"description": "abc123",
"error": RemoteDataAkoyaErrorEntity,
"fiAttributes": [RemoteDataAkoyaFiAttributeEntity],
"interestRate": 987.65,
"interestRateAsOf": "2007-12-03T10:15:30Z",
"interestRateType": "xyz789",
"lastActivityDate": "2007-12-03T10:15:30Z",
"lineOfBusiness": "xyz789",
"micrNumber": "abc123",
"nickname": "abc123",
"parentAccountId": "xyz789",
"priorInterestRate": 987.65,
"productName": "abc123",
"status": "abc123",
"transferIn": false,
"transferOut": false
}
RemoteDataAkoyaInsuranceTransaction
Description
Insurance transactions
Fields
| Field Name | Description |
|---|---|
accountId - String | Corresponds to AccountId in Account |
amount - Float | The amount of money in the account currency. If balanceType is
If balanceType is
|
category - String | Transaction category, preferably MCC or SIC. |
debitCreditMemo - String | Akoya will ensure that this is correctly populated with one of DEBIT or CREDIT and matches the sign of the status field. |
description - String | The description of the transaction |
fiAttributes - [RemoteDataAkoyaFiAttributeEntity!] | Array of FI-specific attributes |
foreignAmount - Float | The amount of money in the foreign currency |
foreignCurrency - String | The ISO 4217 code of the foreign currency |
imageIds - [String!] | Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt. |
lineItem - [RemoteDataAkoyaLineItem!] | Breakdown of the transaction details |
links - [RemoteDataAkoyaHATEOASLink!] | Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs |
memo - String | Secondary transaction description |
postedTimestamp - DateTime | The date and time that the transaction was posted to the account. If not provided then TransactionTimestamp can be used as PostedTimeStamp. |
reference - String | A tracking reference identifier |
referenceTransactionId - String | Akoya ensures that this field is populated for all transactions which are reversals, otherwise it is null. Either way it is always present. For reverse postings, the identity of the transaction being reversed. For the correction transaction, the identity of the reversing post. For credit card posting transactions, the identity of the authorization transaction. |
status - String | AUTHORIZATION, MEMO, PENDING, or POSTED |
subCategory - String | Transaction category detail |
transactionId - String | Long term persistent identity of the transaction (unique to account). Transaction IDs should:
|
transactionTimestamp - DateTime | The date and time that the transaction was added to the server backend systems. Akoya ensures that this field is populated for all transactions to which it applies, otherwise it is null. Either way it is always present. |
transactionType - String | InsuranceTransaction Type |
Example
{
"accountId": "xyz789",
"amount": 123.45,
"category": "abc123",
"debitCreditMemo": "xyz789",
"description": "abc123",
"fiAttributes": [RemoteDataAkoyaFiAttributeEntity],
"foreignAmount": 987.65,
"foreignCurrency": "abc123",
"imageIds": ["xyz789"],
"lineItem": [RemoteDataAkoyaLineItem],
"links": [RemoteDataAkoyaHATEOASLink],
"memo": "xyz789",
"postedTimestamp": "2007-12-03T10:15:30Z",
"reference": "abc123",
"referenceTransactionId": "xyz789",
"status": "abc123",
"subCategory": "xyz789",
"transactionId": "abc123",
"transactionTimestamp": "2007-12-03T10:15:30Z",
"transactionType": "xyz789"
}
RemoteDataAkoyaInvestmentAccount
Description
Investment Account
Fields
| Field Name | Description |
|---|---|
accountId - String | Long-term persistent identity of the account. Not an account number. This identity must be unique to the owning institution. |
accountNumberDisplay - String | Account display number for the end user’s handle at owning institution. This is to be displayed by the Interface Provider. |
accountType - String | The type of an account. For instance, CHECKING, SAVINGS, 401K, etc. |
allowedCheckWriting - Boolean | Check writing privileges |
allowedOptionTrade - Boolean | Allowed to trade options |
balanceType - String | ASSET (positive transaction amount increases balance), LIABILITY (positive transaction amount decreases balance) |
brokerId - String | Unique identifier FI |
calendarYearFor401K - String | Date for this calendar year for 401K account |
currency - RemoteDataAkoyaCurrencyEntity | Indicates the currency code used by the account. May also include currency rate. |
description - String | |
employerName - String | Name of the employer in investment 401k Plan |
error - RemoteDataAkoyaErrorEntity | An error entity which can be used at the API level for error responses or at the account level to indicate a problem specific to a particular account. |
fiAttributes - [RemoteDataAkoyaFiAttributeEntity!] | |
interestRate - Float | Interest Rate of Account |
interestRateAsOf - DateTime | Date of account’s interest rate |
interestRateType - String | The type of interest rate. FIXED or VARIABLE. |
lastActivityDate - DateTime | Date that last transaction occurred on account |
lineOfBusiness - String | The line of business, such as consumer, consumer joint, small business, corporate, etc. |
margin - Boolean | Margin trading is allowed |
micrNumber - String | MICR Number |
nickname - String | Name given by the user. Used in UIs to assist in account selection |
parentAccountId - String | Long-term persistent identity of the parent account. This is used to group accounts. |
planId - String | Plan number for Investment 401k plan |
priorInterestRate - Float | Previous Interest Rate of Account |
productName - String | Marketed product name for this account. Used in UIs to assist in account selection |
status - String | The status of an account. |
transferIn - Boolean | Account is eligible for incoming transfers |
transferOut - Boolean | Account is eligible for outgoing transfers |
Example
{
"accountId": "xyz789",
"accountNumberDisplay": "abc123",
"accountType": "xyz789",
"allowedCheckWriting": true,
"allowedOptionTrade": true,
"balanceType": "abc123",
"brokerId": "xyz789",
"calendarYearFor401K": "xyz789",
"currency": RemoteDataAkoyaCurrencyEntity,
"description": "xyz789",
"employerName": "xyz789",
"error": RemoteDataAkoyaErrorEntity,
"fiAttributes": [RemoteDataAkoyaFiAttributeEntity],
"interestRate": 987.65,
"interestRateAsOf": "2007-12-03T10:15:30Z",
"interestRateType": "abc123",
"lastActivityDate": "2007-12-03T10:15:30Z",
"lineOfBusiness": "abc123",
"margin": false,
"micrNumber": "xyz789",
"nickname": "abc123",
"parentAccountId": "abc123",
"planId": "xyz789",
"priorInterestRate": 987.65,
"productName": "abc123",
"status": "abc123",
"transferIn": false,
"transferOut": false
}
RemoteDataAkoyaInvestmentTransaction
Description
Investment Transactions
Fields
| Field Name | Description |
|---|---|
accountId - String | Corresponds to AccountId in Account |
accruedInterest - Float | Accrued Interest. |
amount - Float | The amount of money in the account currency. If balanceType is
If balanceType is
|
category - String | Transaction category, preferably MCC or SIC. |
commission - Float | Transaction commission. |
confirmationNumber - String | Confirmation number of the transaction. |
debitCreditMemo - String | Akoya will ensure that this is correctly populated with one of DEBIT or CREDIT and matches the sign of the status field. |
description - String | The description of the transaction |
faceValue - Float | Cash value for bonds. |
fees - Float | Fees applied to the trade. |
fiAttributes - [RemoteDataAkoyaFiAttributeEntity!] | Array of FI-specific attributes |
foreignAmount - Float | The amount of money in the foreign currency |
foreignCurrency - String | The ISO 4217 code of the foreign currency |
fractionalCash - Float | Cash for fractional units (used for stock splits). |
gain - Float | For sales. |
imageIds - [String!] | Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt. |
incomeType - String | Type of investment income. CGLONG (capital gains-long term), CGSHORT (capital gains-short term), MISC. |
inv401kSource - String | Source of money. |
lineItem - [RemoteDataAkoyaLineItem!] | Breakdown of the transaction details |
links - [RemoteDataAkoyaHATEOASLink!] | Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs |
load - Float | Load on the transaction. |
loanId - String | For 401k accounts only. This indicates the transaction was due to a loan or a loan repayment. |
loanInterest - Float | How much loan pre-payment is interest. |
loanPrincipal - Float | How much loan pre-payment is principal. |
markup - Float | Portion of unit price that is attributed to the dealer markup. |
memo - String | Secondary transaction description |
newUnits - Float | Number of shares after split. |
oldUnits - Float | Number of shares before split. |
payrollDate - String | The date for the 401k transaction was obtained in payroll. |
penalty - Float | Indicates amount withheld due to a penalty. |
positionType - String | |
postedTimestamp - DateTime | The date and time that the transaction was posted to the account. If not provided then TransactionTimestamp can be used as PostedTimeStamp. |
price - Float | Unit purchase price. |
priorYearContrib - Boolean | Indicates this buy was made using prior years contribution. TRUE or FALSE. |
reference - String | A tracking reference identifier |
referenceTransactionId - String | Akoya ensures that this field is populated for all transactions which are reversals, otherwise it is null. Either way it is always present. For reverse postings, the identity of the transaction being reversed. For the correction transaction, the identity of the reversing post. For credit card posting transactions, the identity of the authorization transaction. |
runningBalance - Float | Running balance of the position. |
securityId - String | Unique identifier of security. |
securityIdType - String | Security identifier type. |
securityType - String | |
shares - Float | Required for stock, mutual funds. Number of shares (with decimals). Negative numbers indicate securities are being removed from the account. |
splitRatioDenominator - Float | Split ratio denominator. |
splitRatioNumerator - Float | Split ratio numerator. |
stateWithholding - Float | State tax withholding. |
status - String | AUTHORIZATION, MEMO, PENDING, or POSTED |
subAccountFund - String | From which account money came in. |
subAccountSec - String | Sub-account security type. |
subCategory - String | Transaction category detail |
symbol - String | Ticker symbol. |
taxExempt - Boolean | Tax-exempt transaction TRUE or FALSE. |
taxes - Float | Taxes on the trade. |
transactionId - String | Long term persistent identity of the transaction (unique to account). Transaction IDs should:
|
transactionReason - String | Reason for this transaction; CALL (the debt was called), SELL (the debt was sold), MATURITY (the debt reached maturity) |
transactionTimestamp - DateTime | The date and time that the transaction was added to the server backend systems. Akoya ensures that this field is populated for all transactions to which it applies, otherwise it is null. Either way it is always present. |
transactionType - String | InvestmentTransaction Type |
transferAction - String | Transfer direction. |
unitPrice - Float | Price per commonly-quoted unit. Does not include markup/markdown, unitprice. Share price for stocks, mutual funds, and others. Percentage of par for bonds. Per share (not contract) for options. |
unitType - String | |
units - Float | For security-based actions other than stock splits, quantity. Shares for stocks, mutual funds, and others. Face value for bonds. Contracts for options. |
withholding - Float | Federal tax withholding. |
Example
{
"accountId": "abc123",
"accruedInterest": 987.65,
"amount": 123.45,
"category": "xyz789",
"commission": 987.65,
"confirmationNumber": "xyz789",
"debitCreditMemo": "abc123",
"description": "abc123",
"faceValue": 123.45,
"fees": 987.65,
"fiAttributes": [RemoteDataAkoyaFiAttributeEntity],
"foreignAmount": 987.65,
"foreignCurrency": "xyz789",
"fractionalCash": 123.45,
"gain": 987.65,
"imageIds": ["abc123"],
"incomeType": "xyz789",
"inv401kSource": "abc123",
"lineItem": [RemoteDataAkoyaLineItem],
"links": [RemoteDataAkoyaHATEOASLink],
"load": 123.45,
"loanId": "abc123",
"loanInterest": 123.45,
"loanPrincipal": 123.45,
"markup": 987.65,
"memo": "xyz789",
"newUnits": 987.65,
"oldUnits": 987.65,
"payrollDate": "abc123",
"penalty": 123.45,
"positionType": "xyz789",
"postedTimestamp": "2007-12-03T10:15:30Z",
"price": 987.65,
"priorYearContrib": false,
"reference": "abc123",
"referenceTransactionId": "abc123",
"runningBalance": 987.65,
"securityId": "xyz789",
"securityIdType": "xyz789",
"securityType": "xyz789",
"shares": 987.65,
"splitRatioDenominator": 987.65,
"splitRatioNumerator": 987.65,
"stateWithholding": 123.45,
"status": "xyz789",
"subAccountFund": "xyz789",
"subAccountSec": "abc123",
"subCategory": "abc123",
"symbol": "xyz789",
"taxExempt": true,
"taxes": 123.45,
"transactionId": "abc123",
"transactionReason": "abc123",
"transactionTimestamp": "2007-12-03T10:15:30Z",
"transactionType": "xyz789",
"transferAction": "xyz789",
"unitPrice": 987.65,
"unitType": "xyz789",
"units": 123.45,
"withholding": 987.65
}
RemoteDataAkoyaLineItem
Description
RemoteData Akoya LineItem
Fields
| Field Name | Description |
|---|---|
amount - Float | The amount of money attributable to this line item |
checkNumber - Float | Check number |
description - String | The description of the line item |
imageIds - [String!] | Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt |
links - [RemoteDataAkoyaHATEOASLink!] | Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs |
memo - String | Secondary item description |
reference - String | A reference number |
Example
{
"amount": 987.65,
"checkNumber": 987.65,
"description": "abc123",
"imageIds": ["xyz789"],
"links": [RemoteDataAkoyaHATEOASLink],
"memo": "xyz789",
"reference": "xyz789"
}
RemoteDataAkoyaLoanAccount
Description
Loan Account
Fields
| Field Name | Description |
|---|---|
accountId - String | Long-term persistent identity of the account. Not an account number. This identity must be unique to the owning institution. |
accountNumberDisplay - String | Account display number for the end user’s handle at owning institution. This is to be displayed by the Interface Provider. |
accountType - String | The type of an account. For instance, CHECKING, SAVINGS, 401K, etc. |
balanceType - String | ASSET (positive transaction amount increases balance), LIABILITY (positive transaction amount decreases balance) |
compoundingPeriod - String | |
currency - RemoteDataAkoyaCurrencyEntity | Indicates the currency code used by the account. May also include currency rate. |
description - String | |
error - RemoteDataAkoyaErrorEntity | An error entity which can be used at the API level for error responses or at the account level to indicate a problem specific to a particular account. |
fiAttributes - [RemoteDataAkoyaFiAttributeEntity!] | |
interestRate - Float | Interest Rate of Account |
interestRateAsOf - DateTime | Date of account’s interest rate |
interestRateType - String | The type of interest rate. FIXED or VARIABLE. |
lastActivityDate - DateTime | Date that last transaction occurred on account |
lineOfBusiness - String | The line of business, such as consumer, consumer joint, small business, corporate, etc. |
loanTerm - Int | Term of loan in months |
maturityDate - DateTime | Maturity date is required for CDs |
micrNumber - String | MICR Number |
nickname - String | Name given by the user. Used in UIs to assist in account selection |
originatingDate - DateTime | Loan origination date |
parentAccountId - String | Long-term persistent identity of the parent account. This is used to group accounts. |
paymentFrequency - String | |
priorInterestRate - Float | Previous Interest Rate of Account |
productName - String | Marketed product name for this account. Used in UIs to assist in account selection |
status - String | The status of an account. |
totalNumberOfPayments - Int | Total number of payments |
transferIn - Boolean | Account is eligible for incoming transfers |
transferOut - Boolean | Account is eligible for outgoing transfers |
Example
{
"accountId": "xyz789",
"accountNumberDisplay": "xyz789",
"accountType": "abc123",
"balanceType": "abc123",
"compoundingPeriod": "xyz789",
"currency": RemoteDataAkoyaCurrencyEntity,
"description": "xyz789",
"error": RemoteDataAkoyaErrorEntity,
"fiAttributes": [RemoteDataAkoyaFiAttributeEntity],
"interestRate": 987.65,
"interestRateAsOf": "2007-12-03T10:15:30Z",
"interestRateType": "xyz789",
"lastActivityDate": "2007-12-03T10:15:30Z",
"lineOfBusiness": "xyz789",
"loanTerm": 987,
"maturityDate": "2007-12-03T10:15:30Z",
"micrNumber": "xyz789",
"nickname": "abc123",
"originatingDate": "2007-12-03T10:15:30Z",
"parentAccountId": "xyz789",
"paymentFrequency": "xyz789",
"priorInterestRate": 123.45,
"productName": "abc123",
"status": "xyz789",
"totalNumberOfPayments": 123,
"transferIn": false,
"transferOut": true
}
RemoteDataAkoyaLoanTransaction
Description
Loan Transaction
Fields
| Field Name | Description |
|---|---|
accountId - String | Corresponds to AccountId in Account |
amount - Float | The amount of money in the account currency. If balanceType is
If balanceType is
|
category - String | Transaction category, preferably MCC or SIC. |
debitCreditMemo - String | Akoya will ensure that this is correctly populated with one of DEBIT or CREDIT and matches the sign of the status field. |
description - String | The description of the transaction |
fiAttributes - [RemoteDataAkoyaFiAttributeEntity!] | Array of FI-specific attributes |
foreignAmount - Float | The amount of money in the foreign currency |
foreignCurrency - String | The ISO 4217 code of the foreign currency |
imageIds - [String!] | Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt. |
lineItem - [RemoteDataAkoyaLineItem!] | Breakdown of the transaction details |
links - [RemoteDataAkoyaHATEOASLink!] | Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs |
memo - String | Secondary transaction description |
paymentDetails - RemoteDataAkoyaPaymentDetails | Payment details for some transactions |
postedTimestamp - DateTime | The date and time that the transaction was posted to the account. If not provided then TransactionTimestamp can be used as PostedTimeStamp. |
reference - String | A tracking reference identifier |
referenceTransactionId - String | Akoya ensures that this field is populated for all transactions which are reversals, otherwise it is null. Either way it is always present. For reverse postings, the identity of the transaction being reversed. For the correction transaction, the identity of the reversing post. For credit card posting transactions, the identity of the authorization transaction. |
status - String | AUTHORIZATION, MEMO, PENDING, or POSTED |
subCategory - String | Transaction category detail |
transactionId - String | Long term persistent identity of the transaction (unique to account). Transaction IDs should:
|
transactionTimestamp - DateTime | The date and time that the transaction was added to the server backend systems. Akoya ensures that this field is populated for all transactions to which it applies, otherwise it is null. Either way it is always present. |
transactionType - String | LoanTransaction Type |
Example
{
"accountId": "abc123",
"amount": 987.65,
"category": "abc123",
"debitCreditMemo": "xyz789",
"description": "xyz789",
"fiAttributes": [RemoteDataAkoyaFiAttributeEntity],
"foreignAmount": 987.65,
"foreignCurrency": "xyz789",
"imageIds": ["xyz789"],
"lineItem": [RemoteDataAkoyaLineItem],
"links": [RemoteDataAkoyaHATEOASLink],
"memo": "abc123",
"paymentDetails": RemoteDataAkoyaPaymentDetails,
"postedTimestamp": "2007-12-03T10:15:30Z",
"reference": "xyz789",
"referenceTransactionId": "abc123",
"status": "abc123",
"subCategory": "abc123",
"transactionId": "abc123",
"transactionTimestamp": "2007-12-03T10:15:30Z",
"transactionType": "abc123"
}
RemoteDataAkoyaLocAccount
Description
Line of Credit Account
Fields
| Field Name | Description |
|---|---|
accountId - String | Long-term persistent identity of the account. Not an account number. This identity must be unique to the owning institution. |
accountNumberDisplay - String | Account display number for the end user’s handle at owning institution. This is to be displayed by the Interface Provider. |
accountType - String | The type of an account. For instance, CHECKING, SAVINGS, 401K, etc. |
balanceType - String | ASSET (positive transaction amount increases balance), LIABILITY (positive transaction amount decreases balance) |
currency - RemoteDataAkoyaCurrencyEntity | Indicates the currency code used by the account. May also include currency rate. |
description - String | |
error - RemoteDataAkoyaErrorEntity | An error entity which can be used at the API level for error responses or at the account level to indicate a problem specific to a particular account. |
fiAttributes - [RemoteDataAkoyaFiAttributeEntity!] | |
interestRate - Float | Interest Rate of Account |
interestRateAsOf - DateTime | Date of account’s interest rate |
interestRateType - String | The type of interest rate. FIXED or VARIABLE. |
lastActivityDate - DateTime | Date that last transaction occurred on account |
lineOfBusiness - String | The line of business, such as consumer, consumer joint, small business, corporate, etc. |
micrNumber - String | MICR Number |
nickname - String | Name given by the user. Used in UIs to assist in account selection |
parentAccountId - String | Long-term persistent identity of the parent account. This is used to group accounts. |
priorInterestRate - Float | Previous Interest Rate of Account |
productName - String | Marketed product name for this account. Used in UIs to assist in account selection |
status - String | The status of an account. |
transferIn - Boolean | Account is eligible for incoming transfers |
transferOut - Boolean | Account is eligible for outgoing transfers |
Example
{
"accountId": "abc123",
"accountNumberDisplay": "xyz789",
"accountType": "xyz789",
"balanceType": "abc123",
"currency": RemoteDataAkoyaCurrencyEntity,
"description": "xyz789",
"error": RemoteDataAkoyaErrorEntity,
"fiAttributes": [RemoteDataAkoyaFiAttributeEntity],
"interestRate": 987.65,
"interestRateAsOf": "2007-12-03T10:15:30Z",
"interestRateType": "abc123",
"lastActivityDate": "2007-12-03T10:15:30Z",
"lineOfBusiness": "abc123",
"micrNumber": "abc123",
"nickname": "abc123",
"parentAccountId": "abc123",
"priorInterestRate": 987.65,
"productName": "xyz789",
"status": "abc123",
"transferIn": true,
"transferOut": false
}
RemoteDataAkoyaLocTransaction
Description
A line of credit transaction of type
Fields
| Field Name | Description |
|---|---|
accountId - String | Corresponds to AccountId in Account |
amount - Float | The amount of money in the account currency. If balanceType is
If balanceType is
|
category - String | Transaction category, preferably MCC or SIC. |
checkNumber - Int | Check number |
debitCreditMemo - String | Akoya will ensure that this is correctly populated with one of DEBIT or CREDIT and matches the sign of the status field. |
description - String | The description of the transaction |
fiAttributes - [RemoteDataAkoyaFiAttributeEntity!] | Array of FI-specific attributes |
foreignAmount - Float | The amount of money in the foreign currency |
foreignCurrency - String | The ISO 4217 code of the foreign currency |
imageIds - [String!] | Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt. |
lineItem - [RemoteDataAkoyaLineItem!] | Breakdown of the transaction details |
links - [RemoteDataAkoyaHATEOASLink!] | Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs |
memo - String | Secondary transaction description |
paymentDetails - RemoteDataAkoyaPaymentDetails | Payment details for some transactions |
postedTimestamp - DateTime | The date and time that the transaction was posted to the account. If not provided then TransactionTimestamp can be used as PostedTimeStamp. |
reference - String | A tracking reference identifier |
referenceTransactionId - String | Akoya ensures that this field is populated for all transactions which are reversals, otherwise it is null. Either way it is always present. For reverse postings, the identity of the transaction being reversed. For the correction transaction, the identity of the reversing post. For credit card posting transactions, the identity of the authorization transaction. |
status - String | AUTHORIZATION, MEMO, PENDING, or POSTED |
subCategory - String | Transaction category detail |
transactionId - String | Long term persistent identity of the transaction (unique to account). Transaction IDs should:
|
transactionTimestamp - DateTime | The date and time that the transaction was added to the server backend systems. Akoya ensures that this field is populated for all transactions to which it applies, otherwise it is null. Either way it is always present. |
transactionType - String | LocTransaction Type |
Example
{
"accountId": "xyz789",
"amount": 987.65,
"category": "xyz789",
"checkNumber": 123,
"debitCreditMemo": "xyz789",
"description": "xyz789",
"fiAttributes": [RemoteDataAkoyaFiAttributeEntity],
"foreignAmount": 123.45,
"foreignCurrency": "abc123",
"imageIds": ["abc123"],
"lineItem": [RemoteDataAkoyaLineItem],
"links": [RemoteDataAkoyaHATEOASLink],
"memo": "abc123",
"paymentDetails": RemoteDataAkoyaPaymentDetails,
"postedTimestamp": "2007-12-03T10:15:30Z",
"reference": "abc123",
"referenceTransactionId": "xyz789",
"status": "xyz789",
"subCategory": "xyz789",
"transactionId": "xyz789",
"transactionTimestamp": "2007-12-03T10:15:30Z",
"transactionType": "abc123"
}
RemoteDataAkoyaMutualFundSecurityEntity
Description
Information about the mutual fund security specific to the type of security
Fields
| Field Name | Description |
|---|---|
mutualFundType - String | Mutual fund type |
reinvestCapitalGains - Boolean | Reinvest capital gains |
reinvestDividends - Boolean | Reinvest dividends |
unitsStreet - Float | Units in the FI's street name, positive quantity |
unitsUser - Float | Units in user's name directly, positive quantity |
yield - Float | Current yield reported as portion of the fund's assets |
yieldAsOfDate - DateTime | As-of date for yield value |
Example
{
"mutualFundType": "abc123",
"reinvestCapitalGains": false,
"reinvestDividends": true,
"unitsStreet": 123.45,
"unitsUser": 123.45,
"yield": 123.45,
"yieldAsOfDate": "2007-12-03T10:15:30Z"
}
RemoteDataAkoyaOptionSecurityEntity
Description
Information about the option security specific to the type of security
Example
{
"expireDate": "2007-12-03T10:15:30Z",
"optionType": "xyz789",
"secured": "xyz789",
"sharesPerContract": 987.65,
"strikePrice": 987.65
}
RemoteDataAkoyaOtherSecurityEntity
Description
Information about the security specific to the type of security
Fields
| Field Name | Description |
|---|---|
typeDescription - String | Description of Other Security |
Example
{"typeDescription": "xyz789"}
RemoteDataAkoyaPaymentDetails
Description
Payment details for some transactions
Fields
| Field Name | Description |
|---|---|
escrowAmount - Float | The amount of payment applied to escrow |
feesAmount - Float | The amount of payment applied to fees |
insuranceAmount - Float | The amount of payment applied to life/health/accident insurance on the loan |
interestAmount - Float | The amount of payment applied to interest |
pmiAmount - Float | The amount of payment applied to PMI |
principalAmount - Float | The amount of payment applied to principal |
Example
{
"escrowAmount": 123.45,
"feesAmount": 123.45,
"insuranceAmount": 987.65,
"interestAmount": 987.65,
"pmiAmount": 987.65,
"principalAmount": 123.45
}
RemoteDataAkoyaStockSecurityEntity
Description
Information about the stock security specific to the type of security
Fields
| Field Name | Description |
|---|---|
reinvestDividends - Boolean | Reinvest dividends |
stockType - String | |
unitsStreet - Float | Units in the FI's street name, positive quantity |
unitsUser - Float | Units in user's name directly, positive quantity |
yield - Float | Current yield |
yieldAsOfDate - DateTime | Yield as-of date |
Example
{
"reinvestDividends": true,
"stockType": "xyz789",
"unitsStreet": 123.45,
"unitsUser": 123.45,
"yield": 987.65,
"yieldAsOfDate": "2007-12-03T10:15:30Z"
}
RemoteDataAkoyaSweepSecurityEntity
Description
Information about the sweep security specific to the type of security
Example
{
"availableBalance": 123.45,
"balanceAsOf": "2007-12-03T10:15:30Z",
"checks": true,
"currentBalance": 123.45
}
RemoteDataAkoyaTaxLots
Description
RemoteData Akoya TaxLots
Fields
| Field Name | Description |
|---|---|
costBasis - Float | Total amount of money spent acquiring this lot including any fees or commission expenses incurred. |
currentValue - Float | Lot market value |
originalPurchaseDate - DateTime | Lot acquired date. |
postionType - String | LONG, SHORT. |
purchasedPrice - Float | Original purchase price. |
quantity - Float | Lot quantity. |
Example
{
"costBasis": 123.45,
"currentValue": 123.45,
"originalPurchaseDate": "2007-12-03T10:15:30Z",
"postionType": "xyz789",
"purchasedPrice": 123.45,
"quantity": 123.45
}
RemoteDataAkoyaTelephones
RemoteDataAkoyaToken
Description
Akoya Connection data.
Fields
| Field Name | Description |
|---|---|
accounts - [String!] | Array of Account Ids |
atHash - String | Access token hash value |
aud - [String!] | Data recipient |
authTime - Float | Auth Time |
connectorId - String | ID of Akoya Provider |
email - String | End-user's email address |
emailVerified - Boolean | True if end-user's email is verified, otherwise false |
exp - Float | Time token will expire in Unix Epoch format |
iat - Float | The time the token was issued in Unix Epoch format |
iss - String | Issuer of the JWT, Akoya |
jti - String | Id of Token |
locale - String | End-user's locale |
name - String | End-user's name in displayable form |
products - [String!] | Array of Enabled Akoya Products |
rat - Float | Timestamp |
recipientId - String | recipient Id |
sid - String | Session ID |
sub - String | Unique value to identify the end-user with the scope specific to the data provider |
Example
{
"accounts": ["xyz789"],
"atHash": "xyz789",
"aud": ["xyz789"],
"authTime": 987.65,
"connectorId": "abc123",
"email": "xyz789",
"emailVerified": false,
"exp": 987.65,
"iat": 123.45,
"iss": "abc123",
"jti": "abc123",
"locale": "abc123",
"name": "abc123",
"products": ["abc123"],
"rat": 987.65,
"recipientId": "abc123",
"sid": "abc123",
"sub": "abc123"
}
RemoteDataAkoyaTransaction
Description
Akoya Transaction data.
Fields
| Field Name | Description |
|---|---|
depositTransaction - RemoteDataAkoyaDepositTransaction | Deposit transaction |
insuranceTransaction - RemoteDataAkoyaInsuranceTransaction | Insurance transactions |
investmentTransaction - RemoteDataAkoyaInvestmentTransaction | Investment Transactions |
loanTransaction - RemoteDataAkoyaLoanTransaction | Loan Transaction |
locTransaction - RemoteDataAkoyaLocTransaction | A line of credit transaction of type |
Example
{
"depositTransaction": RemoteDataAkoyaDepositTransaction,
"insuranceTransaction": RemoteDataAkoyaInsuranceTransaction,
"investmentTransaction": RemoteDataAkoyaInvestmentTransaction,
"loanTransaction": RemoteDataAkoyaLoanTransaction,
"locTransaction": RemoteDataAkoyaLocTransaction
}
RemoteDataFingoalEnrichedTransaction
Description
Fingoal Enrichment data.
Fields
| Field Name | Description |
|---|---|
accountType - String | The type of account associated with the transaction (e.g., 'checking', 'savings') |
accountid - String | The ID of the account associated with the transaction |
address - String | The address associated with the transaction |
amountnum - Float | The transaction's USD amount |
category - String | The most applicable categorization for the transaction |
categoryId - Float | The numeric ID of the transaction's category |
city - String | The city associated with the transaction |
clientId - String | Your FinGoal client ID |
container - String | A high-level categorization of the account type. Eg, 'bank' |
date - DateTime | The date on which the transaction took place |
detailCategoryId - Float | The numeric ID of the transaction's detail category |
guid - String | The transaction's globally unique FinSight API issued ID |
highLevelCategoryId - Float | The numeric ID of the transaction's high level category |
isPhysical - Boolean | Whether the transaction was made at a physical location, or online |
isRecurring - Boolean | Whether the transaction is set to recur on a fixed interval |
merchantAddress1 - String | The street address of the merchant associated with the transaction |
merchantCity - String | The name of the city where the merchant is located |
merchantCountry - String | The name of the country where the merchant is located |
merchantLatitude - String | The latitude of the merchant |
merchantLogoUrl - String | The URL resource for the merchant's logo |
merchantLongitude - String | The longitude of the merchant |
merchantName - String | The name of the merchant associated with the transaction |
merchantPhoneNumber - String | The phone number of the merchant associated with the transaction |
merchantState - String | The name of the state where the merchant is located |
merchantType - String | The merchant's type |
merchantZip - String | The ZIP code where the merchant is located |
originalDescription - String | The transaction description as received. This will not change |
receiptDate - DateTime | The date on which FinSight API first received the transaction |
requestId - String | A unique ID for the request the transaction came in with, for debugging purposes |
settlement - String | The settlement type of the transaction (e.g., 'debit' or 'credit') |
simpleDescription - String | An easy-to-understand, plain-language transaction description |
sourceId - String | The source of the transaction |
state - String | The state associated with the transaction |
subType - String | A more detailed classification that provides further information on the type of transaction. |
subtype - String | A more detailed classification of the transaction |
tenantId - String | The ID of the tenant associated with this transaction, if one was included. |
transactionTags - [String!] | The FinSight API issued tags for the transaction |
transactionTagsId - [Int!] | The numeric IDs corresponding to the transaction tags |
transactionid - String | The ID of the transaction as it was originally submitted |
type - String | An attribute describing the nature of the intent behind the transaction. |
uid - String | The ID of the user associated with the transaction, as originally submitted |
website - String | The merchant's website URL |
zipCode - String | The ZIP code associated with the transaction |
Example
{
"accountType": "abc123",
"accountid": "xyz789",
"address": "xyz789",
"amountnum": 987.65,
"category": "xyz789",
"categoryId": 123.45,
"city": "xyz789",
"clientId": "xyz789",
"container": "abc123",
"date": "2007-12-03T10:15:30Z",
"detailCategoryId": 123.45,
"guid": "abc123",
"highLevelCategoryId": 987.65,
"isPhysical": false,
"isRecurring": true,
"merchantAddress1": "abc123",
"merchantCity": "xyz789",
"merchantCountry": "xyz789",
"merchantLatitude": "abc123",
"merchantLogoUrl": "abc123",
"merchantLongitude": "abc123",
"merchantName": "abc123",
"merchantPhoneNumber": "xyz789",
"merchantState": "xyz789",
"merchantType": "xyz789",
"merchantZip": "xyz789",
"originalDescription": "xyz789",
"receiptDate": "2007-12-03T10:15:30Z",
"requestId": "xyz789",
"settlement": "abc123",
"simpleDescription": "xyz789",
"sourceId": "abc123",
"state": "abc123",
"subType": "abc123",
"subtype": "xyz789",
"tenantId": "xyz789",
"transactionTags": ["xyz789"],
"transactionTagsId": [123],
"transactionid": "abc123",
"type": "abc123",
"uid": "xyz789",
"website": "xyz789",
"zipCode": "xyz789"
}
RemoteDataFingoalUser
Description
Fingoal Insights data.
Fields
| Field Name | Description |
|---|---|
clientId - String | Your client ID. |
id - String | The user ID. |
tags - [String!] | The FinSight API tags that were applied to the user. |
totaltransactions - Float | The total number of transactions the user has in FinSight API. |
transactionsSinceLastUpdate - Float | The number of transactions since the last time insights were run for the user. |
uid - String | The user's ID. |
uniqueId - String | The user's unique ID in the format of client_id:uid. |
Example
{
"clientId": "xyz789",
"id": "xyz789",
"tags": ["abc123"],
"totaltransactions": 123.45,
"transactionsSinceLastUpdate": 987.65,
"uid": "xyz789",
"uniqueId": "abc123"
}
RemoteDataFinicityAccountOwnerDetails
Description
Finicity Owner data.
Owner of a customer account
Fields
| Field Name | Description |
|---|---|
addresses - [RemoteDataFinicityAddresses!] | List of addresses |
documentations - [RemoteDataFinicityDocumentations!] | List of account owner documentation |
emails - [RemoteDataFinicityEmails!] | List of emails |
firstName - String | The first name of the account holder |
identityInsights - RemoteDataFinicityIdentityInsights | List of account owner Identity Insights |
lastName - String | The last name of the account holder |
middleName - String | The middle name of the account holder |
nameClassification - String | The classification of the account holder:
|
nameClassificationconfidencescore - Float | The confidence score 0 – 1.0 of the name classification. |
ownerName - String | The full name of the account owner. Multiple account owners are returned in one string per the source data from the institution. |
phones - [RemoteDataFinicityPhones!] | List of phones |
relationship - String | The type of relationship to the account:
|
suffix - String | A generational or academic suffix |
Example
{
"addresses": [RemoteDataFinicityAddresses],
"documentations": [RemoteDataFinicityDocumentations],
"emails": [RemoteDataFinicityEmails],
"firstName": "abc123",
"identityInsights": RemoteDataFinicityIdentityInsights,
"lastName": "xyz789",
"middleName": "abc123",
"nameClassification": "xyz789",
"nameClassificationconfidencescore": 987.65,
"ownerName": "abc123",
"phones": [RemoteDataFinicityPhones],
"relationship": "xyz789",
"suffix": "abc123"
}
RemoteDataFinicityAddresses
Description
Account owner address
Fields
| Field Name | Description |
|---|---|
city - String | City |
country - String | Country code is Iso3166-1 Alpha-2 code and Alpha 3 standard (max length 3). |
line1 - String | Address line 1 |
line2 - String | Address line 2 |
line3 - String | Address line 3 |
ownerAddress - String | A street address |
postalCode - String | A ZIP code |
state - String | State |
type - String | The type of address location:
|
Example
{
"city": "xyz789",
"country": "xyz789",
"line1": "abc123",
"line2": "abc123",
"line3": "abc123",
"ownerAddress": "abc123",
"postalCode": "abc123",
"state": "xyz789",
"type": "abc123"
}
RemoteDataFinicityCategorization
Description
Categorization Record
Fields
| Field Name | Description |
|---|---|
bestRepresentation - String | Combines the description and memo data together, removing duplicated information and numbers and special characters |
category - String | The different categories for transactions.
|
city - String | City |
country - String | Country code is Iso3166-1 Alpha-2 code and Alpha 3 standard (max length 3). |
normalizedPayeeName - String | A normalized payee, derived from the transaction's description and memo fields |
postalCode - String | A ZIP code |
state - String | State |
Example
{
"bestRepresentation": "abc123",
"category": "abc123",
"city": "xyz789",
"country": "xyz789",
"normalizedPayeeName": "abc123",
"postalCode": "abc123",
"state": "abc123"
}
RemoteDataFinicityConnectionDetails
Description
Finicity Connection data.
Example
{
"aggregationStatusCode": "abc123",
"customerId": "xyz789",
"institutionId": "abc123",
"institutionLoginId": "xyz789"
}
RemoteDataFinicityCustomerAccount
Description
Finicity Account data.
An account represents a bank account such as a checking or savings that the customer has added via the Connect interface.
Fields
| Field Name | Description |
|---|---|
accountNickname - String | The account nickname |
accountNumberDisplay - String | Account identifier derived by Mastercard from the account number provided by the financial institution. The format varies depending on the institution. We recommend using this to identify accounts if available. Below is a non-exhaustive list of examples for the
|
aggregationAttemptDate - BigInt | A timestamp showing the last aggregation attempt, whether successful or not. This will not be present until you have run your first aggregation for the account. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
aggregationStatusCode - Int | The status of the most recent aggregation attempt (see Aggregation Status Codes). Won't be present until you have run your first aggregation for the account. |
aggregationSuccessDate - BigInt | A timestamp showing the last successful aggregation of the account. This will not be present until you have run your first aggregation for the account. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
balance - Float | The cleared balance of the account as of balanceDate |
balanceDate - BigInt | A timestamp showing when the balance was captured by the FI. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
createdDate - BigInt | A timestamp showing when the account record was created. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
currency - String | A currency code |
customerId - String | A customer ID. See Add Customer API for how to create a customer ID. |
detail - RemoteDataFinicityDetail | Additional customer account details. Not all data points will return for each account type. You can see the account type that each data point will return for in descriptions. The data point are also subject to availability by the institution. |
displayPosition - Int | Display position of the account at the financial institution, "1" being the top listed account |
id - String | An account ID |
institutionId - String | The ID of a financial institution |
institutionLoginId - BigInt | An institution login ID (from the account record), represented as a number |
lastTransactionDate - BigInt | The date of the latest transaction on the account. This will not be present until you have run your first aggregation for the account. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
lastUpdatedDate - BigInt | A timestamp showing when the account was last modified. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
linkedAccountDate - BigInt | A timestamp showing when the customer first linked the account via Data Connect. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
marketSegment - String | The market segment of the account. Possible values: personal, business |
name - String | The account name from the institution |
oldestTransactionDate - BigInt | The date of the oldest transaction in the transactions for the account. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
parentAccount - String | The assigned account ID for the account one level higher in the student loan account hierarchy |
position - [RemoteDataFinicityPosition!] | Investment holdings |
realAccountNumberLast4 - String | The last 4 digits of the account number, derived by Mastercard from the account number provided by the financial institution. This is only returned for ACH-enabled accounts. |
status - String | "pending" during account discovery, always "active" following successful account activation |
type - String | The list of supported account types.
|
Example
{
"accountNickname": "abc123",
"accountNumberDisplay": "xyz789",
"aggregationAttemptDate": {},
"aggregationStatusCode": 987,
"aggregationSuccessDate": {},
"balance": 123.45,
"balanceDate": {},
"createdDate": {},
"currency": "abc123",
"customerId": "abc123",
"detail": RemoteDataFinicityDetail,
"displayPosition": 123,
"id": "xyz789",
"institutionId": "xyz789",
"institutionLoginId": {},
"lastTransactionDate": {},
"lastUpdatedDate": {},
"linkedAccountDate": {},
"marketSegment": "abc123",
"name": "abc123",
"oldestTransactionDate": {},
"parentAccount": "abc123",
"position": [RemoteDataFinicityPosition],
"realAccountNumberLast4": "abc123",
"status": "xyz789",
"type": "xyz789"
}
RemoteDataFinicityCustomerAccountPosition
Description
Finicity Holding data.
Details for investment account holdings
Fields
| Field Name | Description |
|---|---|
assetClass - String | An asset class is a grouping of comparable financial securities. These include equities (stocks), fixed income (bonds), and cash equivalent or money market instruments. (DOMESTICBOND, LARGESTOCK, INTLSTOCK, MONEYMRKT, OTHER) |
changePercent - Float | The percent change in value since the previous day |
costBasis - Float | The total cost of acquiring the security |
costBasisPerShare - Float | The per share cost of acquiring the security |
currencyRate - Float | Currency rate, ratio of currency to original currency |
currentPrice - Float | The current price of the investment holding |
currentPriceDate - BigInt | A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
dailyChange - Float | The value amount change since the previous day |
description - String | The description of the holding |
fiAssetClass - String | Financial Institution (FI) defined asset class (COMMON STOCK, COMNEQTY, EQUITY/STOCK, CMA-ISA, CONVERTIBLE PREFERREDS, CORPORATE BONDS, OTHER MONEY FUNDS, ALLOCATION FUNDS, CMA-TAXABLE, FOREIGNEQUITYADRS, COMMONSTOCK, PREFERRED STOCKS, STABLE VALUE, FOREIGN EQUITY ADRS) |
holdType - String | The type of the holding |
id - BigInt | The ID of the investment position |
invSecurityType - String | The security type for the investment holding |
marketValue - Float | Market value of an investment position at the time of retrieval |
mfType - String | Type of mutual fund, such as open ended |
optionExpireDate - Date | Expiration date of option |
optionSharesPerContract - Float | The number of shares per option contract |
optionStrikePrice - Float | The strike price of the option contract |
optionType - String | The type of option contract (PUT or CALL) |
posType - String | Fund type assigned by the FI (long or short) |
securityCurrency - String | Symbol for the currency that the account is being converted into |
securityId - String | The security ID of the transaction |
securityIdType - String | The security type. This field is related to the
|
securityName - String | The security name for the investment holding |
securityType - String | Type of security for the investment position |
status - String | The status of the holding |
subAccountType - String | The subaccount's type, such as cash |
symbol - String | The investment position's market ticker symbol |
todayGlDollar - Float | The current day's gain and loss of the position at the time of aggregation in dollars |
todayGlPercent - Float | The current day's gain and loss of the position at the time of aggregation in percentage |
totalGlDollar - Float | Total gain and loss of the position at the time of aggregation in dollars |
totalGlPercent - Float | Total gain and loss of the position at the time of aggregation in percentage |
transactionType - String | The transaction type of the holding, such as cash, margin, and more |
units - Float | The number of units of the holding |
Example
{
"assetClass": "abc123",
"changePercent": 987.65,
"costBasis": 123.45,
"costBasisPerShare": 987.65,
"currencyRate": 123.45,
"currentPrice": 987.65,
"currentPriceDate": {},
"dailyChange": 123.45,
"description": "abc123",
"fiAssetClass": "xyz789",
"holdType": "xyz789",
"id": {},
"invSecurityType": "xyz789",
"marketValue": 123.45,
"mfType": "xyz789",
"optionExpireDate": "2007-12-03",
"optionSharesPerContract": 987.65,
"optionStrikePrice": 123.45,
"optionType": "abc123",
"posType": "abc123",
"securityCurrency": "abc123",
"securityId": "xyz789",
"securityIdType": "xyz789",
"securityName": "abc123",
"securityType": "xyz789",
"status": "xyz789",
"subAccountType": "xyz789",
"symbol": "xyz789",
"todayGlDollar": 123.45,
"todayGlPercent": 123.45,
"totalGlDollar": 987.65,
"totalGlPercent": 987.65,
"transactionType": "abc123",
"units": 123.45
}
RemoteDataFinicityDetail
Description
Additional customer account details. Not all data points will return for each account type. You can see the account type that each data point will return for in descriptions. The data point are also subject to availability by the institution.
Fields
| Field Name | Description |
|---|---|
afterTaxAmount - Float | (Investment) After-tax amount of total balance |
autoPayEnrolled - String | (Mortgage/Loan) Enrolled in autopay (T/F or Y/N). |
availableBalanceAmount - Float | (Checking/Savings/CD/MoneyMarket) and (Mortgage/Loan) The available balance (typically the current balance with adjustments for any pending transactions) |
availableCashBalance - Float | (Investment) Amount available for cash withdrawal |
balloonAmount - Float | (Mortgage/Loan) Balloon payment amount |
buyPower - Float | (Investment) Money available to buy securities |
cashAccountAllowed - Boolean | Cash account allowed indicator (true / false) |
cashAdvanceAvailableAmount - Float | (Credit Card/Line Of Credit) Currently available cash advance |
cashAdvanceBalance - Float | (Credit Card/Line Of Credit) Balance of current cash advance |
cashAdvanceInterestRate - Float | (Credit Card/Line Of Credit) Interest rate for cash advances |
cashAdvanceMaxAmount - Float | (Credit Card/Line Of Credit) Maximum cash advance amount |
cashBalanceAmount - Float | (Investment) Cash balance of account |
collateral - String | (Mortgage/Loan) Collateral on loan |
contribTotalYtd - Float | (Investment) Total year to date contributions |
convertToRepayment - BigInt | (Student Loan) The date the loan enters into repayment. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
creditAvailableAmount - Float | (Credit Card/Line Of Credit) The available credit (typically the credit limit minus the current balance) |
creditMaxAmount - Float | (Credit Card/Line Of Credit) The account's credit limit |
currentBalance - Float | (Credit Card/Line Of Credit) and (Investment) Current balance |
currentLoanBalance - Float | (Investment) Current loan balance |
currentSchool - String | (Mortgage/Loan) Current school |
dateAsOf - BigInt | (All Account Types) Most recent date of the following information. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
daysDelinquent - Int | (Student Loan) The number of days past a due date that a payment should have been made |
description - String | (Mortgage/Loan) Description of loan |
empMatchAmount - Float | (Investment) Employer matched contributions |
empPretaxContribAmount - Float | (Investment) Employer pretax contribution amount |
empPretaxContribAmountYtd - Float | (Investment) Employer pretax contribution amount year to date |
endingBalanceAmount - Float | (Mortgage/Loan) Ending balance |
escrowBalance - Float | (Mortgage/Loan) The escrow balance |
expectedPayoffDate - BigInt | (Student Loan) The expected date of the payoff date. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
feesBalance - Float | (Student Loan) The total outstanding fees balance |
firstMortgage - Boolean | (Mortgage/Loan) First mortgage (F/Y) |
firstPaymentDate - BigInt | (Mortgage/Loan) First payment due date. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
guarantor - String | (Student Loan) The financial institution guarantor of the loan (who will pay the loan amount to the owner if the borrower defaults) |
initialInterestRate - Float | (Student Loan) Initial interest rate of loan |
initialMlAmount - Float | (Mortgage/Loan) Original loan amount |
initialMlDate - BigInt | (Mortgage/Loan) Original date of loan. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
interestBalance - Float | (Student Loan) The total outstanding interest balance |
interestPaidLtd - Float | (Mortgage/Loan) Interest paid since inception of loan (life to date) |
interestPeriod - String | (Mortgage/Loan) Period of interest |
interestPriorYtdAmount - Float | (Checking/Savings/CD/MoneyMarket) Interest earned in prior year |
interestRate - String | (Credit Card/Line Of Credit) and (Mortgage/Loan) The account's current interest rate |
interestRateType - String | (Mortgage/Loan) Type of interest rate |
interestSubsidyType - String | (Student Loan) The indication of the presence of an interest subsidy (i.e. subsidized) |
interestYtdAmount - Float | (Checking/Savings/CD/MoneyMarket) Interest accrued year-to-date |
lastPaymentAmount - Float | (Credit Card/Line Of Credit) and (Mortgage/Loan) The amount received in the last payment |
lastPaymentDate - BigInt | (Credit Card/Line Of Credit) The date of the last payment. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
lastPaymentDueDate - BigInt | (Mortgage/Loan) Due date of last payment. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
lastPaymentEscrowAmount - Float | (Mortgage/Loan) Amount towards escrow in last payment |
lastPaymentInterestAmount - Float | (Mortgage/Loan) Amount of interest in last payment |
lastPaymentLastFeeAmount - Float | (Mortgage/Loan) Amount of last fee in last payment |
lastPaymentLateCharge - Float | (Mortgage/Loan) Amount of late charge in last payment |
lastPaymentPrincipalAmount - Float | (Mortgage/Loan) Amount towards principal in last payment |
lastPaymentReceiveDate - BigInt | (Mortgage/Loan) The date of the last payment. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
lateFeeAmount - Float | (Mortgage/Loan) Late fee charged |
lender - String | (Mortgage/Loan) Owner of loan |
loanAwardId - String | (Student Loan) The federal unique loan identifying number |
loanPaymentFreq - String | (Mortgage/Loan) Frequency of payments (monthly, etc.) |
loanPaymentType - String | (Mortgage/Loan) Type of loan payment |
loanRate - Float | (Investment) Interest rate of loan |
loanStatus - String | (Student Loan) The repayment status phase (i.e. In School, Grace, Repayment, Deferment, Forbearance) |
loanStatusEndDate - BigInt | (Student Loan) The end date of the current status. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
loanStatusStartDate - BigInt | (Student Loan) The start date of the current status. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
loanTermType - String | (Mortgage/Loan) Type of loan term |
loanTypeDesc - String | (Mortgage/Loan) Description of the mortgage or loan type |
loanYtdFeesPaid - Float | (Student Loan) Loan fees paid year-to-date |
loanYtdInterestPaid - Float | (Student Loan) Loan interest paid year-to-date |
loanYtdPrincipalPaid - Float | (Student Loan) Loan principal paid year-to-date |
marginAllowed - Boolean | Margin trading indicator (true / false) |
marginBalance - Float | (Investment) Net interest earned after deducting interest paid out |
matchAmount - Float | (Investment) Amount matched |
maturityDate - BigInt | (Checking/Savings/CD/MoneyMarket) Maturity date of account type. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
maturityValueAmount - Float | (Investment) amount payable to an investor at maturity |
mlHolderName - String | (Mortgage/Loan) Holder of the mortgage or loan |
nextPayment - Float | (Mortgage/Loan) Minimum payment due |
nextPaymentDate - BigInt | (Mortgage/Loan) Due date for the next payment. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
nextPaymentInterestAmount - Float | (Mortgage/Loan) Amount of interest in next payment |
nextPaymentPrincipalAmount - Float | (Mortgage/Loan) Amount towards principal in next payment |
openDate - BigInt | (Checking/Savings/CD/MoneyMarket) Date when account was opened. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
originalInterestRate - Float | (Student Loan) The original interest rate to which the loan was disbursed, in APY |
originalMaturityDate - BigInt | (Mortgage/Loan) Original date of loan maturity. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
originalSchool - String | (Mortgage/Loan) Original school |
otherNonvestAmount - Float | (Investment) Other nonvested amount |
otherVestAmount - Float | (Investment) Other vested amount |
outOfSchoolDate - BigInt | (Student Loan) The date the borrower graduated or dropped below half-time enrollment in school. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
owner - String | (Student Loan) Owner of the loan |
pastDueAmount - Float | (Credit Card/Line Of Credit) and (Mortgage/Loan) Balance past due |
paymentDueDate - BigInt | (Credit Card/Line Of Credit) Due date for the next payment. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
paymentMinAmount - Float | (Credit Card/Line Of Credit) and (Mortgage/Loan) Minimum payment due |
paymentsMade - Int | (Mortgage/Loan) Number of payments made |
paymentsRemaining - Int | (Mortgage/Loan) Number of payments remaining before loan is paid off |
payoffAmount - Float | (Mortgage/Loan) The amount required to payoff the loan |
payoffAmountDate - BigInt | (Mortgage/Loan) Date of final payment. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
periodDepositAmount - Float | (Checking/Savings/CD/MoneyMarket) Amount deposited in period |
periodEndDate - BigInt | End date of period. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
periodInterestAmount - Float | (Checking/Savings/CD/MoneyMarket) Interest accrued during the current period |
periodInterestRate - Float | (Checking/Savings/CD/MoneyMarket) The APY for the current period interest rate |
periodStartDate - BigInt | (Checking/Savings/CD/MoneyMarket) Start date of period. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
preTaxAmount - Float | (Investment) Pre-tax amount of total balance |
previousBalance - Float | (Credit Card/Line Of Credit) Prior balance in last statement |
principalBalance - Float | (Mortgage/Loan) The principal balance |
profitSharingAmount - Float | (Investment) Amount of balance for profit sharing |
projectedInterest - Float | (Mortgage/Loan) Projected interest on the loan |
recurringPaymentAmount - Float | (Mortgage/Loan) Recurring payment amount |
remainingTermOfMl - Float | (Student Loan) The number of months still outstanding on a loan |
repaymentPlan - String | (Mortgage/Loan) Type of repayment plan for the student loan |
repaymentPlanEndDate - BigInt | (Student Loan) The end date of the current repayment plan. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
repaymentPlanStartDate - BigInt | (Student Loan) The start date of the current repayment plan. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
rewardEarnedBalance - Float | (Credit Card/Line Of Credit) Earned reward balance |
rolloverAmount - Float | (Investment) Amount of balance rolled over from original account (401k, etc.) |
rolloverLtd - Float | (Investment) Life to date of money rolled over |
shortBalance - Float | (Investment) Sum of short balance |
statementCloseBalance - Float | (Credit Card/Line Of Credit) Balance of statement at close |
statementCloseDate - BigInt | (Mortgage/Loan) Date the statement closed. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
statementCreditAmount - Float | (Credit Card/Line Of Credit) Credit amount applied in statement period |
statementEndDate - BigInt | (Credit Card/Line Of Credit) End date of statement period. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
statementFinanceAmount - Float | (Credit Card/Line Of Credit) Finance amount of statement period |
statementPurchaseAmount - Float | (Credit Card/Line Of Credit) Purchase amount of statement period |
statementStartDate - BigInt | (Credit Card/Line Of Credit) Start date of statement period. A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
termOfMl - String | (Mortgage/Loan) Length of loan in months |
totalAmountPaid - Float | (Student Loan) The total amount paid |
totalInterestPaid - Float | (Mortgage/Loan/Student Loan) The total amount paid towards interest |
totalPrincipalPaid - Float | (Mortgage/Loan/Student Loan) The total amount paid towards the principal balance |
vestedBalance - Float | (Investment) Vested amount in account |
weightedInterestRate - Float | (Student Loan) The interest rate of multiple interest rates and balances at the group level, in APY |
ytdInsurancePaid - Float | (Mortgage/Loan) Insurance paid year-to-date |
ytdInterestPaid - Float | (Mortgage/Loan) Interest paid year-to-date |
ytdPrincipalPaid - Float | (Mortgage/Loan) Principal paid year-to-date |
ytdTaxPaid - Float | (Mortgage/Loan) Tax paid year-to-date |
Example
{
"afterTaxAmount": 987.65,
"autoPayEnrolled": "xyz789",
"availableBalanceAmount": 123.45,
"availableCashBalance": 987.65,
"balloonAmount": 123.45,
"buyPower": 987.65,
"cashAccountAllowed": true,
"cashAdvanceAvailableAmount": 987.65,
"cashAdvanceBalance": 987.65,
"cashAdvanceInterestRate": 123.45,
"cashAdvanceMaxAmount": 987.65,
"cashBalanceAmount": 987.65,
"collateral": "xyz789",
"contribTotalYtd": 987.65,
"convertToRepayment": {},
"creditAvailableAmount": 987.65,
"creditMaxAmount": 123.45,
"currentBalance": 987.65,
"currentLoanBalance": 987.65,
"currentSchool": "xyz789",
"dateAsOf": {},
"daysDelinquent": 987,
"description": "abc123",
"empMatchAmount": 123.45,
"empPretaxContribAmount": 123.45,
"empPretaxContribAmountYtd": 987.65,
"endingBalanceAmount": 123.45,
"escrowBalance": 123.45,
"expectedPayoffDate": {},
"feesBalance": 987.65,
"firstMortgage": false,
"firstPaymentDate": {},
"guarantor": "abc123",
"initialInterestRate": 123.45,
"initialMlAmount": 123.45,
"initialMlDate": {},
"interestBalance": 123.45,
"interestPaidLtd": 123.45,
"interestPeriod": "xyz789",
"interestPriorYtdAmount": 123.45,
"interestRate": "xyz789",
"interestRateType": "abc123",
"interestSubsidyType": "abc123",
"interestYtdAmount": 987.65,
"lastPaymentAmount": 123.45,
"lastPaymentDate": {},
"lastPaymentDueDate": {},
"lastPaymentEscrowAmount": 987.65,
"lastPaymentInterestAmount": 987.65,
"lastPaymentLastFeeAmount": 987.65,
"lastPaymentLateCharge": 123.45,
"lastPaymentPrincipalAmount": 987.65,
"lastPaymentReceiveDate": {},
"lateFeeAmount": 987.65,
"lender": "xyz789",
"loanAwardId": "abc123",
"loanPaymentFreq": "abc123",
"loanPaymentType": "abc123",
"loanRate": 123.45,
"loanStatus": "xyz789",
"loanStatusEndDate": {},
"loanStatusStartDate": {},
"loanTermType": "abc123",
"loanTypeDesc": "xyz789",
"loanYtdFeesPaid": 123.45,
"loanYtdInterestPaid": 987.65,
"loanYtdPrincipalPaid": 987.65,
"marginAllowed": false,
"marginBalance": 123.45,
"matchAmount": 123.45,
"maturityDate": {},
"maturityValueAmount": 123.45,
"mlHolderName": "abc123",
"nextPayment": 123.45,
"nextPaymentDate": {},
"nextPaymentInterestAmount": 987.65,
"nextPaymentPrincipalAmount": 123.45,
"openDate": {},
"originalInterestRate": 987.65,
"originalMaturityDate": {},
"originalSchool": "abc123",
"otherNonvestAmount": 987.65,
"otherVestAmount": 123.45,
"outOfSchoolDate": {},
"owner": "abc123",
"pastDueAmount": 123.45,
"paymentDueDate": {},
"paymentMinAmount": 123.45,
"paymentsMade": 987,
"paymentsRemaining": 987,
"payoffAmount": 987.65,
"payoffAmountDate": {},
"periodDepositAmount": 123.45,
"periodEndDate": {},
"periodInterestAmount": 987.65,
"periodInterestRate": 123.45,
"periodStartDate": {},
"preTaxAmount": 987.65,
"previousBalance": 123.45,
"principalBalance": 987.65,
"profitSharingAmount": 987.65,
"projectedInterest": 987.65,
"recurringPaymentAmount": 987.65,
"remainingTermOfMl": 123.45,
"repaymentPlan": "abc123",
"repaymentPlanEndDate": {},
"repaymentPlanStartDate": {},
"rewardEarnedBalance": 987.65,
"rolloverAmount": 123.45,
"rolloverLtd": 123.45,
"shortBalance": 123.45,
"statementCloseBalance": 123.45,
"statementCloseDate": {},
"statementCreditAmount": 987.65,
"statementEndDate": {},
"statementFinanceAmount": 123.45,
"statementPurchaseAmount": 987.65,
"statementStartDate": {},
"termOfMl": "xyz789",
"totalAmountPaid": 987.65,
"totalInterestPaid": 987.65,
"totalPrincipalPaid": 123.45,
"vestedBalance": 123.45,
"weightedInterestRate": 123.45,
"ytdInsurancePaid": 123.45,
"ytdInterestPaid": 987.65,
"ytdPrincipalPaid": 987.65,
"ytdTaxPaid": 123.45
}
RemoteDataFinicityDetails
Description
More granular details of the device insights.
Fields
| Field Name | Description |
|---|---|
deviceInfo - RemoteDataFinicityDeviceInfo | This field contains information related to the consumer device used to authorize with your product or service. |
id - RemoteDataFinicityId | This field contains device identification information. |
Example
{
"deviceInfo": RemoteDataFinicityDeviceInfo,
"id": RemoteDataFinicityId
}
RemoteDataFinicityDevice
Description
Insights generated by analyzing the provided device data.
Fields
| Field Name | Description |
|---|---|
details - RemoteDataFinicityDetails | More granular details of the device insights. |
scores - RemoteDataFinicityScores | Scores that were calculated by analyzing the provided device data. |
Example
{
"details": RemoteDataFinicityDetails,
"scores": RemoteDataFinicityScores
}
RemoteDataFinicityDeviceInfo
Description
This field contains information related to the consumer device used to authorize with your product or service.
Example
{
"browser": "xyz789",
"deviceType": "xyz789",
"platform": "xyz789"
}
RemoteDataFinicityDocumentations
Description
Account owner documentation
Fields
| Field Name | Description |
|---|---|
governmentId - String | A federal or state issued identification number in alphanumeric characters.
|
taxId - String | Country specific tax ID associated with the customer.
|
taxIdCountry - String | Country code is Iso3166-1 Alpha-2 code and Alpha 3 standard (max length 3). |
Example
{
"governmentId": "abc123",
"taxId": "xyz789",
"taxIdCountry": "abc123"
}
RemoteDataFinicityEmails
RemoteDataFinicityId
Description
This field contains device identification information.
Fields
| Field Name | Description |
|---|---|
uDeviceId - String | The generated unique device identifier. |
Example
{"uDeviceId": "xyz789"}
RemoteDataFinicityIdentityInsights
Description
List of account owner Identity Insights
Fields
| Field Name | Description |
|---|---|
addressToName - String | The match status between the input name and the queried entity.
|
addressValidityLevel - String | The most granular level to which the address could be validated. Ex. If the address was only valid to the city level (but not to the house level), it would return “valid_to_city”.
street and house number level. This means the country, state, city, postal code, street, and house number of the input address are valid, but the subpremise of the input address was unable to be confirmed as valid or invalid. validated to the street and house number level. This means the country, state, city, postal code, street, and house number of the input address are valid, but the subpremise of the input address was missing and thus unable to be confirmed as valid or invalid. |
alerts - [String!] | |
device - RemoteDataFinicityDevice | Insights generated by analyzing the provided device data. |
emailDomainCreationDate - String | Returns a date that the email domain was created. |
emailFirstSeenDays - Float | Count of days since the email was first observed in Ekata's Identity Network. If the email has not been observed before, first_seen_days will be 0. |
emailRisk - Float | Email Risk Score assesses the risk level of an email address by leveraging features from our Identity Graph and Identity Network. It provides the strongest indicator of a high-risk email. |
emailToName - String | The match status between the input name and the queried entity.
|
identityRiskScore - Float | Comprehensive identity risk score with a higher score indicating a riskier account sign-up. |
ipAddressDistance - Float | The distance (in miles) between the IP address and the physical address. |
ipGeolocationCountryCode - String | The ISO-3166 alpha-2 country code associated with the geolocation of the IP address. |
ipGeolocationSubdivision - String | More granular detail about the IP address location. |
ipLastSeenDays - Float | Count of days since the IP address was last observed in Ekata's Identity Network. If the IP address has not been observed before, IpLastSeenDays will be 0. |
ipPhoneDistance - Float | The distance (in miles) between the IP address and the closest physical address associated with the phone number. |
ipRisk - Boolean | True if the IP address is considered risky, based on multiple IP data points and velocity calculations. |
ipRiskScore - Float | Comprehensive risk score associated with an IP address, with a higher score indicating a riskier IP address. A number between 0 and 1 rounded to three decimal places. |
isEmailValid - Boolean | True if the email address is valid. |
isPhoneValid - Boolean | True if the phone number is valid. |
phoneCarrier - String | The company that provides voice and/or data services for the phone number. Carriers are returned at the MVNO level. |
phoneCountryCode - String | The ISO-3166 alpha-2 country code associated with the phone number. |
phoneEmailFirstSeenDays - Float | Count of days since the combination of phone and email was first observed in Ekata's Identity Network. If that combination has not been observed before, phoneEmailFirstSeenDays will be 0. |
phoneLastSeenDays - Float | Count of days since the phone was last observed in Ekata's Identity Network. If the phone has not been observed before, phoneLastSeenDays will be 0. |
phoneLineType - String | The line type of the phone number.
|
phoneToAddress - String | The match status between the input phone and the queried entity.
|
phoneToName - String | The match status between the input name and the queried entity.
|
requestRefId - String | The generated unique web transaction identifier. |
warnings - [String!] |
Example
{
"addressToName": "abc123",
"addressValidityLevel": "abc123",
"alerts": ["xyz789"],
"device": RemoteDataFinicityDevice,
"emailDomainCreationDate": "abc123",
"emailFirstSeenDays": 123.45,
"emailRisk": 123.45,
"emailToName": "xyz789",
"identityRiskScore": 987.65,
"ipAddressDistance": 123.45,
"ipGeolocationCountryCode": "abc123",
"ipGeolocationSubdivision": "xyz789",
"ipLastSeenDays": 987.65,
"ipPhoneDistance": 123.45,
"ipRisk": true,
"ipRiskScore": 987.65,
"isEmailValid": true,
"isPhoneValid": false,
"phoneCarrier": "xyz789",
"phoneCountryCode": "xyz789",
"phoneEmailFirstSeenDays": 987.65,
"phoneLastSeenDays": 987.65,
"phoneLineType": "abc123",
"phoneToAddress": "abc123",
"phoneToName": "xyz789",
"requestRefId": "abc123",
"warnings": ["xyz789"]
}
RemoteDataFinicityPhones
Description
Consumer phone
Example
{
"country": "xyz789",
"phone": "xyz789",
"type": "xyz789"
}
RemoteDataFinicityPosition
Description
Details for investment account holdings
Fields
| Field Name | Description |
|---|---|
assetClass - String | An asset class is a grouping of comparable financial securities. These include equities (stocks), fixed income (bonds), and cash equivalent or money market instruments. (DOMESTICBOND, LARGESTOCK, INTLSTOCK, MONEYMRKT, OTHER) |
changePercent - Float | The percent change in value since the previous day |
costBasis - Float | The total cost of acquiring the security |
costBasisPerShare - Float | The per share cost of acquiring the security |
currencyRate - Float | Currency rate, ratio of currency to original currency |
currentPrice - Float | The current price of the investment holding |
currentPriceDate - BigInt | A date in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. |
dailyChange - Float | The value amount change since the previous day |
description - String | The description of the holding |
fiAssetClass - String | Financial Institution (FI) defined asset class (COMMON STOCK, COMNEQTY, EQUITY/STOCK, CMA-ISA, CONVERTIBLE PREFERREDS, CORPORATE BONDS, OTHER MONEY FUNDS, ALLOCATION FUNDS, CMA-TAXABLE, FOREIGNEQUITYADRS, COMMONSTOCK, PREFERRED STOCKS, STABLE VALUE, FOREIGN EQUITY ADRS) |
holdType - String | The type of the holding |
id - BigInt | The ID of the investment position |
invSecurityType - String | The security type for the investment holding |
marketValue - Float | Market value of an investment position at the time of retrieval |
mfType - String | Type of mutual fund, such as open ended |
optionExpireDate - Date | Expiration date of option |
optionSharesPerContract - Float | The number of shares per option contract |
optionStrikePrice - Float | The strike price of the option contract |
optionType - String | The type of option contract (PUT or CALL) |
posType - String | Fund type assigned by the FI (long or short) |
securityCurrency - String | Symbol for the currency that the account is being converted into |
securityId - String | The security ID of the transaction |
securityIdType - String | The security type. This field is related to the
|
securityName - String | The security name for the investment holding |
securityType - String | Type of security for the investment position |
status - String | The status of the holding |
subAccountType - String | The subaccount's type, such as cash |
symbol - String | The investment position's market ticker symbol |
todayGlDollar - Float | The current day's gain and loss of the position at the time of aggregation in dollars |
todayGlPercent - Float | The current day's gain and loss of the position at the time of aggregation in percentage |
totalGlDollar - Float | Total gain and loss of the position at the time of aggregation in dollars |
totalGlPercent - Float | Total gain and loss of the position at the time of aggregation in percentage |
transactionType - String | The transaction type of the holding, such as cash, margin, and more |
units - Float | The number of units of the holding |
Example
{
"assetClass": "abc123",
"changePercent": 123.45,
"costBasis": 123.45,
"costBasisPerShare": 987.65,
"currencyRate": 987.65,
"currentPrice": 987.65,
"currentPriceDate": {},
"dailyChange": 123.45,
"description": "abc123",
"fiAssetClass": "xyz789",
"holdType": "abc123",
"id": {},
"invSecurityType": "abc123",
"marketValue": 123.45,
"mfType": "xyz789",
"optionExpireDate": "2007-12-03",
"optionSharesPerContract": 987.65,
"optionStrikePrice": 123.45,
"optionType": "xyz789",
"posType": "xyz789",
"securityCurrency": "xyz789",
"securityId": "xyz789",
"securityIdType": "abc123",
"securityName": "abc123",
"securityType": "abc123",
"status": "abc123",
"subAccountType": "abc123",
"symbol": "xyz789",
"todayGlDollar": 987.65,
"todayGlPercent": 123.45,
"totalGlDollar": 987.65,
"totalGlPercent": 123.45,
"transactionType": "xyz789",
"units": 987.65
}
RemoteDataFinicityScores
Description
Scores that were calculated by analyzing the provided device data.
Fields
| Field Name | Description |
|---|---|
deviceInsightFactor - Int | The calculated device risk is represented numerically using a range from 1 (no/low risk) to 5 (high risk). Each numerical value and it's associated risk representation is shown below.
The calculated risk score is typically used to identify scenarios where a service provider may want to introduce consumer friction on the authorization process to validate the identity of the consumer. Example usage by a service provider may be to implement controls such as multifactor authentication for calculated risk factors of |
deviceRiskFactor - Int | The calculated risk factor is represented numerically using a range from 1 (no/low risk) to 5 (high risk). Each numerical value and it's associated risk representation is shown below.
The calculated risk factor is typically used to identify scenarios where a service provider may want to introduce consumer friction on the authorization process to validate the identity of the consumer. Example usage by a service provider may be to implement controls such as multifactor authentication for calculated risk factors of |
deviceTrustFactor - Int | An integer between 1-5 (1 being no trust and 5 being high trust). The trust factor value reflects the trustworthiness of the attributes associated with this device. |
Example
{"deviceInsightFactor": 123, "deviceRiskFactor": 123, "deviceTrustFactor": 123}
RemoteDataFinicityTransaction
Description
Finicity Transaction data.
Fields
| Field Name | Description |
|---|---|
accountId - BigInt | An account ID represented as a number |
amount - Float | The total amount of the transaction. Transactions for deposits are positive values, withdrawals and debits are negative values. |
categorization - RemoteDataFinicityCategorization | Categorization Record |
checkNum - String | The reference for the transaction provided by the originating institution. |
commissionAmount - Float | Transaction commission |
createdDate - BigInt | A date in Unix epoch time (in seconds). Represents the timestamp of the transaction when it was added to our platform. See: Handling Epoch Dates and Times. |
currencySymbol - String | If the foreign amount value is present then this is the currency code of that foreign amount |
customerId - BigInt | A customer ID represented as a number. See Add Customer API for how to create a customer ID. |
description - String | The description value is from the financial institution (FI), often known as the payee. The value "No description provided by institution" is returned when the FI doesn't provide one |
effectiveDate - BigInt | A date in Unix epoch time (in seconds). Represents the timestamp of the transaction when it became effective on an account by an institution. See: Handling Epoch Dates and Times. |
escrowAmount - Float | The portion of the transaction allocated to escrow |
feeAmount - Float | The portion of the overall transaction amount applied to fees |
firstEffectiveDate - BigInt | A date in Unix epoch time (in seconds). Represents the first timestamp of the transaction recorded in the effectiveDate field. See: Handling Epoch Dates and Times. |
id - BigInt | A transaction ID |
incomeType - String | Capital gains applied in short, long, or miscellaneous terms for tax purposes |
interestAmount - Float | The portion of the transaction allocated to interest |
investmentTransactionType - String | Keywords in the Possible values:
|
memo - String | The institution must provide either a description, a memo, or both. We recommended concatenating the two fields into a single value. |
optionExpireDate - BigInt | A date in Unix epoch time (in seconds). Represents the timestamp of the transaction expiration date when it became expires on an account by an institution. See: Handling Epoch Dates and Times. |
optionStrikePrice - Float | The strike price of the option contract |
postedDate - BigInt | A date in Unix epoch time (in seconds). Represents the timestamp of the transaction when it was posted or cleared by the institution. This value isn't required for student loan transaction data. See: Handling Epoch Dates and Times. |
principalAmount - Float | The portion of the transaction allocated to principal |
runningBalanceAmount - Float | The ending balance after the transaction was posted |
securityId - String | The security ID of the transaction |
securityIdType - String | The security type. This field is related to the
|
sharesPerContract - Float | Shares per contract of the underlying stock option |
splitDenominator - Float | Denominator of the stock split for the transaction |
splitNumerator - Float | Numerator of the stock split for the transaction |
status - String | One of "active", "pending", or "shadow" (see Transaction Status) |
subAccountFund - String | The sub account where the funds came from |
subaccountSecurityType - String | The type of sub account the funds came from |
suspenseAmount - Float | Temporarily hold funds if you overpay or underpay your monthly payment |
taxesAmount - Float | Taxes applicable to the investment trade |
ticker - String | Ticker symbol for the investment related to the transaction |
transactionDate - BigInt | A date in Unix epoch time (in seconds). Represents the timestamp of the transaction when it occurred. See: Handling Epoch Dates and Times. |
type - String | If provided by the institution, the following values may be returned in the field of a record:
|
unitPrice - Float | Share price for the investment unit: stocks, mutual funds, ETFs |
unitQuantity - Float | The number of units (individual shares) in the transaction |
Example
{
"accountId": {},
"amount": 987.65,
"categorization": RemoteDataFinicityCategorization,
"checkNum": "xyz789",
"commissionAmount": 987.65,
"createdDate": {},
"currencySymbol": "xyz789",
"customerId": {},
"description": "xyz789",
"effectiveDate": {},
"escrowAmount": 987.65,
"feeAmount": 987.65,
"firstEffectiveDate": {},
"id": {},
"incomeType": "xyz789",
"interestAmount": 123.45,
"investmentTransactionType": "abc123",
"memo": "abc123",
"optionExpireDate": {},
"optionStrikePrice": 987.65,
"postedDate": {},
"principalAmount": 987.65,
"runningBalanceAmount": 123.45,
"securityId": "abc123",
"securityIdType": "abc123",
"sharesPerContract": 123.45,
"splitDenominator": 987.65,
"splitNumerator": 987.65,
"status": "xyz789",
"subAccountFund": "xyz789",
"subaccountSecurityType": "xyz789",
"suspenseAmount": 987.65,
"taxesAmount": 123.45,
"ticker": "xyz789",
"transactionDate": {},
"type": "xyz789",
"unitPrice": 987.65,
"unitQuantity": 987.65
}
RemoteDataMockAccount
Description
Mock Account data.
Example
{
"balance": "abc123",
"currency": "xyz789",
"id": "xyz789",
"mask": "xyz789",
"name": "xyz789",
"type": "abc123"
}
RemoteDataMockAddress
RemoteDataMockConnection
RemoteDataMockOwner
Description
Mock Owner data.
Fields
| Field Name | Description |
|---|---|
address - RemoteDataMockAddress | Address |
email - String | |
name - String | Name |
phone - String | Phone |
Example
{
"address": RemoteDataMockAddress,
"email": "abc123",
"name": "abc123",
"phone": "xyz789"
}
RemoteDataMockTransaction
Description
Mock Transaction data.
Example
{
"accountId": "xyz789",
"amount": "xyz789",
"category": "xyz789",
"currencyCode": "abc123",
"date": "xyz789",
"description": "xyz789",
"id": "abc123",
"status": "abc123"
}
RemoteDataMxAccount
Description
Mx Account data.
Fields
| Field Name | Description |
|---|---|
accountNumber - String | The account number associated with the account. This will typically be a masked or partial account number. |
accountNumberSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
accountOwnership - String | The ownership type of the account (e.g., INDIVIDUAL, JOINT, TRUST). |
annuityPolicyToDate - String | The date when the annuity policy ends. |
annuityProvider - String | The provider of the annuity. |
annuityTermYear - Int | The term of the annuity in years. |
apr - Float | The annual percentage rate associated with the account. |
aprSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
apy - Float | The annual percentage yield associated with the account. |
apySetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
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. |
availableBalanceSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
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. |
availableCreditSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
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. |
balanceSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
calculatedApr - Float | An APR for the account, calculated using transaction data. This is currently calculated only for accounts with type CREDIT_CARD, but more account types may be added. |
cashBalance - Float | The cash balance of the account. |
cashBalanceSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
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. |
cashSurrenderValueSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
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. |
creditLimitSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
currencyCode - String | The three-character ISO 4217 currency code. |
currencyCodeSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
dayPaymentIsDue - Int | The day of the month the payment is due. For example, the 14th is passed as 14. |
dayPaymentIsDueSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
deathBenefit - Int | The amount paid to the beneficiary of the account upon death of the account owner. |
deathBenefitSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
federalInsuranceStatus - String | The federal insurance status of the account. Indicates whether the account is insured by the FDIC or NCUA (FDIC for banks, NCUA for credit unions). The possible values are INSURED and NOT_INSURED. |
feedAccountNumber - String | The account number, as provided by our data feed. See account_number for more information. |
feedAccountSubtype - Int | The account subtype, as provided by our data feed. See subtype for more information. |
feedAccountType - Int | The account type, as provided by our data feed. See type for more information. |
feedApr - Float | The apr, as provided by our data feed. |
feedApy - Float | The apy, as provided by our data feed. |
feedAvailableBalance - Float | The available balance, as provided by our data feed. |
feedBalance - Float | The balance, as provided by our data feed. |
feedCashBalance - Float | The cash balance, as provided by our data feed. |
feedCashSurrenderValue - Float | The cash surrender value, as provided by our data feed. |
feedCreditLimit - Float | The credit limit, as provided by our data feed. |
feedCurrencyCode - String | The currency code, as provided by our data feed. |
feedDayPaymentIsDue - Int | The day payment is due, as provided by our data feed. |
feedDeathBenefit - Int | The death benefit, as provided by our data feed. |
feedHoldingsValue - Float | The holdings value, as provided by our data feed. |
feedInterestRate - Float | The interest rate, as provided by our data feed. |
feedIsClosed - Boolean | The is_closed status, as provided by our data feed. |
feedLastPayment - Float | The last payment amount, as provided by our data feed. |
feedLastPaymentAt - String | The date of the last payment, as provided by our data feed. |
feedLoanAmount - Float | The loan amount, as provided by our data feed. |
feedMaturesOn - String | The maturity date, as provided by our data feed. |
feedMinimumBalance - Float | The minimum balance, as provided by our data feed. |
feedMinimumPayment - Float | The minimum payment, as provided by our data feed. |
feedName - String | The account name, as provided by our data feed. |
feedNickname - String | The account nickname, as provided by our data feed. |
feedOriginalBalance - Float | The original balance, as provided by our data feed. |
feedPaymentDueAt - String | The payment due date, as provided by our data feed. |
feedPayoffBalance - Float | The payoff balance, as provided by our data feed. |
feedRoutingNumber - String | The routing number, as provided by our data feed. |
feedStartedOn - String | The start date, as provided by our data feed. |
feedStatementBalance - Float | The statement balance, as provided by our data feed. |
feedTotalAccountValue - Float | The total account value, as provided by our data feed. |
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. |
holdingsValueSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
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. |
institutionGuid - 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. |
interestRateSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
isClosed - Boolean | This indicates whether an account has been closed. |
isClosedSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
isHidden - Boolean | This indicates whether the account is hidden. Defaults to false. |
isManual - Boolean | This indicates whether the account was created manually. |
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. |
lastPaymentAtSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
lastPaymentSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
loanAmount - Float | The amount of the loan associated with the account. |
loanAmountSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
marginBalance - Float | The margin balance of the account. |
maturesOn - String | The date on which the account matures. |
maturesOnSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
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. |
minimumBalanceSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
minimumPayment - Float | The minimum payment required for an account. This can apply to any debt account. |
minimumPaymentSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
name - String | The human-readable name for the account. |
nameSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
nickname - String | An alternate name for the account. |
nicknameSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
originalBalance - Float | The original balance associated with the account. This will always be positive. |
originalBalanceSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
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. |
paymentDueAtSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
payoffBalance - Float | The payoff balance for a debt account. This will normally be a positive number. |
payoffBalanceSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
premiumAmount - Float | The insurance policy's premium amount. |
propertyType - String | The type of property associated with the account (e.g., VEHICLE, REAL_ESTATE). |
routingNumber - String | The routing number for the account. |
startedOn - String | The date on which a debt account was started. |
startedOnSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
statementBalance - Float | The balance at the end of the account's last statement period. |
statementBalanceSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
subtype - String | The account's subtype, e.g., PLAN_401_K, MONEY_MARKET, or HOME_EQUITY. |
subtypeSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
todayUglAmount - Float | The unrealized gain/loss amount for today. |
todayUglPercentage - Float | The unrealized gain/loss percentage for today. |
totalAccountValue - Float | The total value of the account. |
totalAccountValueSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
totalAccountValueUgl - Float | The unrealized gains and losses represent the amount the account has gained or lost based on the purchase price. This is calculated by subtracting the purchase price from the current market value. It does not affect the account until the positions are sold and realized. This may sum to a negative value, and it does not represent an account balance. |
type - String | The general or parent type of the account. |
typeSetBy - Int | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). |
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. |
Example
{
"accountNumber": "xyz789",
"accountNumberSetBy": 987,
"accountOwnership": "xyz789",
"annuityPolicyToDate": "abc123",
"annuityProvider": "xyz789",
"annuityTermYear": 123,
"apr": 987.65,
"aprSetBy": 987,
"apy": 987.65,
"apySetBy": 123,
"availableBalance": 123.45,
"availableBalanceSetBy": 123,
"availableCredit": 123.45,
"availableCreditSetBy": 123,
"balance": 123.45,
"balanceSetBy": 123,
"calculatedApr": 987.65,
"cashBalance": 123.45,
"cashBalanceSetBy": 987,
"cashSurrenderValue": 987.65,
"cashSurrenderValueSetBy": 123,
"createdAt": "xyz789",
"creditLimit": 123.45,
"creditLimitSetBy": 987,
"currencyCode": "abc123",
"currencyCodeSetBy": 987,
"dayPaymentIsDue": 123,
"dayPaymentIsDueSetBy": 123,
"deathBenefit": 123,
"deathBenefitSetBy": 987,
"federalInsuranceStatus": "xyz789",
"feedAccountNumber": "abc123",
"feedAccountSubtype": 987,
"feedAccountType": 987,
"feedApr": 123.45,
"feedApy": 123.45,
"feedAvailableBalance": 123.45,
"feedBalance": 987.65,
"feedCashBalance": 123.45,
"feedCashSurrenderValue": 987.65,
"feedCreditLimit": 987.65,
"feedCurrencyCode": "abc123",
"feedDayPaymentIsDue": 987,
"feedDeathBenefit": 987,
"feedHoldingsValue": 987.65,
"feedInterestRate": 123.45,
"feedIsClosed": true,
"feedLastPayment": 987.65,
"feedLastPaymentAt": "abc123",
"feedLoanAmount": 987.65,
"feedMaturesOn": "abc123",
"feedMinimumBalance": 987.65,
"feedMinimumPayment": 987.65,
"feedName": "xyz789",
"feedNickname": "abc123",
"feedOriginalBalance": 123.45,
"feedPaymentDueAt": "abc123",
"feedPayoffBalance": 123.45,
"feedRoutingNumber": "xyz789",
"feedStartedOn": "xyz789",
"feedStatementBalance": 123.45,
"feedTotalAccountValue": 987.65,
"guid": "xyz789",
"holdingsValue": 123.45,
"holdingsValueSetBy": 987,
"id": "xyz789",
"importedAt": "abc123",
"institutionCode": "abc123",
"institutionGuid": "xyz789",
"insuredName": "xyz789",
"interestRate": 123.45,
"interestRateSetBy": 987,
"isClosed": true,
"isClosedSetBy": 123,
"isHidden": true,
"isManual": true,
"lastPayment": 123.45,
"lastPaymentAt": "abc123",
"lastPaymentAtSetBy": 123,
"lastPaymentSetBy": 123,
"loanAmount": 987.65,
"loanAmountSetBy": 123,
"marginBalance": 123.45,
"maturesOn": "xyz789",
"maturesOnSetBy": 123,
"memberGuid": "xyz789",
"memberId": "abc123",
"memberIsManagedByUser": false,
"metadata": "xyz789",
"minimumBalance": 123.45,
"minimumBalanceSetBy": 123,
"minimumPayment": 987.65,
"minimumPaymentSetBy": 987,
"name": "xyz789",
"nameSetBy": 987,
"nickname": "xyz789",
"nicknameSetBy": 123,
"originalBalance": 987.65,
"originalBalanceSetBy": 123,
"payOutAmount": 123.45,
"paymentDueAt": "abc123",
"paymentDueAtSetBy": 987,
"payoffBalance": 123.45,
"payoffBalanceSetBy": 123,
"premiumAmount": 123.45,
"propertyType": "xyz789",
"routingNumber": "abc123",
"startedOn": "xyz789",
"startedOnSetBy": 987,
"statementBalance": 123.45,
"statementBalanceSetBy": 123,
"subtype": "abc123",
"subtypeSetBy": 123,
"todayUglAmount": 987.65,
"todayUglPercentage": 987.65,
"totalAccountValue": 123.45,
"totalAccountValueSetBy": 987,
"totalAccountValueUgl": 987.65,
"type": "abc123",
"typeSetBy": 123,
"updatedAt": "abc123",
"userGuid": "xyz789",
"userId": "xyz789"
}
RemoteDataMxAccountOwner
Description
Mx Owner data.
Fields
| Field Name | Description |
|---|---|
accountGuid - String | The unique identifier for the account associated with the account owner. Defined by MX. |
address - String | The account owner's street address. |
city - String | The account owner's city. |
country - String | The account owner's country. |
email - String | The account owner's email address. |
firstName - String | The account owner's first name. This may also include a middle name. This field will be null unless name splitting has been enabled. Contact MX to have this feature enabled. |
guid - String | The unique identifier for the account owner. Defined by MX. |
lastName - String | The account owner's last name. This field will be null unless name splitting has been enabled. Contact MX to have this feature enabled. |
memberGuid - String | The unique identifier for the member associated with the account owner. Defined by MX. |
ownerName - String | The account owner's name. |
phone - String | The account owner's phone number. |
postalCode - String | The account owner's postal code. |
state - String | The account owner's state. |
userGuid - String | The unique identifier for the user associated with the account owner. Defined by MX. |
Example
{
"accountGuid": "abc123",
"address": "xyz789",
"city": "xyz789",
"country": "abc123",
"email": "xyz789",
"firstName": "xyz789",
"guid": "xyz789",
"lastName": "xyz789",
"memberGuid": "xyz789",
"ownerName": "xyz789",
"phone": "xyz789",
"postalCode": "xyz789",
"state": "abc123",
"userGuid": "xyz789"
}
RemoteDataMxEnhanceTransaction
Description
Mx Enrichment data.
Fields
| Field Name | Description |
|---|---|
amount - Float | The monetary amount of the transaction. |
categorizedBy - Int | The method used to determine the category assigned to the transaction |
category - String | The category of the transaction. |
categoryGuid - String | The unique identifier for the category assigned to the transaction. |
describedBy - Int | The method used to describe the transaction |
description - String | A human-readable version of the original_description field described below, e.g., “Sam's Club,” “Johnny's Tavern.” This is provided by the MX Platform. |
extendedTransactionType - String | The transaction type assigned by the partner. |
id - String | The unique partner-defined identifier for the transaction. This can only be set for partner-managed transactions. It should be ignored for user-managed transactions, even in occasional cases where it may return with a value. |
isBillPay - Boolean | This indicates whether the transaction represents a bill pay. |
isDirectDeposit - Boolean | This indicates whether the transaction represents a direct deposit. |
isExpense - Boolean | This indicates whether the transaction represents an expense. |
isFee - Boolean | This indicates whether the transaction represents a fee. |
isIncome - Boolean | This indicates whether the transaction represents income. |
isInternational - Boolean | If the transaction is international as defined by the data provider, this field will be true. If the data provider determines it is not international then it will be false. It will be null if the data provider does not have this information. |
isOverdraftFee - Boolean | This indicates whether the transaction represents an overdraft fee. |
isPayrollAdvance - Boolean | This indicates whether the transaction represents a payroll advance. |
isSubscription - Boolean | This indicates whether the transaction represents a payment for a subscription service such as Netflix or Audible. |
memo - String | This field contains additional descriptive information about the transaction. |
merchantCategoryCode - Int | The ISO 18245 category code for the transaction. |
merchantGuid - String | The unique identifier for the merchant associated with this transaction. Defined by MX. |
merchantLocationGuid - String | The unique identifier for the merchant_location associated with this transaction. Defined by MX. |
originalDescription - String | The original description of the transaction as provided by our data feed. See description above for more information. |
type - String | The type of transaction. This will be either CREDIT or DEBIT. |
Example
{
"amount": 987.65,
"categorizedBy": 123,
"category": "xyz789",
"categoryGuid": "abc123",
"describedBy": 987,
"description": "abc123",
"extendedTransactionType": "xyz789",
"id": "abc123",
"isBillPay": false,
"isDirectDeposit": false,
"isExpense": false,
"isFee": true,
"isIncome": true,
"isInternational": true,
"isOverdraftFee": true,
"isPayrollAdvance": true,
"isSubscription": false,
"memo": "xyz789",
"merchantCategoryCode": 987,
"merchantGuid": "xyz789",
"merchantLocationGuid": "xyz789",
"originalDescription": "xyz789",
"type": "abc123"
}
RemoteDataMxMember
Description
Mx Connection data.
Fields
| Field Name | 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. |
connectionStatusMessage - String | A message that can be displayed to the user to help them navigate the connection and aggregation process. |
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. |
institutionGuid - 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. |
isManual - Boolean | This indicates whether the member is for manually created accounts. |
isOauth - Boolean | This indicates whether the member uses OAuth to authenticate. Defaults to false. |
metadata - String | Additional information you can store on this member. |
mostRecentJobDetailCode - Int | (Deprecated) This field is no longer used and will be removed at a future date. |
mostRecentJobDetailText - Boolean | (Deprecated) This field is no longer used and will be removed at a future date. |
mostRecentJobGuid - String | The unique identifier for the most recent job. Defined by MX. |
name - String | The name of the member. |
needsUpdatedCredentials - Boolean | Internal field used by MX in some circumstances. When set to true, MX will not attempt to aggregate the member. It will be set to false automatically when the member's credentials are updated. |
oauthWindowUri - String | A URL used for OAuth authentication flow for the specified member. |
successfullyAggregatedAt - String | The date and time the member was last successfully aggregated. |
useCases - [String!] | The use case associated with the member. Valid values are PFM and/or MONEY_MOVEMENT. Only set this if you've met with MX and have opted in to using this field. |
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. |
Example
{
"aggregatedAt": "abc123",
"backgroundAggregationIsDisabled": false,
"connectionStatus": "xyz789",
"connectionStatusMessage": "abc123",
"guid": "xyz789",
"id": "abc123",
"institutionCode": "abc123",
"institutionGuid": "xyz789",
"isBeingAggregated": false,
"isManagedByUser": false,
"isManual": true,
"isOauth": false,
"metadata": "abc123",
"mostRecentJobDetailCode": 987,
"mostRecentJobDetailText": false,
"mostRecentJobGuid": "abc123",
"name": "abc123",
"needsUpdatedCredentials": true,
"oauthWindowUri": "xyz789",
"successfullyAggregatedAt": "xyz789",
"useCases": ["xyz789"],
"userGuid": "abc123",
"userId": "xyz789"
}
RemoteDataMxTransaction
Description
Mx Transaction data.
Fields
| Field Name | Description |
|---|---|
accountGuid - String | The unique identifier for the account associated with the transaction. Defined by MX. |
accountId - String | The unique partner-defined identifier for the account associated with the transaction. This can only be set for partner-managed accounts. It should be ignored for user-managed transactions, even in occasional cases where it may return with a value. |
amount - Float | The monetary amount of the transaction. |
category - String | The category of the transaction. |
categoryGuid - String | The unique identifier for the category assigned to the transaction. |
checkNumberString - String | The check number for the transaction. |
createdAt - String | The date and time the transaction was created. |
currencyCode - String | The three-character ISO 4217 currency code, e.g. USD. |
date - String | The date on which the transaction took place. This is the field used when searching for transactions by date. This field is generally the same as transacted_at, but uses posted_at as a fallback. |
description - String | A human-readable version of the original_description field described below, e.g., “Sam's Club,” “Johnny's Tavern.” This is provided by the MX Platform. |
extendedTransactionType - String | The transaction type assigned by the partner. |
guid - String | The unique identifier for the transaction. Defined by MX. |
id - String | The unique partner-defined identifier for the transaction. This can only be set for partner-managed transactions. It should be ignored for user-managed transactions, even in occasional cases where it may return with a value. |
isBillPay - Boolean | This indicates whether the transaction represents a bill pay. |
isDirectDeposit - Boolean | This indicates whether the transaction represents a direct deposit. |
isExpense - Boolean | This indicates whether the transaction represents an expense. |
isFee - Boolean | This indicates whether the transaction represents a fee. |
isIncome - Boolean | This indicates whether the transaction represents income. |
isInternational - Boolean | If the transaction is international as defined by the data provider, this field will be true. If the data provider determines it is not international then it will be false. It will be null if the data provider does not have this information. |
isManual - Boolean | This indicates whether the transaction is manually created and belongs to a manual account. |
isOverdraftFee - Boolean | This indicates whether the transaction represents an overdraft fee. |
isPayrollAdvance - Boolean | This indicates whether the transaction represents a payroll advance. |
isRecurring - Boolean | This indicates whether a transaction is a recurring credit or debit. |
isSubscription - Boolean | This indicates whether the transaction represents a payment for a subscription service such as Netflix or Audible. |
latitude - Float | The latitude of the location where the transaction occurred. The number is a signed decimal (e.g. Rio de Janeiro's latitude is -22.9027800 and Tokyo's latitude is 35.689488). |
localizedDescription - String | A human-readable description of the transaction, provided in a local language. |
localizedMemo - String | Additional descriptive information about the transaction, provided in a local language. |
longitude - Float | The longitude of the location where the transaction occurred. The number is a signed decimal (e.g. Rio de Janeiro's longitude is -43.2075000 and Tokyo's longitude is 139.691706). |
memberGuid - String | The unique identifier for the member associated with the transaction Defined by MX. |
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. |
memo - String | This field contains additional descriptive information about the transaction. |
merchantCategoryCode - Int | The ISO 18245 category code for the transaction. |
merchantGuid - String | The unique identifier for the merchant associated with this transaction. Defined by MX. |
merchantLocationGuid - String | The unique identifier for the merchant_location associated with this transaction. Defined by MX. |
metadata - String | Custom data |
originalDescription - String | The original description of the transaction as provided by our data feed. See description above for more information. |
postedAt - String | The date and time the transaction was posted to the account. |
status - String | The status of the transaction. This will be either POSTED or PENDING. |
topLevelCategory - String | The parent category assigned to this transaction's category. |
transactedAt - String | The date and time the transaction took place. |
type - String | The type of transaction. This will be either CREDIT or DEBIT. |
updatedAt - String | The date and time the transaction was last updated. |
userGuid - String | The unique identifier for the user associated with this transaction. Defined by MX. |
userId - String | The unique partner-defined identifier for the user associated with the transaction. |
Example
{
"accountGuid": "xyz789",
"accountId": "xyz789",
"amount": 123.45,
"category": "xyz789",
"categoryGuid": "abc123",
"checkNumberString": "abc123",
"createdAt": "xyz789",
"currencyCode": "abc123",
"date": "xyz789",
"description": "abc123",
"extendedTransactionType": "abc123",
"guid": "abc123",
"id": "xyz789",
"isBillPay": true,
"isDirectDeposit": true,
"isExpense": true,
"isFee": true,
"isIncome": true,
"isInternational": true,
"isManual": true,
"isOverdraftFee": false,
"isPayrollAdvance": true,
"isRecurring": false,
"isSubscription": true,
"latitude": 987.65,
"localizedDescription": "abc123",
"localizedMemo": "xyz789",
"longitude": 987.65,
"memberGuid": "xyz789",
"memberIsManagedByUser": true,
"memo": "xyz789",
"merchantCategoryCode": 987,
"merchantGuid": "xyz789",
"merchantLocationGuid": "xyz789",
"metadata": "abc123",
"originalDescription": "xyz789",
"postedAt": "abc123",
"status": "abc123",
"topLevelCategory": "abc123",
"transactedAt": "xyz789",
"type": "abc123",
"updatedAt": "abc123",
"userGuid": "abc123",
"userId": "abc123"
}
RemoteDataNtropyCategories
Description
RemoteData Ntropy Categories
Example
{
"accounting": "xyz789",
"general": "abc123"
}
RemoteDataNtropyCounterparty
Description
RemoteData Ntropy Counterparty
Example
{
"id": "abc123",
"logo": "abc123",
"mccs": [987],
"name": "abc123",
"type": "abc123",
"website": "xyz789"
}
RemoteDataNtropyEnrichedTransaction
Description
Ntropy Enrichment data.
Fields
| Field Name | Description |
|---|---|
categories - RemoteDataNtropyCategories | Categories |
createdAt - DateTime | The timestamp of when the account holder was created. |
entities - RemoteDataNtropyEntities | Entities found by identity identification |
error - RemoteDataNtropyTransactionError | TransactionError |
id - String | A unique identifier for the transaction. If two transactions are submitted with the same id the most recent one will replace the previous one. |
location - RemoteDataNtropyLocation | Location |
Example
{
"categories": RemoteDataNtropyCategories,
"createdAt": "2007-12-03T10:15:30Z",
"entities": RemoteDataNtropyEntities,
"error": RemoteDataNtropyTransactionError,
"id": "abc123",
"location": RemoteDataNtropyLocation
}
RemoteDataNtropyEntities
Description
Entities found by identity identification
Fields
| Field Name | Description |
|---|---|
counterparty - RemoteDataNtropyCounterparty | Counterparty |
intermediaries - [RemoteDataNtropyIntermediary!] | Intermediaries |
Example
{
"counterparty": RemoteDataNtropyCounterparty,
"intermediaries": [RemoteDataNtropyIntermediary]
}
RemoteDataNtropyIntermediary
Description
RemoteData Ntropy Intermediary
Example
{
"id": "xyz789",
"logo": "abc123",
"mccs": [987],
"name": "xyz789",
"website": "xyz789"
}
RemoteDataNtropyLocation
Description
RemoteData Ntropy Location
Fields
| Field Name | Description |
|---|---|
rawAddress - String | An unstructured string containing the address |
structured - RemoteDataNtropyStructured | When raw is set, a structured representation of it. |
Example
{
"rawAddress": "xyz789",
"structured": RemoteDataNtropyStructured
}
RemoteDataNtropyStructured
Description
When raw is set, a structured representation of it.
Fields
| Field Name | Description |
|---|---|
appleMapsUrl - String | A URL link to view the location on Apple Maps |
city - String | The city where the location is situated |
country - String | The full name of the country |
countryCode - String | The country code of the location in ISO 3166-2 format |
googleMapsUrl - String | A URL link to view the location on Google Maps |
houseNumber - String | The house number if, applicable |
latitude - Float | The latitude coordinate of the location |
longitude - Float | The longitude coordinate of the location |
postcode - String | The postal code or ZIP code of the location |
state - String | The state or region of the location |
storeNumber - String | A unique identifier for a specific store or branch, if applicable |
street - String | The street name of the location |
Example
{
"appleMapsUrl": "xyz789",
"city": "abc123",
"country": "xyz789",
"countryCode": "abc123",
"googleMapsUrl": "abc123",
"houseNumber": "abc123",
"latitude": 987.65,
"longitude": 123.45,
"postcode": "xyz789",
"state": "abc123",
"storeNumber": "xyz789",
"street": "abc123"
}
RemoteDataNtropyTransactionError
RemoteDataPlaidAPR
Description
Information about the APR on the account.
Fields
| Field Name | Description |
|---|---|
aprPercentage - Float | Annual Percentage Rate applied. |
aprType - String | The type of balance to which the APR applies. |
balanceSubjectToApr - Float | Amount of money that is subjected to the APR if a balance was carried beyond payment due date. How it is calculated can vary by card issuer. It is often calculated as an average daily balance. |
interestChargeAmount - Float | Amount of money charged due to interest from last statement. |
Example
{
"aprPercentage": 987.65,
"aprType": "xyz789",
"balanceSubjectToApr": 123.45,
"interestChargeAmount": 987.65
}
RemoteDataPlaidAccount
Description
Plaid Account data.
A single account at a financial institution.
Fields
| Field Name | 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 The If an account with a specific When using a CRA endpoint (an endpoint associated with Plaid Check Consumer Report, i.e. any endpoint beginning with Like all Plaid identifiers, the |
balances - RemoteDataPlaidAccountBalance | A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by /accounts/balance/get or /signal/evaluate (using a Balance-only ruleset). |
holderCategory - String | Indicates the account's categorization as either a personal or a business account. This field is currently in beta; to request access, contact your account manager. |
mask - String | The last 2-4 alphanumeric characters of either the account’s displayed mask or the account’s official account number. Note that the mask may be non-unique between an Item’s accounts. |
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 field is currently supported only for Items at institutions that use Tokenized Account Numbers (i.e., Chase and PNC, and in May 2025 US Bank). Because these accounts have a different account number each time they are linked, this field may be used instead of the account number to uniquely identify an account across multiple Items for payments use cases, helping to reduce duplicate Items or attempted fraud. In Sandbox, this field is populated for TAN-based institutions (ins_56, ins_13) as well as the OAuth Sandbox institution (ins_127287); in Production, it will only be populated for accounts at applicable institutions. |
subtype - String | See the Account type schema for a full listing of account types and corresponding subtypes. |
type - String |
See the Account type schema for a full listing of account types and corresponding subtypes. |
verificationInsights - RemoteDataPlaidVerificationInsights | Insights from performing database verification for the account. Only returned for Auth Items using Database Auth. |
verificationName - String | The account holder name that was used for micro-deposit and/or database verification. Only returned for Auth Items created via micro-deposit or database verification. This name was manually-entered by the user during Link, unless it was otherwise provided via the user.legal_name request field in /link/token/create for the Link session that created the Item. |
verificationStatus - String | Indicates an Item's micro-deposit-based verification or database verification status. This field is only populated when using Auth and falling back to micro-deposit or database verification. Possible values are:
|
Example
{
"accountId": "xyz789",
"balances": RemoteDataPlaidAccountBalance,
"holderCategory": "abc123",
"mask": "abc123",
"name": "xyz789",
"officialName": "xyz789",
"persistentAccountId": "xyz789",
"subtype": "xyz789",
"type": "xyz789",
"verificationInsights": RemoteDataPlaidVerificationInsights,
"verificationName": "xyz789",
"verificationStatus": "xyz789"
}
RemoteDataPlaidAccountBalance
Description
A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by /accounts/balance/get or /signal/evaluate (using a Balance-only ruleset).
Fields
| Field Name | Description |
|---|---|
available - Float | The amount of funds available to be withdrawn from the account, as determined by the financial institution. For For For Note that not all institutions calculate the Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by If |
current - Float | The total amount of funds in or owed by the account. For For For Note that balance information may be cached unless the value was returned by When returned by |
isoCurrencyCode - String | The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null. |
lastUpdatedDatetime - DateTime | Timestamp in ISO 8601 format ( This field is returned only when the institution is |
limit - Float | For For In North America, this field is typically only available for |
unofficialCurrencyCode - String | The unofficial currency code associated with the balance. Always null if See the currency code schema for a full listing of supported |
Example
{
"available": 123.45,
"current": 123.45,
"isoCurrencyCode": "xyz789",
"lastUpdatedDatetime": "2007-12-03T10:15:30Z",
"limit": 987.65,
"unofficialCurrencyCode": "abc123"
}
RemoteDataPlaidAddress
Description
A physical mailing address.
Fields
| Field Name | Description |
|---|---|
data - RemoteDataPlaidAddressData | Data about the components comprising an address. |
primary - Boolean | When true, identifies the address as the primary address on an account. |
Example
{"data": RemoteDataPlaidAddressData, "primary": false}
RemoteDataPlaidAddressData
Description
Data about the components comprising an address.
Fields
| Field Name | Description |
|---|---|
city - String | The full city name |
country - String | The ISO 3166-1 alpha-2 country code |
postalCode - String | The postal code. In API versions 2018-05-22 and earlier, this field is called zip. |
region - String | The region or state. In API versions 2018-05-22 and earlier, this field is called state. Example: "NC" |
street - String | The full street address Example: "564 Main Street, APT 15" |
Example
{
"city": "abc123",
"country": "xyz789",
"postalCode": "abc123",
"region": "abc123",
"street": "abc123"
}
RemoteDataPlaidCounterparty
Description
The counterparty, such as the merchant or financial institution, is extracted by Plaid from the raw description.
Fields
| Field Name | Description |
|---|---|
accountNumbers - RemoteDataPlaidCounterpartyNumbers | Account numbers associated with the counterparty, when available. This field is currently only filled in for select financial institutions in Europe. |
confidenceLevel - String | A description of how confident we are that the provided counterparty is involved in the transaction.
|
entityId - String | A unique, stable, Plaid-generated ID that maps to the counterparty. |
logoUrl - String | The URL of a logo associated with the counterparty, if available. The logo will always be 100×100 pixel PNG file. |
name - String | The name of the counterparty, such as the merchant or the financial institution, as extracted by Plaid from the raw description. |
type - String | The counterparty type.
|
website - String | The website associated with the counterparty. |
Example
{
"accountNumbers": RemoteDataPlaidCounterpartyNumbers,
"confidenceLevel": "xyz789",
"entityId": "abc123",
"logoUrl": "abc123",
"name": "xyz789",
"type": "xyz789",
"website": "xyz789"
}
RemoteDataPlaidCounterpartyNumbers
Description
Account numbers associated with the counterparty, when available. This field is currently only filled in for select financial institutions in Europe.
Fields
| Field Name | Description |
|---|---|
bacs - RemoteDataPlaidCounterpartyNumbersBACS | Identifying information for a UK bank account via BACS. |
international - RemoteDataPlaidCounterpartyNumbersInternational | Account numbers using the International Bank Account Number and BIC/SWIFT code format. |
Example
{
"bacs": RemoteDataPlaidCounterpartyNumbersBACS,
"international": RemoteDataPlaidCounterpartyNumbersInternational
}
RemoteDataPlaidCounterpartyNumbersBACS
RemoteDataPlaidCounterpartyNumbersInternational
RemoteDataPlaidCreditCardLiability
Description
An object representing a credit card account.
Fields
| Field Name | Description |
|---|---|
accountId - String | The ID of the account that this liability belongs to. |
aprs - [RemoteDataPlaidAPR!] | The various interest rates that apply to the account. APR information is not provided by all card issuers; if APR data is not available, this array will be empty. |
isOverdue - Boolean | true if a payment is currently overdue. Availability for this field is limited. |
lastPaymentAmount - Float | The amount of the last payment. |
lastPaymentDate - Date | The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD). Availability for this field is limited. |
lastStatementBalance - Float | The total amount owed as of the last statement issued |
lastStatementIssueDate - Date | The date of the last statement. Dates are returned in an ISO 8601 format (YYYY-MM-DD). |
minimumPaymentAmount - Float | The minimum payment due for the next billing cycle. |
nextPaymentDueDate - Date | The due date for the next payment. The due date is null if a payment is not expected. Dates are returned in an ISO 8601 format (YYYY-MM-DD). |
Example
{
"accountId": "xyz789",
"aprs": [RemoteDataPlaidAPR],
"isOverdue": true,
"lastPaymentAmount": 123.45,
"lastPaymentDate": "2007-12-03",
"lastStatementBalance": 123.45,
"lastStatementIssueDate": "2007-12-03",
"minimumPaymentAmount": 123.45,
"nextPaymentDueDate": "2007-12-03"
}
RemoteDataPlaidEmail
Description
An object representing an email address
Example
{
"data": "xyz789",
"primary": true,
"type": "abc123"
}
RemoteDataPlaidError
Description
Errors are identified by error_code and categorized by error_type. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-null error object will only be part of an API response when calling /item/get to view Item status. Otherwise, error fields will be null if no error has occurred; if an error has occurred, an error code will be returned instead.
Fields
| Field Name | Description |
|---|---|
causes - [String!] | In this product, a request can pertain to more than one Item. If an error is returned for such a request,
|
displayMessage - String | A user-friendly representation of the error code. This may change over time and is not safe for programmatic use. |
documentationUrl - String | The URL of a Plaid documentation page with more information about the error |
errorCode - String | The particular error code. Safe for programmatic use. |
errorCodeReason - String | The specific reason for the error code. Currently, reasons are only supported OAuth-based item errors; Possible values:
|
errorMessage - String | A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use. |
errorType - String | A broad categorization of the error. Safe for programmatic use. |
providedAccountSubtypes - [String!] | A list of the account subtypes that were extracted but did not match the requested subtypes via the account_filters parameter in /link/token/create. Currently only populated for NO_ACCOUNTS errors from Items with investments_auth as an enabled product. |
requestId - String | A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks. |
requiredAccountSubtypes - [String!] | A list of the account subtypes that were requested via the account_filters parameter in /link/token/create. Currently only populated for NO_ACCOUNTS errors from Items with investments_auth as an enabled product. |
status - Int | The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook. |
suggestedAction - String | Suggested steps for resolving the error |
Example
{
"causes": ["abc123"],
"displayMessage": "xyz789",
"documentationUrl": "abc123",
"errorCode": "abc123",
"errorCodeReason": "xyz789",
"errorMessage": "abc123",
"errorType": "xyz789",
"providedAccountSubtypes": ["abc123"],
"requestId": "abc123",
"requiredAccountSubtypes": ["xyz789"],
"status": 987,
"suggestedAction": "xyz789"
}
RemoteDataPlaidFixedIncome
Description
Details about the fixed income security.
Fields
| Field Name | Description |
|---|---|
faceValue - Float | The face value that is paid upon maturity of the fixed income security, per unit of security. |
issueDate - Date | The issue date for this fixed income security, in ISO 8601 format. |
maturityDate - Date | The maturity date for this fixed income security, in ISO 8601 format. |
yieldRate - RemoteDataPlaidYieldRate | Details about a fixed income security's expected rate of return. |
Example
{
"faceValue": 123.45,
"issueDate": "2007-12-03",
"maturityDate": "2007-12-03",
"yieldRate": RemoteDataPlaidYieldRate
}
RemoteDataPlaidHolding
Description
Plaid Holding data.
A securities holding at an institution.
Fields
| Field Name | Description |
|---|---|
accountId - String | The Plaid account_id associated with the holding. |
costBasis - Float | The total cost basis of the holding (e.g., the total amount spent to acquire all assets currently in the holding). |
institutionPrice - Float | The last price given by the institution for this security. |
institutionPriceAsOf - Date | The date at which institution_price was current. |
institutionPriceDatetime - DateTime | Date and time at which This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00). |
institutionValue - Float | The value of the holding, as reported by the institution. |
isoCurrencyCode - String | The ISO-4217 currency code of the holding. Always null if unofficial_currency_code is non-null. |
quantity - Float | The total quantity of the asset held, as reported by the financial institution. If the security is an option, quantity will reflect the total number of options (typically the number of contracts multiplied by 100), not the number of contracts. |
securityId - String | The Plaid security_id associated with the holding. Security data is not specific to a user's account; any user who held the same security at the same financial institution at the same time would have identical security data. The security_id for the same security will typically be the same across different institutions, but this is not guaranteed. The security_id does not typically change, but may change if inherent details of the security change due to a corporate action, for example, in the event of a ticker symbol change or CUSIP change. |
unofficialCurrencyCode - String | The unofficial currency code associated with the holding. Always See the currency code schema for a full listing of supported |
vestedQuantity - Float | The total quantity of vested assets held, as reported by the financial institution. Vested assets are only associated with equities. |
vestedValue - Float | The value of the vested holdings as reported by the institution. |
Example
{
"accountId": "xyz789",
"costBasis": 987.65,
"institutionPrice": 123.45,
"institutionPriceAsOf": "2007-12-03",
"institutionPriceDatetime": "2007-12-03T10:15:30Z",
"institutionValue": 987.65,
"isoCurrencyCode": "abc123",
"quantity": 123.45,
"securityId": "abc123",
"unofficialCurrencyCode": "xyz789",
"vestedQuantity": 123.45,
"vestedValue": 987.65
}
RemoteDataPlaidInvestmentTransaction
Description
Plaid Investment Transaction data.
A transaction within an investment account.
Fields
| Field Name | Description |
|---|---|
accountId - String | The account_id of the account against which this transaction posted. |
amount - Float | The complete value of the transaction. Positive values when cash is debited, e.g. purchases of stock; negative values when cash is credited, e.g. sales of stock. Treatment remains the same for cash-only movements unassociated with securities. |
date - Date | The ISO 8601 posting date for the transaction. This is typically the settlement date. |
fees - Float | The combined value of all fees applied to this transaction |
investmentTransactionId - String | The ID of the Investment transaction, unique across all Plaid transactions. Like all Plaid identifiers, the investment_transaction_id is case sensitive. |
isoCurrencyCode - String | The ISO-4217 currency code of the transaction. Always null if unofficial_currency_code is non-null. |
name - String | The institution’s description of the transaction. |
price - Float | The price of the security at which this transaction occurred. |
quantity - Float | The number of units of the security involved in this transaction. Positive for buy transactions; negative for sell transactions. |
securityId - String | The security_id to which this transaction is related. |
subtype - String | For descriptions of possible transaction types and subtypes, see the Investment transaction types schema. |
transactionDatetime - DateTime | Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) representing when the order type was initiated. This field is returned for select financial institutions and reflects the value provided by the institution. |
type - String | Value is one of the following: For descriptions of possible transaction types and subtypes, see the Investment transaction types schema. |
unofficialCurrencyCode - String | The unofficial currency code associated with the holding. Always See the currency code schema for a full listing of supported |
Example
{
"accountId": "xyz789",
"amount": 123.45,
"date": "2007-12-03",
"fees": 987.65,
"investmentTransactionId": "xyz789",
"isoCurrencyCode": "xyz789",
"name": "abc123",
"price": 123.45,
"quantity": 123.45,
"securityId": "abc123",
"subtype": "xyz789",
"transactionDatetime": "2007-12-03T10:15:30Z",
"type": "xyz789",
"unofficialCurrencyCode": "abc123"
}
RemoteDataPlaidItem
Description
Plaid Connection data.
Metadata about the Item.
Fields
| Field Name | Description |
|---|---|
authMethod - String | The method used to populate Auth data for the Item. This field is only populated for Items that have had Auth numbers data set on at least one of its accounts, and will be
|
availableProducts - [String!] | A list of products available for the Item that have not yet been accessed. The contents of this array will be mutually exclusive with billed_products. |
billedProducts - [String!] | A list of products that have been billed for the Item. The contents of this array will be mutually exclusive with available_products. Note - billed_products is populated in all environments but only requests in Production are billed. Also note that products that are billed on a pay-per-call basis rather than a pay-per-Item basis, such as balance, will not appear here. |
consentExpirationTime - DateTime | The date and time at which the Item's access consent will expire, in ISO 8601 format. If the Item does not have consent expiration scheduled, this field will be null. Currently, only institutions in Europe and a small number of institutions in the US have expiring consent. For a list of US institutions that currently expire consent, see the OAuth Guide. |
consentedProducts - [String!] | A list of products that the user has consented to for the Item via Data Transparency Messaging. This will consist of all products where both of the following are true: the user has consented to the required data scopes for that product and you have Production access for that product. |
error - RemoteDataPlaidError | Errors are identified by error_code and categorized by error_type. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-null error object will only be part of an API response when calling /item/get to view Item status. Otherwise, error fields will be null if no error has occurred; if an error has occurred, an error code will be returned instead. |
institutionId - String | The Plaid Institution ID associated with the Item. Field is null for Items created without an institution connection, such as Items created via Same Day Micro-deposits. |
institutionName - String | The name of the institution associated with the Item. Field is null for Items created without an institution connection, such as Items created via Same Day Micro-deposits. |
itemId - String | The Plaid Item ID. The item_id is always unique; linking the same account at the same institution twice will result in two Items with different item_id values. Like all Plaid identifiers, the item_id is case-sensitive. |
products - [String!] | A list of products added to the Item. In almost all cases, this will be the same as the billed_products field. For some products, it is possible for the product to be added to an Item but not yet billed (e.g. Assets, before /asset_report/create has been called, or Auth or Identity when added as Optional Products but before their endpoints have been called), in which case the product may appear in products but not in billed_products. |
updateType - String | Indicates whether an Item requires user interaction to be updated, which can be the case for Items with some forms of two-factor authentication.
|
webhook - String | The URL registered to receive webhooks for the Item. |
Example
{
"authMethod": "abc123",
"availableProducts": ["xyz789"],
"billedProducts": ["abc123"],
"consentExpirationTime": "2007-12-03T10:15:30Z",
"consentedProducts": ["abc123"],
"error": RemoteDataPlaidError,
"institutionId": "abc123",
"institutionName": "xyz789",
"itemId": "xyz789",
"products": ["abc123"],
"updateType": "xyz789",
"webhook": "abc123"
}
RemoteDataPlaidLiabilitiesObject
Description
Plaid Liabilities data.
An object containing liability accounts
Fields
| Field Name | Description |
|---|---|
credit - [RemoteDataPlaidCreditCardLiability!] | The credit accounts returned. |
mortgage - [RemoteDataPlaidMortgageLiability!] | The mortgage accounts returned. |
student - [RemoteDataPlaidStudentLoan!] | The student loan accounts returned. |
Example
{
"credit": [RemoteDataPlaidCreditCardLiability],
"mortgage": [RemoteDataPlaidMortgageLiability],
"student": [RemoteDataPlaidStudentLoan]
}
RemoteDataPlaidMortgageInterestRate
Description
Object containing metadata about the interest rate for the mortgage.
Example
{"percentage": 123.45, "type": "abc123"}
RemoteDataPlaidMortgageLiability
Description
Contains details about a mortgage account.
Fields
| Field Name | Description |
|---|---|
accountId - String | The ID of the account that this liability belongs to. |
accountNumber - String | The account number of the loan. |
currentLateFee - Float | The current outstanding amount charged for late payment. |
escrowBalance - Float | Total amount held in escrow to pay taxes and insurance on behalf of the borrower. |
hasPmi - Boolean | Indicates whether the borrower has private mortgage insurance in effect. |
hasPrepaymentPenalty - Boolean | Indicates whether the borrower will pay a penalty for early payoff of mortgage. |
interestRate - RemoteDataPlaidMortgageInterestRate | Object containing metadata about the interest rate for the mortgage. |
lastPaymentAmount - Float | The amount of the last payment. |
lastPaymentDate - Date | The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD). |
loanTerm - String | Full duration of mortgage as at origination (e.g. 10 year). |
loanTypeDescription - String | Description of the type of loan, for example conventional, fixed, or variable. This field is provided directly from the loan servicer and does not have an enumerated set of possible values. |
maturityDate - Date | Original date on which mortgage is due in full. Dates are returned in an ISO 8601 format (YYYY-MM-DD). |
nextMonthlyPayment - Float | The amount of the next payment. |
nextPaymentDueDate - Date | The due date for the next payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD). |
originationDate - Date | The date on which the loan was initially lent. Dates are returned in an ISO 8601 format (YYYY-MM-DD). |
originationPrincipalAmount - Float | The original principal balance of the mortgage. |
pastDueAmount - Float | Amount of loan (principal + interest) past due for payment. |
propertyAddress - RemoteDataPlaidMortgagePropertyAddress | Object containing fields describing property address. |
ytdInterestPaid - Float | The year to date (YTD) interest paid. |
ytdPrincipalPaid - Float | The YTD principal paid. |
Example
{
"accountId": "abc123",
"accountNumber": "abc123",
"currentLateFee": 987.65,
"escrowBalance": 987.65,
"hasPmi": true,
"hasPrepaymentPenalty": false,
"interestRate": RemoteDataPlaidMortgageInterestRate,
"lastPaymentAmount": 123.45,
"lastPaymentDate": "2007-12-03",
"loanTerm": "xyz789",
"loanTypeDescription": "abc123",
"maturityDate": "2007-12-03",
"nextMonthlyPayment": 987.65,
"nextPaymentDueDate": "2007-12-03",
"originationDate": "2007-12-03",
"originationPrincipalAmount": 123.45,
"pastDueAmount": 123.45,
"propertyAddress": RemoteDataPlaidMortgagePropertyAddress,
"ytdInterestPaid": 987.65,
"ytdPrincipalPaid": 123.45
}
RemoteDataPlaidMortgagePropertyAddress
Description
Object containing fields describing property address.
Example
{
"city": "abc123",
"country": "abc123",
"postalCode": "xyz789",
"region": "abc123",
"street": "xyz789"
}
RemoteDataPlaidOptionContract
Description
Details about the option security.
For the Sandbox environment, this data is currently only available if the Item is using a custom Sandbox user and the ticker field of the custom security follows the OCC Option Symbol standard with no spaces. For an example of simulating this in Sandbox, see the custom Sandbox GitHub.
Fields
| Field Name | Description |
|---|---|
contractType - String | The type of this option contract. It is one of:
|
expirationDate - Date | The expiration date for this option contract, in ISO 8601 format. |
strikePrice - Float | The strike price for this option contract, per share of security. |
underlyingSecurityTicker - String | The ticker of the underlying security for this option contract. |
Example
{
"contractType": "xyz789",
"expirationDate": "2007-12-03",
"strikePrice": 123.45,
"underlyingSecurityTicker": "xyz789"
}
RemoteDataPlaidOwner
Description
Plaid Owner data.
Data returned from the financial institution about the owner or owners of an account. Only the names array must be non-empty.
Fields
| Field Name | Description |
|---|---|
addresses - [RemoteDataPlaidAddress!] | Data about the various addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution. |
emails - [RemoteDataPlaidEmail!] | A list of email addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution. |
names - [String!] | A list of names associated with the account by the financial institution. In the case of a joint account, Plaid will make a best effort to report the names of all account holders. If an Item contains multiple accounts with different owner names, some institutions will report all names associated with the Item in each account's |
phoneNumbers - [RemoteDataPlaidPhoneNumber!] | A list of phone numbers associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution. |
Example
{
"addresses": [RemoteDataPlaidAddress],
"emails": [RemoteDataPlaidEmail],
"names": ["xyz789"],
"phoneNumbers": [RemoteDataPlaidPhoneNumber]
}
RemoteDataPlaidPaymentMeta
Description
Transaction information specific to inter-bank transfers. If the transaction was not an inter-bank transfer, all fields will be null.
If the transactions object was returned by a Transactions endpoint such as /transactions/sync or /transactions/get, the payment_meta key will always appear, but no data elements are guaranteed. If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.
Fields
| Field Name | Description |
|---|---|
byOrderOf - String | The party initiating a wire transfer. Will be null if the transaction is not a wire transfer. |
payee - String | For transfers, the party that is receiving the transaction. |
payer - String | For transfers, the party that is paying the transaction. |
paymentMethod - String | The type of transfer, e.g. 'ACH' |
paymentProcessor - String | The name of the payment processor |
ppdId - String | The ACH PPD ID for the payer. |
reason - String | The payer-supplied description of the transfer. |
referenceNumber - String | The transaction reference number supplied by the financial institution. |
Example
{
"byOrderOf": "abc123",
"payee": "abc123",
"payer": "xyz789",
"paymentMethod": "abc123",
"paymentProcessor": "abc123",
"ppdId": "abc123",
"reason": "xyz789",
"referenceNumber": "abc123"
}
RemoteDataPlaidPersonalFinanceCategory
Description
Information describing the intent of the transaction. Most relevant for personal finance use cases, but not limited to such use cases.
See the taxonomy CSV file for a full list of personal finance categories. If you are migrating to personal finance categories from the legacy categories, also refer to the migration guide.
Fields
| Field Name | Description |
|---|---|
confidenceLevel - String | A description of how confident we are that the provided categories accurately describe the transaction intent.
|
detailed - String | A granular category conveying the transaction's intent. This field can also be used as a unique identifier for the category. |
primary - String | A high level category that communicates the broad category of the transaction. |
version - String | Indicates which version of the personal finance category taxonomy is being used. View PFCv2 and PFCv1 taxonomies. If you enabled Transactions or Enrich before December 2025 you will receive the If you enabled Transactions or Enrich on or after December 2025, you may only receive the |
Example
{
"confidenceLevel": "xyz789",
"detailed": "abc123",
"primary": "abc123",
"version": "xyz789"
}
RemoteDataPlaidPhoneNumber
RemoteDataPlaidSecurity
Description
Plaid Security data.
Contains details about a security
Fields
| Field Name | Description |
|---|---|
closePrice - Float | Price of the security at the close of the previous trading session. Null for non-public securities. If the security is a foreign currency this field will be updated daily and will be priced in USD. If the security is a cryptocurrency, this field will be updated multiple times a day. As crypto prices can fluctuate quickly and data may become stale sooner than other asset classes, refer to |
closePriceAsOf - Date | Date for which close_price is accurate. Always null if close_price is null. |
cusip - String | 9-character CUSIP, an identifier assigned to North American securities. A verified CUSIP Global Services license is required to receive this data. This field will be null by default for new customers, and null for existing customers starting March 12, 2024. If you would like access to this field, please start the verification process here. |
fixedIncome - RemoteDataPlaidFixedIncome | Details about the fixed income security. |
industry - String | The industry classification of the security, such as Biotechnology, Airlines, etc. For a complete list of possible values, please refer to the "Sectors and Industries" spreadsheet. |
institutionId - String | If institution_security_id is present, this field indicates the Plaid institution_id of the institution to whom the identifier belongs. |
institutionSecurityId - String | An identifier given to the security by the institution |
isCashEquivalent - Boolean | Indicates that a security is a highly liquid asset and can be treated like cash. |
isin - String | 12-character ISIN, a globally unique securities identifier. A verified CUSIP Global Services license is required to receive this data. This field will be null by default for new customers, and null for existing customers starting March 12, 2024. If you would like access to this field, please start the verification process here. |
isoCurrencyCode - String | The ISO-4217 currency code of the price given. Always null if unofficial_currency_code is non-null. |
marketIdentifierCode - String | The ISO-10383 Market Identifier Code of the exchange or market in which the security is being traded. |
name - String | A descriptive name for the security, suitable for display. |
optionContract - RemoteDataPlaidOptionContract | Details about the option security. For the Sandbox environment, this data is currently only available if the Item is using a custom Sandbox user and the |
proxySecurityId - String | In certain cases, Plaid will provide the ID of another security whose performance resembles this security, typically when the original security has low volume, or when a private security can be modeled with a publicly traded security. |
sector - String | The sector classification of the security, such as Finance, Health Technology, etc. For a complete list of possible values, please refer to the "Sectors and Industries" spreadsheet. |
securityId - String | A unique, Plaid-specific identifier for the security, used to associate securities with holdings. Like all Plaid identifiers, the security_id is case sensitive. The security_id may change if inherent details of the security change due to a corporate action, for example, in the event of a ticker symbol change or CUSIP change. |
subtype - String | The security subtype of the holding. In rare instances, a null value is returned when institutional data is insufficient to determine the security subtype. Possible values: |
tickerSymbol - String | The security’s trading symbol for publicly traded securities, and otherwise a short identifier if available. |
type - String | The security type of the holding. In rare instances, a null value is returned when institutional data is insufficient to determine the security type. Valid security types are:
|
unofficialCurrencyCode - String | The unofficial currency code associated with the security. Always See the currency code schema for a full listing of supported |
updateDatetime - DateTime | Date and time at which close_price is accurate, in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). Always null if close_price is null. |
Example
{
"closePrice": 123.45,
"closePriceAsOf": "2007-12-03",
"cusip": "xyz789",
"fixedIncome": RemoteDataPlaidFixedIncome,
"industry": "xyz789",
"institutionId": "abc123",
"institutionSecurityId": "xyz789",
"isCashEquivalent": true,
"isin": "abc123",
"isoCurrencyCode": "abc123",
"marketIdentifierCode": "abc123",
"name": "abc123",
"optionContract": RemoteDataPlaidOptionContract,
"proxySecurityId": "abc123",
"sector": "abc123",
"securityId": "abc123",
"subtype": "xyz789",
"tickerSymbol": "xyz789",
"type": "abc123",
"unofficialCurrencyCode": "xyz789",
"updateDatetime": "2007-12-03T10:15:30Z"
}
RemoteDataPlaidServicerAddressData
Description
The address of the student loan servicer. This is generally the remittance address to which payments should be sent.
Example
{
"city": "xyz789",
"country": "abc123",
"postalCode": "abc123",
"region": "xyz789",
"street": "abc123"
}
RemoteDataPlaidStudentLoan
Description
Contains details about a student loan account
Fields
| Field Name | Description |
|---|---|
accountId - String | The ID of the account that this liability belongs to. Each account can only contain one liability. |
accountNumber - String | The account number of the loan. For some institutions, this may be a masked version of the number (e.g., the last 4 digits instead of the entire number). |
disbursementDates - [Date!] | The dates on which loaned funds were disbursed or will be disbursed. These are often in the past. Dates are returned in an ISO 8601 format (YYYY-MM-DD). |
expectedPayoffDate - Date | The date when the student loan is expected to be paid off. Availability for this field is limited. Dates are returned in an ISO 8601 format (YYYY-MM-DD). |
guarantor - String | The guarantor of the student loan. |
interestRatePercentage - Float | The interest rate on the loan as a percentage. |
isOverdue - Boolean | true if a payment is currently overdue. Availability for this field is limited. |
lastPaymentAmount - Float | The amount of the last payment. |
lastPaymentDate - Date | The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD). |
lastStatementBalance - Float | The total amount owed as of the last statement issued |
lastStatementIssueDate - Date | The date of the last statement. Dates are returned in an ISO 8601 format (YYYY-MM-DD). |
loanName - String | The type of loan, e.g., "Consolidation Loans". |
loanStatus - RemoteDataPlaidStudentLoanStatus | An object representing the status of the student loan |
minimumPaymentAmount - Float | The minimum payment due for the next billing cycle. There are some exceptions: Some institutions require a minimum payment across all loans associated with an account number. Our API presents that same minimum payment amount on each loan. The institutions that do this are: Great Lakes ( ins_116861), Firstmark (ins_116295), Commonbond Firstmark Services (ins_116950), Granite State (ins_116308), and Oklahoma Student Loan Authority (ins_116945). Firstmark (ins_116295 ) and Navient (ins_116248) will display as $0 if there is an autopay program in effect. |
nextPaymentDueDate - Date | The due date for the next payment. The due date is null if a payment is not expected. A payment is not expected if loan_status.type is deferment, in_school, consolidated, paid in full, or transferred. Dates are returned in an ISO 8601 format (YYYY-MM-DD). |
originationDate - Date | The date on which the loan was initially lent. Dates are returned in an ISO 8601 format (YYYY-MM-DD). |
originationPrincipalAmount - Float | The original principal balance of the loan. |
outstandingInterestAmount - Float | The total dollar amount of the accrued interest balance. For Sallie Mae ( ins_116944), this amount is included in the current balance of the loan, so this field will return as null. |
paymentReferenceNumber - String | The relevant account number that should be used to reference this loan for payments. In the majority of cases, payment_reference_number will match account_number, but in some institutions, such as Great Lakes (ins_116861), it will be different. |
repaymentPlan - RemoteDataPlaidStudentRepaymentPlan | An object representing the repayment plan for the student loan |
sequenceNumber - String | The sequence number of the student loan. Heartland ECSI (ins_116948) does not make this field available. |
servicerAddress - RemoteDataPlaidServicerAddressData | The address of the student loan servicer. This is generally the remittance address to which payments should be sent. |
ytdInterestPaid - Float | The year to date (YTD) interest paid. Availability for this field is limited. |
ytdPrincipalPaid - Float | The year to date (YTD) principal paid. Availability for this field is limited. |
Example
{
"accountId": "abc123",
"accountNumber": "xyz789",
"disbursementDates": ["2007-12-03"],
"expectedPayoffDate": "2007-12-03",
"guarantor": "xyz789",
"interestRatePercentage": 123.45,
"isOverdue": true,
"lastPaymentAmount": 987.65,
"lastPaymentDate": "2007-12-03",
"lastStatementBalance": 987.65,
"lastStatementIssueDate": "2007-12-03",
"loanName": "abc123",
"loanStatus": RemoteDataPlaidStudentLoanStatus,
"minimumPaymentAmount": 987.65,
"nextPaymentDueDate": "2007-12-03",
"originationDate": "2007-12-03",
"originationPrincipalAmount": 987.65,
"outstandingInterestAmount": 123.45,
"paymentReferenceNumber": "abc123",
"repaymentPlan": RemoteDataPlaidStudentRepaymentPlan,
"sequenceNumber": "abc123",
"servicerAddress": RemoteDataPlaidServicerAddressData,
"ytdInterestPaid": 123.45,
"ytdPrincipalPaid": 123.45
}
RemoteDataPlaidStudentLoanStatus
Description
An object representing the status of the student loan
Example
{
"endDate": "2007-12-03",
"type": "abc123"
}
RemoteDataPlaidStudentRepaymentPlan
RemoteDataPlaidTransaction
Description
Plaid Transaction data.
A representation of a transaction
Fields
| Field Name | Description |
|---|---|
accountId - String | The ID of the account in which this transaction occurred. |
accountOwner - String | This field is not typically populated and only relevant when dealing with sub-accounts. A sub-account most commonly exists in cases where a single account is linked to multiple cards, each with its own card number and card holder name; each card will be considered a sub-account. If the account does have sub-accounts, this field will typically be some combination of the sub-account owner's name and/or the sub-account mask. The format of this field is not standardized and will vary based on institution. |
amount - Float | The settled value of the transaction, denominated in the transactions's currency, as stated in iso_currency_code or unofficial_currency_code. For all products except Income: Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative. For Income endpoints, values are positive when representing income. |
authorizedDate - Date | The date that the transaction was authorized. For posted transactions, the date field will indicate the posted date, but authorized_date will indicate the day the transaction was authorized by the financial institution. If presenting transactions to the user in a UI, the authorized_date, when available, is generally preferable to use over the date field for posted transactions, as it will generally represent the date the user actually made the transaction. Dates are returned in an ISO 8601 format ( YYYY-MM-DD ). |
authorizedDatetime - DateTime | Date and time when a transaction was authorized in ISO 8601 format ( This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00). This field is only populated in API version 2019-05-29 and later. |
checkNumber - String | The check number of the transaction. This field is only populated for check transactions. |
counterparties - [RemoteDataPlaidCounterparty!] | The counterparties present in the transaction. Counterparties, such as the merchant or the financial institution, are extracted by Plaid from the raw description. |
date - Date | For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an ISO 8601 format ( YYYY-MM-DD ). To receive information about the date that a posted transaction was initiated, see the authorized_date field. |
datetime - DateTime | Date and time when a transaction was posted in ISO 8601 format ( This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00). This field is only populated in API version 2019-05-29 and later. |
isoCurrencyCode - String | The ISO-4217 currency code of the transaction. Always null if unofficial_currency_code is non-null. |
location - RemoteDataPlaidTransactionLocation | A representation of where a transaction took place. Location data is provided only for transactions at physical locations, not for online transactions. Location data availability depends primarily on the merchant and is most likely to be populated for transactions at large retail chains; small, local businesses are less likely to have location data available. |
logoUrl - String | The URL of a logo associated with this transaction, if available. The logo will always be 100×100 pixel PNG file. |
merchantEntityId - String | A unique, stable, Plaid-generated ID that maps to the merchant. In the case of a merchant with multiple retail locations, this field will map to the broader merchant, not a specific location or store. |
merchantName - String | The merchant name, as enriched by Plaid from the name field. This is typically a more human-readable version of the merchant counterparty in the transaction. For some bank transactions (such as checks or account transfers) where there is no meaningful merchant name, this value will be null. |
originalDescription - String | The string returned by the financial institution to describe the transaction. For transactions returned by /transactions/sync or /transactions/get, this field will only be included if the client has set options.include_original_description to true. |
paymentChannel - String | The channel used to make a payment.
This field replaces the |
paymentMeta - RemoteDataPlaidPaymentMeta | Transaction information specific to inter-bank transfers. If the transaction was not an inter-bank transfer, all fields will be If the |
pending - Boolean | When true, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled. Not all institutions provide pending transactions. |
pendingTransactionId - String | The ID of a posted transaction's associated pending transaction, where applicable. Not all institutions provide pending transactions. |
personalFinanceCategory - RemoteDataPlaidPersonalFinanceCategory | Information describing the intent of the transaction. Most relevant for personal finance use cases, but not limited to such use cases. See the taxonomy CSV file for a full list of personal finance categories. If you are migrating to personal finance categories from the legacy categories, also refer to the migration guide. |
personalFinanceCategoryIconUrl - String | The URL of an icon associated with the primary personal finance category. The icon will always be 100×100 pixel PNG file. |
transactionCode - String | An identifier classifying the transaction type. This field is only populated for European institutions. For institutions in the US and Canada, this field is set to
|
transactionId - String | The unique ID of the transaction. Like all Plaid identifiers, the transaction_id is case sensitive. |
unofficialCurrencyCode - String | The unofficial currency code associated with the transaction. Always See the currency code schema for a full listing of supported |
website - String | The website associated with this transaction, if available. |
Example
{
"accountId": "xyz789",
"accountOwner": "abc123",
"amount": 123.45,
"authorizedDate": "2007-12-03",
"authorizedDatetime": "2007-12-03T10:15:30Z",
"checkNumber": "abc123",
"counterparties": [RemoteDataPlaidCounterparty],
"date": "2007-12-03",
"datetime": "2007-12-03T10:15:30Z",
"isoCurrencyCode": "abc123",
"location": RemoteDataPlaidTransactionLocation,
"logoUrl": "xyz789",
"merchantEntityId": "xyz789",
"merchantName": "abc123",
"originalDescription": "abc123",
"paymentChannel": "abc123",
"paymentMeta": RemoteDataPlaidPaymentMeta,
"pending": false,
"pendingTransactionId": "xyz789",
"personalFinanceCategory": RemoteDataPlaidPersonalFinanceCategory,
"personalFinanceCategoryIconUrl": "abc123",
"transactionCode": "abc123",
"transactionId": "abc123",
"unofficialCurrencyCode": "xyz789",
"website": "xyz789"
}
RemoteDataPlaidTransactionLocation
Description
A representation of where a transaction took place. Location data is provided only for transactions at physical locations, not for online transactions. Location data availability depends primarily on the merchant and is most likely to be populated for transactions at large retail chains; small, local businesses are less likely to have location data available.
Fields
| Field Name | Description |
|---|---|
address - String | The street address where the transaction occurred. |
city - String | The city where the transaction occurred. |
country - String | The ISO 3166-1 alpha-2 country code where the transaction occurred. |
lat - Float | The latitude where the transaction occurred. |
lon - Float | The longitude where the transaction occurred. |
postalCode - String | The postal code where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called zip. |
region - String | The region or state where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called state. |
storeNumber - String | The merchant defined store number where the transaction occurred. |
Example
{
"address": "xyz789",
"city": "xyz789",
"country": "abc123",
"lat": 123.45,
"lon": 123.45,
"postalCode": "abc123",
"region": "xyz789",
"storeNumber": "abc123"
}
RemoteDataPlaidVerificationInsights
Description
Insights from performing database verification for the account. Only returned for Auth Items using Database Auth.
Fields
| Field Name | Description |
|---|---|
accountNumberFormat - String | Indicator of account number format validity for institution.
|
nameMatchScore - Int | Indicates the score of the name match between the given name provided during database verification (available in the verification_name field) and matched Plaid network accounts. If defined, will be a value between 0 and 100. Will be undefined if name matching was not enabled for the database verification session or if there were no eligible Plaid network matches to compare the given name with. |
networkStatus - RemoteDataPlaidVerificationInsightsNetworkStatus | Status information about the account and routing number in the Plaid network. |
previousReturns - RemoteDataPlaidVerificationInsightsNetworkStatus | Information about known ACH returns for the account and routing number. |
Example
{
"accountNumberFormat": "abc123",
"nameMatchScore": 987,
"networkStatus": RemoteDataPlaidVerificationInsightsNetworkStatus,
"previousReturns": RemoteDataPlaidVerificationInsightsNetworkStatus
}
RemoteDataPlaidVerificationInsightsNetworkStatus
Description
Status information about the account and routing number in the Plaid network.
Example
{"hasNumbersMatch": false, "isNumbersMatchVerified": true}
RemoteDataPlaidYieldRate
Description
Details about a fixed income security's expected rate of return.
Fields
| Field Name | Description |
|---|---|
percentage - Float | The fixed income security's expected rate of return. |
type - String | The type of rate which indicates how the predicted yield was calculated. It is one of:
|
Example
{"percentage": 987.65, "type": "abc123"}
SearchQuery
Description
Options for searching through a list.
Fields
| Input Field | Description |
|---|---|
term - String | Query for searching. |
Example
{"term": "xyz789"}
Security
Statement
Description
Represents a Statement.
Fields
| Field Name | Description |
|---|---|
account - Account! | The Account associated with the Statement. |
at - DateTime! | The UTC date and time of the most recently known state of the Statement. This typically represents the time when data was last successfully synced with the upstream provider. |
endOn - Date | The end date of the Statement period. |
id - ID! | The ID of the Statement. |
startOn - Date | The start date of the Statement period. |
url - URL! | The URL of the Statement PDF, with a 1-hour expiration. |
Example
{
"account": Account,
"at": "2026-01-22T14:15:22Z",
"endOn": "2007-12-03",
"id": "stmt_11zBVgTOO9DR1vbAZxb6Ldb",
"startOn": "2007-12-03",
"url": "http://www.test.com/"
}
StatementConnection
Description
The connection type for Statement.
Fields
| Field Name | Description |
|---|---|
count - Int! | The total number of records. |
edges - [StatementEdge] | A list of edges. |
nodes - [Statement] | A list of nodes. |
pageInfo - PageInfo! | Information to aid in pagination. |
Example
{
"count": 987,
"edges": [StatementEdge],
"nodes": [Statement],
"pageInfo": PageInfo
}
StatementEdge
StatementFilter
Description
Options for filtering Statements.
Fields
| Input Field | Description |
|---|---|
accountIds - [ID!] | Filter for Statements by one or more supplied Account IDs. Examples:
|
for - DateRange | Filter for Statements by overlap with the supplied data range. Examples:
|
issuedFor - DateMonth | Filter for Statements issued on the supplied month. Examples:
|
on - Date | Filter for Statements covered by the supplied date. Examples:
|
Example
{
"accountIds": ["acct_12Hz9Dz7vEAuljYvhmPcvM9"],
"for": DateRange,
"issuedFor": DateMonth,
"on": "2025-01-24T14:15:22Z"
}
StatementSort
Description
Options for sorting statements.
Values
| Enum Value | Description |
|---|---|
|
| Oldest First, Unknown Periods Last |
|
| Newest First, Unknown Periods First |
Example
"DATE_ASC"
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
Transaction
Description
A Transaction represents financial activity associated with an Account.
Fields
| Field Name | Description |
|---|---|
account - Account! | The Account of the Transaction. |
amount - Float! | The amount of the Transaction. Positive for CREDIT inflows and negative for DEBIT outflows. |
currencyCode - CurrencyCode! | The ISO-4217 currency code of the Transaction |
date - Date! | The date the transaction was posted or occurred, as reported by the financial institution.
|
description - String! | The description or line item name. |
entryType - TransactionEntryType! | Whether the transaction represents an inflow (CREDIT) or an outflow (DEBIT). |
fees - Float | For Investments: The total amount of all fees applied to this transaction. |
id - ID! | The ID of the Transaction. |
kind - AccountKind! | Represents the classification of a Transaction. |
logo - Image | A single Transaction Logo. |
metadata - JSON | Custom metadata about the Transaction, stored in a 'key-value' format. See the Custom Metadata guide for more information and examples. |
price - Float | For Investments: The price of the security at the time of this transaction. |
provider - ConnectionProvider! | The original provider of the Transaction. |
quantity - Float | For Investments: The quantity of security units involved in this transaction: positive for purchases and negative for sales. |
remoteData - TransactionRemoteData | The Remote Data associated with the Transaction. See the Remote Data guide for more information. |
security - Security | The Security associated with the Investment Transaction. |
status - TransactionStatus! | Represents the status for a Transaction. |
Example
{
"account": Account,
"amount": 123.45,
"currencyCode": "USD",
"date": "2007-12-03",
"description": "Chipotle Mexican Grill",
"entryType": "CREDIT",
"fees": 123.45,
"id": "txn_11VgTOO9DR1vbAZxb6zBLdb",
"kind": "DEPOSITORY",
"logo": Image,
"metadata": {"userDefinedName": "My favorite transaction"},
"price": 123.45,
"provider": "AKOYA",
"quantity": 123.45,
"remoteData": TransactionRemoteData,
"security": Security,
"status": "POSTED"
}
TransactionConnection
Description
The connection type for Transaction.
Fields
| Field Name | Description |
|---|---|
count - Int! | The total number of records. |
edges - [TransactionEdge] | A list of edges. |
nodes - [Transaction] | A list of nodes. |
pageInfo - PageInfo! | Information to aid in pagination. |
Example
{
"count": 987,
"edges": [TransactionEdge],
"nodes": [Transaction],
"pageInfo": PageInfo
}
TransactionEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String! | A cursor for use in pagination. |
node - Transaction | The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": Transaction
}
TransactionEntryType
Description
Whether the transaction represents an inflow (CREDIT) or an outflow (DEBIT).
Values
| Enum Value | Description |
|---|---|
|
| An entry recording money being advanced into the account. |
|
| An entry recording money being withdrawn from the account. |
Example
"CREDIT"
TransactionFilter
Description
Options for filtering Transactions.
Fields
| Input Field | Description |
|---|---|
accountIds - [ID!] | Filter Transactions by one or more supplied Account IDs. Examples:
|
amount - Float | The amount of the Transaction |
amount_abs - Float | Absolute value of the amount of the Transaction |
amount_abs_gt - Float | Greater than the absolute value of the amount of the Transaction |
amount_abs_gte - Float | Greater than or equal to the absolute value of the amount of the Transaction |
amount_abs_lt - Float | Less than the absolute value of the amount of the Transaction |
amount_abs_lte - Float | Less than or equal to the absolute value of the amount of the Transaction |
amount_gt - Float | Greater than the amount of the Transaction |
amount_gte - Float | Greater than or equal to the amount of the Transaction |
amount_lt - Float | Less than the amount of the Transaction |
amount_lte - Float | Less than or equal to the amount of the Transaction |
date - Date | The date the transaction was posted or occurred, as reported by the financial institution.
|
date_gt - Date | Greater than the date the transaction was posted or occurred, as reported by the financial institution.
|
date_gte - Date | Greater than or equal to the date the transaction was posted or occurred, as reported by the financial institution.
|
date_lt - Date | Less than the date the transaction was posted or occurred, as reported by the financial institution.
|
date_lte - Date | Less than or equal to the date the transaction was posted or occurred, as reported by the financial institution.
|
entryType - TransactionEntryType | Filter Transactions by debit/credit status. Examples:
|
kind - [AccountKind!] | Filter Transactions by one of more classifications. Examples:
|
kind_not - [AccountKind!] | Filter out Transactions by one or more classification. Examples:
|
metadata - JSON | Filter by the contents of Transaction Examples:
|
status - [TransactionStatus!] | Filter Transactions by Transaction status. Examples:
|
Example
{
"accountIds": ["acct_12Hz9Dz7vEAuljYvhmPcvM9"],
"amount": 123.45,
"amount_abs": 987.65,
"amount_abs_gt": 987.65,
"amount_abs_gte": 987.65,
"amount_abs_lt": 987.65,
"amount_abs_lte": 123.45,
"amount_gt": 987.65,
"amount_gte": 123.45,
"amount_lt": 987.65,
"amount_lte": 987.65,
"date": "2007-12-03",
"date_gt": "2007-12-03",
"date_gte": "2007-12-03",
"date_lt": "2007-12-03",
"date_lte": "2007-12-03",
"entryType": "CREDIT",
"kind": ["DEPOSITORY"],
"kind_not": ["DEPOSITORY"],
"metadata": {},
"status": ["PENDING"]
}
TransactionRemoteData
Description
Remote data associated with a Transaction.
Fields
| Field Name | Description |
|---|---|
akoya - TransactionRemoteDataAkoya | The Akoya remote data associated with the Transaction. |
fingoal - TransactionRemoteDataFingoal | The FinGoal remote data associated with the Transaction. |
finicity - TransactionRemoteDataFinicity | The Finicity remote data associated with the Transaction. |
mock - TransactionRemoteDataMock | The Mock remote data associated with the Transaction. |
mx - TransactionRemoteDataMx | The MX remote data associated with the Transaction. |
ntropy - TransactionRemoteDataNtropy | The Ntropy remote data associated with the Transaction. |
plaid - TransactionRemoteDataPlaid | The Plaid remote data associated with the Transaction. |
Example
{
"akoya": TransactionRemoteDataAkoya,
"fingoal": TransactionRemoteDataFingoal,
"finicity": TransactionRemoteDataFinicity,
"mock": TransactionRemoteDataMock,
"mx": TransactionRemoteDataMx,
"ntropy": TransactionRemoteDataNtropy,
"plaid": TransactionRemoteDataPlaid
}
TransactionRemoteDataAkoya
Description
Transaction-level data from Akoya.
Fields
| Field Name | Description |
|---|---|
transaction - TransactionRemoteDataAkoyaTransaction | The Transaction data from Akoya. |
Example
{"transaction": TransactionRemoteDataAkoyaTransaction}
TransactionRemoteDataAkoyaTransaction
Description
The Transaction data from Akoya.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Akoya ID. |
response - RemoteDataAkoyaTransaction | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "xyz789",
"response": RemoteDataAkoyaTransaction,
"timestamp": "2025-03-24T12:25:12Z"
}
TransactionRemoteDataFingoal
Description
Transaction-level data from FinGoal.
Fields
| Field Name | Description |
|---|---|
enrichment - TransactionRemoteDataFingoalEnrichment | The Enrichment data from FinGoal. |
Example
{"enrichment": TransactionRemoteDataFingoalEnrichment}
TransactionRemoteDataFingoalEnrichment
Description
The Enrichment data from Fingoal.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Fingoal ID. |
response - RemoteDataFingoalEnrichedTransaction | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "xyz789",
"response": RemoteDataFingoalEnrichedTransaction,
"timestamp": "2025-03-24T12:25:12Z"
}
TransactionRemoteDataFinicity
Description
Transaction-level data from Finicity.
Fields
| Field Name | Description |
|---|---|
transaction - TransactionRemoteDataFinicityTransaction | The Transaction data from Finicity. |
Example
{"transaction": TransactionRemoteDataFinicityTransaction}
TransactionRemoteDataFinicityTransaction
Description
The Transaction data from Finicity.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Finicity ID. |
response - RemoteDataFinicityTransaction | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "xyz789",
"response": RemoteDataFinicityTransaction,
"timestamp": "2025-03-24T12:25:12Z"
}
TransactionRemoteDataMock
Description
Transaction-level data from Mock.
Fields
| Field Name | Description |
|---|---|
transaction - TransactionRemoteDataMockTransaction | The Transaction data from Mock. |
Example
{"transaction": TransactionRemoteDataMockTransaction}
TransactionRemoteDataMockTransaction
Description
The Transaction data from Mock.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Mock ID. |
response - RemoteDataMockTransaction | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "xyz789",
"response": RemoteDataMockTransaction,
"timestamp": "2025-03-24T12:25:12Z"
}
TransactionRemoteDataMx
Description
Transaction-level data from MX.
Fields
| Field Name | Description |
|---|---|
enrichment - TransactionRemoteDataMxEnrichment | The Enrichment data from MX. |
transaction - TransactionRemoteDataMxTransaction | The base Transaction data from MX. |
Example
{
"enrichment": TransactionRemoteDataMxEnrichment,
"transaction": TransactionRemoteDataMxTransaction
}
TransactionRemoteDataMxEnrichment
Description
The Enrichment data from Mx.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Mx ID. |
response - RemoteDataMxEnhanceTransaction | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "xyz789",
"response": RemoteDataMxEnhanceTransaction,
"timestamp": "2025-03-24T12:25:12Z"
}
TransactionRemoteDataMxTransaction
Description
The Transaction data from Mx.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Mx ID. |
response - RemoteDataMxTransaction | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "xyz789",
"response": RemoteDataMxTransaction,
"timestamp": "2025-03-24T12:25:12Z"
}
TransactionRemoteDataNtropy
Description
Transaction-level data from Ntropy.
Fields
| Field Name | Description |
|---|---|
enrichment - TransactionRemoteDataNtropyEnrichment | The Enrichment data from Ntropy. |
Example
{"enrichment": TransactionRemoteDataNtropyEnrichment}
TransactionRemoteDataNtropyEnrichment
Description
The Enrichment data from Ntropy.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Ntropy ID. |
response - RemoteDataNtropyEnrichedTransaction | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "xyz789",
"response": RemoteDataNtropyEnrichedTransaction,
"timestamp": "2025-03-24T12:25:12Z"
}
TransactionRemoteDataPlaid
Description
Transaction-level data from Plaid.
Fields
| Field Name | Description |
|---|---|
investmentTransaction - TransactionRemoteDataPlaidInvestmentTransaction | The Investment Transaction data from Plaid. |
security - TransactionRemoteDataPlaidSecurity | The Security data from Plaid. |
transaction - TransactionRemoteDataPlaidTransaction | The base Transaction data from Plaid. |
Example
{
"investmentTransaction": TransactionRemoteDataPlaidInvestmentTransaction,
"security": TransactionRemoteDataPlaidSecurity,
"transaction": TransactionRemoteDataPlaidTransaction
}
TransactionRemoteDataPlaidInvestmentTransaction
Description
The Investment Transaction data from Plaid.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Plaid ID. |
response - RemoteDataPlaidInvestmentTransaction | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "abc123",
"response": RemoteDataPlaidInvestmentTransaction,
"timestamp": "2025-03-24T12:25:12Z"
}
TransactionRemoteDataPlaidSecurity
Description
The Security data from Plaid.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Plaid ID. |
response - RemoteDataPlaidSecurity | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "abc123",
"response": RemoteDataPlaidSecurity,
"timestamp": "2025-03-24T12:25:12Z"
}
TransactionRemoteDataPlaidTransaction
Description
The Transaction data from Plaid.
Fields
| Field Name | Description |
|---|---|
id - String! | The record's Plaid ID. |
response - RemoteDataPlaidTransaction | The response body. |
timestamp - DateTime! | The date and time when the data was fetched. |
Example
{
"id": "abc123",
"response": RemoteDataPlaidTransaction,
"timestamp": "2025-03-24T12:25:12Z"
}
TransactionSort
Description
Options for sorting transactions.
Values
| Enum Value | Description |
|---|---|
|
| Oldest First, Pending Last |
|
| Newest First, Pending First |
Example
"DATE_ASC"
TransactionStatus
Description
Represents the status for a Transaction.
Values
| Enum Value | Description |
|---|---|
|
| Awaiting decision or settlement, and may be replaced, updated, or removed. |
|
| Announced or published as conclusive. |
Example
"PENDING"
TransactionUpdateInput
Description
Autogenerated input type of TransactionUpdate
Fields
| Input Field | Description |
|---|---|
id - ID! | The ID of the transaction to be updated. |
metadata - JSON | Custom metadata about the Transaction, stored in a 'key-value' format. See the Custom Metadata guide for more information and examples. |
Example
{"id": "txn_11VgTOO9DR1vbAZxb6zBLdb", "metadata": {}}
TransactionUpdatePayload
Description
Autogenerated return type of TransactionUpdate.
Fields
| Field Name | Description |
|---|---|
errors - [Error!] | List of errors from an unsuccessful mutation. |
record - Transaction | The updated transaction. |
success - Boolean! | Specifies whether the mutation was successful. |
Example
{
"errors": [Error],
"record": Transaction,
"success": false
}
URL
Description
Represents a valid URL, transported as a string.
Example
"http://www.test.com/"