Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-07-244223105.2 KB
Items

Get a single item

Retrieve the details of a single item

get/v3/aggregation/items/{id}

Path parameters

idnumber required
Example:9456432

Response

Item

idnumber required

Item's unique identifier

provider_idnumber required

Provider's unique identifier

status0 | -2 | -3 | 402 | 429 | 1003 | 1005 | 1007 | 1009 | 1010 | 1099 | 1100 required

Represents the overall state of the connection

status_code_infostring

Details the state of the connection

status_code_descriptionstring

Description used in the connect session to guide the user on what they need to do

account_types'payment' | 'all' required

Account types synchronized on an item. It impacts the available data and the user experience.

last_successful_refreshstring date-time

Timestamp recording when the item was last refreshed in success

last_try_refreshstring date-time

Timestamp recording when the item was last refreshed

created_atstring date-time

Timestamp recording when the item was created

authentication_expires_atstring date-time

Timestamp indicating when the Strong Customer Authentication (SCA) will expire (PSD2 accounts only = payment accounts)

Example response

{
  "id": 9513546,
  "provider_id": 574,
  "status": 1010,
  "status_code_info": "otp_required",
  "status_code_description": "Please fill in the strong customer authentication (SMS, notification, etc.) provided by your bank",
  "account_types": "payment",
  "last_successful_refresh": "2024-10-16T07:59:11.785Z",
  "last_try_refresh": "2024-10-16T09:10:15.455",
  "created_at": "2024-10-01T05:15:13.195Z",
  "authentication_expires_at": "2025-09-04T10:25:35Z"
}