Items statuses

An item represents a connection to a bank account using a set of user credentials. It can contain one or more accounts, each of which holds transactions.

The status of an item is described by three fields:

status
status_code_info
status_code_description

Example:

status -> "1010"
status_code_info -> "otp_required"
status_code_description -> "Please fill in the strong customer authentication (SMS, notification, etc.) provided by your bank"

If you need the status_code_description in French, add a header "Accept-Language" -> 'fr' in your request.

Status

Status	Description
0	Everything is awesome.
-2	The item was recently added, and the item's refresh is in progress.
-3	The credentials were recently updated, and the item's refresh is in progress.
402	Wrong credentials were provided.
429	An action from the user is required within the online banking of the user. This can occur when the user needs to accept new Terms of Service, change their credentials, or when it's their first time connecting to the bank's website.
1003	Couldn't refresh the item; please try again.
1005	Account not supported.
1007	Refreshing the item is temporarily disabled.
1009	The account balance has changed, but no new transactions were found. This can happen with stock or life insurance accounts.
1010	The item wasn't refreshed successfully because it required a Multi-Factor Authentication (MFA) or One-Time Password (OTP) that wasn't provided.
1099	The item is being migrated to another bank.

status_code_info and status_code_description

Status	Status code info
402	invalid_creds wrong_id wrong_id_format wrong_pwd wrong_pwd_format wrong_pwd2 wrong_pwd2_format account_temporarily_blocked account_blocked account_blocked_contact_bank
429	tos_to_validate contract_to_sign inactive_creds account_to_activate phone_nb_to_confirm information_to_review smth_to_validate otp_registration_to_do kyc_to_fill amlcft_data_to_confirm phone_nb_to_set perso_data_to_confirm form_to_fill readonly_access_to_create cannot_access_services no_online_access creds_update_message unlock_otp_in_app unlock_otp_in_web contact_bank expired_id_contact_bank no_access_contact_bank inactive_creds_contact_bank pwd_renewal pwd_renewal_first_co pwd_renewal_readonly_access
1003	cnt_crash login_crash invalid_creds bank_is_down no_account_found
1005	otp_not_supported pro_not_supported part_in_pro_cnt wrong_country_or_area migration_to_new_bank no_access_to_account suspended_access closed_account no_online_access
1010	otp_required otp_failed wrong_otp expired_device invalid_phone_nb blocked_limit_reached blocked_sms_limit_reached otp_not_supported sca_required_webview

The status_code_description are the messages displayed to the users for each status_code_info detailed above.

Item resource example

{
      "id": 10173907,
      "status": 402,
      "status_code_info": "invalid_creds",
      "status_code_description": "The banks credentials you provided don't allow us to synchronize your accounts. Please edit them (check for any typo).",
      "provider_id": 14,
      "account_types": "all",
      "last_successful_refresh": "2024-11-25T10:42:06.387Z"
}