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.

Please request the rights to this file for full detail.

Status

StatusDescription
0Everything is awesome.
-2The item was recently added, and the item's refresh is in progress.
-3The credentials were recently updated, and the item's refresh is in progress.
402Wrong credentials were provided.
429An 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.
1003Couldn't refresh the item; please try again.
1005Account not supported.
1007Refreshing the item is temporarily disabled.
1009The account balance has changed, but no new transactions were found. This can happen with stock or life insurance accounts.
1010The item wasn't refreshed successfully because it required a Multi-Factor Authentication (MFA) or One-Time Password (OTP) that wasn't provided. Please see Strong Customer Authentication.
1099The item is being migrated to another bank.
1100Pro accounts have been detected on this Item and it needs validation. Otherwise the data will be obfuscated.

status_code_info and status_code_description

StatusStatus code info
402INVALID_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
429TOS_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
1003CNT_CRASH
LOGIN_CRASH
INVALID_CREDS
BANK_IS_DOWN
NO_ACCOUNT_FOUND
1005OTP_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
1010OTP_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": 187791,
  "status": 1010,
  "status_code_info": "OTP_REQUIRED",
  "status_code_description": "Please fill in the strong customer authentication (SMS, notification, etc.) provided by your bank",
  "bank_id": 408
}