AISP

get/trusted-beneficiaries

Retrieval of the trusted beneficiaries list (AISP)

OAuth2 scope: aisp

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 (18)

Authorizationheaderstringrequired
Access token to be passed as a header
PSU-IP-Addressheaderstring
IP address used by the PSU's terminal when connecting to the TPP
PSU-IP-Portheaderstring
IP port used by the PSU's terminal when connecting to the TPP
PSU-HTTP-Methodheaderstring
Http method for the most relevant PSU's terminal request to the TTP
PSU-Dateheaderstring
Timestamp of the most relevant PSU's terminal request to the TTP
PSU-GEO-Locationheaderstring
Geographical location of the PSU as provided by the PSU mobile terminal if any to the TPP
PSU-User-Agentheaderstring
"User-Agent" header field sent by the PSU terminal when connecting to the TPP
PSU-Refererheaderstring
"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-Acceptheaderstring
"Accept" header field sent by the PSU terminal when connecting to the TPP
PSU-Accept-Charsetheaderstring
"Accept-Charset" header field sent by the PSU terminal when connecting to the TPP
PSU-Accept-Encodingheaderstring
"Accept-Encoding" header field sent by the PSU terminal when connecting to the TPP
PSU-Accept-Languageheaderstring
"Accept-Language" header field sent by the PSU terminal when connecting to the TPP
PSU-Device-IDheaderstring
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.
Digestheaderstring
Digest of the body
Signatureheaderstring
http-signature of the request 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-IDheaderstringrequired
Correlation header to be set in a request and retrieved in the relevant response
workspacequerystring
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.
X-JWS-Signatureheaderstring
JSON WEB signature of the request

Responses

200

The ASPSP returns the list of whitelisted beneficiaries

Halobject

HalBeneficiaries

HYPERMEDIA structure used for returning the list of the whitelisted beneficiaries

Fields (2)

beneficiariesarray<Beneficiary>required

List of trusted beneficiaries

Item: Beneficiary

workspaceWorkspace
Schema: Workspace
- identificationstringrequired
  identification of the workspace to be used as an optional query parameter for some AISP queries
  Constraints: maxLength: 32
- labelstringrequired
  textual description of the workspace as specified by the ASPSP in relationship wth the PSU
  Constraints: maxLength: 128
idstring
Id of the beneficiary
Constraints: pattern: `^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$`
isTrustedboolean
The ASPSP having not implemented the trusted beneficiaries list must not set this flag.
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

creditorAgentFinancialInstitutionIdentification

Schema: FinancialInstitutionIdentification

bicFistringrequired
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)".
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}$`
clearingSystemMemberIdClearingSystemMemberIdentification
Schema: ClearingSystemMemberIdentification
- clearingSystemIdstringrequired
  ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.
  ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.
  Constraints: maxLength: 35
- memberIdstringrequired
  ISO20022: Identification of a member of a clearing system.
  ISO20022: Identification of a member of a clearing system.
  Constraints: maxLength: 35
leiLeiIdentification
Schema: LeiIdentification
namestring
Name of the financial institution
Constraints: maxLength: 140

postalAddressPostalAddress

Schema: PostalAddress

addressTypestringenum · 6

ISO20022: Identifies the nature of the postal address.

ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.

Code	Name	Description
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

Code	Name	Description
`BIZZ`	—	—
`DLVY`	—	—
`MLTO`	—	—
`PBOX`	—	—
`ADDR`	—	—
`HOME`	—	—

departmentstring
ISO20022: Identification of a division of a large organisation or building.
ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
subDepartmentstring
ISO20022: Identification of a sub-division of a large organisation or building.
ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
streetNamestring
ISO20022: Name of a street or thoroughfare.
ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
buildingNumberstring
ISO20022: Number that identifies the position of a building on a street.
ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
buildingNamestring
ISO20022: Name of the building or house.
ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
postCodestring
ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
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
townNamestring
ISO20022: Name of a built-up area, with defined boundaries, and a local government.
ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
countrySubDivisionstring
ISO20022: Identifies a subdivision of a country such as state, region, county.
ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
countrystringrequired
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.
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})$`
addressLinearray<string>
Unstructured address. The lines must embed zip code and town name.
Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.

