Verify Accounts Using Transactions

v1.0.0

The verify account service is used to verify the account's ownership by matching the transaction details with the accounts aggregated for the user.

If a match is identified, the service returns details of all the accounts along with the matched transaction's details.
If no transaction match is found, an empty response will be returned.
A maximum of 5 transactionCriteria can be passed in a request.
The baseType, date, and amount parameters should mandatorily be passed.
The optional dateVariance parameter cannot be more than 7 days. For example, +7, -4, or +/-2.
Pass the container or accountId parameters for better performance.
This service supports the localization feature and accepts locale as a header parameter.

Input

{
  "type": "object",
  "properties": {
    "accountId": {
      "type": "integer",
      "format": "int64"
    },
    "container": {
      "type": "string",
      "enum": [
        "bank",
        "creditCard",
        "investment",
        "insurance",
        "loan",
        "reward",
        "realEstate",
        "otherAssets",
        "otherLiabilities"
      ]
    },
    "providerAccountId": {
      "type": "string"
    },
    "transactionCriteria": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "amount",
          "date"
        ],
        "properties": {
          "amount": {
            "type": "number",
            "format": "double"
          },
          "baseType": {
            "type": "string",
            "description": "Indicates if the transaction appears as a debit or a credit transaction in the account. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br><b>Applicable Values</b><br>",
            "enum": [
              "CREDIT",
              "DEBIT"
            ]
          },
          "date": {
            "type": "string"
          },
          "dateVariance": {
            "type": "string"
          },
          "keyword": {
            "type": "string"
          },
          "matched": {
            "type": "string",
            "description": "Indicates if the criteria is matched or not. <br><b>Applicable Values</b><br>",
            "enum": [
              "COMPLETE",
              "NONE"
            ]
          },
          "verifiedTransaction": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "CONTAINER": {
                  "type": "string",
                  "description": "The account's container.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br><b>Applicable Values</b><br>",
                  "enum": [
                    "bank",
                    "creditCard",
                    "investment",
                    "insurance",
                    "loan",
                    "reward",
                    "realEstate",
                    "otherAssets",
                    "otherLiabilities"
                  ]
                },
                "accountId": {
                  "type": "integer",
                  "format": "int64",
                  "description": "The account from which the transaction was made. This is basically the primary key of the account resource. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>"
                },
                "amount": {
                  "type": "object",
                  "required": [
                    "amount",
                    "currency"
                  ],
                  "properties": {
                    "amount": {
                      "type": "number",
                      "format": "double"
                    },
                    "currency": {
                      "type": "string",
                      "enum": [
                        "AUD",
                        "BRL",
                        "CAD",
                        "EUR",
                        "GBP",
                        "HKD",
                        "IDR",
                        "INR",
                        "JPY",
                        "NZD",
                        "SGD",
                        "USD",
                        "ZAR",
                        "CNY",
                        "VND",
                        "MYR",
                        "CHF"
                      ]
                    }
                  }
                },
                "baseType": {
                  "type": "string",
                  "description": "Indicates if the transaction appears as a debit or a credit transaction in the account. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br><b>Applicable Values</b><br>",
                  "enum": [
                    "CREDIT",
                    "DEBIT"
                  ]
                },
                "category": {
                  "type": "string",
                  "description": "The name of the category assigned to the transaction. This is the category field of the transaction category resource. The supported values are provided by the GET transactions/categories.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>"
                },
                "categoryId": {
                  "type": "integer",
                  "format": "int64",
                  "description": "The id of the category assigned to the transaction. This is the id field of the transaction category resource. The supported values are provided by the GET transactions/categories.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>"
                },
                "categorySource": {
                  "type": "string",
                  "description": "Indicates the source of the category, i.e., categories derived by the system or assigned/provided by the consumer. This is the source field of the transaction category resource. The supported values are provided by the GET transactions/categories.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br><b>Applicable Values</b><br>",
                  "enum": [
                    "SYSTEM",
                    "USER"
                  ]
                },
                "categoryType": {
                  "type": "string",
                  "description": "The categoryType of the category assigned to the transaction. This is the type field of the transaction category resource. The supported values are provided by the GET transactions/categories.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>",
                  "enum": [
                    "TRANSFER",
                    "DEFERRED_COMPENSATION",
                    "UNCATEGORIZE",
                    "INCOME",
                    "EXPENSE"
                  ]
                },
                "checkNumber": {
                  "type": "string",
                  "description": "The checkNumber of the transaction.<br><br><b>Applicable containers</b>: bank<br>"
                },
                "commission": {
                  "type": "object",
                  "required": [
                    "amount",
                    "currency"
                  ],
                  "properties": {
                    "amount": {
                      "type": "number",
                      "format": "double"
                    },
                    "currency": {
                      "type": "string",
                      "enum": [
                        "AUD",
                        "BRL",
                        "CAD",
                        "EUR",
                        "GBP",
                        "HKD",
                        "IDR",
                        "INR",
                        "JPY",
                        "NZD",
                        "SGD",
                        "USD",
                        "ZAR",
                        "CNY",
                        "VND",
                        "MYR",
                        "CHF"
                      ]
                    }
                  }
                },
                "createdDate": {
                  "type": "string"
                },
                "cusipNumber": {
                  "type": "string",
                  "description": "The CUSIP (Committee on Uniform Securities Identification Procedures) identifies the financial instruments in the United States and Canada.<br><b><br><b>Note</b></b>: The CUSIP number field applies only to trade related transactions.<br><br><b>Applicable containers</b>: investment<br>"
                },
                "date": {
                  "type": "string",
                  "description": "The value provided will be either postDate or transactionDate. postDate takes higher priority than transactionDate, except for the investment container as only transactionDate is available. The availability of postDate or transactionDate depends on the provider site.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>"
                },
                "description": {
                  "type": "object",
                  "properties": {
                    "consumer": {
                      "type": "string",
                      "description": "The description of the transaction as defined by the consumer. The consumer can define or provide more details of the transaction in this field.<br><br><b>Applicable containers</b>:  creditCard, insurance, loan<br>"
                    },
                    "original": {
                      "type": "string",
                      "description": "Original transaction description as it appears at the FI site.<br><br><b>Applicable containers</b>:  creditCard, insurance, loan<br>"
                    },
                    "security": {
                      "type": "string",
                      "description": "The description will provide the actual name of the security.<br><br><b>Applicable containers</b>: investment<br>"
                    },
                    "simple": {
                      "type": "string",
                      "description": "The transaction description that appears at the FI site may not be self-explanatory, i.e., the source, purpose of the transaction may not be evident. Yodlee attempts to simplify and make the transaction meaningful to the consumer, and this simplified transaction description is provided in the simple description field.Note: The simple description field is available only in the United States, Canada, United Kingdom, and India.<br><br><b>Applicable containers</b>:  creditCard, insurance, loan<br>"
                    }
                  }
                },
                "detailCategoryId": {
                  "type": "integer",
                  "format": "int64",
                  "description": "The id of the detail category that is assigned to the transaction. The supported values are provided by GET transactions/categories.<br><br><b>Applicable containers</b>: bank,creditCard<br>"
                },
                "highLevelCategoryId": {
                  "type": "integer",
                  "format": "int64",
                  "description": "The high level category assigned to the transaction. The supported values are provided by the GET transactions/categories. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>"
                },
                "holdingDescription": {
                  "type": "string",
                  "description": "For transactions involving securities, this captures the securities description.<br><br><b>Applicable containers</b>: investment<br>"
                },
                "id": {
                  "type": "integer",
                  "format": "int64",
                  "description": "An unique identifier for the transaction. The combination of the id and account container are unique in the system. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>"
                },
                "interest": {
                  "type": "object",
                  "required": [
                    "amount",
                    "currency"
                  ],
                  "properties": {
                    "amount": {
                      "type": "number",
                      "format": "double"
                    },
                    "currency": {
                      "type": "string",
                      "enum": [
                        "AUD",
                        "BRL",
                        "CAD",
                        "EUR",
                        "GBP",
                        "HKD",
                        "IDR",
                        "INR",
                        "JPY",
                        "NZD",
                        "SGD",
                        "USD",
                        "ZAR",
                        "CNY",
                        "VND",
                        "MYR",
                        "CHF"
                      ]
                    }
                  }
                },
                "isManual": {
                  "type": "boolean",
                  "description": "Indicates if the transaction is aggregated from the FI site or the consumer has manually created the transaction using the application or an API. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>"
                },
                "isin": {
                  "type": "string",
                  "description": "International Securities Identification Number (ISIN) standard is used worldwide to identify specific securities.<br><br><b>Applicable containers</b>: investment<br>"
                },
                "lastUpdated": {
                  "type": "string"
                },
                "memo": {
                  "type": "string",
                  "description": "Additional notes provided by the user for a particular  transaction through application or API services. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>"
                },
                "merchant": {
                  "type": "object",
                  "properties": {
                    "address": {
                      "type": "object",
                      "properties": {
                        "address1": {
                          "type": "string"
                        },
                        "address2": {
                          "type": "string"
                        },
                        "address3": {
                          "type": "string"
                        },
                        "city": {
                          "type": "string"
                        },
                        "country": {
                          "type": "string"
                        },
                        "sourceType": {
                          "type": "string"
                        },
                        "state": {
                          "type": "string"
                        },
                        "street": {
                          "type": "string"
                        },
                        "type": {
                          "type": "string",
                          "enum": [
                            "HOME",
                            "BUSINESS",
                            "POBOX",
                            "RETAIL",
                            "OFFICE",
                            "SMALL_BUSINESS",
                            "COMMUNICATION",
                            "PERMANENT",
                            "STATEMENT_ADDRESS",
                            "PAYMENT",
                            "PAYOFF",
                            "UNKNOWN"
                          ]
                        },
                        "zip": {
                          "type": "string"
                        }
                      }
                    },
                    "categoryLabel": {
                      "type": "array",
                      "description": "The business categories of the merchant.<br><br><b>Applicable containers</b>: bank,creditCard<br><b>Applicable Values</b><br>",
                      "items": {
                        "type": "string"
                      }
                    },
                    "contact": {
                      "type": "object",
                      "properties": {
                        "email": {
                          "type": "string",
                          "description": "Email Id of the merchant<br><br><b>Applicable containers</b>: bank,creditCard,investment,loan<br>"
                        },
                        "phone": {
                          "type": "string",
                          "description": "Phone number of the merchant<br><br><b>Applicable containers</b>: bank,creditCard,investment,loan<br>"
                        }
                      }
                    },
                    "coordinates": {
                      "type": "object",
                      "properties": {
                        "latitude": {
                          "type": "number",
                          "format": "double",
                          "description": "Latitude of the merchant<br><br><b>Applicable containers</b>: bank,creditCard,loan<br>"
                        },
                        "longitude": {
                          "type": "number",
                          "format": "double",
                          "description": "Longitude of the merchant<br><br><b>Applicable containers</b>: bank,creditCard,loan<br>"
                        }
                      }
                    },
                    "id": {
                      "type": "string",
                      "description": "Identifier of the merchant.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>"
                    },
                    "name": {
                      "type": "string",
                      "description": "The name of the merchant.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>"
                    },
                    "source": {
                      "type": "string",
                      "description": "The source through which merchant information is retrieved.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br><b>Applicable Values</b><br>",
                      "enum": [
                        "YODLEE",
                        "FACTUAL"
                      ]
                    },
                    "website": {
                      "type": "string",
                      "description": "The website of the merchant.<br><br><b>Applicable containers</b>: bank,creditCard,investment,loan<br>"
                    }
                  }
                },
                "parentCategoryId": {
                  "type": "integer",
                  "format": "int64",
                  "description": "The parentCategoryId of the category assigned to the transaction.<br><b>Note</b>: This field will be provided in the response if the transaction is assigned to a user-created category. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>"
                },
                "postDate": {
                  "type": "string",
                  "description": "The date on which the transaction is posted to the account.<br><br><b>Applicable containers</b>: bank,creditCard,insurance,loan<br>"
                },
                "price": {
                  "type": "object",
                  "required": [
                    "amount",
                    "currency"
                  ],
                  "properties": {
                    "amount": {
                      "type": "number",
                      "format": "double"
                    },
                    "currency": {
                      "type": "string",
                      "enum": [
                        "AUD",
                        "BRL",
                        "CAD",
                        "EUR",
                        "GBP",
                        "HKD",
                        "IDR",
                        "INR",
                        "JPY",
                        "NZD",
                        "SGD",
                        "USD",
                        "ZAR",
                        "CNY",
                        "VND",
                        "MYR",
                        "CHF"
                      ]
                    }
                  }
                },
                "principal": {
                  "type": "object",
                  "required": [
                    "amount",
                    "currency"
                  ],
                  "properties": {
                    "amount": {
                      "type": "number",
                      "format": "double"
                    },
                    "currency": {
                      "type": "string",
                      "enum": [
                        "AUD",
                        "BRL",
                        "CAD",
                        "EUR",
                        "GBP",
                        "HKD",
                        "IDR",
                        "INR",
                        "JPY",
                        "NZD",
                        "SGD",
                        "USD",
                        "ZAR",
                        "CNY",
                        "VND",
                        "MYR",
                        "CHF"
                      ]
                    }
                  }
                },
                "quantity": {
                  "type": "number",
                  "format": "double",
                  "description": "The quantity associated with the transaction.<br><b>Note</b>: The quantity field applies only to trade-related transactions.<br><br><b>Applicable containers</b>: investment<br>"
                },
                "runningBalance": {
                  "type": "object",
                  "required": [
                    "amount",
                    "currency"
                  ],
                  "properties": {
                    "amount": {
                      "type": "number",
                      "format": "double"
                    },
                    "currency": {
                      "type": "string",
                      "enum": [
                        "AUD",
                        "BRL",
                        "CAD",
                        "EUR",
                        "GBP",
                        "HKD",
                        "IDR",
                        "INR",
                        "JPY",
                        "NZD",
                        "SGD",
                        "USD",
                        "ZAR",
                        "CNY",
                        "VND",
                        "MYR",
                        "CHF"
                      ]
                    }
                  }
                },
                "sedol": {
                  "type": "string",
                  "description": "SEDOL stands for Stock Exchange Daily Official List, a list of security identifiers used in the United Kingdom and Ireland for clearing purposes.<br><br><b>Applicable containers</b>: investment<br>"
                },
                "settleDate": {
                  "type": "string",
                  "description": "It is the date on which the transaction is finalized, that is, the date the ownership of the security is transferred to the buyer. The settlement date is usually few days after the transaction date.<br><br><b>Applicable containers</b>: investment<br>"
                },
                "sourceId": {
                  "type": "string",
                  "description": "A unique ID that the provider site has assigned to the transaction. The source ID is only available for the pre-populated accounts.<br>Pre-populated accounts are the accounts that the FI customers shares with Yodlee, so that the user does not have to add or aggregate those accounts."
                },
                "sourceType": {
                  "type": "string",
                  "description": "The source through which the transaction is added to the Yodlee system.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loann<br><b>Applicable Values:</b><br>",
                  "enum": [
                    "AGGREGATED",
                    "MANUAL"
                  ]
                },
                "status": {
                  "type": "string",
                  "description": "The status of the transaction: pending or posted.<br><b>Note</b>: Most FI sites only display posted transactions. If the FI site displays transaction status, same will be aggregated.  <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br><b>Applicable Values</b><br>",
                  "enum": [
                    "POSTED",
                    "PENDING",
                    "SCHEDULED",
                    "FAILED",
                    "CLEARED"
                  ]
                },
                "subType": {
                  "type": "string",
                  "description": "The transaction subtype field provides a detailed transaction type. For example, purchase is a transaction type and the transaction subtype field indicates if the purchase was made using a debit or credit card.<br><b>Note</b>: The transaction subtype field is available only in the United States, Canada, United Kingdom, and India.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>",
                  "enum": [
                    "AUTH_HOLD",
                    "AUTH_REQUEST",
                    "OVERDRAFT_CHARGE",
                    "CREDIT_ADJUSTMENT",
                    "PIN_DEBIT",
                    "BANK_DIRECT_DEPOSIT",
                    "DIVIDEND_DEPOSIT",
                    "INTEREST_SAVINGS",
                    "INTEREST_ADJUSTMENT",
                    "ONLINE_PURCHASE",
                    "PURCHASED_WITH_CHECK",
                    "RECURRING_BILLING",
                    "TAX_PAYMENT",
                    "PAYMENT_BY_CHECK",
                    "PAYMENT_PLAN",
                    "FEE_REFUND",
                    "WIRE_TRANSFER_CHARGE",
                    "ACCOUNT_TO_ACCOUNT_TRANSFER",
                    "BANK_TO_BANK_TRANSACTION",
                    "BANK_TO_NON_BANK_ACCOUNT_TRANSFER",
                    "CASH_WITHDRAWAL_AT_FI",
                    "ATM_CASH_WITHDRAWAL",
                    "AUTH_PROCESSING",
                    "AUTH_RELEASE",
                    "PRE_AUTH",
                    "AUTH_COMPLETE",
                    "AUTH_VOID",
                    "BALANCE_ENQUIRY",
                    "ACCOUNT_VERIFICATION",
                    "PRE_AUTH_COMPLETION",
                    "SERVICE_CHARGE",
                    "SERVICE_CHARGE_FEE_REFUND",
                    "RETURNED_CHECK_CHARGE",
                    "RETURNED_CHECK_REIMBURSEMENT",
                    "CASH_ADVANCE",
                    "BILL_PAY_CHARGE",
                    "CHECK_IMAGE_SERVICE_CHARGE",
                    "OVERDRAFT_PROTECTION_CHARGE",
                    "STOP_PAYMENT_CHARGE",
                    "CHECKS_ORDERING_CHARGE",
                    "MONTHLY_MAINTENANCE_CHARGE",
                    "DEBIT_CARD_FEE",
                    "CONVENIENCE_FEE",
                    "PERSONAL_LOAN_CREDIT",
                    "CREDIT_CARD_CREDIT",
                    "AUTO_LOAN",
                    "HOME_LOAN_MORTGAGE",
                    "SHORT_TERM_CREDIT",
                    "SIGNATURE_DEBIT",
                    "CONTACT_LESS_DEBIT",
                    "DEFERRED_DEPOSIT",
                    "DEFERRED_BILL_PAY",
                    "INSTALLMENT_PAYMENT",
                    "RECURRING_SUBSCRIPTION_PAYMENT",
                    "HOLD_CHECK_PAYMENT",
                    "CAPITAL_GAINS_DISTIBUTION",
                    "CG_LONG_TERM_DEPOSIT",
                    "OPEN_SALE_DEPOSIT",
                    "INTEREST__CHECK",
                    "PURCHASE_VOID",
                    "PURCHASE_WITH_CREDIT_CARD",
                    "PURCHASE_WITH_DEBIT_CARD",
                    "CHARGE_A_REPEAT_CUSTOMER",
                    "DOWN_PAYMENT_OR_ANNUITY_PAYMENT_OR_DIRECT_PAYMENT",
                    "FEE_PAYMENT",
                    "FINANCE_CHARGE_REFUND",
                    "TRANSACTION_VOID",
                    "FEE_VOID",
                    "DEBIT_CARD_WITHDRAWAL_AT_STORE",
                    "ELECTRONIC_PAYMENT",
                    "ACH_DEBIT",
                    "ATM_TELLER_DEPOSIT",
                    "POS_DEBIT",
                    "BANK_ADJUSTMENT",
                    "CHARGES_FEES",
                    "INTEREST",
                    "DEPOSITS_CREDITS",
                    "PAYMENT",
                    "PURCHASE",
                    "REFUND",
                    "TRANSFER",
                    "WITHDRAWAL",
                    "OTHER_DEPOSITS",
                    "OTHER_WITHDRAWALS",
                    "ADJUSTMENT",
                    "FINANCE_CHARGE",
                    "OTHER_CHARGES_FEES",
                    "ANNUAL_FEE",
                    "DEPOSIT",
                    "DIRECT_DEPOSIT_SALARY",
                    "INVESTMENT_INCOME_CASH",
                    "SSA",
                    "REWARDS",
                    "CHECK_DEPOSIT",
                    "MOBILE_REMOTE_DEPOSIT",
                    "TELLER_DEPOSIT",
                    "TAX_REFUND",
                    "CREDIT_CARD_PAYMENT",
                    "INSURANCE_PAYMENT",
                    "UTILITIES_PAYMENT",
                    "CHILD_SUPPORT",
                    "LOAN",
                    "PERSONAL_LOAN",
                    "STUDENT_LOAN",
                    "SALES_TAX",
                    "REIMBURSEMENT",
                    "BALANCE_TRANSFER",
                    "WIRE_TRANSFER",
                    "OVERDRAFT_PROTECTION",
                    "DEBIT",
                    "CREDIT",
                    "NSF_FEES"
                  ]
                },
                "symbol": {
                  "type": "string",
                  "description": "The symbol of the security being traded.<br><b>Note</b>: The settle date field applies only to trade-related transactions. <br><br><b>Applicable containers</b>: investment<br>"
                },
                "transactionDate": {
                  "type": "string",
                  "description": "The date the transaction happens in the account. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>"
                },
                "type": {
                  "type": "string",
                  "description": "The nature of the transaction, i.e., deposit, refund, payment, etc.<br><b>Note</b>: The transaction type field is available only for the United States, Canada, United Kingdom, and India based provider sites. <br><br><b>Applicable containers</b>: bank,creditCard,investment<br>"
                },
                "valoren": {
                  "type": "string",
                  "description": "It is an identification number that is assigned to financial instruments such as stocks and bonds trading in Switzerland.<br><br><b>Applicable containers</b>: investment<br>"
                }
              }
            }
          }
        }
      }
    }
  },
  "required": [
    "providerAccountId",
    "transactionCriteria"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}