v1
latestOpenAPI 3.1.02026-07-2478315484.9 KBGet Accounts
The Get Accounts endpoint retrieves a list of bank accounts that have been linked by a user via LinkSDK, identified by their entity_id.Each account object contains fields such as account_id, account status, currency, account_sub_type, account identifiers (such as IBAN, ACCOUNT_NUMBER, and NATIONAL_ID) and other data points related accounts. You can use the resulting account_ids to query additional financial data through other Lean APIs such as transactions, balances, beneficiaries, and other data APIs. A step by step guide here.
Query parameters
When true the API will return a results_id which can be fetched from the /data/v2/results endpoint when ready. Note: it's recommended to use the sync flow (async=false) for all requests by adapting the data workflow for connected entities.
The page you're requesting - returns page 0 of a response if not specified.
The number of objects you want to return as a page size.
The entity_id you're querying for, which is created by LinkSDK .connect() function.
Additional data you would like to store against the request. Example: {"foo": "val"}
Response
OK
Example response
{
"data": {
"accounts": [
{
"currency": "AED"
}
]
}
}