creditorPartyIdentificationrequired

Schema: PartyIdentification

namestringrequired
ISO20022: Name by which a party is known and which is usually used to identify that party.
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
dateAndPlaceOfBirthDateAndPlaceOfBirth
Schema: DateAndPlaceOfBirth
- birthDatestring (date)required
  Date on which a person is born.
- cityOfBirthstringrequired
  City where a person was born.
  Constraints: maxLength: 35
- countryOfBirthstringrequired
  Country where a person was born.
  Constraints: pattern: `^[A-Z]{2,2}$`

postalAddressPostalAddress

Schema: PostalAddress

addressTypestringenum · 6

ISO20022: Identifies the nature of the postal address.

ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.

Code	Name	Description
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

Code	Name	Description
`BIZZ`	—	—
`DLVY`	—	—
`MLTO`	—	—
`PBOX`	—	—
`ADDR`	—	—
`HOME`	—	—

departmentstring
ISO20022: Identification of a division of a large organisation or building.
ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
subDepartmentstring
ISO20022: Identification of a sub-division of a large organisation or building.
ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
streetNamestring
ISO20022: Name of a street or thoroughfare.
ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
buildingNumberstring
ISO20022: Number that identifies the position of a building on a street.
ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
buildingNamestring
ISO20022: Name of the building or house.
ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
postCodestring
ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
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
townNamestring
ISO20022: Name of a built-up area, with defined boundaries, and a local government.
ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
countrySubDivisionstring
ISO20022: Identifies a subdivision of a country such as state, region, county.
ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
countrystringrequired
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.
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})$`
addressLinearray<string>
Unstructured address. The lines must embed zip code and town name.
Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.

contactDetailsContactDetails
Schema: ContactDetails
- phoneNumberPhoneNumber
  Schema: PhoneNumber
- faxNumberPhoneNumber
  Schema: PhoneNumber
- emailAddressstring
  email address of the contact
  Constraints: maxLength: 2048 · pattern: `^.+@.+$`

organisationIdGenericIdentification

Schema: GenericIdentification

identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70

schemeNamestringrequired

Name of the identification scheme.

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

issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
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

privateIdGenericIdentification

Schema: GenericIdentification

identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70

schemeNamestringrequired

Name of the identification scheme.

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

issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
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

leiLeiIdentification
Schema: LeiIdentification

creditorAccountAccountIdentification

Schema: AccountIdentification

workspacestring
Workspace to which the account is linked.
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
ibanstring
ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer.
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}$`

otherGenericIdentification

Schema: GenericIdentification

identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70

schemeNamestringrequired

Name of the identification scheme.

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

issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
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

currencyCurrencyCode
Schema: CurrencyCode

_linksBeneficiariesLinksrequired
Schema: BeneficiariesLinks
- selfGenericLinkrequired
  Schema: GenericLink
  hrefstringrequired
  URI to be used. HREF stands for Hypertext REFerence.
  Constraints: maxLength: 2000
  templatedboolean
  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.
  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
- accountsGenericLink
  Schema: GenericLink
  hrefstringrequired
  URI to be used. HREF stands for Hypertext REFerence.
  Constraints: maxLength: 2000
  templatedboolean
  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.
  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
- consentsGenericLink
  Schema: GenericLink
  hrefstringrequired
  URI to be used. HREF stands for Hypertext REFerence.
  Constraints: maxLength: 2000
  templatedboolean
  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.
  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
- endUserIdentityGenericLink
  Schema: GenericLink
  hrefstringrequired
  URI to be used. HREF stands for Hypertext REFerence.
  Constraints: maxLength: 2000
  templatedboolean
  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.
  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
