All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| get_classification_summary | GET /verification/classification/summary | Get Classification Summary |
| get_holder_profile | GET /verification/holderProfile | Get Holder Profile |
| get_verification_status | GET /verification | Get Verification Status |
| get_verified_accounts | GET /verification/verifiedAccounts | Get Verified Accounts |
| initiate_matching_or_challenge_deposite_verification | POST /verification | Initiaite Challenge Deposit |
| verify_challenge_deposit | PUT /verification | Verify Challenge Deposit |
ClassificationSummaryResponse get_classification_summary(account_id)
Get Classification Summary
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.
from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
# Create an instance of the API class
api_instance = yodlee.VerificationApi(api_client)
account_id = 'account_id_example' # str | accountId
try:
# Get Classification Summary
api_response = api_instance.get_classification_summary(account_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling VerificationApi->get_classification_summary: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| account_id | str | accountId |
No authorization required
- Content-Type: Not defined
- Accept: application/json;charset=UTF-8
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Y847 : resource cannot be requested, as feature not enabled<br>Y812 : Required field/value - accountId missing in the request<br>Y800 : Invalid value for accountId. Only ACTIVE and verified bank account ID belonging to the user is allowed.<br>Y805 : Multiple accountId not supported<br> | - |
| 401 | Unauthorized | - |
| 404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
HolderProfileResponse get_holder_profile(provider_account_id, account_id=account_id)
Get Holder Profile
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.
from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
# Create an instance of the API class
api_instance = yodlee.VerificationApi(api_client)
provider_account_id = 'provider_account_id_example' # str | providerAccountId.
account_id = 'account_id_example' # str | accountId (optional)
try:
# Get Holder Profile
api_response = api_instance.get_holder_profile(provider_account_id, account_id=account_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling VerificationApi->get_holder_profile: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| provider_account_id | str | providerAccountId. | |
| account_id | str | accountId | [optional] |
No authorization required
- Content-Type: Not defined
- Accept: application/json;charset=UTF-8
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Y901 : Service not supported<br>Y800 : Invalid value for providerAccountId<br>Y800 : Invalid value for accountId. Only ACTIVE accountIds are supported<br>Y800 : Invalid value for accountId. All accountIds should belong to the same providerAccountId<br>Y803 : providerAccountId required<br>Y805 : Multiple providerAccountId not supported<br>Y820 : The accountId is not supported for containers other than bank and investment<br>can only be invoked after the verification process is completed<br>Y824 : The maximum number of accountIds permitted is 10<br>Y878 : Profile data is not yet requested for this account | - |
| 401 | Unauthorized | - |
| 404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VerificationStatusResponse get_verification_status(account_id=account_id, provider_account_id=provider_account_id, verification_type=verification_type)
Get Verification Status
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.
from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
# Create an instance of the API class
api_instance = yodlee.VerificationApi(api_client)
account_id = 'account_id_example' # str | Comma separated accountId (optional)
provider_account_id = 'provider_account_id_example' # str | Comma separated providerAccountId (optional)
verification_type = 'verification_type_example' # str | verificationType (optional)
try:
# Get Verification Status
api_response = api_instance.get_verification_status(account_id=account_id, provider_account_id=provider_account_id, verification_type=verification_type)
pprint(api_response)
except ApiException as e:
print("Exception when calling VerificationApi->get_verification_status: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| account_id | str | Comma separated accountId | [optional] |
| provider_account_id | str | Comma separated providerAccountId | [optional] |
| verification_type | str | verificationType | [optional] |
No authorization required
- Content-Type: Not defined
- Accept: application/json;charset=UTF-8
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Y901 : Service not supported<br>Y813 : Either of accountId or providerAccountId should be provided<br>Y800 : Invalid value for accountId<br>Y800 : Invalid value for verification.verificationType<br>Y800 : Invalid value for providerAccountId<br>Y835 : Account(s) not eligible for Matching verification<br>Y836 : No verification initiated | - |
| 401 | Unauthorized | - |
| 404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VerifiedAccountResponse get_verified_accounts(provider_account_id, account_id=account_id, is_selected=is_selected, verification_status=verification_status)
Get Verified Accounts
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.
from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
# Create an instance of the API class
api_instance = yodlee.VerificationApi(api_client)
provider_account_id = 'provider_account_id_example' # str | providerAccountId.
account_id = 'account_id_example' # str | Comma separated accountIds. (optional)
is_selected = 'is_selected_example' # str | Comma separated isSelected. Allowed values are true, false <br><b>Note:</b> If no value is passed, the implicit default value is true. (optional)
verification_status = 'verification_status_example' # str | Comma separated verificationStatus. Allowed values are SUCCESS, FAILED <br><b>Note:</b> If no value is passed, the implicit default value is SUCCESS. (optional)
try:
# Get Verified Accounts
api_response = api_instance.get_verified_accounts(provider_account_id, account_id=account_id, is_selected=is_selected, verification_status=verification_status)
pprint(api_response)
except ApiException as e:
print("Exception when calling VerificationApi->get_verified_accounts: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| provider_account_id | str | providerAccountId. | |
| account_id | str | Comma separated accountIds. | [optional] |
| is_selected | str | Comma separated isSelected. Allowed values are true, false <br><b>Note:</b> If no value is passed, the implicit default value is true. | [optional] |
| verification_status | str | Comma separated verificationStatus. Allowed values are SUCCESS, FAILED <br><b>Note:</b> If no value is passed, the implicit default value is SUCCESS. | [optional] |
No authorization required
- Content-Type: Not defined
- Accept: application/json;charset=UTF-8
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Y813 : providerAccountId should be provided<br>Y800 : Invalid value for providerAccountId<br>Y800 : Invalid value for verificationStatus<br>Y800 : Invalid value for isSelected<br>Y800 : Invalid value for accountId<br>Y807 : Resource not found<br>Y871 : The verification process for the request is still in progress. This API can only be invoked after the verification process is completed<br>Y824 : The maximum number of accountIds permitted is 10 | - |
| 401 | Unauthorized | - |
| 404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VerificationResponse initiate_matching_or_challenge_deposite_verification(verification_param)
Initiaite Challenge Deposit
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 MS verification process, a string-match of the account holder name with the registered user name is performed instantaneously. You can contact the Yodlee CustomerCare to configure the full name or only the last name match.
Once the CDV process is initiated Yodlee will post the microtransaction (i.e., credit and debit) in the user's account. The CDV process takes 2 to 3 days to complete as it requires the user to provide the microtransaction details.
The CDV process is currently supported only in the United States.
The verificationId in the response can be used to track the verification request.
Notes:
from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
# Create an instance of the API class
api_instance = yodlee.VerificationApi(api_client)
verification_param = yodlee.VerificationRequest() # VerificationRequest | verification information
try:
# Initiaite Challenge Deposit
api_response = api_instance.initiate_matching_or_challenge_deposite_verification(verification_param)
pprint(api_response)
except ApiException as e:
print("Exception when calling VerificationApi->initiate_matching_or_challenge_deposite_verification: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| verification_param | VerificationRequest | verification information |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Y901 : Service not supported<br>Y812 : Required field/value - verification.verificationType missing in the verificationParam<br>Y812 : Required field/value - accountNumber missing in the verificationParam<br>Y812 : Required field/value - accountType missing in the verificationParam<br>Y812 : Required field/value - bankTransferCode missing in the verificationParam<br>Y812 : Required field/value - bankTransferCode.id missing in the verificationParam<br>Y812 : Required field/value - bankTransferCode.type missing in the verificationParam<br>Y800 : Invalid value for verification.verificationType<br>Y800 : Invalid value for verificationParam<br>Y800 : Invalid value for bankTransferCode.type<br>Y800 : Invalid value for bankTransferCode.id<br>Y800 : Invalid value for accountType<br>Y800 : Invalid value for accountId<br>Y813 : Account details should be provided<br>Y801 : Invalid length for accountNumber<br>Y835 : Account(s) not eligible for Challenge Deposit verification<br>Y806 : Invalid Input<br>Y840 : Verification has been initiated already<br>Y837 : Account has been verified already<br>Y800 : Invalid value for userClassification | - |
| 401 | Unauthorized | - |
| 404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VerificationResponse verify_challenge_deposit(verification_param)
Verify Challenge Deposit
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:
- This endpoint cannot be used to test the CDV functionality in the developer sandbox or test environment. You will need a money transmitter license to implement the CDV functionality and also require the Yodlee Professional Services team's assistance to set up a dedicated environment.
from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
# Create an instance of the API class
api_instance = yodlee.VerificationApi(api_client)
verification_param = yodlee.UpdateVerificationRequest() # UpdateVerificationRequest | verification information
try:
# Verify Challenge Deposit
api_response = api_instance.verify_challenge_deposit(verification_param)
pprint(api_response)
except ApiException as e:
print("Exception when calling VerificationApi->verify_challenge_deposit: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| verification_param | UpdateVerificationRequest | verification information |
No authorization required
- Content-Type: application/json
- Accept: application/json;charset=UTF-8
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Y901 : Service not supported<br>Y812 : Required field/value - verification.verificationType missing in the verificationParam<br>Y812 : Required field/value - amount.amount missing in the verificationParam<br>Y812 : Required field/value - baseType missing in the verificationParam<br>Y812 : Required field/value - currency missing in the verificationParam<br>Y812 : Required field/value - providerAccountId missing in the verificationParam<br>Y812 : Required field/value - accountId missing in the verificationParam<br>Y800 : Invalid value for verificationParam<br>Y800 : Invalid value for verification.verificationType<br>Y800 : Invalid value for baseType<br>Y800 : Invalid value for providerAccountId<br>Y800 : Invalid value for accountId<br>Y813 : Transaction should be provided<br>Y801 : Invalid length for accountNumber<br>Y801 : Invalid length for amount<br>Y835 : Account(s) not eligible for Challenge Deposit verification<br>Y806 : Invalid Input<br>Y840 : Verification has been initiated already<br>Y837 : Account has been verified already<br>Y838 : The currency code provided does not match with the currency of the transaction executed on the target account<br>Y846 : The number of financial transactions made on the target account does not match with the number of transactions entered by the user.<br>Y842 : Number of retries exceeded the maximum Challenge Deposit verification limit<br>Y844 : Financial Instructions were not executed successfully on the target account<br>Y845 : Verification time expired. Please try initiating challenge deposit again<br>Y868 : No action is allowed, as the data is being migrated to the Open Banking provider<br> | - |
| 401 | Unauthorized | - |
| 404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]