Statut prime d'activité
Statut bénéficiaire de la prime d'activité, majorée ou non.
CNAF & MSA
Périmètre
Particuliers concernés :
✅ Le périmètre de l’API est a priori exhaustif et couvre tous les bénéficiaires de la prime d’activité (PPA).
Les enfants d’un allocataire de la prime d’activité ne sont pas considérés comme des bénéficiaires.
⚙️ Vérification en cours avec le fournisseur de données pour confirmer le périmètre exact.
Périmètre géographique :
- ✅ France Métropolitaine
- ✅ Départements d’Outre-mer
- ❌ Les collectivités d’Outre-mer, ayant un autre système de sécurité sociale, ne sont pas concernées par cette API.
- ⚙️ Personne de nationalité étrangère - Vérification en cours avec le fournisseur de la donnée pour confirmer la prise en charge. D’un point de vue métier, des prestations sont bien délivrées à une personne étrangère ayant un numéro d’immatriculation en attente (NIA) mais nous ne savons pas encore si le NIA est supporté par l’API.
Actualisation de la donnée :
Les données sont mises à jour en temps réel et issues du répertoire national commun de la protection sociale (RNCPS) opéré par la CNAV (Caisse nationale d’assurance vieillesse). Les données du répertoire sont remontées directement par les différents organismes comme la CNAF pour les assurés du régime général et la MSA pour les assurés au régime agricole.
Cas d'usages
Spécifications de l'API
Format de l'information
Modalités d'appel
- Identité pivot
-
FranceConnect
Disponibilité
Page de statut des APISpécifications techniques :
Consulter le swagger Cas de testsModalités d'appel
Cette API propose deux modalités d’appel :
FranceConnect
Avec la modalité d’appel FranceConnect.
Identité pivot
Avec les données d’identité :
- Nom de naissance*, nom d’usage, prénoms1, sexe*, date de naissance de l’allocataire** ;
- Lieu de naissance :
- Si le lieu de naissance est en France, la commune de naissance est obligatoire, elle peut être saisie de deux façons différentes :
- Option 1 : Code COG de la commune de naissance*. En savoir plus ;
- Option 2 : Nom de la commune de naissance* et code du département de naissance*. Pour cette option, la date de naissance est obligatoire. En savoir plus.
Pour chacune des deux options ci-dessus, le code COG de la France
99100* doit également être renseigné en paramètre d’appel. Vous n’avez pas besoin de le demander à l’usager, il peut être déduit de la commune de naissance. - Si le lieu de naissance est à l’étranger : code COG du pays de naissance*.
- Si le lieu de naissance est en France, la commune de naissance est obligatoire, elle peut être saisie de deux façons différentes :
* Obligatoire | ** Obligatoire pour l’option 2 du lieu de naissance.
1 Fournir plusieurs prénoms permet de limiter les risques d’homonymie mais un seul prénom peut fonctionner. Attention, l’usager doit compléter chaque prénom dans un champ distinct.
Les données
Cette API indique si le particulier est bénéficiaire de la prime d’activité, En précisant la date d’ouverture du droit.
Informations renvoyées en JSON :
Si ce champ est à false, cela signifie que la prime d'activité n'est pas majorée.
Ce champ sera null si le particulier n'est pas bénéficiaire de la prime d'activité.
Ce champ est null dans le cas où le particulier n'est pas bénéficiaire de la prime d'activité.
Questions & réponses
Historique
Ce que change le passage à la V.3 d’API Particulier:
- Suppression de la date de fin car cette donnée était calculée et présentait le risque de ne pas être juste dans toutes les situations ;
- Tous les changements sont décrits dans la table de correspondance du guide migration
Documentations des anciennes API :
Plus d'informations sur la gestion de version API Particulier dans cette documentation.
Conditions d'utilisation des données
Ouverture de la donnée :
Conditions générales :
Cette API et l’utilisation de ses données est soumise aux CGU générales d’API Particulier, dont voici les principaux éléments auxquels vous vous engagez :
- ne demander que les données strictement nécessaires ;
- ne pas utiliser votre jeton d’accès pour une démarche différente de celle indiquée lors de votre demande (le cas échéant le jeton sera révoqué) ;
- présenter les données obtenues uniquement aux seuls agents habilités et à tracer l’accès de ces agents aux données ;
- ne pas commercialiser les données reçues et à ne pas les communiquer à des tiers en dehors des cas prévus par la loi.
CGU API Particulier
Cas d'usages
Spécifications de l'API
Format de l'information
Modalités d'appel
- Identité pivot
-
FranceConnect