get/accounts/{accountResourceId}/owners
Retrieval of an account owners (AISP)
OAuth2 scopes: aisp, aisp
Description
This call returns the owners identities for a given PSU account that is specified by the AISP through an account resource identification. This call cannot be used when the account is owned by a legal entity where the identity of this entity is directly available in the account structure (field [company]).
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. § 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. § 3.4.2) is any.
- The ASPSP takes into account the access token that establishes the link between the PSU and the AISP.
- The TPP has previously retrieved the list of available accounts for the PSU
Business flow
The AISP requests the ASPSP on one of the PSU’s accounts. The ASPSP answers by the identities of the account owners.
Parameters (18)
- Authorizationheaderstringrequired
Access token to be passed as a header
- accountResourceIdpathstringrequired
Identification of account resource to fetch
Constraints: pattern: ^([a-zA-Z0-9_ /\-?:\()\.,']{1,100})$
- 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
- Signatureheaderstringrequired
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
Constraints: maxLength: 70
- 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.
Constraints: maxLength: 32
Responses
200
Account owners identities response
HalOwners
HYPERMEDIA structure used for returning the identities of the account owners. These owners are either real persons or a company
Fields (3)
- companyGenericIdentification
specifies the identity of the company owning the account.
specifies the identity of the company owning the account.
Schema: 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.
- 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
- identitiesarray<Identity>
identity of the account owners.
identity of the account owners.
Item: Identity
HYPERMEDIA structure used for returning the identity of the PSU
- fullNamestringrequired
Last name and first name
Last name and first name
Constraints: maxLength: 140
- namePrefixNamePrefixCode
Specifies the terms used to formally address a person.
Schema: NamePrefixCode
Code Description DOCTDoctor MADMMadam MISSMiss MISTMister - firstNamestring
First name
First name
Constraints: maxLength: 70
- lastNamestring
Last name
Last name
Constraints: maxLength: 70
- _linksOwnersLinksrequired
links that can be used for further navigation when browsing balances Information at one account level
Schema: OwnersLinks
links that can be used for further navigation when browsing balances Information at one account level
Link Description self link to the owners of a given account parent-list link to the list of all available accounts balances link to the balances for a given account transactions link to the transactions of a given account overdrafts link to the lists of overdrafts of a given account - selfGenericLinkrequired
hypertext reference
Schema: GenericLink
hypertext reference
- hrefstringrequired
URI to be used. HREF stands for Hypertext REFerence.
Constraints: maxLength: 2000
- templatedboolean
specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
- parent-listGenericLink
hypertext reference
Schema: GenericLink
hypertext reference
- hrefstringrequired
URI to be used. HREF stands for Hypertext REFerence.
Constraints: maxLength: 2000
- templatedboolean
specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
- balancesGenericLink
hypertext reference
Schema: GenericLink
hypertext reference
- hrefstringrequired
URI to be used. HREF stands for Hypertext REFerence.
Constraints: maxLength: 2000
- templatedboolean
specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
- transactionsGenericLink
hypertext reference
Schema: GenericLink
hypertext reference
- hrefstringrequired
URI to be used. HREF stands for Hypertext REFerence.
Constraints: maxLength: 2000
- templatedboolean
specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
- overdraftsGenericLink
hypertext reference
Schema: GenericLink
hypertext reference
- hrefstringrequired
URI to be used. HREF stands for Hypertext REFerence.
Constraints: maxLength: 2000
- templatedboolean
specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
204
No content.
Shared response definition: 204
400
Invalid status value
Error400Model
Specific 400 error report structure
Fields (6)
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
- acceptedAuthenticationApproachAuthenticationApproaches
Can only be set by the ASPSP
Can only be set by the ASPSP Authentication approaches that are supported by the ASPSP. The PISP can provide several choices separated by commas.
Schema: AuthenticationApproach
Code REDIRECTDECOUPLEDEMBEDDED-1-FACTORNONE
401
Unauthorized, authentication failure.
ErrorModel
Generic error report structure
Fields (5)
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
403
Forbidden, authentication successful but access to resource is not allowed.
ErrorModel
Generic error report structure
Fields (5)
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
404
Not found, no request available.
ErrorModel
Generic error report structure
Fields (5)
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
405
Method Not Allowed.
ErrorModel
Generic error report structure
Fields (5)
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
406
Not Acceptable.
ErrorModel
Generic error report structure
Fields (5)
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
408
Request Timeout.
ErrorModel
Generic error report structure
Fields (5)
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
429
Too many requests.
ErrorModel
Generic error report structure
Fields (5)
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
500
Internal server error.
ErrorModel
Generic error report structure
Fields (5)
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
503
Service unavailable.
ErrorModel
Generic error report structure
Fields (5)
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
Schemas used by this endpoint
Every structure referenced by this operation, listed once. Cross-references resolve to anchors on this page.
AuthenticationApproach
Authentication approaches that can be applied. REDIRECT: the PSU is redirected by the TPP to the ASPSP which processes identification and authentication DECOUPLED: the TPP identifies the PSU and forwards the identification to the ASPSP which processes the authentication through a decoupled device EMBEDDED-1-FACTOR: the TPP identifies the PSU and forwards the identification to the ASPSP which starts the authentication. The TPP forwards one authentication factor of the PSU (e.g. OTP or response to a challenge) NONE: there is no need for the PSU to authenticate
| Code |
|---|
REDIRECT |
DECOUPLED |
EMBEDDED-1-FACTOR |
NONE |
AuthenticationApproaches
List of authentication approaches
Items: AuthenticationApproach
Error400Model
Specific 400 error report structure
Fields (6)
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
- acceptedAuthenticationApproachAuthenticationApproaches
Can only be set by the ASPSP
Can only be set by the ASPSP Authentication approaches that are supported by the ASPSP. The PISP can provide several choices separated by commas.
Schema: AuthenticationApproaches
ErrorModel
Generic error report structure
Fields (5)
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
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
GenericLink
hypertext reference
Fields (2)
- hrefstringrequired
URI to be used. HREF stands for Hypertext REFerence.
Constraints: maxLength: 2000
- templatedboolean
specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false
HalOwners
HYPERMEDIA structure used for returning the identities of the account owners. These owners are either real persons or a company
Fields (3)
- companyGenericIdentification
specifies the identity of the company owning the account.
specifies the identity of the company owning the account.
Schema: GenericIdentification
- identitiesarray<Identity>
identity of the account owners.
identity of the account owners.
Item: Identity
- _linksOwnersLinksrequired
Schema: OwnersLinks
Identity
HYPERMEDIA structure used for returning the identity of the PSU
Fields (4)
- fullNamestringrequired
Last name and first name
Last name and first name
Constraints: maxLength: 140
- namePrefixNamePrefixCode
Schema: NamePrefixCode
- firstNamestring
First name
First name
Constraints: maxLength: 70
- lastNamestring
Last name
Last name
Constraints: maxLength: 70
NamePrefixCode
Specifies the terms used to formally address a person. This field accepts the following code values
| Code | Description |
|---|---|
DOCT | Doctor |
MADM | Madam |
MISS | Miss |
MIST | Mister |
OwnersLinks
links that can be used for further navigation when browsing balances Information at one account level
| Link | Description |
|---|---|
| self | link to the owners of a given account |
| parent-list | link to the list of all available accounts |
| balances | link to the balances for a given account |
| transactions | link to the transactions of a given account |
| overdrafts | link to the lists of overdrafts of a given account |
Fields (5)
- selfGenericLinkrequired
Schema: GenericLink
- parent-listGenericLink
Schema: GenericLink
- balancesGenericLink
Schema: GenericLink
- transactionsGenericLink
Schema: GenericLink
- overdraftsGenericLink
Schema: GenericLink