---
title: "Retrieval of the identity of the end-user (AISP)"
method: GET
path: "/end-user-identity"
tags: ["AISP"]
---

# Retrieval of the identity of the end-user (AISP)

`GET /end-user-identity`

## Request

- Base URL: `https://www.10207.oba-bad-me-live-api.banquepopulaire.fr/stet/psd2/v1.6.2`
- URL: `https://www.10207.oba-bad-me-live-api.banquepopulaire.fr/stet/psd2/v1.6.2/end-user-identity`
- Auth: OAuth 2
  - Authorization code: `/stet/psd2/oauth/authorize`
  - Token URL: `/stet/psd2/oauth/token` scopes: `aisp`

### Description
This call returns the identity of the PSU (end-user).
### 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) 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 identity of the PSU.
  The ASPSP answers with the identity, i.e. first and last names of the end-user.

## Headers

- `Authorization` string, required
- `PSU-IP-Address` string
- `PSU-IP-Port` string
- `PSU-HTTP-Method` string
- `PSU-Date` string
- `PSU-GEO-Location` string
- `PSU-User-Agent` string
- `PSU-Referer` string
- `PSU-Accept` string
- `PSU-Accept-Charset` string
- `PSU-Accept-Encoding` string
- `PSU-Accept-Language` string
- `PSU-Device-ID` string
- `Digest` string
- `Signature` string, required
- `X-Request-ID` string, required

## Response `200`

The ASPSP returns the identity of the PSU

- 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.
  - `identity` Identity, required: HYPERMEDIA structure used for returning the identity of the PSU
    - `fullName` string, required: Last name and first name
    - `namePrefix` 'DOCT' | 'MADM' | 'MISS' | 'MIST': 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 |
    - `firstName` string: First name
    - `lastName` string: Last name
  - `_links` EndUserIdentityLinks, required: 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 |
    - `self` GenericLink, required: hypertext reference
      - `href` string, required: URI to be used. HREF stands for Hypertext REFerence.
      - `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
    - `accounts` GenericLink: hypertext reference
      - `href` string, required: URI to be used. HREF stands for Hypertext REFerence.
      - `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
    - `consents` GenericLink: hypertext reference
      - `href` string, required: URI to be used. HREF stands for Hypertext REFerence.
      - `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
    - `trustedBeneficiaries` GenericLink: hypertext reference
      - `href` string, required: URI to be used. HREF stands for Hypertext REFerence.
      - `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

## Other responses

- `204`: No content.
- `401`: Unauthorized, authentication failure.
- `403`: Forbidden, authentication successful but access to resource is not allowed.
- `404`: Not found, no request available.
- `405`: Method Not Allowed.
- `406`: Not Acceptable.
- `429`: Too many requests.
- `500`: Internal server error.

---

[API](https://skmtc.dev/groupebpce/apis/accounts-information.md) - [All operations](https://skmtc.dev/groupebpce/apis/accounts-information/llms.txt) - [OpenAPI document](https://skmtc.dev/groupebpce/apis/accounts-information/revisions/1e8366574497?raw)