- firstGenericLink
  Schema: GenericLink
  hrefstringrequired
  URI to be used. HREF stands for Hypertext REFerence.
  Constraints: maxLength: 2000
  templatedboolean
  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.
  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
- lastGenericLink
  Schema: GenericLink
  hrefstringrequired
  URI to be used. HREF stands for Hypertext REFerence.
  Constraints: maxLength: 2000
  templatedboolean
  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.
  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
- nextGenericLink
  Schema: GenericLink
  hrefstringrequired
  URI to be used. HREF stands for Hypertext REFerence.
  Constraints: maxLength: 2000
  templatedboolean
  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.
  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
- prevGenericLink
  Schema: GenericLink
  hrefstringrequired
  URI to be used. HREF stands for Hypertext REFerence.
  Constraints: maxLength: 2000
  templatedboolean
  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.
  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

204

No content.

Shared response definition: 204

401

Unauthorized, authentication failure.

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

timestampstring (date-time)
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140
detailsarray<ErrorDetail>
list of detailed errors that were encountered
Item: ErrorDetail
- locationstringenum · 2
  Location of the erroneous parameter when not in request body
  Code Name Description
  header
  — —
  query
  — —
- namestring
  Name of the erroneous parameter when not in request body
- pathstring
  JsonPath of the erroneous request body property
- erroneousValuestring
  Erroneous parameter value
- messagestring
  Relevant message for the erroneous parameter
- expectedPatternstring
  Expected pattern, if any, that the erroneous parameter does not match with
- expectedValueRangeobject
  Expected value range, if any, that the erroneous parameter does not match with
- expectedValueCountobject
  Expected value count, in the case of an array item, that the erroneous parameter does not match with
- expectedEnumerationarray<string>
  Expected enumeration, if any, that the erroneous parameter do not match with

Code	Name	Description
`header`	—	—
`query`	—	—

403

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

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

timestampstring (date-time)
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140
detailsarray<ErrorDetail>
list of detailed errors that were encountered
Item: ErrorDetail
- locationstringenum · 2
  Location of the erroneous parameter when not in request body
  Code Name Description
  header
  — —
  query
  — —
- namestring
  Name of the erroneous parameter when not in request body
- pathstring
  JsonPath of the erroneous request body property
- erroneousValuestring
  Erroneous parameter value
- messagestring
  Relevant message for the erroneous parameter
- expectedPatternstring
  Expected pattern, if any, that the erroneous parameter does not match with
- expectedValueRangeobject
  Expected value range, if any, that the erroneous parameter does not match with
- expectedValueCountobject
  Expected value count, in the case of an array item, that the erroneous parameter does not match with
- expectedEnumerationarray<string>
  Expected enumeration, if any, that the erroneous parameter do not match with

Code	Name	Description
`header`	—	—
`query`	—	—

404

Not found, no request available.

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

timestampstring (date-time)
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140
detailsarray<ErrorDetail>
list of detailed errors that were encountered
Item: ErrorDetail
- locationstringenum · 2
  Location of the erroneous parameter when not in request body
  Code Name Description
  header
  — —
  query
  — —
- namestring
  Name of the erroneous parameter when not in request body
- pathstring
  JsonPath of the erroneous request body property
- erroneousValuestring
  Erroneous parameter value
- messagestring
  Relevant message for the erroneous parameter
- expectedPatternstring
  Expected pattern, if any, that the erroneous parameter does not match with
- expectedValueRangeobject
  Expected value range, if any, that the erroneous parameter does not match with
- expectedValueCountobject
  Expected value count, in the case of an array item, that the erroneous parameter does not match with
- expectedEnumerationarray<string>
  Expected enumeration, if any, that the erroneous parameter do not match with

Code	Name	Description
`header`	—	—
`query`	—	—

405

