Statut allocation de soutien familial (ASF)

Savoir si un particulier est bénéficiaire de l'allocation de soutien familial (ASF).

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

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** ;
  • 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*.

* 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 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 :

Statut bénéficiaire de l'allocation de soution familial (ASF)
Indique si le particulier est bénéficiaire de l'allocation de soution familial au moment de l'appel.
Date d'ouverture du droit à l'ASF
ex: 1992-11-29
Date de début de droit à l'ASF si le particulier est bénéficiaire.
Ce champ est null dans le cas où le particulier n'est pas bénéficiaire de l'ASF.
Date de fermeture du droit à l'ASF
ex: 1993-11-29
Date de fin de droit à l'allocation de soution familial du particulier bénéficiaire.
Ce champ est calculé en ajoutant 12 mois à la date de début de droit à l'ASF.
Ce champ sera null dans le cas où le particulier n'est pas bénéficiaire de l'ASF.

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 lieu de naissance du particulier.

  • Pour les particuliers nés en France: le code COG pays 99100 est obigatoire. La commune de naissance est également obligatoire et peut-être renseignée via deux options différentes :

  • Pour les particuliers nés à l’étranger: le code COG pays est obigatoire.

Le code COG du pays de naissance est obligatoire pour tous les appels. Pour simplifier le parcours des usagers, évitez de demander aux particuliers nés en France de saisir leur pays de naissance, puisque vous pouvez le paramétrer directement -code COG pays France 99100-, dès qu’un particuloer renseigne les informations de sa commune de naissance (forcément en France).

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