Sorry, you need to enable JavaScript to visit this website.
Skip to main content

Verified Account Resource

Request-level Data

Attribute Name Type Description Endpoint
verifiedAccount entity[] Details about the verified account. GET verification/verifiedAccounts
requestId string The unique identifier for the request. GET verification/verifiedAccounts
requestDate dateTime Indicates the date and time when the request ID is created in the system. GET verification/verifiedAccounts
state string The state of the verification request.
Valid Values: Verified Accounts Verification State
GET verification/verifiedAccounts
failedReason string The reason for the account verification failed.
Valid Values: Verification Request Failed Reason
GET verification/verifiedAccounts

Entity: verifiedAccount

Attribute Name Type Description Endpoint
CONTAINER string The type of service, i.e., bank or investment. GET verification/verifiedAccounts
accountId long The unique identifier for the account. GET verification/verifiedAccounts
displayedName string The name or identification of the account owner as it appears at the financial institution (FI) site.
Note: The account holder’s name can be full or partial based on how it is displayed on the account summary page of the FI site. In most cases, the FI site does not display the full account holder’s name on the account summary page.
GET verification/verifiedAccounts
providerAccountId long The unique identifier for the provider account. GET verification/verifiedAccounts
accountName string The account name as it appears on the site. GET verification/verifiedAccounts
accountNumber string The account number as it appears on the site. GET verification/verifiedAccounts
providerId string Identifier of the provider site. The primary key of provider resource.  GET verification/verifiedAccounts
providerName string Service provider or institution name where the account originates. This belongs to the provider resource.
accountType string The aggregated account type, such as savings, checking, etc. The account type is derived based on the attributes of the account.
Valid Values: Aggregated Account Types
GET verification/verifiedAccounts
availableBalance money The balance in the account that is available for spending. For checking accounts with overdrafts, the available balance may include an overdraft amount if the site adds an overdraft balance to the available balance.
Note: Applies only to the bank container.
GET verification/verifiedAccounts
currentBalance money The balance in the account that is available at the beginning of the business day; is equal to the account's ledger balance.
Note: Applies only to the bank container.
GET verification/verifiedAccounts
cash money The amount that is available for immediate withdrawal or the total amount available to purchase securities in a brokerage or investment account.
Note: The cash balance field applies only to brokerage-related accounts.
GET verification/verifiedAccounts
balance money The total balance of all the investment accounts, as it appears on the FI site.
Note: Applies only to the investment container.
GET verification/verifiedAccounts
classification string The classification of the account, such as personal, corporate, etc., as set by the system.
Valid Values: Account Classification
GET verification/verifiedAccounts
verificationStatus string The status of the account verification.
Valid Values: Verified Accounts Verification Status
GET verification/verifiedAccounts
failedReason string The reason the account verification failed.
Valid Values: Verification Account Failed Reason
GET verification/verifiedAccounts
isSelected boolean Indicates if an account is selected by the user in the FastLink 4 application. GET verification/verifiedAccounts
bankTransferCode entity[] Bank and branch identification information GET verification/verifiedAccounts
fullAccountNumberList entity Includes payment account number and unmasked account number. The payment account number is used for ACH or funds transfers. The unmasked account number refers to an account; it is not masked or partially displayed. GET verification/verifiedAccounts
holder entity[] Holder details of the account. GET verification/verifiedAccounts

Entity: fullAccountNumberList

Attribute Name Type Description Endpoint
paymentAccountNumber string The payment account number of the account used for payments in all regions. This may be looked at as an ACH account number in the US. GET verification/verifiedAccounts
unmaskedAccountNumber string The unmasked account number of the account is the same as the account number that is used to refer to an account and is not partial or masked. In the case of investments, it is the number used for asset transfers. GET verification/verifiedAccounts

Entity: holder

Attribute Name Type Description Endpoint
name name Name of the account holder. GET verification/verifiedAccounts
gender string Gender of the account holder. GET verification/verifiedAccounts
ownership string Indicates the ownership of the account. GET verification/verifiedAccounts

Entity: bankTransferCode

