Intégrez les versions FranceConnectées des API Particulier pour proposer cette modalité d’appel et accélérer les démarches de vos usagers.
Pour accéder aux données de l’API Particulier, votre service doit fournir des paramètres permettant d’identifier le particulier dont vous souhaitez récupérer les données.
Du côté de l’usager qui utilise votre service, cela signifie qu’il va devoir communiquer des informations le concernant, pour bénéficier de l’accès à ses données personnelles par le biais de l’API Particulier.
Les données d’API Particulier peuvent être appelées par le biais de trois modalités d’appel :
Par conséquent, dans le cas de la modalité d’appel FranceConnect, l’usager, en cliquant sur le bouton FranceConnect, permet à FranceConnect de transmettre ses informations pour appeler l’API. L’identité pivot de l’usager ne transitera pas par votre système d’information, ce qui constitue un avantage d’un point de vue de la sécurité des données personnelles.
Le périmètre de la modalité d’appel FranceConnect est étendu à plus 40 millions d’usagers uniques actifs.
Une alternative d’appel est donc obligatoire afin de ne pas exclure les usagers qui n’utilisent pas FranceConnect ou qui ne sont pas éligibles.
Les particuliers suivants ne peuvent pas utiliser FranceConnect :
Par ailleurs, toutes les API du bouquet API Particulier ne bénéficient pas de la modalité d’appel FranceConnect :
API du bouquet API Particulier | Modalité d’appel Identité pivot ou Indentifiant |
Modalité d’appel FranceConnect |
---|---|---|
Quotient familial MSA & CAF - Cnaf & msa Fiche métier |
Identité pivot | |
Statut étudiant - Mesri Fiche métier |
Identité pivot & Identifiant INE | |
Statut étudiant boursier - Cnous Fiche métier |
Identité pivot & Identifiant INE | |
Statut élève scolarisé et boursier - Ministère de l’éducation nationale Fiche métier |
Identité pivot | ❌ N’est pas FranceConnectée |
Statut demandeur d’emploi - France Travail Fiche métier |
Identifiant France Travail | ❌ FranceConnect sur API Particulier ✅ FranceConnect en dehors du bouquet avec l’API statut demandeur d’emploi |
Paiements versés par France Travail - France Travail Fiche métier |
Identifiant France Travail | ❌ FranceConnect sur API Particulier ✅ FranceConnect en dehors du bouquet avec l’API Indemnisation France Travail |
Complémentaire santé solidaire - La sécurité sociale Fiche métier |
Identité pivot |
Pour vos usagers, proposer la modalité d’appel FranceConnect, c’est :
Pour votre service et vos agents, proposer la modalité d’appel FranceConnect, c’est :
Plutôt que de renseigner ses données personnelles dans différents champs de saisie, vos usagers auront simplement à utiliser les boutons FranceConnect pour récupérer leurs données API Particulier. L’appel aux données de l’API Particulier par le biais de FranceConnect peut se faire à deux moments différents de la démarche en ligne :
Au moment de la connexion :
En cliquant sur le bouton “S’identifier avec FranceConnect”, les données API Particulier nécessaires sont téléchargées en parallèle de l’authentification de l’usager.
ℹ️ L’utilisation de la modalité d’appel FranceConnect pour récupérer les données de l’API Particulier n’oblige pas votre service à utiliser FranceConnect comme mode d’identification de vos comptes utilisateurs. Vous pourrez alors utiliser le second bouton ci-contre.
Au cours de la démarche, après la connexion :
⏳ Si cette nouvelle demande de donnée intervient dans les 30 minutes après la première FranceConnexion, l'usager n'aura pas à se reconnecter. Il n'aura qu'une seule étape à faire : confirmer le transfert de ses données.
📟 D’un point de vue technique, ces deux boutons sont identiques et nécessitent la même intégration. Consulter la documentation technique de FranceConnect
Ce schéma présente les interractions entre les différents acteurs impliqués dans les API Particulier FranceConnectées et leur utilisation par l’usager durant vos démarches :
Étape 1 : Le particulier entame sa démarche sur votre service.
Étape 2 : Pour récupérer ses données API Particulier, il clique sur le bouton FranceConnect “S’identifier avec FranceConnect” ou “Récupérer mes données avec FranceConnect”.
Étape 3 : La fenêtre FranceConnect s’ouvre, l’usager choisit sur la mire son fournisseur d’identité ; par exemple le compte impots.gouv.fr, le compte Ameli ou l’Identité numérique de la Poste. L’usager entre alors son identifiant et son mot de passe du compte choisit. Plus d’information sur les fédérateurs d’identité de FranceConnect.
⚙️ En arrière plan : Votre système d’information demande à FranceConnect un accès à la donnée personnelle de l’usager.
Étape 4 : L’usager confirme le transfert de ses données personnelles en cliquant sur “Continuer”.
⚙️ En arrière plan :
1. FranceConnect affiche à l’usager la liste de ses données personnelles, dont celles d’API Particulier, qui vont être transmises à votre service si il continue. Lorsque l’usager clique sur “Continuer”., FranceConnect récupère la confirmation de l’usager.
2. FranceConnect donne un jeton de consentement à votre Système d’information (SI).
3. Votre SI utilise ce jeton pour appeler l’API Particulier.
4. API particulier transmet le jeton à FranceConnect.
5. FC vérifie le jeton et retourne l’identité pivot et le périmètre des données demandées par votre service.
6. Avec l’identité pivot, API Particulier demande les données à l’administration fournisseur des données (FD) présentent sur API Particulier.
7. Le FD retourne les données du particulier à API Particulier.
8. API Particulier transmet les données du particulier à votre SI.
Étape 5 : Les données API Particulier de l’usager sont renseignées dans votre démarche.
Modalité d’appel Identité pivot ou Indentifiant |
Modalité d’appel FranceConnect |
|
---|---|---|
Action de l’usager | L’usager renseigne ses informations identifiantes | L’usager se connecte à FranceConnect |
Authentification de l’usager | ❌ À vérifier par vos agents | ✅ Comprise avec la connexion |
Délivrance instantanée de la donnée API Particulier | ❌ Uniquement après vérification de l’identité de l’internaute par vos agents | ✅ Oui |
Moins de données personnelles dans votre système d’information | ❌ Les données personnelles renseignées par l’usager pour appeler l’API Particulier transitent par votre SI | ✅ L’identité pivot ne transite pas par vos systèmes |
Périmètre des usagers couverts | ✅ La totalité | ⚠️ Seulement les usagers ayant FranceConnect |
Démonstrateur API Particulier | Kevin bénéficie du tarif réduit pour la cantine de ses enfants, grâce à API Particulier. Il renseigne son identité pivot Voir la démo |
Camille bénéficie du tarif réduit pour la cantine de ses enfants, grâce à API Particulier. Elle utilise la modalité d’appel FranceConnect Voir la démo |
Cas n°1 : Mon éditeur propose déjà les API Particulier FranceConnectées :
Si votre éditeur a déjà intégré la modalité d’appel FranceConnect pour API Particulier, cela signifie que l’intégration technique est déjà disponible et que le logiciel de votre éditeur a déjà été certifié par FranceConnect. Il ne manque que les droits d’accès aux données, que votre service (et non votre éditeur) doit demander :
Cas n°2 : Mon éditeur n’a pas encore intégré les API Particulier FranceConnectées :
Contactez-nous à api-particulier@api.gouv.fr en mentionnant le nom de votre éditeur et ses coordonnées, nous prendrons attache avec lui.
Votre service implémente lui-même les API Particulier FranceConnectée ? Pour y accéder, vous devez être habilité à FranceConnect et à API Particulier. Voici les étapes :
client_id
par mail et le client_secret
par SMS.Attention, en tant qu’éditeur, vous ne pouvez en aucun cas être destinataire des données issues de l’API Particulier et de FranceConnect.
Vous éditez un logiciel pour un service public et vous souhaitez proposer API Particulier à vos clients avec la modalité d’appel FranceConnect ? Voici les étapes à suivre :
Simplifiez l'attribution des aides facultatives départementales et régionales
En savoir plusObtenez automatiquement les données nécessaires à l'attribution des tarifs réduits de transports collectifs
En savoir plusCalculez automatiquement le tarif de restauration scolaire des collégiens et lycéens
En savoir plusPlaceholder