Error Documentation

API Implementation Errors

Yodlee API implementation errors are returned in JSON format. Here is the sample error response:

{ 
    "errorCode": "Y804", 
    "errorMessage": "Permitted values of top between 1 - 500", 
    "referenceCode": "u1455707934756c4F23u" 
}

Attribute	Description
errorCode	The error code follows the format YNNN. The error codes do not change. New error codes may be added as we introduce new features and enhance functionalities.
errorMessage	The descriptive message that explains the error scenario.
referenceCode	Unique Yodlee identifier used to troubleshoot issues at Yodlee’s end.

Authentication Errors

Following authentication errors occur while accessing the API services.

HTTP Status Code	Error Code	Error Message	Cause and Action
401	Y001	loginName and password required	You have not provided the login name or password to the cobrand (customer) login or user login services. Provide the valid login name and password.
401	Y002	Invalid loginName/password	You have provided an incorrect login name or password to the cobrand (customer) or user login services. Provide the valid login name and password.
401	Y003	Account is locked, contact Yodlee Customer Service	You have exceeded the allowed number of login attempts by passing an incorrect password seven consecutive times. The account is now locked. Your trial period of using Yodlee API services in the developer portal environment has ended. Contact Yodlee Customer Service.
401	Y005	Suspended user	The login name provided is for a suspended user. Contact Yodlee Customer Service.
401	Y006	Unregistered user	You have provided a user session for a user who has been unregistered from the system.
401	Y007	Authorization header missing	You must provide the required authorization header parameter while invoking the API services. Refer to the authorization parameter recommendations.
401	Y008	Invalid token in authorization header	Regenerate the admin access/user access token as the token you have provided is invalid or has expired. OR The cobSession/userSession you provided is invalid or expired. Regenerate the session token from login services.
401	Y009	Session tokens missing	You must provide the required authorization header parameter while invoking the API services. Refer to the authorization parameter recommendations.
401	Y010	Invalid session	The cobSession you provided does not belong to the cobrand (customer).
401	Y011	Invalid cobrand (customer) or incorrectly configured cobrand	Invalid configurations. Examples: PKI is not configured properly, vendor configurations are incorrect for asset classification data. Contact Yodlee Customer Service for details.
401	Y012	User session should not be passed	You have provided userSession to an API service that accepts only cobrandSession. Refer to the authorization parameter recommendations.
401	Y013	Fields should be passed as body parameters	You have provided the required fields to an API service as query parameters. Make sure that you pass them as body parameters
401	Y014	Cobrand configuration missing	The required configurations seem to be missing in the backend. Contact Yodlee Customer Service.
401	Y015	Unauthorized User	This user is not authorized to access this endpoint
401	Y016	{0} header missing	The endpoint cannot respond without the required header.
401	Y017	Your account is locked, contact Yodlee Customer Care	Your account is locked, contact Yodlee Customer Services.
401	Y018	Your trial/contract has expired; contact Yodlee Customer Care	Your trial period to use the Yodlee APIs in the developer portal environment has ended. Contact Yodlee Customer Services.
401	Y019	Issuer is either locked or deleted	You have provided an issuer or API key that is either locked or deleted.
401	Y020	Invalid token in Authorization header	The Authorization token is invalid. Create a new valid Access Token.
401	Y021	Maximum duration of token cannot be greater than {0} seconds	Yodlee sets the maximum duration of the token’s validity. The token’s expiry time minus the current time cannot be greater than the cobrand’s maximum token validity duration.
401	Y022	Configuration missing	The required configurations for this API endpoint are missing. Contact Yodlee Customer Services.
401	Y023	Token has expired	The Authorization token has expired. Create a fresh valid access token.
401	Y024	This API service is not relevant to be invoked for API Key based authentication	Invoking this API endpoint is not relevant for the API key-based authentication. If you are receiving this error, contact Yodlee Customer Service.
401	Y025	Invalid token. This endpoint does not accept a user-specific token. Provide a token without any user identifier	This cobrand-level API endpoint does not accept any user-specific tokens. Regenerate the token without passing any user identifier.
401	Y300	Invalid token	Regenerate the admin access/user access token as the token you have provided is invalid or has expired.
401	Y304	clientId and secret is locked. Contact Yodlee Customer Services.	Your account is locked, contact Yodlee Client Services.
401	Y308	User registration service only works with admin token	You have provided the user access token to an API service that accepts only the admin access token.