Method Not Allowed.

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

timestampstring (date-time)
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140
detailsarray<ErrorDetail>
list of detailed errors that were encountered
Item: ErrorDetail
- locationstringenum · 2
  Location of the erroneous parameter when not in request body
  Code Name Description
  header
  — —
  query
  — —
- namestring
  Name of the erroneous parameter when not in request body
- pathstring
  JsonPath of the erroneous request body property
- erroneousValuestring
  Erroneous parameter value
- messagestring
  Relevant message for the erroneous parameter
- expectedPatternstring
  Expected pattern, if any, that the erroneous parameter does not match with
- expectedValueRangeobject
  Expected value range, if any, that the erroneous parameter does not match with
- expectedValueCountobject
  Expected value count, in the case of an array item, that the erroneous parameter does not match with
- expectedEnumerationarray<string>
  Expected enumeration, if any, that the erroneous parameter do not match with

Code	Name	Description
`header`	—	—
`query`	—	—

406

Not Acceptable.

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

timestampstring (date-time)
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140
detailsarray<ErrorDetail>
list of detailed errors that were encountered
Item: ErrorDetail
- locationstringenum · 2
  Location of the erroneous parameter when not in request body
  Code Name Description
  header
  — —
  query
  — —
- namestring
  Name of the erroneous parameter when not in request body
- pathstring
  JsonPath of the erroneous request body property
- erroneousValuestring
  Erroneous parameter value
- messagestring
  Relevant message for the erroneous parameter
- expectedPatternstring
  Expected pattern, if any, that the erroneous parameter does not match with
- expectedValueRangeobject
  Expected value range, if any, that the erroneous parameter does not match with
- expectedValueCountobject
  Expected value count, in the case of an array item, that the erroneous parameter does not match with
- expectedEnumerationarray<string>
  Expected enumeration, if any, that the erroneous parameter do not match with

Code	Name	Description
`header`	—	—
`query`	—	—

429

Too many requests.

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

timestampstring (date-time)
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140
detailsarray<ErrorDetail>
list of detailed errors that were encountered
Item: ErrorDetail
- locationstringenum · 2
  Location of the erroneous parameter when not in request body
  Code Name Description
  header
  — —
  query
  — —
- namestring
  Name of the erroneous parameter when not in request body
- pathstring
  JsonPath of the erroneous request body property
- erroneousValuestring
  Erroneous parameter value
- messagestring
  Relevant message for the erroneous parameter
- expectedPatternstring
  Expected pattern, if any, that the erroneous parameter does not match with
- expectedValueRangeobject
  Expected value range, if any, that the erroneous parameter does not match with
- expectedValueCountobject
  Expected value count, in the case of an array item, that the erroneous parameter does not match with
- expectedEnumerationarray<string>
  Expected enumeration, if any, that the erroneous parameter do not match with

Code	Name	Description
`header`	—	—
`query`	—	—

500

Internal server error.

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

timestampstring (date-time)
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140
detailsarray<ErrorDetail>
list of detailed errors that were encountered
Item: ErrorDetail
- locationstringenum · 2
  Location of the erroneous parameter when not in request body
  Code Name Description
  header
  — —
  query
  — —
- namestring
  Name of the erroneous parameter when not in request body
- pathstring
  JsonPath of the erroneous request body property
- erroneousValuestring
  Erroneous parameter value
- messagestring
  Relevant message for the erroneous parameter
- expectedPatternstring
  Expected pattern, if any, that the erroneous parameter does not match with
- expectedValueRangeobject
  Expected value range, if any, that the erroneous parameter does not match with
- expectedValueCountobject
  Expected value count, in the case of an array item, that the erroneous parameter does not match with
- expectedEnumerationarray<string>
  Expected enumeration, if any, that the erroneous parameter do not match with

Code	Name	Description
`header`	—	—
`query`	—	—

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.

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

