---
title: "Get Account Beneficiaries"
method: GET
path: "/accounts/{accountId}/beneficiaries"
tags: ["Financial Data"]
---

# Get Account Beneficiaries

`GET /accounts/{accountId}/beneficiaries`

## Request

- Base URL: `https://api.yapily.com`
- URL: `https://api.yapily.com/accounts/{accountId}/beneficiaries`
- Auth: HTTP basic

Returns all the beneficiaries of a user's account.

Feature: `ACCOUNT_BENEFICIARIES`

## Path parameters

- `accountId` string, required

## Headers

- `consent` string, required
- `sub-application` string, uuid

## Response `200`

Ok

- ApiListResponseOfBeneficiary
  - `meta` ResponseListMeta
    - `tracingId` string
    - `count` integer
    - `pagination` Pagination
      - `totalCount` integer
      - `self` FilterAndSort
        - `from` string, date-time: __Optional__. The earliest date and time of resources / records that should be returned.
        - `before` string, date-time: __Optional__. The latest date and time of resources / records that should be returned.
        - `limit` integer: __Optional__. The maximum number of resources / records that should be returned.
        - `sort` 'date' | '-date': The attribute on which resources / records returned should be sorted. Valid options for the sort parameter.
        - `offset` integer
        - `cursor` string
      - `next` Next
        - `from` string, date-time
        - `before` string, date-time
        - `limit` integer
        - `cursor` string
  - `data` Beneficiary[]
    - `id` string: Unique identifier of the `beneficiary`.
    - `reference` string: A creditor reference that is requested to be used for all payment instructions to this beneficiary.
    - `payee` BeneficiaryPayee: __Mandatory__. Account details belonging to the `Beneficiary Payee` (person/ business). You must define this in your payment request along with all of the nested mandatory properties.
      - `name` string: The account holder name of the beneficiary.
      - `accountIdentifications` AccountIdentification[], required: __Mandatory__. The account identifications that identify the `BeneficiaryPayee` bank account.
        - `type` 'SORT_CODE' | 'ACCOUNT_NUMBER' | 'IBAN' | 'BBAN' | 'BIC' | 'PAN' | 'MASKED_PAN' | 'MSISDN' | 'BSB' | 'NCC' | 'ABA' | 'ABA_WIRE' | 'ABA_ACH' | 'EMAIL' | 'ROLL_NUMBER' | 'BLZ' | 'IFS' | 'CLABE' | 'CTN' | 'BRANCH_CODE' | 'VIRTUAL_ACCOUNT_ID', required: __Mandatory__. Used to describe the format of the account. See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-execution#account-identifications-combinations) for more information on when to specify each type.
        - `identification` string, required: __Mandatory__. The value associated with the account identification type. See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-execution#account-identifications-combinations) for more information on the format of the values.
      - `address` Address: __Conditional__. The address of the `Payee` or `Payer`. - `payee.address` is mandatory when the `paymentType` is an `INTERNATIONAL` payment - An `Institution` may require you to specify the `country` when used in the context of the `Payee` to be able to make a payment.
        - `addressLines` string[]: __Optional__. The address line of the address
        - `streetName` string: __Optional__. The street name of the address
        - `buildingNumber` string: __Optional__. The building number of the address
        - `postCode` string: __Optional__. The post code of the address
        - `townName` string: __Optional__. The town name of the address
        - `county` string[]: __Optional__. The list of counties for the address
        - `country` string: __Conditional__. The 2-letter country code for the address. An `Institution` may require you to specify the `country` when used in the context of the `Payee` to be able to make a payment
        - `department` string: __Optional__. The department for the address
        - `subDepartment` string: __Optional__. The sub-department for the address
        - `addressType` 'BUSINESS' | 'CORRESPONDENCE' | 'DELIVERY_TO' | 'MAIL_TO' | 'PO_BOX' | 'POSTAL' | 'RESIDENTIAL' | 'STATEMENT' | 'UNKNOWN': __Optional__. The type of address
    - `trusted` boolean: Indicates whether the account owner has stated that this beneficiary should be trusted. This often results in reduced authentication and authorisation requirements on payments to the beneficiary.
  - `links` object
  - `forwardedData` ResponseForwardedData[]
    - `headers` object
    - `url` string
  - `raw` RawResponse[]
    - `request` RawRequest
      - `method` string
      - `url` string
      - `requestInstant` string, date-time
      - `headers` object
      - `body` object
      - `bodyParameters` object
      - `startTime` string, date-time
      - `startedAt` string, date-time
    - `duration` string, iso8601
    - `headers` object
    - `resultCode` integer
    - `result` object
  - `tracingId` string

## Other responses

- `default`: Error Response

---

[API](https://skmtc.dev/yapily/apis/yapily-api.md) - [All operations](https://skmtc.dev/yapily/apis/yapily-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yapily/apis/yapily-api/revisions/a8ca54f9eb9f?raw)