{
"opencollection": "1.0.0",
"info": {
"name": "Yodlee Core APIs Account Token Verification API",
"version": "1.1.0"
},
"items": [
{
"info": {
"name": "Verification",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Verified Accounts",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/verification/verifiedAccounts",
"params": [
{
"name": "accountId",
"value": "",
"type": "query",
"description": "Comma separated accountIds."
},
{
"name": "isSelected",
"value": "",
"type": "query",
"description": "Comma separated isSelected. Allowed values are true, false.
"
},
{
"name": "providerAccountId",
"value": "",
"type": "query",
"description": "providerAccountId."
},
{
"name": "verificationStatus",
"value": "",
"type": "query",
"description": "Comma separated verificationStatus. Allowed values are SUCCESS, FAILED
Note: If no value is passed, the implicit default value is SUCCESS."
}
]
},
"docs": "The Verified Accounts API v1.1 provides information about the bank and investment accounts that the user has selected for verification, during the Account Verification flow on FastLink 4. By default, the API only returns information of the accounts that were selected and have been successfully verified.
"
},
{
"info": {
"name": "Get Holder Profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/verification/holderProfile",
"params": [
{
"name": "accountId",
"value": "",
"type": "query",
"description": "accountId"
},
{
"name": "providerAccountId",
"value": "",
"type": "query",
"description": "providerAccountId."
}
]
},
"docs": "The Holder Profile API service allows retrieving the user's profile details (i.e., PII data such as name, email, phone number, and address) that are available at the provider account and each account level. The API accepts the providerAccountId and retrieves the profile information available under it and all the details available under each of the associated accounts.
This service can only be invoked by Yodlee API v1.1, FastLink 3, and FastLink 4 customers.
"
},
{
"info": {
"name": "Get Classification Summary",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/verification/classification/summary",
"params": [
{
"name": "accountId",
"value": "",
"type": "query",
"description": "accountId"
}
]
},
"docs": "The get classification summary API service returns attributes that provide account-level and transaction-level summary for a user's account.
As a prerequisite, the Account Verification customers should have Transactions enabled to fetch a response. The API can be invoked only for an account verified by the user following the get verified accounts API call. If the prerequisite is not satisfied, an appropriate error will be returned on invoking the API.
"
},
{
"info": {
"name": "Get Verification Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/verification",
"params": [
{
"name": "accountId",
"value": "",
"type": "query",
"description": "Comma separated accountId"
},
{
"name": "providerAccountId",
"value": "",
"type": "query",
"description": "Comma separated providerAccountId"
},
{
"name": "verificationType",
"value": "",
"type": "query",
"description": "verificationType"
}
]
},
"docs": "The get verification status service is used to retrieve the verification status of all accounts for which the MS or CDV process has been initiated.
For the MS process, the account details object returns the aggregated information of the verified accounts. For the CDV process, the account details object returns the user provided account information.
"
},
{
"info": {
"name": "Initiaite Challenge Deposit",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/verification"
},
"docs": "The post verification service is used to initiate the matching service (MS) and the challenge deposit account verification (CDV) process to verify account ownership.
The MS and CDV process can verify ownership of only bank accounts (i.e., checking and savings).
The MS verification can be initiated only for an already aggregated account or a providerAccount.
The prerequisite for the MS verification process is to request the ACCT_PROFILE dataset with the HOLDER_NAME attribute.
In the M"
},
{
"info": {
"name": "Verify Challenge Deposit",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/verification"
},
"docs": "The put verification service is used to complete the challenge deposit verification (CDV) process.
This service is used only by the customer of CDV flow.
In the CDV process, the user-provided microtransaction details (i.e., credit and debit) is matched against the microtransactions posted by Yodlee. For a successful verification of the account's ownership both the microtransaction details should match.
The CDV process is currently supported only in the United States.
Notes: