Quotient familial MSA & CAF Nouvelle version
Quotient familial et composition de la famille d'un allocataire du régime agricole (régime général à venir).
Cnaf & Msa
Périmètre
Particuliers concernés :
Cette API concerne les allocataires de la majorité des régimes :
- ✅ le régime agricole (MSA) ;
- ✅ le régime général ;
- ✅ les titulaires de l’éducation nationale ;
- ✅ les retraités de la fonction publique d’État et des collectivités locales ;
- ✅ les régimes spéciaux suivants : artiste-auteur-compositeur, France Télécom, industries électriques et gazières, marin du commerce et pêche, mines (régime général), poste, RATP, SNCF, navigation intérieure en cas d’accord local et les pensions des autres régimes.
Ne sont pas concernés par cette API, les bénéficiaires des régimes suivants :
- ❌ le régime des titulaires de l’Assemblée nationale et du Sénat ;
- ❌ le régime de la navigation intérieure sauf lorsqu’un accord local est passé, et que le régime est alors pris en compte par la CAF.
Périmètre géographique :
- ✅ France métropolitaine
- ✅ DROM COM
- ✅ Allocataires de nationalité étrangère
Actualisation de la donnée :
Les données sont mises à jour en temps réel, cette API opérée par la CNAV (Caisse nationale d’assurance vieillesse) est reliée au système d’information de la Caisse nationale des allocations familiales (CNAF) et à celui de la mutualité sociale agricole (MSA).
⚠️ Les informations obtenues sont représentatives de la situation connue par la CNAF et la MSA au moment de l’appel, il est donc possible qu’un quotient familial appelé pour un mois donné à un instant T, soit différent s’il est redemandé à un instant T+. En savoir plus.
Cas d'usage
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
L’API est uniquement appelable avec les informations de l’allocataire.
Il n’est pas possible d’interroger cette API avec les informations des ayants droit.
Deux modalités d’appel sont possibles :
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.
⚠️ Message API Particulier du 04.06.2024 : Nous avons constaté que les appels effectués sans nom de naissance et avec le nom d’usage ne fonctionnent pas dans une très grande partie des cas. Après investigation auprès de la CNAV (opérateur de l’API source), API Particulier a donc décidé de passer le paramètre “Nom de naissance” en obligatoire.
Les données
Cette API délivre :
- la composition familiale du particulier, en savoir plus ;
- le quotient familial CAF ou MSA du particulier. Par défaut, le quotient familial du mois en cours est transmis. Le QF de l’allocataire est disponible pour les 24 mois précédents en précisant le mois et l’année dans l’appel.
Le quotient familial au sens de la CNAF ou de la MSA a une définition différente du quotient familial de l’administration fiscale, en savoir plus.
Le QF CNAF est calculé seulement pour les allocataires dont les ressources sont déclarées. En effet, pour calculer le quotient familial, la CNAF collecte tous les mois auprès de la DGFIP les ressources de l’individu (revenus salariés et non-salariés, du capital, rentes …). Elle récupère le bilan en fin d’année. Sans la réception de ces ressources, le QF CNAF ne peut être calculé : une erreur est renvoyée par l’API.
Si le particulier n’a plus d’allocations, son QF n’est pas renvoyé. Une erreur est transmise par l’API.
Informations renvoyées en JSON :
- Si aucun mois n'a été renseigné mais que l'année a été spécifiée en paramètres d'appel, le quotient familial retourné sera celui du mois en cours pour l'année spécifiée.
Questions & réponses
Historique
Ce que change cette API CNAF-MSA par rapport à l’API précédente de la CNAF :
- Le périmètre des particuliers concernés s’élargit avec l’ajout des bénéficiaires de la MSA qui sont au régime agricole.
- Les paramètres d’appel évoluent. Dans l’API précédente, l’usager devait renseigner son numéro d’allocataire et son code postal. Avec cette API l’usager renseigne ses données d’identité.
Documentations des anciennes API :
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'usage
Spécifications de l'API
Format de l'information
Modalités d'appel
- Identité pivot
- FranceConnect