Obtenir l'identité du client
➤ Cas d'usage
Ce service permet de récupérer l’identité d'un client qui vous a donné son consentement pour le faire.
Les accès à cette méthode sont limités à 4 accès batch maximum par jour calendaire, pour un PSU donné.
En résumé, ce service permet de récupérer l’identité du PSU.
➤ Prérequis
Pour procéder à cette requête il est nécessaire de remplir les prérequis d’éligibilité et d'avoir récupéré le jeton d'accès OAUTH2 (voir la rubrique "Vue d'ensemble" > "Récupérer votre jeton").
Pour récupérer l'identité d'un PSU :
L'autorisation de transmettre au TPP ces informations d’identité doit nous avoir été transmis via la valorisation à true de l’attribut "psuIdentity" de la méthode PUT /consents et ne doit pas avoir été révoqué depuis (c’est à dire pas d'annule et remplace via PUT /consents avec un attribut "psuIdentity" valorisé à false) ;
L'URI pour l'accès à cette méthode est donnée via la rubrique "_links": {"endUserIdentity": {"href": ...}} en résultat de la requête GET /accounts.
➤ Requête
GET /end-user-identity
Voir aussi la spécification de place STET V1.4.2.17 / Part II / section 4.6.4 / page 43
➤ Paramètres obligatoires ou facultatifs du body requis pour l'appel de ce service
Paramètres obligatoires : PSU-IP-ADDRESS => à alimenter si le PSU est connecté.
➤ Résultat retourné
Cet appel permet de récupérer l'identité du client final.
Un lien self sera également pour revenir à la page obtenue après exécution de la requête.
Vos accès à cette méthode sont limités à 4 accès batch maximum par jour calendaire, pour un client. En revanche, lorsque c'est le client connecté qui interroge directement ses comptes à vue, le nombre d'accès n'est pas limité.
➤ Exemple
Requête
GET /stet/psd2/v1.4.2/end-user-identity
Un exemple plus complet de requête est fourni dans la rubrique "Comment tester l'API ?" > "Assemblage sandbox".
Voir aussi la spécification de place STET V1.4.2.17 / Part III / Section 6.3 / page 8
Résultat
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" } } } |
(cas du persona Marc - D0999990I0)
Codes erreurs
Voici la liste de descriptions des codes erreurs de ce service. Il y a une annotation pour ceux étant définis CFONB.
Lien vers la description de la méthode et des codes retour http
Erreur | Description de l'erreur |
---|---|
BE05 (CFONB) | UnrecognisedInitiatingParty : l'AISP est inconnu |
BADS | BadScope : l'appel au service a été fait avec un jeton CBPII (AISP attendu) |
INTE | InternalError : il y a une erreur interne de traitement |
INTS | InternalServerError : il y a une erreur interne de communication avec le SI |
NIMP | NotImplemented : le mauvais verbe est appelé (GET attendu) |
IPSU | InvalidPSU : Numéro d'abonné non référencé ou abonnement banque à distance résilié |
➤ Test d'acceptance
Ces cas de tests ont pour objectif de vous permettre d'effectuer un minimum de tests afin de prendre en main cette API et d'y accéder depuis votre application.
Description du test | Jeu de données |
---|---|
Récupération de l'identité de l'utilisateur | Persona : Marc - D0999990I0 Prérequis : scope OAuth2 = aisp Résultat : réponse HTTP 200 => OK |
Récupération de l’identité de l’utilisateur qui n’a pas donné son consentement pour cela | Persona : Tech’n Co - D0999993I0 Prérequis : scope OAuth2 = aisp Résultat : réponse HTTP 403 => accès à la ressource refusé |