---
title: "HalBeneficiaries"
canonical: "https://openfinanceguide.com/en/stet/1.6.3/resources/hal-beneficiaries"
edition: "STET PSD2 API 1.6.3.1"
source: "https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.2-openapi.yaml"
pdf: "https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf"
language: "en"
normative: "The normative text is the English PDF and OpenAPI file published by STET. This Markdown reproduces it for reading; where they differ, the PDF prevails."
license: "CC BY 3.0 FR (https://creativecommons.org/licenses/by/3.0/fr/), STET. Converted to Markdown by Open Finance Guide."
---

# HalBeneficiaries

Type: `object` · Kind: Hal

HYPERMEDIA structure used for returning the list of the whitelisted beneficiaries

Fields:

- `beneficiaries`, array of [`Beneficiary`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/beneficiary.md), required — List of trusted beneficiaries
- `_links`, [`BeneficiariesLinks`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/beneficiaries-links.md), required

## Example

```json
{
  "demoBeneficiaries": [
    {
      "creditor": {
        "name": "myMerchant",
        "postalAddress": {
          "country": "FR",
          "addressLine": [
            "18 rue de la DSP2",
            "75008 PARIS"
          ]
        },
        "organisationId": {
          "identification": "852126789",
          "schemeName": "SIREN",
          "issuer": "FR"
        }
      },
      "creditorAccount": {
        "iban": "YY64COJH41059545330222956960771321",
        "currency": "EUR"
      }
    }
  ],
  "beneficiaries": [
    {
      "creditor": {
        "name": "myMerchant",
        "postalAddress": {
          "country": "FR",
          "addressLine": [
            "18 rue de la DSP2",
            "75008 PARIS"
          ]
        },
        "organisationId": {
          "identification": "852126789",
          "schemeName": "SIREN",
          "issuer": "FR"
        }
      },
      "creditorAccount": {
        "iban": "YY64COJH41059545330222956960771321",
        "currency": "EUR"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "/v1/trusted-beneficiaries"
    },
    "accounts": {
      "href": "/v1/accounts"
    }
  }
}
```

## Used by

- `GET /trusted-beneficiaries` (trustedBeneficiariesGet)