Attribute Name Type Description Endpoint
id string The financial institution's branch identification number.
Additional Details: The bank account's routing number in the United States. For non-United States accounts, it is the IFSC code (India), BSB number (Australia), and sort code (United Kingdom). 
GET verification/verifiedAccounts
type string The bank transfer code type varies depending on the region of the account origination.
Valid Values: Bank Transfer Code
GET verification/verifiedAccounts

Enum: Bank Transfer Code

Type Description
BSB BSB is a Bank-State-Branch number used to identify the branch in Australia and is required for performing transfers. 
ROUTING_NUMBER  A bank routing number or routing transit number (RTN) is a nine-digit number used in the US to identify a financial institution in a transaction. The most common transaction types where routing numbers are used are ACH and wire transfers.
IFSC FSC is the Indian Financial System Code. It is an alphanumeric code that is used to identify a particular branch in India and is required for electronic funds settlement.
SORT_CODE  The sort code is a six-digit number used in the UK to identify the bank and the branch where the account is held.

Enum: Verified Accounts Verification State

State Description
COMPLETED The verification request is completed.
FAILED The verification request has failed.

Enum: Account Classification

Account Classification Description
CORPORATE Indicates the account is a corporate account.
PERSONAL Indicates the account is a personal account.
SMALL_BUSINESS Indicates the account is a small or medium business account.
TRUST Indicates the account is a trust account.
OTHER Indicates that the account could not be classified into any other account classifications.

Enum: Verified Accounts Verification Status

Verification Status Description
SUCCESS The user’s account verification is successful.
FAILED The user’s account verification has failed.

Enum: Verification Request Failed Reason

Failed Reason Description
NO_ELIGIBLE_ACCOUNTS The account verification process has failed, as no eligible accounts are available.
REQUIRED_DATA_NOT_AVAILABLE The account verification-related details are not available at the FI site.
MATCHING_FAILED The account verification process has failed due to the account holder’s data mismatch.
USER_INPUT_REQUIRED User input is required for the site login. 
CREDENTIALS_UPDATE_NEEDED Login errors due to outdated credentials.
INCORRECT_CREDENTIALS Login errors due to incorrect credentials. 
USER_ACTION_NEEDED_AT_SITE All errors that need a user action at the site. Example- Accept T&C, etc.
ADDL_AUTHENTICATION_REQUIRED Additional MFA information is needed at the site.
INVALID_ADDL_INFO_PROVIDED Invalid MFA information provided by the user.
ACCOUNT_LOCKED Account locked at the end site.
SITE_NOT_SUPPORTED All errors where support is not available to complete the requested action.
SITE_BLOCKING_ERROR Yodlee's IP is blocked. 
TECH_ERROR Technical error has occurred.
UNEXPECTED_SITE_ERROR All errors related to site issues, such as the site being down for maintenance.
SITE_UNAVAILABLE Site is unavailable due to issues such as the site being down for maintenance.
SITE_SESSION_INVALIDATED Errors related to multiple sessions or sessions terminated by the site. 
REQUEST_TIME_OUT Request has timed out.
CONSENT_EXPIRED The site has informed us to provide user consent for aggregation. 
CONSENT_REVOKED The site has informed that consent is revoked by the user for aggregation.
INCORRECT_OAUTH_TOKEN The site has informed us that the tokens provided are incorrect.
CONSENT_REQUIRED The site has informed us that user consent is required.
NEW_AUTHENTICATION_REQUIRED The site has requested an OAuth authentication.

Enum: Verification Account Failed Reason

Failed Reason Description
REQUIRED_DATA_NOT_AVAILABLE The account verification-related details are not available at the FI site.
MATCHING_FAILED The account verification process has failed due to the account holder’s data mismatch.

Enum: Aggregated Account Types

Container Account Type
bank CHECKING
Note: For the UK and Australian regions, CHECKING indicates the current account type.
SAVINGS
MONEY_MARKET
investment BROKERAGE_CASH
BROKERAGE_MARGIN
INDIVIDUAL
CASH_MANAGEMENT_ACCOUNT
BROKERAGE_LINK_ACCOUNT