---
title: "GET /accounts"
canonical: "https://openfinanceguide.com/en/stet/1.6.3/endpoints/aisp/accounts-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.2"
pdf_pages: "29"
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 /accounts

Retrieval of the PSU accounts (AISP)

Operation: `accountsGet` · Tags: AISP · Scopes: `aisp` · Source: [§ 4.2 Retrieval of the PSU accounts (AISP), PDF p. 29](https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf#page=29)

### Description
This call returns all payment accounts that are relevant for the PSU on behalf of whom the AISP is connected.
Thanks to HYPERMEDIA, each account is returned with the links aiming to ease access to the relevant transactions and balances.
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 TPP sends a request to the ASPSP for retrieving the list of the PSU payment accounts.
The ASPSP computes the relevant PSU accounts and builds the answer as an accounts list.
The result may be subject to pagination in order to avoid an excessive result set.
Each payment account will be provided with its characteristics.

## 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 return a PSU context
- listing the accounts that were made available to the AISP by the PSU and,
- for each of these accounts, the further transactions that were enabled by the PSU through HYPERMEDIA links.

Body: [`HalAccounts`](#halaccounts)

Headers:

- `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.
- `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response

### 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.

### 408

Request Timeout.

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

### 503

Service unavailable.

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/accounts' \
  -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
{
  "accounts": [
    {
      "workspace": {
        "identification": "PERSO",
        "label": "comptes personnels"
      },
      "resourceId": "Alias1",
      "bicFi": "BNKAFRPPXXX",
      "accountId": {
        "iban": "YY64COJH41059545330222956960771321",
        "currency": "EUR"
      },
      "name": "Compte de Mr et Mme Dupont",
      "usage": "PRIV",
      "cashAccountType": "CACC",
      "psuStatus": "Co-account Holder",
      "_links": {
        "balances": {
          "href": "/v1/accounts/Alias1/balances"
        },
        "transactions": {
          "href": "/v1/accounts/Alias1/transactions"
        },
        "overdrafts": {
          "href": "/v1/accounts/Alias1/overdrafts"
        }
      }
    },
    {
      "workspace": {
        "identification": "PERSO",
        "label": "comptes personnels"
      },
      "resourceId": "Alias2",
      "bicFi": "BNKAFRPPXXX",
      "accountId": {
        "iban": "YY64COJH41059545330222956960771321",
        "currency": "EUR"
      },
      "name": "Compte de Mme Dupont",
      "usage": "PRIV",
      "cashAccountType": "CACC",
      "psuStatus": "Account Holder",
      "_links": {
        "balances": {
          "href": "/v1/accounts/Alias2/balances"
        },
        "transactions": {
          "href": "/v1/accounts/Alias2/transactions"
        },
        "overdrafts": {
          "href": "/v1/accounts/Alias2/overdrafts"
        }
      }
    }
  ],
  "_links": {
    "self": {
      "href": "/v1/accounts"
    },
    "consents": {
      "href": "/v1/consents"
    },
    "endUserIdentity": {
      "href": "v1/end-user-identity"
    },
    "trustedBeneficiaries": {
      "href": "/v1/trusted-beneficiaries"
    }
  }
}
```

## 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)

### AccountLinks

Type: `object` · Kind: Hal

links that can be used for further navigation when browsing Account Information at one account level
| Link | Description |
| ---- | ----------- |
| owners | link to the owners identities for a given account |
| balances | link to the balances of a given account |
| transactions | link to the transactions of a given account |
| overdrafts | link to the lists of overdrafts of a given account |

Fields:

- `owners`, [`GenericLink`](#genericlink)
- `balances`, [`GenericLink`](#genericlink)
- `transactions`, [`GenericLink`](#genericlink)
- `overdrafts`, [`GenericLink`](#genericlink)

### AccountListLinks

Type: `object` · Kind: Hal

Links that can be used for further navigation when browsing Account Information at top level
| Link | Description |
| ---- | ----------- |
| self | link to the list of all available accounts |
| consents | link to the consents forwarding |
| endUserIdentity | link to the end-user identity|
| trustedBeneficiaries | link to the list of trusted beneficiaries |
| worspaces | array of link to each relevant workspaces |
| first | link to the first page of the accounts result |
| last | link to the last page of the accounts result |
| next | link to the next page of the accounts result |
| prev | link to the previous page of the accounts result |

Fields:

- `self`, [`GenericLink`](#genericlink), required
- `consents`, [`GenericLink`](#genericlink)
- `endUserIdentity`, [`GenericLink`](#genericlink)
- `trustedBeneficiaries`, [`GenericLink`](#genericlink)
- `workspaces`, array of [`GenericLink`](#genericlink) — list of all workspaces that can be accessed by the PSU
- `first`, [`GenericLink`](#genericlink)
- `last`, [`GenericLink`](#genericlink)
- `next`, [`GenericLink`](#genericlink)
- `prev`, [`GenericLink`](#genericlink)

### AccountResource

Type: `object` · Kind: Resources

PSU account that is made available to the TPP.
The ASPSP is able to set up specific accounts in order to provide card transactions with a delayed debit.
This account must be specific to a given card. Consequently, when the card is renewed, a new account will be set up.
ASPSP might also set-up different accounts for one given card but with different imputation dates. The remanence of these accounts is up to the ASPSP but must be equal or greater than the one which is provided through the Web-Banking interface.
Case a payment card is blocked, any relevant information (balances, transactions...) that is available through the ASPSP PSU-interfaces must also be available through the API till the end of remanence period.

Fields:

- `workspace`, [`Workspace`](#workspace)
- `resourceId`, [`ResourceId`](#resourceid)
- `bicFi`, `string` — 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}$`.
- `accountId`, [`AccountIdentification`](#accountidentification)
- `name`, `string`, required — Label of the PSU account
  In case of a delayed debit card transaction set, the name shall specify the holder name and can also provide the imputation date
  Constraints: maxLength 70.
- `details`, `string` — Specifications that might be provided by the ASPSP
  - characteristics of the account
  - characteristics of the relevant card
  Constraints: maxLength 140.
- `linkedAccount`, `string` — Case of a set of pending card transactions, the ASPSP will provide the relevant cash account the card is set up on.
  When used, this field must be valued with the resourceId of the relevant cash account.
  Constraints: maxLength 70.
- `usage`, `string` — Specifies the usage of the account
  Case of a set of pending card transactions, this field does not have to be set since the usage is inherited from the linked account.
  Values:
  - `PRIV` — Private personal account
  - `ORGA` — Professional account
- `cashAccountType`, `string`, required — Specifies the type of the account
  Values:
  - `CACC` — Cash account
  - `CARD` — List of card based transactions
- `product`, `string` — Product Name of the Bank for this account, proprietary definition
  Constraints: maxLength 35.
- `balances`, array of [`BalanceResource`](#balanceresource) — list of balances provided by the ASPSP
- `psuStatus`, [`PsuStatusType`](#psustatustype)
- `_links`, [`AccountLinks`](#accountlinks), required

### AmountType

Type: `object` · Kind: ISO20022 · Source: [§ 4.1.2, 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)

Structure aiming to embed the amount and the currency to be used.

Fields:

- `amount`, `number (float)`, required — ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
  Constraints: pattern `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`.
- `currency`, [`CurrencyCode`](#currencycode), required

### BalanceResource

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

Structure of an account balance

Fields:

- `name`, `string`, required — Label of the balance
  Constraints: maxLength 70.
- `balanceAmount`, [`AmountType`](#amounttype), required
- `balanceType`, [`BalanceStatus`](#balancestatus), required
- `lastChangeDateTime`, `string (date-time)` — Timestamp of the last change of the balance amount
- `referenceDate`, `string (date-time)` — Reference date for the balance
- `lastCommittedTransaction`, `string` — Identification of the last committed transaction. This is actually useful for instant balance.
  Constraints: maxLength 40.

### BalanceStatus

Type: `string` · Kind: ISO20022

Type of balance

Values:

- `CLBD` — ISO20022 ClosingBooked: Balance of the account at the end of the pre-agreed account reporting period. It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period.
- `PRCD` — ISO20022 PreviouslyClosedBooked: Balance of the account at the previously closed account reporting period. The opening booked balance for the new period has to be equal to this balance. Usage: the previously booked closing balance should equal (inclusive date) the booked closing balance of the date it references and equal the actual booked opening balance of the current date.
- `ITAV` — ISO20022 InterimAvailable: Available balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.
- `XPCD` — ISO20022 Expected: Balance, composed of booked entries and pending items known at the time of calculation, which projects the end of day balance if everything is booked on the account and no other entry is posted.
- `VALU` — (None): Value-date balance
- `OTHR` — (None): Other Balance

### 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".

### 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

### 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

### HalAccounts

Type: `object` · Kind: Hal

HYPERMEDIA structure used for returning the list of the available accounts to the AISP

Fields:

- `accounts`, array of [`AccountResource`](#accountresource), required — List of PSU account that are made available to the TPP
- `_links`, [`AccountListLinks`](#accountlistlinks), required

### PsuStatusType

Type: `string` · Kind: ISO20022 · Constraints: maxLength 35

ISO20022: Specifies the type of account ownership.
| Name | Description |
| ---- | ---------- |
| Account Holder | Person which is the sole holder of the account. |
| Account Co-Holder | Person which shares with others the holding of the account. |
| Attorney | Generic case of a person having a mandate to access the account data. |
| Custodian For Minor | Entity that holds shares/units on behalf of a legal minor. Although the account is registered under the name of the minor, the custodian retains control of the account. |
| Legal Guardian | Entity that was appointed by a legal authority to act on behalf of a person judged to be incapacitated. |
| Nominee | Entity named by the beneficial owner to act on its behalf, often to facilitate dealing, or to conceal the identity of the beneficiary. |
| Successor On Death | Deceased's estate, or successor, to whom the respective percentage of ownership will be transferred upon the death of one of the owners. |
| Trustee | Legal owners of the property. However, the beneficiary has the equitable or beneficial ownership. |

### ResourceId

Type: `string` · Kind: Resources · Constraints: pattern `^([a-zA-Z0-9_ /\-?:\()\.,']{1,100})$`

API: Identifier assigned by the ASPSP for further use of the created resource through API calls.
The API client cannot set or modify the value of this field.
Since this value can be exchanged between the server and the client as an URL element or for support information, it must not contain sensitive value such as personal or business data.
However it is the duty of each ASPSP to perform its own risk analysis on this topic.

### 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.
