---
openapi: 3.0.0
info:
  title: API Particulier
  version: 3.0.0
  description: |
    ## Bienvenue sur la documentation interactive d'API Particulier.

    ### Commencer à utiliser l'API

    API Particulier est une API en accès restreint, ce qui signifie qu'il vous faut remplir une [demande d'habilitation](https://datapass.api.gouv.fr) avant de pouvoir l'utiliser avec des vraies données.

    Afin de tester l'API avant la validation de votre demande d'habilitation, nous avons mis en place un bac à sable de l'API qui reproduit les comportements de l'API en production.

    Dans cet environnement, les données sont fictives et éditables par tout le monde. Cet environnement essaye de simuler au mieux les compotements en production en fournissant des réponses à un ensemble de paramètre fixe.
    Pour accéder à l'environnement de staging, référez-vous à la [documentation](https://particulier.api.gouv.fr/developpeurs#tester-api-preproduction).

    Le bac à sable et l'API de production sont appelables par deux adresses distinctes :

    - bac à sable : [https://staging.particulier.api.gouv.fr](https://staging.particulier.api.gouv.fr)
    - production : [https://particulier.api.gouv.fr](https://particulier.api.gouv.fr)

    Pour récupérer le jeton de production un portail développeur est mis à votre disposition à l'adresse suivante : [https://particulier.api.gouv.fr/compte](https://particulier.api.gouv.fr/compte)

    Pour effectuer vos tests sur le bac à sable, référez-vous à ce dépôt github: [datagouv/apistration](https://github.com/datagouv/apistration/tree/develop/mocks/) (l'ancien système basé sur Airtable n'est plus maintenu et va être remplacé par le nouveau système). Un jeton nommé default est disponible ici: [tokens](https://github.com/datagouv/apistration/tree/develop/mocks/tokens)

    ### Accéder à la version 2 de l'API

    Vous pouvez accéder à la documentation v2 [ici](https://particulier.api.gouv.fr/developpeurs/openapi-v2).

    ### Périmètre des données retournées

    **Important :** le contenu du jeu de données retourné dépend des _scopes_ ou _périmètres_ du jeton utilisé.

    En effet, les disposition de l'article [L144-8](https://www.legifrance.gouv.fr/codes/article_lc/LEGIARTI000045213315) n'autorisent que l'échange des informations **strictement nécessaires** pour traiter une démarche.

    Afin de respecter ce devoir de minimisation de la donnée, chaque jeton est associé, par la demande d'habilitation, à des _scopes_ agissant comme des masques sur la donnée.

    Ainsi, pour pouvoir lire de la donnée, il est nécessaire de cocher lors de votre [demande d'habilitation](https://datapass.api.gouv.fr) une ou plusieurs cases correspondant aux données du même fournisseur, votre jeton possèdera alors les _scopes_ associés aux données cochées.

    En conséquence, suivant le jeton utilisé, une même requête peut retourner des résultats différents.

    **Attention :** La documentation ci-dessous ne prend pas en compte les _scopes_, qui agissent comme masques de la donnée retournée par l'API. Cette documentation suppose donc que votre jeton permet d'accéder à la donnée décrite.

    ### Passer son service en production

    Lors de votre passage en production :

    - remplacez l'URL de staging.particulier.api.gouv.fr à particulier.api.gouv.fr
    - remplacez le jeton de test par le jeton obtenu sur [le portail API Particulier](https://particulier.api.gouv.fr/compte)
  termsOfService: https://api.gouv.fr/resources/CGU%20API%20Particulier.pdf
  contact:
    name: Contact API Particulier
    email: api-particulier@api.gouv.fr
    url: https://particulier.api.gouv.fr/
  license:
    name: GNU Affero General Public License v3.0
    url: https://github.com/betagouv/api-particulier/blob/master/LICENSE
tags: []
paths:
  "/v3/ants/extrait_immatriculation_vehicule/france_connect":
    get:
      summary: "[FranceConnect] Extrait d'immatriculation véhicule"
      tags:
      - Extrait d'immatriculation véhicule
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: immatriculation
        in: query
        description: Identifiant de l'immatriculation du véhicule.
        example: AA-123-BB
        required: true
        schema:
          type: string
      security:
      - jwt_bearer_token: []
      description: Extrait d'immatriculation du véhicule avec l'identité du demandeur
        du dossier.
      responses:
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                missing_france_connect_access_token_error:
                  value:
                    errors:
                    - code: '50004'
                      title: Accès non autorisé
                      detail: 'Le jeton d''accès FranceConnect est manquant. Cet endpoint
                        requiert un jeton d''accès FranceConnect transmis via l''en-tête
                        Authorization: Bearer.'
                      source:
                      meta: {}
                  summary: Accès non autorisé
                  description: 'Le jeton d''accès FranceConnect est manquant. Cet
                    endpoint requiert un jeton d''accès FranceConnect transmis via
                    l''en-tête Authorization: Bearer.'
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Identité trouvée
          headers:
            RateLimit-Limit:
              schema:
                type: integer
              description: La limite concernant l’endpoint appelé, soit le nombre
                de requête/minute.
              example: 50
            RateLimit-Remaining:
              schema:
                type: integer
              description: Le nombre d’appels restants durant la période courante
                d’une minute.
              example: 47
            RateLimit-Reset:
              schema:
                type: integer
              description: La fin de la période courante (en format timestamp)
              example: 1637223155
          x-operationId: api_particulier_v3_ants_extrait_immatriculation_vehicule_with_france_connect
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      identite_particulier:
                        title: Identité
                        type: object
                        description: Identité du demandeur du dossier d'immatriculation.
                          Ces données ne proviennent pas de FranceConnect et sont
                          fournies à des fins de vérification de l'identité du demandeur.
                        properties:
                          nom:
                            title: Nom
                            type: string
                            description: Le nom du demandeur du dossier d'immatriculation.
                            example: MARTIN
                          prenom:
                            title: Prénom
                            type: string
                            description: Le prénom du demandeur du dossier d'immatriculation
                              (si personne physique).
                            example: JEAN
                          sexe_etat_civil:
                            title: Sexe état civil
                            type: string
                            description: Le sexe à l'état civil du demandeur.
                            enum:
                            - M
                            - F
                            example: M
                          annee_date_naissance:
                            title: Année de naissance
                            type: integer
                            description: L'année de naissance du demandeur.
                            example: 1990
                            nullable: true
                          mois_date_naissance:
                            title: Mois de naissance
                            type: integer
                            description: Le mois de naissance du demandeur.
                            minimum: 1
                            maximum: 12
                            example: 3
                            nullable: true
                          jour_date_naissance:
                            title: Jour de naissance
                            type: integer
                            description: Le jour de naissance du demandeur.
                            minimum: 1
                            maximum: 31
                            example: 15
                            nullable: true
                          code_departement_naissance:
                            title: Code département de naissance
                            type: string
                            description: Le code du département de naissance du demandeur.
                            example: '75'
                        x-scope: ants_extrait_immatriculation_vehicule_identite_particulier
                        required:
                        - nom
                        - prenom
                        - sexe_etat_civil
                        - annee_date_naissance
                        - mois_date_naissance
                        - jour_date_naissance
                        - code_departement_naissance
                      adresse_particulier:
                        title: Adresse
                        type: object
                        description: L'adresse du demandeur.
                        properties:
                          complement_information:
                            title: Complément information de l'adresse
                            type: string
                            nullable: true
                            description: Complément d'adresse.
                            example:
                          num_voie:
                            title: Numéro de voie
                            type: string
                            nullable: true
                            description: Numéro de voie.
                            example: '15'
                          type_voie:
                            title: Type de voie
                            type: string
                            nullable: true
                            description: Type de voie.
                            example: RUE
                          libelle_voie:
                            title: Libellé de voie
                            type: string
                            nullable: true
                            description: Libellé de voie.
                            example: DE LA REPUBLIQUE
                          code_postal_ville:
                            title: Code postal
                            type: string
                            description: Code postal de la ville
                            example: '75001'
                          libelle_commune:
                            title: Libellé de commune
                            type: string
                            description: Libellé de commune.
                            example: PARIS
                          lieu_dit:
                            title: Lieu-dit
                            type: string
                            nullable: true
                            description: Lieu-dit ou quartier
                            example:
                          etage_escalier_appartement:
                            title: Étage, escalier ou appartement
                            type: string
                            nullable: true
                            description: Étage, escalier ou numéro d'appartement.
                            example: ESCALIER 2
                          extension:
                            title: Extension de l'adresse
                            type: string
                            nullable: true
                            description: Extension de l'adresse, si applicable (Bis,
                              Ter, etc.).
                            example: B
                          pays:
                            title: Pays
                            type: string
                            nullable: true
                            description: Libellé du pays
                            example: FRANCE
                        x-scope: ants_extrait_immatriculation_vehicule_adresse_particulier
                        required:
                        - complement_information
                        - num_voie
                        - type_voie
                        - libelle_voie
                        - code_postal_ville
                        - libelle_commune
                        - lieu_dit
                        - etage_escalier_appartement
                        - extension
                        - pays
                      statut_rattachement:
                        title: Statut de rattachement au véhicule
                        type: string
                        description: Le statut du demandeur du dossier d'immatriculation.
                          Si le véhicule est en location longue durée (LLD, LCB, LCL),
                          alors il s'agit du locataire. Dans les autres cas, c'est
                          'titulaire' ou 'cotitulaire'.
                        enum:
                        - locataire
                        - titulaire
                        - cotitulaire
                        example: titulaire
                        x-scope: ants_extrait_immatriculation_vehicule_statut_rattachement
                      donnees_immatriculation_vehicule:
                        title: Données d'immatriculation du véhicule
                        type: object
                        description: Informations relatives à l'immatriculation du
                          véhicule
                        required:
                        - numero_immatriculation
                        - date_premiere_immatriculation
                        - statut_location
                        properties:
                          numero_immatriculation:
                            title: Numéro d'immatriculation
                            type: string
                            description: Le numéro d'immatriculation du véhicule.
                            example: AA-123-BB
                          date_premiere_immatriculation:
                            title: Date de première immatriculation
                            type: string
                            description: La date de la première immatriculation du
                              véhicule.
                            example: '2024-01-15'
                          statut_location:
                            title: Statut de location
                            type: object
                            description: Le statut de location du véhicule, si applicable.
                              Les codes LLD, LCB, LCL correspondent à une location
                              longue durée.
                            required:
                            - code
                            - label
                            properties:
                              code:
                                title: Code du statut de location
                                type: string
                                description: Le code du statut de location selon la
                                  nomenclature officielle.
                                example: LLD
                                nullable: true
                              label:
                                title: Label du statut de location
                                type: string
                                description: Le label descriptif du statut de location.
                                example: Location Longue Durée
                                nullable: true
                        x-scope: ants_extrait_immatriculation_vehicule_donnees_immatriculation_vehicule
                      caracteristiques_techniques_vehicule:
                        title: Informations et des caractéristiques techniques du
                          véhicule
                        type: object
                        description: Extrait des informations techniques et caractéristiques
                          du véhicule.
                        required:
                        - marque
                        - type_variante_version
                        - denomination_commerciale
                        - masse_charge_maximale
                        - categorie_vehicule
                        - genre_national
                        - cylindree
                        - type_carburant
                        - taux_co2
                        - classe_environnementale
                        properties:
                          marque:
                            title: Marque du véhicule
                            type: string
                            description: La marque du véhicule.
                            example: PEUGEOT
                          type_variante_version:
                            title: Type Variante Version
                            type: string
                            description: Les Type Variante Version (TVV) du véhicule.
                            example: ABCDEF-G1H234
                          denomination_commerciale:
                            title: Dénomination commerciale
                            type: string
                            description: La dénomination commerciale du véhicule.
                            example: '308'
                          masse_charge_maximale:
                            title: Masse en charge maximale
                            type: number
                            description: La masse en charge maximale admissible du
                              véhicule en service.
                            example: 1850
                          categorie_vehicule:
                            title: Catégorie du véhicule
                            type: object
                            description: La catégorie du véhicule (CE)
                            required:
                            - code
                            - label
                            properties:
                              code:
                                title: Code de la catégorie du véhicule
                                type: string
                                description: Le code de la catégorie du véhicule selon
                                  la classification européenne.
                                enum:
                                - M1
                                - M2
                                - M3
                                - N1
                                - N2
                                - N3
                                - O1
                                - O2
                                - O3
                                - O4
                                - L1e
                                - L2e
                                - L3e
                                - L4e
                                - L5e
                                - L6e
                                - L7e
                                example: M1
                              label:
                                title: Label de la catégorie du véhicule
                                type: string
                                description: Le label de la catégorie du véhicule
                                example: Véhicule de transport de personnes comportant
                                  au maximum 8 places assises outre le siège du conducteur.
                          genre_national:
                            title: Genre national
                            type: object
                            description: Le genre national du véhicule.
                            required:
                            - code
                            - label
                            properties:
                              code:
                                title: Code du genre national
                                type: string
                                description: Le code du genre national selon la classification
                                  française.
                                enum:
                                - VP
                                - CTTE
                                - VASP
                                - TCP
                                - TRR
                                - CAM
                                - REM
                                - RESP
                                - SRAT
                                - SREM
                                - CL
                                - CYCL
                                - MTL
                                - MTT1
                                - MTT2
                                - MOTO
                                - MAGA
                                - QM
                                - TRA
                                example: VP
                              label:
                                title: Label du genre national
                                type: string
                                description: Le label du genre national.
                                example: Véhicule Particulier
                          cylindree:
                            title: Cylindrée
                            type: number
                            description: La cylindrée (en cm3)
                            example: 1600
                          type_carburant:
                            title: Type de carburant
                            type: object
                            description: Le type de carburant ou la source d'énergie.
                            required:
                            - code
                            - label
                            properties:
                              code:
                                title: Code du type de carburant
                                type: string
                                description: Le code du type de carburant selon la
                                  nomenclature officielle.
                                enum:
                                - AC
                                - EE
                                - EG
                                - EH
                                - EL
                                - EM
                                - EN
                                - EP
                                - EQ
                                - ER
                                - ES
                                - ET
                                - FE
                                - FG
                                - FH
                                - FL
                                - FN
                                - GA
                                - GF
                                - GG
                                - GH
                                - GL
                                - GM
                                - GN
                                - GO
                                - GP
                                - GQ
                                - GZ
                                - H2
                                - HE
                                - HH
                                - HY
                                - NE
                                - NH
                                - PE
                                - PH
                                - PL
                                example: ES
                              label:
                                title: Label du type de carburant
                                type: string
                                description: Le label du type de carburant.
                                example: Essence
                          taux_co2:
                            title: Taux de CO2
                            type: number
                            description: Le taux de CO2 (en g/km).
                            example: 120
                          classe_environnementale:
                            title: Classe environnementale
                            type: object
                            description: 'L''indication de la classe environnementale
                              de réception CE : mention de la version applicable en
                              vertu de la directive 70/220/CEE ou de la directive
                              88/77/CEE.'
                            required:
                            - code
                            - label
                            properties:
                              code:
                                title: Code de la classe environnementale
                                type: string
                                description: Le code de la classe environnementale
                                  selon les normes européennes.
                                enum:
                                - Euro 1
                                - Euro 2
                                - Euro 3
                                - Euro 4
                                - Euro 5
                                - Euro 5a
                                - Euro 5b
                                - Euro 6
                                - Euro 6b
                                - Euro 6c
                                - Euro 6d-TEMP
                                - Euro 6d
                                - Euro 6e
                                - Euro VI
                                example: Euro 6
                              label:
                                title: Label de la classe environnementale
                                type: string
                                description: Le label de la classe environnementale.
                                example: Norme européenne d'émission Euro 6
                        x-scope: ants_extrait_immatriculation_vehicule_caracteristiques_techniques_vehicule
                    required:
                    - identite_particulier
                    - adresse_particulier
                    - statut_rattachement
                    - donnees_immatriculation_vehicule
                    - caracteristiques_techniques_vehicule
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                    properties:
                      identity_matching:
                        title: Résultats de la vérification d'identité
                        type: object
                        description: Résultats de la comparaison entre l'identité
                          FranceConnect et l'identité du demandeur d'immatriculation.
                          A noter que la validation demande exclusivement une correspondance
                          sur le nom de famille et le prénom. La correspondance sur
                          la date de naissance n'est pas prise en compte dans cette
                          validation mais est fournie à titre informatif.
                        properties:
                          family_name:
                            title: Nom de famille correspond
                            type: number
                            format: float
                            description: Indique si le nom de famille correspond entre
                              FranceConnect et l'identité ANTS.
                            example: 1.0
                          given_name:
                            title: Prénom correspond
                            type: number
                            format: float
                            description: Indique si le prénom correspond entre FranceConnect
                              et l'identité ANTS.
                            example: 1.0
                          birth_date:
                            title: Date de naissance correspond
                            type: number
                            format: float
                            description: Indique si la date de naissance correspond
                              entre FranceConnect et l'identité ANTS.
                            example: 0.0
                          overall_match:
                            title: Correspondance globale
                            type: boolean
                            description: Indique si l'identité correspond globalement
                              (nom de famille et prénom).
                            example: true
                    required:
                    - identity_matching
                    additionalProperties: false
                required:
                - data
                - links
                - meta
        '404':
          description: Immatriculation non trouvée ou identité non trouvée pour cette
            immatriculation
          content:
            application/json:
              examples:
                entite_non_trouvee_42003:
                  value:
                    errors:
                    - code: '42003'
                      title: Entité non trouvée
                      detail: Le ou les paramètre(s) d'entrée n'existent pas, ne sont
                        pas connus, ou ne comportent aucune information pour cet appel.
                        Veuillez vérifier que votre recherche est couverte par le
                        périmètre de l'API.
                      source:
                      meta:
                        provider: ANTS
                  summary: Entité non trouvée
                  description: Le ou les paramètre(s) d'entrée n'existent pas, ne
                    sont pas connus, ou ne comportent aucune information pour cet
                    appel. Veuillez vérifier que votre recherche est couverte par
                    le périmètre de l'API.
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '422':
          description: Paramètre(s) invalide(s)
          content:
            application/json:
              examples:
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/dss/allocation_adulte_handicape/identite":
    get:
      summary: "[Identité] Statut allocation adulte handicapé (AAH)"
      tags:
      - Statut Allocation Adulte Handicapé (AAH)
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: Cache-Control
        in: header
        description: Si cette valeur est fixée à "no-cache", le système de cache est
          alors ignoré et la donnée est directement récupérée depuis le fournisseur
          de données.
        schema:
          type: string
      - name: nomNaissance
        in: query
        description: "**Nom de naissance, également appelé nom de famille**. \n\nLe
          nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le
          livret de famille, etc. Le nom de famille/naissance figure toujours sur
          la pièce d'identité en premier, avant le nom d'usage si le particulier en
          a un. \n\nEn cas de changement de nom de naissance, une mention avec le
          nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler
          l'API, le nom de naissance/famille nécessaire est bien le nom de famille
          modifié."
        example: DURANT
        required: true
        schema:
          type: string
      - name: nomUsage
        in: query
        description: "**Nom d'usage**. \n\nSi le particulier a un nom d'usage, c'est
          le nom qu'il utilise généralement au quotidien. Le nom d'usage est facultatif
          et peut changer au cours de la vie. Il correspond au nom de famille/naissance
          d'un parent, d'un époux ou d'une épouse, seul ou accolé au nom de famille/naissance.
          Par exemple, le nom d'usage ne peut pas être le nom de famille/naissance
          d'un concubin ou d'un partenaire de pacs. \n\nSi le particulier en a fait
          la demande, le nom d'usage peut être inscrit derrière le nom de naissance
          sur la carte d'identité ou le passeport ; il peut également être celui utilisé
          par l'administration sur les courriers. Le nom d'usage ne remplace pas le
          nom de famille/naissance qui reste le seul mentionné. \nDans nos APIs, le
          nom d'usage n'est jamais identique au nom de famille.\n\nPour en savoir
          plus : https://www.service-public.fr/particuliers/vosdroits/F868."
        example: DUPONT DURANT
        required: false
        schema:
          type: string
      - name: prenoms[]
        in: query
        schema:
          type: array
          minItems: 1
          maxItems: 3
          items:
            type: string
          example:
          - PIERRE
          - RICHARD
        description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise
          les chances que l'API retrouve le particulier car cela permet de limiter
          le risque d’homonymie."
        required: true
      - name: anneeDateNaissance
        in: query
        description: "**Année de naissance**. \n\nPour un particulier né en France,
          dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance',
          ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance')
          afin de retrouver le code COG de la commune de naissance."
        example: 1990
        required: false
        schema:
          type: integer
      - name: moisDateNaissance
        in: query
        description: "**Mois de naissance**. \n\nCette valeur est ignorée si le paramètre
          'anneeDateNaissance' est vide."
        example: 1
        required: false
        schema:
          type: integer
      - name: jourDateNaissance
        in: query
        description: "**Jour de naissance**. \n\nCette valeur est ignorée si le paramètre
          'moisDateNaissance' ou le paramètre 'anneeDateNaissance' est vide.\""
        example: 1
        required: false
        schema:
          type: integer
      - name: sexeEtatCivil
        in: query
        schema:
          type: string
          enum:
          - M
          - F
        description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**,
          comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité
          des cas, il s'agit également de la mention indiquée sur la pièce d'identité
          et le passeport. Cette mention peut être masculin ('M') ou féminin ('F').
          \nDans le cas d'un particulier ayant demandé une modification de sa mention
          de sexe à l'état civil, le changement est indiqué en marge de l'acte de
          naissance une fois la décision rendue. Le changement intervient sur les
          titres d'identité seulement si le particulier en demande le renouvellement."
        example: M
        required: false
      - name: codeCogInseePaysNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '99100'
        description: |-
          **Code Insee à 5 chiffres du pays de naissance**.

          - Code Insee France = 99100 ;
          - Liste de tous les codes Insee des pays étrangers depuis 1943 : https://explore.data.gouv.fr/fr/datasets/58c984b088ee386cdb1261f3/#/resources/150889d3-ffda-4ea5-8709-6ee67415294f.
        required: true
      - name: codeCogInseeCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '08480'
        description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation de la seconde option
          (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance'),
          ce paramètre est obligatoire si la personne est née en France.\n\nNe pas
          remplir si la personne est née à l'étranger."
        required: false
      - name: nomCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 1
          example: Gennevilliers
        description: "**Nom en toute lettre de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation du 'codeCogInseeCommuneNaissance',
          ce paramètre est obligatoire si la personne est née en France ; il doit
          être obligatoirement accompagné des paramètres 'codeCogInseeDepartementNaissance'
          et 'anneeDateNaissance'.\n\nNe pas remplir si la personne est née à l'étranger."
        required: false
      - name: codeCogInseeDepartementNaissance
        in: query
        schema:
          type: string
          minLength: 2
          maxLength: 3
          example: '92'
        description: "**Code INSEE du département de naissance**. \n\nPour retrouver
          un particulier né en France, il est nécessaire d'indiquer sa commune de
          naissance. Ce paramètre fait partie d'une des deux options disponibles pour
          renseigner la commune de naissance. Lorsque le paramètre 'nomCommuneNaissance'
          est utilisé, ce paramètre est obligatoire si la personne est née en France
          et permet de retrouver le code COG avec le paramètre 'anneeDateNaissance'.\n\nNe
          pas remplir si la personne est née à l'étranger."
        required: false
      security:
      - jwt_bearer_token: []
      description: "Statut bénéficiaire de l'allocation adulte handicapé (AAH). \n\n
        Retourne également des informations sur les dates d'ouverture des droits."
      responses:
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Allocation Adulte Handicape active trouvée
          headers:
            X-Response-Cached:
              schema:
                type: boolean
                example: true
                enum:
                - true
                - false
                default: false
              description: Indique si la réponse a été caché.
            X-Cache-Expires-in:
              schema:
                type: number
                nullable: true
                example: 9001
              description: Secondes avant que le cache n'expire. Si le cache est vide,
                ce header est vide (mais présent). La durée du cache est de 1 heure.
          x-operationId: api_particulier_v3_cnav_allocation_adulte_handicape_with_civility
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      est_beneficiaire:
                        title: Est bénéficiaire de l'allocation adulte handicapé (AAH)
                        type: boolean
                        example: true
                        description: Indique que le particulier est bénéficiaire de
                          l'allocation adulte handicapé au moment de l'appel.
                        x-scope: allocation_adulte_handicape
                      date_debut_droit:
                        title: Date d'ouverture du droit à l'AAH
                        type: string
                        nullable: true
                        description: "Date de début de droit à l'allocation adulte
                          handicapé du particulier bénéficiaire. \n Ce champs est
                          null dans le cas où le particulier n'est pas bénéficiaire
                          de l'AAH."
                        example: '1992-11-29'
                        x-scope: allocation_adulte_handicape
                    required:
                    - est_beneficiaire
                    - date_debut_droit
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '422':
          description: Impossible d'identifier l'allocataire
          content:
            application/json:
              examples:
                entite_non_traitable_00366:
                  value:
                    errors:
                    - code: '00366'
                      title: Entité non traitable
                      detail: Un ou plusieurs paramètres de civilité ne sont pas correctement
                        formatés
                      source:
                      meta: {}
                  summary: Entité non traitable
                  description: Un ou plusieurs paramètres de civilité ne sont pas
                    correctement formatés
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '404':
          description: Dossier allocataire inexistant. Le document ne peut être édité.
          content:
            application/json:
              examples:
                dossier_allocataire_absent:
                  value:
                    errors:
                    - code: '36003'
                      title: Dossier allocataire absent
                      detail: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                        de données est précisé dans 'meta.provider'.
                      source:
                      meta:
                        provider: Sécurité sociale
                  summary: Dossier allocataire absent
                  description: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                    de données est précisé dans 'meta.provider'.
                allocataire_non_reference_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Allocataire non référencé
                      detail: L'allocataire n'est pas référencé auprès des caisses
                        éligibles
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Allocataire non référencé
                  description: L'allocataire n'est pas référencé auprès des caisses
                    éligibles
                erreur_inattendue_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Erreur inattendue
                      detail: Une erreur inattendue est survenue lors de la collecte
                        des données
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Erreur inattendue
                  description: Une erreur inattendue est survenue lors de la collecte
                    des données
              schema:
                "$ref": "#/components/schemas/Error"
        '502':
          description: Erreur du fournisseur
          content:
            application/json:
              examples:
                erreur_inconnue_du_fournisseur_de_donnees_37999:
                  value:
                    errors:
                    - code: '37999'
                      title: Erreur inconnue du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et inconnue de notre service. L'équipe technique
                        a été notifiée de cette erreur pour investigation.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur inconnue du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et inconnue de notre service. L'équipe technique
                    a été notifiée de cette erreur pour investigation.
                erreur_interne_du_fournisseur_de_donnees_37000:
                  value:
                    errors:
                    - code: '37000'
                      title: Erreur interne du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et a été identifié comme étant une erreur interne.
                        Si le problème persiste, consultez la page de status ou contactez
                        nous sur le support.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur interne du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et a été identifié comme étant une erreur interne.
                    Si le problème persiste, consultez la page de status ou contactez
                    nous sur le support.
                erreur_aupres_du_fournisseur_de_donnees_trop_de_requetes_37008:
                  value:
                    errors:
                    - code: '37008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: CNAV
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
                erreur_temporaire_du_fournisseur_de_donnees_37011:
                  value:
                    errors:
                    - code: '37011'
                      title: Erreur temporaire du fournisseur de données
                      detail: Merci de réessayer dans quelques instants
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur temporaire du fournisseur de données
                  description: Merci de réessayer dans quelques instants
                erreur_de_certificat_ssl_du_fournisseur_de_donnees_37009:
                  value:
                    errors:
                    - code: '37009'
                      title: Erreur de certificat SSL du fournisseur de données
                      detail: Le certificat SSL du fournisseur de données est invalide
                        ou expiré.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur de certificat SSL du fournisseur de données
                  description: Le certificat SSL du fournisseur de données est invalide
                    ou expiré.
              schema:
                "$ref": "#/components/schemas/Error"
        '504':
          description: Erreur d'intermédiaire
          content:
            application/json:
              examples:
                timeout_error:
                  value:
                    errors:
                    - code: '37002'
                      title: Intermédiaire hors-délai
                      detail: Temps d’attente d’une réponse du fournisseur de données
                        écoulé.
                      source:
                      meta:
                        provider: CNAV
                  summary: Intermédiaire hors-délai
                  description: Temps d’attente d’une réponse du fournisseur de données
                    écoulé.
                provider_unavailable_error:
                  value:
                    errors:
                    - code: '37001'
                      title: Service non disponible
                      detail: Service du fournisseur de données temporairement indisponible
                        ou en maintenance.
                      source:
                      meta:
                        provider: CNAV
                  summary: Service non disponible
                  description: Service du fournisseur de données temporairement indisponible
                    ou en maintenance.
                network_error:
                  value:
                    errors:
                    - code: '00501'
                      title: Erreur réseau
                      detail: Problème de connexion au serveur distant. L'erreur peut
                        venir soit du fournisseur, soit de API Entreprise. Il s'agit
                        souvent d'une erreur temporaire.
                      source:
                      meta:
                        retry_in: 10
                  summary: Erreur réseau
                  description: Problème de connexion au serveur distant. L'erreur
                    peut venir soit du fournisseur, soit de API Entreprise. Il s'agit
                    souvent d'une erreur temporaire.
                dns_resolution_error:
                  value:
                    errors:
                    - code: '37004'
                      title: Erreur de résolution DNS
                      detail: Problème de résolution DNS de l'adresse du serveur
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur de résolution DNS
                  description: Problème de résolution DNS de l'adresse du serveur
                provider_error:
                  value:
                    errors:
                    - code: '37008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: CNAV
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/dss/allocation_adulte_handicape/france_connect":
    get:
      summary: "[FranceConnect] Statut allocation adulte handicapé (AAH)"
      tags:
      - Statut Allocation Adulte Handicapé (AAH)
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: Cache-Control
        in: header
        description: Si cette valeur est fixée à "no-cache", le système de cache est
          alors ignoré et la donnée est directement récupérée depuis le fournisseur
          de données.
        schema:
          type: string
      security:
      - jwt_bearer_token: []
      description: "Statut bénéficiaire de l'allocation adulte handicapé (AAH). \n\n
        Retourne également des informations sur les dates d'ouverture des droits."
      responses:
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                missing_france_connect_access_token_error:
                  value:
                    errors:
                    - code: '50004'
                      title: Accès non autorisé
                      detail: 'Le jeton d''accès FranceConnect est manquant. Cet endpoint
                        requiert un jeton d''accès FranceConnect transmis via l''en-tête
                        Authorization: Bearer.'
                      source:
                      meta: {}
                  summary: Accès non autorisé
                  description: 'Le jeton d''accès FranceConnect est manquant. Cet
                    endpoint requiert un jeton d''accès FranceConnect transmis via
                    l''en-tête Authorization: Bearer.'
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Dossier trouvé
          headers:
            X-Response-Cached:
              schema:
                type: boolean
                example: true
                enum:
                - true
                - false
                default: false
              description: Indique si la réponse a été caché.
            X-Cache-Expires-in:
              schema:
                type: number
                nullable: true
                example: 9001
              description: Secondes avant que le cache n'expire. Si le cache est vide,
                ce header est vide (mais présent). La durée du cache est de 1 heure.
          x-operationId: api_particulier_v3_cnav_allocation_adulte_handicape_with_france_connect
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      est_beneficiaire:
                        title: Est bénéficiaire de l'allocation adulte handicapé (AAH)
                        type: boolean
                        example: true
                        description: Indique que le particulier est bénéficiaire de
                          l'allocation adulte handicapé au moment de l'appel.
                        x-scope: allocation_adulte_handicape
                      date_debut_droit:
                        title: Date d'ouverture du droit à l'AAH
                        type: string
                        nullable: true
                        description: "Date de début de droit à l'allocation adulte
                          handicapé du particulier bénéficiaire. \n Ce champs est
                          null dans le cas où le particulier n'est pas bénéficiaire
                          de l'AAH."
                        example: '1992-11-29'
                        x-scope: allocation_adulte_handicape
                    required:
                    - est_beneficiaire
                    - date_debut_droit
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '422':
          description: Impossible d'identifier l'allocataire
          content:
            application/json:
              examples:
                entite_non_traitable_00366:
                  value:
                    errors:
                    - code: '00366'
                      title: Entité non traitable
                      detail: Un ou plusieurs paramètres de civilité ne sont pas correctement
                        formatés
                      source:
                      meta: {}
                  summary: Entité non traitable
                  description: Un ou plusieurs paramètres de civilité ne sont pas
                    correctement formatés
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '404':
          description: Dossier allocataire inexistant. Le document ne peut être édité.
          content:
            application/json:
              examples:
                dossier_allocataire_absent:
                  value:
                    errors:
                    - code: '36003'
                      title: Dossier allocataire absent
                      detail: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                        de données est précisé dans 'meta.provider'.
                      source:
                      meta:
                        provider: Sécurité sociale
                  summary: Dossier allocataire absent
                  description: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                    de données est précisé dans 'meta.provider'.
                allocataire_non_reference_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Allocataire non référencé
                      detail: L'allocataire n'est pas référencé auprès des caisses
                        éligibles
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Allocataire non référencé
                  description: L'allocataire n'est pas référencé auprès des caisses
                    éligibles
                erreur_inattendue_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Erreur inattendue
                      detail: Une erreur inattendue est survenue lors de la collecte
                        des données
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Erreur inattendue
                  description: Une erreur inattendue est survenue lors de la collecte
                    des données
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/dss/allocation_enfant_handicape/identite":
    get:
      summary: "[Identité] Statut allocation d'éducation de l'enfant handicapé (AEEH)"
      tags:
      - Statut Allocation d'Éducation de l'Enfant Handicapé (AEEH)
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: Cache-Control
        in: header
        description: Si cette valeur est fixée à "no-cache", le système de cache est
          alors ignoré et la donnée est directement récupérée depuis le fournisseur
          de données.
        schema:
          type: string
      - name: nomNaissance
        in: query
        description: "**Nom de naissance, également appelé nom de famille**. \n\nLe
          nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le
          livret de famille, etc. Le nom de famille/naissance figure toujours sur
          la pièce d'identité en premier, avant le nom d'usage si le particulier en
          a un. \n\nEn cas de changement de nom de naissance, une mention avec le
          nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler
          l'API, le nom de naissance/famille nécessaire est bien le nom de famille
          modifié."
        example: DURANT
        required: true
        schema:
          type: string
      - name: nomUsage
        in: query
        description: "**Nom d'usage**. \n\nSi le particulier a un nom d'usage, c'est
          le nom qu'il utilise généralement au quotidien. Le nom d'usage est facultatif
          et peut changer au cours de la vie. Il correspond au nom de famille/naissance
          d'un parent, d'un époux ou d'une épouse, seul ou accolé au nom de famille/naissance.
          Par exemple, le nom d'usage ne peut pas être le nom de famille/naissance
          d'un concubin ou d'un partenaire de pacs. \n\nSi le particulier en a fait
          la demande, le nom d'usage peut être inscrit derrière le nom de naissance
          sur la carte d'identité ou le passeport ; il peut également être celui utilisé
          par l'administration sur les courriers. Le nom d'usage ne remplace pas le
          nom de famille/naissance qui reste le seul mentionné. \nDans nos APIs, le
          nom d'usage n'est jamais identique au nom de famille.\n\nPour en savoir
          plus : https://www.service-public.fr/particuliers/vosdroits/F868."
        example: DUPONT DURANT
        required: false
        schema:
          type: string
      - name: prenoms[]
        in: query
        schema:
          type: array
          minItems: 1
          maxItems: 3
          items:
            type: string
          example:
          - PIERRE
          - RICHARD
        description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise
          les chances que l'API retrouve le particulier car cela permet de limiter
          le risque d’homonymie."
        required: true
      - name: anneeDateNaissance
        in: query
        description: "**Année de naissance**. \n\nPour un particulier né en France,
          dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance',
          ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance')
          afin de retrouver le code COG de la commune de naissance."
        example: 1990
        required: false
        schema:
          type: integer
      - name: moisDateNaissance
        in: query
        description: "**Mois de naissance**. \n\nCette valeur est ignorée si le paramètre
          'anneeDateNaissance' est vide."
        example: 1
        required: false
        schema:
          type: integer
      - name: jourDateNaissance
        in: query
        description: "**Jour de naissance**. \n\nCette valeur est ignorée si le paramètre
          'moisDateNaissance' ou le paramètre 'anneeDateNaissance' est vide.\""
        example: 1
        required: false
        schema:
          type: integer
      - name: sexeEtatCivil
        in: query
        schema:
          type: string
          enum:
          - M
          - F
        description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**,
          comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité
          des cas, il s'agit également de la mention indiquée sur la pièce d'identité
          et le passeport. Cette mention peut être masculin ('M') ou féminin ('F').
          \nDans le cas d'un particulier ayant demandé une modification de sa mention
          de sexe à l'état civil, le changement est indiqué en marge de l'acte de
          naissance une fois la décision rendue. Le changement intervient sur les
          titres d'identité seulement si le particulier en demande le renouvellement."
        example: M
        required: false
      - name: codeCogInseePaysNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '99100'
        description: |-
          **Code Insee à 5 chiffres du pays de naissance**.

          - Code Insee France = 99100 ;
          - Liste de tous les codes Insee des pays étrangers depuis 1943 : https://explore.data.gouv.fr/fr/datasets/58c984b088ee386cdb1261f3/#/resources/150889d3-ffda-4ea5-8709-6ee67415294f.
        required: true
      - name: codeCogInseeCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '08480'
        description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation de la seconde option
          (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance'),
          ce paramètre est obligatoire si la personne est née en France.\n\nNe pas
          remplir si la personne est née à l'étranger."
        required: false
      - name: nomCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 1
          example: Gennevilliers
        description: "**Nom en toute lettre de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation du 'codeCogInseeCommuneNaissance',
          ce paramètre est obligatoire si la personne est née en France ; il doit
          être obligatoirement accompagné des paramètres 'codeCogInseeDepartementNaissance'
          et 'anneeDateNaissance'.\n\nNe pas remplir si la personne est née à l'étranger."
        required: false
      - name: codeCogInseeDepartementNaissance
        in: query
        schema:
          type: string
          minLength: 2
          maxLength: 3
          example: '92'
        description: "**Code INSEE du département de naissance**. \n\nPour retrouver
          un particulier né en France, il est nécessaire d'indiquer sa commune de
          naissance. Ce paramètre fait partie d'une des deux options disponibles pour
          renseigner la commune de naissance. Lorsque le paramètre 'nomCommuneNaissance'
          est utilisé, ce paramètre est obligatoire si la personne est née en France
          et permet de retrouver le code COG avec le paramètre 'anneeDateNaissance'.\n\nNe
          pas remplir si la personne est née à l'étranger."
        required: false
      security:
      - jwt_bearer_token: []
      description: "Statut bénéficiaire de l'allocation d'éducation de l'enfant handicapé
        (AEEH). \n\n Retourne également des informations sur les prestations et les
        dates d'ouverture des droits. \n L'indicateur précise si le particulier est
        allocataire, ouvrant droit ou non bénéficiaire de l'AEEH."
      responses:
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Allocation Enfant Handicapé active trouvée
          headers:
            X-Response-Cached:
              schema:
                type: boolean
                example: true
                enum:
                - true
                - false
                default: false
              description: Indique si la réponse a été caché.
            X-Cache-Expires-in:
              schema:
                type: number
                nullable: true
                example: 9001
              description: Secondes avant que le cache n'expire. Si le cache est vide,
                ce header est vide (mais présent). La durée du cache est de 1 heure.
          x-operationId: api_particulier_v3_cnav_allocation_enfant_handicape_with_civility
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      status:
                        title: Statut bénéficiaire de l'allocation d'éducation de
                          l'enfant handicapé (AEEH)
                        type: string
                        description: "Indique si le particulier est bénéficiaire de
                          l'allocation d'éducation de l'enfant handicapé au moment
                          de l'appel. \n \n - Si le statut est 'allocataire', cela
                          signifie que le particulier est l'allocataire de l'AEEH
                          (qualité bénéficiaire 105). Cela concerne généralement le
                          parent ou le tuteur légal de l'enfant handicapé. \n - Si
                          le statut est 'ouvrant_droit', cela signifie que le particulier
                          est ouvrant droit de l'AEEH (qualité bénéficiaire 205).
                          Cela concerne généralement l'enfant handicapé lui-même.
                          \n - Si le statut est 'non_beneficiaire', cela signifie
                          que le particulier n'est pas concerné par l'AEEH."
                        enum:
                        - allocataire
                        - ouvrant_droit
                        - non_beneficiaire
                        x-scope: cnav_allocation_enfant_handicape
                      date_debut_droit:
                        title: Date d'ouverture du droit à l'AEEH
                        type: string
                        nullable: true
                        description: "Date de début de droit à l'allocation enfant
                          handicapé du particulier bénéficiaire. \n Ce champs est
                          null dans le cas où le particulier n'est pas bénéficiaire
                          de l'AEEH."
                        example: '1992-11-29'
                        x-scope: cnav_allocation_enfant_handicape
                    required:
                    - status
                    - date_debut_droit
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '422':
          description: Impossible d'identifier l'allocataire
          content:
            application/json:
              examples:
                entite_non_traitable_00366:
                  value:
                    errors:
                    - code: '00366'
                      title: Entité non traitable
                      detail: Un ou plusieurs paramètres de civilité ne sont pas correctement
                        formatés
                      source:
                      meta: {}
                  summary: Entité non traitable
                  description: Un ou plusieurs paramètres de civilité ne sont pas
                    correctement formatés
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '404':
          description: Dossier allocataire inexistant. Le document ne peut être édité.
          content:
            application/json:
              examples:
                dossier_allocataire_absent:
                  value:
                    errors:
                    - code: '36003'
                      title: Dossier allocataire absent
                      detail: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                        de données est précisé dans 'meta.provider'.
                      source:
                      meta:
                        provider: Sécurité sociale
                  summary: Dossier allocataire absent
                  description: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                    de données est précisé dans 'meta.provider'.
                allocataire_non_reference_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Allocataire non référencé
                      detail: L'allocataire n'est pas référencé auprès des caisses
                        éligibles
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Allocataire non référencé
                  description: L'allocataire n'est pas référencé auprès des caisses
                    éligibles
                erreur_inattendue_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Erreur inattendue
                      detail: Une erreur inattendue est survenue lors de la collecte
                        des données
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Erreur inattendue
                  description: Une erreur inattendue est survenue lors de la collecte
                    des données
              schema:
                "$ref": "#/components/schemas/Error"
        '502':
          description: Erreur du fournisseur
          content:
            application/json:
              examples:
                erreur_inconnue_du_fournisseur_de_donnees_37999:
                  value:
                    errors:
                    - code: '37999'
                      title: Erreur inconnue du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et inconnue de notre service. L'équipe technique
                        a été notifiée de cette erreur pour investigation.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur inconnue du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et inconnue de notre service. L'équipe technique
                    a été notifiée de cette erreur pour investigation.
                erreur_interne_du_fournisseur_de_donnees_37000:
                  value:
                    errors:
                    - code: '37000'
                      title: Erreur interne du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et a été identifié comme étant une erreur interne.
                        Si le problème persiste, consultez la page de status ou contactez
                        nous sur le support.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur interne du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et a été identifié comme étant une erreur interne.
                    Si le problème persiste, consultez la page de status ou contactez
                    nous sur le support.
                erreur_aupres_du_fournisseur_de_donnees_trop_de_requetes_37008:
                  value:
                    errors:
                    - code: '37008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: CNAV
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
                erreur_temporaire_du_fournisseur_de_donnees_37011:
                  value:
                    errors:
                    - code: '37011'
                      title: Erreur temporaire du fournisseur de données
                      detail: Merci de réessayer dans quelques instants
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur temporaire du fournisseur de données
                  description: Merci de réessayer dans quelques instants
                erreur_de_certificat_ssl_du_fournisseur_de_donnees_37009:
                  value:
                    errors:
                    - code: '37009'
                      title: Erreur de certificat SSL du fournisseur de données
                      detail: Le certificat SSL du fournisseur de données est invalide
                        ou expiré.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur de certificat SSL du fournisseur de données
                  description: Le certificat SSL du fournisseur de données est invalide
                    ou expiré.
              schema:
                "$ref": "#/components/schemas/Error"
        '504':
          description: Erreur d'intermédiaire
          content:
            application/json:
              examples:
                timeout_error:
                  value:
                    errors:
                    - code: '37002'
                      title: Intermédiaire hors-délai
                      detail: Temps d’attente d’une réponse du fournisseur de données
                        écoulé.
                      source:
                      meta:
                        provider: CNAV
                  summary: Intermédiaire hors-délai
                  description: Temps d’attente d’une réponse du fournisseur de données
                    écoulé.
                provider_unavailable_error:
                  value:
                    errors:
                    - code: '37001'
                      title: Service non disponible
                      detail: Service du fournisseur de données temporairement indisponible
                        ou en maintenance.
                      source:
                      meta:
                        provider: CNAV
                  summary: Service non disponible
                  description: Service du fournisseur de données temporairement indisponible
                    ou en maintenance.
                network_error:
                  value:
                    errors:
                    - code: '00501'
                      title: Erreur réseau
                      detail: Problème de connexion au serveur distant. L'erreur peut
                        venir soit du fournisseur, soit de API Entreprise. Il s'agit
                        souvent d'une erreur temporaire.
                      source:
                      meta:
                        retry_in: 10
                  summary: Erreur réseau
                  description: Problème de connexion au serveur distant. L'erreur
                    peut venir soit du fournisseur, soit de API Entreprise. Il s'agit
                    souvent d'une erreur temporaire.
                dns_resolution_error:
                  value:
                    errors:
                    - code: '37004'
                      title: Erreur de résolution DNS
                      detail: Problème de résolution DNS de l'adresse du serveur
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur de résolution DNS
                  description: Problème de résolution DNS de l'adresse du serveur
                provider_error:
                  value:
                    errors:
                    - code: '37008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: CNAV
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/dss/allocation_enfant_handicape/france_connect":
    get:
      summary: "[FranceConnect] Statut allocation d'éducation de l'enfant handicapé
        (AEEH)"
      tags:
      - Statut Allocation d'Éducation de l'Enfant Handicapé (AEEH)
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: Cache-Control
        in: header
        description: Si cette valeur est fixée à "no-cache", le système de cache est
          alors ignoré et la donnée est directement récupérée depuis le fournisseur
          de données.
        schema:
          type: string
      security:
      - jwt_bearer_token: []
      description: "Statut bénéficiaire de l'allocation d'éducation de l'enfant handicapé
        (AEEH). \n\n Retourne également des informations sur les prestations et les
        dates d'ouverture des droits. \n L'indicateur précise si le particulier est
        allocataire, ouvrant droit ou non bénéficiaire de l'AEEH."
      responses:
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                missing_france_connect_access_token_error:
                  value:
                    errors:
                    - code: '50004'
                      title: Accès non autorisé
                      detail: 'Le jeton d''accès FranceConnect est manquant. Cet endpoint
                        requiert un jeton d''accès FranceConnect transmis via l''en-tête
                        Authorization: Bearer.'
                      source:
                      meta: {}
                  summary: Accès non autorisé
                  description: 'Le jeton d''accès FranceConnect est manquant. Cet
                    endpoint requiert un jeton d''accès FranceConnect transmis via
                    l''en-tête Authorization: Bearer.'
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Dossier trouvé
          headers:
            X-Response-Cached:
              schema:
                type: boolean
                example: true
                enum:
                - true
                - false
                default: false
              description: Indique si la réponse a été caché.
            X-Cache-Expires-in:
              schema:
                type: number
                nullable: true
                example: 9001
              description: Secondes avant que le cache n'expire. Si le cache est vide,
                ce header est vide (mais présent). La durée du cache est de 1 heure.
          x-operationId: api_particulier_v3_cnav_allocation_enfant_handicape_with_france_connect
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      status:
                        title: Statut bénéficiaire de l'allocation d'éducation de
                          l'enfant handicapé (AEEH)
                        type: string
                        description: "Indique si le particulier est bénéficiaire de
                          l'allocation d'éducation de l'enfant handicapé au moment
                          de l'appel. \n \n - Si le statut est 'allocataire', cela
                          signifie que le particulier est l'allocataire de l'AEEH
                          (qualité bénéficiaire 105). Cela concerne généralement le
                          parent ou le tuteur légal de l'enfant handicapé. \n - Si
                          le statut est 'ouvrant_droit', cela signifie que le particulier
                          est ouvrant droit de l'AEEH (qualité bénéficiaire 205).
                          Cela concerne généralement l'enfant handicapé lui-même.
                          \n - Si le statut est 'non_beneficiaire', cela signifie
                          que le particulier n'est pas concerné par l'AEEH."
                        enum:
                        - allocataire
                        - ouvrant_droit
                        - non_beneficiaire
                        x-scope: cnav_allocation_enfant_handicape
                      date_debut_droit:
                        title: Date d'ouverture du droit à l'AEEH
                        type: string
                        nullable: true
                        description: "Date de début de droit à l'allocation enfant
                          handicapé du particulier bénéficiaire. \n Ce champs est
                          null dans le cas où le particulier n'est pas bénéficiaire
                          de l'AEEH."
                        example: '1992-11-29'
                        x-scope: cnav_allocation_enfant_handicape
                    required:
                    - status
                    - date_debut_droit
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '422':
          description: Impossible d'identifier l'allocataire
          content:
            application/json:
              examples:
                entite_non_traitable_00366:
                  value:
                    errors:
                    - code: '00366'
                      title: Entité non traitable
                      detail: Un ou plusieurs paramètres de civilité ne sont pas correctement
                        formatés
                      source:
                      meta: {}
                  summary: Entité non traitable
                  description: Un ou plusieurs paramètres de civilité ne sont pas
                    correctement formatés
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '404':
          description: Dossier allocataire inexistant. Le document ne peut être édité.
          content:
            application/json:
              examples:
                dossier_allocataire_absent:
                  value:
                    errors:
                    - code: '36003'
                      title: Dossier allocataire absent
                      detail: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                        de données est précisé dans 'meta.provider'.
                      source:
                      meta:
                        provider: Sécurité sociale
                  summary: Dossier allocataire absent
                  description: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                    de données est précisé dans 'meta.provider'.
                allocataire_non_reference_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Allocataire non référencé
                      detail: L'allocataire n'est pas référencé auprès des caisses
                        éligibles
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Allocataire non référencé
                  description: L'allocataire n'est pas référencé auprès des caisses
                    éligibles
                erreur_inattendue_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Erreur inattendue
                      detail: Une erreur inattendue est survenue lors de la collecte
                        des données
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Erreur inattendue
                  description: Une erreur inattendue est survenue lors de la collecte
                    des données
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/dss/allocation_soutien_familial/identite":
    get:
      summary: "[Identité] Statut allocation de soutien familial (ASF)"
      tags:
      - Statut Allocation Soutien Familial (ASF)
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: Cache-Control
        in: header
        description: Si cette valeur est fixée à "no-cache", le système de cache est
          alors ignoré et la donnée est directement récupérée depuis le fournisseur
          de données.
        schema:
          type: string
      - name: nomNaissance
        in: query
        description: "**Nom de naissance, également appelé nom de famille**. \n\nLe
          nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le
          livret de famille, etc. Le nom de famille/naissance figure toujours sur
          la pièce d'identité en premier, avant le nom d'usage si le particulier en
          a un. \n\nEn cas de changement de nom de naissance, une mention avec le
          nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler
          l'API, le nom de naissance/famille nécessaire est bien le nom de famille
          modifié."
        example: DURANT
        required: true
        schema:
          type: string
      - name: nomUsage
        in: query
        description: "**Nom d'usage**. \n\nSi le particulier a un nom d'usage, c'est
          le nom qu'il utilise généralement au quotidien. Le nom d'usage est facultatif
          et peut changer au cours de la vie. Il correspond au nom de famille/naissance
          d'un parent, d'un époux ou d'une épouse, seul ou accolé au nom de famille/naissance.
          Par exemple, le nom d'usage ne peut pas être le nom de famille/naissance
          d'un concubin ou d'un partenaire de pacs. \n\nSi le particulier en a fait
          la demande, le nom d'usage peut être inscrit derrière le nom de naissance
          sur la carte d'identité ou le passeport ; il peut également être celui utilisé
          par l'administration sur les courriers. Le nom d'usage ne remplace pas le
          nom de famille/naissance qui reste le seul mentionné. \nDans nos APIs, le
          nom d'usage n'est jamais identique au nom de famille.\n\nPour en savoir
          plus : https://www.service-public.fr/particuliers/vosdroits/F868."
        example: DUPONT DURANT
        required: false
        schema:
          type: string
      - name: prenoms[]
        in: query
        schema:
          type: array
          minItems: 1
          maxItems: 3
          items:
            type: string
          example:
          - PIERRE
          - RICHARD
        description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise
          les chances que l'API retrouve le particulier car cela permet de limiter
          le risque d’homonymie."
        required: true
      - name: anneeDateNaissance
        in: query
        description: "**Année de naissance**. \n\nPour un particulier né en France,
          dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance',
          ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance')
          afin de retrouver le code COG de la commune de naissance."
        example: 1990
        required: false
        schema:
          type: integer
      - name: moisDateNaissance
        in: query
        description: "**Mois de naissance**. \n\nCette valeur est ignorée si le paramètre
          'anneeDateNaissance' est vide."
        example: 1
        required: false
        schema:
          type: integer
      - name: jourDateNaissance
        in: query
        description: "**Jour de naissance**. \n\nCette valeur est ignorée si le paramètre
          'moisDateNaissance' ou le paramètre 'anneeDateNaissance' est vide.\""
        example: 1
        required: false
        schema:
          type: integer
      - name: sexeEtatCivil
        in: query
        schema:
          type: string
          enum:
          - M
          - F
        description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**,
          comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité
          des cas, il s'agit également de la mention indiquée sur la pièce d'identité
          et le passeport. Cette mention peut être masculin ('M') ou féminin ('F').
          \nDans le cas d'un particulier ayant demandé une modification de sa mention
          de sexe à l'état civil, le changement est indiqué en marge de l'acte de
          naissance une fois la décision rendue. Le changement intervient sur les
          titres d'identité seulement si le particulier en demande le renouvellement."
        example: M
        required: false
      - name: codeCogInseePaysNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '99100'
        description: |-
          **Code Insee à 5 chiffres du pays de naissance**.

          - Code Insee France = 99100 ;
          - Liste de tous les codes Insee des pays étrangers depuis 1943 : https://explore.data.gouv.fr/fr/datasets/58c984b088ee386cdb1261f3/#/resources/150889d3-ffda-4ea5-8709-6ee67415294f.
        required: true
      - name: codeCogInseeCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '08480'
        description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation de la seconde option
          (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance'),
          ce paramètre est obligatoire si la personne est née en France.\n\nNe pas
          remplir si la personne est née à l'étranger."
        required: false
      - name: nomCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 1
          example: Gennevilliers
        description: "**Nom en toute lettre de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation du 'codeCogInseeCommuneNaissance',
          ce paramètre est obligatoire si la personne est née en France ; il doit
          être obligatoirement accompagné des paramètres 'codeCogInseeDepartementNaissance'
          et 'anneeDateNaissance'.\n\nNe pas remplir si la personne est née à l'étranger."
        required: false
      - name: codeCogInseeDepartementNaissance
        in: query
        schema:
          type: string
          minLength: 2
          maxLength: 3
          example: '92'
        description: "**Code INSEE du département de naissance**. \n\nPour retrouver
          un particulier né en France, il est nécessaire d'indiquer sa commune de
          naissance. Ce paramètre fait partie d'une des deux options disponibles pour
          renseigner la commune de naissance. Lorsque le paramètre 'nomCommuneNaissance'
          est utilisé, ce paramètre est obligatoire si la personne est née en France
          et permet de retrouver le code COG avec le paramètre 'anneeDateNaissance'.\n\nNe
          pas remplir si la personne est née à l'étranger."
        required: false
      security:
      - jwt_bearer_token: []
      description: "Statut bénéficiaire de l'allocation de soutien familial (ASF).
        \n\n Retourne également des informations sur les dates d'ouverture et de fermeture
        des droits."
      responses:
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Allocation Soutien Familial active trouvée
          headers:
            X-Response-Cached:
              schema:
                type: boolean
                example: true
                enum:
                - true
                - false
                default: false
              description: Indique si la réponse a été caché.
            X-Cache-Expires-in:
              schema:
                type: number
                nullable: true
                example: 9001
              description: Secondes avant que le cache n'expire. Si le cache est vide,
                ce header est vide (mais présent). La durée du cache est de 1 heure.
          x-operationId: api_particulier_v3_cnav_allocation_soutien_familial_with_civility
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      est_beneficiaire:
                        title: Est bénéficiaire de l'allocation de soutien familial
                          (ASF)
                        type: boolean
                        example: true
                        description: Indique que le particulier est bénéficiaire de
                          l'allocation de soutien familial au moment de l'appel.
                        x-scope: allocation_soutien_familial
                      date_debut_droit:
                        title: Date d'ouverture du droit à l'ASF
                        type: string
                        nullable: true
                        description: "Date de début de droit à l'allocation de soutien
                          familial du particulier bénéficiaire. \n Ce champ est null
                          dans le cas où le particulier n'est pas bénéficiaire de
                          l'ASF."
                        example: '1992-11-29'
                        x-scope: allocation_soutien_familial
                    required:
                    - est_beneficiaire
                    - date_debut_droit
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '422':
          description: Impossible d'identifier l'allocataire
          content:
            application/json:
              examples:
                entite_non_traitable_00366:
                  value:
                    errors:
                    - code: '00366'
                      title: Entité non traitable
                      detail: Un ou plusieurs paramètres de civilité ne sont pas correctement
                        formatés
                      source:
                      meta: {}
                  summary: Entité non traitable
                  description: Un ou plusieurs paramètres de civilité ne sont pas
                    correctement formatés
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '404':
          description: Dossier allocataire inexistant. Le document ne peut être édité.
          content:
            application/json:
              examples:
                dossier_allocataire_absent:
                  value:
                    errors:
                    - code: '36003'
                      title: Dossier allocataire absent
                      detail: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                        de données est précisé dans 'meta.provider'.
                      source:
                      meta:
                        provider: Sécurité sociale
                  summary: Dossier allocataire absent
                  description: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                    de données est précisé dans 'meta.provider'.
                allocataire_non_reference_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Allocataire non référencé
                      detail: L'allocataire n'est pas référencé auprès des caisses
                        éligibles
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Allocataire non référencé
                  description: L'allocataire n'est pas référencé auprès des caisses
                    éligibles
                erreur_inattendue_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Erreur inattendue
                      detail: Une erreur inattendue est survenue lors de la collecte
                        des données
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Erreur inattendue
                  description: Une erreur inattendue est survenue lors de la collecte
                    des données
              schema:
                "$ref": "#/components/schemas/Error"
        '502':
          description: Erreur du fournisseur
          content:
            application/json:
              examples:
                erreur_inconnue_du_fournisseur_de_donnees_37999:
                  value:
                    errors:
                    - code: '37999'
                      title: Erreur inconnue du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et inconnue de notre service. L'équipe technique
                        a été notifiée de cette erreur pour investigation.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur inconnue du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et inconnue de notre service. L'équipe technique
                    a été notifiée de cette erreur pour investigation.
                erreur_interne_du_fournisseur_de_donnees_37000:
                  value:
                    errors:
                    - code: '37000'
                      title: Erreur interne du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et a été identifié comme étant une erreur interne.
                        Si le problème persiste, consultez la page de status ou contactez
                        nous sur le support.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur interne du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et a été identifié comme étant une erreur interne.
                    Si le problème persiste, consultez la page de status ou contactez
                    nous sur le support.
                erreur_aupres_du_fournisseur_de_donnees_trop_de_requetes_37008:
                  value:
                    errors:
                    - code: '37008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: CNAV
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
                erreur_temporaire_du_fournisseur_de_donnees_37011:
                  value:
                    errors:
                    - code: '37011'
                      title: Erreur temporaire du fournisseur de données
                      detail: Merci de réessayer dans quelques instants
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur temporaire du fournisseur de données
                  description: Merci de réessayer dans quelques instants
                erreur_de_certificat_ssl_du_fournisseur_de_donnees_37009:
                  value:
                    errors:
                    - code: '37009'
                      title: Erreur de certificat SSL du fournisseur de données
                      detail: Le certificat SSL du fournisseur de données est invalide
                        ou expiré.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur de certificat SSL du fournisseur de données
                  description: Le certificat SSL du fournisseur de données est invalide
                    ou expiré.
              schema:
                "$ref": "#/components/schemas/Error"
        '504':
          description: Erreur d'intermédiaire
          content:
            application/json:
              examples:
                timeout_error:
                  value:
                    errors:
                    - code: '37002'
                      title: Intermédiaire hors-délai
                      detail: Temps d’attente d’une réponse du fournisseur de données
                        écoulé.
                      source:
                      meta:
                        provider: CNAV
                  summary: Intermédiaire hors-délai
                  description: Temps d’attente d’une réponse du fournisseur de données
                    écoulé.
                provider_unavailable_error:
                  value:
                    errors:
                    - code: '37001'
                      title: Service non disponible
                      detail: Service du fournisseur de données temporairement indisponible
                        ou en maintenance.
                      source:
                      meta:
                        provider: CNAV
                  summary: Service non disponible
                  description: Service du fournisseur de données temporairement indisponible
                    ou en maintenance.
                network_error:
                  value:
                    errors:
                    - code: '00501'
                      title: Erreur réseau
                      detail: Problème de connexion au serveur distant. L'erreur peut
                        venir soit du fournisseur, soit de API Entreprise. Il s'agit
                        souvent d'une erreur temporaire.
                      source:
                      meta:
                        retry_in: 10
                  summary: Erreur réseau
                  description: Problème de connexion au serveur distant. L'erreur
                    peut venir soit du fournisseur, soit de API Entreprise. Il s'agit
                    souvent d'une erreur temporaire.
                dns_resolution_error:
                  value:
                    errors:
                    - code: '37004'
                      title: Erreur de résolution DNS
                      detail: Problème de résolution DNS de l'adresse du serveur
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur de résolution DNS
                  description: Problème de résolution DNS de l'adresse du serveur
                provider_error:
                  value:
                    errors:
                    - code: '37008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: CNAV
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/dss/allocation_soutien_familial/france_connect":
    get:
      summary: "[FranceConnect] Statut allocation de soutien familial (ASF)"
      tags:
      - Statut Allocation Soutien Familial (ASF)
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: Cache-Control
        in: header
        description: Si cette valeur est fixée à "no-cache", le système de cache est
          alors ignoré et la donnée est directement récupérée depuis le fournisseur
          de données.
        schema:
          type: string
      security:
      - jwt_bearer_token: []
      description: "Statut bénéficiaire de l'allocation de soutien familial (ASF).
        \n\n Retourne également des informations sur les dates d'ouverture et de fermeture
        des droits."
      responses:
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                missing_france_connect_access_token_error:
                  value:
                    errors:
                    - code: '50004'
                      title: Accès non autorisé
                      detail: 'Le jeton d''accès FranceConnect est manquant. Cet endpoint
                        requiert un jeton d''accès FranceConnect transmis via l''en-tête
                        Authorization: Bearer.'
                      source:
                      meta: {}
                  summary: Accès non autorisé
                  description: 'Le jeton d''accès FranceConnect est manquant. Cet
                    endpoint requiert un jeton d''accès FranceConnect transmis via
                    l''en-tête Authorization: Bearer.'
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Dossier trouvé
          headers:
            X-Response-Cached:
              schema:
                type: boolean
                example: true
                enum:
                - true
                - false
                default: false
              description: Indique si la réponse a été caché.
            X-Cache-Expires-in:
              schema:
                type: number
                nullable: true
                example: 9001
              description: Secondes avant que le cache n'expire. Si le cache est vide,
                ce header est vide (mais présent). La durée du cache est de 1 heure.
          x-operationId: api_particulier_v3_cnav_allocation_soutien_familial_with_france_connect
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      est_beneficiaire:
                        title: Est bénéficiaire de l'allocation de soutien familial
                          (ASF)
                        type: boolean
                        example: true
                        description: Indique que le particulier est bénéficiaire de
                          l'allocation de soutien familial au moment de l'appel.
                        x-scope: allocation_soutien_familial
                      date_debut_droit:
                        title: Date d'ouverture du droit à l'ASF
                        type: string
                        nullable: true
                        description: "Date de début de droit à l'allocation de soutien
                          familial du particulier bénéficiaire. \n Ce champ est null
                          dans le cas où le particulier n'est pas bénéficiaire de
                          l'ASF."
                        example: '1992-11-29'
                        x-scope: allocation_soutien_familial
                    required:
                    - est_beneficiaire
                    - date_debut_droit
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '422':
          description: Impossible d'identifier l'allocataire
          content:
            application/json:
              examples:
                entite_non_traitable_00366:
                  value:
                    errors:
                    - code: '00366'
                      title: Entité non traitable
                      detail: Un ou plusieurs paramètres de civilité ne sont pas correctement
                        formatés
                      source:
                      meta: {}
                  summary: Entité non traitable
                  description: Un ou plusieurs paramètres de civilité ne sont pas
                    correctement formatés
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '404':
          description: Dossier allocataire inexistant. Le document ne peut être édité.
          content:
            application/json:
              examples:
                dossier_allocataire_absent:
                  value:
                    errors:
                    - code: '36003'
                      title: Dossier allocataire absent
                      detail: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                        de données est précisé dans 'meta.provider'.
                      source:
                      meta:
                        provider: Sécurité sociale
                  summary: Dossier allocataire absent
                  description: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                    de données est précisé dans 'meta.provider'.
                allocataire_non_reference_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Allocataire non référencé
                      detail: L'allocataire n'est pas référencé auprès des caisses
                        éligibles
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Allocataire non référencé
                  description: L'allocataire n'est pas référencé auprès des caisses
                    éligibles
                erreur_inattendue_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Erreur inattendue
                      detail: Une erreur inattendue est survenue lors de la collecte
                        des données
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Erreur inattendue
                  description: Une erreur inattendue est survenue lors de la collecte
                    des données
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/dss/complementaire_sante_solidaire/identite":
    get:
      summary: "[Identité] Statut complémentaire santé solidaire (C2S)"
      tags:
      - Statut Complémentaire Santé Solidaire (C2S)
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: Cache-Control
        in: header
        description: Si cette valeur est fixée à "no-cache", le système de cache est
          alors ignoré et la donnée est directement récupérée depuis le fournisseur
          de données.
        schema:
          type: string
      - name: nomNaissance
        in: query
        description: "**Nom de naissance, également appelé nom de famille**. \n\nLe
          nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le
          livret de famille, etc. Le nom de famille/naissance figure toujours sur
          la pièce d'identité en premier, avant le nom d'usage si le particulier en
          a un. \n\nEn cas de changement de nom de naissance, une mention avec le
          nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler
          l'API, le nom de naissance/famille nécessaire est bien le nom de famille
          modifié."
        example: DURANT
        required: true
        schema:
          type: string
      - name: nomUsage
        in: query
        description: "**Nom d'usage**. \n\nSi le particulier a un nom d'usage, c'est
          le nom qu'il utilise généralement au quotidien. Le nom d'usage est facultatif
          et peut changer au cours de la vie. Il correspond au nom de famille/naissance
          d'un parent, d'un époux ou d'une épouse, seul ou accolé au nom de famille/naissance.
          Par exemple, le nom d'usage ne peut pas être le nom de famille/naissance
          d'un concubin ou d'un partenaire de pacs. \n\nSi le particulier en a fait
          la demande, le nom d'usage peut être inscrit derrière le nom de naissance
          sur la carte d'identité ou le passeport ; il peut également être celui utilisé
          par l'administration sur les courriers. Le nom d'usage ne remplace pas le
          nom de famille/naissance qui reste le seul mentionné. \nDans nos APIs, le
          nom d'usage n'est jamais identique au nom de famille.\n\nPour en savoir
          plus : https://www.service-public.fr/particuliers/vosdroits/F868."
        example: DUPONT DURANT
        required: false
        schema:
          type: string
      - name: prenoms[]
        in: query
        schema:
          type: array
          minItems: 1
          maxItems: 3
          items:
            type: string
          example:
          - PIERRE
          - RICHARD
        description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise
          les chances que l'API retrouve le particulier car cela permet de limiter
          le risque d’homonymie."
        required: true
      - name: anneeDateNaissance
        in: query
        description: "**Année de naissance**. \n\nPour un particulier né en France,
          dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance',
          ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance')
          afin de retrouver le code COG de la commune de naissance."
        example: 1990
        required: false
        schema:
          type: integer
      - name: moisDateNaissance
        in: query
        description: "**Mois de naissance**. \n\nCette valeur est ignorée si le paramètre
          'anneeDateNaissance' est vide."
        example: 1
        required: false
        schema:
          type: integer
      - name: jourDateNaissance
        in: query
        description: "**Jour de naissance**. \n\nCette valeur est ignorée si le paramètre
          'moisDateNaissance' ou le paramètre 'anneeDateNaissance' est vide.\""
        example: 1
        required: false
        schema:
          type: integer
      - name: sexeEtatCivil
        in: query
        schema:
          type: string
          enum:
          - M
          - F
        description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**,
          comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité
          des cas, il s'agit également de la mention indiquée sur la pièce d'identité
          et le passeport. Cette mention peut être masculin ('M') ou féminin ('F').
          \nDans le cas d'un particulier ayant demandé une modification de sa mention
          de sexe à l'état civil, le changement est indiqué en marge de l'acte de
          naissance une fois la décision rendue. Le changement intervient sur les
          titres d'identité seulement si le particulier en demande le renouvellement."
        example: M
        required: false
      - name: codeCogInseePaysNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '99100'
        description: |-
          **Code Insee à 5 chiffres du pays de naissance**.

          - Code Insee France = 99100 ;
          - Liste de tous les codes Insee des pays étrangers depuis 1943 : https://explore.data.gouv.fr/fr/datasets/58c984b088ee386cdb1261f3/#/resources/150889d3-ffda-4ea5-8709-6ee67415294f.
        required: true
      - name: codeCogInseeCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '08480'
        description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation de la seconde option
          (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance'),
          ce paramètre est obligatoire si la personne est née en France.\n\nNe pas
          remplir si la personne est née à l'étranger."
        required: false
      - name: nomCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 1
          example: Gennevilliers
        description: "**Nom en toute lettre de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation du 'codeCogInseeCommuneNaissance',
          ce paramètre est obligatoire si la personne est née en France ; il doit
          être obligatoirement accompagné des paramètres 'codeCogInseeDepartementNaissance'
          et 'anneeDateNaissance'.\n\nNe pas remplir si la personne est née à l'étranger."
        required: false
      - name: codeCogInseeDepartementNaissance
        in: query
        schema:
          type: string
          minLength: 2
          maxLength: 3
          example: '92'
        description: "**Code INSEE du département de naissance**. \n\nPour retrouver
          un particulier né en France, il est nécessaire d'indiquer sa commune de
          naissance. Ce paramètre fait partie d'une des deux options disponibles pour
          renseigner la commune de naissance. Lorsque le paramètre 'nomCommuneNaissance'
          est utilisé, ce paramètre est obligatoire si la personne est née en France
          et permet de retrouver le code COG avec le paramètre 'anneeDateNaissance'.\n\nNe
          pas remplir si la personne est née à l'étranger."
        required: false
      security:
      - jwt_bearer_token: []
      description: "Statut bénéficiaire de la complémentaire santé solidaire (C2S).
        \n\n Retourne également des informations sur les dates d'ouverture des droits.
        \n Pour plus d'informations sur cette API et obtenir un accès en avant-première,
        veuillez contacter l'équipe API Particulier. \n **Données disponibles en bac
        à sable :** [Liste de payloads de test](https://github.com/datagouv/apistration/blob/develop/mocks/payloads/complementaire_sante_solidaire)"
      responses:
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Complementaire Sante Solidaire trouvée
          headers:
            X-Response-Cached:
              schema:
                type: boolean
                example: true
                enum:
                - true
                - false
                default: false
              description: Indique si la réponse a été caché.
            X-Cache-Expires-in:
              schema:
                type: number
                nullable: true
                example: 9001
              description: Secondes avant que le cache n'expire. Si le cache est vide,
                ce header est vide (mais présent). La durée du cache est de 1 heure.
          x-operationId: api_particulier_v3_cnav_complementaire_sante_solidaire_with_civility
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      est_beneficiaire:
                        title: Est bénéficiaire de la complémentaire de santé solidaire
                          (C2S)
                        type: boolean
                        example: true
                        description: Indique que le particulier est bénéficiaire de
                          la complémentaire de santé solidaire au moment de l'appel.
                        x-scope: complementaire_sante_solidaire
                      avec_participation:
                        title: C2S avec participation financière
                        type: boolean
                        example: false
                        nullable: true
                        description: "Indique que la C2S du particulier bénéficiaire
                          est avec participation financière. \n Si ce champ est à
                          false, cela signifie que la C2S est sans participation financière
                          de la part de l'allocataire. \n Ce champ est null dans le
                          cas où le particulier n'est pas bénéficiaire de la C2S."
                        x-scope: complementaire_sante_solidaire
                      date_debut_droit:
                        title: Date d'ouverture du droit en cours à la C2S
                        type: string
                        nullable: true
                        description: |
                          Date de début du droit à la complémentaire santé solidaire du particulier bénéficiaire.
                          \n
                          \n
                          Cette date est relative à la prestation en cours. C'est-à-dire :
                          \n
                          - Dans le cas d'une attribution l'année en cours N, la date de début correspondra à la date de l'attribution ;
                          - Dans le cas d'une attribution l'année passée N-1, qui est renouvelée en année N, la date de début correspondra à la date d'attribution l'année passée N-1 ;
                          - Dans le cas où, en année N-2 un allocataire était bénéficiaire, puis ne l'était plus en année N-1, puis l'est à nouveau dans l'année en cours N, la date de début correspond à la date d'attribution de la prestation en cours (et donc de l'année N).
                          \n
                          \n
                          Ce champ est null dans le cas où le particulier n'est pas bénéficiaire de la C2S.
                        example: '1992-11-29'
                        x-scope: complementaire_sante_solidaire
                    required:
                    - est_beneficiaire
                    - avec_participation
                    - date_debut_droit
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '422':
          description: Impossible d'identifier l'allocataire
          content:
            application/json:
              examples:
                entite_non_traitable_00366:
                  value:
                    errors:
                    - code: '00366'
                      title: Entité non traitable
                      detail: Un ou plusieurs paramètres de civilité ne sont pas correctement
                        formatés
                      source:
                      meta: {}
                  summary: Entité non traitable
                  description: Un ou plusieurs paramètres de civilité ne sont pas
                    correctement formatés
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '404':
          description: Dossier allocataire inexistant. Le document ne peut être édité.
          content:
            application/json:
              examples:
                dossier_allocataire_absent:
                  value:
                    errors:
                    - code: '36003'
                      title: Dossier allocataire absent
                      detail: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                        de données est précisé dans 'meta.provider'.
                      source:
                      meta:
                        provider: Sécurité sociale
                  summary: Dossier allocataire absent
                  description: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                    de données est précisé dans 'meta.provider'.
                allocataire_non_reference_40003:
                  value:
                    errors:
                    - code: '40003'
                      title: Allocataire non référencé
                      detail: L'allocataire n'est pas référencé auprès des caisses
                        éligibles
                      source:
                      meta:
                        provider: RNCPS
                  summary: Allocataire non référencé
                  description: L'allocataire n'est pas référencé auprès des caisses
                    éligibles
                erreur_inattendue_40003:
                  value:
                    errors:
                    - code: '40003'
                      title: Erreur inattendue
                      detail: Une erreur inattendue est survenue lors de la collecte
                        des données
                      source:
                      meta:
                        provider: RNCPS
                  summary: Erreur inattendue
                  description: Une erreur inattendue est survenue lors de la collecte
                    des données
              schema:
                "$ref": "#/components/schemas/Error"
        '502':
          description: Erreur du fournisseur
          content:
            application/json:
              examples:
                erreur_inconnue_du_fournisseur_de_donnees_37999:
                  value:
                    errors:
                    - code: '37999'
                      title: Erreur inconnue du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et inconnue de notre service. L'équipe technique
                        a été notifiée de cette erreur pour investigation.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur inconnue du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et inconnue de notre service. L'équipe technique
                    a été notifiée de cette erreur pour investigation.
                erreur_interne_du_fournisseur_de_donnees_37000:
                  value:
                    errors:
                    - code: '37000'
                      title: Erreur interne du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et a été identifié comme étant une erreur interne.
                        Si le problème persiste, consultez la page de status ou contactez
                        nous sur le support.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur interne du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et a été identifié comme étant une erreur interne.
                    Si le problème persiste, consultez la page de status ou contactez
                    nous sur le support.
                erreur_aupres_du_fournisseur_de_donnees_trop_de_requetes_37008:
                  value:
                    errors:
                    - code: '37008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: CNAV
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
                erreur_temporaire_du_fournisseur_de_donnees_37011:
                  value:
                    errors:
                    - code: '37011'
                      title: Erreur temporaire du fournisseur de données
                      detail: Merci de réessayer dans quelques instants
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur temporaire du fournisseur de données
                  description: Merci de réessayer dans quelques instants
                erreur_de_certificat_ssl_du_fournisseur_de_donnees_37009:
                  value:
                    errors:
                    - code: '37009'
                      title: Erreur de certificat SSL du fournisseur de données
                      detail: Le certificat SSL du fournisseur de données est invalide
                        ou expiré.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur de certificat SSL du fournisseur de données
                  description: Le certificat SSL du fournisseur de données est invalide
                    ou expiré.
              schema:
                "$ref": "#/components/schemas/Error"
        '504':
          description: Erreur d'intermédiaire
          content:
            application/json:
              examples:
                timeout_error:
                  value:
                    errors:
                    - code: '37002'
                      title: Intermédiaire hors-délai
                      detail: Temps d’attente d’une réponse du fournisseur de données
                        écoulé.
                      source:
                      meta:
                        provider: CNAV
                  summary: Intermédiaire hors-délai
                  description: Temps d’attente d’une réponse du fournisseur de données
                    écoulé.
                provider_unavailable_error:
                  value:
                    errors:
                    - code: '37001'
                      title: Service non disponible
                      detail: Service du fournisseur de données temporairement indisponible
                        ou en maintenance.
                      source:
                      meta:
                        provider: CNAV
                  summary: Service non disponible
                  description: Service du fournisseur de données temporairement indisponible
                    ou en maintenance.
                network_error:
                  value:
                    errors:
                    - code: '00501'
                      title: Erreur réseau
                      detail: Problème de connexion au serveur distant. L'erreur peut
                        venir soit du fournisseur, soit de API Entreprise. Il s'agit
                        souvent d'une erreur temporaire.
                      source:
                      meta:
                        retry_in: 10
                  summary: Erreur réseau
                  description: Problème de connexion au serveur distant. L'erreur
                    peut venir soit du fournisseur, soit de API Entreprise. Il s'agit
                    souvent d'une erreur temporaire.
                dns_resolution_error:
                  value:
                    errors:
                    - code: '37004'
                      title: Erreur de résolution DNS
                      detail: Problème de résolution DNS de l'adresse du serveur
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur de résolution DNS
                  description: Problème de résolution DNS de l'adresse du serveur
                provider_error:
                  value:
                    errors:
                    - code: '37008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: CNAV
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/dss/complementaire_sante_solidaire/france_connect":
    get:
      summary: "[FranceConnect] Statut complémentaire santé solidaire (C2S)"
      tags:
      - Statut Complémentaire Santé Solidaire (C2S)
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: Cache-Control
        in: header
        description: Si cette valeur est fixée à "no-cache", le système de cache est
          alors ignoré et la donnée est directement récupérée depuis le fournisseur
          de données.
        schema:
          type: string
      security:
      - jwt_bearer_token: []
      description: "Statut bénéficiaire de la complémentaire santé solidaire (C2S).
        \n\n Retourne également des informations sur les dates d'ouverture des droits.
        \n Pour plus d'informations sur cette API et obtenir un accès en avant-première,
        veuillez contacter l'équipe API Particulier. \n **Données disponibles en bac
        à sable :** [Liste de payloads de test](https://github.com/datagouv/apistration/blob/develop/mocks/payloads/complementaire_sante_solidaire)"
      responses:
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                missing_france_connect_access_token_error:
                  value:
                    errors:
                    - code: '50004'
                      title: Accès non autorisé
                      detail: 'Le jeton d''accès FranceConnect est manquant. Cet endpoint
                        requiert un jeton d''accès FranceConnect transmis via l''en-tête
                        Authorization: Bearer.'
                      source:
                      meta: {}
                  summary: Accès non autorisé
                  description: 'Le jeton d''accès FranceConnect est manquant. Cet
                    endpoint requiert un jeton d''accès FranceConnect transmis via
                    l''en-tête Authorization: Bearer.'
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Dossier trouvé
          headers:
            X-Response-Cached:
              schema:
                type: boolean
                example: true
                enum:
                - true
                - false
                default: false
              description: Indique si la réponse a été caché.
            X-Cache-Expires-in:
              schema:
                type: number
                nullable: true
                example: 9001
              description: Secondes avant que le cache n'expire. Si le cache est vide,
                ce header est vide (mais présent). La durée du cache est de 1 heure.
          x-operationId: api_particulier_v3_cnav_complementaire_sante_solidaire_with_france_connect
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      est_beneficiaire:
                        title: Est bénéficiaire de la complémentaire de santé solidaire
                          (C2S)
                        type: boolean
                        example: true
                        description: Indique que le particulier est bénéficiaire de
                          la complémentaire de santé solidaire au moment de l'appel.
                        x-scope: complementaire_sante_solidaire
                      avec_participation:
                        title: C2S avec participation financière
                        type: boolean
                        example: false
                        nullable: true
                        description: "Indique que la C2S du particulier bénéficiaire
                          est avec participation financière. \n Si ce champ est à
                          false, cela signifie que la C2S est sans participation financière
                          de la part de l'allocataire. \n Ce champ est null dans le
                          cas où le particulier n'est pas bénéficiaire de la C2S."
                        x-scope: complementaire_sante_solidaire
                      date_debut_droit:
                        title: Date d'ouverture du droit en cours à la C2S
                        type: string
                        nullable: true
                        description: |
                          Date de début du droit à la complémentaire santé solidaire du particulier bénéficiaire.
                          \n
                          \n
                          Cette date est relative à la prestation en cours. C'est-à-dire :
                          \n
                          - Dans le cas d'une attribution l'année en cours N, la date de début correspondra à la date de l'attribution ;
                          - Dans le cas d'une attribution l'année passée N-1, qui est renouvelée en année N, la date de début correspondra à la date d'attribution l'année passée N-1 ;
                          - Dans le cas où, en année N-2 un allocataire était bénéficiaire, puis ne l'était plus en année N-1, puis l'est à nouveau dans l'année en cours N, la date de début correspond à la date d'attribution de la prestation en cours (et donc de l'année N).
                          \n
                          \n
                          Ce champ est null dans le cas où le particulier n'est pas bénéficiaire de la C2S.
                        example: '1992-11-29'
                        x-scope: complementaire_sante_solidaire
                    required:
                    - est_beneficiaire
                    - avec_participation
                    - date_debut_droit
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '422':
          description: Impossible d'identifier l'allocataire
          content:
            application/json:
              examples:
                entite_non_traitable_00366:
                  value:
                    errors:
                    - code: '00366'
                      title: Entité non traitable
                      detail: Un ou plusieurs paramètres de civilité ne sont pas correctement
                        formatés
                      source:
                      meta: {}
                  summary: Entité non traitable
                  description: Un ou plusieurs paramètres de civilité ne sont pas
                    correctement formatés
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '404':
          description: Dossier allocataire inexistant. Le document ne peut être édité.
          content:
            application/json:
              examples:
                dossier_allocataire_absent:
                  value:
                    errors:
                    - code: '36003'
                      title: Dossier allocataire absent
                      detail: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                        de données est précisé dans 'meta.provider'.
                      source:
                      meta:
                        provider: Sécurité sociale
                  summary: Dossier allocataire absent
                  description: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                    de données est précisé dans 'meta.provider'.
                allocataire_non_reference_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Allocataire non référencé
                      detail: L'allocataire n'est pas référencé auprès des caisses
                        éligibles
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Allocataire non référencé
                  description: L'allocataire n'est pas référencé auprès des caisses
                    éligibles
                erreur_inattendue_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Erreur inattendue
                      detail: Une erreur inattendue est survenue lors de la collecte
                        des données
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Erreur inattendue
                  description: Une erreur inattendue est survenue lors de la collecte
                    des données
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/dss/participation_familiale_eaje/identite":
    get:
      summary: "[Identité] Participation familiale EAJE"
      tags:
      - Participation familiale EAJE
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: Cache-Control
        in: header
        description: Si cette valeur est fixée à "no-cache", le système de cache est
          alors ignoré et la donnée est directement récupérée depuis le fournisseur
          de données.
        schema:
          type: string
      - name: nomNaissance
        in: query
        description: "**Nom de naissance, également appelé nom de famille**. \n\nLe
          nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le
          livret de famille, etc. Le nom de famille/naissance figure toujours sur
          la pièce d'identité en premier, avant le nom d'usage si le particulier en
          a un. \n\nEn cas de changement de nom de naissance, une mention avec le
          nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler
          l'API, le nom de naissance/famille nécessaire est bien le nom de famille
          modifié."
        example: DURANT
        required: true
        schema:
          type: string
      - name: nomUsage
        in: query
        description: "**Nom d'usage**. \n\nSi le particulier a un nom d'usage, c'est
          le nom qu'il utilise généralement au quotidien. Le nom d'usage est facultatif
          et peut changer au cours de la vie. Il correspond au nom de famille/naissance
          d'un parent, d'un époux ou d'une épouse, seul ou accolé au nom de famille/naissance.
          Par exemple, le nom d'usage ne peut pas être le nom de famille/naissance
          d'un concubin ou d'un partenaire de pacs. \n\nSi le particulier en a fait
          la demande, le nom d'usage peut être inscrit derrière le nom de naissance
          sur la carte d'identité ou le passeport ; il peut également être celui utilisé
          par l'administration sur les courriers. Le nom d'usage ne remplace pas le
          nom de famille/naissance qui reste le seul mentionné. \nDans nos APIs, le
          nom d'usage n'est jamais identique au nom de famille.\n\nPour en savoir
          plus : https://www.service-public.fr/particuliers/vosdroits/F868."
        example: DUPONT DURANT
        required: false
        schema:
          type: string
      - name: prenoms[]
        in: query
        schema:
          type: array
          minItems: 1
          maxItems: 3
          items:
            type: string
          example:
          - PIERRE
          - RICHARD
        description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise
          les chances que l'API retrouve le particulier car cela permet de limiter
          le risque d’homonymie."
        required: true
      - name: anneeDateNaissance
        in: query
        description: "**Année de naissance**. \n\nPour un particulier né en France,
          dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance',
          ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance')
          afin de retrouver le code COG de la commune de naissance."
        example: 1990
        required: false
        schema:
          type: integer
      - name: moisDateNaissance
        in: query
        description: "**Mois de naissance**. \n\nCette valeur est ignorée si le paramètre
          'anneeDateNaissance' est vide."
        example: 1
        required: false
        schema:
          type: integer
      - name: jourDateNaissance
        in: query
        description: "**Jour de naissance**. \n\nCette valeur est ignorée si le paramètre
          'moisDateNaissance' ou le paramètre 'anneeDateNaissance' est vide.\""
        example: 1
        required: false
        schema:
          type: integer
      - name: sexeEtatCivil
        in: query
        schema:
          type: string
          enum:
          - M
          - F
        description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**,
          comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité
          des cas, il s'agit également de la mention indiquée sur la pièce d'identité
          et le passeport. Cette mention peut être masculin ('M') ou féminin ('F').
          \nDans le cas d'un particulier ayant demandé une modification de sa mention
          de sexe à l'état civil, le changement est indiqué en marge de l'acte de
          naissance une fois la décision rendue. Le changement intervient sur les
          titres d'identité seulement si le particulier en demande le renouvellement."
        example: M
        required: false
      - name: codeCogInseePaysNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '99100'
        description: |-
          **Code Insee à 5 chiffres du pays de naissance**.

          - Code Insee France = 99100 ;
          - Liste de tous les codes Insee des pays étrangers depuis 1943 : https://explore.data.gouv.fr/fr/datasets/58c984b088ee386cdb1261f3/#/resources/150889d3-ffda-4ea5-8709-6ee67415294f.
        required: true
      - name: codeCogInseeCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '08480'
        description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation de la seconde option
          (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance'),
          ce paramètre est obligatoire si la personne est née en France.\n\nNe pas
          remplir si la personne est née à l'étranger."
        required: false
      - name: nomCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 1
          example: Gennevilliers
        description: "**Nom en toute lettre de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation du 'codeCogInseeCommuneNaissance',
          ce paramètre est obligatoire si la personne est née en France ; il doit
          être obligatoirement accompagné des paramètres 'codeCogInseeDepartementNaissance'
          et 'anneeDateNaissance'.\n\nNe pas remplir si la personne est née à l'étranger."
        required: false
      - name: codeCogInseeDepartementNaissance
        in: query
        schema:
          type: string
          minLength: 2
          maxLength: 3
          example: '92'
        description: "**Code INSEE du département de naissance**. \n\nPour retrouver
          un particulier né en France, il est nécessaire d'indiquer sa commune de
          naissance. Ce paramètre fait partie d'une des deux options disponibles pour
          renseigner la commune de naissance. Lorsque le paramètre 'nomCommuneNaissance'
          est utilisé, ce paramètre est obligatoire si la personne est née en France
          et permet de retrouver le code COG avec le paramètre 'anneeDateNaissance'.\n\nNe
          pas remplir si la personne est née à l'étranger."
        required: false
      security:
      - jwt_bearer_token: []
      description: Participation familiale EAJE
      responses:
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Dossier trouvé
          headers:
            X-Response-Cached:
              schema:
                type: boolean
                example: true
                enum:
                - true
                - false
                default: false
              description: Indique si la réponse a été caché.
            X-Cache-Expires-in:
              schema:
                type: number
                nullable: true
                example: 9001
              description: Secondes avant que le cache n'expire. Si le cache est vide,
                ce header est vide (mais présent). La durée du cache est de 1 heure.
            RateLimit-Limit:
              schema:
                type: integer
              description: La limite concernant l’endpoint appelé, soit le nombre
                de requête/minute.
              example: 50
            RateLimit-Remaining:
              schema:
                type: integer
              description: Le nombre d’appels restants durant la période courante
                d’une minute.
              example: 47
            RateLimit-Reset:
              schema:
                type: integer
              description: La fin de la période courante (en format timestamp)
              example: 1637223155
          x-operationId: api_particulier_v3_cnav_participation_familiale_eaje_with_civility
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      allocataires:
                        title: Données d'identité de l'allocataire et du conjoint
                        type: array
                        minItems: 1
                        description: Liste des données d'identité de l'allocataire
                          appelé et de celles du conjoint le cas échéant. La provenance
                          de ces données n'est pas sourcée précisément et diffère
                          selon la CAF ou la MSA.
                        items:
                          type: object
                          properties:
                            nom_naissance:
                              title: Nom de naissance
                              type: string
                              description: Nom de naissance de l'allocataire ou du
                                conjoint.
                              example: JACQUES
                            nom_usage:
                              title: Nom d'usage
                              type: string
                              description: Nom d'usage de l'allocataire ou du conjoint.
                              example: DUPONT
                              nullable: true
                            prenoms:
                              title: Prénoms
                              type: string
                              description: Prénoms de l'allocataire ou du conjoint.
                              example: JEAN-PIERRE THOMAS
                            date_naissance:
                              title: Date de naissance
                              description: Date de naissance de l'allocataire ou du
                                conjoint au format AAAA-MM-JJ.
                              type: string
                              example: '2000-01-20'
                            sexe:
                              title: Sexe
                              type: string
                              description: Sexe de l'allocataire ou du conjoint.
                              example: M
                              enum:
                              - F
                              - M
                            code_cog_insee_commune_naissance:
                              title: COG de la commune de naissance
                              type: string
                              nullable: true
                              description: Code officiel géographique (COG) de la
                                commune de naissance. Ce champ peut être null, notamment
                                pour les co-allocataires (il n'est généralement renvoyé
                                que pour l'allocataire principal demandé).
                              example: '75113'
                        x-scope: cnav_participation_familiale_eaje_allocataires
                      enfants:
                        title: Données d'identité des enfants
                        type: array
                        description: Liste des données d'identité des enfants composant
                          la famille, le cas échéant. La provenance de ces données
                          n'est pas sourcée précisément et diffère selon la CAF ou
                          la MSA.
                        items:
                          type: object
                          properties:
                            nom_naissance:
                              title: Nom de naissance
                              type: string
                              description: Nom de naissance de l'enfant.
                              example: DUPONT
                            nom_usage:
                              title: Nom d'usage
                              type: string
                              description: Nom d'usage de l'enfant.
                              example:
                              nullable: true
                            prenoms:
                              title: Prénoms
                              type: string
                              description: Prénoms de l'enfant.
                              example: JEAN-PIERRE THOMAS JUNIOR
                            date_naissance:
                              title: Date de naissance
                              description: Date de naissance de l'enfant au format
                                AAAA-MM-JJ.
                              type: string
                              example: '2000-01-20'
                            sexe:
                              title: Sexe
                              type: string
                              description: Sexe de l'enfant.
                              example: M
                              enum:
                              - F
                              - M
                            code_cog_insee_commune_naissance:
                              title: COG de la commune de naissance
                              type: string
                              nullable: true
                              description: Code officiel géographique (COG) de la
                                commune de naissance. Ce champ peut être null pour
                                les enfants (il n'est généralement renvoyé que pour
                                l'allocataire principal demandé).
                              example:
                        x-scope: cnav_participation_familiale_eaje_enfants
                      adresse:
                        title: Adresse de la famille
                        type: object
                        description: Adresse de la famille au format de La Poste.
                          Cette adresse est déclarative. Si l'usager a changé d'adresse
                          et n'a pas actualisé son adresse auprès de la CAF ou de
                          la MSA, l'information sera donc obsolète.
                        properties:
                          destinataire:
                            title: Destinataire
                            type: string
                            example: Monsieur JEAN JACQUES
                            description: Civilité, titre ou qualité, nom et prénom
                              du destinataire.
                          complement_information:
                            title: Complément d'information du destinataire ou point
                              de remise
                            type: string
                            nullable: true
                            example:
                          complement_information_geographique:
                            title: Complément d'information du point géographique
                            type: string
                            nullable: true
                            example:
                          numero_libelle_voie:
                            title: Voie
                            type: string
                            description: Numéro et libellé de la voie.
                            example: 1 RUE DE LA GARE
                            nullable: true
                          lieu_dit:
                            title: Lieu-dit
                            type: string
                            nullable: true
                            example:
                            description: 'Lieu-dit ou service particulier de distribution
                              : poste restante, boîte postale.'
                          code_postal_ville:
                            title: Code postal
                            type: string
                            description: Code postal et localité de destination.
                            example: '75002'
                          pays:
                            title: Pays
                            type: string
                            example: FRANCE
                        x-scope: cnav_participation_familiale_eaje_adresse
                        required:
                        - destinataire
                        - complement_information
                        - complement_information_geographique
                        - numero_libelle_voie
                        - lieu_dit
                        - code_postal_ville
                        - pays
                      parametres_calcul_participation_familiale:
                        title: Paramètre pris en compte pour le calcul du tarif
                        description: Liste des paramètres pris en compte lors du calcul
                          tarifaire de l'allocation
                        type: object
                        properties:
                          nombre_enfants_a_charge:
                            title: Nombre d'enfants à charge
                            description: Nombre d'enfants à charge des allocataires
                            type: integer
                            example: 2
                          nombre_enfants_beneficiaire_aeeh:
                            title: Nombre d'enfants beneficiaire de l'AEEH
                            description: Nombre d'enfants beneficiaire de l'AEEH
                            type: integer
                            example: 3
                          base_ressources_annuelles:
                            title: Ressource annuelles
                            description: Ressource annuelles déclarée par les allocataires
                            type: object
                            properties:
                              valeur:
                                title: Valeur
                                description: Montant des ressources annuelles
                                type: integer
                                example: 40923
                              annee_calcul:
                                title: Année du calcul des ressources
                                type: integer
                                description: "Année lors de laquelle le calcul du
                                  quotient familial demandé a été effectué. Cette
                                  année peut différer de l'année effective du quotient
                                  familial. \n\n Pour la CAF, le quotient familial
                                  est recalculé uniquement si de nouvelles informations
                                  sont venues rectifier la situation de l'allocataire.
                                  \n Pour la MSA, le quotient familial est systématiquement
                                  recalculé ; l'année correspond donc toujours à l'année
                                  courante."
                                example: 2023
                            required:
                            - valeur
                            - annee_calcul
                        x-scope: cnav_participation_familiale_eaje_parametres_calcul
                        required:
                        - nombre_enfants_a_charge
                        - nombre_enfants_beneficiaire_aeeh
                        - base_ressources_annuelles
                    required:
                    - allocataires
                    - enfants
                    - adresse
                    - parametres_calcul_participation_familiale
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '404':
          description: Dossier non trouvé
          content:
            application/json:
              examples:
                entite_non_trouvee_37003:
                  value:
                    errors:
                    - code: '37003'
                      title: Entité non trouvée
                      detail: Dossier allocataire inexistant. Le document ne peut
                        être édité.
                      source:
                      meta:
                        provider: CNAV
                  summary: Entité non trouvée
                  description: Dossier allocataire inexistant. Le document ne peut
                    être édité.
              schema:
                "$ref": "#/components/schemas/Error"
        '502':
          description: Erreur du fournisseur
          content:
            application/json:
              examples:
                erreur_inconnue_du_fournisseur_de_donnees_37999:
                  value:
                    errors:
                    - code: '37999'
                      title: Erreur inconnue du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et inconnue de notre service. L'équipe technique
                        a été notifiée de cette erreur pour investigation.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur inconnue du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et inconnue de notre service. L'équipe technique
                    a été notifiée de cette erreur pour investigation.
                erreur_interne_du_fournisseur_de_donnees_37000:
                  value:
                    errors:
                    - code: '37000'
                      title: Erreur interne du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et a été identifié comme étant une erreur interne.
                        Si le problème persiste, consultez la page de status ou contactez
                        nous sur le support.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur interne du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et a été identifié comme étant une erreur interne.
                    Si le problème persiste, consultez la page de status ou contactez
                    nous sur le support.
                erreur_aupres_du_fournisseur_de_donnees_trop_de_requetes_37008:
                  value:
                    errors:
                    - code: '37008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: CNAV
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
                erreur_temporaire_du_fournisseur_de_donnees_37011:
                  value:
                    errors:
                    - code: '37011'
                      title: Erreur temporaire du fournisseur de données
                      detail: Merci de réessayer dans quelques instants
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur temporaire du fournisseur de données
                  description: Merci de réessayer dans quelques instants
                erreur_de_certificat_ssl_du_fournisseur_de_donnees_37009:
                  value:
                    errors:
                    - code: '37009'
                      title: Erreur de certificat SSL du fournisseur de données
                      detail: Le certificat SSL du fournisseur de données est invalide
                        ou expiré.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur de certificat SSL du fournisseur de données
                  description: Le certificat SSL du fournisseur de données est invalide
                    ou expiré.
              schema:
                "$ref": "#/components/schemas/Error"
        '504':
          description: Erreur d'intermédiaire
          content:
            application/json:
              examples:
                timeout_error:
                  value:
                    errors:
                    - code: '37002'
                      title: Intermédiaire hors-délai
                      detail: Temps d’attente d’une réponse du fournisseur de données
                        écoulé.
                      source:
                      meta:
                        provider: CNAV
                  summary: Intermédiaire hors-délai
                  description: Temps d’attente d’une réponse du fournisseur de données
                    écoulé.
                provider_unavailable_error:
                  value:
                    errors:
                    - code: '37001'
                      title: Service non disponible
                      detail: Service du fournisseur de données temporairement indisponible
                        ou en maintenance.
                      source:
                      meta:
                        provider: CNAV
                  summary: Service non disponible
                  description: Service du fournisseur de données temporairement indisponible
                    ou en maintenance.
                network_error:
                  value:
                    errors:
                    - code: '00501'
                      title: Erreur réseau
                      detail: Problème de connexion au serveur distant. L'erreur peut
                        venir soit du fournisseur, soit de API Entreprise. Il s'agit
                        souvent d'une erreur temporaire.
                      source:
                      meta:
                        retry_in: 10
                  summary: Erreur réseau
                  description: Problème de connexion au serveur distant. L'erreur
                    peut venir soit du fournisseur, soit de API Entreprise. Il s'agit
                    souvent d'une erreur temporaire.
                dns_resolution_error:
                  value:
                    errors:
                    - code: '37004'
                      title: Erreur de résolution DNS
                      detail: Problème de résolution DNS de l'adresse du serveur
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur de résolution DNS
                  description: Problème de résolution DNS de l'adresse du serveur
                provider_error:
                  value:
                    errors:
                    - code: '37008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: CNAV
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '422':
          description: Paramètre(s) invalide(s)
          content:
            application/json:
              examples:
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/dss/participation_familiale_eaje/france_connect":
    get:
      summary: "[FranceConnect] Participation familiale EAJE"
      tags:
      - Participation familiale EAJE
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: Cache-Control
        in: header
        description: Si cette valeur est fixée à "no-cache", le système de cache est
          alors ignoré et la donnée est directement récupérée depuis le fournisseur
          de données.
        schema:
          type: string
      security:
      - jwt_bearer_token: []
      description: Participation familiale EAJE
      responses:
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                missing_france_connect_access_token_error:
                  value:
                    errors:
                    - code: '50004'
                      title: Accès non autorisé
                      detail: 'Le jeton d''accès FranceConnect est manquant. Cet endpoint
                        requiert un jeton d''accès FranceConnect transmis via l''en-tête
                        Authorization: Bearer.'
                      source:
                      meta: {}
                  summary: Accès non autorisé
                  description: 'Le jeton d''accès FranceConnect est manquant. Cet
                    endpoint requiert un jeton d''accès FranceConnect transmis via
                    l''en-tête Authorization: Bearer.'
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Dossier trouvé
          headers:
            X-Response-Cached:
              schema:
                type: boolean
                example: true
                enum:
                - true
                - false
                default: false
              description: Indique si la réponse a été caché.
            X-Cache-Expires-in:
              schema:
                type: number
                nullable: true
                example: 9001
              description: Secondes avant que le cache n'expire. Si le cache est vide,
                ce header est vide (mais présent). La durée du cache est de 1 heure.
          x-operationId: api_particulier_v3_cnav_participation_familiale_eaje_with_france_connect
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      allocataires:
                        title: Données d'identité de l'allocataire et du conjoint
                        type: array
                        minItems: 1
                        description: Liste des données d'identité de l'allocataire
                          appelé et de celles du conjoint le cas échéant. La provenance
                          de ces données n'est pas sourcée précisément et diffère
                          selon la CAF ou la MSA.
                        items:
                          type: object
                          properties:
                            nom_naissance:
                              title: Nom de naissance
                              type: string
                              description: Nom de naissance de l'allocataire ou du
                                conjoint.
                              example: JACQUES
                            nom_usage:
                              title: Nom d'usage
                              type: string
                              description: Nom d'usage de l'allocataire ou du conjoint.
                              example: DUPONT
                              nullable: true
                            prenoms:
                              title: Prénoms
                              type: string
                              description: Prénoms de l'allocataire ou du conjoint.
                              example: JEAN-PIERRE THOMAS
                            date_naissance:
                              title: Date de naissance
                              description: Date de naissance de l'allocataire ou du
                                conjoint au format AAAA-MM-JJ.
                              type: string
                              example: '2000-01-20'
                            sexe:
                              title: Sexe
                              type: string
                              description: Sexe de l'allocataire ou du conjoint.
                              example: M
                              enum:
                              - F
                              - M
                            code_cog_insee_commune_naissance:
                              title: COG de la commune de naissance
                              type: string
                              nullable: true
                              description: Code officiel géographique (COG) de la
                                commune de naissance. Ce champ peut être null, notamment
                                pour les co-allocataires (il n'est généralement renvoyé
                                que pour l'allocataire principal demandé).
                              example: '75113'
                        x-scope: cnav_participation_familiale_eaje_allocataires
                      enfants:
                        title: Données d'identité des enfants
                        type: array
                        description: Liste des données d'identité des enfants composant
                          la famille, le cas échéant. La provenance de ces données
                          n'est pas sourcée précisément et diffère selon la CAF ou
                          la MSA.
                        items:
                          type: object
                          properties:
                            nom_naissance:
                              title: Nom de naissance
                              type: string
                              description: Nom de naissance de l'enfant.
                              example: DUPONT
                            nom_usage:
                              title: Nom d'usage
                              type: string
                              description: Nom d'usage de l'enfant.
                              example:
                              nullable: true
                            prenoms:
                              title: Prénoms
                              type: string
                              description: Prénoms de l'enfant.
                              example: JEAN-PIERRE THOMAS JUNIOR
                            date_naissance:
                              title: Date de naissance
                              description: Date de naissance de l'enfant au format
                                AAAA-MM-JJ.
                              type: string
                              example: '2000-01-20'
                            sexe:
                              title: Sexe
                              type: string
                              description: Sexe de l'enfant.
                              example: M
                              enum:
                              - F
                              - M
                            code_cog_insee_commune_naissance:
                              title: COG de la commune de naissance
                              type: string
                              nullable: true
                              description: Code officiel géographique (COG) de la
                                commune de naissance. Ce champ peut être null pour
                                les enfants (il n'est généralement renvoyé que pour
                                l'allocataire principal demandé).
                              example:
                        x-scope: cnav_participation_familiale_eaje_enfants
                      adresse:
                        title: Adresse de la famille
                        type: object
                        description: Adresse de la famille au format de La Poste.
                          Cette adresse est déclarative. Si l'usager a changé d'adresse
                          et n'a pas actualisé son adresse auprès de la CAF ou de
                          la MSA, l'information sera donc obsolète.
                        properties:
                          destinataire:
                            title: Destinataire
                            type: string
                            example: Monsieur JEAN JACQUES
                            description: Civilité, titre ou qualité, nom et prénom
                              du destinataire.
                          complement_information:
                            title: Complément d'information du destinataire ou point
                              de remise
                            type: string
                            nullable: true
                            example:
                          complement_information_geographique:
                            title: Complément d'information du point géographique
                            type: string
                            nullable: true
                            example:
                          numero_libelle_voie:
                            title: Voie
                            type: string
                            description: Numéro et libellé de la voie.
                            example: 1 RUE DE LA GARE
                            nullable: true
                          lieu_dit:
                            title: Lieu-dit
                            type: string
                            nullable: true
                            example:
                            description: 'Lieu-dit ou service particulier de distribution
                              : poste restante, boîte postale.'
                          code_postal_ville:
                            title: Code postal
                            type: string
                            description: Code postal et localité de destination.
                            example: '75002'
                          pays:
                            title: Pays
                            type: string
                            example: FRANCE
                        x-scope: cnav_participation_familiale_eaje_adresse
                        required:
                        - destinataire
                        - complement_information
                        - complement_information_geographique
                        - numero_libelle_voie
                        - lieu_dit
                        - code_postal_ville
                        - pays
                      parametres_calcul_participation_familiale:
                        title: Paramètre pris en compte pour le calcul du tarif
                        description: Liste des paramètres pris en compte lors du calcul
                          tarifaire de l'allocation
                        type: object
                        properties:
                          nombre_enfants_a_charge:
                            title: Nombre d'enfants à charge
                            description: Nombre d'enfants à charge des allocataires
                            type: integer
                            example: 2
                          nombre_enfants_beneficiaire_aeeh:
                            title: Nombre d'enfants beneficiaire de l'AEEH
                            description: Nombre d'enfants beneficiaire de l'AEEH
                            type: integer
                            example: 3
                          base_ressources_annuelles:
                            title: Ressource annuelles
                            description: Ressource annuelles déclarée par les allocataires
                            type: object
                            properties:
                              valeur:
                                title: Valeur
                                description: Montant des ressources annuelles
                                type: integer
                                example: 40923
                              annee_calcul:
                                title: Année du calcul des ressources
                                type: integer
                                description: "Année lors de laquelle le calcul du
                                  quotient familial demandé a été effectué. Cette
                                  année peut différer de l'année effective du quotient
                                  familial. \n\n Pour la CAF, le quotient familial
                                  est recalculé uniquement si de nouvelles informations
                                  sont venues rectifier la situation de l'allocataire.
                                  \n Pour la MSA, le quotient familial est systématiquement
                                  recalculé ; l'année correspond donc toujours à l'année
                                  courante."
                                example: 2023
                            required:
                            - valeur
                            - annee_calcul
                        x-scope: cnav_participation_familiale_eaje_parametres_calcul
                        required:
                        - nombre_enfants_a_charge
                        - nombre_enfants_beneficiaire_aeeh
                        - base_ressources_annuelles
                    required:
                    - allocataires
                    - enfants
                    - adresse
                    - parametres_calcul_participation_familiale
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '404':
          description: Dossier non trouvé
          content:
            application/json:
              examples:
                entite_non_trouvee_37003:
                  value:
                    errors:
                    - code: '37003'
                      title: Entité non trouvée
                      detail: Dossier allocataire inexistant.
                      source:
                      meta:
                        provider: CNAV
                  summary: Entité non trouvée
                  description: Dossier allocataire inexistant.
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '422':
          description: Paramètre(s) invalide(s)
          content:
            application/json:
              examples:
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/dss/prime_activite/identite":
    get:
      summary: "[Identité] Statut prime d'activité"
      tags:
      - Statut Prime Activité
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: Cache-Control
        in: header
        description: Si cette valeur est fixée à "no-cache", le système de cache est
          alors ignoré et la donnée est directement récupérée depuis le fournisseur
          de données.
        schema:
          type: string
      - name: nomNaissance
        in: query
        description: "**Nom de naissance, également appelé nom de famille**. \n\nLe
          nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le
          livret de famille, etc. Le nom de famille/naissance figure toujours sur
          la pièce d'identité en premier, avant le nom d'usage si le particulier en
          a un. \n\nEn cas de changement de nom de naissance, une mention avec le
          nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler
          l'API, le nom de naissance/famille nécessaire est bien le nom de famille
          modifié."
        example: DURANT
        required: true
        schema:
          type: string
      - name: nomUsage
        in: query
        description: "**Nom d'usage**. \n\nSi le particulier a un nom d'usage, c'est
          le nom qu'il utilise généralement au quotidien. Le nom d'usage est facultatif
          et peut changer au cours de la vie. Il correspond au nom de famille/naissance
          d'un parent, d'un époux ou d'une épouse, seul ou accolé au nom de famille/naissance.
          Par exemple, le nom d'usage ne peut pas être le nom de famille/naissance
          d'un concubin ou d'un partenaire de pacs. \n\nSi le particulier en a fait
          la demande, le nom d'usage peut être inscrit derrière le nom de naissance
          sur la carte d'identité ou le passeport ; il peut également être celui utilisé
          par l'administration sur les courriers. Le nom d'usage ne remplace pas le
          nom de famille/naissance qui reste le seul mentionné. \nDans nos APIs, le
          nom d'usage n'est jamais identique au nom de famille.\n\nPour en savoir
          plus : https://www.service-public.fr/particuliers/vosdroits/F868."
        example: DUPONT DURANT
        required: false
        schema:
          type: string
      - name: prenoms[]
        in: query
        schema:
          type: array
          minItems: 1
          maxItems: 3
          items:
            type: string
          example:
          - PIERRE
          - RICHARD
        description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise
          les chances que l'API retrouve le particulier car cela permet de limiter
          le risque d’homonymie."
        required: true
      - name: anneeDateNaissance
        in: query
        description: "**Année de naissance**. \n\nPour un particulier né en France,
          dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance',
          ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance')
          afin de retrouver le code COG de la commune de naissance."
        example: 1990
        required: false
        schema:
          type: integer
      - name: moisDateNaissance
        in: query
        description: "**Mois de naissance**. \n\nCette valeur est ignorée si le paramètre
          'anneeDateNaissance' est vide."
        example: 1
        required: false
        schema:
          type: integer
      - name: jourDateNaissance
        in: query
        description: "**Jour de naissance**. \n\nCette valeur est ignorée si le paramètre
          'moisDateNaissance' ou le paramètre 'anneeDateNaissance' est vide.\""
        example: 1
        required: false
        schema:
          type: integer
      - name: sexeEtatCivil
        in: query
        schema:
          type: string
          enum:
          - M
          - F
        description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**,
          comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité
          des cas, il s'agit également de la mention indiquée sur la pièce d'identité
          et le passeport. Cette mention peut être masculin ('M') ou féminin ('F').
          \nDans le cas d'un particulier ayant demandé une modification de sa mention
          de sexe à l'état civil, le changement est indiqué en marge de l'acte de
          naissance une fois la décision rendue. Le changement intervient sur les
          titres d'identité seulement si le particulier en demande le renouvellement."
        example: M
        required: false
      - name: codeCogInseePaysNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '99100'
        description: |-
          **Code Insee à 5 chiffres du pays de naissance**.

          - Code Insee France = 99100 ;
          - Liste de tous les codes Insee des pays étrangers depuis 1943 : https://explore.data.gouv.fr/fr/datasets/58c984b088ee386cdb1261f3/#/resources/150889d3-ffda-4ea5-8709-6ee67415294f.
        required: true
      - name: codeCogInseeCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '08480'
        description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation de la seconde option
          (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance'),
          ce paramètre est obligatoire si la personne est née en France.\n\nNe pas
          remplir si la personne est née à l'étranger."
        required: false
      - name: nomCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 1
          example: Gennevilliers
        description: "**Nom en toute lettre de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation du 'codeCogInseeCommuneNaissance',
          ce paramètre est obligatoire si la personne est née en France ; il doit
          être obligatoirement accompagné des paramètres 'codeCogInseeDepartementNaissance'
          et 'anneeDateNaissance'.\n\nNe pas remplir si la personne est née à l'étranger."
        required: false
      - name: codeCogInseeDepartementNaissance
        in: query
        schema:
          type: string
          minLength: 2
          maxLength: 3
          example: '92'
        description: "**Code INSEE du département de naissance**. \n\nPour retrouver
          un particulier né en France, il est nécessaire d'indiquer sa commune de
          naissance. Ce paramètre fait partie d'une des deux options disponibles pour
          renseigner la commune de naissance. Lorsque le paramètre 'nomCommuneNaissance'
          est utilisé, ce paramètre est obligatoire si la personne est née en France
          et permet de retrouver le code COG avec le paramètre 'anneeDateNaissance'.\n\nNe
          pas remplir si la personne est née à l'étranger."
        required: false
      security:
      - jwt_bearer_token: []
      description: "Statut bénéficiaire de la prime d'activité, majorée ou non. \n\n
        Retourne également des informations sur les dates d'ouverture des droits."
      responses:
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Prime Activite active trouvée
          headers:
            X-Response-Cached:
              schema:
                type: boolean
                example: true
                enum:
                - true
                - false
                default: false
              description: Indique si la réponse a été caché.
            X-Cache-Expires-in:
              schema:
                type: number
                nullable: true
                example: 9001
              description: Secondes avant que le cache n'expire. Si le cache est vide,
                ce header est vide (mais présent). La durée du cache est de 1 heure.
          x-operationId: api_particulier_v3_cnav_prime_activite_with_civility
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      est_beneficiaire:
                        title: Est bénéficiaire de la prime d'activité
                        type: boolean
                        example: true
                        description: Indique que le particulier est bénéficiaire de
                          la prime d'activité au moment de l'appel.
                        x-scope: prime_activite
                      avec_majoration:
                        title: Prime d'activité avec majoration
                        type: boolean
                        nullable: true
                        description: "Indique que la prime d'activité du particulier
                          bénéficiaire est majorée au moment de l'appel. \n Si ce
                          champ est à false, cela signifie que la prime d'activité
                          n'est pas majorée. \n Ce champ sera null si le particulier
                          n'est pas bénéficiaire de la prime d'activité."
                        example: false
                        x-scope: prime_activite_majoration
                      date_debut_droit:
                        title: Date d'ouverture du droit à la prime d'activité
                        type: string
                        nullable: true
                        description: "Date de début de droit à la prime d'activité
                          si le particulier est bénéficiaire. \n Ce champ est null
                          dans le cas où le particulier n'est pas bénéficiaire de
                          la prime d'activité."
                        example: '1992-11-20'
                        x-scope: prime_activite
                    required:
                    - est_beneficiaire
                    - avec_majoration
                    - date_debut_droit
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '422':
          description: Impossible d'identifier l'allocataire
          content:
            application/json:
              examples:
                entite_non_traitable_00366:
                  value:
                    errors:
                    - code: '00366'
                      title: Entité non traitable
                      detail: Un ou plusieurs paramètres de civilité ne sont pas correctement
                        formatés
                      source:
                      meta: {}
                  summary: Entité non traitable
                  description: Un ou plusieurs paramètres de civilité ne sont pas
                    correctement formatés
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '404':
          description: Dossier allocataire inexistant. Le document ne peut être édité.
          content:
            application/json:
              examples:
                dossier_allocataire_absent:
                  value:
                    errors:
                    - code: '36003'
                      title: Dossier allocataire absent
                      detail: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                        de données est précisé dans 'meta.provider'.
                      source:
                      meta:
                        provider: Sécurité sociale
                  summary: Dossier allocataire absent
                  description: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                    de données est précisé dans 'meta.provider'.
                allocataire_non_reference_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Allocataire non référencé
                      detail: L'allocataire n'est pas référencé auprès des caisses
                        éligibles
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Allocataire non référencé
                  description: L'allocataire n'est pas référencé auprès des caisses
                    éligibles
                erreur_inattendue_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Erreur inattendue
                      detail: Une erreur inattendue est survenue lors de la collecte
                        des données
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Erreur inattendue
                  description: Une erreur inattendue est survenue lors de la collecte
                    des données
              schema:
                "$ref": "#/components/schemas/Error"
        '502':
          description: Erreur du fournisseur
          content:
            application/json:
              examples:
                erreur_inconnue_du_fournisseur_de_donnees_37999:
                  value:
                    errors:
                    - code: '37999'
                      title: Erreur inconnue du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et inconnue de notre service. L'équipe technique
                        a été notifiée de cette erreur pour investigation.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur inconnue du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et inconnue de notre service. L'équipe technique
                    a été notifiée de cette erreur pour investigation.
                erreur_interne_du_fournisseur_de_donnees_37000:
                  value:
                    errors:
                    - code: '37000'
                      title: Erreur interne du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et a été identifié comme étant une erreur interne.
                        Si le problème persiste, consultez la page de status ou contactez
                        nous sur le support.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur interne du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et a été identifié comme étant une erreur interne.
                    Si le problème persiste, consultez la page de status ou contactez
                    nous sur le support.
                erreur_aupres_du_fournisseur_de_donnees_trop_de_requetes_37008:
                  value:
                    errors:
                    - code: '37008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: CNAV
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
                erreur_temporaire_du_fournisseur_de_donnees_37011:
                  value:
                    errors:
                    - code: '37011'
                      title: Erreur temporaire du fournisseur de données
                      detail: Merci de réessayer dans quelques instants
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur temporaire du fournisseur de données
                  description: Merci de réessayer dans quelques instants
                erreur_de_certificat_ssl_du_fournisseur_de_donnees_37009:
                  value:
                    errors:
                    - code: '37009'
                      title: Erreur de certificat SSL du fournisseur de données
                      detail: Le certificat SSL du fournisseur de données est invalide
                        ou expiré.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur de certificat SSL du fournisseur de données
                  description: Le certificat SSL du fournisseur de données est invalide
                    ou expiré.
              schema:
                "$ref": "#/components/schemas/Error"
        '504':
          description: Erreur d'intermédiaire
          content:
            application/json:
              examples:
                timeout_error:
                  value:
                    errors:
                    - code: '37002'
                      title: Intermédiaire hors-délai
                      detail: Temps d’attente d’une réponse du fournisseur de données
                        écoulé.
                      source:
                      meta:
                        provider: CNAV
                  summary: Intermédiaire hors-délai
                  description: Temps d’attente d’une réponse du fournisseur de données
                    écoulé.
                provider_unavailable_error:
                  value:
                    errors:
                    - code: '37001'
                      title: Service non disponible
                      detail: Service du fournisseur de données temporairement indisponible
                        ou en maintenance.
                      source:
                      meta:
                        provider: CNAV
                  summary: Service non disponible
                  description: Service du fournisseur de données temporairement indisponible
                    ou en maintenance.
                network_error:
                  value:
                    errors:
                    - code: '00501'
                      title: Erreur réseau
                      detail: Problème de connexion au serveur distant. L'erreur peut
                        venir soit du fournisseur, soit de API Entreprise. Il s'agit
                        souvent d'une erreur temporaire.
                      source:
                      meta:
                        retry_in: 10
                  summary: Erreur réseau
                  description: Problème de connexion au serveur distant. L'erreur
                    peut venir soit du fournisseur, soit de API Entreprise. Il s'agit
                    souvent d'une erreur temporaire.
                dns_resolution_error:
                  value:
                    errors:
                    - code: '37004'
                      title: Erreur de résolution DNS
                      detail: Problème de résolution DNS de l'adresse du serveur
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur de résolution DNS
                  description: Problème de résolution DNS de l'adresse du serveur
                provider_error:
                  value:
                    errors:
                    - code: '37008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: CNAV
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/dss/prime_activite/france_connect":
    get:
      summary: "[FranceConnect] Statut prime d'activité"
      tags:
      - Statut Prime Activité
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: Cache-Control
        in: header
        description: Si cette valeur est fixée à "no-cache", le système de cache est
          alors ignoré et la donnée est directement récupérée depuis le fournisseur
          de données.
        schema:
          type: string
      security:
      - jwt_bearer_token: []
      description: "Statut bénéficiaire de la prime d'activité, majorée ou non. \n\n
        Retourne également des informations sur les dates d'ouverture des droits."
      responses:
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                missing_france_connect_access_token_error:
                  value:
                    errors:
                    - code: '50004'
                      title: Accès non autorisé
                      detail: 'Le jeton d''accès FranceConnect est manquant. Cet endpoint
                        requiert un jeton d''accès FranceConnect transmis via l''en-tête
                        Authorization: Bearer.'
                      source:
                      meta: {}
                  summary: Accès non autorisé
                  description: 'Le jeton d''accès FranceConnect est manquant. Cet
                    endpoint requiert un jeton d''accès FranceConnect transmis via
                    l''en-tête Authorization: Bearer.'
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Dossier trouvé
          headers:
            X-Response-Cached:
              schema:
                type: boolean
                example: true
                enum:
                - true
                - false
                default: false
              description: Indique si la réponse a été caché.
            X-Cache-Expires-in:
              schema:
                type: number
                nullable: true
                example: 9001
              description: Secondes avant que le cache n'expire. Si le cache est vide,
                ce header est vide (mais présent). La durée du cache est de 1 heure.
          x-operationId: api_particulier_v3_cnav_prime_activite_with_france_connect
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      est_beneficiaire:
                        title: Est bénéficiaire de la prime d'activité
                        type: boolean
                        example: true
                        description: Indique que le particulier est bénéficiaire de
                          la prime d'activité au moment de l'appel.
                        x-scope: prime_activite
                      avec_majoration:
                        title: Prime d'activité avec majoration
                        type: boolean
                        nullable: true
                        description: "Indique que la prime d'activité du particulier
                          bénéficiaire est majorée au moment de l'appel. \n Si ce
                          champ est à false, cela signifie que la prime d'activité
                          n'est pas majorée. \n Ce champ sera null si le particulier
                          n'est pas bénéficiaire de la prime d'activité."
                        example: false
                        x-scope: prime_activite_majoration
                      date_debut_droit:
                        title: Date d'ouverture du droit à la prime d'activité
                        type: string
                        nullable: true
                        description: "Date de début de droit à la prime d'activité
                          si le particulier est bénéficiaire. \n Ce champ est null
                          dans le cas où le particulier n'est pas bénéficiaire de
                          la prime d'activité."
                        example: '1992-11-20'
                        x-scope: prime_activite
                    required:
                    - est_beneficiaire
                    - avec_majoration
                    - date_debut_droit
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '422':
          description: Impossible d'identifier l'allocataire
          content:
            application/json:
              examples:
                entite_non_traitable_00366:
                  value:
                    errors:
                    - code: '00366'
                      title: Entité non traitable
                      detail: Un ou plusieurs paramètres de civilité ne sont pas correctement
                        formatés
                      source:
                      meta: {}
                  summary: Entité non traitable
                  description: Un ou plusieurs paramètres de civilité ne sont pas
                    correctement formatés
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '404':
          description: Dossier allocataire inexistant. Le document ne peut être édité.
          content:
            application/json:
              examples:
                dossier_allocataire_absent:
                  value:
                    errors:
                    - code: '36003'
                      title: Dossier allocataire absent
                      detail: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                        de données est précisé dans 'meta.provider'.
                      source:
                      meta:
                        provider: Sécurité sociale
                  summary: Dossier allocataire absent
                  description: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                    de données est précisé dans 'meta.provider'.
                allocataire_non_reference_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Allocataire non référencé
                      detail: L'allocataire n'est pas référencé auprès des caisses
                        éligibles
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Allocataire non référencé
                  description: L'allocataire n'est pas référencé auprès des caisses
                    éligibles
                erreur_inattendue_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Erreur inattendue
                      detail: Une erreur inattendue est survenue lors de la collecte
                        des données
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Erreur inattendue
                  description: Une erreur inattendue est survenue lors de la collecte
                    des données
              schema:
                "$ref": "#/components/schemas/Error"
        '502':
          description: Erreur du fournisseur
          content:
            application/json:
              examples:
                erreur_inconnue_du_fournisseur_de_donnees_37999:
                  value:
                    errors:
                    - code: '37999'
                      title: Erreur inconnue du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et inconnue de notre service. L'équipe technique
                        a été notifiée de cette erreur pour investigation.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur inconnue du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et inconnue de notre service. L'équipe technique
                    a été notifiée de cette erreur pour investigation.
                erreur_interne_du_fournisseur_de_donnees_37000:
                  value:
                    errors:
                    - code: '37000'
                      title: Erreur interne du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et a été identifié comme étant une erreur interne.
                        Si le problème persiste, consultez la page de status ou contactez
                        nous sur le support.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur interne du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et a été identifié comme étant une erreur interne.
                    Si le problème persiste, consultez la page de status ou contactez
                    nous sur le support.
                erreur_aupres_du_fournisseur_de_donnees_trop_de_requetes_37008:
                  value:
                    errors:
                    - code: '37008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: CNAV
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
                erreur_temporaire_du_fournisseur_de_donnees_37011:
                  value:
                    errors:
                    - code: '37011'
                      title: Erreur temporaire du fournisseur de données
                      detail: Merci de réessayer dans quelques instants
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur temporaire du fournisseur de données
                  description: Merci de réessayer dans quelques instants
                erreur_de_certificat_ssl_du_fournisseur_de_donnees_37009:
                  value:
                    errors:
                    - code: '37009'
                      title: Erreur de certificat SSL du fournisseur de données
                      detail: Le certificat SSL du fournisseur de données est invalide
                        ou expiré.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur de certificat SSL du fournisseur de données
                  description: Le certificat SSL du fournisseur de données est invalide
                    ou expiré.
              schema:
                "$ref": "#/components/schemas/Error"
        '504':
          description: Erreur d'intermédiaire
          content:
            application/json:
              examples:
                timeout_error:
                  value:
                    errors:
                    - code: '37002'
                      title: Intermédiaire hors-délai
                      detail: Temps d’attente d’une réponse du fournisseur de données
                        écoulé.
                      source:
                      meta:
                        provider: CNAV
                  summary: Intermédiaire hors-délai
                  description: Temps d’attente d’une réponse du fournisseur de données
                    écoulé.
                provider_unavailable_error:
                  value:
                    errors:
                    - code: '37001'
                      title: Service non disponible
                      detail: Service du fournisseur de données temporairement indisponible
                        ou en maintenance.
                      source:
                      meta:
                        provider: CNAV
                  summary: Service non disponible
                  description: Service du fournisseur de données temporairement indisponible
                    ou en maintenance.
                network_error:
                  value:
                    errors:
                    - code: '00501'
                      title: Erreur réseau
                      detail: Problème de connexion au serveur distant. L'erreur peut
                        venir soit du fournisseur, soit de API Entreprise. Il s'agit
                        souvent d'une erreur temporaire.
                      source:
                      meta:
                        retry_in: 10
                  summary: Erreur réseau
                  description: Problème de connexion au serveur distant. L'erreur
                    peut venir soit du fournisseur, soit de API Entreprise. Il s'agit
                    souvent d'une erreur temporaire.
                dns_resolution_error:
                  value:
                    errors:
                    - code: '37004'
                      title: Erreur de résolution DNS
                      detail: Problème de résolution DNS de l'adresse du serveur
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur de résolution DNS
                  description: Problème de résolution DNS de l'adresse du serveur
                provider_error:
                  value:
                    errors:
                    - code: '37008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: CNAV
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/dss/quotient_familial/identite":
    get:
      summary: "[Identité] Quotient familial CAF & MSA"
      tags:
      - Quotient familial CAF & MSA
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: Cache-Control
        in: header
        description: Si cette valeur est fixée à "no-cache", le système de cache est
          alors ignoré et la donnée est directement récupérée depuis le fournisseur
          de données.
        schema:
          type: string
      - name: nomNaissance
        in: query
        description: "**Nom de naissance, également appelé nom de famille**. \n\nLe
          nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le
          livret de famille, etc. Le nom de famille/naissance figure toujours sur
          la pièce d'identité en premier, avant le nom d'usage si le particulier en
          a un. \n\nEn cas de changement de nom de naissance, une mention avec le
          nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler
          l'API, le nom de naissance/famille nécessaire est bien le nom de famille
          modifié."
        example: DURANT
        required: true
        schema:
          type: string
      - name: nomUsage
        in: query
        description: "**Nom d'usage**. \n\nSi le particulier a un nom d'usage, c'est
          le nom qu'il utilise généralement au quotidien. Le nom d'usage est facultatif
          et peut changer au cours de la vie. Il correspond au nom de famille/naissance
          d'un parent, d'un époux ou d'une épouse, seul ou accolé au nom de famille/naissance.
          Par exemple, le nom d'usage ne peut pas être le nom de famille/naissance
          d'un concubin ou d'un partenaire de pacs. \n\nSi le particulier en a fait
          la demande, le nom d'usage peut être inscrit derrière le nom de naissance
          sur la carte d'identité ou le passeport ; il peut également être celui utilisé
          par l'administration sur les courriers. Le nom d'usage ne remplace pas le
          nom de famille/naissance qui reste le seul mentionné. \nDans nos APIs, le
          nom d'usage n'est jamais identique au nom de famille.\n\nPour en savoir
          plus : https://www.service-public.fr/particuliers/vosdroits/F868."
        example: DUPONT DURANT
        required: false
        schema:
          type: string
      - name: prenoms[]
        in: query
        schema:
          type: array
          minItems: 1
          maxItems: 3
          items:
            type: string
          example:
          - PIERRE
          - RICHARD
        description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise
          les chances que l'API retrouve le particulier car cela permet de limiter
          le risque d’homonymie."
        required: true
      - name: anneeDateNaissance
        in: query
        description: "**Année de naissance**. \n\nPour un particulier né en France,
          dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance',
          ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance')
          afin de retrouver le code COG de la commune de naissance."
        example: 1990
        required: false
        schema:
          type: integer
      - name: moisDateNaissance
        in: query
        description: "**Mois de naissance**. \n\nCette valeur est ignorée si le paramètre
          'anneeDateNaissance' est vide."
        example: 1
        required: false
        schema:
          type: integer
      - name: jourDateNaissance
        in: query
        description: "**Jour de naissance**. \n\nCette valeur est ignorée si le paramètre
          'moisDateNaissance' ou le paramètre 'anneeDateNaissance' est vide.\""
        example: 1
        required: false
        schema:
          type: integer
      - name: sexeEtatCivil
        in: query
        schema:
          type: string
          enum:
          - M
          - F
        description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**,
          comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité
          des cas, il s'agit également de la mention indiquée sur la pièce d'identité
          et le passeport. Cette mention peut être masculin ('M') ou féminin ('F').
          \nDans le cas d'un particulier ayant demandé une modification de sa mention
          de sexe à l'état civil, le changement est indiqué en marge de l'acte de
          naissance une fois la décision rendue. Le changement intervient sur les
          titres d'identité seulement si le particulier en demande le renouvellement."
        example: M
        required: false
      - name: codeCogInseePaysNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '99100'
        description: |-
          **Code Insee à 5 chiffres du pays de naissance**.

          - Code Insee France = 99100 ;
          - Liste de tous les codes Insee des pays étrangers depuis 1943 : https://explore.data.gouv.fr/fr/datasets/58c984b088ee386cdb1261f3/#/resources/150889d3-ffda-4ea5-8709-6ee67415294f.
        required: true
      - name: codeCogInseeCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '08480'
        description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation de la seconde option
          (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance'),
          ce paramètre est obligatoire si la personne est née en France.\n\nNe pas
          remplir si la personne est née à l'étranger."
        required: false
      - name: nomCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 1
          example: Gennevilliers
        description: "**Nom en toute lettre de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation du 'codeCogInseeCommuneNaissance',
          ce paramètre est obligatoire si la personne est née en France ; il doit
          être obligatoirement accompagné des paramètres 'codeCogInseeDepartementNaissance'
          et 'anneeDateNaissance'.\n\nNe pas remplir si la personne est née à l'étranger."
        required: false
      - name: codeCogInseeDepartementNaissance
        in: query
        schema:
          type: string
          minLength: 2
          maxLength: 3
          example: '92'
        description: "**Code INSEE du département de naissance**. \n\nPour retrouver
          un particulier né en France, il est nécessaire d'indiquer sa commune de
          naissance. Ce paramètre fait partie d'une des deux options disponibles pour
          renseigner la commune de naissance. Lorsque le paramètre 'nomCommuneNaissance'
          est utilisé, ce paramètre est obligatoire si la personne est née en France
          et permet de retrouver le code COG avec le paramètre 'anneeDateNaissance'.\n\nNe
          pas remplir si la personne est née à l'étranger."
        required: false
      - name: annee
        in: query
        description: Année du quotient familial recherché. Si l'année n'est pas renseignée,
          l'année utilisée par défaut est celle en cours. L'API permet d'accéder à
          un historique de maximum 2 ans.
        example: 2023
        required: false
        schema:
          type: integer
      - name: mois
        in: query
        description: Mois du quotient familial recherché. Si le mois n'est pas renseigné,
          le mois utilisé par défaut est celui en cours.
        example: 12
        required: false
        schema:
          type: integer
      security:
      - jwt_bearer_token: []
      description: "Quotient familial délivré par la CAF ou la MSA et composition
        de la famille de l'allocataire. \n Pour plus d'informations sur cette API
        et obtenir un accès en avant-première, veuillez contacter l'équipe API Particulier.
        \n **Données disponibles en bac à sable :** [liste](https://github.com/datagouv/apistration/blob/develop/mocks/payloads/api_particulier_v2_cnav_quotient_familial_v2)"
      responses:
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Quotient Familial active trouvée
          headers:
            X-Response-Cached:
              schema:
                type: boolean
                example: true
                enum:
                - true
                - false
                default: false
              description: Indique si la réponse a été caché.
            X-Cache-Expires-in:
              schema:
                type: number
                nullable: true
                example: 9001
              description: Secondes avant que le cache n'expire. Si le cache est vide,
                ce header est vide (mais présent). La durée du cache est de 24 heure.
          x-operationId: api_particulier_v3_cnav_quotient_familial_with_civility
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      allocataires:
                        title: Données d'identité de l'allocataire et du conjoint
                        type: array
                        minItems: 1
                        description: Liste des données d'identité de l'allocataire
                          appelé et de celles du conjoint le cas échéant. La provenance
                          de ces données n'est pas sourcée précisément et diffère
                          selon la CAF ou la MSA. Les membres de la famille listés
                          sont toujours ceux du mois en cours, y compris en cas d'appel
                          sur une date antérieure.
                        items:
                          type: object
                          properties:
                            nom_naissance:
                              title: Nom de naissance
                              type: string
                              description: Nom de naissance de l'allocataire ou du
                                conjoint.
                              example: JACQUES
                            nom_usage:
                              title: Nom d'usage
                              type: string
                              description: Nom d'usage de l'allocataire ou du conjoint.
                              example: DUPONT
                              nullable: true
                            prenoms:
                              title: Prénoms
                              type: string
                              description: Prénoms de l'allocataire ou du conjoint.
                              example: JEAN-PIERRE THOMAS
                            date_naissance:
                              title: Date de naissance
                              description: Date de naissance de l'allocataire ou du
                                conjoint au format AAAA-MM-JJ.
                              type: string
                              example: '2000-01-20'
                            sexe:
                              title: Sexe
                              type: string
                              description: Sexe de l'allocataire ou du conjoint.
                              example: M
                              enum:
                              - F
                              - M
                        x-scope: cnaf_allocataires
                      enfants:
                        title: Données d'identité des enfants
                        type: array
                        description: Liste des données d'identité des enfants composant
                          la famille, le cas échéant. La provenance de ces données
                          n'est pas sourcée précisément et diffère selon la CAF ou
                          la MSA. Les membres de la famille listés sont toujours ceux
                          du mois en cours, y compris en cas d'appel sur une date
                          antérieure.
                        items:
                          type: object
                          properties:
                            nom_naissance:
                              title: Nom de naissance
                              type: string
                              description: Nom de naissance de l'enfant.
                              example: DUPONT
                            nom_usage:
                              title: Nom d'usage
                              type: string
                              description: Nom d'usage de l'enfant.
                              example:
                              nullable: true
                            prenoms:
                              title: Prénoms
                              type: string
                              description: Prénoms de l'enfant.
                              example: JEAN-PIERRE THOMAS JUNIOR
                            date_naissance:
                              title: Date de naissance
                              description: Date de naissance de l'enfant au format
                                AAAA-MM-JJ.
                              type: string
                              example: '2000-01-20'
                            sexe:
                              title: Sexe
                              type: string
                              description: Sexe de l'enfant.
                              example: M
                              enum:
                              - F
                              - M
                        x-scope: cnaf_enfants
                      adresse:
                        title: Adresse de la famille
                        type: object
                        description: Adresse de la famille au format de La Poste.
                          Cette adresse est déclarative. Si l'usager a changé d'adresse
                          et n'a pas actualisé son adresse auprès de la CAF ou de
                          la MSA, l'information sera donc obsolète.
                        properties:
                          destinataire:
                            title: Destinataire
                            type: string
                            example: Monsieur JEAN JACQUES
                            description: Civilité, titre ou qualité, nom et prénom
                              du destinataire.
                          complement_information:
                            title: Complément d'information du destinataire ou point
                              de remise
                            type: string
                            nullable: true
                            example:
                          complement_information_geographique:
                            title: Complément d'information du point géographique
                            type: string
                            nullable: true
                            example:
                          numero_libelle_voie:
                            title: Voie
                            type: string
                            description: Numéro et libellé de la voie.
                            example: 1 RUE DE LA GARE
                            nullable: true
                          lieu_dit:
                            title: Lieu-dit
                            type: string
                            nullable: true
                            example:
                            description: 'Lieu-dit ou service particulier de distribution
                              : poste restante, boîte postale.'
                          code_postal_ville:
                            title: Code postal
                            type: string
                            description: Code postal et localité de destination.
                            example: '75002'
                          pays:
                            title: Pays
                            type: string
                            example: FRANCE
                        x-scope: cnaf_adresse
                        required:
                        - destinataire
                        - complement_information
                        - complement_information_geographique
                        - numero_libelle_voie
                        - lieu_dit
                        - code_postal_ville
                        - pays
                      quotient_familial:
                        title: Informations du quotient familial (QF)
                        type: object
                        description: Données relatives à l'attribution du quotient
                          familial CAF ou MSA.
                        properties:
                          fournisseur:
                            title: Fournisseur du QF
                            type: string
                            description: Indique si le quotient familial de l'allocataire
                              provient de la CAF ou de la MSA.
                            example: MSA
                            enum:
                            - CNAF
                            - MSA
                          valeur:
                            title: Valeur du QF
                            type: integer
                            description: Valeur du quotient familial calculée par
                              la CAF ou la MSA.
                            example: 1045
                          annee:
                            title: Année effective du QF
                            type: integer
                            description: "Ce champ indique l'année effective du quotient
                              familial appelé. C'est-à-dire l'année à laquelle s'applique
                              le quotient familial. Cette année peut être différente
                              de l'année de calcul du quotient si ce dernier a été
                              recalculé suite à la réception d'informations rectifiant
                              la situation de l'allocataire. \n\n - Si aucune année
                              et aucun mois n'ont été renseignés en paramètres d'appel,
                              le quotient familial retourné sera celui du mois de
                              l'année en cours. - Si aucune année n'a été renseignée
                              et que le mois est renseigné, le quotient familial retourné
                              sera celui du mois spécifié pour l'année en cours. En
                              revanche, si la date finalement composée avec cette
                              règle s'avère dans le futur (mois postérieur au moins
                              en cours), l'API renvoie un erreur 400. "
                            example: 2023
                          mois:
                            title: Mois effectif du QF
                            type: integer
                            description: "Mois effectif du quotient familial. C'est-à-dire
                              le mois auquel s'applique le quotient familial. Ce mois
                              peut être différent du mois de calcul du quotient si
                              ce dernier a été recalculé suite à la réception d'informations
                              rectifiant la situation de l'allocataire. \n\n - Si
                              aucun mois et aucune année n'ont été renseignés en paramètres
                              d'appel, le quotient familial retourné sera celui du
                              mois de l'année en cours. - Si le mois est renseigné
                              mais qu'aucune année n'est saisie, le quotient familial
                              retourné sera celui du mois spécifié pour l'année en
                              cours. En revanche, si la date finalement composée avec
                              cette règle s'avère dans le futur (mois postérieur au
                              moins en cours), l'API renvoie un erreur 400. - Si aucun
                              mois n'a été renseigné mais que l'année a été spécifiée
                              en paramètres d'appel, le quotient familial retourné
                              sera celui du mois en cours pour l'année spécifiée."
                            example: 6
                          annee_calcul:
                            title: Année du calcul du QF
                            type: integer
                            description: "Année lors de laquelle le calcul du quotient
                              familial demandé a été effectué. Cette année peut différer
                              de l'année effective du quotient familial. \n\n Pour
                              la CAF, le quotient familial est recalculé uniquement
                              si de nouvelles informations sont venues rectifier la
                              situation de l'allocataire. \n Pour la MSA, le quotient
                              familial est systématiquement recalculé ; l'année correspond
                              donc toujours à l'année courante."
                            example: 2023
                          mois_calcul:
                            title: Mois du calcul du QF
                            type: integer
                            description: "Mois lors duquel le calcul du quotient familial
                              demandé a été effectué. Ce mois peut différer du mois
                              effectif du quotient familial. \n\n Pour la CAF, le
                              quotient familial est recalculé uniquement si de nouvelles
                              informations sont venues rectifier la situation de l'allocataire.
                              \n Pour la MSA, le quotient familial est systématiquement
                              recalculé ; le mois correspond donc toujours au mois
                              en cours."
                            example: 9
                        x-scope: cnaf_quotient_familial
                        required:
                        - fournisseur
                        - valeur
                        - annee
                        - mois
                        - annee_calcul
                        - mois_calcul
                    required:
                    - allocataires
                    - enfants
                    - adresse
                    - quotient_familial
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '422':
          description: Impossible d'identifier l'allocataire
          content:
            application/json:
              examples:
                entite_non_traitable_00366:
                  value:
                    errors:
                    - code: '00366'
                      title: Entité non traitable
                      detail: Un ou plusieurs paramètres de civilité ne sont pas correctement
                        formatés
                      source:
                      meta: {}
                  summary: Entité non traitable
                  description: Un ou plusieurs paramètres de civilité ne sont pas
                    correctement formatés
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '404':
          description: Dossier allocataire inexistant. Le document ne peut être édité.
          content:
            application/json:
              examples:
                dossier_allocataire_absent_msa_10003:
                  value:
                    errors:
                    - code: '10003'
                      title: Dossier allocataire absent MSA
                      detail: Le dossier allocataire n'a pas été trouvé auprès de
                        la MSA.
                      source:
                      meta:
                        provider: MSA
                  summary: Dossier allocataire absent MSA
                  description: Le dossier allocataire n'a pas été trouvé auprès de
                    la MSA.
                dossier_allocataire_absent_cnaf_23003:
                  value:
                    errors:
                    - code: '23003'
                      title: Dossier allocataire absent CNAF
                      detail: Le dossier allocataire n'a pas été trouvé auprès de
                        la CNAF.
                      source:
                      meta:
                        provider: CNAF
                  summary: Dossier allocataire absent CNAF
                  description: Le dossier allocataire n'a pas été trouvé auprès de
                    la CNAF.
                allocataire_non_reference_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Allocataire non référencé
                      detail: L'allocataire n'est pas référencé auprès des caisses
                        éligibles
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Allocataire non référencé
                  description: L'allocataire n'est pas référencé auprès des caisses
                    éligibles
                erreur_inattendue_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Erreur inattendue
                      detail: Une erreur inattendue est survenue lors de la collecte
                        des données
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Erreur inattendue
                  description: Une erreur inattendue est survenue lors de la collecte
                    des données
              schema:
                "$ref": "#/components/schemas/Error"
        '502':
          description: Erreur du fournisseur
          content:
            application/json:
              examples:
                erreur_inconnue_du_fournisseur_de_donnees_37999:
                  value:
                    errors:
                    - code: '37999'
                      title: Erreur inconnue du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et inconnue de notre service. L'équipe technique
                        a été notifiée de cette erreur pour investigation.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur inconnue du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et inconnue de notre service. L'équipe technique
                    a été notifiée de cette erreur pour investigation.
                erreur_interne_du_fournisseur_de_donnees_37000:
                  value:
                    errors:
                    - code: '37000'
                      title: Erreur interne du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et a été identifié comme étant une erreur interne.
                        Si le problème persiste, consultez la page de status ou contactez
                        nous sur le support.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur interne du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et a été identifié comme étant une erreur interne.
                    Si le problème persiste, consultez la page de status ou contactez
                    nous sur le support.
                erreur_aupres_du_fournisseur_de_donnees_trop_de_requetes_37008:
                  value:
                    errors:
                    - code: '37008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: CNAV
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
                erreur_temporaire_du_fournisseur_de_donnees_37011:
                  value:
                    errors:
                    - code: '37011'
                      title: Erreur temporaire du fournisseur de données
                      detail: Merci de réessayer dans quelques instants
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur temporaire du fournisseur de données
                  description: Merci de réessayer dans quelques instants
                erreur_de_certificat_ssl_du_fournisseur_de_donnees_37009:
                  value:
                    errors:
                    - code: '37009'
                      title: Erreur de certificat SSL du fournisseur de données
                      detail: Le certificat SSL du fournisseur de données est invalide
                        ou expiré.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur de certificat SSL du fournisseur de données
                  description: Le certificat SSL du fournisseur de données est invalide
                    ou expiré.
              schema:
                "$ref": "#/components/schemas/Error"
        '504':
          description: Erreur d'intermédiaire
          content:
            application/json:
              examples:
                timeout_error:
                  value:
                    errors:
                    - code: '37002'
                      title: Intermédiaire hors-délai
                      detail: Temps d’attente d’une réponse du fournisseur de données
                        écoulé.
                      source:
                      meta:
                        provider: CNAV
                  summary: Intermédiaire hors-délai
                  description: Temps d’attente d’une réponse du fournisseur de données
                    écoulé.
                provider_unavailable_error:
                  value:
                    errors:
                    - code: '37001'
                      title: Service non disponible
                      detail: Service du fournisseur de données temporairement indisponible
                        ou en maintenance.
                      source:
                      meta:
                        provider: CNAV
                  summary: Service non disponible
                  description: Service du fournisseur de données temporairement indisponible
                    ou en maintenance.
                network_error:
                  value:
                    errors:
                    - code: '00501'
                      title: Erreur réseau
                      detail: Problème de connexion au serveur distant. L'erreur peut
                        venir soit du fournisseur, soit de API Entreprise. Il s'agit
                        souvent d'une erreur temporaire.
                      source:
                      meta:
                        retry_in: 10
                  summary: Erreur réseau
                  description: Problème de connexion au serveur distant. L'erreur
                    peut venir soit du fournisseur, soit de API Entreprise. Il s'agit
                    souvent d'une erreur temporaire.
                dns_resolution_error:
                  value:
                    errors:
                    - code: '37004'
                      title: Erreur de résolution DNS
                      detail: Problème de résolution DNS de l'adresse du serveur
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur de résolution DNS
                  description: Problème de résolution DNS de l'adresse du serveur
                provider_error:
                  value:
                    errors:
                    - code: '37008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: CNAV
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/dss/quotient_familial/france_connect":
    get:
      summary: "[FranceConnect] Quotient familial CAF & MSA"
      tags:
      - Quotient familial CAF & MSA
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: Cache-Control
        in: header
        description: Si cette valeur est fixée à "no-cache", le système de cache est
          alors ignoré et la donnée est directement récupérée depuis le fournisseur
          de données.
        schema:
          type: string
      - name: annee
        in: query
        description: Année du quotient familial recherché. Si l'année n'est pas renseignée,
          l'année utilisée par défaut est celle en cours. L'API permet d'accéder à
          un historique de maximum 2 ans.
        example: 2023
        required: false
        schema:
          type: integer
      - name: mois
        in: query
        description: Mois du quotient familial recherché. Si le mois n'est pas renseigné,
          le mois utilisé par défaut est celui en cours.
        example: 12
        required: false
        schema:
          type: integer
      security:
      - jwt_bearer_token: []
      description: "Quotient familial délivré par la CAF ou la MSA et composition
        de la famille de l'allocataire. \n Pour plus d'informations sur cette API
        et obtenir un accès en avant-première, veuillez contacter l'équipe API Particulier.
        \n **Données disponibles en bac à sable :** [liste](https://github.com/datagouv/apistration/blob/develop/mocks/payloads/api_particulier_v2_cnav_quotient_familial_v2)"
      responses:
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                missing_france_connect_access_token_error:
                  value:
                    errors:
                    - code: '50004'
                      title: Accès non autorisé
                      detail: 'Le jeton d''accès FranceConnect est manquant. Cet endpoint
                        requiert un jeton d''accès FranceConnect transmis via l''en-tête
                        Authorization: Bearer.'
                      source:
                      meta: {}
                  summary: Accès non autorisé
                  description: 'Le jeton d''accès FranceConnect est manquant. Cet
                    endpoint requiert un jeton d''accès FranceConnect transmis via
                    l''en-tête Authorization: Bearer.'
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Dossier trouvé
          headers:
            X-Response-Cached:
              schema:
                type: boolean
                example: true
                enum:
                - true
                - false
                default: false
              description: Indique si la réponse a été caché.
            X-Cache-Expires-in:
              schema:
                type: number
                nullable: true
                example: 9001
              description: Secondes avant que le cache n'expire. Si le cache est vide,
                ce header est vide (mais présent). La durée du cache est de 24 heure.
          x-operationId: api_particulier_v3_cnav_quotient_familial_with_france_connect
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      allocataires:
                        title: Données d'identité de l'allocataire et du conjoint
                        type: array
                        minItems: 1
                        description: Liste des données d'identité de l'allocataire
                          appelé et de celles du conjoint le cas échéant. La provenance
                          de ces données n'est pas sourcée précisément et diffère
                          selon la CAF ou la MSA. Les membres de la famille listés
                          sont toujours ceux du mois en cours, y compris en cas d'appel
                          sur une date antérieure.
                        items:
                          type: object
                          properties:
                            nom_naissance:
                              title: Nom de naissance
                              type: string
                              description: Nom de naissance de l'allocataire ou du
                                conjoint.
                              example: JACQUES
                            nom_usage:
                              title: Nom d'usage
                              type: string
                              description: Nom d'usage de l'allocataire ou du conjoint.
                              example: DUPONT
                              nullable: true
                            prenoms:
                              title: Prénoms
                              type: string
                              description: Prénoms de l'allocataire ou du conjoint.
                              example: JEAN-PIERRE THOMAS
                            date_naissance:
                              title: Date de naissance
                              description: Date de naissance de l'allocataire ou du
                                conjoint au format AAAA-MM-JJ.
                              type: string
                              example: '2000-01-20'
                            sexe:
                              title: Sexe
                              type: string
                              description: Sexe de l'allocataire ou du conjoint.
                              example: M
                              enum:
                              - F
                              - M
                        x-scope: cnaf_allocataires
                      enfants:
                        title: Données d'identité des enfants
                        type: array
                        description: Liste des données d'identité des enfants composant
                          la famille, le cas échéant. La provenance de ces données
                          n'est pas sourcée précisément et diffère selon la CAF ou
                          la MSA. Les membres de la famille listés sont toujours ceux
                          du mois en cours, y compris en cas d'appel sur une date
                          antérieure.
                        items:
                          type: object
                          properties:
                            nom_naissance:
                              title: Nom de naissance
                              type: string
                              description: Nom de naissance de l'enfant.
                              example: DUPONT
                            nom_usage:
                              title: Nom d'usage
                              type: string
                              description: Nom d'usage de l'enfant.
                              example:
                              nullable: true
                            prenoms:
                              title: Prénoms
                              type: string
                              description: Prénoms de l'enfant.
                              example: JEAN-PIERRE THOMAS JUNIOR
                            date_naissance:
                              title: Date de naissance
                              description: Date de naissance de l'enfant au format
                                AAAA-MM-JJ.
                              type: string
                              example: '2000-01-20'
                            sexe:
                              title: Sexe
                              type: string
                              description: Sexe de l'enfant.
                              example: M
                              enum:
                              - F
                              - M
                        x-scope: cnaf_enfants
                      adresse:
                        title: Adresse de la famille
                        type: object
                        description: Adresse de la famille au format de La Poste.
                          Cette adresse est déclarative. Si l'usager a changé d'adresse
                          et n'a pas actualisé son adresse auprès de la CAF ou de
                          la MSA, l'information sera donc obsolète.
                        properties:
                          destinataire:
                            title: Destinataire
                            type: string
                            example: Monsieur JEAN JACQUES
                            description: Civilité, titre ou qualité, nom et prénom
                              du destinataire.
                          complement_information:
                            title: Complément d'information du destinataire ou point
                              de remise
                            type: string
                            nullable: true
                            example:
                          complement_information_geographique:
                            title: Complément d'information du point géographique
                            type: string
                            nullable: true
                            example:
                          numero_libelle_voie:
                            title: Voie
                            type: string
                            description: Numéro et libellé de la voie.
                            example: 1 RUE DE LA GARE
                            nullable: true
                          lieu_dit:
                            title: Lieu-dit
                            type: string
                            nullable: true
                            example:
                            description: 'Lieu-dit ou service particulier de distribution
                              : poste restante, boîte postale.'
                          code_postal_ville:
                            title: Code postal
                            type: string
                            description: Code postal et localité de destination.
                            example: '75002'
                          pays:
                            title: Pays
                            type: string
                            example: FRANCE
                        x-scope: cnaf_adresse
                        required:
                        - destinataire
                        - complement_information
                        - complement_information_geographique
                        - numero_libelle_voie
                        - lieu_dit
                        - code_postal_ville
                        - pays
                      quotient_familial:
                        title: Informations du quotient familial (QF)
                        type: object
                        description: Données relatives à l'attribution du quotient
                          familial CAF ou MSA.
                        properties:
                          fournisseur:
                            title: Fournisseur du QF
                            type: string
                            description: Indique si le quotient familial de l'allocataire
                              provient de la CAF ou de la MSA.
                            example: MSA
                            enum:
                            - CNAF
                            - MSA
                          valeur:
                            title: Valeur du QF
                            type: integer
                            description: Valeur du quotient familial calculée par
                              la CAF ou la MSA.
                            example: 1045
                          annee:
                            title: Année effective du QF
                            type: integer
                            description: "Ce champ indique l'année effective du quotient
                              familial appelé. C'est-à-dire l'année à laquelle s'applique
                              le quotient familial. Cette année peut être différente
                              de l'année de calcul du quotient si ce dernier a été
                              recalculé suite à la réception d'informations rectifiant
                              la situation de l'allocataire. \n\n - Si aucune année
                              et aucun mois n'ont été renseignés en paramètres d'appel,
                              le quotient familial retourné sera celui du mois de
                              l'année en cours. - Si aucune année n'a été renseignée
                              et que le mois est renseigné, le quotient familial retourné
                              sera celui du mois spécifié pour l'année en cours. En
                              revanche, si la date finalement composée avec cette
                              règle s'avère dans le futur (mois postérieur au moins
                              en cours), l'API renvoie un erreur 400. "
                            example: 2023
                          mois:
                            title: Mois effectif du QF
                            type: integer
                            description: "Mois effectif du quotient familial. C'est-à-dire
                              le mois auquel s'applique le quotient familial. Ce mois
                              peut être différent du mois de calcul du quotient si
                              ce dernier a été recalculé suite à la réception d'informations
                              rectifiant la situation de l'allocataire. \n\n - Si
                              aucun mois et aucune année n'ont été renseignés en paramètres
                              d'appel, le quotient familial retourné sera celui du
                              mois de l'année en cours. - Si le mois est renseigné
                              mais qu'aucune année n'est saisie, le quotient familial
                              retourné sera celui du mois spécifié pour l'année en
                              cours. En revanche, si la date finalement composée avec
                              cette règle s'avère dans le futur (mois postérieur au
                              moins en cours), l'API renvoie un erreur 400. - Si aucun
                              mois n'a été renseigné mais que l'année a été spécifiée
                              en paramètres d'appel, le quotient familial retourné
                              sera celui du mois en cours pour l'année spécifiée."
                            example: 6
                          annee_calcul:
                            title: Année du calcul du QF
                            type: integer
                            description: "Année lors de laquelle le calcul du quotient
                              familial demandé a été effectué. Cette année peut différer
                              de l'année effective du quotient familial. \n\n Pour
                              la CAF, le quotient familial est recalculé uniquement
                              si de nouvelles informations sont venues rectifier la
                              situation de l'allocataire. \n Pour la MSA, le quotient
                              familial est systématiquement recalculé ; l'année correspond
                              donc toujours à l'année courante."
                            example: 2023
                          mois_calcul:
                            title: Mois du calcul du QF
                            type: integer
                            description: "Mois lors duquel le calcul du quotient familial
                              demandé a été effectué. Ce mois peut différer du mois
                              effectif du quotient familial. \n\n Pour la CAF, le
                              quotient familial est recalculé uniquement si de nouvelles
                              informations sont venues rectifier la situation de l'allocataire.
                              \n Pour la MSA, le quotient familial est systématiquement
                              recalculé ; le mois correspond donc toujours au mois
                              en cours."
                            example: 9
                        x-scope: cnaf_quotient_familial
                        required:
                        - fournisseur
                        - valeur
                        - annee
                        - mois
                        - annee_calcul
                        - mois_calcul
                    required:
                    - allocataires
                    - enfants
                    - adresse
                    - quotient_familial
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '422':
          description: Impossible d'identifier l'allocataire
          content:
            application/json:
              examples:
                entite_non_traitable_00366:
                  value:
                    errors:
                    - code: '00366'
                      title: Entité non traitable
                      detail: Un ou plusieurs paramètres de civilité ne sont pas correctement
                        formatés
                      source:
                      meta: {}
                  summary: Entité non traitable
                  description: Un ou plusieurs paramètres de civilité ne sont pas
                    correctement formatés
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '404':
          description: Dossier allocataire inexistant. Le document ne peut être édité.
          content:
            application/json:
              examples:
                dossier_allocataire_absent_msa_10003:
                  value:
                    errors:
                    - code: '10003'
                      title: Dossier allocataire absent MSA
                      detail: Le dossier allocataire n'a pas été trouvé auprès de
                        la MSA.
                      source:
                      meta:
                        provider: MSA
                  summary: Dossier allocataire absent MSA
                  description: Le dossier allocataire n'a pas été trouvé auprès de
                    la MSA.
                dossier_allocataire_absent_cnaf_23003:
                  value:
                    errors:
                    - code: '23003'
                      title: Dossier allocataire absent CNAF
                      detail: Le dossier allocataire n'a pas été trouvé auprès de
                        la CNAF.
                      source:
                      meta:
                        provider: CNAF
                  summary: Dossier allocataire absent CNAF
                  description: Le dossier allocataire n'a pas été trouvé auprès de
                    la CNAF.
                allocataire_non_reference_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Allocataire non référencé
                      detail: L'allocataire n'est pas référencé auprès des caisses
                        éligibles
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Allocataire non référencé
                  description: L'allocataire n'est pas référencé auprès des caisses
                    éligibles
                erreur_inattendue_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Erreur inattendue
                      detail: Une erreur inattendue est survenue lors de la collecte
                        des données
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Erreur inattendue
                  description: Une erreur inattendue est survenue lors de la collecte
                    des données
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/dss/revenu_solidarite_active/identite":
    get:
      summary: "[Identité] Statut revenu de solidarité active (RSA)"
      tags:
      - Statut Revenu Solidarité Active (RSA)
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: Cache-Control
        in: header
        description: Si cette valeur est fixée à "no-cache", le système de cache est
          alors ignoré et la donnée est directement récupérée depuis le fournisseur
          de données.
        schema:
          type: string
      - name: nomNaissance
        in: query
        description: "**Nom de naissance, également appelé nom de famille**. \n\nLe
          nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le
          livret de famille, etc. Le nom de famille/naissance figure toujours sur
          la pièce d'identité en premier, avant le nom d'usage si le particulier en
          a un. \n\nEn cas de changement de nom de naissance, une mention avec le
          nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler
          l'API, le nom de naissance/famille nécessaire est bien le nom de famille
          modifié."
        example: DURANT
        required: true
        schema:
          type: string
      - name: nomUsage
        in: query
        description: "**Nom d'usage**. \n\nSi le particulier a un nom d'usage, c'est
          le nom qu'il utilise généralement au quotidien. Le nom d'usage est facultatif
          et peut changer au cours de la vie. Il correspond au nom de famille/naissance
          d'un parent, d'un époux ou d'une épouse, seul ou accolé au nom de famille/naissance.
          Par exemple, le nom d'usage ne peut pas être le nom de famille/naissance
          d'un concubin ou d'un partenaire de pacs. \n\nSi le particulier en a fait
          la demande, le nom d'usage peut être inscrit derrière le nom de naissance
          sur la carte d'identité ou le passeport ; il peut également être celui utilisé
          par l'administration sur les courriers. Le nom d'usage ne remplace pas le
          nom de famille/naissance qui reste le seul mentionné. \nDans nos APIs, le
          nom d'usage n'est jamais identique au nom de famille.\n\nPour en savoir
          plus : https://www.service-public.fr/particuliers/vosdroits/F868."
        example: DUPONT DURANT
        required: false
        schema:
          type: string
      - name: prenoms[]
        in: query
        schema:
          type: array
          minItems: 1
          maxItems: 3
          items:
            type: string
          example:
          - PIERRE
          - RICHARD
        description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise
          les chances que l'API retrouve le particulier car cela permet de limiter
          le risque d’homonymie."
        required: true
      - name: anneeDateNaissance
        in: query
        description: "**Année de naissance**. \n\nPour un particulier né en France,
          dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance',
          ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance')
          afin de retrouver le code COG de la commune de naissance."
        example: 1990
        required: false
        schema:
          type: integer
      - name: moisDateNaissance
        in: query
        description: "**Mois de naissance**. \n\nCette valeur est ignorée si le paramètre
          'anneeDateNaissance' est vide."
        example: 1
        required: false
        schema:
          type: integer
      - name: jourDateNaissance
        in: query
        description: "**Jour de naissance**. \n\nCette valeur est ignorée si le paramètre
          'moisDateNaissance' ou le paramètre 'anneeDateNaissance' est vide.\""
        example: 1
        required: false
        schema:
          type: integer
      - name: sexeEtatCivil
        in: query
        schema:
          type: string
          enum:
          - M
          - F
        description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**,
          comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité
          des cas, il s'agit également de la mention indiquée sur la pièce d'identité
          et le passeport. Cette mention peut être masculin ('M') ou féminin ('F').
          \nDans le cas d'un particulier ayant demandé une modification de sa mention
          de sexe à l'état civil, le changement est indiqué en marge de l'acte de
          naissance une fois la décision rendue. Le changement intervient sur les
          titres d'identité seulement si le particulier en demande le renouvellement."
        example: M
        required: false
      - name: codeCogInseePaysNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '99100'
        description: |-
          **Code Insee à 5 chiffres du pays de naissance**.

          - Code Insee France = 99100 ;
          - Liste de tous les codes Insee des pays étrangers depuis 1943 : https://explore.data.gouv.fr/fr/datasets/58c984b088ee386cdb1261f3/#/resources/150889d3-ffda-4ea5-8709-6ee67415294f.
        required: true
      - name: codeCogInseeCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '08480'
        description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation de la seconde option
          (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance'),
          ce paramètre est obligatoire si la personne est née en France.\n\nNe pas
          remplir si la personne est née à l'étranger."
        required: false
      - name: nomCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 1
          example: Gennevilliers
        description: "**Nom en toute lettre de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation du 'codeCogInseeCommuneNaissance',
          ce paramètre est obligatoire si la personne est née en France ; il doit
          être obligatoirement accompagné des paramètres 'codeCogInseeDepartementNaissance'
          et 'anneeDateNaissance'.\n\nNe pas remplir si la personne est née à l'étranger."
        required: false
      - name: codeCogInseeDepartementNaissance
        in: query
        schema:
          type: string
          minLength: 2
          maxLength: 3
          example: '92'
        description: "**Code INSEE du département de naissance**. \n\nPour retrouver
          un particulier né en France, il est nécessaire d'indiquer sa commune de
          naissance. Ce paramètre fait partie d'une des deux options disponibles pour
          renseigner la commune de naissance. Lorsque le paramètre 'nomCommuneNaissance'
          est utilisé, ce paramètre est obligatoire si la personne est née en France
          et permet de retrouver le code COG avec le paramètre 'anneeDateNaissance'.\n\nNe
          pas remplir si la personne est née à l'étranger."
        required: false
      security:
      - jwt_bearer_token: []
      description: "Statut bénéficiaire du revenu de solidarité active (RSA), majoré
        ou non. \n\n Retourne également des informations sur les dates d'ouverture
        des droits."
      responses:
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Revenu solidarité active trouvée
          headers:
            X-Response-Cached:
              schema:
                type: boolean
                example: true
                enum:
                - true
                - false
                default: false
              description: Indique si la réponse a été caché.
            X-Cache-Expires-in:
              schema:
                type: number
                nullable: true
                example: 9001
              description: Secondes avant que le cache n'expire. Si le cache est vide,
                ce header est vide (mais présent). La durée du cache est de 1 heure.
          x-operationId: api_particulier_v3_cnav_revenu_solidarite_active_with_civility
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      est_beneficiaire:
                        title: Est bénéficiaire du revenu de solidarité active (RSA)
                        type: boolean
                        example: true
                        description: Indique que le particulier est bénéficiaire du
                          revenu de solidarité active au moment de l'appel.
                        x-scope: revenu_solidarite_active
                      avec_majoration:
                        title: RSA avec majoration
                        type: boolean
                        nullable: true
                        description: "Indique que le RSA du particulier bénéficiaire
                          est majoré au moment de l'appel. \n Si ce champ est à false,
                          cela signifie que le RSA n'est pas majoré. \n Ce champ est
                          null dans le cas où le particulier n'est pas bénéficiaire
                          du RSA."
                        example: false
                        x-scope: revenu_solidarite_active_majoration
                      date_debut_droit:
                        title: Date d'ouverture du droit au RSA
                        type: string
                        nullable: true
                        description: "Date de début de droit au RSA du particulier
                          bénéficiaire. \n Ce champ est null dans le cas où le particulier
                          n'est pas bénéficiaire du RSA."
                        example: '1992-11-29'
                        x-scope: revenu_solidarite_active
                    required:
                    - est_beneficiaire
                    - avec_majoration
                    - date_debut_droit
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '422':
          description: Impossible d'identifier l'allocataire
          content:
            application/json:
              examples:
                entite_non_traitable_00366:
                  value:
                    errors:
                    - code: '00366'
                      title: Entité non traitable
                      detail: Un ou plusieurs paramètres de civilité ne sont pas correctement
                        formatés
                      source:
                      meta: {}
                  summary: Entité non traitable
                  description: Un ou plusieurs paramètres de civilité ne sont pas
                    correctement formatés
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '404':
          description: Dossier allocataire inexistant. Le document ne peut être édité.
          content:
            application/json:
              examples:
                dossier_allocataire_absent:
                  value:
                    errors:
                    - code: '36003'
                      title: Dossier allocataire absent
                      detail: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                        de données est précisé dans 'meta.provider'.
                      source:
                      meta:
                        provider: Sécurité sociale
                  summary: Dossier allocataire absent
                  description: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                    de données est précisé dans 'meta.provider'.
                allocataire_non_reference_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Allocataire non référencé
                      detail: L'allocataire n'est pas référencé auprès des caisses
                        éligibles
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Allocataire non référencé
                  description: L'allocataire n'est pas référencé auprès des caisses
                    éligibles
                erreur_inattendue_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Erreur inattendue
                      detail: Une erreur inattendue est survenue lors de la collecte
                        des données
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Erreur inattendue
                  description: Une erreur inattendue est survenue lors de la collecte
                    des données
              schema:
                "$ref": "#/components/schemas/Error"
        '502':
          description: Erreur du fournisseur
          content:
            application/json:
              examples:
                erreur_inconnue_du_fournisseur_de_donnees_37999:
                  value:
                    errors:
                    - code: '37999'
                      title: Erreur inconnue du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et inconnue de notre service. L'équipe technique
                        a été notifiée de cette erreur pour investigation.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur inconnue du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et inconnue de notre service. L'équipe technique
                    a été notifiée de cette erreur pour investigation.
                erreur_interne_du_fournisseur_de_donnees_37000:
                  value:
                    errors:
                    - code: '37000'
                      title: Erreur interne du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et a été identifié comme étant une erreur interne.
                        Si le problème persiste, consultez la page de status ou contactez
                        nous sur le support.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur interne du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et a été identifié comme étant une erreur interne.
                    Si le problème persiste, consultez la page de status ou contactez
                    nous sur le support.
                erreur_aupres_du_fournisseur_de_donnees_trop_de_requetes_37008:
                  value:
                    errors:
                    - code: '37008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: CNAV
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
                erreur_temporaire_du_fournisseur_de_donnees_37011:
                  value:
                    errors:
                    - code: '37011'
                      title: Erreur temporaire du fournisseur de données
                      detail: Merci de réessayer dans quelques instants
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur temporaire du fournisseur de données
                  description: Merci de réessayer dans quelques instants
                erreur_de_certificat_ssl_du_fournisseur_de_donnees_37009:
                  value:
                    errors:
                    - code: '37009'
                      title: Erreur de certificat SSL du fournisseur de données
                      detail: Le certificat SSL du fournisseur de données est invalide
                        ou expiré.
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur de certificat SSL du fournisseur de données
                  description: Le certificat SSL du fournisseur de données est invalide
                    ou expiré.
              schema:
                "$ref": "#/components/schemas/Error"
        '504':
          description: Erreur d'intermédiaire
          content:
            application/json:
              examples:
                timeout_error:
                  value:
                    errors:
                    - code: '37002'
                      title: Intermédiaire hors-délai
                      detail: Temps d’attente d’une réponse du fournisseur de données
                        écoulé.
                      source:
                      meta:
                        provider: CNAV
                  summary: Intermédiaire hors-délai
                  description: Temps d’attente d’une réponse du fournisseur de données
                    écoulé.
                provider_unavailable_error:
                  value:
                    errors:
                    - code: '37001'
                      title: Service non disponible
                      detail: Service du fournisseur de données temporairement indisponible
                        ou en maintenance.
                      source:
                      meta:
                        provider: CNAV
                  summary: Service non disponible
                  description: Service du fournisseur de données temporairement indisponible
                    ou en maintenance.
                network_error:
                  value:
                    errors:
                    - code: '00501'
                      title: Erreur réseau
                      detail: Problème de connexion au serveur distant. L'erreur peut
                        venir soit du fournisseur, soit de API Entreprise. Il s'agit
                        souvent d'une erreur temporaire.
                      source:
                      meta:
                        retry_in: 10
                  summary: Erreur réseau
                  description: Problème de connexion au serveur distant. L'erreur
                    peut venir soit du fournisseur, soit de API Entreprise. Il s'agit
                    souvent d'une erreur temporaire.
                dns_resolution_error:
                  value:
                    errors:
                    - code: '37004'
                      title: Erreur de résolution DNS
                      detail: Problème de résolution DNS de l'adresse du serveur
                      source:
                      meta:
                        provider: CNAV
                  summary: Erreur de résolution DNS
                  description: Problème de résolution DNS de l'adresse du serveur
                provider_error:
                  value:
                    errors:
                    - code: '37008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: CNAV
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/dss/revenu_solidarite_active/france_connect":
    get:
      summary: "[FranceConnect] Statut revenu de solidarité active (RSA)"
      tags:
      - Statut Revenu Solidarité Active (RSA)
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: Cache-Control
        in: header
        description: Si cette valeur est fixée à "no-cache", le système de cache est
          alors ignoré et la donnée est directement récupérée depuis le fournisseur
          de données.
        schema:
          type: string
      security:
      - jwt_bearer_token: []
      description: "Statut bénéficiaire du revenu de solidarité active (RSA), majoré
        ou non. \n\n Retourne également des informations sur les dates d'ouverture
        des droits."
      responses:
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                missing_france_connect_access_token_error:
                  value:
                    errors:
                    - code: '50004'
                      title: Accès non autorisé
                      detail: 'Le jeton d''accès FranceConnect est manquant. Cet endpoint
                        requiert un jeton d''accès FranceConnect transmis via l''en-tête
                        Authorization: Bearer.'
                      source:
                      meta: {}
                  summary: Accès non autorisé
                  description: 'Le jeton d''accès FranceConnect est manquant. Cet
                    endpoint requiert un jeton d''accès FranceConnect transmis via
                    l''en-tête Authorization: Bearer.'
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Dossier trouvé
          headers:
            X-Response-Cached:
              schema:
                type: boolean
                example: true
                enum:
                - true
                - false
                default: false
              description: Indique si la réponse a été caché.
            X-Cache-Expires-in:
              schema:
                type: number
                nullable: true
                example: 9001
              description: Secondes avant que le cache n'expire. Si le cache est vide,
                ce header est vide (mais présent). La durée du cache est de 1 heure.
          x-operationId: api_particulier_v3_cnav_revenu_solidarite_active_with_france_connect
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      est_beneficiaire:
                        title: Est bénéficiaire du revenu de solidarité active (RSA)
                        type: boolean
                        example: true
                        description: Indique que le particulier est bénéficiaire du
                          revenu de solidarité active au moment de l'appel.
                        x-scope: revenu_solidarite_active
                      avec_majoration:
                        title: RSA avec majoration
                        type: boolean
                        nullable: true
                        description: "Indique que le RSA du particulier bénéficiaire
                          est majoré au moment de l'appel. \n Si ce champ est à false,
                          cela signifie que le RSA n'est pas majoré. \n Ce champ est
                          null dans le cas où le particulier n'est pas bénéficiaire
                          du RSA."
                        example: false
                        x-scope: revenu_solidarite_active_majoration
                      date_debut_droit:
                        title: Date d'ouverture du droit au RSA
                        type: string
                        nullable: true
                        description: "Date de début de droit au RSA du particulier
                          bénéficiaire. \n Ce champ est null dans le cas où le particulier
                          n'est pas bénéficiaire du RSA."
                        example: '1992-11-29'
                        x-scope: revenu_solidarite_active
                    required:
                    - est_beneficiaire
                    - avec_majoration
                    - date_debut_droit
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '422':
          description: Impossible d'identifier l'allocataire
          content:
            application/json:
              examples:
                entite_non_traitable_00366:
                  value:
                    errors:
                    - code: '00366'
                      title: Entité non traitable
                      detail: Un ou plusieurs paramètres de civilité ne sont pas correctement
                        formatés
                      source:
                      meta: {}
                  summary: Entité non traitable
                  description: Un ou plusieurs paramètres de civilité ne sont pas
                    correctement formatés
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '404':
          description: Dossier allocataire inexistant. Le document ne peut être édité.
          content:
            application/json:
              examples:
                dossier_allocataire_absent:
                  value:
                    errors:
                    - code: '36003'
                      title: Dossier allocataire absent
                      detail: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                        de données est précisé dans 'meta.provider'.
                      source:
                      meta:
                        provider: Sécurité sociale
                  summary: Dossier allocataire absent
                  description: Le dossier allocataire n'a pas été trouvé. Le fournisseur
                    de données est précisé dans 'meta.provider'.
                allocataire_non_reference_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Allocataire non référencé
                      detail: L'allocataire n'est pas référencé auprès des caisses
                        éligibles
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Allocataire non référencé
                  description: L'allocataire n'est pas référencé auprès des caisses
                    éligibles
                erreur_inattendue_35003:
                  value:
                    errors:
                    - code: '35003'
                      title: Erreur inattendue
                      detail: Une erreur inattendue est survenue lors de la collecte
                        des données
                      source:
                      meta:
                        provider: CNAF & MSA
                  summary: Erreur inattendue
                  description: Une erreur inattendue est survenue lors de la collecte
                    des données
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
  "/v4/cnous/etudiant_boursier/identite":
    get:
      summary: "[Identité] Statut étudiant boursier"
      tags:
      - Statut étudiant boursier
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: nomNaissance
        in: query
        description: "**Nom de naissance, également appelé nom de famille**. \n\nLe
          nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le
          livret de famille, etc. Le nom de famille/naissance figure toujours sur
          la pièce d'identité en premier, avant le nom d'usage si le particulier en
          a un. \n\nEn cas de changement de nom de naissance, une mention avec le
          nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler
          l'API, le nom de naissance/famille nécessaire est bien le nom de famille
          modifié."
        example: DURANT
        required: true
        schema:
          type: string
      - name: prenoms[]
        in: query
        schema:
          type: array
          minItems: 1
          maxItems: 3
          items:
            type: string
          example:
          - PIERRE
          - RICHARD
        description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise
          les chances que l'API retrouve le particulier car cela permet de limiter
          le risque d’homonymie."
        required: true
      - name: anneeDateNaissance
        in: query
        description: "**Année de naissance**. \n\nPour un particulier né en France,
          dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance',
          ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance')
          afin de retrouver le code COG de la commune de naissance."
        example: 1990
        required: true
        schema:
          type: integer
      - name: moisDateNaissance
        in: query
        description: "**Mois de naissance**."
        example: 1
        required: true
        schema:
          type: integer
      - name: jourDateNaissance
        in: query
        description: "**Jour de naissance**."
        example: 1
        required: true
        schema:
          type: integer
      - name: sexeEtatCivil
        in: query
        schema:
          type: string
          enum:
          - M
          - F
        description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**,
          comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité
          des cas, il s'agit également de la mention indiquée sur la pièce d'identité
          et le passeport. Cette mention peut être masculin ('M') ou féminin ('F').
          \nDans le cas d'un particulier ayant demandé une modification de sa mention
          de sexe à l'état civil, le changement est indiqué en marge de l'acte de
          naissance une fois la décision rendue. Le changement intervient sur les
          titres d'identité seulement si le particulier en demande le renouvellement."
        example: M
        required: false
      - name: codeCogInseeCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '08480'
        description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation de la seconde option
          (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance').\n\nNe
          pas remplir si la personne est née à l'étranger."
        required: false
      - name: nomCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 1
          example: Gennevilliers
        description: "**Nom en toute lettre de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation du 'codeCogInseeCommuneNaissance',
          ce paramètre est obligatoire si la personne est née en France ; il doit
          être obligatoirement accompagné des paramètres 'codeCogInseeDepartementNaissance'
          et 'anneeDateNaissance'.\n\nNe pas remplir si la personne est née à l'étranger."
        required: false
      - name: codeCogInseeDepartementNaissance
        in: query
        schema:
          type: string
          minLength: 2
          maxLength: 3
          example: '92'
        description: "**Code INSEE du département de naissance**. \n\nPour retrouver
          un particulier né en France, il est nécessaire d'indiquer sa commune de
          naissance. Ce paramètre fait partie d'une des deux options disponibles pour
          renseigner la commune de naissance. Lorsque le paramètre 'nomCommuneNaissance'
          est utilisé, ce paramètre est obligatoire si la personne est née en France
          et permet de retrouver le code COG avec le paramètre 'anneeDateNaissance'.\n\nNe
          pas remplir si la personne est née à l'étranger."
        required: false
      - name: campaignYear
        in: query
        description: |
          **Année de référence de la campagne scolaire** (paramètre optionnel).

          Année de début de la campagne scolaire recherchée. Par exemple, l'année scolaire 2025-2026 est représentée par `2025`.

          Les données sont disponibles à partir de la campagne 2021-2022. La fiabilité des données augmente avec les années, notamment car les imports régionaux étaient moins fréquents lors des premières campagnes.

          En l'absence de ce paramètre, l'API recherche une bourse valide pour l'étudiant ; si plusieurs résultats existent, elle renvoie la bourse la plus récente en priorité.
        example: 2024
        schema:
          type: integer
          minimum: 2021
        required: false
      security:
      - jwt_bearer_token: []
      description: Statut et échelon boursier d'un étudiant, délivrés par le Cnous.
      responses:
        '200':
          description: Étudiant identifié
          x-operationId: api_particulier_v4_cnous_etudiant_boursier_with_civility
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      statut_boursier:
                        title: Statut boursier
                        description: Informations relatives au statut boursier de
                          l'étudiant, incluant la radiation éventuelle.
                        type: object
                        properties:
                          est_boursier:
                            title: Est boursier
                            type: boolean
                            description: Indique que l'étudiant est boursier.
                            example: true
                          est_radie:
                            title: Est radié
                            type: boolean
                            description: Indique si l'étudiant a été radié. Si true,
                              le champ date_radiation contient la date de radiation.
                            example: false
                          date_radiation:
                            title: Date de radiation
                            type: string
                            format: date
                            nullable: true
                            description: Date de radiation. Renseignée uniquement
                              si est_radie est true.
                            example:
                        x-scope: cnous_statut_boursier
                        required:
                        - est_boursier
                        - est_radie
                        - date_radiation
                      periode_versement_bourse:
                        title: Période de versement de la bourse
                        description: Informations relatives à la période de versement
                          de la bourse de l'étudiant.
                        type: object
                        properties:
                          date_rentree:
                            title: Date de rentrée
                            type: string
                            format: date
                            description: Date de rentrée scolaire ou universitaire
                              de l'étudiant, correspondant au début de la période
                              de versement de la bourse.
                            example: '2019-09-01'
                          duree:
                            title: Durée de versement
                            type: number
                            description: Nombre de mois de versement de la bourse
                              à l'étudiant.
                            example: 12
                        x-scope: cnous_periode_versement
                        required:
                        - date_rentree
                        - duree
                      etablissement_etudes:
                        title: Établissement d'études de l'étudiant
                        description: Contient le détail des informations concernant
                          l'établissement dans lequel l'étudiant fait ses études.
                        type: object
                        properties:
                          nom_commune:
                            title: Commune d'études
                            type: string
                            description: Libellé de la commune d'études de l'étudiant
                            example: Brest
                          nom_etablissement:
                            title: Établissement d'études
                            type: string
                            description: Nom de l'établissement d'études de l'étudiant.
                            example: Carnot
                        x-scope: cnous_ville_etudes
                        required:
                        - nom_commune
                        - nom_etablissement
                      echelon_bourse:
                        title: Informations concernant l'échelon de la bourse
                        description: Informations relatives à l'échelon de la bourse.
                        type: object
                        properties:
                          echelon:
                            title: Échelon de la bourse
                            type: string
                            description: "Ce champ indique l'échelon de la bourse
                              de l'étudiant. Il existe 8 échelons de bourse, de 0bis
                              à 7, correspondant aux montants reçus par l'étudiant
                              pour l'année scolaire. \n\n Pour en savoir plus, consulter
                              la FAQ : https://particulier.api.gouv.fr/catalogue/cnous/statut_etudiant_boursier#faq_entry_answer_0_api_particulier_endpoint_cnous_statut_etudiant_boursier."
                            example: '6'
                            enum:
                            - 0bis
                            - '1'
                            - '2'
                            - '3'
                            - '4'
                            - '5'
                            - '6'
                            - '7'
                          echelon_bourse_regionale_provisoire:
                            title: Statut provisoire (bourses régionales uniquement)
                            description: Ce champ indique que l'échelon de la bourse
                              indiqué est provisoire. Ce statut provisoire n'est indiqué
                              que pour les boursiers bénéficiaires d'une bourse régionale.
                            type: boolean
                            example: true
                            enum:
                            - true
                            - false
                        x-scope: cnous_echelon_bourse
                        required:
                        - echelon
                        - echelon_bourse_regionale_provisoire
                      email:
                        title: E-mail
                        type: string
                        description: Adresse e-mail de l'étudiant boursier.
                        example: georges@moustaki.fr
                        x-scope: cnous_email
                      identite:
                        title: Données d'identité
                        type: object
                        description: "Données d'identité de l'étudiant boursier. Ces
                          informations d'identité sont saisies manuellement par les
                          étudiants. \n\n - Dans le cas des étudiants avec bourse
                          nationale, les informations sont vérifiées par un agent
                          via la pièce d'identité fournie (sauf le lieu de naissance)
                          ; \n\n - Dans le cas des étudiants avec bourse régionale,
                          les informations ne sont pas revérifiées avant d'être remontées
                          au Cnous, mais si l'étudiant est déjà connu du Cnous, c'est
                          l'identité vérifiée du Cnous qui sera retenue."
                        properties:
                          nom:
                            title: Nom de naissance
                            type: string
                            description: Nom de naissance de l'étudiant boursier.
                            example: Moustaki
                          prenoms:
                            type: array
                            minItems: 1
                            items:
                              type: string
                            example:
                            - PIERRE
                            - RICHARD
                          date_naissance:
                            title: Date de naissance
                            type: string
                            format: date
                            description: Date de naissance de l'étudiant boursier.
                            example: '1992-11-29'
                          nom_commune_naissance:
                            title: Commune de naissance
                            type: string
                            description: Libellé de la commune de naissance de l'étudiant
                              boursier.
                            example: Poitiers
                          sexe:
                            title: Sexe
                            type: string
                            description: Sexe de l'étudiant boursier.
                            example: M
                            enum:
                            - M
                            - F
                        x-scope: cnous_identite
                        required:
                        - nom
                        - prenoms
                        - date_naissance
                        - nom_commune_naissance
                        - sexe
                    required:
                    - statut_boursier
                    - periode_versement_bourse
                    - etablissement_etudes
                    - echelon_bourse
                    - email
                    - identite
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '422':
          description: Paramètre(s) invalide(s)
          content:
            application/json:
              examples:
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
  "/v4/cnous/etudiant_boursier/france_connect":
    get:
      summary: "[FranceConnect] Statut étudiant boursier"
      tags:
      - Statut étudiant boursier
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: campaignYear
        in: query
        description: |
          **Année de référence de la campagne scolaire** (paramètre optionnel).

          Année de début de la campagne scolaire recherchée. Par exemple, l'année scolaire 2025-2026 est représentée par `2025`.

          Les données sont disponibles à partir de la campagne 2021-2022. La fiabilité des données augmente avec les années, notamment car les imports régionaux étaient moins fréquents lors des premières campagnes.

          En l'absence de ce paramètre, l'API recherche une bourse valide pour l'étudiant ; si plusieurs résultats existent, elle renvoie la bourse la plus récente en priorité.
        example: 2024
        schema:
          type: integer
          minimum: 2021
        required: false
      security:
      - jwt_bearer_token: []
      description: Statut et échelon boursier d'un étudiant, délivrés par le Cnous.
      responses:
        '200':
          description: Étudiant identifié
          x-operationId: api_particulier_v4_cnous_etudiant_boursier_with_france_connect
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      statut_boursier:
                        title: Statut boursier
                        description: Informations relatives au statut boursier de
                          l'étudiant, incluant la radiation éventuelle.
                        type: object
                        properties:
                          est_boursier:
                            title: Est boursier
                            type: boolean
                            description: Indique que l'étudiant est boursier.
                            example: true
                          est_radie:
                            title: Est radié
                            type: boolean
                            description: Indique si l'étudiant a été radié. Si true,
                              le champ date_radiation contient la date de radiation.
                            example: false
                          date_radiation:
                            title: Date de radiation
                            type: string
                            format: date
                            nullable: true
                            description: Date de radiation. Renseignée uniquement
                              si est_radie est true.
                            example:
                        x-scope: cnous_statut_boursier
                        required:
                        - est_boursier
                        - est_radie
                        - date_radiation
                      periode_versement_bourse:
                        title: Période de versement de la bourse
                        description: Informations relatives à la période de versement
                          de la bourse de l'étudiant.
                        type: object
                        properties:
                          date_rentree:
                            title: Date de rentrée
                            type: string
                            format: date
                            description: Date de rentrée scolaire ou universitaire
                              de l'étudiant, correspondant au début de la période
                              de versement de la bourse.
                            example: '2019-09-01'
                          duree:
                            title: Durée de versement
                            type: number
                            description: Nombre de mois de versement de la bourse
                              à l'étudiant.
                            example: 12
                        x-scope: cnous_periode_versement
                        required:
                        - date_rentree
                        - duree
                      etablissement_etudes:
                        title: Établissement d'études de l'étudiant
                        description: Contient le détail des informations concernant
                          l'établissement dans lequel l'étudiant fait ses études.
                        type: object
                        properties:
                          nom_commune:
                            title: Commune d'études
                            type: string
                            description: Libellé de la commune d'études de l'étudiant
                            example: Brest
                          nom_etablissement:
                            title: Établissement d'études
                            type: string
                            description: Nom de l'établissement d'études de l'étudiant.
                            example: Carnot
                        x-scope: cnous_ville_etudes
                        required:
                        - nom_commune
                        - nom_etablissement
                      echelon_bourse:
                        title: Informations concernant l'échelon de la bourse
                        description: Informations relatives à l'échelon de la bourse.
                        type: object
                        properties:
                          echelon:
                            title: Échelon de la bourse
                            type: string
                            description: "Ce champ indique l'échelon de la bourse
                              de l'étudiant. Il existe 8 échelons de bourse, de 0bis
                              à 7, correspondant aux montants reçus par l'étudiant
                              pour l'année scolaire. \n\n Pour en savoir plus, consulter
                              la FAQ : https://particulier.api.gouv.fr/catalogue/cnous/statut_etudiant_boursier#faq_entry_answer_0_api_particulier_endpoint_cnous_statut_etudiant_boursier."
                            example: '6'
                            enum:
                            - 0bis
                            - '1'
                            - '2'
                            - '3'
                            - '4'
                            - '5'
                            - '6'
                            - '7'
                          echelon_bourse_regionale_provisoire:
                            title: Statut provisoire (bourses régionales uniquement)
                            description: Ce champ indique que l'échelon de la bourse
                              indiqué est provisoire. Ce statut provisoire n'est indiqué
                              que pour les boursiers bénéficiaires d'une bourse régionale.
                            type: boolean
                            example: true
                            enum:
                            - true
                            - false
                        x-scope: cnous_echelon_bourse
                        required:
                        - echelon
                        - echelon_bourse_regionale_provisoire
                      email:
                        title: E-mail
                        type: string
                        description: Adresse e-mail de l'étudiant boursier.
                        example: georges@moustaki.fr
                        x-scope: cnous_email
                    required:
                    - statut_boursier
                    - periode_versement_bourse
                    - etablissement_etudes
                    - echelon_bourse
                    - email
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '422':
          description: Paramètre(s) invalide(s)
          content:
            application/json:
              examples:
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
  "/v4/cnous/etudiant_boursier/ine":
    get:
      summary: "[INE] Statut étudiant boursier"
      tags:
      - Statut étudiant boursier
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: ine
        in: query
        description: Identifiant National Étudiant (INE). Cet identifiant est unique
          à chaque étudiant sur le territoire français. Il est composé de 11 caractères,
          10 chiffres et 1 lettre, et depuis la rentrée 2018, 9 chiffres et 2 lettres.
          Les étudiants peuvent retrouver leur numéro INE sur leur carte étudiant
          et leur certificat de scolarité.
        example: 1234567890G
        schema:
          type: string
          pattern: "^[0-9a-zA-Z]{11}$"
        required: true
      - name: campaignYear
        in: query
        description: |
          **Année de référence de la campagne scolaire** (paramètre optionnel).

          Année de début de la campagne scolaire recherchée. Par exemple, l'année scolaire 2025-2026 est représentée par `2025`.

          Les données sont disponibles à partir de la campagne 2021-2022. La fiabilité des données augmente avec les années, notamment car les imports régionaux étaient moins fréquents lors des premières campagnes.

          En l'absence de ce paramètre, l'API recherche une bourse valide pour l'étudiant ; si plusieurs résultats existent, elle renvoie la bourse la plus récente en priorité.
        example: 2024
        schema:
          type: integer
          minimum: 2021
        required: false
      security:
      - jwt_bearer_token: []
      description: Statut et échelon boursier d'un étudiant, délivrés par le Cnous.
      responses:
        '200':
          description: Étudiant identifié
          x-operationId: api_particulier_v4_cnous_etudiant_boursier_with_ine
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      statut_boursier:
                        title: Statut boursier
                        description: Informations relatives au statut boursier de
                          l'étudiant, incluant la radiation éventuelle.
                        type: object
                        properties:
                          est_boursier:
                            title: Est boursier
                            type: boolean
                            description: Indique que l'étudiant est boursier.
                            example: true
                          est_radie:
                            title: Est radié
                            type: boolean
                            description: Indique si l'étudiant a été radié. Si true,
                              le champ date_radiation contient la date de radiation.
                            example: false
                          date_radiation:
                            title: Date de radiation
                            type: string
                            format: date
                            nullable: true
                            description: Date de radiation. Renseignée uniquement
                              si est_radie est true.
                            example:
                        x-scope: cnous_statut_boursier
                        required:
                        - est_boursier
                        - est_radie
                        - date_radiation
                      periode_versement_bourse:
                        title: Période de versement de la bourse
                        description: Informations relatives à la période de versement
                          de la bourse de l'étudiant.
                        type: object
                        properties:
                          date_rentree:
                            title: Date de rentrée
                            type: string
                            format: date
                            description: Date de rentrée scolaire ou universitaire
                              de l'étudiant, correspondant au début de la période
                              de versement de la bourse.
                            example: '2019-09-01'
                          duree:
                            title: Durée de versement
                            type: number
                            description: Nombre de mois de versement de la bourse
                              à l'étudiant.
                            example: 12
                        x-scope: cnous_periode_versement
                        required:
                        - date_rentree
                        - duree
                      etablissement_etudes:
                        title: Établissement d'études de l'étudiant
                        description: Contient le détail des informations concernant
                          l'établissement dans lequel l'étudiant fait ses études.
                        type: object
                        properties:
                          nom_commune:
                            title: Commune d'études
                            type: string
                            description: Libellé de la commune d'études de l'étudiant
                            example: Brest
                          nom_etablissement:
                            title: Établissement d'études
                            type: string
                            description: Nom de l'établissement d'études de l'étudiant.
                            example: Carnot
                        x-scope: cnous_ville_etudes
                        required:
                        - nom_commune
                        - nom_etablissement
                      echelon_bourse:
                        title: Informations concernant l'échelon de la bourse
                        description: Informations relatives à l'échelon de la bourse.
                        type: object
                        properties:
                          echelon:
                            title: Échelon de la bourse
                            type: string
                            description: "Ce champ indique l'échelon de la bourse
                              de l'étudiant. Il existe 8 échelons de bourse, de 0bis
                              à 7, correspondant aux montants reçus par l'étudiant
                              pour l'année scolaire. \n\n Pour en savoir plus, consulter
                              la FAQ : https://particulier.api.gouv.fr/catalogue/cnous/statut_etudiant_boursier#faq_entry_answer_0_api_particulier_endpoint_cnous_statut_etudiant_boursier."
                            example: '6'
                            enum:
                            - 0bis
                            - '1'
                            - '2'
                            - '3'
                            - '4'
                            - '5'
                            - '6'
                            - '7'
                          echelon_bourse_regionale_provisoire:
                            title: Statut provisoire (bourses régionales uniquement)
                            description: Ce champ indique que l'échelon de la bourse
                              indiqué est provisoire. Ce statut provisoire n'est indiqué
                              que pour les boursiers bénéficiaires d'une bourse régionale.
                            type: boolean
                            example: true
                            enum:
                            - true
                            - false
                        x-scope: cnous_echelon_bourse
                        required:
                        - echelon
                        - echelon_bourse_regionale_provisoire
                      email:
                        title: E-mail
                        type: string
                        description: Adresse e-mail de l'étudiant boursier.
                        example: georges@moustaki.fr
                        x-scope: cnous_email
                      identite:
                        title: Données d'identité
                        type: object
                        description: "Données d'identité de l'étudiant boursier. Ces
                          informations d'identité sont saisies manuellement par les
                          étudiants. \n\n - Dans le cas des étudiants avec bourse
                          nationale, les informations sont vérifiées par un agent
                          via la pièce d'identité fournie (sauf le lieu de naissance)
                          ; \n\n - Dans le cas des étudiants avec bourse régionale,
                          les informations ne sont pas revérifiées avant d'être remontées
                          au Cnous, mais si l'étudiant est déjà connu du Cnous, c'est
                          l'identité vérifiée du Cnous qui sera retenue."
                        properties:
                          nom:
                            title: Nom de naissance
                            type: string
                            description: Nom de naissance de l'étudiant boursier.
                            example: Moustaki
                          prenoms:
                            type: array
                            minItems: 1
                            items:
                              type: string
                            example:
                            - PIERRE
                            - RICHARD
                          date_naissance:
                            title: Date de naissance
                            type: string
                            format: date
                            description: Date de naissance de l'étudiant boursier.
                            example: '1992-11-29'
                          nom_commune_naissance:
                            title: Commune de naissance
                            type: string
                            description: Libellé de la commune de naissance de l'étudiant
                              boursier.
                            example: Poitiers
                          sexe:
                            title: Sexe
                            type: string
                            description: Sexe de l'étudiant boursier.
                            example: M
                            enum:
                            - M
                            - F
                        x-scope: cnous_identite
                        required:
                        - nom
                        - prenoms
                        - date_naissance
                        - nom_commune_naissance
                        - sexe
                    required:
                    - statut_boursier
                    - periode_versement_bourse
                    - etablissement_etudes
                    - echelon_bourse
                    - email
                    - identite
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '422':
          description: Paramètre(s) invalide(s)
          content:
            application/json:
              examples:
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/dsnj/service_national/identite":
    get:
      summary: "[Identité] API Service national"
      tags:
      - Statut Service national
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: nomNaissance
        in: query
        description: "**Nom de naissance, également appelé nom de famille**. \n\nLe
          nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le
          livret de famille, etc. Le nom de famille/naissance figure toujours sur
          la pièce d'identité en premier, avant le nom d'usage si le particulier en
          a un. \n\nEn cas de changement de nom de naissance, une mention avec le
          nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler
          l'API, le nom de naissance/famille nécessaire est bien le nom de famille
          modifié."
        example: DURANT
        required: true
        schema:
          type: string
      - name: prenoms[]
        in: query
        schema:
          type: array
          minItems: 1
          maxItems: 3
          items:
            type: string
          example:
          - PIERRE
          - RICHARD
        description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise
          les chances que l'API retrouve le particulier car cela permet de limiter
          le risque d’homonymie."
        required: true
      - name: anneeDateNaissance
        in: query
        description: "**Année de naissance**. \n\nPour un particulier né en France,
          dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance',
          ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance')
          afin de retrouver le code COG de la commune de naissance."
        example: 1990
        required: true
        schema:
          type: integer
      - name: moisDateNaissance
        in: query
        description: "**Mois de naissance**."
        example: 1
        required: true
        schema:
          type: integer
      - name: jourDateNaissance
        in: query
        description: "**Jour de naissance**."
        example: 1
        required: true
        schema:
          type: integer
      - name: sexeEtatCivil
        in: query
        schema:
          type: string
          enum:
          - M
          - F
        description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**,
          comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité
          des cas, il s'agit également de la mention indiquée sur la pièce d'identité
          et le passeport. Cette mention peut être masculin ('M') ou féminin ('F').
          \nDans le cas d'un particulier ayant demandé une modification de sa mention
          de sexe à l'état civil, le changement est indiqué en marge de l'acte de
          naissance une fois la décision rendue. Le changement intervient sur les
          titres d'identité seulement si le particulier en demande le renouvellement."
        example: M
        required: true
      - name: codeCogInseeCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '08480'
        description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation de la seconde option
          (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance').\n\nNe
          pas remplir si la personne est née à l'étranger."
        required: false
      - name: codeCogInseePaysNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '99100'
        description: |-
          **Code Insee à 5 chiffres du pays de naissance**.

          - Code Insee France = 99100 ;
          - Liste de tous les codes Insee des pays étrangers depuis 1943 : https://explore.data.gouv.fr/fr/datasets/58c984b088ee386cdb1261f3/#/resources/150889d3-ffda-4ea5-8709-6ee67415294f.
        required: true
      security:
      - jwt_bearer_token: []
      description: Statut de conformité au Service national des jeunes entre 16 et
        25 ans.
      responses:
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Identité trouvée
          headers:
            RateLimit-Limit:
              schema:
                type: integer
              description: La limite concernant l’endpoint appelé, soit le nombre
                de requête/minute.
              example: 50
            RateLimit-Remaining:
              schema:
                type: integer
              description: Le nombre d’appels restants durant la période courante
                d’une minute.
              example: 47
            RateLimit-Reset:
              schema:
                type: integer
              description: La fin de la période courante (en format timestamp)
              example: 1637223155
          x-operationId: api_particulier_v3_dsnj_service_national_with_civility
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      statut_service_national:
                        title: Statut service national
                        type: string
                        description: Indique si la personne est en règle de ses obligations
                          de service national. "en_regle" si la personne est en règle,
                          "pas_en_regle" si la personne n'est pas en règle, "indetermine"
                          si l'information n'est pas connue, "non_concerne" si la
                          personne n'est pas concernée par les obligations de service
                          national.
                        example: en_regle
                        enum:
                        - en_regle
                        - pas_en_regle
                        - indetermine
                        - non_concerne
                        x-scope: dsnj_statut_service_national
                      commentaires:
                        title: Commentaires de la DSNJ
                        type: string
                        description: Commentaire indiqué par la direction du Service
                          national et de la jeunesse (DSNJ), notamment pour les cas
                          particuliers.
                        nullable: true
                        x-scope: dsnj_statut_service_national
                    required:
                    - statut_service_national
                    - commentaires
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '404':
          description: Non trouvée
          content:
            application/json:
              examples:
                entite_non_trouvee_39003:
                  value:
                    errors:
                    - code: '39003'
                      title: Entité non trouvée
                      detail: Le ou les paramètre(s) d'entrée n'existent pas, ne sont
                        pas connus, ou ne comportent aucune information pour cet appel.
                        Veuillez vérifier que votre recherche est couverte par le
                        périmètre de l'API.
                      source:
                      meta:
                        provider: DSNJ
                  summary: Entité non trouvée
                  description: Le ou les paramètre(s) d'entrée n'existent pas, ne
                    sont pas connus, ou ne comportent aucune information pour cet
                    appel. Veuillez vérifier que votre recherche est couverte par
                    le périmètre de l'API.
              schema:
                "$ref": "#/components/schemas/Error"
        '422':
          description: Paramètre(s) invalide(s)
          content:
            application/json:
              examples:
                unprocessable_content_error_sexe_etat_civil_error:
                  value:
                    errors:
                    - code: '00427'
                      title: Entité non traitable
                      detail: Le sexe de l'état civil est manquant
                      source:
                      meta: {}
                  summary: Entité non traitable
                  description: Le sexe de l'état civil est manquant
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '502':
          description: Erreur du fournisseur
          content:
            application/json:
              examples:
                erreur_inconnue_du_fournisseur_de_donnees_39999:
                  value:
                    errors:
                    - code: '39999'
                      title: Erreur inconnue du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et inconnue de notre service. L'équipe technique
                        a été notifiée de cette erreur pour investigation.
                      source:
                      meta:
                        provider: DSNJ
                  summary: Erreur inconnue du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et inconnue de notre service. L'équipe technique
                    a été notifiée de cette erreur pour investigation.
                erreur_interne_du_fournisseur_de_donnees_39000:
                  value:
                    errors:
                    - code: '39000'
                      title: Erreur interne du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et a été identifié comme étant une erreur interne.
                        Si le problème persiste, consultez la page de status ou contactez
                        nous sur le support.
                      source:
                      meta:
                        provider: DSNJ
                  summary: Erreur interne du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et a été identifié comme étant une erreur interne.
                    Si le problème persiste, consultez la page de status ou contactez
                    nous sur le support.
                erreur_aupres_du_fournisseur_de_donnees_trop_de_requetes_39008:
                  value:
                    errors:
                    - code: '39008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: DSNJ
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
                erreur_temporaire_du_fournisseur_de_donnees_39011:
                  value:
                    errors:
                    - code: '39011'
                      title: Erreur temporaire du fournisseur de données
                      detail: Merci de réessayer dans quelques instants
                      source:
                      meta:
                        provider: DSNJ
                  summary: Erreur temporaire du fournisseur de données
                  description: Merci de réessayer dans quelques instants
                erreur_de_certificat_ssl_du_fournisseur_de_donnees_39009:
                  value:
                    errors:
                    - code: '39009'
                      title: Erreur de certificat SSL du fournisseur de données
                      detail: Le certificat SSL du fournisseur de données est invalide
                        ou expiré.
                      source:
                      meta:
                        provider: DSNJ
                  summary: Erreur de certificat SSL du fournisseur de données
                  description: Le certificat SSL du fournisseur de données est invalide
                    ou expiré.
              schema:
                "$ref": "#/components/schemas/Error"
        '504':
          description: Erreur d'intermédiaire
          content:
            application/json:
              examples:
                timeout_error:
                  value:
                    errors:
                    - code: '39002'
                      title: Intermédiaire hors-délai
                      detail: Temps d’attente d’une réponse du fournisseur de données
                        écoulé.
                      source:
                      meta:
                        provider: DSNJ
                  summary: Intermédiaire hors-délai
                  description: Temps d’attente d’une réponse du fournisseur de données
                    écoulé.
                provider_unavailable_error:
                  value:
                    errors:
                    - code: '39001'
                      title: Service non disponible
                      detail: Service du fournisseur de données temporairement indisponible
                        ou en maintenance.
                      source:
                      meta:
                        provider: DSNJ
                  summary: Service non disponible
                  description: Service du fournisseur de données temporairement indisponible
                    ou en maintenance.
                network_error:
                  value:
                    errors:
                    - code: '00501'
                      title: Erreur réseau
                      detail: Problème de connexion au serveur distant. L'erreur peut
                        venir soit du fournisseur, soit de API Entreprise. Il s'agit
                        souvent d'une erreur temporaire.
                      source:
                      meta:
                        retry_in: 10
                  summary: Erreur réseau
                  description: Problème de connexion au serveur distant. L'erreur
                    peut venir soit du fournisseur, soit de API Entreprise. Il s'agit
                    souvent d'une erreur temporaire.
                dns_resolution_error:
                  value:
                    errors:
                    - code: '39004'
                      title: Erreur de résolution DNS
                      detail: Problème de résolution DNS de l'adresse du serveur
                      source:
                      meta:
                        provider: DSNJ
                  summary: Erreur de résolution DNS
                  description: Problème de résolution DNS de l'adresse du serveur
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/dsnj/service_national/france_connect":
    get:
      summary: "[FranceConnect] API Service national"
      tags:
      - Statut Service national
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      security:
      - jwt_bearer_token: []
      description: Statut de conformité au Service national des jeunes entre 16 et
        25 ans.
      responses:
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                missing_france_connect_access_token_error:
                  value:
                    errors:
                    - code: '50004'
                      title: Accès non autorisé
                      detail: 'Le jeton d''accès FranceConnect est manquant. Cet endpoint
                        requiert un jeton d''accès FranceConnect transmis via l''en-tête
                        Authorization: Bearer.'
                      source:
                      meta: {}
                  summary: Accès non autorisé
                  description: 'Le jeton d''accès FranceConnect est manquant. Cet
                    endpoint requiert un jeton d''accès FranceConnect transmis via
                    l''en-tête Authorization: Bearer.'
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Identité trouvée
          headers:
            RateLimit-Limit:
              schema:
                type: integer
              description: La limite concernant l’endpoint appelé, soit le nombre
                de requête/minute.
              example: 50
            RateLimit-Remaining:
              schema:
                type: integer
              description: Le nombre d’appels restants durant la période courante
                d’une minute.
              example: 47
            RateLimit-Reset:
              schema:
                type: integer
              description: La fin de la période courante (en format timestamp)
              example: 1637223155
          x-operationId: api_particulier_v3_dsnj_service_national_with_france_connect
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      statut_service_national:
                        title: Statut service national
                        type: string
                        description: Indique si la personne est en règle de ses obligations
                          de service national. "en_regle" si la personne est en règle,
                          "pas_en_regle" si la personne n'est pas en règle, "indetermine"
                          si l'information n'est pas connue, "non_concerne" si la
                          personne n'est pas concernée par les obligations de service
                          national.
                        example: en_regle
                        enum:
                        - en_regle
                        - pas_en_regle
                        - indetermine
                        - non_concerne
                        x-scope: dsnj_statut_service_national
                      commentaires:
                        title: Commentaires de la DSNJ
                        type: string
                        description: Commentaire indiqué par la direction du Service
                          national et de la jeunesse (DSNJ), notamment pour les cas
                          particuliers.
                        nullable: true
                        x-scope: dsnj_statut_service_national
                    required:
                    - statut_service_national
                    - commentaires
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '404':
          description: Non trouvée
          content:
            application/json:
              examples:
                entite_non_trouvee_39003:
                  value:
                    errors:
                    - code: '39003'
                      title: Entité non trouvée
                      detail: Le ou les paramètre(s) d'entrée n'existent pas, ne sont
                        pas connus, ou ne comportent aucune information pour cet appel.
                        Veuillez vérifier que votre recherche est couverte par le
                        périmètre de l'API.
                      source:
                      meta:
                        provider: DSNJ
                  summary: Entité non trouvée
                  description: Le ou les paramètre(s) d'entrée n'existent pas, ne
                    sont pas connus, ou ne comportent aucune information pour cet
                    appel. Veuillez vérifier que votre recherche est couverte par
                    le périmètre de l'API.
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '422':
          description: Paramètre(s) invalide(s)
          content:
            application/json:
              examples:
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/france_travail/indemnites/identifiant":
    get:
      summary: Paiements versés par France Travail
      tags:
      - Paiements versés par France Travail
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: identifiant
        in: query
        description: Identifiant France Travail choisi par le particulier lors de
          la création de son espace personnel en ligne.
        example: jean.dupont33
        required: true
        schema:
          type: string
      security:
      - jwt_bearer_token: []
      description: Ensemble des paiements versés par France Travail au particulier
      responses:
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Indemnites trouvées
          x-operationId: api_particulier_v3_france_travail_indemnites_with_identifiant
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      identifiant:
                        title: Nom d'utilisateur France Travail
                        type: string
                        description: Identifiant du compte utilisateur France Travail,
                          tel qu'il a été renseigné en paramètre d'appel. Cet identifiant
                          est le nom d'utilisateur tel que choisi par le particulier
                          lors de la création de son espace personnel en ligne.
                        example: jean.dupont33
                      paiements:
                        title: Liste des paiements versés
                        description: Liste des paiements versés par FranceTravail
                          au particulier.
                        type: array
                        minItems: 1
                        items:
                          title: Paiement
                          type: object
                          properties:
                            date_versement:
                              title: Date du paiement
                              type: string
                              example: '2021-01-01'
                            montant_total:
                              title: Montant total versé
                              description: Montant total du paiement. Il s'agit de
                                la somme des allocations, aides et autres paiements,
                                moins le prélèvement de l'impôt à la source.
                              type: number
                              example: 123.4
                            montant_allocations:
                              title: Montant d'allocations
                              description: Montant du paiement, avant prélèvement
                                de l'impôt à la source, correspondant aux allocations
                                (allocation d'aide au retour à l'emploi, allocation
                                de sécurisation professionnelle, allocation de solidarité
                                spécifique, allocation pour les travailleurs indépendants,
                                Rémunération de formation France Travail, Rémunération
                                de fin de formation, allocation de fin de droit, allocation
                                d'accompagnement personnalisé, allocation de professionnalisation
                                et de solidarité, allocation décès, allocation contrat
                                engagement jeune).
                              type: number
                              example: 45.1
                            montant_aides:
                              title: Montant d'aides
                              description: Montant du paiement, avant prélèvement
                                de l'impôt à la source, correspondant aux aides (aide
                                à la reprise et à la création d’entreprise, aide à
                                la mobilité, aide à la garde d'enfant pour parent
                                isolé, aide fin de droit, aide aux congés non payés,
                                aide à la valorisation des acquis par l'expérience,
                                aide du fond de sécurisation du secteur automobile,
                                aide ponctuelle jeune, aide régionale, aide aux demandeurs
                                d'emploi longue durée, aide exceptionnelle de solidarité,
                                Prime de reclassement).
                              type: number
                              example: 12.21
                            montant_autres:
                              title: Montant des autres paiements
                              description: Montant du paiement, avant prélèvement
                                de l'impôt à la source, correspondant aux autres paiements
                                (prime de Noël, indemnité différentielle de reclassement,
                                acompte, avance, reversement).
                              type: number
                              example: 2.34
                        x-scope: pole_emploi_paiements
                    required:
                    - identifiant
                    - paiements
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '404':
          description: Non trouvée
          content:
            application/json:
              examples:
                entite_non_trouvee_24003:
                  value:
                    errors:
                    - code: '24003'
                      title: Entité non trouvée
                      detail: Aucune situation France Travail n'a pu être trouvée
                        avec les critères de recherche fournis.
                      source:
                      meta:
                        provider: France Travail
                  summary: Entité non trouvée
                  description: Aucune situation France Travail n'a pu être trouvée
                    avec les critères de recherche fournis.
              schema:
                "$ref": "#/components/schemas/Error"
        '502':
          description: Erreur du fournisseur
          content:
            application/json:
              examples:
                erreur_inconnue_du_fournisseur_de_donnees_24999:
                  value:
                    errors:
                    - code: '24999'
                      title: Erreur inconnue du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et inconnue de notre service. L'équipe technique
                        a été notifiée de cette erreur pour investigation.
                      source:
                      meta:
                        provider: France Travail
                  summary: Erreur inconnue du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et inconnue de notre service. L'équipe technique
                    a été notifiée de cette erreur pour investigation.
                erreur_interne_du_fournisseur_de_donnees_24000:
                  value:
                    errors:
                    - code: '24000'
                      title: Erreur interne du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et a été identifié comme étant une erreur interne.
                        Si le problème persiste, consultez la page de status ou contactez
                        nous sur le support.
                      source:
                      meta:
                        provider: France Travail
                  summary: Erreur interne du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et a été identifié comme étant une erreur interne.
                    Si le problème persiste, consultez la page de status ou contactez
                    nous sur le support.
                erreur_aupres_du_fournisseur_de_donnees_trop_de_requetes_24008:
                  value:
                    errors:
                    - code: '24008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: France Travail
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
                erreur_temporaire_du_fournisseur_de_donnees_24011:
                  value:
                    errors:
                    - code: '24011'
                      title: Erreur temporaire du fournisseur de données
                      detail: Merci de réessayer dans quelques instants
                      source:
                      meta:
                        provider: France Travail
                  summary: Erreur temporaire du fournisseur de données
                  description: Merci de réessayer dans quelques instants
                erreur_de_certificat_ssl_du_fournisseur_de_donnees_24009:
                  value:
                    errors:
                    - code: '24009'
                      title: Erreur de certificat SSL du fournisseur de données
                      detail: Le certificat SSL du fournisseur de données est invalide
                        ou expiré.
                      source:
                      meta:
                        provider: France Travail
                  summary: Erreur de certificat SSL du fournisseur de données
                  description: Le certificat SSL du fournisseur de données est invalide
                    ou expiré.
              schema:
                "$ref": "#/components/schemas/Error"
        '504':
          description: Erreur d'intermédiaire
          content:
            application/json:
              examples:
                timeout_error:
                  value:
                    errors:
                    - code: '24002'
                      title: Intermédiaire hors-délai
                      detail: Temps d’attente d’une réponse du fournisseur de données
                        écoulé.
                      source:
                      meta:
                        provider: France Travail
                  summary: Intermédiaire hors-délai
                  description: Temps d’attente d’une réponse du fournisseur de données
                    écoulé.
                provider_unavailable_error:
                  value:
                    errors:
                    - code: '24001'
                      title: Service non disponible
                      detail: Service du fournisseur de données temporairement indisponible
                        ou en maintenance.
                      source:
                      meta:
                        provider: France Travail
                  summary: Service non disponible
                  description: Service du fournisseur de données temporairement indisponible
                    ou en maintenance.
                network_error:
                  value:
                    errors:
                    - code: '00501'
                      title: Erreur réseau
                      detail: Problème de connexion au serveur distant. L'erreur peut
                        venir soit du fournisseur, soit de API Entreprise. Il s'agit
                        souvent d'une erreur temporaire.
                      source:
                      meta:
                        retry_in: 10
                  summary: Erreur réseau
                  description: Problème de connexion au serveur distant. L'erreur
                    peut venir soit du fournisseur, soit de API Entreprise. Il s'agit
                    souvent d'une erreur temporaire.
                dns_resolution_error:
                  value:
                    errors:
                    - code: '24004'
                      title: Erreur de résolution DNS
                      detail: Problème de résolution DNS de l'adresse du serveur
                      source:
                      meta:
                        provider: France Travail
                  summary: Erreur de résolution DNS
                  description: Problème de résolution DNS de l'adresse du serveur
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '422':
          description: Paramètre(s) invalide(s)
          content:
            application/json:
              examples:
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/france_travail/statut/identifiant":
    get:
      summary: Statut demandeur d'emploi
      tags:
      - Statut demandeurs d'emploi
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: identifiant
        in: query
        description: Identifiant France Travail choisi par le particulier lors de
          la création de son espace personnel en ligne.
        example: jean.dupont33
        required: true
        schema:
          type: string
      security:
      - jwt_bearer_token: []
      description: |
        Statut demandeur d'emploi, données relatives à l'inscription FranceTravail, ainsi que données d'identité de contact.
        **Paramètres d'appel :** Nom d’utilisateur France Travail choisi par le particulier lors de la création de son espace personnel en ligne
        **Données disponibles en bac à sable :** [liste](https://github.com/datagouv/apistration/blob/develop/mocks/payloads/api_particulier_v2_pole_emploi_statut)
      responses:
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Statut trouvé
          x-operationId: api_particulier_v3_france_travail_statut_with_identifiant
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      identifiant:
                        title: Identifiant France Travail
                        type: string
                        description: |
                          Identifiant du compte utilisateur France Travail, tel qu'il a été renseigné
                          en paramètre d'appel. Cet identifiant est le nom d'utilisateur
                          tel que choisi par le particulier lors de la création de son
                          espace personnel en ligne.
                        example: martin.jacques
                        x-scope: pole_emploi_identifiant
                      identite:
                        title: Données d'identité de l'utilisateur France Travail
                        description: 'Les informations d''identité retournées ici
                          sont issues de l''espace FranceTravail où l''utilisateur
                          les a saisies. Elles sont vérifiées par un agent, à l''aide
                          de la pièce d''identité fournie, et corrigées le cas échéant.
                          Les justificatifs d''identité qui servent à la vérification
                          des données sont listés ici : https://www.service-public.fr/particuliers/vosdroits/F24465'
                        type: object
                        properties:
                          civilite:
                            title: Civilité
                            description: Civilité, Madame ou Monsieur.
                            type: string
                            example: M.
                            enum:
                            - MME
                            - M.
                          nom_naissance:
                            title: Nom de naissance
                            type: string
                            description: Nom de naissance.
                            example: MARTIN
                          nom_usage:
                            title: Nom d'usage
                            type: string
                            description: Nom d'usage.
                            nullable: true
                            example:
                          prenom:
                            title: Prénom
                            type: string
                            example: JACQUES
                            description: Prénom, limité à 13 caractères.
                          sexe:
                            title: Sexe
                            type: string
                            description: Sexe.
                            example: Masculin
                          date_naissance:
                            title: Date de naissance
                            format: date
                            type: string
                            description: Date de naissance au format YYYY-MM-DD.
                            example: '1995-02-02'
                        x-scope: pole_emploi_identite
                        required:
                        - civilite
                        - nom_naissance
                        - nom_usage
                        - prenom
                        - sexe
                        - date_naissance
                      contact:
                        title: Données de contact
                        description: Données de contact de l'utilisateur France Travail
                        type: object
                        properties:
                          telephone:
                            title: Téléphone principal
                            type: string
                            description: Numéro de téléphone principal.
                            example: '0636676767'
                          telephone2:
                            title: Téléphone secondaire
                            type: string
                            description: Numéro de téléphone secondaire.
                            nullable: true
                            example: '1122334455'
                          email:
                            title: E-mail
                            type: string
                            nullable: true
                            description: Adresse e-mail.
                            example: martin.jacques@france.fr
                        x-scope: pole_emploi_contact
                        required:
                        - telephone
                        - telephone2
                        - email
                      adresse:
                        title: Adresse
                        type: object
                        description: Adresse déclarée par le particulier lors de son
                          inscription à France Travail ou suite à une déclaration
                          de changement d’adresse.
                        properties:
                          code_postal:
                            type: string
                            title: Code postal
                            example: '75001'
                          code_cog_insee_commune:
                            title: COG de la commune
                            description: Code officiel géographique (COG) de la commune
                            type: string
                            example: '75101'
                          localite:
                            title: Localité (Code postal et nom de la commune)
                            type: string
                            example: 75001 Paris
                          ligne_voie:
                            title: Voie
                            type: string
                            example: 21 RUE DES MARMOTS
                          ligne_complement_destinataire:
                            title: Complément destinataire
                            type: string
                            nullable: true
                            example: Appartement 42
                          ligne_complement_adresse:
                            title: Complément d'adresse
                            type: string
                            nullable: true
                            example:
                          ligne_complement_distribution:
                            title: Complément distribution
                            type: string
                            nullable: true
                          ligne_nom:
                            title: Nom du destinataire
                            type: string
                            example: MARTIN
                        x-scope: pole_emploi_adresse
                        required:
                        - code_postal
                        - code_cog_insee_commune
                        - localite
                        - ligne_voie
                        - ligne_complement_destinataire
                        - ligne_complement_adresse
                        - ligne_complement_distribution
                        - ligne_nom
                      inscription:
                        title: Inscription FranceTravail
                        description: Données relatives à l'inscription de l'utilisateur
                          à France Travail.
                        type: object
                        properties:
                          date_debut:
                            title: Date d'inscription
                            format: date
                            type: string
                            description: Date d'inscription à France Travail au format
                              YYYY-MM-DD.
                            example: '2021-01-07'
                          date_fin:
                            title: Date de cessation d'inscription
                            description: Date de cessation d'inscription à France
                              Travail au format YYYY-MM-DD.
                            type: string
                            format: date
                            nullable: true
                            example: '2023-03-12'
                          categorie:
                            title: Catégorie d'inscription
                            description: "Catégorie de l'inscription de l'utilisateur
                              à France Travail. La liste des catégories possibles
                              est la suivante : \n  - 1 : PERSONNE SANS EMPLOI DISPONIBLE
                              DUREE INDETERMINEE PLEIN TPS\n  - 2 : PERSONNE SANS
                              EMPLOI DISPONIBLE DUREE INDETERMINEE PARTIEL\n  - 3
                              : PERSONNE SANS EMPLOI DISPONIBLE DUREE DETERMINEE OU
                              SAISON\n  - 4 : PERSONNE SANS EMPLOI NON DISPONIBLE
                              IMMEDIATEMENT\n  - 5 : PERSONNE POURVUE D'UN EMPLOI
                              A LA RECHERCHE D'UN AUTRE\n"
                            type: object
                            properties:
                              code:
                                title: Code
                                description: 'Code de la catégorie d''inscription
                                  du particulier à France Travail.

                                  '
                                type: integer
                                example: 1
                                enum:
                                - 1
                                - 2
                                - 3
                                - 4
                                - 5
                              libelle:
                                title: Libellé
                                description: Libellé de la catégorie d'inscription
                                  du particulier à France Travail.
                                type: string
                                example: PERSONNE SANS EMPLOI DISPONIBLE DUREE INDETERMINEE
                                  PLEIN TPS
                                enum:
                                - PERSONNE SANS EMPLOI DISPONIBLE DUREE INDETERMINEE
                                  PLEIN TPS
                                - PERSONNE SANS EMPLOI DISPONIBLE DUREE INDETERMINEE
                                  PARTIEL
                                - PERSONNE SANS EMPLOI DISPONIBLE DUREE DETERMINEE
                                  OU SAISON
                                - PERSONNE SANS EMPLOI NON DISPONIBLE IMMEDIATEMENT
                                - PERSONNE POURVUE D'UN EMPLOI A LA RECHERCHE D'UN
                                  AUTRE
                            required:
                            - code
                            - libelle
                          code_certification_cnav:
                            title: Code du statut de certification d'identité CNAV
                            type: string
                            description: |
                              France Travail dépend d'un flux de certification d'identité émis par la CNAV, un particulier peut avoir été
                              certifié ou non. La signification des codes est la suivante :
                                - VC IDENTITE CERTIFIEE
                                - IC : IDENTITE ASSIMILEE CERTIFIEE
                                - PC : IDENTITE CERTIFIEE PARTIELLEMENT
                              Sont considérés comme non-certifiés :
                                - AC : ATTENTE TRAITEMENT RETOUR CNAV
                                - DC : DEMANDE CERTIF. ENVOYEE
                                - EC : ECHEC DE CERTIFICATION CNAV
                                - RC : REFUS PROPOSITION DE CERTIFICATION
                                - null : IDENTITE NON CERTIFIEE
                            example: VC
                            enum:
                            - VC
                            - IC
                            - PC
                            - AC
                            - DC
                            - RC
                            -
                        x-scope: pole_emploi_inscription
                        required:
                        - date_debut
                        - date_fin
                        - categorie
                        - code_certification_cnav
                    required:
                    - identifiant
                    - identite
                    - contact
                    - adresse
                    - inscription
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '404':
          description: Non trouvée
          content:
            application/json:
              examples:
                entite_non_trouvee_24003:
                  value:
                    errors:
                    - code: '24003'
                      title: Entité non trouvée
                      detail: Aucune situation France Travail n'a pu être trouvée
                        avec les critères de recherche fournis.
                      source:
                      meta:
                        provider: France Travail
                  summary: Entité non trouvée
                  description: Aucune situation France Travail n'a pu être trouvée
                    avec les critères de recherche fournis.
              schema:
                "$ref": "#/components/schemas/Error"
        '502':
          description: Erreur du fournisseur
          content:
            application/json:
              examples:
                erreur_inconnue_du_fournisseur_de_donnees_24999:
                  value:
                    errors:
                    - code: '24999'
                      title: Erreur inconnue du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et inconnue de notre service. L'équipe technique
                        a été notifiée de cette erreur pour investigation.
                      source:
                      meta:
                        provider: France Travail
                  summary: Erreur inconnue du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et inconnue de notre service. L'équipe technique
                    a été notifiée de cette erreur pour investigation.
                erreur_interne_du_fournisseur_de_donnees_24000:
                  value:
                    errors:
                    - code: '24000'
                      title: Erreur interne du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et a été identifié comme étant une erreur interne.
                        Si le problème persiste, consultez la page de status ou contactez
                        nous sur le support.
                      source:
                      meta:
                        provider: France Travail
                  summary: Erreur interne du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et a été identifié comme étant une erreur interne.
                    Si le problème persiste, consultez la page de status ou contactez
                    nous sur le support.
                erreur_aupres_du_fournisseur_de_donnees_trop_de_requetes_24008:
                  value:
                    errors:
                    - code: '24008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: France Travail
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
                erreur_temporaire_du_fournisseur_de_donnees_24011:
                  value:
                    errors:
                    - code: '24011'
                      title: Erreur temporaire du fournisseur de données
                      detail: Merci de réessayer dans quelques instants
                      source:
                      meta:
                        provider: France Travail
                  summary: Erreur temporaire du fournisseur de données
                  description: Merci de réessayer dans quelques instants
                erreur_de_certificat_ssl_du_fournisseur_de_donnees_24009:
                  value:
                    errors:
                    - code: '24009'
                      title: Erreur de certificat SSL du fournisseur de données
                      detail: Le certificat SSL du fournisseur de données est invalide
                        ou expiré.
                      source:
                      meta:
                        provider: France Travail
                  summary: Erreur de certificat SSL du fournisseur de données
                  description: Le certificat SSL du fournisseur de données est invalide
                    ou expiré.
              schema:
                "$ref": "#/components/schemas/Error"
        '504':
          description: Erreur d'intermédiaire
          content:
            application/json:
              examples:
                timeout_error:
                  value:
                    errors:
                    - code: '24002'
                      title: Intermédiaire hors-délai
                      detail: Temps d’attente d’une réponse du fournisseur de données
                        écoulé.
                      source:
                      meta:
                        provider: France Travail
                  summary: Intermédiaire hors-délai
                  description: Temps d’attente d’une réponse du fournisseur de données
                    écoulé.
                provider_unavailable_error:
                  value:
                    errors:
                    - code: '24001'
                      title: Service non disponible
                      detail: Service du fournisseur de données temporairement indisponible
                        ou en maintenance.
                      source:
                      meta:
                        provider: France Travail
                  summary: Service non disponible
                  description: Service du fournisseur de données temporairement indisponible
                    ou en maintenance.
                network_error:
                  value:
                    errors:
                    - code: '00501'
                      title: Erreur réseau
                      detail: Problème de connexion au serveur distant. L'erreur peut
                        venir soit du fournisseur, soit de API Entreprise. Il s'agit
                        souvent d'une erreur temporaire.
                      source:
                      meta:
                        retry_in: 10
                  summary: Erreur réseau
                  description: Problème de connexion au serveur distant. L'erreur
                    peut venir soit du fournisseur, soit de API Entreprise. Il s'agit
                    souvent d'une erreur temporaire.
                dns_resolution_error:
                  value:
                    errors:
                    - code: '24004'
                      title: Erreur de résolution DNS
                      detail: Problème de résolution DNS de l'adresse du serveur
                      source:
                      meta:
                        provider: France Travail
                  summary: Erreur de résolution DNS
                  description: Problème de résolution DNS de l'adresse du serveur
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '422':
          description: Paramètre(s) invalide(s)
          content:
            application/json:
              examples:
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/gip_mds/service_civique/identite":
    get:
      summary: "[Identité] Statut service civique"
      tags:
      - Statut service civique
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: nomNaissance
        in: query
        description: "**Nom de naissance, également appelé nom de famille**. \n\nLe
          nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le
          livret de famille, etc. Le nom de famille/naissance figure toujours sur
          la pièce d'identité en premier, avant le nom d'usage si le particulier en
          a un. \n\nEn cas de changement de nom de naissance, une mention avec le
          nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler
          l'API, le nom de naissance/famille nécessaire est bien le nom de famille
          modifié."
        example: DURANT
        required: true
        schema:
          type: string
      - name: prenoms[]
        in: query
        schema:
          type: array
          minItems: 1
          maxItems: 3
          items:
            type: string
          example:
          - PIERRE
          - RICHARD
        description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise
          les chances que l'API retrouve le particulier car cela permet de limiter
          le risque d’homonymie."
        required: true
      - name: anneeDateNaissance
        in: query
        description: "**Année de naissance**. \n\nPour un particulier né en France,
          dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance',
          ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance')
          afin de retrouver le code COG de la commune de naissance."
        example: 1990
        required: true
        schema:
          type: integer
      - name: moisDateNaissance
        in: query
        description: "**Mois de naissance**."
        example: 1
        required: true
        schema:
          type: integer
      - name: jourDateNaissance
        in: query
        description: "**Jour de naissance**."
        example: 1
        required: true
        schema:
          type: integer
      security:
      - jwt_bearer_token: []
      description: Informations relatives au contrat de service civique d'un particulier,
        issues des déclarations sociales nominatives (DSN) transmises au GIP-MDS.
        Permet de vérifier si une personne est ou a été engagée dans un service civique
        et d'obtenir les détails du contrat.
      responses:
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Identité trouvée
          headers:
            RateLimit-Limit:
              schema:
                type: integer
              description: La limite concernant l’endpoint appelé, soit le nombre
                de requête/minute.
              example: 50
            RateLimit-Remaining:
              schema:
                type: integer
              description: Le nombre d’appels restants durant la période courante
                d’une minute.
              example: 47
            RateLimit-Reset:
              schema:
                type: integer
              description: La fin de la période courante (en format timestamp)
              example: 1637223155
          x-operationId: api_particulier_v3_gip_mds_service_civique_with_civility
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      statut_actuel:
                        title: Statut actuel
                        description: Informations sur le contrat de service civique
                          en cours. Accessible avec le scope 'service_civique_actuel'.
                        type: object
                        properties:
                          contrat_trouve:
                            title: Contrat en cours trouvé
                            description: Indique si le particulier est actuellement
                              en service civique. Un contrat est considéré en cours
                              en absence de date de fin, ou lorsque le motif de rupture
                              transmis par le GIP-MDS est 99 (contrat non rompu) ou
                              100 (fin de contrat non encore déclarée).
                            type: boolean
                            example: true
                          organisme_accueil:
                            title: Organisme d'accueil
                            description: Informations sur l'administration ou l'association
                              qui accueille le volontaire en service civique.
                            type: object
                            properties:
                              siret:
                                title: SIRET de l'organisme d'accueil
                                description: Numéro SIRET de l'administration ou de
                                  l'association qui accueille le volontaire en service
                                  civique. Null si aucun contrat en cours.
                                type: string
                                example: '13002526500013'
                                nullable: true
                              raison_sociale:
                                title: Raison sociale de l'organisme d'accueil
                                description: Nom officiel de l'administration ou de
                                  l'association qui accueille le volontaire en service
                                  civique. Null si aucun contrat en cours.
                                type: string
                                example: DIRECTION INTERMINISTERIELLE DU NUMERIQUE
                                nullable: true
                            x-scope: gip_mds_service_civique_organisme_accueil
                            required:
                            - siret
                            - raison_sociale
                          date_debut_contrat:
                            title: Date de début du contrat
                            description: Premier jour du contrat de service civique,
                              au format ISO 8601 (AAAA-MM-JJ). Null si aucun contrat
                              en cours.
                            type: string
                            format: date
                            example: '2024-01-15'
                            nullable: true
                            x-scope: gip_mds_service_civique_dates
                          date_fin_contrat:
                            title: Date de fin du contrat
                            description: Date de fin prévue du contrat de service
                              civique, au format ISO 8601 (AAAA-MM-JJ). Null si aucun
                              contrat en cours ou si la date de fin n'est pas encore
                              définie.
                            type: string
                            format: date
                            example: '2024-07-14'
                            nullable: true
                            x-scope: gip_mds_service_civique_dates
                        x-scope: gip_mds_service_civique_statut_actuel
                        required:
                        - contrat_trouve
                        - organisme_accueil
                        - date_debut_contrat
                        - date_fin_contrat
                      statut_passe:
                        title: Statut passé
                        description: Informations sur le contrat de service civique
                          terminé. Accessible avec le scope 'service_civique_passe'.
                        type: object
                        properties:
                          contrat_trouve:
                            title: Contrat passé trouvé
                            description: Indique si le particulier a effectué un service
                              civique par le passé (contrat terminé).
                            type: boolean
                            example: true
                          organisme_accueil:
                            title: Organisme d'accueil
                            description: Informations sur l'administration ou l'association
                              qui a accueilli le volontaire en service civique.
                            type: object
                            properties:
                              siret:
                                title: SIRET de l'organisme d'accueil
                                description: Numéro SIRET de l'administration ou de
                                  l'association qui a accueilli le volontaire en service
                                  civique. Null si aucun contrat passé.
                                type: string
                                example: '13002526500013'
                                nullable: true
                              raison_sociale:
                                title: Raison sociale de l'organisme d'accueil
                                description: Nom officiel de l'administration ou de
                                  l'association qui a accueilli le volontaire en service
                                  civique. Null si aucun contrat passé.
                                type: string
                                example: DIRECTION INTERMINISTERIELLE DU NUMERIQUE
                                nullable: true
                            x-scope: gip_mds_service_civique_organisme_accueil
                            required:
                            - siret
                            - raison_sociale
                          date_debut_contrat:
                            title: Date de début du contrat
                            description: Premier jour du contrat de service civique,
                              au format ISO 8601 (AAAA-MM-JJ). Null si aucun contrat
                              passé.
                            type: string
                            format: date
                            example: '2024-01-15'
                            nullable: true
                            x-scope: gip_mds_service_civique_dates
                          date_fin_contrat:
                            title: Date de fin du contrat
                            description: Dernier jour du contrat de service civique,
                              au format ISO 8601 (AAAA-MM-JJ). Null si aucun contrat
                              passé.
                            type: string
                            format: date
                            example: '2024-07-14'
                            nullable: true
                            x-scope: gip_mds_service_civique_dates
                        x-scope: gip_mds_service_civique_statut_passe
                        required:
                        - contrat_trouve
                        - organisme_accueil
                        - date_debut_contrat
                        - date_fin_contrat
                    required:
                    - statut_actuel
                    - statut_passe
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '404':
          description: Non trouvée
          content:
            application/json:
              examples:
                entite_non_trouvee_31003:
                  value:
                    errors:
                    - code: '31003'
                      title: Entité non trouvée
                      detail: Le ou les paramètre(s) d'entrée n'existent pas, ne sont
                        pas connus, ou ne comportent aucune information pour cet appel.
                        Veuillez vérifier que votre recherche est couverte par le
                        périmètre de l'API.
                      source:
                      meta:
                        provider: GIP-MDS
                  summary: Entité non trouvée
                  description: Le ou les paramètre(s) d'entrée n'existent pas, ne
                    sont pas connus, ou ne comportent aucune information pour cet
                    appel. Veuillez vérifier que votre recherche est couverte par
                    le périmètre de l'API.
              schema:
                "$ref": "#/components/schemas/Error"
        '422':
          description: Entité non traitable
          content:
            application/json:
              examples:
                entite_non_traitable_00391:
                  value:
                    errors:
                    - code: '00391'
                      title: Entité non traitable
                      detail: Les paramètres d'identité correspondent à plusieurs
                        personnes. Nous ne pouvons pas fournir les informations de
                        service civique pour cet individu.
                      source:
                      meta: {}
                  summary: Entité non traitable
                  description: Les paramètres d'identité correspondent à plusieurs
                    personnes. Nous ne pouvons pas fournir les informations de service
                    civique pour cet individu.
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '502':
          description: Erreur du fournisseur
          content:
            application/json:
              examples:
                erreur_inconnue_du_fournisseur_de_donnees_31999:
                  value:
                    errors:
                    - code: '31999'
                      title: Erreur inconnue du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et inconnue de notre service. L'équipe technique
                        a été notifiée de cette erreur pour investigation.
                      source:
                      meta:
                        provider: GIP-MDS
                  summary: Erreur inconnue du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et inconnue de notre service. L'équipe technique
                    a été notifiée de cette erreur pour investigation.
                erreur_interne_du_fournisseur_de_donnees_31000:
                  value:
                    errors:
                    - code: '31000'
                      title: Erreur interne du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et a été identifié comme étant une erreur interne.
                        Si le problème persiste, consultez la page de status ou contactez
                        nous sur le support.
                      source:
                      meta:
                        provider: GIP-MDS
                  summary: Erreur interne du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et a été identifié comme étant une erreur interne.
                    Si le problème persiste, consultez la page de status ou contactez
                    nous sur le support.
                erreur_aupres_du_fournisseur_de_donnees_trop_de_requetes_31008:
                  value:
                    errors:
                    - code: '31008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: GIP-MDS
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
                erreur_temporaire_du_fournisseur_de_donnees_31011:
                  value:
                    errors:
                    - code: '31011'
                      title: Erreur temporaire du fournisseur de données
                      detail: Merci de réessayer dans quelques instants
                      source:
                      meta:
                        provider: GIP-MDS
                  summary: Erreur temporaire du fournisseur de données
                  description: Merci de réessayer dans quelques instants
                erreur_de_certificat_ssl_du_fournisseur_de_donnees_31009:
                  value:
                    errors:
                    - code: '31009'
                      title: Erreur de certificat SSL du fournisseur de données
                      detail: Le certificat SSL du fournisseur de données est invalide
                        ou expiré.
                      source:
                      meta:
                        provider: GIP-MDS
                  summary: Erreur de certificat SSL du fournisseur de données
                  description: Le certificat SSL du fournisseur de données est invalide
                    ou expiré.
              schema:
                "$ref": "#/components/schemas/Error"
        '504':
          description: Erreur d'intermédiaire
          content:
            application/json:
              examples:
                timeout_error:
                  value:
                    errors:
                    - code: '31002'
                      title: Intermédiaire hors-délai
                      detail: Temps d’attente d’une réponse du fournisseur de données
                        écoulé.
                      source:
                      meta:
                        provider: GIP-MDS
                  summary: Intermédiaire hors-délai
                  description: Temps d’attente d’une réponse du fournisseur de données
                    écoulé.
                provider_unavailable_error:
                  value:
                    errors:
                    - code: '31001'
                      title: Service non disponible
                      detail: Service du fournisseur de données temporairement indisponible
                        ou en maintenance.
                      source:
                      meta:
                        provider: GIP-MDS
                  summary: Service non disponible
                  description: Service du fournisseur de données temporairement indisponible
                    ou en maintenance.
                network_error:
                  value:
                    errors:
                    - code: '00501'
                      title: Erreur réseau
                      detail: Problème de connexion au serveur distant. L'erreur peut
                        venir soit du fournisseur, soit de API Entreprise. Il s'agit
                        souvent d'une erreur temporaire.
                      source:
                      meta:
                        retry_in: 10
                  summary: Erreur réseau
                  description: Problème de connexion au serveur distant. L'erreur
                    peut venir soit du fournisseur, soit de API Entreprise. Il s'agit
                    souvent d'une erreur temporaire.
                dns_resolution_error:
                  value:
                    errors:
                    - code: '31004'
                      title: Erreur de résolution DNS
                      detail: Problème de résolution DNS de l'adresse du serveur
                      source:
                      meta:
                        provider: GIP-MDS
                  summary: Erreur de résolution DNS
                  description: Problème de résolution DNS de l'adresse du serveur
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/gip_mds/service_civique/france_connect":
    get:
      summary: "[FranceConnect] Statut service civique"
      tags:
      - Statut service civique
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      security:
      - jwt_bearer_token: []
      description: Informations relatives au contrat de service civique d'un particulier,
        issues des déclarations sociales nominatives (DSN) transmises au GIP-MDS.
        Permet de vérifier si une personne est ou a été engagée dans un service civique
        et d'obtenir les détails du contrat.
      responses:
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                missing_france_connect_access_token_error:
                  value:
                    errors:
                    - code: '50004'
                      title: Accès non autorisé
                      detail: 'Le jeton d''accès FranceConnect est manquant. Cet endpoint
                        requiert un jeton d''accès FranceConnect transmis via l''en-tête
                        Authorization: Bearer.'
                      source:
                      meta: {}
                  summary: Accès non autorisé
                  description: 'Le jeton d''accès FranceConnect est manquant. Cet
                    endpoint requiert un jeton d''accès FranceConnect transmis via
                    l''en-tête Authorization: Bearer.'
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Identité trouvée
          headers:
            RateLimit-Limit:
              schema:
                type: integer
              description: La limite concernant l’endpoint appelé, soit le nombre
                de requête/minute.
              example: 50
            RateLimit-Remaining:
              schema:
                type: integer
              description: Le nombre d’appels restants durant la période courante
                d’une minute.
              example: 47
            RateLimit-Reset:
              schema:
                type: integer
              description: La fin de la période courante (en format timestamp)
              example: 1637223155
          x-operationId: api_particulier_v3_gip_mds_service_civique_with_france_connect
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      statut_actuel:
                        title: Statut actuel
                        description: Informations sur le contrat de service civique
                          en cours. Accessible avec le scope 'service_civique_actuel'.
                        type: object
                        properties:
                          contrat_trouve:
                            title: Contrat en cours trouvé
                            description: Indique si le particulier est actuellement
                              en service civique. Un contrat est considéré en cours
                              en absence de date de fin, ou lorsque le motif de rupture
                              transmis par le GIP-MDS est 99 (contrat non rompu) ou
                              100 (fin de contrat non encore déclarée).
                            type: boolean
                            example: true
                          organisme_accueil:
                            title: Organisme d'accueil
                            description: Informations sur l'administration ou l'association
                              qui accueille le volontaire en service civique.
                            type: object
                            properties:
                              siret:
                                title: SIRET de l'organisme d'accueil
                                description: Numéro SIRET de l'administration ou de
                                  l'association qui accueille le volontaire en service
                                  civique. Null si aucun contrat en cours.
                                type: string
                                example: '13002526500013'
                                nullable: true
                              raison_sociale:
                                title: Raison sociale de l'organisme d'accueil
                                description: Nom officiel de l'administration ou de
                                  l'association qui accueille le volontaire en service
                                  civique. Null si aucun contrat en cours.
                                type: string
                                example: DIRECTION INTERMINISTERIELLE DU NUMERIQUE
                                nullable: true
                            x-scope: gip_mds_service_civique_organisme_accueil
                            required:
                            - siret
                            - raison_sociale
                          date_debut_contrat:
                            title: Date de début du contrat
                            description: Premier jour du contrat de service civique,
                              au format ISO 8601 (AAAA-MM-JJ). Null si aucun contrat
                              en cours.
                            type: string
                            format: date
                            example: '2024-01-15'
                            nullable: true
                            x-scope: gip_mds_service_civique_dates
                          date_fin_contrat:
                            title: Date de fin du contrat
                            description: Date de fin prévue du contrat de service
                              civique, au format ISO 8601 (AAAA-MM-JJ). Null si aucun
                              contrat en cours ou si la date de fin n'est pas encore
                              définie.
                            type: string
                            format: date
                            example: '2024-07-14'
                            nullable: true
                            x-scope: gip_mds_service_civique_dates
                        x-scope: gip_mds_service_civique_statut_actuel
                        required:
                        - contrat_trouve
                        - organisme_accueil
                        - date_debut_contrat
                        - date_fin_contrat
                      statut_passe:
                        title: Statut passé
                        description: Informations sur le contrat de service civique
                          terminé. Accessible avec le scope 'service_civique_passe'.
                        type: object
                        properties:
                          contrat_trouve:
                            title: Contrat passé trouvé
                            description: Indique si le particulier a effectué un service
                              civique par le passé (contrat terminé).
                            type: boolean
                            example: true
                          organisme_accueil:
                            title: Organisme d'accueil
                            description: Informations sur l'administration ou l'association
                              qui a accueilli le volontaire en service civique.
                            type: object
                            properties:
                              siret:
                                title: SIRET de l'organisme d'accueil
                                description: Numéro SIRET de l'administration ou de
                                  l'association qui a accueilli le volontaire en service
                                  civique. Null si aucun contrat passé.
                                type: string
                                example: '13002526500013'
                                nullable: true
                              raison_sociale:
                                title: Raison sociale de l'organisme d'accueil
                                description: Nom officiel de l'administration ou de
                                  l'association qui a accueilli le volontaire en service
                                  civique. Null si aucun contrat passé.
                                type: string
                                example: DIRECTION INTERMINISTERIELLE DU NUMERIQUE
                                nullable: true
                            x-scope: gip_mds_service_civique_organisme_accueil
                            required:
                            - siret
                            - raison_sociale
                          date_debut_contrat:
                            title: Date de début du contrat
                            description: Premier jour du contrat de service civique,
                              au format ISO 8601 (AAAA-MM-JJ). Null si aucun contrat
                              passé.
                            type: string
                            format: date
                            example: '2024-01-15'
                            nullable: true
                            x-scope: gip_mds_service_civique_dates
                          date_fin_contrat:
                            title: Date de fin du contrat
                            description: Dernier jour du contrat de service civique,
                              au format ISO 8601 (AAAA-MM-JJ). Null si aucun contrat
                              passé.
                            type: string
                            format: date
                            example: '2024-07-14'
                            nullable: true
                            x-scope: gip_mds_service_civique_dates
                        x-scope: gip_mds_service_civique_statut_passe
                        required:
                        - contrat_trouve
                        - organisme_accueil
                        - date_debut_contrat
                        - date_fin_contrat
                    required:
                    - statut_actuel
                    - statut_passe
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '404':
          description: Non trouvée
          content:
            application/json:
              examples:
                entite_non_trouvee_31003:
                  value:
                    errors:
                    - code: '31003'
                      title: Entité non trouvée
                      detail: Le ou les paramètre(s) d'entrée n'existent pas, ne sont
                        pas connus, ou ne comportent aucune information pour cet appel.
                        Veuillez vérifier que votre recherche est couverte par le
                        périmètre de l'API.
                      source:
                      meta:
                        provider: GIP-MDS
                  summary: Entité non trouvée
                  description: Le ou les paramètre(s) d'entrée n'existent pas, ne
                    sont pas connus, ou ne comportent aucune information pour cet
                    appel. Veuillez vérifier que votre recherche est couverte par
                    le périmètre de l'API.
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '422':
          description: Paramètre(s) invalide(s)
          content:
            application/json:
              examples:
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
        '502':
          description: Erreur du fournisseur
          content:
            application/json:
              examples:
                provider_unknown_error:
                  value:
                    errors:
                    - code: '31999'
                      title: Erreur inconnue du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et inconnue de notre service. L'équipe technique
                        a été notifiée de cette erreur pour investigation.
                      source:
                      meta:
                        provider: GIP-MDS
                  summary: Erreur inconnue du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et inconnue de notre service. L'équipe technique
                    a été notifiée de cette erreur pour investigation.
              schema:
                "$ref": "#/components/schemas/Error"
        '504':
          description: Erreur d'intermédiaire
          content:
            application/json:
              examples:
                timeout_error:
                  value:
                    errors:
                    - code: '31002'
                      title: Intermédiaire hors-délai
                      detail: Temps d’attente d’une réponse du fournisseur de données
                        écoulé.
                      source:
                      meta:
                        provider: GIP-MDS
                  summary: Intermédiaire hors-délai
                  description: Temps d’attente d’une réponse du fournisseur de données
                    écoulé.
                provider_unavailable_error:
                  value:
                    errors:
                    - code: '31001'
                      title: Service non disponible
                      detail: Service du fournisseur de données temporairement indisponible
                        ou en maintenance.
                      source:
                      meta:
                        provider: GIP-MDS
                  summary: Service non disponible
                  description: Service du fournisseur de données temporairement indisponible
                    ou en maintenance.
                network_error:
                  value:
                    errors:
                    - code: '00501'
                      title: Erreur réseau
                      detail: Problème de connexion au serveur distant. L'erreur peut
                        venir soit du fournisseur, soit de API Entreprise. Il s'agit
                        souvent d'une erreur temporaire.
                      source:
                      meta:
                        retry_in: 10
                  summary: Erreur réseau
                  description: Problème de connexion au serveur distant. L'erreur
                    peut venir soit du fournisseur, soit de API Entreprise. Il s'agit
                    souvent d'une erreur temporaire.
                dns_resolution_error:
                  value:
                    errors:
                    - code: '31004'
                      title: Erreur de résolution DNS
                      detail: Problème de résolution DNS de l'adresse du serveur
                      source:
                      meta:
                        provider: GIP-MDS
                  summary: Erreur de résolution DNS
                  description: Problème de résolution DNS de l'adresse du serveur
              schema:
                "$ref": "#/components/schemas/Error"
  "/v5/men/scolarites/identite":
    get:
      summary: Statut élève scolarisé et boursier
      tags:
      - Statut élève scolarisé
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: nomNaissance
        in: query
        description: "**Nom de naissance, également appelé nom de famille**. \n\nLe
          nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le
          livret de famille, etc. Le nom de famille/naissance figure toujours sur
          la pièce d'identité en premier, avant le nom d'usage si le particulier en
          a un. \n\nEn cas de changement de nom de naissance, une mention avec le
          nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler
          l'API, le nom de naissance/famille nécessaire est bien le nom de famille
          modifié."
        example: DURANT
        required: true
        schema:
          type: string
      - name: prenoms[]
        in: query
        schema:
          type: array
          minItems: 1
          maxItems: 3
          items:
            type: string
          example:
          - PIERRE
          - RICHARD
        description: "**Liste des prénoms**. \n\nFournir plusieurs prénoms maximise
          les chances que l'API retrouve le particulier car cela permet de limiter
          le risque d’homonymie."
        required: true
      - name: sexeEtatCivil
        in: query
        schema:
          type: string
          enum:
          - M
          - F
        description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**,
          comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité
          des cas, il s'agit également de la mention indiquée sur la pièce d'identité
          et le passeport. Cette mention peut être masculin ('M') ou féminin ('F').
          \nDans le cas d'un particulier ayant demandé une modification de sa mention
          de sexe à l'état civil, le changement est indiqué en marge de l'acte de
          naissance une fois la décision rendue. Le changement intervient sur les
          titres d'identité seulement si le particulier en demande le renouvellement."
        example: M
        required: true
      - name: anneeDateNaissance
        in: query
        description: "**Année de naissance**. \n\nPour un particulier né en France,
          dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance',
          ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance')
          afin de retrouver le code COG de la commune de naissance."
        example: 1990
        required: true
        schema:
          type: integer
      - name: moisDateNaissance
        in: query
        description: "**Mois de naissance**."
        example: 1
        required: true
        schema:
          type: integer
      - name: jourDateNaissance
        in: query
        description: "**Jour de naissance**."
        example: 1
        required: true
        schema:
          type: integer
      - name: codeEtablissement
        in: query
        description: |
          Code d'unité administrative immatriculée (code UAI) de l'établissement où est scolarisé l'élève. Ce code unique inscrit au répertoire national des établissements est composé de 7 chiffres et d'une lettre ; les trois premiers chiffres correspondent au numéro de département de l'établissement.

          Pour retrouver facilement le code UAI d'un établissement à partir d'informations plus facilement connues des usagers (commune, code postal, etc.), vous pouvez utiliser l'[API "Annuaire de l'éducation nationale"](https://api.gouv.fr/les-api/api-annuaire-education).

          ⚠️ L'établissement 0861288H (CNED Direction générale) n'existe pas dans l'API annuaire de l'éducation nationale, il faudra donc compléter la liste des établissements avec une ligne CNED à laquelle sera associée le code UAI qui sera en passé en entrée.
        example: 0210015C
        required: false
        schema:
          type: string
      - name: anneeScolaire
        in: query
        description: 'Année scolaire recherchée au format AAAA-AAAA ou AAAA. Les informations
          connues par l''API concerne surtout l''année en cours et parfois l''année
          scolaire à venir. Pour en savoir plus consulter la fiche métier : https://particulier.api.gouv.fr/catalogue/education_nationale/statut_eleve_scolarise#faq_entry_answer_0_api_particulier_endpoint_education_nationale_statut_eleve_scolarise.'
        example: 2022-2023
        required: true
        schema:
          type: string
      - name: degreEtablissement
        in: query
        description: 'Degré de l''établissement scolaire : 1D pour le premier degré
          (écoles maternelles et élémentaires) ou 2D pour le second degré (collèges
          et lycées).'
        example: 2D
        required: false
        schema:
          type: string
      - name: codesBcnDepartements[]
        in: query
        schema:
          type: array
          items:
            type: string
        description: |
          Liste des codes BCN des départements du périmètre de recherche. Exactement un type de périmètre doit être fourni.

          Référentiel : [N_DEPARTEMENT](https://bcn.depp.education.fr/bcn/workspace/viewTable/n/N_DEPARTEMENT)
        example:
        - '075'
        required: false
      - name: codesBcnRegions[]
        in: query
        schema:
          type: array
          items:
            type: string
        description: |
          Liste des codes BCN des régions académiques du périmètre de recherche. Exactement un type de périmètre doit être fourni.

          Référentiel : [N_REGION_ACADEMIQUE](https://bcn.depp.education.fr/bcn/workspace/viewTable/n/N_REGION_ACADEMIQUE)
        example:
        - '10'
        required: false
      security:
      - jwt_bearer_token: []
      description: Statut scolarisé d'un élève du primaire, collège ou lycée et statut
        boursier.
      responses:
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Scolarite trouvee par perimetre
          x-operationId: api_particulier_v5_men_scolarites_with_civility
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      regime_pensionnat:
                        title: Régime de pensionnat
                        description: |
                          Indique le régime de pensionnat de l'élève dans l'établissement. Ce champ est à "null" lorsque l'information n'est pas disponible. Les valeurs possibles sont :

                          - 0 : Externe libre
                          - 1 : Externe surveillé
                          - 2 : Demi-pensionnaire dans l'établissement
                          - 3 : Interne dans l'établissement
                          - 4 : Interne externé
                          - 5 : Interne hébergé
                          - 6 : Demi-pensionnaire hors l'établissement
                        type: object
                        nullable: true
                        properties:
                          code:
                            title: Code
                            description: Code du régime de pensionnat de l'élève sur
                              1 caractère, selon la nomenclature BCN.
                            type: string
                            example: '0'
                            enum:
                            - '0'
                            - '1'
                            - '2'
                            - '3'
                            - '4'
                            - '5'
                            - '6'
                          libelle:
                            title: Libellé
                            description: Libellé du régime de pensionnat de l'élève.
                            type: string
                            example: Externe libre
                            nullable: true
                        x-scope: men_regime_pensionnat
                        required:
                        - code
                        - libelle
                      identite:
                        title: Données d'identité de l'élève
                        description: Les informations d'identité retournées ici sont
                          issues de la base de données des établissemets scolaires
                          (API SIGNE) où les élèves sont inscrits et proviennent des
                          pièces d'identité que les parents doivent fournir à l'établissement
                          pour inscrire leur enfant.
                        type: object
                        properties:
                          nom:
                            title: Nom
                            description: Nom de l'élève.
                            type: string
                            example: Martin
                          prenom:
                            title: Prénom
                            description: Prénom de l'élève.
                            type: string
                            example: Justine
                          sexe:
                            title: Sexe
                            description: Sexe de l'élève, masculin ou féminin.
                            type: string
                            example: F
                            enum:
                            - M
                            - F
                          date_naissance:
                            title: Date de naissance
                            description: Date de naissance de l'élève au format AAAA-MM-JJ
                            type: string
                            example: '2000-01-20'
                        x-scope: men_statut_identite
                        required:
                        - nom
                        - prenom
                        - sexe
                        - date_naissance
                      module_elementaire_formation:
                        title: Module élémentaire de formation (MEF)
                        description: Libellé et code du module élémentaire de formation
                          (MEF)
                        type: object
                        properties:
                          code_mef_stat:
                            title: Code MEF
                            description: Code Mef Stat 11, selon la BCN
                            type: string
                            example: '211324099991'
                            nullable: true
                          libelle:
                            title: Libéllé long, selon la BCN
                            description: Libellé long, selon la BCN
                            type: string
                            example: 1CAP1 STAFFEUR ORNEMANISTE
                            nullable: true
                        x-scope: men_statut_module_elementaire_formation
                        required:
                        - code_mef_stat
                        - libelle
                      etablissement:
                        title: Établissement d'études
                        description: Les informations relatives à l'établissement
                        type: object
                        properties:
                          code_uai:
                            title: Code UAI de l'établissement
                            description: |
                              Code d'unité administrative immatriculée (code UAI) de l'établissement où est scolarisé l'élève. Ce code unique inscrit au répertoire national des établissements est composé de 7 chiffres et d'une lettre ; les trois premiers chiffres correspondent au numéro de département de l'établissement.

                              Pour retrouver le nom de l'établissement, vous pouvez utiliser l'[API "Annuaire de l'éducation nationale"](https://api.gouv.fr/les-api/api-annuaire-education) ou le site https://annuaire-education.fr.
                            type: string
                            pattern: "^\\d{7}\\w$"
                            example: 0210015C
                          code_ministere_tutelle:
                            title: Code de l'établissement auprès du ministère de
                              tutelle
                            description: Code ministère de tutelle principale composé
                              de 2 chiffres, selon la BCN
                            type: string
                            example: '06'
                            nullable: true
                        x-scope: men_statut_etablissement
                        required:
                        - code_uai
                        - code_ministere_tutelle
                      annee_scolaire:
                        title: Année scolaire
                        description: Année scolaire de l'élève au format AAAA-AAAA.
                        type: string
                        pattern: "^\\d{4}$|^\\d{4}-\\d{4}$"
                        example: 2022-2023
                        x-scope: men_statut_scolarite
                      est_scolarise:
                        title: Est scolarisé
                        description: Indique si l'élève est scolarisé dans un établissement.
                        type: boolean
                        example: true
                        x-scope: men_statut_scolarite
                      statut_eleve:
                        title: Statut de l'élève
                        description: |
                          Indique le statut sous lequel l'élève est scolarisé dans l'établissement. Les valeurs sont susceptibles d'évoluer :

                          - ST : Scolaire, il s'agit du statut de base renvoyé pour près de 95% des élèves.
                          - AP : Apprenti
                          - CQ : Contrat de qualification
                          - FC : Formation continue
                          - ED : Enseignement à distance
                          - IN : Candidat individuel
                          - FQ : Stagiaire de la formation Professionnelle
                          - SC : Scolaire ou formation initiale
                          - CP : Contrat de professionnalisation.
                          - NC : Non connu ou non communiqué.
                        type: object
                        properties:
                          code:
                            title: Code
                            description: Code du statut sous lequel l'élève est scolarisé
                              dans l'établissement.
                            type: string
                            example: ST
                          libelle:
                            title: Libellé
                            description: Libellé du statut sous lequel l'élève est
                              scolarisé dans l'établissement.
                            type: string
                            example: SCOLAIRE
                        x-scope: men_statut_scolarite
                        required:
                        - code
                        - libelle
                      est_boursier:
                        description: |
                          Indique si l'élève est boursier dans l'établissement. Les bourses concernent uniquement les élèves des collèges et lycées.

                          ⚠️ Si le statut boursier est à "false" avant mi-octobre, cela ne signifie pas forcément que l'élève n'est pas boursier. Il peut s'agir d'un faux négatif lié à une absence de l'information en base. Pour en savoir plus consulter la fiche métier : https://particulier.api.gouv.fr/catalogue/education_nationale/statut_eleve_scolarise#faq_entry_answer_1_api_particulier_endpoint_education_nationale_statut_eleve_scolarise.

                          Ce champs prend la valeur null lorsque l'on ne sait pas si l'élève est boursier ou non
                        type: boolean
                        example: true
                        nullable: false
                        x-scope: men_statut_boursier
                      echelon_bourse:
                        description: |
                          Indique l'échelon de la bourse de l'élève. Est à "null" quand "est_boursier" est "false". Les bourses concernent uniquement les élèves des collèges et lycées.

                          Il existe trois échelons de bourses pour les collégiens (1 à 3) et six échelons pour les lycéens (1 à 6), correspondant aux montants reçus par l'élève pour l'année scolaire. Pour en savoir plus, consulter la FAQ : https://particulier.api.gouv.fr/catalogue/education_nationale/statut_eleve_scolarise#faq_entry_answer_2_api_particulier_endpoint_education_nationale_statut_eleve_scolarise"
                        type: integer
                        example: 1
                        nullable: true
                        enum:
                        -
                        - 1
                        - 2
                        - 3
                        - 4
                        - 5
                        - 6
                        x-scope: men_echelon_bourse
                    required:
                    - regime_pensionnat
                    - identite
                    - module_elementaire_formation
                    - etablissement
                    - annee_scolaire
                    - est_scolarise
                    - statut_eleve
                    - est_boursier
                    - echelon_bourse
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '404':
          description: Non trouvee par perimetre
          content:
            application/json:
              examples:
                entite_non_trouvee_30003:
                  value:
                    errors:
                    - code: '30003'
                      title: Entité non trouvée
                      detail: Aucun eleve n'a pu etre trouve avec les criteres de
                        recherche fournis
                      source:
                      meta:
                        provider: MEN
                  summary: Entité non trouvée
                  description: Aucun eleve n'a pu etre trouve avec les criteres de
                    recherche fournis
              schema:
                "$ref": "#/components/schemas/Error"
        '422':
          description: Paramètre(s) invalide(s)
          content:
            application/json:
              examples:
                unprocessable_content_error_code_etablissement_et_perimetre_error:
                  value:
                    errors:
                    - code: '00419'
                      title: Entité non traitable
                      detail: Les paramètres codeEtablissement et périmètre (codesBcnRegions/codesBcnDepartements)
                        sont mutuellement exclusifs
                      source:
                      meta: {}
                  summary: Entité non traitable
                  description: Les paramètres codeEtablissement et périmètre (codesBcnRegions/codesBcnDepartements)
                    sont mutuellement exclusifs
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '502':
          description: Erreur du fournisseur
          content:
            application/json:
              examples:
                erreur_inconnue_du_fournisseur_de_donnees_30999:
                  value:
                    errors:
                    - code: '30999'
                      title: Erreur inconnue du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et inconnue de notre service. L'équipe technique
                        a été notifiée de cette erreur pour investigation.
                      source:
                      meta:
                        provider: MEN
                  summary: Erreur inconnue du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et inconnue de notre service. L'équipe technique
                    a été notifiée de cette erreur pour investigation.
                erreur_interne_du_fournisseur_de_donnees_30000:
                  value:
                    errors:
                    - code: '30000'
                      title: Erreur interne du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et a été identifié comme étant une erreur interne.
                        Si le problème persiste, consultez la page de status ou contactez
                        nous sur le support.
                      source:
                      meta:
                        provider: MEN
                  summary: Erreur interne du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et a été identifié comme étant une erreur interne.
                    Si le problème persiste, consultez la page de status ou contactez
                    nous sur le support.
                erreur_aupres_du_fournisseur_de_donnees_trop_de_requetes_30008:
                  value:
                    errors:
                    - code: '30008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: MEN
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
                erreur_temporaire_du_fournisseur_de_donnees_30011:
                  value:
                    errors:
                    - code: '30011'
                      title: Erreur temporaire du fournisseur de données
                      detail: Merci de réessayer dans quelques instants
                      source:
                      meta:
                        provider: MEN
                  summary: Erreur temporaire du fournisseur de données
                  description: Merci de réessayer dans quelques instants
                erreur_de_certificat_ssl_du_fournisseur_de_donnees_30009:
                  value:
                    errors:
                    - code: '30009'
                      title: Erreur de certificat SSL du fournisseur de données
                      detail: Le certificat SSL du fournisseur de données est invalide
                        ou expiré.
                      source:
                      meta:
                        provider: MEN
                  summary: Erreur de certificat SSL du fournisseur de données
                  description: Le certificat SSL du fournisseur de données est invalide
                    ou expiré.
              schema:
                "$ref": "#/components/schemas/Error"
        '504':
          description: Erreur d'intermédiaire
          content:
            application/json:
              examples:
                timeout_error:
                  value:
                    errors:
                    - code: '30002'
                      title: Intermédiaire hors-délai
                      detail: Temps d’attente d’une réponse du fournisseur de données
                        écoulé.
                      source:
                      meta:
                        provider: MEN
                  summary: Intermédiaire hors-délai
                  description: Temps d’attente d’une réponse du fournisseur de données
                    écoulé.
                provider_unavailable_error:
                  value:
                    errors:
                    - code: '30001'
                      title: Service non disponible
                      detail: Service du fournisseur de données temporairement indisponible
                        ou en maintenance.
                      source:
                      meta:
                        provider: MEN
                  summary: Service non disponible
                  description: Service du fournisseur de données temporairement indisponible
                    ou en maintenance.
                network_error:
                  value:
                    errors:
                    - code: '00501'
                      title: Erreur réseau
                      detail: Problème de connexion au serveur distant. L'erreur peut
                        venir soit du fournisseur, soit de API Entreprise. Il s'agit
                        souvent d'une erreur temporaire.
                      source:
                      meta:
                        retry_in: 10
                  summary: Erreur réseau
                  description: Problème de connexion au serveur distant. L'erreur
                    peut venir soit du fournisseur, soit de API Entreprise. Il s'agit
                    souvent d'une erreur temporaire.
                dns_resolution_error:
                  value:
                    errors:
                    - code: '30004'
                      title: Erreur de résolution DNS
                      detail: Problème de résolution DNS de l'adresse du serveur
                      source:
                      meta:
                        provider: MEN
                  summary: Erreur de résolution DNS
                  description: Problème de résolution DNS de l'adresse du serveur
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/mesri/statut_etudiant/identite":
    get:
      summary: "[Identité] Statut étudiant"
      tags:
      - Statut étudiant
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: nomNaissance
        in: query
        description: "**Nom de naissance, également appelé nom de famille**. \n\nLe
          nom de naissance est indiqué sur l'acte de naissance, de mariage, sur le
          livret de famille, etc. Le nom de famille/naissance figure toujours sur
          la pièce d'identité en premier, avant le nom d'usage si le particulier en
          a un. \n\nEn cas de changement de nom de naissance, une mention avec le
          nouveau nom de famille est inscrite sur l'acte de naissance. Pour appeler
          l'API, le nom de naissance/famille nécessaire est bien le nom de famille
          modifié."
        example: DURANT
        required: true
        schema:
          type: string
      - name: prenoms[]
        in: query
        schema:
          type: array
          minItems: 1
          maxItems: 1
          items:
            type: string
          example:
          - PIERRE
          - RICHARD
        description: "**Liste des prénoms**. \n\nDans le cadre de cette API, il n'est
          possible de fournir qu'un seul prenom."
        required: true
      - name: anneeDateNaissance
        in: query
        description: "**Année de naissance**. \n\nPour un particulier né en France,
          dans le cadre d'un appel à l'API avec l'utilisation du paramètre 'nomCommuneNaissance',
          ce paramètre est obligatoire (ainsi que le paramètre 'codeCogInseeDepartementNaissance')
          afin de retrouver le code COG de la commune de naissance."
        example: 1990
        required: true
        schema:
          type: integer
      - name: moisDateNaissance
        in: query
        description: "**Mois de naissance**."
        example: 1
        required: true
        schema:
          type: integer
      - name: jourDateNaissance
        in: query
        description: "**Jour de naissance**."
        example: 1
        required: true
        schema:
          type: integer
      - name: sexeEtatCivil
        in: query
        schema:
          type: string
          enum:
          - M
          - F
        description: "**Sexe de la personne tel qu'indiqué sur les actes d'état civil**,
          comme par exemple l'acte de naissance ou de mariage. \n\nDans la majorité
          des cas, il s'agit également de la mention indiquée sur la pièce d'identité
          et le passeport. Cette mention peut être masculin ('M') ou féminin ('F').
          \nDans le cas d'un particulier ayant demandé une modification de sa mention
          de sexe à l'état civil, le changement est indiqué en marge de l'acte de
          naissance une fois la décision rendue. Le changement intervient sur les
          titres d'identité seulement si le particulier en demande le renouvellement."
        example: M
        required: true
      - name: codeCogInseeCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 5
          maxLength: 5
          example: '08480'
        description: "**Code Insee à 5 chiffres de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation de la seconde option
          (triplet 'nomCommuneNaissance', 'anneeDateNaissance', 'codeInseeDepartementNaissance').\n\nNe
          pas remplir si la personne est née à l'étranger."
        required: false
      - name: nomCommuneNaissance
        in: query
        schema:
          type: string
          minLength: 1
          example: Gennevilliers
        description: "**Nom en toute lettre de la commune de naissance**. \n\nPour
          retrouver un particulier né en France, il est nécessaire d'indiquer sa commune
          de naissance. Ce paramètre est une des deux options disponibles pour renseigner
          la commune de naissance. En l'absence de l'utilisation du 'codeCogInseeCommuneNaissance',
          ce paramètre est obligatoire si la personne est née en France ; il doit
          être obligatoirement accompagné des paramètres 'codeCogInseeDepartementNaissance'
          et 'anneeDateNaissance'.\n\nNe pas remplir si la personne est née à l'étranger."
        required: false
      - name: codeCogInseeDepartementNaissance
        in: query
        schema:
          type: string
          minLength: 2
          maxLength: 3
          example: '92'
        description: "**Code INSEE du département de naissance**. \n\nPour retrouver
          un particulier né en France, il est nécessaire d'indiquer sa commune de
          naissance. Ce paramètre fait partie d'une des deux options disponibles pour
          renseigner la commune de naissance. Lorsque le paramètre 'nomCommuneNaissance'
          est utilisé, ce paramètre est obligatoire si la personne est née en France
          et permet de retrouver le code COG avec le paramètre 'anneeDateNaissance'.\n\nNe
          pas remplir si la personne est née à l'étranger."
        required: false
      security:
      - jwt_bearer_token: []
      description: Admissions et inscriptions d'un étudiant aux établissements d'enseignement
        supérieur.
      responses:
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Étudiant identifié
          x-operationId: api_particulier_v3_mesri_statut_etudiant_with_civility
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      admissions:
                        title: Liste des admissions de l'étudiant dans les établissements
                        description: "Liste des admissions de l'étudiant dans un ou
                          plusieurs établissements d'enseignement supérieur pour l'année
                          en cours. \n\nChaque objet listé correspond à un établissement
                          dans lequel l'étudiant est au minimum admis. C'est-à-dire
                          que l'étudiant est au minimum pré-inscrit dans l'établissement.\n\nSi
                          l'étudiant est inscrit dans l'établissement (procédure complète
                          et règlement des droits d'inscription terminés), la clé
                          est_inscrit sera alors à true pour l'objet concerné.\n"
                        type: array
                        items:
                          type: object
                          properties:
                            date_debut:
                              title: Date de début de période d'études
                              type: string
                              format: date
                              description: Date de début de la période d'études dans
                                l'établissement.
                              example: '2022-09-01'
                            date_fin:
                              title: Date de fin de période d'études
                              type: string
                              format: date
                              description: Date de fin de la période d'étude dans
                                l'établissement.
                              example: '2023-08-31'
                            est_inscrit:
                              title: Est inscrit
                              type: boolean
                              example: true
                              enum:
                              - true
                              - false
                              description: |
                                Indique que l'étudiant est inscrit dans l'établissement.

                                Si le champ est à false, c'est que l'étudiant n'est pas inscrit, mais seulement admis dans l'établissement. C'est-à-dire que l'étudiant est pré-inscrit dans l'établissement mais que la procédure complète d'inscription et le règlement des droits d'inscription ne sont pas terminés. Les étudiants admis deviennent inscrits, une fois leurs droits d'inscription régularisés (paiement des droits, premier versement des droits ou acquittement des droits selon la situation de l'étudiant et les règles de l'établissement.). Tous les étudiants admis ne seront pas forcément de futurs étudiants inscrits dans l'établissement.
                              x-scope: mesri_admission_inscrit
                            regime_formation:
                              title: Régime de formation
                              description: "Régime de formation de l'étudiant. La
                                liste des régimes possibles est la suivante : \n  -
                                RF1 : formation initiale\n  - RF2 : formation initiale
                                hors apprentissage\n  - RF3 : reprise d'études non
                                financée sans convention\n  - RF4 : contrat d'apprentissage\n
                                \ - RF5 : formation continue\n  - RF6 : formation
                                continue hors contrat professionnel\n  - RF7 : contrat
                                de professionnalisation\n"
                              type: object
                              properties:
                                libelle:
                                  title: Libellé
                                  type: string
                                  description: 'Libellé de la formation de l''étudiant.

                                    '
                                  example: formation initiale
                                  enum:
                                  - formation initiale
                                  - formation initiale hors apprentissage
                                  - reprise d'études non financée sans convention
                                  - contrat d'apprentissage
                                  - formation continue
                                  - formation continue hors contrat professionnel
                                  - contrat de professionnalisation
                                code:
                                  title: Code
                                  type: string
                                  description: 'Code de la formation correspondant
                                    au régime. C''est un code technique pour exploiter
                                    différents mécanismes indépendament du label du
                                    régime.

                                    '
                                  example: RF1
                                  enum:
                                  - RF1
                                  - RF2
                                  - RF3
                                  - RF4
                                  - RF5
                                  - RF6
                                  - RF7
                              x-scope: mesri_admission_regime_formation
                            code_cog_insee_commune:
                              title: COG de la commune de l'établissement d'études
                              type: string
                              description: Code officiel géographique (COG) de la
                                commune de l'établissement d'études de l'étudiant.
                              example: '29085'
                              x-scope: mesri_admission_commune_etudes
                            etablissement_etudes:
                              title: Établissement d'études
                              description: "Code UAI et libellé de l'établissement
                                d'enseignement supérieur dans lequel l'étudiant est
                                admis. \n\nPour retrouver d'autres informations sur
                                l'établissement, vous pouvez utiliser l'[API \"Annuaire
                                de l'éducation nationale\"](https://api.gouv.fr/les-api/api-annuaire-education)
                                ou le site https://annuaire-education.fr.\n"
                              type: object
                              properties:
                                uai:
                                  title: Code UAI
                                  type: string
                                  description: 'Code d''unité administrative immatriculée
                                    (code UAI) de l''établissement où est scolarisé
                                    l''élève. Ce code unique inscrit au répertoire
                                    national des établissements est composé de 7 chiffres
                                    et d''une lettre ; les trois premiers chiffres
                                    correspondent au numéro de département de l''établissement.

                                    '
                                  pattern: "^\\d{7}\\w$"
                                  example: 0011402U
                                nom:
                                  title: Appelation officielle
                                  type: string
                                  description: Appelation officielle de l'établissement
                                    associée au code UAI.
                                  example: EGC AIN BOURG EN BRESSE EC GESTION ET COMMERCE
                                    (01000)
                              x-scope: mesri_admission_etablissement_etudes
                        x-scope: mesri_admissions
                      identite:
                        title: Données d'identité de l'étudiant
                        description: Données d'identité de l'étudiant corrigées et
                          certifiées via l'API Ines qui croise l'état civil et le
                          numéro INE de l'étudiant.
                        type: object
                        properties:
                          nom_naissance:
                            title: Nom de naissance
                            type: string
                            description: "Nom de naissance de l'étudiant. Il s'agit
                              du nom de famille tel qu'indiqué sur l'acte de naissance,
                              de mariage, sur le livret de famille, etc. Ce nom figure
                              toujours sur la pièce d'identité en premier, avant le
                              nom d'usage si le particulier en a un. \n\nEn cas de
                              changement de nom de naissance, une mention avec le
                              nouveau nom de famille est inscrite sur l'acte de naissance.\n"
                            example: Moustaki
                          prenom:
                            title: Prénom
                            type: string
                            description: Prénom de l'étudiant.
                            example: Georges
                          date_naissance:
                            title: Date de naissance
                            type: string
                            format: date
                            description: Date de naissance de l'étudiant.
                            example: '1992-11-29'
                        x-scope: mesri_identite
                        required:
                        - nom_naissance
                        - prenom
                        - date_naissance
                    required:
                    - admissions
                    - identite
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '404':
          description: Étudiant non identifié
          content:
            application/json:
              examples:
                entite_non_trouvee_25003:
                  value:
                    errors:
                    - code: '25003'
                      title: Entité non trouvée
                      detail: Aucun étudiant n'a pu être trouvé avec les critères
                        de recherche fournis.
                      source:
                      meta:
                        provider: MESRI
                  summary: Entité non trouvée
                  description: Aucun étudiant n'a pu être trouvé avec les critères
                    de recherche fournis.
              schema:
                "$ref": "#/components/schemas/Error"
        '502':
          description: Erreur du fournisseur
          content:
            application/json:
              examples:
                erreur_inconnue_du_fournisseur_de_donnees_25999:
                  value:
                    errors:
                    - code: '25999'
                      title: Erreur inconnue du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et inconnue de notre service. L'équipe technique
                        a été notifiée de cette erreur pour investigation.
                      source:
                      meta:
                        provider: MESRI
                  summary: Erreur inconnue du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et inconnue de notre service. L'équipe technique
                    a été notifiée de cette erreur pour investigation.
                erreur_interne_du_fournisseur_de_donnees_25000:
                  value:
                    errors:
                    - code: '25000'
                      title: Erreur interne du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et a été identifié comme étant une erreur interne.
                        Si le problème persiste, consultez la page de status ou contactez
                        nous sur le support.
                      source:
                      meta:
                        provider: MESRI
                  summary: Erreur interne du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et a été identifié comme étant une erreur interne.
                    Si le problème persiste, consultez la page de status ou contactez
                    nous sur le support.
                erreur_aupres_du_fournisseur_de_donnees_trop_de_requetes_25008:
                  value:
                    errors:
                    - code: '25008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: MESRI
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
                erreur_temporaire_du_fournisseur_de_donnees_25011:
                  value:
                    errors:
                    - code: '25011'
                      title: Erreur temporaire du fournisseur de données
                      detail: Merci de réessayer dans quelques instants
                      source:
                      meta:
                        provider: MESRI
                  summary: Erreur temporaire du fournisseur de données
                  description: Merci de réessayer dans quelques instants
                erreur_de_certificat_ssl_du_fournisseur_de_donnees_25009:
                  value:
                    errors:
                    - code: '25009'
                      title: Erreur de certificat SSL du fournisseur de données
                      detail: Le certificat SSL du fournisseur de données est invalide
                        ou expiré.
                      source:
                      meta:
                        provider: MESRI
                  summary: Erreur de certificat SSL du fournisseur de données
                  description: Le certificat SSL du fournisseur de données est invalide
                    ou expiré.
              schema:
                "$ref": "#/components/schemas/Error"
        '504':
          description: Erreur d'intermédiaire
          content:
            application/json:
              examples:
                timeout_error:
                  value:
                    errors:
                    - code: '25002'
                      title: Intermédiaire hors-délai
                      detail: Temps d’attente d’une réponse du fournisseur de données
                        écoulé.
                      source:
                      meta:
                        provider: MESRI
                  summary: Intermédiaire hors-délai
                  description: Temps d’attente d’une réponse du fournisseur de données
                    écoulé.
                provider_unavailable_error:
                  value:
                    errors:
                    - code: '25001'
                      title: Service non disponible
                      detail: Service du fournisseur de données temporairement indisponible
                        ou en maintenance.
                      source:
                      meta:
                        provider: MESRI
                  summary: Service non disponible
                  description: Service du fournisseur de données temporairement indisponible
                    ou en maintenance.
                network_error:
                  value:
                    errors:
                    - code: '00501'
                      title: Erreur réseau
                      detail: Problème de connexion au serveur distant. L'erreur peut
                        venir soit du fournisseur, soit de API Entreprise. Il s'agit
                        souvent d'une erreur temporaire.
                      source:
                      meta:
                        retry_in: 10
                  summary: Erreur réseau
                  description: Problème de connexion au serveur distant. L'erreur
                    peut venir soit du fournisseur, soit de API Entreprise. Il s'agit
                    souvent d'une erreur temporaire.
                dns_resolution_error:
                  value:
                    errors:
                    - code: '25004'
                      title: Erreur de résolution DNS
                      detail: Problème de résolution DNS de l'adresse du serveur
                      source:
                      meta:
                        provider: MESRI
                  summary: Erreur de résolution DNS
                  description: Problème de résolution DNS de l'adresse du serveur
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '422':
          description: Paramètre(s) invalide(s)
          content:
            application/json:
              examples:
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/mesri/statut_etudiant/france_connect":
    get:
      summary: "[FranceConnect] Statut étudiant"
      tags:
      - Statut étudiant
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      security:
      - jwt_bearer_token: []
      description: Admissions et inscriptions d'un étudiant aux établissements d'enseignement
        supérieur.
      responses:
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                missing_france_connect_access_token_error:
                  value:
                    errors:
                    - code: '50004'
                      title: Accès non autorisé
                      detail: 'Le jeton d''accès FranceConnect est manquant. Cet endpoint
                        requiert un jeton d''accès FranceConnect transmis via l''en-tête
                        Authorization: Bearer.'
                      source:
                      meta: {}
                  summary: Accès non autorisé
                  description: 'Le jeton d''accès FranceConnect est manquant. Cet
                    endpoint requiert un jeton d''accès FranceConnect transmis via
                    l''en-tête Authorization: Bearer.'
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://particulier.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Étudiant identifié
          x-operationId: api_particulier_v3_mesri_statut_etudiant_with_france_connect
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      admissions:
                        title: Liste des admissions de l'étudiant dans les établissements
                        description: "Liste des admissions de l'étudiant dans un ou
                          plusieurs établissements d'enseignement supérieur pour l'année
                          en cours. \n\nChaque objet listé correspond à un établissement
                          dans lequel l'étudiant est au minimum admis. C'est-à-dire
                          que l'étudiant est au minimum pré-inscrit dans l'établissement.\n\nSi
                          l'étudiant est inscrit dans l'établissement (procédure complète
                          et règlement des droits d'inscription terminés), la clé
                          est_inscrit sera alors à true pour l'objet concerné.\n"
                        type: array
                        items:
                          type: object
                          properties:
                            date_debut:
                              title: Date de début de période d'études
                              type: string
                              format: date
                              description: Date de début de la période d'études dans
                                l'établissement.
                              example: '2022-09-01'
                            date_fin:
                              title: Date de fin de période d'études
                              type: string
                              format: date
                              description: Date de fin de la période d'étude dans
                                l'établissement.
                              example: '2023-08-31'
                            est_inscrit:
                              title: Est inscrit
                              type: boolean
                              example: true
                              enum:
                              - true
                              - false
                              description: |
                                Indique que l'étudiant est inscrit dans l'établissement.

                                Si le champ est à false, c'est que l'étudiant n'est pas inscrit, mais seulement admis dans l'établissement. C'est-à-dire que l'étudiant est pré-inscrit dans l'établissement mais que la procédure complète d'inscription et le règlement des droits d'inscription ne sont pas terminés. Les étudiants admis deviennent inscrits, une fois leurs droits d'inscription régularisés (paiement des droits, premier versement des droits ou acquittement des droits selon la situation de l'étudiant et les règles de l'établissement.). Tous les étudiants admis ne seront pas forcément de futurs étudiants inscrits dans l'établissement.
                              x-scope: mesri_admission_inscrit
                            regime_formation:
                              title: Régime de formation
                              description: "Régime de formation de l'étudiant. La
                                liste des régimes possibles est la suivante : \n  -
                                RF1 : formation initiale\n  - RF2 : formation initiale
                                hors apprentissage\n  - RF3 : reprise d'études non
                                financée sans convention\n  - RF4 : contrat d'apprentissage\n
                                \ - RF5 : formation continue\n  - RF6 : formation
                                continue hors contrat professionnel\n  - RF7 : contrat
                                de professionnalisation\n"
                              type: object
                              properties:
                                libelle:
                                  title: Libellé
                                  type: string
                                  description: 'Libellé de la formation de l''étudiant.

                                    '
                                  example: formation initiale
                                  enum:
                                  - formation initiale
                                  - formation initiale hors apprentissage
                                  - reprise d'études non financée sans convention
                                  - contrat d'apprentissage
                                  - formation continue
                                  - formation continue hors contrat professionnel
                                  - contrat de professionnalisation
                                code:
                                  title: Code
                                  type: string
                                  description: 'Code de la formation correspondant
                                    au régime. C''est un code technique pour exploiter
                                    différents mécanismes indépendament du label du
                                    régime.

                                    '
                                  example: RF1
                                  enum:
                                  - RF1
                                  - RF2
                                  - RF3
                                  - RF4
                                  - RF5
                                  - RF6
                                  - RF7
                              x-scope: mesri_admission_regime_formation
                            code_cog_insee_commune:
                              title: COG de la commune de l'établissement d'études
                              type: string
                              description: Code officiel géographique (COG) de la
                                commune de l'établissement d'études de l'étudiant.
                              example: '29085'
                              x-scope: mesri_admission_commune_etudes
                            etablissement_etudes:
                              title: Établissement d'études
                              description: "Code UAI et libellé de l'établissement
                                d'enseignement supérieur dans lequel l'étudiant est
                                admis. \n\nPour retrouver d'autres informations sur
                                l'établissement, vous pouvez utiliser l'[API \"Annuaire
                                de l'éducation nationale\"](https://api.gouv.fr/les-api/api-annuaire-education)
                                ou le site https://annuaire-education.fr.\n"
                              type: object
                              properties:
                                uai:
                                  title: Code UAI
                                  type: string
                                  description: 'Code d''unité administrative immatriculée
                                    (code UAI) de l''établissement où est scolarisé
                                    l''élève. Ce code unique inscrit au répertoire
                                    national des établissements est composé de 7 chiffres
                                    et d''une lettre ; les trois premiers chiffres
                                    correspondent au numéro de département de l''établissement.

                                    '
                                  pattern: "^\\d{7}\\w$"
                                  example: 0011402U
                                nom:
                                  title: Appelation officielle
                                  type: string
                                  description: Appelation officielle de l'établissement
                                    associée au code UAI.
                                  example: EGC AIN BOURG EN BRESSE EC GESTION ET COMMERCE
                                    (01000)
                              x-scope: mesri_admission_etablissement_etudes
                        x-scope: mesri_admissions
                    required:
                    - admissions
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '404':
          description: Étudiant non identifié
          content:
            application/json:
              examples:
                entite_non_trouvee_25003:
                  value:
                    errors:
                    - code: '25003'
                      title: Entité non trouvée
                      detail: Aucun étudiant n'a pu être trouvé.
                      source:
                      meta:
                        provider: MESRI
                  summary: Entité non trouvée
                  description: Aucun étudiant n'a pu être trouvé.
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '422':
          description: Paramètre(s) invalide(s)
          content:
            application/json:
              examples:
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/mesri/statut_etudiant/ine":
    get:
      summary: "[INE] Statut étudiant"
      tags:
      - Statut étudiant
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: ine
        in: query
        description: Identifiant National Étudiant (INE). Cet identifiant est unique
          à chaque étudiant sur le territoire français. Il est composé de 11 caractères,
          10 chiffres et 1 lettre, et depuis la rentrée 2018, 9 chiffres et 2 lettres.
          Les étudiants peuvent retrouver leur numéro INE sur leur carte étudiant
          et leur certificat de scolarité.
        example: 1234567890G
        schema:
          type: string
          pattern: "^[0-9a-zA-Z]{11}$"
        required: true
      security:
      - jwt_bearer_token: []
      description: Admissions et inscriptions d'un étudiant aux établissements d'enseignement
        supérieur.
      responses:
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Étudiant identifié
          x-operationId: api_particulier_v3_mesri_statut_etudiant_with_ine
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      admissions:
                        title: Liste des admissions de l'étudiant dans les établissements
                        description: "Liste des admissions de l'étudiant dans un ou
                          plusieurs établissements d'enseignement supérieur pour l'année
                          en cours. \n\nChaque objet listé correspond à un établissement
                          dans lequel l'étudiant est au minimum admis. C'est-à-dire
                          que l'étudiant est au minimum pré-inscrit dans l'établissement.\n\nSi
                          l'étudiant est inscrit dans l'établissement (procédure complète
                          et règlement des droits d'inscription terminés), la clé
                          est_inscrit sera alors à true pour l'objet concerné.\n"
                        type: array
                        items:
                          type: object
                          properties:
                            date_debut:
                              title: Date de début de période d'études
                              type: string
                              format: date
                              description: Date de début de la période d'études dans
                                l'établissement.
                              example: '2022-09-01'
                            date_fin:
                              title: Date de fin de période d'études
                              type: string
                              format: date
                              description: Date de fin de la période d'étude dans
                                l'établissement.
                              example: '2023-08-31'
                            est_inscrit:
                              title: Est inscrit
                              type: boolean
                              example: true
                              enum:
                              - true
                              - false
                              description: |
                                Indique que l'étudiant est inscrit dans l'établissement.

                                Si le champ est à false, c'est que l'étudiant n'est pas inscrit, mais seulement admis dans l'établissement. C'est-à-dire que l'étudiant est pré-inscrit dans l'établissement mais que la procédure complète d'inscription et le règlement des droits d'inscription ne sont pas terminés. Les étudiants admis deviennent inscrits, une fois leurs droits d'inscription régularisés (paiement des droits, premier versement des droits ou acquittement des droits selon la situation de l'étudiant et les règles de l'établissement.). Tous les étudiants admis ne seront pas forcément de futurs étudiants inscrits dans l'établissement.
                              x-scope: mesri_admission_inscrit
                            regime_formation:
                              title: Régime de formation
                              description: "Régime de formation de l'étudiant. La
                                liste des régimes possibles est la suivante : \n  -
                                RF1 : formation initiale\n  - RF2 : formation initiale
                                hors apprentissage\n  - RF3 : reprise d'études non
                                financée sans convention\n  - RF4 : contrat d'apprentissage\n
                                \ - RF5 : formation continue\n  - RF6 : formation
                                continue hors contrat professionnel\n  - RF7 : contrat
                                de professionnalisation\n"
                              type: object
                              properties:
                                libelle:
                                  title: Libellé
                                  type: string
                                  description: 'Libellé de la formation de l''étudiant.

                                    '
                                  example: formation initiale
                                  enum:
                                  - formation initiale
                                  - formation initiale hors apprentissage
                                  - reprise d'études non financée sans convention
                                  - contrat d'apprentissage
                                  - formation continue
                                  - formation continue hors contrat professionnel
                                  - contrat de professionnalisation
                                code:
                                  title: Code
                                  type: string
                                  description: 'Code de la formation correspondant
                                    au régime. C''est un code technique pour exploiter
                                    différents mécanismes indépendament du label du
                                    régime.

                                    '
                                  example: RF1
                                  enum:
                                  - RF1
                                  - RF2
                                  - RF3
                                  - RF4
                                  - RF5
                                  - RF6
                                  - RF7
                              x-scope: mesri_admission_regime_formation
                            code_cog_insee_commune:
                              title: COG de la commune de l'établissement d'études
                              type: string
                              description: Code officiel géographique (COG) de la
                                commune de l'établissement d'études de l'étudiant.
                              example: '29085'
                              x-scope: mesri_admission_commune_etudes
                            etablissement_etudes:
                              title: Établissement d'études
                              description: "Code UAI et libellé de l'établissement
                                d'enseignement supérieur dans lequel l'étudiant est
                                admis. \n\nPour retrouver d'autres informations sur
                                l'établissement, vous pouvez utiliser l'[API \"Annuaire
                                de l'éducation nationale\"](https://api.gouv.fr/les-api/api-annuaire-education)
                                ou le site https://annuaire-education.fr.\n"
                              type: object
                              properties:
                                uai:
                                  title: Code UAI
                                  type: string
                                  description: 'Code d''unité administrative immatriculée
                                    (code UAI) de l''établissement où est scolarisé
                                    l''élève. Ce code unique inscrit au répertoire
                                    national des établissements est composé de 7 chiffres
                                    et d''une lettre ; les trois premiers chiffres
                                    correspondent au numéro de département de l''établissement.

                                    '
                                  pattern: "^\\d{7}\\w$"
                                  example: 0011402U
                                nom:
                                  title: Appelation officielle
                                  type: string
                                  description: Appelation officielle de l'établissement
                                    associée au code UAI.
                                  example: EGC AIN BOURG EN BRESSE EC GESTION ET COMMERCE
                                    (01000)
                              x-scope: mesri_admission_etablissement_etudes
                        x-scope: mesri_admissions
                      identite:
                        title: Données d'identité de l'étudiant
                        description: Données d'identité de l'étudiant corrigées et
                          certifiées via l'API Ines qui croise l'état civil et le
                          numéro INE de l'étudiant.
                        type: object
                        properties:
                          nom_naissance:
                            title: Nom de naissance
                            type: string
                            description: "Nom de naissance de l'étudiant. Il s'agit
                              du nom de famille tel qu'indiqué sur l'acte de naissance,
                              de mariage, sur le livret de famille, etc. Ce nom figure
                              toujours sur la pièce d'identité en premier, avant le
                              nom d'usage si le particulier en a un. \n\nEn cas de
                              changement de nom de naissance, une mention avec le
                              nouveau nom de famille est inscrite sur l'acte de naissance.\n"
                            example: Moustaki
                          prenom:
                            title: Prénom
                            type: string
                            description: Prénom de l'étudiant.
                            example: Georges
                          date_naissance:
                            title: Date de naissance
                            type: string
                            format: date
                            description: Date de naissance de l'étudiant.
                            example: '1992-11-29'
                        x-scope: mesri_identite
                        required:
                        - nom_naissance
                        - prenom
                        - date_naissance
                    required:
                    - admissions
                    - identite
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '404':
          description: Étudiant non identifié
          content:
            application/json:
              examples:
                entite_non_trouvee_25003:
                  value:
                    errors:
                    - code: '25003'
                      title: Entité non trouvée
                      detail: Aucun étudiant n'a pu être trouvé avec les critères
                        de recherche fournis.
                      source:
                      meta:
                        provider: MESRI
                  summary: Entité non trouvée
                  description: Aucun étudiant n'a pu être trouvé avec les critères
                    de recherche fournis.
              schema:
                "$ref": "#/components/schemas/Error"
        '502':
          description: Erreur du fournisseur
          content:
            application/json:
              examples:
                erreur_inconnue_du_fournisseur_de_donnees_25999:
                  value:
                    errors:
                    - code: '25999'
                      title: Erreur inconnue du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et inconnue de notre service. L'équipe technique
                        a été notifiée de cette erreur pour investigation.
                      source:
                      meta:
                        provider: MESRI
                  summary: Erreur inconnue du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et inconnue de notre service. L'équipe technique
                    a été notifiée de cette erreur pour investigation.
                erreur_interne_du_fournisseur_de_donnees_25000:
                  value:
                    errors:
                    - code: '25000'
                      title: Erreur interne du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et a été identifié comme étant une erreur interne.
                        Si le problème persiste, consultez la page de status ou contactez
                        nous sur le support.
                      source:
                      meta:
                        provider: MESRI
                  summary: Erreur interne du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et a été identifié comme étant une erreur interne.
                    Si le problème persiste, consultez la page de status ou contactez
                    nous sur le support.
                erreur_aupres_du_fournisseur_de_donnees_trop_de_requetes_25008:
                  value:
                    errors:
                    - code: '25008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: MESRI
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
                erreur_temporaire_du_fournisseur_de_donnees_25011:
                  value:
                    errors:
                    - code: '25011'
                      title: Erreur temporaire du fournisseur de données
                      detail: Merci de réessayer dans quelques instants
                      source:
                      meta:
                        provider: MESRI
                  summary: Erreur temporaire du fournisseur de données
                  description: Merci de réessayer dans quelques instants
                erreur_de_certificat_ssl_du_fournisseur_de_donnees_25009:
                  value:
                    errors:
                    - code: '25009'
                      title: Erreur de certificat SSL du fournisseur de données
                      detail: Le certificat SSL du fournisseur de données est invalide
                        ou expiré.
                      source:
                      meta:
                        provider: MESRI
                  summary: Erreur de certificat SSL du fournisseur de données
                  description: Le certificat SSL du fournisseur de données est invalide
                    ou expiré.
              schema:
                "$ref": "#/components/schemas/Error"
        '504':
          description: Erreur d'intermédiaire
          content:
            application/json:
              examples:
                timeout_error:
                  value:
                    errors:
                    - code: '25002'
                      title: Intermédiaire hors-délai
                      detail: Temps d’attente d’une réponse du fournisseur de données
                        écoulé.
                      source:
                      meta:
                        provider: MESRI
                  summary: Intermédiaire hors-délai
                  description: Temps d’attente d’une réponse du fournisseur de données
                    écoulé.
                provider_unavailable_error:
                  value:
                    errors:
                    - code: '25001'
                      title: Service non disponible
                      detail: Service du fournisseur de données temporairement indisponible
                        ou en maintenance.
                      source:
                      meta:
                        provider: MESRI
                  summary: Service non disponible
                  description: Service du fournisseur de données temporairement indisponible
                    ou en maintenance.
                network_error:
                  value:
                    errors:
                    - code: '00501'
                      title: Erreur réseau
                      detail: Problème de connexion au serveur distant. L'erreur peut
                        venir soit du fournisseur, soit de API Entreprise. Il s'agit
                        souvent d'une erreur temporaire.
                      source:
                      meta:
                        retry_in: 10
                  summary: Erreur réseau
                  description: Problème de connexion au serveur distant. L'erreur
                    peut venir soit du fournisseur, soit de API Entreprise. Il s'agit
                    souvent d'une erreur temporaire.
                dns_resolution_error:
                  value:
                    errors:
                    - code: '25004'
                      title: Erreur de résolution DNS
                      detail: Problème de résolution DNS de l'adresse du serveur
                      source:
                      meta:
                        provider: MESRI
                  summary: Erreur de résolution DNS
                  description: Problème de résolution DNS de l'adresse du serveur
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
        '422':
          description: Paramètre(s) invalide(s)
          content:
            application/json:
              examples:
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
  "/v3/sdh/statut_sportif/identifiant":
    get:
      summary: "[Identifiant] API Statut sportif de haut niveau et sur liste ministérielle"
      tags:
      - Statut Sportif
      parameters:
      - name: recipient
        in: query
        description: |-
          "**Bénéficiaire de l’appel**

          SIRET de l’administration destinatrice des données."
        example: '13002526500013'
        required: true
        schema:
          type: string
      - name: identifiant
        in: query
        description: Identifiant du sportif dans le système d'information du Ministère
          des Sports.
        example: '123456789'
        required: true
        schema:
          type: string
      security:
      - jwt_bearer_token: []
      description: Statut sportif de haut niveau et toute catégorie inscrits en liste
        des collectifs nationaux ou en liste des arbitres et juges sportifs de haut-niveau.
      responses:
        '401':
          description: Non autorisé
          content:
            application/json:
              examples:
                invalid_token_error:
                  value:
                    errors:
                    - code: '00101'
                      title: Interdit
                      detail: Votre token n'est pas valide ou n'est pas renseigné
                      source:
                        parameter: token
                      meta: {}
                  summary: Interdit
                  description: Votre token n'est pas valide ou n'est pas renseigné
                expired_token_error:
                  value:
                    errors:
                    - code: '00103'
                      title: Jeton expiré
                      detail: Votre token est expiré. Vous devez refaire une demande
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton expiré
                  description: Votre token est expiré. Vous devez refaire une demande
                blacklisted_token_error:
                  value:
                    errors:
                    - code: '00105'
                      title: Jeton sur liste noire
                      detail: 'Votre jeton est sur liste noire, celui-ci a certainement
                        été divulgué sur un canal non-sécurisé. Vous pouvez trouver
                        un jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
                      source:
                        parameter: token
                      meta: {}
                  summary: Jeton sur liste noire
                  description: 'Votre jeton est sur liste noire, celui-ci a certainement
                    été divulgué sur un canal non-sécurisé. Vous pouvez trouver un
                    jeton valide sur votre espace personnel: https://entreprise.api.gouv.fr/compte'
              schema:
                "$ref": "#/components/schemas/Error"
        '403':
          description: Accès interdit
          content:
            application/json:
              examples:
                insufficient_privileges_error:
                  value:
                    errors:
                    - code: '00100'
                      title: Privilèges insuffisants
                      detail: Votre token est valide mais vos privilèges sont insuffisants.
                        Listez vos privilèges sur /api/introspect
                      source:
                        parameter: token
                      meta: {}
                  summary: Privilèges insuffisants
                  description: Votre token est valide mais vos privilèges sont insuffisants.
                    Listez vos privilèges sur /api/introspect
              schema:
                "$ref": "#/components/schemas/Error"
        '429':
          description: Trop de requêtes
          content:
            application/json:
              examples:
                too_many_requests_error:
                  value:
                    errors:
                    - code: '00429'
                      title: Trop de requêtes
                      detail: Vous avez effectué trop de requêtes
                      source:
                      meta: {}
                  summary: Trop de requêtes
                  description: Vous avez effectué trop de requêtes
              schema:
                "$ref": "#/components/schemas/Error"
        '200':
          description: Sportif trouvé
          headers:
            RateLimit-Limit:
              schema:
                type: integer
              description: La limite concernant l’endpoint appelé, soit le nombre
                de requête/minute.
              example: 50
            RateLimit-Remaining:
              schema:
                type: integer
              description: Le nombre d’appels restants durant la période courante
                d’une minute.
              example: 47
            RateLimit-Reset:
              schema:
                type: integer
              description: La fin de la période courante (en format timestamp)
              example: 1637223155
          x-operationId: api_particulier_v3_sdh_statut_sportif_with_identifiant
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      identite:
                        title: Données d'identité du sportif
                        type: object
                        description: Informations d'identité du sportif.
                        properties:
                          nom_naissance:
                            title: Nom de naissance
                            type: string
                            description: Nom de naissance du sportif.
                            example: Dupont
                          nom_usage:
                            title: Nom d'usage
                            type: string
                            description: Nom d'usage du sportif.
                            example: Martin
                          prenoms:
                            title: Prénoms
                            type: string
                            description: Prénoms du sportif.
                            example: Jean Claude
                          date_naissance:
                            title: Date de naissance
                            type: string
                            format: date
                            description: Date de naissance du sportif (format YYYY-MM-DD).
                            example: '1990-05-15'
                          sexe:
                            title: Sexe
                            type: string
                            description: Sexe du sportif.
                            example: M
                            enum:
                            - F
                            - M
                        x-scope: sdh_statut_sportif_identite
                        required:
                        - nom_naissance
                        - nom_usage
                        - prenoms
                        - date_naissance
                        - sexe
                      est_sportif_de_haut_niveau:
                        title: Est sportif de haut niveau
                        type: boolean
                        description: Indique si la personne est actuellement un sportif
                          de haut niveau.
                        example: true
                        x-scope: sdh_statut_sportif_est_sportif_de_haut_niveau
                      a_ete_sportif_de_haut_niveau:
                        title: A été sportif de haut niveau
                        type: boolean
                        description: Indique si la personne a été un sportif de haut
                          niveau dans le passé.
                        example: true
                        x-scope: sdh_statut_sportif_a_ete_sportif_de_haut_niveau
                      informations_statut:
                        title: Informations du statut sportif
                        type: object
                        description: Détails du statut sportif actuel.
                        properties:
                          periode:
                            title: Période du statut
                            type: object
                            description: Période de validité du statut sportif de
                              haut niveau.
                            properties:
                              date_debut_statut:
                                title: Date de début du statut
                                type: string
                                format: date
                                description: Date de début du statut sportif de haut
                                  niveau.
                                example: '2023-01-01'
                              date_fin_statut:
                                title: Date de fin du statut
                                type: string
                                format: date
                                description: Date de fin du statut sportif de haut
                                  niveau.
                                example: '2025-09-30'
                            required:
                            - date_debut_statut
                            - date_fin_statut
                          federation:
                            title: Informations sur la fédération
                            type: object
                            description: Données d'identification de la fédération.
                            properties:
                              code_federation:
                                title: Code fédération
                                type: string
                                description: Code de la fédération.
                                example: '29'
                              nom_federation:
                                title: Nom de la fédération
                                type: string
                                description: Nom complet de la fédération.
                                example: fédération française de handball
                              nom_court_federation:
                                title: Nom court de la fédération
                                type: string
                                description: Nom court de la fédération.
                                example: HANDBALL
                            required:
                            - code_federation
                            - nom_federation
                            - nom_court_federation
                          etablissement:
                            title: Informations sur l'établissement
                            type: object
                            description: Données d'identification de l'établissement.
                            properties:
                              code_etablissement:
                                title: Code établissement
                                type: string
                                description: Code de l'établissement.
                                example: '2075'
                              nom_etablissement:
                                title: Nom de l'établissement
                                type: string
                                description: Nom de l'établissement.
                                example: Maison de la Performance Nouvelle-Aquitaine
                            required:
                            - code_etablissement
                            - nom_etablissement
                          region:
                            title: Informations sur la région
                            type: object
                            description: Données d'identification de la région.
                            properties:
                              code_region:
                                title: Code région
                                type: string
                                description: Code de la région.
                                example: '75'
                              nom_region:
                                title: Nom de la région
                                type: string
                                description: Nom de la région.
                                example: Nouvelle-Aquitaine
                            required:
                            - code_region
                            - nom_region
                          categorie:
                            title: Informations sur la catégorie
                            type: object
                            description: Données d'identification de la catégorie
                              sportive.
                            properties:
                              code_categorie:
                                title: Code catégorie
                                type: string
                                description: Code de la catégorie.
                                example: '2'
                              nom_categorie:
                                title: Nom de la catégorie
                                type: string
                                description: Nom de la catégorie.
                                example: elite
                              valeur:
                                title: Valeur
                                type: string
                                description: Valeur associée à la catégorie.
                                example: '4'
                            required:
                            - code_categorie
                            - nom_categorie
                            - valeur
                          sportif_de_haut_niveau:
                            title: Sportif de haut niveau
                            type: boolean
                            description: Indique si ce statut correspond à un sportif
                              de haut niveau.
                            example: true
                        x-scope: sdh_statut_sportif_informations_statut
                        required:
                        - periode
                        - federation
                        - etablissement
                        - region
                        - categorie
                        - sportif_de_haut_niveau
                      informations_statuts_precedents:
                        title: Historique des statuts précédents
                        type: array
                        description: Détails historiques des statuts sportifs précédents.
                        items:
                          type: object
                          properties:
                            fiche:
                              title: Numéro de fiche
                              type: integer
                              description: Numéro de la fiche.
                              example: 789456
                            periode:
                              title: Période du statut
                              type: object
                              description: Période de validité du statut sportif de
                                haut niveau.
                              properties:
                                date_debut_statut:
                                  title: Date de début du statut
                                  type: string
                                  format: date
                                  description: Date de début du statut sportif de
                                    haut niveau.
                                  example: '2021-01-01'
                                date_fin_statut:
                                  title: Date de fin du statut
                                  type: string
                                  format: date
                                  description: Date de fin du statut sportif de haut
                                    niveau.
                                  example: '2022-12-31'
                            federation:
                              title: Informations sur la fédération
                              type: object
                              description: Données d'identification de la fédération.
                              properties:
                                code_federation:
                                  title: Code fédération
                                  type: string
                                  description: Code de la fédération.
                                  example: '69'
                                nom_federation:
                                  title: Nom de la fédération
                                  type: string
                                  description: Nom complet de la fédération.
                                  example: Fédération Française de Triathlon et Disciplines
                                    Enchaînées
                                nom_court_federation:
                                  title: Nom court de la fédération
                                  type: string
                                  description: Nom court de la fédération.
                                  example: TRIATHLON
                            etablissement:
                              title: Informations sur l'établissement
                              type: object
                              description: Données d'identification de l'établissement.
                              properties:
                                code_etablissement:
                                  title: Code établissement
                                  type: string
                                  description: Code de l'établissement.
                                  example: '1093'
                                nom_etablissement:
                                  title: Nom de l'établissement
                                  type: string
                                  description: Nom de l'établissement.
                                  example: Maison de la Performance Occitanie
                            region:
                              title: Informations sur la région
                              type: object
                              description: Données d'identification de la région.
                              properties:
                                code_region:
                                  title: Code région
                                  type: string
                                  description: Code de la région.
                                  example: '76'
                                nom_region:
                                  title: Nom de la région
                                  type: string
                                  description: Nom de la région.
                                  example: Occitanie
                            categorie:
                              title: Informations sur la catégorie
                              type: object
                              description: Données d'identification de la catégorie
                                sportive.
                              properties:
                                code_categorie:
                                  title: Code catégorie
                                  type: string
                                  description: Code de la catégorie.
                                  example: '4'
                                nom_categorie:
                                  title: Nom de la catégorie
                                  type: string
                                  description: Nom de la catégorie.
                                  example: Elite
                                valeur:
                                  title: Valeur
                                  type: string
                                  description: Valeur associée à la catégorie.
                                  example: '128'
                            sportif_de_haut_niveau:
                              title: Sportif de haut niveau
                              type: boolean
                              description: Indique si ce statut correspond à un sportif
                                de haut niveau.
                              example: true
                        x-scope: sdh_statut_sportif_informations_statuts_precedents
                    required:
                    - identite
                    - est_sportif_de_haut_niveau
                    - a_ete_sportif_de_haut_niveau
                    - informations_statut
                    - informations_statuts_precedents
                    additionalProperties: false
                  links:
                    type: object
                  meta:
                    type: object
                required:
                - data
                - links
                - meta
        '404':
          description: Non trouvé
          content:
            application/json:
              examples:
                entite_non_trouvee_41003:
                  value:
                    errors:
                    - code: '41003'
                      title: Entité non trouvée
                      detail: Le ou les paramètre(s) d'entrée n'existent pas, ne sont
                        pas connus, ou ne comportent aucune information pour cet appel.
                        Veuillez vérifier que votre recherche est couverte par le
                        périmètre de l'API.
                      source:
                      meta:
                        provider: SDH
                  summary: Entité non trouvée
                  description: Le ou les paramètre(s) d'entrée n'existent pas, ne
                    sont pas connus, ou ne comportent aucune information pour cet
                    appel. Veuillez vérifier que votre recherche est couverte par
                    le périmètre de l'API.
              schema:
                "$ref": "#/components/schemas/Error"
        '422':
          description: Paramètre(s) invalide(s)
          content:
            application/json:
              examples:
                unprocessable_content_error_identifiant_error:
                  value:
                    errors:
                    - code: '00380'
                      title: Entité non traitable
                      detail: L'identifiant est manquant
                      source:
                      meta: {}
                  summary: Entité non traitable
                  description: L'identifiant est manquant
                missing_mandatory_params_recipient_error:
                  value:
                    errors:
                    - code: '00203'
                      title: Entité non traitable
                      detail: Le paramètre recipient est obligatoire
                      source:
                        parameter: recipient
                      meta: {}
                  summary: Entité non traitable
                  description: Le paramètre recipient est obligatoire
              schema:
                "$ref": "#/components/schemas/Error"
        '502':
          description: Erreur du fournisseur
          content:
            application/json:
              examples:
                erreur_inconnue_du_fournisseur_de_donnees_41999:
                  value:
                    errors:
                    - code: '41999'
                      title: Erreur inconnue du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et inconnue de notre service. L'équipe technique
                        a été notifiée de cette erreur pour investigation.
                      source:
                      meta:
                        provider: SDH
                  summary: Erreur inconnue du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et inconnue de notre service. L'équipe technique
                    a été notifiée de cette erreur pour investigation.
                erreur_interne_du_fournisseur_de_donnees_41000:
                  value:
                    errors:
                    - code: '41000'
                      title: Erreur interne du fournisseur de données
                      detail: La réponse retournée par le fournisseur de données est
                        invalide et a été identifié comme étant une erreur interne.
                        Si le problème persiste, consultez la page de status ou contactez
                        nous sur le support.
                      source:
                      meta:
                        provider: SDH
                  summary: Erreur interne du fournisseur de données
                  description: La réponse retournée par le fournisseur de données
                    est invalide et a été identifié comme étant une erreur interne.
                    Si le problème persiste, consultez la page de status ou contactez
                    nous sur le support.
                erreur_aupres_du_fournisseur_de_donnees_trop_de_requetes_41008:
                  value:
                    errors:
                    - code: '41008'
                      title: 'Erreur auprès du fournisseur de données : trop de requêtes'
                      detail: 'Erreur de fournisseur de donnée : Trop de requêtes
                        effectuées, veuillez réessayer plus tard.'
                      source:
                      meta:
                        provider: SDH
                  summary: 'Erreur auprès du fournisseur de données : trop de requêtes'
                  description: 'Erreur de fournisseur de donnée : Trop de requêtes
                    effectuées, veuillez réessayer plus tard.'
                erreur_temporaire_du_fournisseur_de_donnees_41011:
                  value:
                    errors:
                    - code: '41011'
                      title: Erreur temporaire du fournisseur de données
                      detail: Merci de réessayer dans quelques instants
                      source:
                      meta:
                        provider: SDH
                  summary: Erreur temporaire du fournisseur de données
                  description: Merci de réessayer dans quelques instants
                erreur_de_certificat_ssl_du_fournisseur_de_donnees_41009:
                  value:
                    errors:
                    - code: '41009'
                      title: Erreur de certificat SSL du fournisseur de données
                      detail: Le certificat SSL du fournisseur de données est invalide
                        ou expiré.
                      source:
                      meta:
                        provider: SDH
                  summary: Erreur de certificat SSL du fournisseur de données
                  description: Le certificat SSL du fournisseur de données est invalide
                    ou expiré.
              schema:
                "$ref": "#/components/schemas/Error"
        '504':
          description: Erreur d'intermédiaire
          content:
            application/json:
              examples:
                timeout_error:
                  value:
                    errors:
                    - code: '41002'
                      title: Intermédiaire hors-délai
                      detail: Temps d’attente d’une réponse du fournisseur de données
                        écoulé.
                      source:
                      meta:
                        provider: SDH
                  summary: Intermédiaire hors-délai
                  description: Temps d’attente d’une réponse du fournisseur de données
                    écoulé.
                provider_unavailable_error:
                  value:
                    errors:
                    - code: '41001'
                      title: Service non disponible
                      detail: Service du fournisseur de données temporairement indisponible
                        ou en maintenance.
                      source:
                      meta:
                        provider: SDH
                  summary: Service non disponible
                  description: Service du fournisseur de données temporairement indisponible
                    ou en maintenance.
                network_error:
                  value:
                    errors:
                    - code: '00501'
                      title: Erreur réseau
                      detail: Problème de connexion au serveur distant. L'erreur peut
                        venir soit du fournisseur, soit de API Entreprise. Il s'agit
                        souvent d'une erreur temporaire.
                      source:
                      meta:
                        retry_in: 10
                  summary: Erreur réseau
                  description: Problème de connexion au serveur distant. L'erreur
                    peut venir soit du fournisseur, soit de API Entreprise. Il s'agit
                    souvent d'une erreur temporaire.
                dns_resolution_error:
                  value:
                    errors:
                    - code: '41004'
                      title: Erreur de résolution DNS
                      detail: Problème de résolution DNS de l'adresse du serveur
                      source:
                      meta:
                        provider: SDH
                  summary: Erreur de résolution DNS
                  description: Problème de résolution DNS de l'adresse du serveur
              schema:
                "$ref": "#/components/schemas/Error"
        '409':
          description: Conflit
          content:
            application/json:
              examples:
                conflict_error:
                  value:
                    errors:
                    - code: '00015'
                      title: Conflit
                      detail: Une requête associé à votre jeton est déjà en cours
                        de traitement pour ces paramètres. Veuillez attendre la fin
                        du traitement avant d'effectuer une nouvelle requête.
                      source:
                      meta: {}
                  summary: Conflit
                  description: Une requête associé à votre jeton est déjà en cours
                    de traitement pour ces paramètres. Veuillez attendre la fin du
                    traitement avant d'effectuer une nouvelle requête.
              schema:
                "$ref": "#/components/schemas/Error"
servers:
- url: https://particulier.api.gouv.fr
  description: Environnement de production
- url: https://staging.particulier.api.gouv.fr
  description: Environnement de staging
components:
  schemas:
    Error:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              title:
                type: string
              detail:
                type: string
              code:
                type: string
            required:
            - title
            - detail
            - code
      required:
      - errors
  securitySchemes:
    jwt_bearer_token:
      type: http
      description: |-
        Votre jeton d'authentification doit être placé dans le header 'Authorization: Bearer VOTRE_JWT', sa validité est de 18 mois. Dans le cas où vous utilisez une API FranceConnectée, vous devez utiliser le jeton FranceConnect à la place du jeton d'authentification.

            Exemple cURL :

                curl -X GET \
                -H "Authorization: Bearer $token" \
                --url "https://particulier.api.gouv.fr/v3/..."
      name: Authorization
      in: header
      scheme: bearer
      bearerFormat: JWT
