API Integrations

After exiting the FastLink flow, Envestnet | Yodlee recommends calling the following relevant Yodlee APIs after learning that the link account process is completed based on your product use cases:

• GET Accounts – To retrieve all the accounts that are aggregated for the user.
• GET Account Detail– To retrieve a single account's details.
• GET Verified Accounts – To retrieve the successfully verified or failed verified accounts.
• GET Provider Accounts – To retrieve the latest status of the provider accounts that are added, edited, or updated through FastLink.
• GET Provider Account Details – To retrieve the latest status of a particular provider account that was added, edited, or updated through FastLink.

GET Accounts

The GET accounts service should be called to retrieve aggregation-based accounts only if the config names passed to FastLink are based on the following user flows:

• Aggregation
• Aggregation plus Verification
• Verification plus Aggregation

The GET accounts service provides information about accounts added by the user through FastLink. By default, this service returns information of active and to-be-closed accounts. If requestId is provided, the accounts that are updated in the context of the requestId will be provided in the response. If the isSelectedForAggregation flag is provided as TRUE, the accounts associated with the Aggregation flow are only returned.

Input Parameter:

• accountId - The unique identifier of the account as returned in the FastLink post messages. Retrieve account details of a given accountId. Comma separated values can be passed.
• providerAccountId - The unique identifier of the provider accounts as returned in the FastLink post messages.
• requestId - The unique identifier for every request (to retrieve contextual data) as returned in the FastLink post messages.
• isSelectedForAggregation - If you are using the Aggregation plus Verification user flow, pass the value as TRUE to retrieve the aggregation-only accounts.

Method and URL:

GET Account Details

The GET account details service provides detailed information, such as account numbers, routing numbers, holder details, etc., of the account, added and selected for verification through FastLink.

Input Parameter:

accountId - The unique identifier of an account as returned in the FastLink post messages. Retrieve account details of a given accountId.

Method and URL:

GET Verified Accounts

The GET verified accounts service should be called to retrieve verified accounts only if the config names passed to FastLink are based on the following user flows:

• Verification
• Aggregation plus Verification
• Verification plus Aggregation

The GET verified accounts service provides information on the bank and investment accounts that are verified by the user. By default, the API only returns successfully verified accounts' information.

Input Parameter:

• accountId - The unique identifier of an account as returned in the FastLink post messages. Retrieve account details of multiple verified account IDs.
• providerAccountId - The unique identifier of the provider accounts as returned in the FastLink post messages.
• isSelected - Relevant only if you have opted for the account selection screen. To retrieve only the verified and selected accounts, pass the value as TRUE.

Method and URL:

GET Provider Accounts

The GET provider accounts service retrieves the latest status of the provider accounts that are added, edited, or updated through FastLink. This includes both failed and successfully added provider accounts. The response includes the providerAccount and the dataset-level statuses.

Input Parameter:

providerIds - The unique identifier of the provider as returned in the FastLink post messages. Comma-separated providerIds can be passed.

Method and URL:

GET Provider Account Details

The GET provider account details service is used to retrieve the latest status of a particular provider account that was added, edited, or updated through FastLink. This service has to be continuously called to know the progress of the triggered process. This service also provides the MFA information requested by the provider site.
The requestId returned in the FastLink post messages can be provided as input to the get provider account details service. If the requestId is provided, the response will be contextual (i.e., the datasets associated with the provided requestId will be returned. The response includes the providerAccount and the dataset-level statuses.

Input Parameter:

• providerAccountId - The unique identifier of the provider accounts as returned in the FastLink post messages.
• requestId - The unique identifier for every request (to retrieve contextual data) as returned in the FastLink post messages.

Method and URL: