Halobject

HalOwners

HYPERMEDIA structure used for returning the identities of the account owners. These owners are either real persons or a company.

in the first case, the [identities] block must be used
in the second cas, the [company] property specifies the identity of the company owning the account.

Fields (3)

companyGenericIdentification

ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer.

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
  DOCT
  Doctor
  MADM
  Madam
  MISS
  Miss
  MIST
  Mister
- firstNamestring
  First name
  First name
  Constraints: maxLength: 70
- lastNamestring
  Last name
  Last name
  Constraints: maxLength: 70

Code	Description
`DOCT`	Doctor
`MADM`	Madam
`MISS`	Miss
`MIST`	Mister

_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
  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
parent-listGenericLink
hypertext reference
Schema: GenericLink
hypertext reference
- 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
balancesGenericLink
hypertext reference
Schema: GenericLink
hypertext reference
- 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
transactionsGenericLink
hypertext reference
Schema: GenericLink
hypertext reference
- 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
overdraftsGenericLink
hypertext reference
Schema: GenericLink
hypertext reference
- 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