Get Open Banking Account Beneficiaries

Retrieves the beneficiaries for a bank account linked by a user via LinkSDK for the KSA Open Banking (SAMA) ecosystem. Each beneficiary object contains the beneficiary type, account holder name, creditor agent, and creditor account details. Requires ReadBeneficiariesBasic or ReadBeneficiariesDetail consent permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The Lean account identifier uniquely identifying the account within Lean.

Query Params
uuid

The entity_id of the connected customer.

uuid

The customer_id of the connected customer.

integer
≥ 0
Defaults to 0

The page you're requesting - returns page 0 of a response if not specified.

integer
1 to 100
Defaults to 50

The number of objects you want to return as a page size.

Headers
string

An RFC4122 UID used as a correlation id.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json