Get PSU's identity

Use case

This service allows you to retrieve the customer's identity who has given you their consent to do so.

Access to this method are limited to a maximum of 4 batch accesses per calendar day, for a given PSU.

To sum up, this service allows you to recover the identity of the PSU.

 

Prerequisite

To proceed with this request, it is necessary to fulfill the eligibility prerequisites and to have retrieved the OAUTH2 access token (see in the section "Overview"  > "Get your access token").

To get the PSU's identity, you need :

  • The authorization to transmit this identity information to the TPP must have been transmitted to us via the setting to true of the "psuIdentity" attribute of the PUT /consents method and must not have since been revoked (i.e. not cancel and replace via PUT /consents with a "psuIdentity" attribute set to false);

  • The URI to access this method is given through the "_links": {"endUserIdentity": {"href": ...}} item as a result to the GET /accounts request.

  

Request

GET /end-user-identity

book picto See also specification STET V1.4.2.17 / Part II / section 4.6.4 / page 43 



Mandatory or optional settings of the body required to call this service

Mandatory settings : PSU-IP-ADDRESS => to inform if the PSU is connected.

  

Returned result

This call allows you to get the identity of the end customer

A self link will also be available to return to the page obtained after execution of the request.

Your access to this method are limited to a maximum of 4 batch accesses per calendar day, for a customer. However, when it is the connected customer who directly interrogates his current accounts, the number of accesses is not limited.

  

Example

Request

GET /stet/psd2/v1.4.2/end-user-identity

A more complete example of a a query is provided in the "Sandbox assembly" use case.

book picto See also specification STET V1.4.2.17 / Part III / Section 6.3 / page 8

Result

Status code : 200

  

Body

{

    "connectedPsuNamePrefix": "MIST",

    "connectedPsu": "MALLOW MARC",

    "connectedPsuFirstName": "Marc",

    "connectedPsuLastName": "MALLOW",

    "_links": {

        "self": {

            "href": "https://www.<cdetab>.sandbox.api.89C3.com/stet/psd2/v1.4.2/end-user-identity"

        },

        "parent-list": {

            "href": "https://www.<cdetab>.sandbox.api.89C3.com/stet/psd2/v1.4.2/accounts"

        }

    }

}

(data set Marc's persona - D0999990I0)

  

Error codes

Here is the list of descriptions of the error codes for this service. There is an annotation for those being defined CFONB.

Link to the description of the method and return codes http

ErrorDescription of the error
BE05
(CFONB)

UnrecognisedInitiatingParty : AISP is recognised
BADS BadScope : the service call was made with a CBPII token (expected AISP)
INTE InternalError : there is an internet treatment error
INTS InternalServerError : there is an internet communication error with the IS
NIMP NotImplemented : the wrong verb is called (GET expected)
IPSU InvalidPSU : Subscirber number nos listed or remote banking subscription terminated

  

Acceptance tests

These test cases are intended to allow you to perform a minimum of tests to get started with this API and access it from your application.

Description of the testData

User identity recovery

Persona :

Marc - D0999990I0

Prerequisites : 

scope OAuth2 = aisp

Results :

HTTP answer 200 => OK

Recovery of the identity of the user who has not given their consent for this

Persona :

Tech’n Co - D0999993I0

Prerequisites : 

scope OAuth2 = aisp

Results :

HTTP answer 403 => access to the ressource denied