Top

Validation Errors

Following validation errors occur while accessing the API services.

HTTP Status Code	Error Code	Error Message	Cause and Action
400	Y301	Invalid clientId or secret	The client credentials you provided is invalid.
400	Y302	Missing header parameter {0},{1},{2},{3}	You are missing a required parameter. Review the API implementation notes to find the correct value.
400	Y303	clientId or secret is missing	You are missing a required parameter. Review the API implementation notes to find the correct value.
400	Y309	User already exists as an admin user, try registering user with different name	You have provided loginName that already exists as an admin user, try using a different name.
400	Y800	Invalid value for {0}	Review the parameter values passed. The parameter you provided is invalid. Reasons could be incorrect data type, deleted data, etc. Examples: Invalid value for status Invalid value for container Invalid value for loginName
400	Y801	Invalid length for {0}	The length of a parameter provided is not as expected. Review the API implementation notes to find the correct value. Example: Invalid length for description; min 3 and max 200 characters are allowed.
400	Y802	{0} not allowed	The parameter/value you provided is not allowed. Review the API implementation notes to find the correct value. Examples: categoryParam not allowed, future fromDate not allowed.
400	Y803	{0} required {1}	You are missing a required parameter. Review the API implementation notes to find the correct value.
400	Y804	Permitted values of {0} between {1} - {2}	The parameter value you provided is not in the acceptable range. Review the API implementation notes to find the correct value. Example: Permitted values are between 1 - 500.
400	Y805	Multiple {0} not supported	You can only provide a single value for this parameter. Review the API implementation notes to find the correct value.
400	Y806	Invalid Input	You have provided an invalid parameter name or JSON. Review the API implementation notes to find the correct value.
400	Y807	Resource not found	You have provided a resource value that does not exist in the system. Please check the URI you submitted for errors or invalid values. If the URI is correct, this may be a premium resource to which you need to subscribe. Ensure that you have previously authorized access to the resource through Yodlee Client Services.
400	Y808	Your password doesn't meet required criteria	The password you have provided to register or update credential services does not meet the required criteria. Ensure that the password value adheres to the eligibility criteria.
400	Y809	Invalid date range	The date range you have provided is invalid. Make sure the To date is greater than the From date and the range passed is within the acceptable limits.
400	Y810	{0} should not be same as {1}	You have passed the same values to at least two API input parameters. Examples: The new password should not be the same as the old password High Level categoryName should not be the same as categoryName
400	Y811	{0} value already exists	You have provided a parameter value that already exists. Ask the user to correct the value.
400	Y812	Required field/value - {0} missing in the {1}	One of the mandatory parameter values is missing. Review the API implementation notes to find the correct value.
400	Y813	{0} should be provided	The request you made cannot be executed because the required information is missing from the request. Example: Either category or categoryId should be provided.
400	Y814	Exchange rate not available for currency	The exchange rate for the user's preferred currency is not available. Contact Yodlee Customer Service for details.
400	Y815	Cannot apply filter on {0} if {1}	The combination of query parameters you have provided is in error. Review the API implementation notes to find the correct values. Examples: Cannot apply filter on assetClassification. classificationType if assetClassification is not requested.
400	Y816	{0} can only be requested for {1}	The request you made is not applicable or relevant for a specific resource. Example: Credentials can only be requested for aggregated accounts.
400	Y817	Invalid JSON for {}	You have provided an invalid JSON as an input. Verify the JSON format and the field names. Example: Invalid JSON for transactionParam.
400	Y819	{0} cannot be updated	The parameter or resource you are trying to update is not supported for updates or cannot be updated. Examples: accountType cannot be updated account cannot be updated for this provider.
400	Y820	The {0} is not supported for {1} Note: 820 and 821 are similar type of errors with a slight variation in the error message.	The combination of request parameters you have provided are not supported. Examples: The Type filter is not supported for insurance accountType while retrieving transaction The accountReconType field is not supported for container other than investment isAsset field is not supported for loan/card account type dueDate/frequency is not supported for bank/investment/otherAssets/otherLiabilities.
400	Y821	{0} not supported Note: 820 and 821 are similar type of errors with a slight variation in the error message.	The data you requested is not currently enabled.
400	Y822	{0} cannot be requested for {1}	You have requested a piece of information that is not allowed. Example: Credential cannot be requested for a shared providerAccount
400	Y823	{0} not applicable {1}	You have requested a piece of information that is not relevant. Examples: Credentials are not applicable for real estate accounts Transaction are not applicable for reward
400	Y824	The maximum number of {0} permitted is {1}	You have provided data that is more than the permitted length. Example: The maximum number of accountIds permitted is 100. The maximum number of categoryIds permitted is 100
400	Y825	Update not allowed {0}	You have performed an operation that is not allowed. Examples: Update not allowed - Data Retrieval in Progress Update not allowed - Reason: REFRESHED_RECENTLY
400	Y826	Query parameter(s) {0} have been deprecated; support for them is only available through body parameters	You have provided the deprecated query input parameter. Make sure that you pass the relevant body parameters.
400	Y827	{0} has been reached. Please try later	The action you have performed has reached the threshold that is allowed for the day. Example: The maximum threshold for the day has been reached. Please try later
400	Y828	The provider has not yet requested the MFA information	You have provided the MFA details for an add/update account process that has not yet requested the information.
400	Y830	{0} has to be enabled {1}	The information that you are requesting cannot be provided, as the required dataset/feature is not enabled. Contact Yodlee Customer Services
400	Y831	Account already {0} for EBILL	You are trying to enroll or unroll EBILL for an ineligible account. Examples: Account already enrolled for EBILL Account already unenrolled for EBILL
400	Y832	Invalid syntax for {0}	The syntax you have provided for the input filter is invalid. Example: Invalid value(s) ACCT_PROFILES for dataset$filter
400	Y833	Invalid value(s) {0} for {1}	You have provided an invalid value for a filter. Example: Invalid syntax for dataset$filter
400	Y847	{0} cannot be requested, as {1} not enabled	You cannot request a feature-related attribute if the feature is not enabled. Example: isAssetTransferEligible cannot be requested, as SN 2.0 or asset transfer feature is not enabled
400	Y848	{0} cannot be provided as input, as the {1} feature is not enabled	You cannot update the attribute because the feature is not enabled. Example: DetailedCategoryId cannot be provided as input, as the detailed category feature is not enabled
400	Y850	Container: {0} are inactive. The accounts linked to them were deleted. Add the accounts again to reactivate them.	You have deleted all available accounts under the container. Add the provider account again to restore them to the system. Example: Container: loan and investment are inactive. The accounts linked to them were deleted. Add the accounts again to reactivate them.
400	Y852	Duplicate {0} cannot be passed in the input.	You cannot pass duplicate attributes in the input. Example: Duplicate ids cannot be passed in the input.
400	Y853	{0} parameters cannot be passed simultaneously.	You cannot simultaneously pass similar parameters as input. Pass one parameter at a time while invoking the API. Example: dataset and datasetNames cannot be passed simultaneously.
400	Y854	The number of account additions have reached the maximum limit. Contact Yodlee Customer Services.	You have exceeded the permissible number of accounts; no more can be added.
400	Y866	As the user edits the credentials, the initiatingSource value cannot be SYSTEM while submitting the user-edited credentials.	You have provided incorrect value of initiatingSource as SYSTEM while submitting edit-credentials. Make sure you pass the relevant parameter as the user has edited the credentials.
400	Y867	As the user initiates the MFA refresh, the initiatingSource value cannot be SYSTEM while submitting the MFA information	You have provided incorrect value of initiatingSource as SYSTEM while submitting the MFA information. Make sure you pass the relevant parameter as the user initiates the refresh and provides the MFA information.
400	Y872	Maximum threshold to perform challenge deposit verification has been reached. No additional account verification is allowed.	The number of challenge deposit verification (CDV) a consumer is allowed to perform in a lifetime is restricted to a certain threshold. Once that threshold has reached this error is shown.

