-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
6103 lines (6031 loc) · 228 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: Pappers API
description: >
L'API de Pappers vous permet de récupérer des informations et documents sur
les entreprises françaises à partir de leur numéro SIREN ou SIRET.
Vous devez indiquer votre clé d'API dans les requêtes, en utilisant le
paramètre `api_token`.
L'URL d'accès à l'API est https://api.pappers.fr/v2/
Lien vers la documentation de la V1 :
https://www.pappers.fr/api/documentation/v1
Lien vers la documentation de la V3 :
https://www.pappers.fr/api/documentation/v3
Lien vers la documentation de l'API internationale :
https://www.pappers.in/api/documentation
L'historique des modifications (changelog) est accessible à l'url suivante :
https://www.pappers.fr/api/changelog
version: 2.13.0
contact:
name: Support technique Pappers
email: support@pappers.fr
x-konfig-ignore:
potential-incorrect-type: true
servers:
- url: https://api.pappers.fr/v2
tags:
- name: Documents
- name: Recherche
- name: Surveillance
- name: Fiche entreprise
- name: Fiche association
- name: Suggestions / Autocomplete
- name: Comptes annuels
- name: Cartographie
- name: Conformité
- name: Suivi utilisation
paths:
/entreprise:
get:
tags:
- Fiche entreprise
summary: Récupère l'ensemble des informations disponibles sur une entreprise.
operationId: FicheEntreprise_getInformation
description: >-
Vous devez fournir soit le SIREN, soit le SIRET. Si vous indiquez le
SIREN, tous les établissements associés à ce SIREN seront renvoyés dans
la clé `etablissements`. Si vous indiquez le SIRET, seul l'établissement
associé sera renvoyé dans la clé `etablissement`.
parameters:
- description: Clé d'utilisation de l'API
name: api_token
in: query
required: true
schema:
type: string
example: votre_clé_ici
- description: SIREN de l'entreprise
name: siren
in: query
required: false
schema:
type: string
example: 443061841
- description: SIRET de l'entreprise
name: siret
in: query
required: false
schema:
type: string
example: 44306184100047
- description: >-
Si vrai et si l'entreprise est en diffusion partielle, le retour
renverra les informations partielles disponibles. Valeur par défaut
: `false`.
name: integrer_diffusions_partielles
in: query
required: false
schema:
type: boolean
- description: >-
Format attendu pour les publications BODACC. Valeur par défaut :
`"objet"`.
name: format_publications_bodacc
in: query
required: false
schema:
type: string
enum:
- objet
- texte
example: objet
- description: >-
Si vrai, le retour inclura les marques éventuelles de l'entreprise.
Valeur par défaut : `false`.
name: marques
in: query
required: false
schema:
type: boolean
- description: >-
Si vrai, le champ validite_tva_intracommunautaire du retour
indiquera si le numéro de tva est valide auprès de la Commission
européenne. Valeur par défaut : `false`.
name: validite_tva_intracommunautaire
in: query
required: false
schema:
type: boolean
- description: >-
Pappers traite les publications BODACC afin de supprimer les
publications périmée. Si vrai, le retour inclura les publications
bodacc sans traitement. Valeur par défaut : `false`.
name: publications_bodacc_brutes
in: query
required: false
schema:
type: boolean
- description: >
Liste des champs supplémentaires à inclure dans le retour. Certains
champs peuvent entraîner une consommation de jetons supplémentaires.
Champs supplémentaires disponibles :
- `sites_internet` : 1 jeton supplémentaire
- `telephone` : 1 jeton supplémentaire *
- `email` : 1 jeton supplémentaire *
- `enseigne_1` : gratuit
- `enseigne_2` : gratuit
- `enseigne_3` : gratuit
- `distribution_speciale` : gratuit
- `code_cedex` : gratuit
- `libelle_cedex` : gratuit
- `code_commune` : gratuit
- `code_region` : gratuit
- `region` : gratuit
- `code_departement` : gratuit
- `departement` : gratuit
- `nomenclature_code_naf` : gratuit
- `labels` : gratuit
- `labels:orias` : 0.5 jeton supplémentaire
- `micro_entreprise` : gratuit
- `sanctions` : 1 jeton supplémentaire
- `personne_politiquement_exposee` : 1 jeton supplémentaire
- `scoring_financier` : 10 jetons supplémentaires
- `scoring_non_financier` : 10 jetons supplémentaires
\* : le coût des champs `telephone` et `email` est de 1 jeton
supplémentaire au total, même si les deux sont demandés.
name: champs_supplementaires
in: query
required: false
schema:
type: string
example: site_internet,telephone
responses:
'200':
description: >-
Entreprise trouvée. Le retour contient un objet décrivant
l'entreprise.
content:
application/json:
schema:
$ref: '#/components/schemas/EntrepriseFiche'
'206':
description: >-
Entreprise trouvée. Le retour est cependant partiel : au moins une
source de données n'a pas répondu dans le temps imparti.
content:
application/json:
schema:
$ref: '#/components/schemas/EntrepriseFiche'
'400':
description: Paramètres de la requête incorrects.
'401':
description: Clé API incorrecte.
'404':
description: Entreprise inexistante.
/association:
get:
tags:
- Fiche association
summary: Récupère l'ensemble des informations disponibles sur une association.
operationId: FicheAssociation_getInfo
description: >-
Vous devez fournir soit l'identifiant de l'association, soit le SIREN,
soit le SIRET.
parameters:
- description: Clé d'utilisation de l'API
name: api_token
in: query
required: true
schema:
type: string
example: votre_clé_ici
- description: Identifiant de l'association
name: id_association
in: query
required: false
schema:
type: string
example: W142005389
- description: SIRET de l'association
name: siret
in: query
required: false
schema:
type: string
example: 95037097300014
- description: SIREN de l'association
name: siren
in: query
required: false
schema:
type: string
example: 950370973
responses:
'200':
description: >-
Association trouvée. Le retour contient un objet décrivant
l'association.
content:
application/json:
schema:
$ref: '#/components/schemas/Association'
'400':
description: Paramètres de la requête incorrects.
'401':
description: Clé API incorrecte.
'404':
description: Association inexistante.
'503':
description: Service momentanément indisponible.
/recherche:
get:
tags:
- Recherche
summary: Recherche les entreprises qui correspondent à des critères.
operationId: Recherche_criteriaEnterprisesGet
description: >
Tous les paramètres sont optionnels et servent à filtrer la recherche.
Les différentes entreprises seront renvoyées dans un tableau
`resultats`, et le nombre total de résultats sera renvoyé dans le champ
`total`.
Pour parcourir l'ensemble des résultats, deux solutions sont possibles :
- La pagination (paramètres `page` et `par_page`), limitée aux 400
premiers résultats ;
- Les curseurs (paramètres `curseur` et `par_curseur`).
parameters:
- $ref: '#/components/parameters/api_token'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/par_page'
- $ref: '#/components/parameters/curseur'
- $ref: '#/components/parameters/par_curseur'
- $ref: '#/components/parameters/bases'
- $ref: '#/components/parameters/precision'
- description: >-
Texte à rechercher. Dénomination pour une personne morale, nom et
prénom pour une personne physique.
Si vous recherchez dans plusieurs bases, ce paramètre sera utilisé
pour rechercher dans toutes les bases.
name: q
in: query
required: false
schema:
type: string
example: Google France
- description: Défini si la requête se base sur le siège
name: siege
in: query
required: false
schema:
type: string
example: 'true'
- $ref: '#/components/parameters/code_naf'
- $ref: '#/components/parameters/departement'
- $ref: '#/components/parameters/region'
- $ref: '#/components/parameters/code_postal'
- $ref: '#/components/parameters/convention_collective'
- $ref: '#/components/parameters/categorie_juridique'
- $ref: '#/components/parameters/entreprise_cessee'
- $ref: '#/components/parameters/statut_rcs'
- $ref: '#/components/parameters/objet_social'
- $ref: '#/components/parameters/date_immatriculation_rcs_min'
- $ref: '#/components/parameters/date_immatriculation_rcs_max'
- $ref: '#/components/parameters/date_radiation_rcs_min'
- $ref: '#/components/parameters/date_radiation_rcs_max'
- $ref: '#/components/parameters/capital_min'
- $ref: '#/components/parameters/capital_max'
- $ref: '#/components/parameters/chiffre_affaires_min'
- $ref: '#/components/parameters/chiffre_affaires_max'
- $ref: '#/components/parameters/resultat_min'
- $ref: '#/components/parameters/resultat_max'
- $ref: '#/components/parameters/date_creation_min'
- $ref: '#/components/parameters/date_creation_max'
- $ref: '#/components/parameters/tranche_effectif_min'
- $ref: '#/components/parameters/tranche_effectif_max'
- $ref: '#/components/parameters/type_dirigeant'
- $ref: '#/components/parameters/qualite_dirigeant'
- $ref: '#/components/parameters/nationalite_dirigeant'
- $ref: '#/components/parameters/nom_dirigeant'
- $ref: '#/components/parameters/prenom_dirigeant'
- $ref: '#/components/parameters/age_dirigeant_min'
- $ref: '#/components/parameters/age_dirigeant_max'
- $ref: '#/components/parameters/date_de_naissance_dirigeant_min'
- $ref: '#/components/parameters/date_de_naissance_dirigeant_max'
- $ref: '#/components/parameters/age_beneficiaire_min'
- $ref: '#/components/parameters/age_beneficiaire_max'
- $ref: '#/components/parameters/date_de_naissance_beneficiaire_min'
- $ref: '#/components/parameters/date_de_naissance_beneficiaire_max'
- $ref: '#/components/parameters/nationalite_beneficiaire'
- $ref: '#/components/parameters/date_depot_document_min'
- $ref: '#/components/parameters/date_depot_document_max'
- $ref: '#/components/parameters/type_publication'
- $ref: '#/components/parameters/date_publication_min'
- $ref: '#/components/parameters/date_publication_max'
responses:
'200':
description: >-
Recherche réussie. Le retour contient la liste des entreprises qui
répondent aux critères indiqués.
content:
application/json:
schema:
$ref: '#/components/schemas/RechercheCriteriaEnterprisesGetResponse'
'401':
description: Clé API incorrecte.
'404':
description: Aucune entreprise ne correspond aux critères indiqués.
'503':
description: Service momentanément indisponible.
/recherche-dirigeants:
get:
tags:
- Recherche
summary: Recherche les dirigeants qui correspondent à des critères.
operationId: Recherche_leadersSearchCriteriaGet
description: >-
Tous les paramètres sont optionnels et servent à filtrer la recherche.
Les différents dirigeants seront renvoyées dans un tableau `resultats`.
parameters:
- $ref: '#/components/parameters/api_token'
- $ref: '#/components/parameters/par_page'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/precision'
- description: >-
Texte à rechercher. Nom et prénom du dirigeant pour une personne
physique, dénomination pour une personne morale.
name: q
in: query
required: false
schema:
type: string
example: Google France
- $ref: '#/components/parameters/type_dirigeant'
- $ref: '#/components/parameters/qualite_dirigeant'
- $ref: '#/components/parameters/nationalite_dirigeant'
- $ref: '#/components/parameters/nom_dirigeant'
- $ref: '#/components/parameters/prenom_dirigeant'
- $ref: '#/components/parameters/age_dirigeant_min'
- $ref: '#/components/parameters/age_dirigeant_max'
- $ref: '#/components/parameters/date_de_naissance_dirigeant_min'
- $ref: '#/components/parameters/date_de_naissance_dirigeant_max'
- $ref: '#/components/parameters/code_naf'
- $ref: '#/components/parameters/departement'
- $ref: '#/components/parameters/region'
- $ref: '#/components/parameters/code_postal'
- $ref: '#/components/parameters/convention_collective'
- $ref: '#/components/parameters/categorie_juridique'
- $ref: '#/components/parameters/entreprise_cessee'
- $ref: '#/components/parameters/statut_rcs'
- $ref: '#/components/parameters/objet_social'
- $ref: '#/components/parameters/date_immatriculation_rcs_min'
- $ref: '#/components/parameters/date_immatriculation_rcs_max'
- $ref: '#/components/parameters/date_radiation_rcs_min'
- $ref: '#/components/parameters/date_radiation_rcs_max'
- $ref: '#/components/parameters/capital_min'
- $ref: '#/components/parameters/capital_max'
- $ref: '#/components/parameters/chiffre_affaires_min'
- $ref: '#/components/parameters/chiffre_affaires_max'
- $ref: '#/components/parameters/resultat_min'
- $ref: '#/components/parameters/resultat_max'
- $ref: '#/components/parameters/date_creation_min'
- $ref: '#/components/parameters/date_creation_max'
- $ref: '#/components/parameters/tranche_effectif_min'
- $ref: '#/components/parameters/tranche_effectif_max'
- $ref: '#/components/parameters/age_beneficiaire_min'
- $ref: '#/components/parameters/age_beneficiaire_max'
- $ref: '#/components/parameters/date_de_naissance_beneficiaire_min'
- $ref: '#/components/parameters/date_de_naissance_beneficiaire_max'
- $ref: '#/components/parameters/nationalite_beneficiaire'
- $ref: '#/components/parameters/date_depot_document_min'
- $ref: '#/components/parameters/date_depot_document_max'
- $ref: '#/components/parameters/type_publication'
- $ref: '#/components/parameters/date_publication_min'
- $ref: '#/components/parameters/date_publication_max'
- $ref: '#/components/parameters/siren'
responses:
'200':
description: >-
Recherche réussie. Le retour contient la liste des dirigeants qui
répondent aux critères indiqués.
content:
application/json:
schema:
$ref: '#/components/schemas/RechercheLeadersSearchCriteriaGetResponse'
'401':
description: Clé API incorrecte.
'404':
description: Aucun dirigeant ne correspond aux critères indiqués.
'503':
description: Service momentanément indisponible.
/recherche-beneficiaires:
get:
tags:
- Recherche
summary: Recherche les bénéficiaires effectifs qui correspondent à des critères.
operationId: Recherche_effectiveBeneficiariesSearch
description: >-
Tous les paramètres sont optionnels et servent à filtrer la recherche.
Les différents bénéficiaires effectifs seront renvoyées dans un tableau
`resultats`.
parameters:
- $ref: '#/components/parameters/api_token'
- $ref: '#/components/parameters/par_page'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/precision'
- description: Nom et/ou prénom du bénéficiaire effectif.
name: q
in: query
required: false
schema:
type: string
example: Xavier Niel
- $ref: '#/components/parameters/age_beneficiaire_min'
- $ref: '#/components/parameters/age_beneficiaire_max'
- $ref: '#/components/parameters/date_de_naissance_beneficiaire_min'
- $ref: '#/components/parameters/date_de_naissance_beneficiaire_max'
- $ref: '#/components/parameters/nationalite_beneficiaire'
- $ref: '#/components/parameters/code_naf'
- $ref: '#/components/parameters/departement'
- $ref: '#/components/parameters/region'
- $ref: '#/components/parameters/code_postal'
- $ref: '#/components/parameters/convention_collective'
- $ref: '#/components/parameters/categorie_juridique'
- $ref: '#/components/parameters/entreprise_cessee'
- $ref: '#/components/parameters/statut_rcs'
- $ref: '#/components/parameters/objet_social'
- $ref: '#/components/parameters/date_immatriculation_rcs_min'
- $ref: '#/components/parameters/date_immatriculation_rcs_max'
- $ref: '#/components/parameters/date_radiation_rcs_min'
- $ref: '#/components/parameters/date_radiation_rcs_max'
- $ref: '#/components/parameters/capital_min'
- $ref: '#/components/parameters/capital_max'
- $ref: '#/components/parameters/chiffre_affaires_min'
- $ref: '#/components/parameters/chiffre_affaires_max'
- $ref: '#/components/parameters/resultat_min'
- $ref: '#/components/parameters/resultat_max'
- $ref: '#/components/parameters/date_creation_min'
- $ref: '#/components/parameters/date_creation_max'
- $ref: '#/components/parameters/tranche_effectif_min'
- $ref: '#/components/parameters/tranche_effectif_max'
- $ref: '#/components/parameters/type_dirigeant'
- $ref: '#/components/parameters/qualite_dirigeant'
- $ref: '#/components/parameters/nationalite_dirigeant'
- $ref: '#/components/parameters/nom_dirigeant'
- $ref: '#/components/parameters/prenom_dirigeant'
- $ref: '#/components/parameters/age_dirigeant_min'
- $ref: '#/components/parameters/age_dirigeant_max'
- $ref: '#/components/parameters/date_de_naissance_dirigeant_min'
- $ref: '#/components/parameters/date_de_naissance_dirigeant_max'
- $ref: '#/components/parameters/date_depot_document_min'
- $ref: '#/components/parameters/date_depot_document_max'
- $ref: '#/components/parameters/type_publication'
- $ref: '#/components/parameters/date_publication_min'
- $ref: '#/components/parameters/date_publication_max'
- $ref: '#/components/parameters/siren'
responses:
'200':
description: >-
Recherche réussie. Le retour contient la liste des bénéficiaires
effectifs qui répondent aux critères indiqués.
content:
application/json:
schema:
$ref: >-
#/components/schemas/RechercheEffectiveBeneficiariesSearchResponse
'401':
description: Clé API incorrecte.
'404':
description: Aucun bénéficiaire effectif ne correspond aux critères indiqués.
'503':
description: Service momentanément indisponible.
/recherche-documents:
get:
tags:
- Recherche
summary: Recherche les documents qui correspondent à des critères.
operationId: Recherche_matchingDocumentsGet
description: >-
Tous les paramètres sont optionnels et servent à filtrer la recherche.
Les différents documents seront renvoyées dans un tableau `resultats`.
parameters:
- $ref: '#/components/parameters/api_token'
- $ref: '#/components/parameters/par_page'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/precision'
- description: Mot-clé à rechercher dans le contenu du document.
name: q
in: query
required: false
schema:
type: string
example: Rémunération
- $ref: '#/components/parameters/date_depot_document_min'
- $ref: '#/components/parameters/date_depot_document_max'
- $ref: '#/components/parameters/code_naf'
- $ref: '#/components/parameters/departement'
- $ref: '#/components/parameters/region'
- $ref: '#/components/parameters/code_postal'
- $ref: '#/components/parameters/convention_collective'
- $ref: '#/components/parameters/categorie_juridique'
- $ref: '#/components/parameters/entreprise_cessee'
- $ref: '#/components/parameters/statut_rcs'
- $ref: '#/components/parameters/objet_social'
- $ref: '#/components/parameters/date_immatriculation_rcs_min'
- $ref: '#/components/parameters/date_immatriculation_rcs_max'
- $ref: '#/components/parameters/date_radiation_rcs_min'
- $ref: '#/components/parameters/date_radiation_rcs_max'
- $ref: '#/components/parameters/capital_min'
- $ref: '#/components/parameters/capital_max'
- $ref: '#/components/parameters/chiffre_affaires_min'
- $ref: '#/components/parameters/chiffre_affaires_max'
- $ref: '#/components/parameters/resultat_min'
- $ref: '#/components/parameters/resultat_max'
- $ref: '#/components/parameters/date_creation_min'
- $ref: '#/components/parameters/date_creation_max'
- $ref: '#/components/parameters/tranche_effectif_min'
- $ref: '#/components/parameters/tranche_effectif_max'
- $ref: '#/components/parameters/type_dirigeant'
- $ref: '#/components/parameters/qualite_dirigeant'
- $ref: '#/components/parameters/nationalite_dirigeant'
- $ref: '#/components/parameters/nom_dirigeant'
- $ref: '#/components/parameters/prenom_dirigeant'
- $ref: '#/components/parameters/age_dirigeant_min'
- $ref: '#/components/parameters/age_dirigeant_max'
- $ref: '#/components/parameters/date_de_naissance_dirigeant_min'
- $ref: '#/components/parameters/date_de_naissance_dirigeant_max'
- $ref: '#/components/parameters/age_beneficiaire_min'
- $ref: '#/components/parameters/age_beneficiaire_max'
- $ref: '#/components/parameters/date_de_naissance_beneficiaire_min'
- $ref: '#/components/parameters/date_de_naissance_beneficiaire_max'
- $ref: '#/components/parameters/nationalite_beneficiaire'
- $ref: '#/components/parameters/type_publication'
- $ref: '#/components/parameters/date_publication_min'
- $ref: '#/components/parameters/date_publication_max'
- $ref: '#/components/parameters/siren'
responses:
'200':
description: >-
Recherche réussie. Le retour contient la liste des documents qui
répondent aux critères indiqués.
content:
application/json:
schema:
$ref: '#/components/schemas/RechercheMatchingDocumentsGetResponse'
'401':
description: Clé API incorrecte.
'404':
description: Aucun document ne correspond aux critères indiqués.
'503':
description: Service momentanément indisponible.
/recherche-publications:
get:
tags:
- Recherche
summary: Recherche les publications BODACC qui correspondent à des critères.
operationId: Recherche_matchingPublicationsGet
description: >-
Tous les paramètres sont optionnels et servent à filtrer la recherche.
Les différentes publications seront renvoyées dans un tableau
`resultats`.
parameters:
- $ref: '#/components/parameters/api_token'
- $ref: '#/components/parameters/par_page'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/precision'
- description: Mot-clé à rechercher dans le contenu de la publication.
name: q
in: query
required: false
schema:
type: string
example: Liquidation
- $ref: '#/components/parameters/code_naf'
- $ref: '#/components/parameters/departement'
- $ref: '#/components/parameters/region'
- $ref: '#/components/parameters/code_postal'
- $ref: '#/components/parameters/convention_collective'
- $ref: '#/components/parameters/categorie_juridique'
- $ref: '#/components/parameters/entreprise_cessee'
- $ref: '#/components/parameters/statut_rcs'
- $ref: '#/components/parameters/objet_social'
- $ref: '#/components/parameters/date_immatriculation_rcs_min'
- $ref: '#/components/parameters/date_immatriculation_rcs_max'
- $ref: '#/components/parameters/date_radiation_rcs_min'
- $ref: '#/components/parameters/date_radiation_rcs_max'
- $ref: '#/components/parameters/capital_min'
- $ref: '#/components/parameters/capital_max'
- $ref: '#/components/parameters/chiffre_affaires_min'
- $ref: '#/components/parameters/chiffre_affaires_max'
- $ref: '#/components/parameters/resultat_min'
- $ref: '#/components/parameters/resultat_max'
- $ref: '#/components/parameters/date_creation_min'
- $ref: '#/components/parameters/date_creation_max'
- $ref: '#/components/parameters/tranche_effectif_min'
- $ref: '#/components/parameters/tranche_effectif_max'
- $ref: '#/components/parameters/type_dirigeant'
- $ref: '#/components/parameters/qualite_dirigeant'
- $ref: '#/components/parameters/nationalite_dirigeant'
- $ref: '#/components/parameters/nom_dirigeant'
- $ref: '#/components/parameters/prenom_dirigeant'
- $ref: '#/components/parameters/age_dirigeant_min'
- $ref: '#/components/parameters/age_dirigeant_max'
- $ref: '#/components/parameters/date_de_naissance_dirigeant_min'
- $ref: '#/components/parameters/date_de_naissance_dirigeant_max'
- $ref: '#/components/parameters/age_beneficiaire_min'
- $ref: '#/components/parameters/age_beneficiaire_max'
- $ref: '#/components/parameters/date_de_naissance_beneficiaire_min'
- $ref: '#/components/parameters/date_de_naissance_beneficiaire_max'
- $ref: '#/components/parameters/nationalite_beneficiaire'
- $ref: '#/components/parameters/date_depot_document_min'
- $ref: '#/components/parameters/date_depot_document_max'
- $ref: '#/components/parameters/type_publication'
- $ref: '#/components/parameters/date_publication_min'
- $ref: '#/components/parameters/date_publication_max'
- $ref: '#/components/parameters/siren'
responses:
'200':
description: >-
Recherche réussie. Le retour contient la liste des publications qui
répondent aux critères indiqués.
content:
application/json:
schema:
$ref: '#/components/schemas/RechercheMatchingPublicationsGetResponse'
'401':
description: Clé API incorrecte.
'404':
description: Aucune publication ne correspond aux critères indiqués.
'503':
description: Service momentanément indisponible.
/suggestions:
get:
tags:
- Suggestions / Autocomplete
summary: >-
Recherche les entreprises qui correspondent à un début de recherche
textuelle (type autocomplete).
operationId: SuggestionsAutocomplete_searchText
description: >-
Cette route nécessite généralement d'avoir un temps de réponse très
faible. Une URL avec un temps de réponse plus faible a été mise en place
: `https://suggestions.pappers.fr/v2?q=googl`. D'autre part, afin de
permettre une intégration en front-end la plus directe, cette route ne
nécessite pas de token d'authentification.
parameters:
- description: Début de recherche textuelle
name: q
in: query
required: true
schema:
type: string
example: googl
- description: 'Nombre de résultats. Maximum 100. Valeur par défaut : `10`.'
name: longueur
in: query
required: false
schema:
type: integer
example: 20
- description: >-
Cibles de la recherche, séparées par des virgules. Valeur par défaut
: `"nom_entreprise"`.
name: cibles
in: query
required: false
schema:
type: string
enum:
- nom_entreprise
- denomination
- nom_complet
- representant
- siren
- siret
example: nom_entreprise,siren,siret
responses:
'200':
description: >-
Requête correctement exécutée. Le retour contient une ou plusieurs
listes d'entreprises en fonction du paramètre `cibles` de la
requête.
content:
application/json:
schema:
$ref: '#/components/schemas/SuggestionsAutocompleteSearchTextResponse'
'400':
description: Paramètres de la requête incorrects.
/entreprise/comptes:
get:
tags:
- Comptes annuels
summary: Récupère les comptes annuels publiés d'une entreprise.
operationId: ComptesAnnuels_getBySiren
description: >-
Vous devez fournir le SIREN de l'entreprise pour laquelle vous souhaitez
obtenir les comptes annuels.
parameters:
- $ref: '#/components/parameters/api_token'
- description: SIREN de l'entreprise
name: siren
in: query
required: false
schema:
type: string
example: 443061841
- description: >-
Année de cloture des comptes souhaités. Il est possible d'indiquer
plusieurs années en les séparant par des virgules. Si le paramètre
n'est pas fourni, toutes les années disponibles seront retournées.
name: annee
in: query
required: false
schema:
type: string
example: 2016,2017,2018
responses:
'200':
description: >-
Comptes annuels disponibles. Le retour contient les comptes
détaillés, ainsi que les ratios associés.
content:
application/json:
schema:
$ref: '#/components/schemas/ComptesAnnuelsGetBySirenResponse'
'400':
description: Paramètres de la requête incorrects.
'401':
description: Clé API incorrecte.
'404':
description: Comptes annuels indisponibles.
'503':
description: Service momentanément indisponible.
/entreprise/cartographie:
get:
tags:
- Cartographie
summary: >-
Récupère les données permettant d'établir une cartographie d'une
entreprise.
operationId: Cartographie_getData
description: >
Cette route fournit les données nécessaires à l'établissement de la
cartographie Pappers d'une entreprise telle qu'elle apparaît sur les
fiches Pappers (exemple
https://www.pappers.fr/entreprise/google-france-443061841#cartographie).
- La requête est gratuite (erreur 404) si seul le noeud principal
(l'entreprise recherchée) est disponible.
- La requête coûte 1 jeton si, en plus du noeud principal, des noeuds
dirigeants directs de l'entreprise sont disponibles. Il est possible de
rejeter ces cas avec le paramètre `rejeter_premier_degre`. La requête
est alors gratuite (erreur 404).
- La requête coûte 3 jetons si des noeuds supplémentaires sont
disponibles.
parameters:
- description: Clé d'utilisation de l'API
name: api_token
in: query
required: true
schema:
type: string
example: votre_clé_ici
- description: SIREN de l'entreprise
name: siren
in: query
required: true
schema:
type: string
example: 443061841
- description: >-
Si vrai, la cartographie intègrera les entreprises dirigées par
l'entreprise recherchée et les entreprises qui dirigent l'entreprise
recherchée. Valeur par défaut : `true`.
name: inclure_entreprises_dirigees
in: query
required: false
schema:
type: boolean
- description: >-
Si vrai, la cartographie intègrera les entreprises citées
conjointement avec l'entreprise recherchée dans des actes et
statuts. Valeur par défaut : `false`.
name: inclure_entreprises_citees
in: query
required: false
schema:
type: boolean
- description: >-
Si vrai, la cartographie intègrera les SCI. Valeur par défaut :
`true`.
name: inclure_sci
in: query
required: false
schema:
type: boolean
- description: >-
Si vrai, la cartographie pourra adapter automatiquement ses
paramètres si ceux choisis manuellement ne sont pas idéaux. Valeur
par défaut : `false`.
name: autoriser_modifications
in: query
required: false
schema:
type: boolean
- description: >-
Si vrai et que la cartographie ne fait apparaître que l'entreprise
recherchée ainsi que ses dirigeants directs, une erreur 404 sera
renvoyée et la requête ne sera pas comptabilisée dans le quota de
jetons. Valeur par défaut : `false`.
name: rejeter_premier_degre
in: query
required: false
schema:
type: boolean
- description: >-
Permet de choisir manuellement un degré pour la cartographie. Seuls
deux états sont possibles : un nombre <= 2 ou bien un nombre > 2.
Cela veut dire que 0, 1 ou 2 donneront la même cartographie, tout
comme 3, 4 ou 5.
name: degre
in: query
required: false
schema:
type: integer
responses:
'200':
description: >-
Cartographie disponible. Le retour contient un objet permettant de
reconstruire la cartographie.
content:
application/json:
schema:
$ref: '#/components/schemas/Cartographie'
'400':
description: Paramètres de la requête incorrects.
'401':
description: Clé API incorrecte.
'404':
description: >-
La cartographie n'est pas disponible car elle ne contient qu'un seul
noeud ou bien le paramètre `rejeter_premier_degre` a été utilisé.
/document/telechargement:
get:
tags:
- Documents
summary: Télécharge un document PDF ou XLSX à partir de son token.
operationId: Documents_downloadDocumentByToken
description: >-
Vous devez fournir le token du document. Le document vous sera envoyé au
format PDF ou XLSX.
parameters:
- description: Clé d'utilisation de l'API
name: api_token
in: query
required: true
schema:
type: string
example: votre_clé_ici
- description: Token du document
name: token
in: query
required: true
schema:
type: string
example: >-
QTQ0MzA2MTg0MTIwMjAwNDA3RMOpY2lzaW9uKHMpIGRlIGwnYXNzb2Npw6kgdW5pcXVl
responses:
'200':
description: >-
Document disponible. Le retour contient le document au format PDF ou
XLSX.
content:
application/pdf:
schema:
$ref: '#/components/schemas/DocumentsDownloadDocumentByTokenResponse'
'400':
description: Paramètres de la requête incorrects.
'401':
description: Clé API incorrecte.
'404':
description: Document indisponible.
'503':
description: Service momentanément indisponible.
/document/extrait_pappers:
get:
tags:
- Documents
summary: >-
Télécharge l'extrait Pappers d'une entreprise à partir de son SIREN ou
SIRET.
operationId: Documents_downloadPappersExtrait
description: >-
Vous devez fournir soit le SIREN, soit le SIRET. Le document vous sera
envoyé au format PDF.
parameters:
- description: Clé d'utilisation de l'API
name: api_token
in: query
required: true
schema:
type: string
example: votre_clé_ici
- description: SIREN de l'entreprise
name: siren
in: query
required: false
schema:
type: string
example: 443061841
- description: SIRET de l'entreprise
name: siret
in: query
required: false
schema:
type: string
example: 44306184100047
responses:
'200':
description: >-
Document disponible. Le retour contient l'extrait Pappers au format
PDF.
content:
application/pdf:
schema:
$ref: '#/components/schemas/DocumentsDownloadPappersExtraitResponse'
'400':
description: Paramètres de la requête incorrects.
'401':
description: Clé API incorrecte.
'404':
description: Document indisponible.
'503':
description: Service momentanément indisponible.
/document/extrait_inpi:
get: