---
title: "Get Beneficiaries"
method: GET
path: "/data/v2/accounts/{account_id}/beneficiaries"
tags: ["Beneficiaries Raw Data"]
---

# Get Beneficiaries

`GET /data/v2/accounts/{account_id}/beneficiaries`

Get the beneficiaries for a specific account given an accountId. 
The accountId can be found by making a call to the /accounts endpoint.
The accountId can be found by making a call to the /accounts endpoint. 
Requires the following permissions: `beneficiaries`

## Path parameters

- `account_id` string, uuid, required

## Query parameters

- `async` boolean
- `page` integer
- `size` integer
- `entity_id` string, uuid
- `meta` string

## Response `200`

OK

- FetchBeneficiariesResultV2
  - `status` 'OK' | 'PENDING' | 'FAILED' | 'CONSENT_EXPIRED' | 'RECONNECT_REQUIRED' | 'PROCESSING_STARTED', required — The status of the request
  - `results_id` string, uuid, required — The unique identifier for the request
  - `message` string, required — A message describing the status of the request
  - `meta` object, nullable — Meta information about the request
  - `timestamp` string, date-time, required — The datetime of when the request was made
  - `status_detail` StatusDetail, nullable
    - `granular_status_code` string, nullable — Granular status code
    - `status_additional_info` string, nullable — Additional information about the status
  - `refreshed_at` string, date-time, nullable — The datetime of when the data was refreshed
  - `type` string, nullable — The endpoint the original request was made to.
  - `data` BeneficiariesData
    - `beneficiaries` Beneficiary[] — An array of beneficiaries associated with the account.
      - `account_id` string — Unique identifier for the account
      - `account_holder_name` string — Full name of the account holder
      - `account_holder_short_name` string — Short form of the name of the account holder
      - `beneficiary_id` string — Unique identifier for the beneficiary
      - `beneficiary_type` 'TRUSTED' | 'ORDINARY' | 'OTHER' | 'UNSUPPORTED' — Type of beneficiary relationship
      - `creditor_agent` BeneficiaryCreditorAgent
        - `scheme_name` 'BICFI' | 'OTHER' | 'UNSUPPORTED' — Type of financial institution identification scheme
        - `identification` string — Unique identification of the servicing institution.
        - `name` string — Name of the agent or institution
        - `postal_address` OBPostalAddress
          - `address_line` string — Full address line
          - `address_type` 'BUSINESS' | 'CORRESPONDENCE' | 'DELIVERY_TO' | 'MAIL_TO' | 'PO_BOX' | 'POSTAL' | 'RESIDENTIAL' | 'STATEMENT' | 'UNSUPPORTED' — Type of address
          - `building_number` string — Building number
          - `country` string — Country name or code
          - `department` string — Department within the address
          - `post_code` string — Postal or ZIP code
          - `street_name` string — Name of the street
          - `sub_department` string — Sub-department within the address
          - `town_name` string — Town or city name
          - `country_sub_division` string — Country subdivision such as state or province
      - `creditor_account` AccountIdentifier
        - `scheme_name` 'PAN' | 'MASKED_PAN' | 'IBAN' | 'BBAN' | 'UNSUPPORTED' | 'OTHER' — Indicates the type of identification being provided. For example, IBAN | The `identification` field is returning the IBAN for the account.
        - `identification` string — The account identification value
        - `name` string — The name associated with the account
      - `reference` string — Unique reference in the context of the creditor, provided by the creditor to debtor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party (i.e. Debtor) provides this reference in the structured remittance information, to enable reconciliation by the Creditor upon receipt of the amount of money. This field is populated by the User 1 (who is the initiating party of the payment e.g. the Debtor).
      - `supplementary_data` object — Additional information that can not be captured in the structured fields and/or any other specific block.
    - `page` PageMetadata — Metadata about the current page of results
      - `number` integer, required — The current page being returned by the API
      - `size` integer, required — The page size requested
      - `total_elements` integer, required — The total number of elements in all pages
      - `total_pages` integer, required — The total number of pages retrievable
      - `sort` string[] — Sort parameters applied to the results
    - `type` string, required — The endpoint the original request was made to.

## Other responses

- `202` — Accepted (Asynchronous request)
- `400` — Bad Request
- `404` — Account or entity not found
- `500` — Internal Server Error

---

[API](https://skmtc.net/leantech/apis/auth.md) · [All operations](https://skmtc.net/leantech/apis/auth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/leantech/auth/versions/c2e46d54d886/schema)