Top

Y400 Generic Error

Y400 is a generic error code that gets thrown for few functional or syntax validations that may occur while invoking the API services. If you facing this error and do not get the reason why the error is thrown, please contact Customer Services.

HTTP Status Code	Error Code	Error Message	Cause and Action
400	Y400	{0}	You have not invoked the API service per our recommendations and implementation notes.
400	Y400	Credentials have to be encrypted	The PKI feature requires that you enter encrypted credentials and answers.
400	Y400	Accessibility denied	The API you called is not available in a sandbox environment. Example: You may be trying to register a new user on the developer portal environment.

Top

Service Errors

Y9NN series errors are service level errors.

HTTP Status Code	Error Code	Error Message	Cause and Action
400	Y901	Service not supported	The service you requested isn't available to you. Contact Yodlee Customer Services for details.
500	Y902	Oops some issue at our end	We're having technical difficulties connecting. Contact Yodlee Customer Services for details.
500	Y903	Connection unavailable	We're having technical difficulties connecting. Contact Yodlee Customer Services for details.
500	Y904	Internal exception	We're having technical difficulties. Contact Yodlee Customer Services for details.

Top

Y013 SAML Error

Y013 error will be thrown by SAMLRegister and SAMLLogin services. A sub error code gets additionally returned for this error code. Sub error code has a unique error message associated with it.

