Item resource

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

FieldDescription
id
long
Item's unique identifier
status
integer
Item status codes are detailed below
status_code_info
string
Detailed on the Items status page
status_code_description
string
Detailed on the Items status page
bank_id
long
Bank's unique identifier

LIST OF ITEM STATUS CODES

StatusCodeDescription
ok0Everything is awesome.
just_added-2The account was recently added. The account refresh is pending.
just_edited-3The account's credentials were recently changed. The account refresh is pending.
login_failed402Wrong credentials.
needs_human_action429An action from the user is required within the online banking of the user.

Examples:
The user needs to accept new ToS, change his credentials, first time connecting to the bank's website, ...
could_not_refresh1003Couldn't refresh. Try again.
not_supported1005Account not supported.
disabled_temporarily1007Refresh temporarily disabled.
incomplete1009Account balance has changed but no new transactions were found.
This may happen with stock / life insurance accounts.
needs_manual_refresh1010Item wasn't refreshed successfully, it required an MFA / OTP that wasn't provided.
migration1099Item is migrating to another bank.
pro_account_locked1100Pro accounts have been detected on this Item and it needs validation. Otherwise the data will be obfuscated. Please check our guide for more detail.
Example item resource
{
  "id": 187741,
  "resource_uri": "/v2/items/187741",
  "resource_type": "item",
  "status": 1003,
  "status_code_info": "BANK_IS_DOWN",
  "status_code_description": "Your bank's interface is down for now.",
  "bank": {
    "id": 408,
    "resource_uri": "/v2/banks/408",
    "resource_type": "bank"
  },
  "accounts": [
    {
      "id": 2341488,
      "resource_uri": "/v2/accounts/2341488",
      "resource_type": "account"
    }
  ],
}