com.yodlee.api.model.enums.VerificationRequestFailedReason Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yodlee-api-model-beta Show documentation
Yodlee API Model Beta is the stage version
There is a newer version: 1.0.29.beta1
Show newest version
/**
 * Copyright (c) 2019 Yodlee, Inc. All Rights Reserved.
 *
 * Licensed under the MIT License. See LICENSE file in the project root for license information.
 */
package com.yodlee.api.model.enums;

public enum VerificationRequestFailedReason {
	/**
	 * Description: The account is locked at the provider site. The user has exceeded the maximum number of
	 * incorrect login attempts resulting in the account getting locked. 

	 * Next Action: Instruct the user to visit the provider site and take necessary actions to unlock the account
	 */
	ACCOUNT_LOCKED,
	//
	//
	/**
	 * 
	 * Description:  

	 * Next Action: 
	 */
	ADDL_AUTHENTICATION_REQUIRED, //
	//
	//
	/**
	 * Description: Unable to log in to the provider site due to out-dated credentials. The site may be prompting
	 * the user to change or verify the credentials. 

	 * Next Action: Instruct the user to visit the provider site and perform the required actions, and invoke the
	 * edit account flow to update the credentials in the Yodlee system
	 */
	CREDENTIALS_UPDATE_NEEDED,
	//
	//
	/**
	 * 
	 * Description: Unable to log in to the provider site due to incorrect credentials. The credentials that the
	 * user has provided are incorrect. 

	 * Next Action: Instruct the user to provide the correct credentials by invoking the edit account flow.
	 */
	INCORRECT_CREDENTIALS, //
	//
	//
	/**
	 * 
	 * Description: The user has provided incorrect MFA information or the MFA information provided has expired.
	 * 

	 * Next Action: Instruct the user to provide the correct MFA information
	 */
	INVALID_ADDL_INFO_PROVIDED,
	//
	//
	/**
	 * 
	 * Description: The request has timed-out due to technical reasons. 

	 * Next Action: Instruct the user to try again later. If the request fails repeatedly, report the issue to
	 * the customer service team
	 */
	REQUEST_TIME_OUT,
	//
	//
	/**
	 * 
	 * Description: The Yodlee IP is blocked by the provider site. 

	 * Next Action: Instruct the user to try again later. If the request fails repeatedly, report the issue to
	 * the customer service team
	 */
	SITE_BLOCKING_ERROR,
	//
	//
	/**
	 * 
	 * Description: All error indicating issues at the provider site, such as the site is down for maintenance.
	 * 

	 * Next Action: Instruct the user to try again later. If the request fails repeatedly, report the issue to
	 * the customer service team
	 */
	UNEXPECTED_SITE_ERROR,
	//
	//
	/**
	 * 
	 * Description: Indicates that the site does not support the requested data or support is not available to
	 * complete the requested action. For example, site not available, document download not supported at the site, etc.
	 * 

	 * Next Action: Inform the user about the latest available status
	 */
	SITE_NOT_SUPPORTED,
	//
	//
	/**
	 * 
	 * Description: The provider site is unavailable due to issues such as the site is down for maintenance. 

	 * 

	 * Next Action: Instruct the user to try again later. If the request fails repeatedly, report the issue to
	 * the customer service team
	 */
	SITE_UNAVAILABLE,
	//
	//
	/**
	 * 
	 * Description: Indicates there is a technical error. 

	 * Next Action:  Instruct the user to try again later. If the request fails repeatedly, report the issue to
	 * the customer service team.

	 */
	TECH_ERROR, //
	/**
	 * Description: The errors that require users to take action at the provider site, for example, accept T{@literal &}C,
	 * etc. 

	 * Next Action: Instruct the user to visit the provider site and perform the necessary action
	 */
	USER_ACTION_NEEDED_AT_SITE,
	//
	//
	/**
	 * 
	 * Description: Indicates if multiple sessions or a session is terminated by the provider site. 

	 * Next Action: Instruct the user to try again later
	 */
	SITE_SESSION_INVALIDATED,
	//
	//
	/**
	 * 
	 * Description: The site has requested for OAuth authentication.

	 * Next Action: The OAUTH based authentication sites can be added or updated only using Yodlee FastLink and
	 * not Yodlee APIs. Instruct the user to add the account using FastLink
	 */
	NEW_AUTHENTICATION_REQUIRED,
	//
	//
	/**
	 * 
	 * Description: The user has to provide consent to access the account information through Open Banking.

	 * Next Action: Instruct the user to provide the consent through the edit account flow.
	 */
	CONSENT_REQUIRED,
	//
	//
	/**
	 * 
	 * Description: The consent provided by the user to access the account information through Open Banking has expired.

	 * Next Action: Instruct the user to provide the consent through the edit account flow.
	 */
	CONSENT_EXPIRED,
	//
	//
	/**
	 * 
	 * Description: The user has revoked the consent to access the account information through Open Banking.

	 * Next Action: Instruct the user to provide the consent through the add account flow.
	 */
	CONSENT_REVOKED,
	//
	//
	/**
	 * 
	 * Description: Failed to log in to the Open Banking provider site due to incorrect token.

	 * Next Action: Instruct the user to provide the consent through the edit account flow.
	 */
	INCORRECT_OAUTH_TOKEN,
	//
	//
	/**
	 * Description: Required data is not available.

	 * Next Action: No action is required as it is an end state.
	 */
	REQUIRED_DATA_NOT_AVAILABLE,
	//
	//
	/**
	 * Description: Matching failed.

	 * Next Action: No action is required as it is an end state.
	 */
	MATCHING_FAILED,
	//
	//
	/**
	 * Description: No eligible accounts for given configuration.

	 * Next Action: No action is required as it is an end state.
	 */
	NO_ELIGIBLE_ACCOUNTS,
	//
	//
	/**
	 * Description: Additional MFA information required from the user.
	 * 

	 * Next Action: Instruct the user to provide the MFA information
	 */
	USER_INPUT_REQUIRED
}