HTTP Status Code	Error Code	Sub Error Code	Error Message
401	Y013	001	Initiation failed
401	Y013	002	Encoding failed
401	Y013	003	Decoding failed
401	Y013	004	Invalid SAML configuration
401	Y013	005	Invalid issuer
401	Y013	006	Invalid source
401	Y013	007	Invalid source id for issuer
401	Y013	008	Invalid artifact
401	Y013	009	Invalid request
401	Y013	010	Invalid IssueInstant
401	Y013	011	Expired IssueInstant
401	Y013	012	IssueInstant is in future
401	Y013	013	Invalid response
401	Y013	014	Mismatched source
401	Y013	015	Invalid source for issuer
401	Y013	016	Invalid profile
401	Y013	017	Invalid assertion
401	Y013	018	Invalid assertion - NotBefore in future
401	Y013	019	Invalid assertion - NotAfter in past
401	Y013	020	Invalid statement AuthenticationInstant
401	Y013	021	Artifact generation failure
401	Y013	022	Artifact decoding failure
401	Y013	023	Invalid assertion length
401	Y013	024	Invalid assertion id
401	Y013	025	Duplicate assertion id
401	Y013	026	External exception
401	Y013	027	Source id generation failure
401	Y013	028	Request generation failure
401	Y013	029	Request generation XML failure
401	Y013	030	Request generation signature failure
401	Y013	031	Request verification signature failure
401	Y013	031	Response generation failure
401	Y013	032	Response generation failure - invalid SAML request
401	Y013	033	Response generation - XML failure
401	Y013	034	Response generation - invalid recipient
401	Y013	035	Response generation failure - invalid issuer
401	Y013	036	Response generation failure - invalid source id
401	Y013	037	Response generation - signature failure
401	Y013	038	Response generation failure - invalid SAML response info
401	Y013	039	Response generation failure - invalid subject
401	Y013	040	Response generation failure - invalid lifetime
401	Y013	041	Response generation failure - invalid artifact
401	Y013	042	Response generation failure - invalid assertion
401	Y013	043	Response generation failure - implementation library failure
401	Y013	044	Response generation failure - invalid source
401	Y013	045	Response generation encryption failure
401	Y013	046	Response verification xml failure
401	Y013	047	Response verification failure - invalid assertion
401	Y013	048	Response verification failure - invalid subject
401	Y013	049	Response verification failure - invalid statement
401	Y013	050	Response verification failure - invalid statement
401	Y013	051	Response verification failure - invalid certificates
401	Y013	052	Response verification failure - invalid SAML response
401	Y013	053	Response verification failure - decryption failure
401	Y013	054	Response verification failure - assertion verification failure, invalid certificates
401	Y013	055	Response verification failure - assertion verification failure, invalid assertion id
401	Y013	056	Response verification failure - invalid issuer
401	Y013	057	Response verification failure - invalid source
401	Y013	058	Response verification failure - implementation library failure
401	Y013	059	Response restore failure - invalid SAML response
401	Y013	060	Response restore failure - invalid assertion
401	Y013	061	Response restore failure - invalid issuer
401	Y013	062	Response restore failure - invalid source
401	Y013	063	Response restore failure - certificate retrieval failure
401	Y013	064	Response restore failure - invalid subject
401	Y013	065	Response restore failure - invalid statement
401	Y013	066	Response restore failure - invalid confirmation method
401	Y013	067	Response restore failure - implementation library failure
401	Y013	068	No signing key found
401	Y013	069	Invalid subject confirmation
401	Y013	070	Invalid authentication statement instant
401	Y013	071	Response verification failure - invalid attributes encoding
401	Y013	072	Response verification failure - invalid assertion format
401	Y013	073	Response verification failure - assertion decryption
401	Y013	074	Response verification failure - invalid attributes format
401	Y013	075	Null SAML response
401	Y013	076	Failed to parse SAML XML response
401	Y013	078	Failed to restore SAML response
401	Y013	079	SAML internal system error
401	Y013	080	Invalid username
401	Y013	081	Null user credentials
401	Y013	082	SSO is not enabled or initialized
401	Y013	083	Null SAML credentials
401	Y013	084	Unknown Issuer ID null in SAML Credentials
401	Y013	085	Null issuer ID
401	Y013	086	Invalid issuer ID
401	Y013	087	Invalid SAML response type
401	Y013	088	Could not locate a valid Source for issuer
401	Y013	089	User not registered :
401	Y013	090	The account for user is locked
401	Y013	091	Max user count
401	Y013	092	Invalid group name groupName
401	Y013	093	User Name already exists
401	Y013	094	userCredentials
401	Y013	095	samlResponse required
401	Y013	096	Issuer required
401	Y013	097	Source required
401	Y013	098	Failed to parse XmlStringElement type
401	Y013	099	Failed to parse XmlStringContent is not allowed in prolog
401	Y013	100	Failed to parse XmlStringXML document structures must start and end within the same entity
401	Y013	101	Failed to parse XmlStringA pseudo attribute name is expected
401	Y013	102	Failed to parse XmlStringContent is not allowed in prolog
401	Y013	103	Could not locate a valid source
401	Y013	104	Failed to parse XmlStringThe encoding declaration is required in the text declaration
401	Y013	105	User does not have any associated Issuer

Top

Add/Update Account Errors

Technical or user input errors faced during add or update provider accounts are not API implementation errors. Hence these errors are denoted with status and additionalStatus attributes provided in the POST /providerAccounts, PUT /providerAccounts and GET /providerAccounts provider account services response.

Learn more about different statuses, additional statuses, and failure reasons from the provider account data model page.