timestampstring (date-time)
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140
detailsarray<ErrorDetail>
list of detailed errors that were encountered
Item: ErrorDetail
- locationstringenum · 2
  Location of the erroneous parameter when not in request body
  Code Name Description
  header
  — —
  query
  — —
- namestring
  Name of the erroneous parameter when not in request body
- pathstring
  JsonPath of the erroneous request body property
- erroneousValuestring
  Erroneous parameter value
- messagestring
  Relevant message for the erroneous parameter
- expectedPatternstring
  Expected pattern, if any, that the erroneous parameter does not match with
- expectedValueRangeobject
  Expected value range, if any, that the erroneous parameter does not match with
- expectedValueCountobject
  Expected value count, in the case of an array item, that the erroneous parameter does not match with
- expectedEnumerationarray<string>
  Expected enumeration, if any, that the erroneous parameter do not match with

Code	Name	Description
`header`	—	—
`query`	—	—

Schemas used by this endpoint

Every structure referenced by this operation, listed once. Cross-references resolve to anchors on this page.

ISO20022object§ 4.1.1 · PDF p. 2

AccountIdentification

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 (4)

workspacestring
Workspace to which the account is linked.
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
ibanstring
ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer.
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}$`
otherGenericIdentification
Schema: GenericIdentification
currencyCurrencyCode
Schema: CurrencyCode

Halobject

BeneficiariesLinks

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 (8)

selfGenericLinkrequired
Schema: GenericLink
accountsGenericLink
Schema: GenericLink
consentsGenericLink
Schema: GenericLink
endUserIdentityGenericLink
Schema: GenericLink
firstGenericLink
Schema: GenericLink
lastGenericLink
Schema: GenericLink
nextGenericLink
Schema: GenericLink
prevGenericLink
Schema: GenericLink

Resourcesobject

Beneficiary

Specification of a beneficiary

Fields (6)

workspaceWorkspace
Schema: Workspace
idstring
Id of the beneficiary
Constraints: pattern: `^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$`
isTrustedboolean
The ASPSP having not implemented the trusted beneficiaries list must not set this flag.
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
creditorAgentFinancialInstitutionIdentification
Schema: FinancialInstitutionIdentification
creditorPartyIdentificationrequired
Schema: PartyIdentification
creditorAccountAccountIdentification
Schema: AccountIdentification

ISO20022object

ClearingSystemMemberIdentification

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 (2)

clearingSystemIdstringrequired
ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.
ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.
Constraints: maxLength: 35
memberIdstringrequired
ISO20022: Identification of a member of a clearing system.
ISO20022: Identification of a member of a clearing system.
Constraints: maxLength: 35

ISO20022object

ContactDetails

Indicates how to contact the party.

Fields (3)

phoneNumberPhoneNumber
Schema: PhoneNumber
faxNumberPhoneNumber
Schema: PhoneNumber
emailAddressstring
email address of the contact
Constraints: maxLength: 2048 · pattern: `^.+@.+$`

ISO20022string

CurrencyCode

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

ISO20022object

DateAndPlaceOfBirth

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 (3)

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

Technicalobject

ErrorDetail

detailed error description

Fields (9)

locationstringenum · 2
Location of the erroneous parameter when not in request body
Code Name Description
header
— —
query
— —
namestring
Name of the erroneous parameter when not in request body
pathstring
JsonPath of the erroneous request body property
erroneousValuestring
Erroneous parameter value
messagestring
Relevant message for the erroneous parameter
expectedPatternstring
Expected pattern, if any, that the erroneous parameter does not match with
expectedValueRangeobject
Expected value range, if any, that the erroneous parameter does not match with
expectedValueCountobject
Expected value count, in the case of an array item, that the erroneous parameter does not match with
expectedEnumerationarray<string>
Expected enumeration, if any, that the erroneous parameter do not match with

Code	Name	Description
`header`	—	—
`query`	—	—

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

timestampstring (date-time)
current timestamp
statusinteger (int32)required
HTTP error code
errorstring
HTTP error text
Constraints: maxLength: 140
messagestringrequired
HTTP textual reason phrase
Constraints: maxLength: 140
pathstring
Relevant path that was used
Constraints: maxLength: 140
detailsarray<ErrorDetail>
list of detailed errors that were encountered
Item schema: ErrorDetail

ISO20022object§ 4.1.5 · PDF p. 12

FinancialInstitutionIdentification

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

Fields (5)

bicFistringrequired
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)".
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}$`
clearingSystemMemberIdClearingSystemMemberIdentification
Schema: ClearingSystemMemberIdentification
leiLeiIdentification
Schema: LeiIdentification
namestring
Name of the financial institution
Constraints: maxLength: 140
postalAddressPostalAddress
Schema: PostalAddress

