Error Codes Returned by APIs for Managing Accounts and User Factors
The following topics list the error codes that are returned by the APIs for managing accounts and user factors:
cairis2012saas
The following topics list the error codes that are returned by the APIs for managing accounts and user factors:
These error codes are returned along with HTTP status 400. If you encounter any other error, please send the request again after some time.
Error Codes for Token API and Account Management APIs
Error Code | Error Description | Token API | Add Account API | Linked Accounts API | Add Link API | Delete Link API | Delete Account API |
|---|---|---|---|---|---|---|---|
account_not_found | account does not exist | - | - | Yes | Yes | Yes | Yes |
contact_not_found | contact_id [ <contact_id> ] does not exist | - | - | - | - | - | - |
device_not_found | contact_id <contact_id> does not exist | - | - | - | - | - | - |
default_factor_cannot_be_deleted | Default factor cannot be deleted | - | - | - | - | - | - |
card_not_found | card_number [<card_number>] does not exist | - | - | - | Yes | - | - |
account_exists | account_id already exists | - | Yes | - | - | - | - |
tenant_not_found | tenant_id does not exist | - | Yes | Yes | - | - | Yes |
multiple_accounts_found | account_id found for more than one name | - | - | Yes | Yes | Yes | Yes |
is_default_enabled_for_more_than_one_factor | is_default is set to true for more than one %s | - | Yes | - | - | - | - |
link_already_exists | Cardnumber (<card_number>) is linked with another account | - | - | - | Yes | - | - |
unauthorized_access | Invalid credentials Explanation: The credentials of the administrator account sent in the Token API payload were incorrect. | Yes | - | - | - | - | - |
user_not_authorized | User is not authorized Explanation: The administrator account for which the token has been generated is not authorized to perform this operation. | - | Yes | Yes | Yes | Yes | Yes |
auth_token_verify_failed | Authorization token verification has failed Explanation: The JWT token sent as the value of the Authorization header is invalid. | - | Yes | Yes | Yes | - | Yes |
auth_token_expired | Authorization token has expired | - | Yes | Yes | Yes | Yes | Yes |
missing_input | Value for element {<element_name>} is required | Yes | Yes | Yes | Yes | Yes | Yes |
missing_input | At least one factor must be specified | - | - | - | - | - | - |
missing_input | device_tokens is required for 3DSECURE channel | - | - | - | - | - | - |
missing_input | Value for Header {<header_name>} is required | - | - | - | Yes | - | Yes |
invalid_input | only device_token is allowed in 3DSECURE channel type request | - | - | - | - | - | - |
invalid_input | invalid factor type | - | - | - | - | - | - |
invalid_input | invalid channel_type; 3DSECURE/BANKING are the only allowed channelType | - | - | Yes | - | - | - |
invalid_input | The account_type parameter can accept only one of these values: {enum-value-1}, {enum-value-2}, {enum-value-3} | - | Yes | - | Yes | - | Yes |
invalid_input | account_type | - | Yes | Yes | - | Yes | |
missing_input | Value for element <element_name> for account is required | - | Yes | Yes | - | Yes | |
invalid_input | client_txn_id has exceeded max allowed length i.e 36 | Yes | Yes | Yes | Yes | -Yes | Yes |
invalid_input | account_id length not matching length criteria min :<minlimit> max:<maxlimit> | - | Yes | - | Yes | ||
invalid_input | account_id invalid | - | Yes | Yes | Yes | - | Yes |
invalid_input | An invalid value was sent for the account_type parameter | - | Yes | - | Yes | Yes | - |
invalid_token | Invalid Authorization Token Explanation: The JWT token sent as the value of the Authorization header is invalid. | - | Yes | Yes | Yes | Yes | Yes |
tenant_not_associated_with_portfolio_group | Tenant is not associated with this portfolio group | - | Yes | - | Yes | - | |
portfolio_groups_are_different | Accounts do not belong to the same portfolio group | - | - | - | Yes | Yes | - |
customer_ids_are_different | Accounts are linked to different customer IDs | - | - | - | Yes | Yes | - |
linking_not_enabled | Linking of accounts is not enabled for this portfolio group | - | Yes | - | Yes | - | |
customer_id_type_not_enabled | Customer ID type specified in the customer._type parameter is not enabled for this portfolio group | - | Yes | - | Yes | Yes | - |
portfolio_group_not_found | Portfolio group does not exist | - | Yes | - | Yes | - |
Error Codes for Factor Management APIs
Error Code | Error Description | Set Factors API | Get Factors API | Update Factors API | Delete Factors API |
|---|---|---|---|---|---|
account_not_found | account does not exist | Yes | Yes | Yes | Yes |
contact_not_found | contact_id [ <contact_id> ] does not exist | - | - | Yes | Yes |
device_not_found | contact_id <contact_id> does not exist | - | - | Yes | Yes |
default_factor_cannot_be_deleted | Default factor cannot be deleted | - | - | - | Yes |
tenant_not_found | tenant_id does not exist | Yes | Yes | Yes | Yes |
multiple_accounts_found | account_id found for more than one name | Yes | Yes | Yes | Yes |
is_default_enabled_for_more_than_one_factor | is_default is set to true for more than one %s | Yes | - | - | - |
unauthorized_access | Invalid credentials Explanation: The credentials of the administrator account sent in the Token API payload were incorrect. | - | - | - | - |
user_not_authorized | Token is invalid for this operation Explanation: The administrator account for which the token has been generated is not authorized to perform this operation. | Yes | Yes | Yes | Yes |
auth_token_verify_failed | Authorization token verification has failed Explanation: The JWT token sent as the value of the Authorization header is invalid. | Yes | Yes | Yes | Yes |
auth_token_expired | Authorization token has expired | Yes | Yes | Yes | Yes |
missing_input | Value for element {<element_name>} is required | Yes | Yes | Yes | Yes |
missing_input | At least one factor must be specified | - | - | - | Yes |
missing_input | device_tokens is required for 3DSECURE channel | - | - | - | Yes |
invalid_input | only device_token is allowed in 3DSECURE channel type request | - | Yes | - | - |
invalid_input | invalid factor type | - | Yes | - | - |
missing_input | Value for element [ <element_name> ] is required | Yes | Yes | Yes | Yes |
invalid_input | account_holder_name is not acceptable parameter for BANKING request | Yes | Yes | Yes | Yes |
missing_input | Specify a value for the value parameter under the <factor type> parameter | Yes | - | Yes | - |
invalid_input | The value parameter under the <factor type> parameter must be between 4 and 15 digits in length | Yes | - | Yes | - |
invalid_input | client_txn_id has exceeded max allowed length i.e 36 | Yes | Yes | Yes | Yes |
invalid_input | account_id length not matching length criteria min :<minlimit> max:<maxlimit> | Yes | Yes | Yes | Yes |
missing_input | Value for element {<element_name>} is required | Yes | - | - | Yes |
invalid_input | account_id invalid | Yes | Yes | Yes | Yes |
invalid_input | An invalid value was sent for the account_type parameter | Yes | Yes | Yes | Yes |
missing_input | Specify a value for the value parameter under the email_addresses parameter | Yes | - | Yes | - |
invalid_input | The value <email_address> in the email_addresses parameter is in an invalid format | Yes | - | Yes | - |
invalid_input | The value <email_address> in the email_addresses parameter is invalid. It must be between 6 and 255 characters in length | Yes | - | Yes | - |
missing_input | Specify a value for the value parameter under the device_tokens parameter | Yes | - | Yes | - |
invalid_input | The value <device_token_masked_value> in the device_tokens parameter is invalid. It must be between 8 and 255 characters in length | Yes | - | Yes | - |
missing_input | Specify a value for the device_nickname parameter under the device_tokens parameter | Yes | - | Yes | - |
invalid_input | The value <device_nickname_value> in the device_tokens parameter is invalid. It must be between 1 and 255 characters in length | Yes | - | Yes | - |
invalid_input | The value for 'is_default' can not be set to false for [<factor type>] | Yes | - | Yes | - |
missing_input | Value for element {_value} is required | - | - | - | - |
missing_input | Value for element {_type} is required | - | - | - | - |
missing_input | Value for element {factor_types} is required | - | Yes | - | - |
invalid_input | The only allowed channel is BANKING | Yes | Yes | Yes | Yes |
invalid_input | tenant_id is not present in the system | Yes | - | - | - |
missing_input | Specify a value for the Authorization header | Yes | Yes | Yes | Yes |
missing_input | Value for element {tenant_id} is required | Yes | Yes | Yes | Yes |
missing_input | Specify a value for at least one of the factors: mobile_numbers, home_phones, email_addresses, device_tokens | Yes | - | - | - |
missing_input | Specify a value for the factors parameter | - | - | - | Yes |
invalid_input | only device_tokens are allowed in 3DSECURE channel type request | Yes | - | - | - |
invalid_input | Duplicate contacts are not allowed for [<factor type>] | Yes | - | Yes | - |
missing_input | Specify a value for the <factor_type> parameter Note: This message is sent when contact_id in delete-factors is empty. | - | - | - | Yes |
invalid_input | The <factor_type> parameter must be between 1 and 36 characters in length Note: This message is sent when contact_id in delete-factors is of incorrect length. | - | - | - | Yes |
invalid_token | Invalid Authorization Token Explanation: The JWT token sent as the value of the Authorization header is invalid. | Yes | Yes | Yes | Yes |
max_limit_exceeded | Number of factors for an account {account_id} exceeds the maximum limit of 20 | Yes | - | - | Yes |
Changes in the Error Codes
There are no changes in the error codes after the previous release.