API Particulier

Les données des particuliers pour les administrations

Nouvelle API quotient familial CAF & MSA : Bureau ouvert en visio le 06/05/2025 à 10 heures.

Quotient familial (CAF) Déprécié

Quotient familial et composition de la famille d'un allocataire de la Caisse nationale des allocations familiales (CNAV).

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

CNAF

Cette API est dépréciée

Cette API est une ancienne version, nous vous invitons à utiliser ces API les plus récentes :

Périmètre

Particuliers concernés :

⚠️ Cette API ne sera plus en production à partir de mai 2025. Les données seront intégrées dans l’API CNAF MSA à partir de janvier 2024.

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

  • ✅ 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 agricole : les bénéficiaires (1 à 2% des allocataires) sont rattachés à la MSA ;
  • ❌ 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, l’API étant reliée au système d’information de la Caisse nationale des allocations familiales.

⚠️ Les informations obtenues sont représentatives de la situation connue par la CNAF et peuvent évoluer très fréquemment. Le Quotient familial CAF est recalculé tous les mois, il peut être rétroactif et dépend de la situation du particulier et de l’état du droit. Il peut donc y avoir des écarts, notamment si la situation de la personne évolue entre temps : perte d’un emploi, évolution des ressources, arrivée d’un enfant, majorité d’un enfant, modification de la législation etc. Depuis que les allocations logement sont contemporaines (transmises très régulièrement), le QF est amené à évoluer lui aussi très fréquemment.

Spécifications de l'API

Format de l'information

Donnée structurée JSON

Modalité d'appel

  • Code postal et numéro de l'allocataire
Détails des modalités

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 une seule modalité d’appel :

Identifiant

Le numéro d’allocataire du particulier et son code postal.

Les données

Cette API délivre la composition familiale de l’allocataire et son quotient familial CAF.

Le quotient familial de la CNAF 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.

Le montant du quotient familial CAF retourné par l’API Particulier peut être différent de celui transmis par le dossier allocataire (CDAP), en savoir plus.

Informations renvoyées en JSON :

Aperçu d'un exemple de réponse JSON
Informations sur les parents composant la famille
Cette propriété contient 1 ou plusieurs éléments ayant les spécifications suivantes :
Nom et prénoms
ex: JEAN JACQUES
Nom et prénoms du parent allocataire de la CAF
Date de naissance
ex: 01021970
Date de naissance au format JJMMAAAA
Sexe
ex: M
Sexe du parent
Informations sur les enfants composant la famille
La liste des enfants correspond à la notion d'enfant à charge au sens de la législation familiale. Il n'y a notamment pas d'obligation de lien de parenté avec l’enfant. Pour en savoir plus, consultez la FAQ https://particulier.api.gouv.fr/catalogue/cnav/quotient_familial#faq_entry_2_api_particulier_endpoint_cnav_quotient_familial:
Cette propriété contient 1 ou plusieurs éléments ayant les spécifications suivantes :
Nom et prénoms
ex: JESSICA JACQUES
Nom et prénoms de l'enfant des allocataires
Date de naissance
ex: 01031995
Date de naissance au format JJMMAAAA
Sexe
ex: F
Sexe de l'enfant
Adresse de la famille
Adresse structurée au format de la poste. C'est l'adresse connue de la CNAV, il s'agit d'une information déclarative.
Identité du destinataire
ex: Monsieur JEAN JACQUES
L'identité se compose de la civilité, du titre ou de la qualité, suivis du nom et du prénom.
Complément d'information du destinataire ou point de remise
Numéro d'appartement, escalier
Complément d'information du point géographique
Entrée, tour, immeuble, bâtiment, résidence
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 postal et localité de destination
Pays
ex: FRANCE
Quotient familial CAF de la famille
ex: 1045
Valeur du quotient familial calculée par la CAF
Année du quotient familial
ex: 2021
Il s'agit toujours de l'année du mois précédent l'appel.
Mois du quotient familial
ex: 6
Le quotient familial transmis correspond au QF du mois M-1 (M étant le mois de l'appel).

Questions & réponses

Actuellement, il peut arriver que le quotient familial transmis par l’API particulier diffère de celui obtenu sur le CDAP (Consultation du dossier allocataire par les partenaires). Voici des éléments de réponses pour comprendre les différences suivantes :

  • Le montant du QF est différent :
    La différence des montants observés est souvent liée à une différence de temporalité. L’API Particulier délivre le QF du mois M-1 ; là où le CDAP indique le QF en cours.
  • Le montant du QF est à 0 sur API Particulier, au lieu de non connu sur le CDAP :
    Actuellement, l’API de la CNAF qui alimente l’API Particulier, n’indique pas par un code erreur précis le cas des allocataires dont le QF n’est pas calculable faute de connaître les ressources perçues. En effet, actuellement, un QF à 0 est envoyé, plutôt qu’une erreur.
    La CNAF a conscience que ce retour peut porter à confusion. Il est prévu une évolution dans la future API.
  • Le montant du QF n’est pas délivré par l’API Particulier (affiché non droit) alors qu’il est délivré par le CDAP :
    Lorsqu’aucune prestation n’est versée au mois M, l’API CNAF, source de l’API Particulier, ne retourne pas de QF, y compris si en M-1 la personne avait bien des prestations. Une question métier est en cours pour faire évoluer l’API afin de fournir le dernier QF calculé ainsi que la date de ce dernier calcul.

La CNAF travaille actuellement sur une nouvelle API qui retournera les mêmes informations que le CDAP. Les développements sont déjà en cours.

Le quotient familial retourné par l’API est le quotient familial de la CAF. 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 de la CAF est revu à chaque changement de situation familiale et/ou professionnelle.

Calcul du QF de la CAF : 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 telles que calculées par la Caf.

Source : Caf.fr

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

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

Spécifications de l'API

Format de l'information

Donnée structurée JSON

Modalité d'appel

  • Code postal et numéro de l'allocataire
Détails des modalités

Disponibilité

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

Spécifications techniques :

Consulter le swagger