Complémentaire santé solidaire
Savoir si un particulier est bénéficiaire de la complémentaire santé solidaire (C2S).
Fournisseur de la donnée
Ccmsa, Cnam, Cprpsncf, Crpcen, Cnmss & Cnav
Périmètre
Particuliers concernés :
✅ Le périmètre de l’API est exhaustif et couvre tous les assurés de la sphère sociale susceptibles d’être concernés par la complémentaire de santé solidaire (C2S).
Périmètre géographique :
- ✅ France métropolitaine
- ✅ Départements d’Outre-mer
- ✅ Assurés de nationalité étrangère
- ❌ Les collectivtés d’Outre-mer, ayant un autre système de sécurité sociale, ne sont pas concernées par cette 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 CNAM 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
Disponibilité
Page de statut des API
Disponible 24h/24 et 7j/7
Spécifications techniques :
Consulter le swagger Cas de testsModalités d'appel
Cette API propose 2 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 la complémentaire santé solidaire. En précisant :
- si la C2S est avec ou sans participation financière ;
- la date d’ouverture du droit ;
- la date de fermeture du droit.
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:
2023
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:
2023
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é
Statut bénéficiaire de la complémentaire santé solidaire (C2S)
Indique si le particulier est bénéficiaire de la complémentaire de santé solidaire au moment de l'appel. Cet indicateur précise sous quelle forme la C2S est attribuée (avec ou sans participation financière).
- Si le statut est 'beneficiaire_sans_participation_financiere', cela signifie que le particulier est bénéficiaire d'une C2S sans participation financière.
- Si le statut est 'beneficiaire_avec_participation_financiere', cela signifie que le particulier est d'une bénéficiaire de C2S avec participation financière.
- Si le statut est 'non_beneficiaire_css', cela signifie que le particulier n'est pas concerné par la C2S.
- Si le statut est 'beneficiaire_sans_participation_financiere', cela signifie que le particulier est bénéficiaire d'une C2S sans participation financière.
- Si le statut est 'beneficiaire_avec_participation_financiere', cela signifie que le particulier est d'une bénéficiaire de C2S avec participation financière.
- Si le statut est 'non_beneficiaire_css', cela signifie que le particulier n'est pas concerné par la C2S.
Date d'ouverture du droit à la C2S
ex:
1992-11-29
Date de début de droit à la complémentaire santé solidaire (C2S) si le particulier est bénéficiaire.
Ce champs est null dans le cas où le particulier n'est pas bénéficiaire de la C2S.
Ce champs est null dans le cas où le particulier n'est pas bénéficiaire de la C2S.
Date de fermeture du droit à la C2S
ex:
1993-11-29
Date de fin de droit à la complémentaire santé solidaire (C2S) du particulier bénéficiaire.
Ce champs est calculé en ajoutant 12 mois à la date de début de droit à la C2S.
Ce champs sera null dans le cas où le particulier n'est pas bénéficiaire de la C2S.
Ce champs est calculé en ajoutant 12 mois à la date de début de droit à la C2S.
Ce champs sera null dans le cas où le particulier n'est pas bénéficiaire de la C2S.
Questions & réponses
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.
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
Disponibilité
Page de statut des API
Disponible 24h/24 et 7j/7