---
title: "GET /trusted-beneficiaries"
canonical: "https://openfinanceguide.com/en/stet/1.6.3/endpoints/aisp/trusted-beneficiaries-get"
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"
section: "4.10"
pdf_pages: "52"
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."
---

# GET /trusted-beneficiaries

Retrieval of the trusted beneficiaries list (AISP)

Operation: `trustedBeneficiariesGet` · Tags: AISP · Scopes: `aisp` · Source: [§ 4.10 Retrieval of the trusted beneficiaries list (AISP), PDF p. 52](https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf#page=52)

### Description
This call returns all trusted beneficiaries that were set by the PSU.
Those beneficiaries can benefit from an SCA exemption during payment initiation.
The result may be subject to pagination (i.e. retrieving a partial result in case of having too many results) through a set of pages by the ASPSP. Thereafter, the AISP may ask for the first, next, previous or last page of results.
### Prerequisites
- The TPP was registered by the Registration Authority for the AISP role.
- The TPP and the PSU have a contract that was enrolled by the ASPSP
    - At this step, the ASPSP has delivered an OAUTH2 "Authorization Code" or "Resource Owner Password" access token to the TPP (cf. paragraph  3.4.2).
- The TPP and the ASPSP have successfully processed a mutual check and authentication
- The TPP has presented its OAUTH2 "Authorization Code" or "Resource Owner Password" access token which allows the ASPSP to identify the relevant PSU and retrieve the linked PSU context (cf. paragraph  3.4.2) if any.
- The ASPSP takes into account the access token that establishes the link between the PSU and the AISP.
### Business Flow
The AISP asks for the trusted beneficiaries list.
The ASPSP answers with a list of beneficiary details structure.

## Parameters

- `Authorization`, in header, `string`, required — Access token to be passed as a header
- `PSU-IP-Address`, in header, `string` — IP address used by the PSU's terminal when connecting to the TPP
- `PSU-IP-Port`, in header, `string` — IP port used by the PSU's terminal when connecting to the TPP
- `PSU-HTTP-Method`, in header, `string` — Http method for the most relevant PSU's terminal request to the TTP
- `PSU-Date`, in header, `string` — Timestamp of the most relevant PSU's terminal request to the TTP
- `PSU-GEO-Location`, in header, `string` — Geographical location of the PSU as provided by the PSU mobile terminal if any to the TPP
- `PSU-User-Agent`, in header, `string` — "User-Agent" header field sent by the PSU terminal when connecting to the TPP
- `PSU-Referer`, in header, `string` — "Referer" header field sent by the PSU terminal when connecting to the TPP.
  Notice that an initial typo in RFC 1945 specifies that "referer" (incorrect spelling) is to be used. The correct spelling "referrer" can be used but might not be understood.
- `PSU-Accept`, in header, `string` — "Accept" header field sent by the PSU terminal when connecting to the TPP
- `PSU-Accept-Charset`, in header, `string` — "Accept-Charset" header field sent by the PSU terminal when connecting to the TPP
- `PSU-Accept-Encoding`, in header, `string` — "Accept-Encoding" header field sent by the PSU terminal when connecting to the TPP
- `PSU-Accept-Language`, in header, `string` — "Accept-Language" header field sent by the PSU terminal when connecting to the TPP
- `PSU-Device-ID`, in header, `string` — UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available.
  UUID identifies either a device or a device dependant application installation.
  In case of installation identification this ID need to be unaltered until removal from device.
- `Digest`, in header, `string` — Digest of the body
- `Signature`, in header, `string` — [http-signature of the request](https://datatracker.ietf.org/doc/draft-cavage-http-signatures/)
  The keyId must specify the way to get the relevant qualified certificate. It is requested that this identifier is an URL aiming to provide the relevant Qualified Certificate.
- `X-Request-ID`, in header, `string`, required — Correlation header to be set in a request and retrieved in the relevant response
  Constraints: maxLength 70.
- `workspace`, in query, `string` — Workspace to be used for processing an AISP request.
  If not provided, the default workspace is computed from the authentication that was used for getting the OAuth2 Access Token.
  Constraints: maxLength 32.
- `X-JWS-Signature`, in header, `string` — [JSON WEB signature of the request](https://www.openbankingeurope.eu/media/2095/obe-json-web-signature-profile-for-open-banking.pdf)

## Responses

### 200

The ASPSP returns the list of whitelisted beneficiaries

Body: [`HalBeneficiaries`](#halbeneficiaries)

Headers:

- `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response
- `Warning`, `string` — Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message.

### 204

No content.

Headers:

- `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response
- `Warning`, `string` — Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message.

### 401

Unauthorized, authentication failure.

Body: [`ErrorModel`](#errormodel)

Headers:

- `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response
- `Warning`, `string` — Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message.

### 403

Forbidden, authentication successful but access to resource is not allowed.

Body: [`ErrorModel`](#errormodel)

Headers:

- `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response
- `Warning`, `string` — Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message.

### 404

Not found, no request available.

Body: [`ErrorModel`](#errormodel)

Headers:

- `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response
- `Warning`, `string` — Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message.

### 405

Method Not Allowed.

Body: [`ErrorModel`](#errormodel)

Headers:

- `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response
- `Warning`, `string` — Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message.

### 406

Not Acceptable.

Body: [`ErrorModel`](#errormodel)

Headers:

- `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response
- `Warning`, `string` — Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message.

### 429

Too many requests.

Body: [`ErrorModel`](#errormodel)

Headers:

- `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response
- `Warning`, `string` — Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message.

### 500

Internal server error.

Body: [`ErrorModel`](#errormodel)

Headers:

- `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response

### 501

Not Implemented.
This code should be used when the entry point is implemented but cannot provide a result, given the context.
When the entry point is not implemented at all, HTTP400 will be returned.

Body: [`ErrorModel`](#errormodel)

Headers:

- `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response

## Example

Built from the specification: every documented header and field.

```bash
curl -X GET 'https://api.aspsp.example/v1/trusted-beneficiaries' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'PSU-IP-Address: 192.0.2.1' \
  -H 'PSU-IP-Port: 443' \
  -H 'PSU-HTTP-Method: GET' \
  -H 'PSU-Date: Tue, 03 Oct 2022 10:15:30 GMT' \
  -H 'PSU-GEO-Location: {PSU-GEO-Location}' \
  -H 'PSU-User-Agent: {PSU-User-Agent}' \
  -H 'PSU-Referer: {PSU-Referer}' \
  -H 'PSU-Accept: {PSU-Accept}' \
  -H 'PSU-Accept-Charset: {PSU-Accept-Charset}' \
  -H 'PSU-Accept-Encoding: {PSU-Accept-Encoding}' \
  -H 'PSU-Accept-Language: {PSU-Accept-Language}' \
  -H 'PSU-Device-ID: {PSU-Device-ID}' \
  -H 'Digest: SHA-256=X48E9qOokqqrvdts8nOJRJN3OWDUoyWxBf7kbu9DBPE=' \
  -H 'Signature: keyId="...",algorithm="rsa-sha256",headers="(request-target) date digest",signature="..."' \
  -H 'X-Request-ID: a1b2c3d4-e5f6-4a3b-8c2d-1e2f3a4b5c6d' \
  -H 'X-JWS-Signature: {X-JWS-Signature}'
```

Response 200:

```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"
    }
  }
}
```

## Schemas

Every schema this endpoint uses, each once; fields name the schema they hold.

### AccountIdentification

Type: `object` · Kind: ISO20022 · Source: [§ 4.1.1, PDF p. 2](https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf#page=2)

Unique and unambiguous identification for the account between the account owner and the account servicer.
Card accounts must provide the identification of the card through the "other" substructure by giving, for instance, the masked PAN (MPAN).
The currency used for the account, when needed, can be specified through the [currency] field.

Fields:

- `workspace`, `string` — Workspace to which the account is linked.
  This workspace might be specified by the AISP when forwarding the consent on accounts.
  If not provided, the default workspace is computed from the authentication that was used for getting the OAuth2 Access Token.
  Constraints: maxLength 32.
- `iban`, `string` — ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer.

  Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 "Banking and related financial services - International Bank Account Number (IBAN)" version 1997-10-01, or later revisions.
  Constraints: pattern `^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$`.
- `other`, [`GenericIdentification`](#genericidentification)
- `currency`, [`CurrencyCode`](#currencycode)

### BeneficiariesLinks

Type: `object` · Kind: Hal

links that can be used for further navigation when browsing Account Information at one account level
| Link | Description |
| ---- | ----------- |
| self | link to the list of trusted beneficiaries |
| accounts | link to the list of all available accounts |
| consents | link to the consents forwarding |
| endUserIdentity | link to the end-user identity |
| first | link to the first page of the beneficiaries result |
| last | link to the last page of the beneficiaries result |
| next | link to the next page of the beneficiaries result |
| prev | link to the previous page of the beneficiaries result |

Fields:

- `self`, [`GenericLink`](#genericlink), required
- `accounts`, [`GenericLink`](#genericlink)
- `consents`, [`GenericLink`](#genericlink)
- `endUserIdentity`, [`GenericLink`](#genericlink)
- `first`, [`GenericLink`](#genericlink)
- `last`, [`GenericLink`](#genericlink)
- `next`, [`GenericLink`](#genericlink)
- `prev`, [`GenericLink`](#genericlink)

### Beneficiary

Type: `object` · Kind: Resources

Specification of a beneficiary

Fields:

- `workspace`, [`Workspace`](#workspace)
- `id`, `string` — Id of the beneficiary
  Constraints: pattern `^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$`.
- `isTrusted`, `boolean` — The ASPSP having not implemented the trusted beneficiaries list must not set this flag.
  Otherwise, the ASPSP indicates whether or not the beneficiary was registered by the PSU within the trusted beneficiaries list.
  - true: the beneficiary is actually a trusted beneficiary
  - false: the beneficiary is not a trusted beneficiary
- `creditorAgent`, [`FinancialInstitutionIdentification`](#financialinstitutionidentification)
- `creditor`, [`PartyIdentification`](#partyidentification), required
- `creditorAccount`, [`AccountIdentification`](#accountidentification)

### ClearingSystemMemberIdentification

Type: `object` · Kind: ISO20022

ISO20022: Information used to identify a member within a clearing system.
API: to be used for some specific international credit transfers in order to identify the beneficiary bank

Fields:

- `clearingSystemId`, `string`, required — ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.
  Constraints: maxLength 35.
- `memberId`, `string`, required — ISO20022: Identification of a member of a clearing system.
  Constraints: maxLength 35.

### ContactDetails

Type: `object` · Kind: ISO20022

Indicates how to contact the party.

Fields:

- `phoneNumber`, [`PhoneNumber`](#phonenumber)
- `faxNumber`, [`PhoneNumber`](#phonenumber)
- `emailAddress`, `string` — email address of the contact
  Constraints: maxLength 2048, pattern `^.+@.+$`.

### CurrencyCode

Type: `string` · Kind: ISO20022 · Constraints: pattern `^[A-Z]{3,3}$`

Specifies the currency of the amount or of the account.
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

### DateAndPlaceOfBirth

Type: `object` · Kind: ISO20022

Date and place of birth of a person.
This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment.

Fields:

- `birthDate`, `string (date)`, required — Date on which a person is born.
- `cityOfBirth`, `string`, required — City where a person was born.
  Constraints: maxLength 35.
- `countryOfBirth`, `string`, required — Country where a person was born.
  Constraints: pattern `^[A-Z]{2,2}$`.

### ErrorDetail

Type: `object` · Kind: Technical

detailed error description

Fields:

- `location`, `string` — Location of the erroneous parameter when not in request body
  Values:
  - `header`
  - `query`
- `name`, `string` — Name of the erroneous parameter when not in request body
- `path`, `string` — JsonPath of the erroneous request body property
- `erroneousValue`, `string` — Erroneous parameter value
- `message`, `string` — Relevant message for the erroneous parameter
- `expectedPattern`, `string` — Expected pattern, if any, that the erroneous parameter does not match with
- `expectedValueRange`, `object` — Expected value range, if any, that the erroneous parameter does not match with
  - `minValue`, `integer`
  - `maxValue`, `integer`
- `expectedValueCount`, `object` — Expected value count, in the case of an array item, that the erroneous parameter does not match with
  - `minValue`, `integer`
  - `maxValue`, `integer`
- `expectedEnumeration`, array of `string` — Expected enumeration, if any, that the erroneous parameter do not match with

### ErrorModel

Type: `object` · Kind: Technical

Generic error report structure

Fields:

- `timestamp`, `string (date-time)` — current timestamp
- `status`, `integer (int32)`, required — HTTP error code
- `error`, `string` — HTTP error text
  Constraints: maxLength 140.
- `message`, `string`, required — HTTP textual reason phrase
  Constraints: maxLength 140.
- `path`, `string` — Relevant path that was used
  Constraints: maxLength 140.
- `details`, array of [`ErrorDetail`](#errordetail) — list of detailed errors that were encountered

### FinancialInstitutionIdentification

Type: `object` · Kind: ISO20022 · Source: [§ 4.1.5, PDF p. 12](https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf#page=12)

ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.

Fields:

- `bicFi`, `string`, required — ISO20022: Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)".
  Constraints: pattern `^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$`.
- `clearingSystemMemberId`, [`ClearingSystemMemberIdentification`](#clearingsystemmemberidentification)
- `lei`, [`LeiIdentification`](#leiidentification)
- `name`, `string` — Name of the financial institution
  Constraints: maxLength 140.
- `postalAddress`, [`PostalAddress`](#postaladdress)

### GenericIdentification

Type: `object` · Kind: ISO20022 · Source: [§ 4.1.6, PDF p. 14](https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf#page=14)

ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer.
API: The ASPSP will document which account reference type it will support.

Fields:

- `identification`, `string`, required — API: Identifier
  Constraints: maxLength 70.
- `schemeName`, `string`, required — Name of the identification scheme.
  Possible values for the scheme name, partially based on ISO20022 external code list, are the following:
  | Code | Name | Description |
  | ---- | ---- | ----------- |
  | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. |
  | BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. |
  | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) |
  | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. |
  | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. |
  | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. |
  Other values are also permitted, for instance:
  | Code | Name | Description |
  | ---- | ---- | ----------- |
  | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU |
  | CPAN | CardPan | Card PAN |
  | MPAN | MaskedPan | Card PAN where some digits were replaced for security reason |
  | TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field |
  | TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field |
  Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used
  Constraints: maxLength 70.
- `issuer`, `string` — ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
  Constraints: maxLength 35.

### GenericLink

Type: `object` · Kind: Hal · Source: [§ 4.1.7, PDF p. 15](https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf#page=15)

hypertext reference

Fields:

- `href`, `string`, required — URI to be used. HREF stands for Hypertext REFerence.
  Constraints: maxLength 2000.
- `templated`, `boolean` — This field must be set with "true"  when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.
  Otherwise, this property must be absent or set to false
  default value: false

### HalBeneficiaries

Type: `object` · Kind: Hal

HYPERMEDIA structure used for returning the list of the whitelisted beneficiaries

Fields:

- `beneficiaries`, array of [`Beneficiary`](#beneficiary), required — List of trusted beneficiaries
- `_links`, [`BeneficiariesLinks`](#beneficiarieslinks), required

### LeiIdentification

Type: `string` · Kind: ISO20022 · Constraints: pattern `^[A-Z0-9]{18,18}[0-9]{2,2}$`

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

### PartyIdentification

Type: `object` · Kind: ISO20022 · Source: [§ 4.1.8, PDF p. 15](https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf#page=15)

API : Description of a Party which can be either a person or an organization.

Fields:

- `name`, `string`, required — ISO20022: Name by which a party is known and which is usually used to identify that party.
  The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation.
  The [privateId] property allows the specification of an unique and unambiguous way to identify a person.
  Constraints: maxLength 140.
- `dateAndPlaceOfBirth`, [`DateAndPlaceOfBirth`](#dateandplaceofbirth)
- `postalAddress`, [`PostalAddress`](#postaladdress)
- `contactDetails`, [`ContactDetails`](#contactdetails)
- `organisationId`, [`GenericIdentification`](#genericidentification)
- `privateId`, [`GenericIdentification`](#genericidentification)
- `lei`, [`LeiIdentification`](#leiidentification)

### PhoneNumber

Type: `string` · Kind: ISO20022 · Constraints: pattern `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$`

The collection of information which identifies a specific phone or FAX number as defined by telecom services.
It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).

### PostalAddress

Type: `object` · Kind: ISO20022

ISO20022: Information that locates and identifies a specific address, as defined by postal services.

Fields:

- `addressType`, `string` — ISO20022: Identifies the nature of the postal address.
  API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.
  Values:
  - `BIZZ` — Business: Address is the business address
  - `DLVY` — Delivery: Address is the address to which delivery is to take place
  - `MLTO` — Mail To: Address is the  address to which mail is sent
  - `PBOX` — PO Box: Address is is a postal office (PO) box
  - `ADDR` — Postal: Address is the complete postal address
  - `HOME` — Home: Address is the home address
- `department`, `string` — ISO20022: Identification of a division of a large organisation or building.
  API: Cannot be used for SEPA payments.
  Constraints: maxLength 70.
- `subDepartment`, `string` — ISO20022: Identification of a sub-division of a large organisation or building.
  API: Cannot be used for SEPA payments.
  Constraints: maxLength 70.
- `streetName`, `string` — ISO20022: Name of a street or thoroughfare.
  API: Cannot be used for SEPA payments.
  Constraints: maxLength 70.
- `buildingNumber`, `string` — ISO20022: Number that identifies the position of a building on a street.
  API: Cannot be used for SEPA payments.
  Constraints: maxLength 16.
- `buildingName`, `string` — ISO20022: Name of the building or house.
  API: Cannot be used for SEPA payments.
  Constraints: maxLength 16.
- `postCode`, `string` — ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
  API: Cannot be used for SEPA payments.
  Constraints: maxLength 16.
- `townName`, `string` — ISO20022: Name of a built-up area, with defined boundaries, and a local government.
  API: Cannot be used for SEPA payments.
  Constraints: maxLength 35.
- `countrySubDivision`, `string` — ISO20022: Identifies a subdivision of a country such as state, region, county.
  API: Cannot be used for SEPA payments.
  Constraints: maxLength 35.
- `country`, `string`, required — ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.
  Constraints: pattern `^([A-Z]{2,2})$`.
- `addressLine`, array of `string` — Unstructured address. The lines must embed zip code and town name.
  For SEPA payments, only two address lines are allowed.
  Item constraints: maxLength 70.
  Items: Address line

### Workspace

Type: `object`

Some ASPSP may provide different user workspaces that can be accessed by the same authenticated PSU. In this case, the AISP is able to retrieve the different pieces of account information by specifying the relevant workspace as a QUERY parameter. Identification of the workspace to be used when processing the request. If not present, the default workspace to be used is the one that is linked to the authentication processed during the OAuth2 access token request.

Fields:

- `identification`, `string`, required — identification of the workspace to be used as an optional query parameter for some AISP queries
  Constraints: maxLength 32.
- `label`, `string`, required — textual description of the workspace as specified by the ASPSP in relationship wth the PSU
  Constraints: maxLength 128.
