Statut revenu de solidarité active (RSA)

Statut bénéficiaire du revenu de solidarité active (RSA), majoré ou non.

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

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 du revenu de solidarité active (RSA).

Les enfants d’un allocataire du RSA ne sont pas considérés comme 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'usage

Liste des cas d'usage où cette API est utile :

Spécifications de l'API

Format de l'information

Donnée structurée JSON

Modalités d'appel

  • Identité pivot
  • FranceConnect Pictogramme fournisseurs de données regroupés
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 Cas de tests

Modalités d'appel

Cette API propose deux modalités d’appel :

Cette API est FranceConnectée 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**, code COG du pays de naissance*.
  • Commune de naissance qui peut être renseignée de deux façons différentes :
    • Option 1 : Code COG* de la commune de naissance si le lieu de naissance est en France. 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.

* 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 indique si le particulier est bénéficiaire du revenu de solidarité active. En précisant :

  • la date d’ouverture du droit ;
  • la date de fermeture du droit.

Informations renvoyées en JSON :

Statut bénéficiaire du revenu de solidarité active (RSA)
Indique si le particulier est bénéficiaire du revenu de solidarité active au moment de l'appel.
Statut bénéficiaire de la majoration du RSA
Indique si le particulier est bénéficiaire du RSA majoré au moment de l'appel. Nécessite un scope spécifique pour être envoyé. Sera null si le particulier n'est pas bénéficiaire du RSA.
Date d'ouverture du droit au RSA
ex: 1992-11-29
Date de début de droit au RSA si le particulier est bénéficiaire.
Ce champ est null dans le cas où le particulier n'est pas bénéficiaire du RSA.
Date de fermeture du droit au revenu de solidarité active
ex: 1993-02-20
Date de fin de droit au revenu de solidarité active du particulier bénéficiaire.
Ce champ est calculé en ajoutant 3 mois à la date de début de droit du RSA.
Ce champ sera null dans le cas où le particulier n'est pas bénéficiaire du RSA.

Questions & réponses

Lorsque l’API est appelée avec l’identité pivot, pour identifier correctement le particulier, le système d’information a besoin de récupérer le code COG du lieu de naissance de l’usager.

La déduction du code COG peut être obtenue via deux options différentes :

Option 1 : L’API est appelée avec le code COG lui-même

Cette option est à privilégier car elle couvre l’ensemble des usagers, y compris ceux nés à l’étranger et ceux nés dans un pays étranger autrefois rattaché à la France.

Toutefois, cette option nécessite de disposer du code COG de la commune ou du pays de naissance. Pour aider les usagers à renseigner leur code COG, consultez la publication suivante :

Option 2 : L’API est appelée avec le nom de la commune de naissance et code* du département de naissance

Cette option à pour objectif de faciliter vos développements, mais elle n’est pas exhaustive puisque les usagers nés à l’étranger ne pourront pas être identifiés.

Avec cette option, vous pouvez appeler l’API avec le nom de la commune de naissance et le code du département de naissance. La date de naissance est obligatoire car c’est elle qui permettra à l’API de faire la correspondance avec le bon code COG.

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 :

Spécifications de l'API

Format de l'information

Donnée structurée JSON

Modalités d'appel

  • Identité pivot
  • FranceConnect Pictogramme fournisseurs de données regroupés
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 Cas de tests