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).

Logo du fournisseur de données
Fournisseur de la donnée

Cnaf & Msa


Périmètre

Particuliers concernés :

Cette API concerne les allocataires de la majorité des régimes :

  • ✅ le régime agricole (MSA) ;

À venir prochainement (T1 2024) et disponibles durant la transition dans l’ancienne API :

  • ⏳ 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

Liste des cas d'usage où cette API est utile :
  • Attribution des aides à la scolarite
  • Attribution des aides sociales
  • Tarification sociale et solidaire des transports
  • Tarification des services publics municipaux

Spécifications de l'API

Format de l'information

Donnée structurée JSON

Modalités d'appel

  • Identité pivot ;
  • ou FranceConnect.
Détails des paramètres

Disponibilité

Temps réel :
Page de statut des API
Disponible 24h/24 et 7j/7

Spécifications techniques :

Consulter le swagger

Modalités d'appel

Cette API propose deux modalités d’appel :

FranceConnect

Avec FranceConnect.

Identité pivot

Avec les données d’identité : Noms, prénoms, sexe*, date de naissance, code COG de la commune de naissance** et code COG du pays de naissance* de l’allocataire.
* Obligatoire | ** Obligatoire si la personne est née en France.

Les données

Cette API délivre la composition familiale de l’allocataire et son quotient familial CAF ou MSA. 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 :

Informations sur les parents composant la famille
Cette propriété contient 1 ou plusieurs éléments ayant les spécifications suivantes :
Nom
ex: JACQUES
Nom de naissance de l'allocataire
Nom d'usage
ex: JACQUES
Nom d'usage de l'allocataire
Prénoms
ex: JEAN-PIERRE THOMAS
Prénoms de l'allocataire
Année de naissance
ex: 2000
Année de la date de naissance de l'allocataire. Peut-être vide si inconnue.
Mois de naissance
ex: 01
Mois de la date de naissance de l'allocataire. Peut-être vide si inconnue.
Jour de naissance
ex: 31
Jour de la date de naissance de l'allocataire. Peut-être vide si inconnue.
Sexe
ex: M
Sexe de l'allocataire
Informations sur les enfants composant la famille
Cette propriété contient 1 ou plusieurs éléments ayant les spécifications suivantes :
Nom de naissance
ex: JACQUES
Nom de naissance de l'enfant
Nom d'usage
ex: JACQUES
Nom d'usage de l'enfant
Prénoms
ex: JEAN-PIERRE THOMAS
Prénoms de l'enfant
Année de naissance
ex: 2000
Année de la date de naissance de l'enfant. Peut-être vide si inconnue.
Mois de naissance
ex: 01
Mois de la date de naissance de l'enfant. Peut-être vide si inconnue.
Jour de naissance
ex: 31
Jour de la date de naissance de l'enfant. Peut-être vide si inconnue.
Sexe
ex: M
Sexe de l'enfant
Adresse de la famille
Adresse au format de la poste
Identité du destinataire
ex: Monsieur JEAN JACQUES
Identité du destinataire : Civilité, titre ou qualité + nom et prénom
Complément d'information du destinataire ou point de remise
Complément d'information du destinataire ou point de remise.
Complément d'information du point géographique
Complément d'information du point géographique.
Voie
ex: 1 RUE DE LA GARE
Numéro et libellé de la voie
Lieu-dit
Lieu-dit ou service particulier de distribution : poste restante, boîte postale
Code postal
ex: 75002
Code postale et localité de destination
Pays
ex: FRANCE
Pays
Régime de l'allocataire
ex: MSA
Précise le régime de l'allocataire (CNAF ou MSA)
Quotient familial CAF ou MSA
ex: 1045
Valeur du quotient familial calculé par la CAF ou la MSA
Année du quotient familial
ex: 2021
Année de calcul du quotient familial
Mois du quotient familial
ex: 6
Mois de calcul du quotient familial
Année du calcul du quotient familial
ex: 2021
Année à laquelle le quotient familial a été calculé
Mois du calcul du quotient familial
ex: 3
Mois auquel le quotient familial a été calculé

Questions & réponses

Le quotient familial retourné par l’API est le quotient familial de la CAF ou de la MSA. Ce QF est différent de celui de l’administration fiscale car il prend en compte les prestations familiales. Contrairement au quotient familial DGFIP calculé au moment de la déclaration de revenu, le QF CAF/MSA est revu à chaque changement de situation familiale et/ou professionnelle.

Calcul du QF CAF/MSA : Revenu imposable de l’année N-2 divisé par 12 + les prestations familiales du mois de référence, le tout divisé par le nombre de parts fiscales du foyer.

Source : Caf.fr

Le quotient familial CAF ou MSA d’un même mois peut changer. Il est recalculé fréquemment au cours du temps par la CAF et la MSA. En effet, la situation de la personne peut évoluer : perte d’un emploi, évolution des ressources, arrivée d’un enfant, majorité d’un enfant, modification de la législation, évolution des allocations logement etc.
Cette variation apparaît notamment entre le quotient familial du mois en cours appelé en début de mois ou en fin de mois.

Deplus, la date du calcul du quotient familial diffère selon qu’il s’agit du quotient de la CAF ou de la MSA.

  • La CAF effectue une sauvegarde des quotients recalculés uniquement lorqu’un changement subvient du côté de l’allocataire.

    Par exemple, un appel le 28 juin 2023, du quotient du mois en cours (juin 2023) : La CAF renverra le QF qu’elle a en mémoire, par exemple calculé le 19 juin 2023.

  • La MSA effectue un recalcul du quotient familial à chaque appel de l’API.

    Par exemple, un appel le 28 juin 2023 du quotient familial du mois en cours (juin 2023) : la MSA recalculera le QF le 28 juin 2023.

La liste des enfants transmis par l’API correspond à la notion d’enfant à charge au sens de la législation familiale. Pour qu’un enfant soit considéré comme “à charge”, l’allocataire doit assurer financièrement son entretien de manière effective et permanente et assumer à son égard la responsabilité affective et éducative. Il n’y a pas d’obligation de lien de parenté avec l’enfant.

Deux notions d’enfant à charge cohabitent :

  • enfant à charge au sens des prestations familiales (Pf) : un enfant est reconnu à charge s’il est âgé d’un mois à moins de 20 ans quelle que soit sa situation, dès lors que son salaire net mensuel ne dépasse pas 55 % du Smic brut ;
  • enfant à charge au sens de la législation familiale: en plus des enfants à charge au sens des Pf, sont également considérés à charge pour les aides au logement, les enfants âgés de moins de 21 ans en Métropole (22 ans dans les Dom), les enfants âgés de 20 à 25 ans pour le calcul du Rmi/Rsa, et dès le mois de leur naissance, les enfants bénéficiaires de l’allocation de base de la Paje.

Source: data.caf.fr

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 :

Donnée protégé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.
L’ensemble des conditions sont consultables et téléchargeables ci-dessous :

CGU API Particulier

Cas d'usage

Liste des cas d'usage où cette API est utile :
  • Attribution des aides à la scolarite
  • Attribution des aides sociales
  • Tarification sociale et solidaire des transports
  • Tarification des services publics municipaux

Spécifications de l'API

Format de l'information

Donnée structurée JSON

Modalités d'appel

  • Identité pivot ;
  • ou FranceConnect.
Détails des paramètres

Disponibilité

Temps réel :
Page de statut des API
Disponible 24h/24 et 7j/7

Spécifications techniques :

Consulter le swagger