An item represents a connection to a bank account using a set of user credentials.
It contains one or more accounts which contain transactions.
Field | Description |
---|---|
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
Status | Code | Description |
---|---|---|
ok | 0 | Everything is awesome. |
just_added | -2 | The account was recently added. The account refresh is pending. |
just_edited | -3 | The account's credentials were recently changed. The account refresh is pending. |
login_failed | 402 | Wrong credentials. |
needs_human_action | 429 | An 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_refresh | 1003 | Couldn't refresh. Try again. |
not_supported | 1005 | Account not supported. |
disabled_temporarily | 1007 | Refresh temporarily disabled. |
incomplete | 1009 | Account balance has changed but no new transactions were found. This may happen with stock / life insurance accounts. |
needs_manual_refresh | 1010 | Item wasn't refreshed successfully, it required an MFA / OTP that wasn't provided. |
migration | 1099 | Item is migrating to another bank. |
pro_account_locked | 1100 | Pro 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"
}
],
}