Halobject

HalEndUserIdentity

HYPERMEDIA structure used for returning the identity of the PSU. The [identity] property specifies the identity of the PSU which has granted access to the AISP on the accounts data This information can be retrieved based on the PSU's authentication that occurred during the OAUTH2 access token initialisation.

Fields (2)

identityIdentityrequired
HYPERMEDIA structure used for returning the identity of the PSU
Schema: 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
_linksEndUserIdentityLinksrequired
links that can be used for further navigation after retrieving end-user identity
Schema: EndUserIdentityLinks
links that can be used for further navigation after retrieving end-user identity

Link Description
self link to the end-user identity
accounts link to the list of all available accounts
consents link to the consents forwarding
trustedBeneficiaries link to the list of trusted beneficiaries
- 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
- accountsGenericLink
  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
- consentsGenericLink
  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
- trustedBeneficiariesGenericLink
  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

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

Link	Description
self	link to the end-user identity
accounts	link to the list of all available accounts
consents	link to the consents forwarding
trustedBeneficiaries	link to the list of trusted beneficiaries