ISO20022object§ 4.1.6 · PDF p. 14

GenericIdentification

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 (3)

identificationstringrequired
API: Identifier
API: Identifier
Constraints: maxLength: 70

schemeNamestringrequired

Name of the identification scheme.

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

issuerstring
ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties
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

Halobject§ 4.1.7 · PDF p. 15

GenericLink

hypertext reference

Fields (2)

hrefstringrequired
URI to be used. HREF stands for Hypertext REFerence.
Constraints: maxLength: 2000
templatedboolean
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.
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

Halobject

HalBeneficiaries

HYPERMEDIA structure used for returning the list of the whitelisted beneficiaries

Fields (2)

beneficiariesarray<Beneficiary>required
List of trusted beneficiaries
Item schema: Beneficiary
_linksBeneficiariesLinksrequired
Schema: BeneficiariesLinks

ISO20022string

LeiIdentification

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

ISO20022object§ 4.1.8 · PDF p. 15

PartyIdentification

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

Fields (7)

namestringrequired
ISO20022: Name by which a party is known and which is usually used to identify that party.
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
dateAndPlaceOfBirthDateAndPlaceOfBirth
Schema: DateAndPlaceOfBirth
postalAddressPostalAddress
Schema: PostalAddress
contactDetailsContactDetails
Schema: ContactDetails
organisationIdGenericIdentification
Schema: GenericIdentification
privateIdGenericIdentification
Schema: GenericIdentification
leiLeiIdentification
Schema: LeiIdentification

ISO20022string

PhoneNumber

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

ISO20022object

PostalAddress

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

Fields (11)

addressTypestringenum · 6

ISO20022: Identifies the nature of the postal address.

ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.

Code	Name	Description
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

Code	Name	Description
`BIZZ`	—	—
`DLVY`	—	—
`MLTO`	—	—
`PBOX`	—	—
`ADDR`	—	—
`HOME`	—	—

departmentstring
ISO20022: Identification of a division of a large organisation or building.
ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
subDepartmentstring
ISO20022: Identification of a sub-division of a large organisation or building.
ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
streetNamestring
ISO20022: Name of a street or thoroughfare.
ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.
Constraints: maxLength: 70
buildingNumberstring
ISO20022: Number that identifies the position of a building on a street.
ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
buildingNamestring
ISO20022: Name of the building or house.
ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.
Constraints: maxLength: 16
postCodestring
ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
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
townNamestring
ISO20022: Name of a built-up area, with defined boundaries, and a local government.
ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
countrySubDivisionstring
ISO20022: Identifies a subdivision of a country such as state, region, county.
ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.
Constraints: maxLength: 35
countrystringrequired
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.
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})$`
addressLinearray<string>
Unstructured address. The lines must embed zip code and town name.
Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.

object

Workspace

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 (2)

identificationstringrequired
identification of the workspace to be used as an optional query parameter for some AISP queries
Constraints: maxLength: 32
labelstringrequired
textual description of the workspace as specified by the ASPSP in relationship wth the PSU
Constraints: maxLength: 128