---
title: "Get Beneficiaries"
method: GET
path: "/beneficiaries"
tags: ["Beneficiaries"]
---

# Get Beneficiaries

`GET /beneficiaries`

Enables an AISP to retrieve Beneficiary information for account(s) that the PSU has consented to.

## Headers

- `x-fapi-auth-date` string
- `x-fapi-customer-ip-address` string
- `x-fapi-interaction-id` string
- `Authorization` string, required
- `x-customer-user-agent` string
- `x-client-id` string

## Response `200`

Beneficiaries Read

- OBReadBeneficiary5
  - `Data` object, required
    - `Beneficiary` OBBeneficiary5[]
      - `AccountId` string — A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
      - `BeneficiaryId` string — A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.
      - `BeneficiaryType` 'Trusted' | 'Ordinary' — Specifies the Beneficiary Type.
      - `Reference` string — Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
      - `SupplementaryData` OBSupplementaryData1 — Additional information that can not be captured in the structured fields and/or any other specific block.
      - `CreditorAgent` OBBranchAndFinancialInstitutionIdentification60 — Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.
        - `SchemeName` string — Name of the identification scheme, in a coded form as published in an external list.<br/> For a full list of enumeration values refer to `OBInternalFinancialInstitutionIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `Identification` string — Unique and unambiguous identification of the servicing institution.
        - `Name` string — Name by which an agent is known and which is usually used to identify that agent.
        - `PostalAddress` OBPostalAddress7 — Information that locates and identifies a specific address, as defined by postal services.
          - `AddressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME' | 'CORR' | 'STAT' — Identifies the nature of the postal address. <br /> For a full set of codes see `OBAddressType2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
          - `Department` string — Identification of a division of a large organisation or building.
          - `SubDepartment` string — Identification of a sub-division of a large organisation or building.
          - `StreetName` string — Name of a street or thoroughfare.
          - `BuildingNumber` string — Number that identifies the position of a building on a street.
          - `BuildingName` string — Name of a referenced building.
          - `Floor` string — Number that identifies the level within a building
          - `UnitNumber` string — Number that identifies the unit of a specific address .
          - `Room` string — Information that locates and identifies a room to form part of an address
          - `PostBox` string — Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
          - `TownLocationName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `DistrictName` string — Number that of the regional area, known as a district, which forms part of an address
          - `CareOf` string — The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
          - `PostCode` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
          - `TownName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `CountrySubDivision` string — Identifies a subdivision of a country such as state, region, county.
          - `Country` string — Nation with its own government.
          - `AddressLine` string[]
        - `LEI` string — Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
      - `CreditorAccount` OBCashAccount50 — Provides the details to identify the beneficiary account.
        - `SchemeName` string, required — Name of the identification scheme, in a coded form as published in an external list. <br /> For a full list of enumeration values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `Identification` string, required — Identification assigned by an institution to identify an account. This identification is known by the account owner.
        - `Name` string — The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
        - `SecondaryIdentification` string — This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
        - `Proxy` OBProxy1 — Specifies an alternate assumed name for the identification of the account.
          - `Identification` string, required — Identification used to indicate the account identification under another specified name.
          - `Code` 'TELE' | 'EMAL' | 'DNAM' | 'CINC' | 'COTX' | 'COID' | 'CUST' | 'DRLC' | 'EIDN' | 'EWAL' | 'PVTX' | 'LEIC' | 'MBNO' | 'NIDN' | 'CCPT' | 'SHID' | 'SOSE' | 'TOKN' | 'UBIL' | 'VIPN' | 'BIID', required — Specifies the external proxy account type code, as published in the proxy account type external code set.<br /> For more information and a full list of values see `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
          - `Type` string — Type of the proxy identification.
  - `Links` Links — Links relevant to the payload
    - `Self` string, uri, required
    - `First` string, uri
    - `Prev` string, uri
    - `Next` string, uri
    - `Last` string, uri
  - `Meta` Meta — Meta Data relevant to the payload
    - `TotalPages` integer
    - `FirstAvailableDateTime` string, date-time — All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
    - `LastAvailableDateTime` string, date-time — All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `405` — Method Not Allowed
- `406` — Not Acceptable
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.net/openbankinguk/apis/account-and-transaction-api-specification.md) · [All operations](https://skmtc.net/openbankinguk/apis/account-and-transaction-api-specification/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openbankinguk/account-and-transaction-api-specification/versions/b1c449c8ecb0/schema)