Allocation de Soutien Familial prochainement
Savoir si un particulier est bénéficiaire de l'Allocation de Soutien Familial (ASF).
Cette API est bientôt disponible, testez-là !
Cette API est en cours de conception et va bientôt rejoindre le catalogue d'API Particulier.
En plus de cette documentation, un environnement technique de test est déjà disponible : Consulter le swagger
Cnav
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 l’allocation de soutien familial (ASF).
⚙️ 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
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, prénoms1, sexe*, date de naissance de l’allocataire**.
- Lieu de naissance qui peut être renseigné de deux façons différentes :
- Option 1 : Code COG* de la commune de naissance si le lieu de naissance est en France ou du pays de naissance pour les personnes nées à l’étranger. 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.
Les données
Cette API indique si le particulier est bénéficiaire de l’allocation de soutien familial. En précisant :
- la date d’ouverture du droit ;
- la date de fermeture du droit.
Informations renvoyées en JSON :
Ce champs est null dans le cas où le particulier n'est pas bénéficiaire de l'ASF.
Ce champs est calculé en ajoutant 12 mois à la date de début de droit à l'ASF.
Ce champs sera null dans le cas où le particulier n'est pas bénéficiaire de l'ASF.
Questions & réponses
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