diff --git a/sdks/db/cached-method-objects/from-custom-request_box.com.yaml b/sdks/db/cached-method-objects/from-custom-request_box.com.yaml index e2737796b2..ff2ab6e83b 100644 --- a/sdks/db/cached-method-objects/from-custom-request_box.com.yaml +++ b/sdks/db/cached-method-objects/from-custom-request_box.com.yaml @@ -1,4 +1,4 @@ -hash: fe5bc557d9ba0acac52c46a9cb4348065b6ff28dd9dc27657b1b55ee6861a9e9 +hash: 5bc3c66e5a79f8838fc3d59af06be08cb3bb71cb8b809eb0a652be12a58d7805 methodObjects: - url: /authorize method: authorize @@ -310,7 +310,7 @@ methodObjects: Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example - `?field=metadata.enterprise_12345.contractTemplate`. + `?fields=metadata.enterprise_12345.contractTemplate`. example: - id - type @@ -791,8 +791,8 @@ methodObjects: - url: /files/upload_sessions method: createSessionForUpload httpMethod: post - tag: Uploads (Chunked) - typeScriptTag: uploadsChunked + tag: Uploads (https://developer.box.com/reference/ + typeScriptTag: uploadsHttps:DeveloperBoxComReference description: Create upload session parameters: - name: folder_id @@ -826,8 +826,8 @@ methodObjects: - url: /files/{file_id}/upload_sessions method: createSessionForUpload httpMethod: post - tag: Uploads (Chunked) - typeScriptTag: uploadsChunked + tag: Uploads (https://developer.box.com/reference/ + typeScriptTag: uploadsHttps:DeveloperBoxComReference description: Create upload session for existing file parameters: - name: fileId @@ -862,8 +862,8 @@ methodObjects: - url: /files/upload_sessions/{upload_session_id} method: removeUploadSession httpMethod: delete - tag: Uploads (Chunked) - typeScriptTag: uploadsChunked + tag: Uploads (https://developer.box.com/reference/ + typeScriptTag: uploadsHttps:DeveloperBoxComReference description: Remove upload session parameters: - name: uploadSessionId @@ -881,8 +881,8 @@ methodObjects: - url: /files/upload_sessions/{upload_session_id} method: info httpMethod: get - tag: Uploads (Chunked) - typeScriptTag: uploadsChunked + tag: Uploads (https://developer.box.com/reference/ + typeScriptTag: uploadsHttps:DeveloperBoxComReference description: Get upload session parameters: - name: uploadSessionId @@ -898,8 +898,8 @@ methodObjects: - url: /files/upload_sessions/{upload_session_id} method: filePartUpdate httpMethod: put - tag: Uploads (Chunked) - typeScriptTag: uploadsChunked + tag: Uploads (https://developer.box.com/reference/ + typeScriptTag: uploadsHttps:DeveloperBoxComReference description: Upload part of file parameters: - name: uploadSessionId @@ -957,8 +957,8 @@ methodObjects: - url: /files/upload_sessions/{upload_session_id}/parts method: listParts httpMethod: get - tag: Uploads (Chunked) - typeScriptTag: uploadsChunked + tag: Uploads (https://developer.box.com/reference/ + typeScriptTag: uploadsHttps:DeveloperBoxComReference description: List parts parameters: - name: uploadSessionId @@ -992,8 +992,8 @@ methodObjects: - url: /files/upload_sessions/{upload_session_id}/commit method: commitSession httpMethod: post - tag: Uploads (Chunked) - typeScriptTag: uploadsChunked + tag: Uploads (https://developer.box.com/reference/ + typeScriptTag: uploadsHttps:DeveloperBoxComReference description: Commit upload session parameters: - name: uploadSessionId @@ -1199,8 +1199,8 @@ methodObjects: - url: /files/{file_id}/collaborations method: fileAccessList httpMethod: get - tag: Collaborations (List) - typeScriptTag: collaborationsList + tag: Collaborations (https://developer.box.com/reference/ + typeScriptTag: collaborationsHttps:DeveloperBoxComReference description: List file collaborations parameters: - name: fileId @@ -1649,8 +1649,8 @@ methodObjects: - url: /files/{file_id}/metadata method: listFileMetadata httpMethod: get - tag: Metadata instances (Files) - typeScriptTag: metadataInstancesFiles + tag: Metadata instances (https://developer.box.com/reference/ + typeScriptTag: metadataInstancesHttps:DeveloperBoxComReference description: List metadata instances on file parameters: - name: fileId @@ -1818,8 +1818,8 @@ methodObjects: - url: /files/{file_id}/metadata/{scope}/{template_key} method: removeInstance httpMethod: delete - tag: Metadata instances (Files) - typeScriptTag: metadataInstancesFiles + tag: Metadata instances (https://developer.box.com/reference/ + typeScriptTag: metadataInstancesHttps:DeveloperBoxComReference description: Remove metadata instance from file parameters: - name: fileId @@ -1860,8 +1860,8 @@ methodObjects: - url: /files/{file_id}/metadata/{scope}/{template_key} method: getInstance httpMethod: get - tag: Metadata instances (Files) - typeScriptTag: metadataInstancesFiles + tag: Metadata instances (https://developer.box.com/reference/ + typeScriptTag: metadataInstancesHttps:DeveloperBoxComReference description: Get metadata instance on file parameters: - name: fileId @@ -1904,8 +1904,8 @@ methodObjects: - url: /files/{file_id}/metadata/{scope}/{template_key} method: applyTemplate httpMethod: post - tag: Metadata instances (Files) - typeScriptTag: metadataInstancesFiles + tag: Metadata instances (https://developer.box.com/reference/ + typeScriptTag: metadataInstancesHttps:DeveloperBoxComReference description: Create metadata instance on file parameters: - name: fileId @@ -1948,8 +1948,8 @@ methodObjects: - url: /files/{file_id}/metadata/{scope}/{template_key} method: updateInstanceOnFile httpMethod: put - tag: Metadata instances (Files) - typeScriptTag: metadataInstancesFiles + tag: Metadata instances (https://developer.box.com/reference/ + typeScriptTag: metadataInstancesHttps:DeveloperBoxComReference description: Update metadata instance on file parameters: - name: fileId @@ -2104,8 +2104,8 @@ methodObjects: - url: /files/{file_id}/watermark method: removeWatermark httpMethod: delete - tag: Watermarks (Files) - typeScriptTag: watermarksFiles + tag: Watermarks (https://developer.box.com/reference/ + typeScriptTag: watermarksHttps:DeveloperBoxComReference description: Remove watermark from file parameters: - name: fileId @@ -2130,8 +2130,8 @@ methodObjects: - url: /files/{file_id}/watermark method: get httpMethod: get - tag: Watermarks (Files) - typeScriptTag: watermarksFiles + tag: Watermarks (https://developer.box.com/reference/ + typeScriptTag: watermarksHttps:DeveloperBoxComReference description: Get watermark on file parameters: - name: fileId @@ -2159,8 +2159,8 @@ methodObjects: - url: /files/{file_id}/watermark method: applyWatermarkToFile httpMethod: put - tag: Watermarks (Files) - typeScriptTag: watermarksFiles + tag: Watermarks (https://developer.box.com/reference/ + typeScriptTag: watermarksHttps:DeveloperBoxComReference description: Apply watermark to file parameters: - name: fileId @@ -2461,7 +2461,7 @@ methodObjects: Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example - `?field=metadata.enterprise_12345.contractTemplate`. + `?fields=metadata.enterprise_12345.contractTemplate`. example: - id - type @@ -2782,7 +2782,7 @@ methodObjects: Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example - `?field=metadata.enterprise_12345.contractTemplate`. + `?fields=metadata.enterprise_12345.contractTemplate`. example: - id - type @@ -3033,8 +3033,8 @@ methodObjects: - url: /folders/{folder_id}/collaborations method: folderAccess httpMethod: get - tag: Collaborations (List) - typeScriptTag: collaborationsList + tag: Collaborations (https://developer.box.com/reference/ + typeScriptTag: collaborationsHttps:DeveloperBoxComReference description: List folder collaborations parameters: - name: folderId @@ -3151,8 +3151,8 @@ methodObjects: - url: /folders/{folder_id}/metadata method: listOnFolder httpMethod: get - tag: Metadata instances (Folders) - typeScriptTag: metadataInstancesFolders + tag: Metadata instances (https://developer.box.com/reference/ + typeScriptTag: metadataInstancesHttps:DeveloperBoxComReference description: List metadata instances on folder parameters: - name: folderId @@ -3339,8 +3339,8 @@ methodObjects: - url: /folders/{folder_id}/metadata/{scope}/{template_key} method: removeInstance httpMethod: delete - tag: Metadata instances (Folders) - typeScriptTag: metadataInstancesFolders + tag: Metadata instances (https://developer.box.com/reference/ + typeScriptTag: metadataInstancesHttps:DeveloperBoxComReference description: Remove metadata instance from folder parameters: - name: folderId @@ -3384,8 +3384,8 @@ methodObjects: - url: /folders/{folder_id}/metadata/{scope}/{template_key} method: getFolderMetadataInstance httpMethod: get - tag: Metadata instances (Folders) - typeScriptTag: metadataInstancesFolders + tag: Metadata instances (https://developer.box.com/reference/ + typeScriptTag: metadataInstancesHttps:DeveloperBoxComReference description: Get metadata instance on folder parameters: - name: folderId @@ -3431,8 +3431,8 @@ methodObjects: - url: /folders/{folder_id}/metadata/{scope}/{template_key} method: applyTemplate httpMethod: post - tag: Metadata instances (Folders) - typeScriptTag: metadataInstancesFolders + tag: Metadata instances (https://developer.box.com/reference/ + typeScriptTag: metadataInstancesHttps:DeveloperBoxComReference description: Create metadata instance on folder parameters: - name: folderId @@ -3478,8 +3478,8 @@ methodObjects: - url: /folders/{folder_id}/metadata/{scope}/{template_key} method: updateInstanceOnFolder httpMethod: put - tag: Metadata instances (Folders) - typeScriptTag: metadataInstancesFolders + tag: Metadata instances (https://developer.box.com/reference/ + typeScriptTag: metadataInstancesHttps:DeveloperBoxComReference description: Update metadata instance on folder parameters: - name: folderId @@ -3618,8 +3618,8 @@ methodObjects: - url: /folders/{folder_id}/watermark method: removeFolderWatermark httpMethod: delete - tag: Watermarks (Folders) - typeScriptTag: watermarksFolders + tag: Watermarks (https://developer.box.com/reference/ + typeScriptTag: watermarksHttps:DeveloperBoxComReference description: Remove watermark from folder parameters: - name: folderId @@ -3649,8 +3649,8 @@ methodObjects: - url: /folders/{folder_id}/watermark method: getFolderWatermark httpMethod: get - tag: Watermarks (Folders) - typeScriptTag: watermarksFolders + tag: Watermarks (https://developer.box.com/reference/ + typeScriptTag: watermarksHttps:DeveloperBoxComReference description: Get watermark for folder parameters: - name: folderId @@ -3681,8 +3681,8 @@ methodObjects: - url: /folders/{folder_id}/watermark method: applyToFolder httpMethod: put - tag: Watermarks (Folders) - typeScriptTag: watermarksFolders + tag: Watermarks (https://developer.box.com/reference/ + typeScriptTag: watermarksHttps:DeveloperBoxComReference description: Apply watermark to folder parameters: - name: folderId @@ -4636,8 +4636,8 @@ methodObjects: - url: /collaborations method: collaborations httpMethod: get - tag: Collaborations (List) - typeScriptTag: collaborationsList + tag: Collaborations (https://developer.box.com/reference/ + typeScriptTag: collaborationsHttps:DeveloperBoxComReference description: List pending collaborations parameters: - name: status @@ -4888,7 +4888,7 @@ methodObjects: a given file size range. This applied to files and folders. Size ranges are defined as comma separated list of a lower - and upper byte size limit (inclusive). + and upper byte size limit (https://developer.box.com/reference/. The upper and lower bound can be omitted to create open ranges. example: @@ -5051,7 +5051,8 @@ methodObjects: explicitly specified. - * `relevance` (default) returns the results sorted by relevance to the + * `relevance` (https://developer.box.com/reference/ returns the + results sorted by relevance to the query search term. The relevance is based on the occurrence of the search @@ -5453,8 +5454,8 @@ methodObjects: - url: /shared_items method: getBySharedLink httpMethod: get - tag: Shared links (Files) - typeScriptTag: sharedLinksFiles + tag: Shared links (https://developer.box.com/reference/ + typeScriptTag: sharedLinksHttps:DeveloperBoxComReference description: Find file for shared link parameters: - name: ifNoneMatch @@ -5511,8 +5512,8 @@ methodObjects: - url: /files/{file_id}#get_shared_link method: getSharedLinkInfo httpMethod: get - tag: Shared links (Files) - typeScriptTag: sharedLinksFiles + tag: Shared links (https://developer.box.com/reference/ + typeScriptTag: sharedLinksHttps:DeveloperBoxComReference description: Get shared link for file parameters: - name: fileId @@ -5550,8 +5551,8 @@ methodObjects: - url: /files/{file_id}#add_shared_link method: addSharedLinkToFile httpMethod: put - tag: Shared links (Files) - typeScriptTag: sharedLinksFiles + tag: Shared links (https://developer.box.com/reference/ + typeScriptTag: sharedLinksHttps:DeveloperBoxComReference description: Add shared link to file parameters: - name: fileId @@ -5598,8 +5599,8 @@ methodObjects: - url: /files/{file_id}#update_shared_link method: updateLinkOnFile httpMethod: put - tag: Shared links (Files) - typeScriptTag: sharedLinksFiles + tag: Shared links (https://developer.box.com/reference/ + typeScriptTag: sharedLinksHttps:DeveloperBoxComReference description: Update shared link on file parameters: - name: fileId @@ -5646,8 +5647,8 @@ methodObjects: - url: /files/{file_id}#remove_shared_link method: removeSharedLink httpMethod: put - tag: Shared links (Files) - typeScriptTag: sharedLinksFiles + tag: Shared links (https://developer.box.com/reference/ + typeScriptTag: sharedLinksHttps:DeveloperBoxComReference description: Remove shared link from file parameters: - name: fileId @@ -5693,8 +5694,8 @@ methodObjects: - url: /shared_items#folders method: findFolderBySharedLink httpMethod: get - tag: Shared links (Folders) - typeScriptTag: sharedLinksFolders + tag: Shared links (https://developer.box.com/reference/ + typeScriptTag: sharedLinksHttps:DeveloperBoxComReference description: Find folder for shared link parameters: - name: ifNoneMatch @@ -5751,8 +5752,8 @@ methodObjects: - url: /folders/{folder_id}#get_shared_link method: getSharedLinkForFolder httpMethod: get - tag: Shared links (Folders) - typeScriptTag: sharedLinksFolders + tag: Shared links (https://developer.box.com/reference/ + typeScriptTag: sharedLinksHttps:DeveloperBoxComReference description: Get shared link for folder parameters: - name: folderId @@ -5793,8 +5794,8 @@ methodObjects: - url: /folders/{folder_id}#add_shared_link method: addLinkToFolder httpMethod: put - tag: Shared links (Folders) - typeScriptTag: sharedLinksFolders + tag: Shared links (https://developer.box.com/reference/ + typeScriptTag: sharedLinksHttps:DeveloperBoxComReference description: Add shared link to folder parameters: - name: folderId @@ -5844,8 +5845,8 @@ methodObjects: - url: /folders/{folder_id}#update_shared_link method: updateFolderSharedLink httpMethod: put - tag: Shared links (Folders) - typeScriptTag: sharedLinksFolders + tag: Shared links (https://developer.box.com/reference/ + typeScriptTag: sharedLinksHttps:DeveloperBoxComReference description: Update shared link on folder parameters: - name: folderId @@ -5895,8 +5896,8 @@ methodObjects: - url: /folders/{folder_id}#remove_shared_link method: removeFromFolder httpMethod: put - tag: Shared links (Folders) - typeScriptTag: sharedLinksFolders + tag: Shared links (https://developer.box.com/reference/ + typeScriptTag: sharedLinksHttps:DeveloperBoxComReference description: Remove shared link from folder parameters: - name: folderId @@ -7486,8 +7487,8 @@ methodObjects: - url: /groups/{group_id}/collaborations method: groupAccessDetails httpMethod: get - tag: Collaborations (List) - typeScriptTag: collaborationsList + tag: Collaborations (https://developer.box.com/reference/ + typeScriptTag: collaborationsHttps:DeveloperBoxComReference description: List group collaborations parameters: - name: groupId diff --git a/sdks/db/cached-method-objects/from-custom-request_customer.io_DatePipelines.yaml b/sdks/db/cached-method-objects/from-custom-request_customer.io_DatePipelines.yaml index 17e7769838..29351a694c 100644 --- a/sdks/db/cached-method-objects/from-custom-request_customer.io_DatePipelines.yaml +++ b/sdks/db/cached-method-objects/from-custom-request_customer.io_DatePipelines.yaml @@ -1,4 +1,4 @@ -hash: 357e3421f13be7908cd00522707722e992c80afa8086472b6908c13fead2ffaa +hash: bcb6798ef66908a2e84871498c842f21ded84c883244bd6ef0f60628a101fb71 methodObjects: - url: /identify method: personTraitsAssignment diff --git a/sdks/db/cached-method-objects/from-custom-request_customer.io_JourneysApp.yaml b/sdks/db/cached-method-objects/from-custom-request_customer.io_JourneysApp.yaml index f8937f430d..9d362228dd 100644 --- a/sdks/db/cached-method-objects/from-custom-request_customer.io_JourneysApp.yaml +++ b/sdks/db/cached-method-objects/from-custom-request_customer.io_JourneysApp.yaml @@ -1,4 +1,4 @@ -hash: 69654d0d731cec1be5ea25ee3af3f906a1ec8a56881a1be6ffe4b3827b1d2739 +hash: b2fb1a6411e0aa4676879913831dca7c4c4d5f6a66dc48850068475425dbce35 methodObjects: - url: /v1/campaigns/{broadcast_id}/triggers method: triggerBroadcast diff --git a/sdks/db/cached-method-objects/from-custom-request_customer.io_JourneysTrack.yaml b/sdks/db/cached-method-objects/from-custom-request_customer.io_JourneysTrack.yaml index c544b0b2b8..de6aa43103 100644 --- a/sdks/db/cached-method-objects/from-custom-request_customer.io_JourneysTrack.yaml +++ b/sdks/db/cached-method-objects/from-custom-request_customer.io_JourneysTrack.yaml @@ -1,4 +1,4 @@ -hash: e27457a55ca7e2421f0ddf0eb95b035a77ad1d3520c27bd09c21fc78b9e43dc4 +hash: d02c8867da7caa07720e6d6e8eef7420e2e17f50832d77c0c0bf66642e12fc0e methodObjects: - url: /api/v1/accounts/region method: findAccountRegion diff --git a/sdks/db/cached-method-objects/from-custom-request_digitalocean.com.yaml b/sdks/db/cached-method-objects/from-custom-request_digitalocean.com.yaml index d1734b5116..5194d3d544 100644 --- a/sdks/db/cached-method-objects/from-custom-request_digitalocean.com.yaml +++ b/sdks/db/cached-method-objects/from-custom-request_digitalocean.com.yaml @@ -1,4 +1,4 @@ -hash: 16a87aa09d8ba0f424f316708477b839d59b9c8426428dfd08ff7533bca75977 +hash: 34dbab87b60c92915d6c3607dcc8bf6809b49decfea3b148ee3ad76080242646 methodObjects: - url: /v2/1-clicks method: list @@ -2602,7 +2602,9 @@ methodObjects: httpMethod: get tag: Databases typeScriptTag: databases - description: List Connection Pools (PostgreSQL) + description: >- + List Connection Pools + (https://docs.digitalocean.com/reference/api/api-reference/ parameters: - name: databaseClusterUuid schema: string @@ -2627,7 +2629,9 @@ methodObjects: httpMethod: post tag: Databases typeScriptTag: databases - description: Add a New Connection Pool (PostgreSQL) + description: >- + Add a New Connection Pool + (https://docs.digitalocean.com/reference/api/api-reference/ parameters: - name: databaseClusterUuid schema: string @@ -2693,7 +2697,9 @@ methodObjects: httpMethod: delete tag: Databases typeScriptTag: databases - description: Delete a Connection Pool (PostgreSQL) + description: >- + Delete a Connection Pool + (https://docs.digitalocean.com/reference/api/api-reference/ parameters: - name: databaseClusterUuid schema: string @@ -2723,7 +2729,9 @@ methodObjects: httpMethod: get tag: Databases typeScriptTag: databases - description: Retrieve Existing Connection Pool (PostgreSQL) + description: >- + Retrieve Existing Connection Pool + (https://docs.digitalocean.com/reference/api/api-reference/ parameters: - name: databaseClusterUuid schema: string @@ -2753,7 +2761,9 @@ methodObjects: httpMethod: put tag: Databases typeScriptTag: databases - description: Update Connection Pools (PostgreSQL) + description: >- + Update Connection Pools + (https://docs.digitalocean.com/reference/api/api-reference/ parameters: - name: databaseClusterUuid schema: string @@ -4076,7 +4086,9 @@ methodObjects: httpMethod: delete tag: Droplets typeScriptTag: droplets - description: Destroy a Droplet and All of its Associated Resources (Dangerous) + description: >- + Destroy a Droplet and All of its Associated Resources + (https://docs.digitalocean.com/reference/api/api-reference/ parameters: - name: dropletId schema: integer @@ -5057,12 +5069,18 @@ methodObjects: - name: imageId schema: undefined required: true - description: | - A unique number (id) or string (slug) used to identify and reference a + description: > + A unique number + (https://docs.digitalocean.com/reference/api/api-reference/ or string + (https://docs.digitalocean.com/reference/api/api-reference/ used to + identify and reference a + specific image. + **Public** images can be identified by image `id` or `slug`. + **Private** images *must* be identified by image `id`. responses: - statusCode: '200' @@ -5536,7 +5554,9 @@ methodObjects: httpMethod: delete tag: Kubernetes typeScriptTag: kubernetes - description: Delete a Cluster and All of its Associated Resources (Dangerous) + description: >- + Delete a Cluster and All of its Associated Resources + (https://docs.digitalocean.com/reference/api/api-reference/ parameters: - name: clusterId schema: string @@ -6638,12 +6658,12 @@ methodObjects: - name: start schema: string required: true - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. example: '1620683817' - name: end schema: string required: true - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. example: '1620705417' responses: - statusCode: '200' @@ -6671,12 +6691,12 @@ methodObjects: - name: start schema: string required: true - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. example: '1620683817' - name: end schema: string required: true - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. example: '1620705417' responses: - statusCode: '200' @@ -6704,12 +6724,12 @@ methodObjects: - name: start schema: string required: true - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. example: '1620683817' - name: end schema: string required: true - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. example: '1620705417' responses: - statusCode: '200' @@ -6737,12 +6757,12 @@ methodObjects: - name: start schema: string required: true - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. example: '1620683817' - name: end schema: string required: true - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. example: '1620705417' responses: - statusCode: '200' @@ -6770,12 +6790,12 @@ methodObjects: - name: start schema: string required: true - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. example: '1620683817' - name: end schema: string required: true - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. example: '1620705417' responses: - statusCode: '200' @@ -6803,12 +6823,12 @@ methodObjects: - name: start schema: string required: true - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. example: '1620683817' - name: end schema: string required: true - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. example: '1620705417' responses: - statusCode: '200' @@ -6836,12 +6856,12 @@ methodObjects: - name: start schema: string required: true - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. example: '1620683817' - name: end schema: string required: true - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. example: '1620705417' responses: - statusCode: '200' @@ -6869,12 +6889,12 @@ methodObjects: - name: start schema: string required: true - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. example: '1620683817' - name: end schema: string required: true - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. example: '1620705417' responses: - statusCode: '200' @@ -6902,12 +6922,12 @@ methodObjects: - name: start schema: string required: true - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. example: '1620683817' - name: end schema: string required: true - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. example: '1620705417' responses: - statusCode: '200' @@ -6935,12 +6955,12 @@ methodObjects: - name: start schema: string required: true - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. example: '1620683817' - name: end schema: string required: true - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. example: '1620705417' responses: - statusCode: '200' @@ -6968,12 +6988,12 @@ methodObjects: - name: start schema: string required: true - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. example: '1620683817' - name: end schema: string required: true - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. example: '1620705417' responses: - statusCode: '200' @@ -7006,12 +7026,12 @@ methodObjects: - name: start schema: string required: true - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. example: '1620683817' - name: end schema: string required: true - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. example: '1620705417' responses: - statusCode: '200' @@ -7044,12 +7064,12 @@ methodObjects: - name: start schema: string required: true - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. example: '1620683817' - name: end schema: string required: true - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. example: '1620705417' responses: - statusCode: '200' @@ -7082,12 +7102,12 @@ methodObjects: - name: start schema: string required: true - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. example: '1620683817' - name: end schema: string required: true - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. example: '1620705417' responses: - statusCode: '200' @@ -7699,7 +7719,9 @@ methodObjects: httpMethod: get tag: Container Registry typeScriptTag: containerRegistry - description: List All Container Registry Repositories (V2) + description: >- + List All Container Registry Repositories + (https://docs.digitalocean.com/reference/api/api-reference/ parameters: - name: perPage schema: integer diff --git a/sdks/db/cached-method-objects/from-custom-request_hsbc.com_AccountInformationCE.yaml b/sdks/db/cached-method-objects/from-custom-request_hsbc.com_AccountInformationCE.yaml index 8716b591ea..277bf3ec42 100644 --- a/sdks/db/cached-method-objects/from-custom-request_hsbc.com_AccountInformationCE.yaml +++ b/sdks/db/cached-method-objects/from-custom-request_hsbc.com_AccountInformationCE.yaml @@ -1,4 +1,4 @@ -hash: 1c0a9473f06102d1e1d8bf55fe1f2907ff0cd988c772af91f99174f8f0cf42b7 +hash: 064e119af60cdbe727c4f7e22e701706190997d0d4db6d1498cd45eadfa12c22 methodObjects: - url: /account-access-consents method: createConsent diff --git a/sdks/db/cached-method-objects/from-custom-request_pappers.fr.yaml b/sdks/db/cached-method-objects/from-custom-request_pappers.fr.yaml new file mode 100644 index 0000000000..3cc370cbd2 --- /dev/null +++ b/sdks/db/cached-method-objects/from-custom-request_pappers.fr.yaml @@ -0,0 +1,2526 @@ +hash: 69cb1d9a13dcb6dcb381751aa31f9893495784925bf171211007a39f3b2ea3df +methodObjects: + - url: /entreprise + method: getInformation + httpMethod: get + tag: Fiche entreprise + typeScriptTag: ficheEntreprise + description: Récupère l'ensemble des informations disponibles sur une entreprise. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: siren + schema: string + required: false + description: SIREN de l'entreprise + example: 443061841 + - name: siret + schema: string + required: false + description: SIRET de l'entreprise + example: 44306184100047 + - name: integrerDiffusionsPartielles + schema: boolean + required: false + description: >- + Si vrai et si l'entreprise est en diffusion partielle, le retour + renverra les informations partielles disponibles. Valeur par défaut : + `false`. + - name: formatPublicationsBodacc + schema: string + required: false + description: >- + Format attendu pour les publications BODACC. Valeur par défaut : + `"objet"`. + example: objet + - name: marques + schema: boolean + required: false + description: >- + Si vrai, le retour inclura les marques éventuelles de l'entreprise. + Valeur par défaut : `false`. + - name: validiteTvaIntracommunautaire + schema: boolean + required: false + 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: publicationsBodaccBrutes + schema: boolean + required: false + 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: champsSupplementaires + schema: string + required: false + 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. + example: site_internet,telephone + responses: + - statusCode: '200' + description: '' + - statusCode: '206' + description: '' + - statusCode: '400' + description: Paramètres de la requête incorrects. + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '404' + description: Entreprise inexistante. + - url: /association + method: getInfo + httpMethod: get + tag: Fiche association + typeScriptTag: ficheAssociation + description: Récupère l'ensemble des informations disponibles sur une association. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: idAssociation + schema: string + required: false + description: Identifiant de l'association + example: W142005389 + - name: siret + schema: string + required: false + description: SIRET de l'association + example: 95037097300014 + - name: siren + schema: string + required: false + description: SIREN de l'association + example: 950370973 + responses: + - statusCode: '200' + description: Association liée à l'entreprise. + - statusCode: '400' + description: Paramètres de la requête incorrects. + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '404' + description: Association inexistante. + - statusCode: '503' + description: Service momentanément indisponible. + - url: /recherche + method: criteriaEnterprisesGet + httpMethod: get + tag: Recherche + typeScriptTag: recherche + description: Recherche les entreprises qui correspondent à des critères. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: page + schema: integer + required: false + description: 'Page de résultats. Valeur par défaut : `1`.' + example: 1 + - name: parPage + schema: integer + required: false + description: 'Nombre de résultats affichés sur une page. Valeur par défaut : `10`.' + example: 20 + - name: curseur + schema: string + required: false + description: >- + Curseur servant à parcourir l'ensemble des résultats (alternativement + à la pagination qui est limitée à 400 résultats maximum). Doit valoir + `*` pour la première requête, et doit pour les requêtes suivantes + reprendre la valeur `curseurSuivant` retournée par la dernière + réponse. + example: '*' + - name: parCurseur + schema: integer + required: false + description: >- + Nombre de résultats affichés par curseur. Valeur par défaut : `50`. + Valeur minimale: `1`. Valeur maximale : `1000`. + example: 20 + - name: bases + schema: string + required: false + description: >- + Bases de données dans lesquelles rechercher. Il est possible + d'indiquer plusieurs bases en les séparant par des virgules. Valeur + par défaut : `"entreprises"`. + example: entreprises + - name: precision + schema: string + required: false + description: 'Niveau de précision de la recherche. Valeur par défaut : `"standard"`.' + example: standard + - name: q + schema: string + required: false + 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. + example: Google France + - name: siege + schema: string + required: false + description: Défini si la requête se base sur le siège + example: 'true' + - name: codeNaf + schema: string + required: false + description: >- + Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes + NAF en les séparant par des virgules. + example: 70.10Z + - name: departement + schema: string + required: false + description: >- + Numéro de département de l'un des établissements de l'entreprise. Il + est possible d'indiquer plusieurs départements en les séparant par des + virgules. + example: 75 + - name: region + schema: string + required: false + description: >- + Code de la région de l'un des établissements de l'entreprise, selon la + [nomenclature + Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il + est possible d'indiquer plusieurs codes régions en les séparant par + des virgules. + example: 11 + - name: codePostal + schema: string + required: false + description: >- + Code postal de l'un des établissements de l'entreprise. Il est + possible d'indiquer plusieurs codes postaux en les séparant par des + virgules. + example: 75009 + - name: conventionCollective + schema: string + required: false + description: Convention collective de l'entreprise. + example: 1486 + - name: categorieJuridique + schema: string + required: false + description: >- + Catégorie juridique de l'entreprise, selon la [nomenclature + Insee](https://www.insee.fr/fr/information/2028129). + + + **Note** : Le code correspond à celui de l'INSEE, à l'exception des + SASU qui auront comme code 5720 et les EURL qui auront comme code + 5498. + example: 5499 + - name: entrepriseCessee + schema: boolean + required: false + description: Activité de l'entreprise cessée ou non. + example: false + - name: statutRcs + schema: string + required: false + description: Statut au RCS + example: inscrit + - name: objetSocial + schema: string + required: false + description: Objet social de l'entreprise déclaré au RCS. + example: La conception de moteurs de recherche sur internet. + - name: dateImmatriculationRcsMin + schema: string + required: false + description: >- + Date d'immatriculation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + example: 15-05-2002 + - name: dateImmatriculationRcsMax + schema: string + required: false + description: >- + d'immatriculation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + example: 15-05-2002 + - name: dateRadiationRcsMin + schema: string + required: false + description: >- + Date de radiation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + example: 15-05-2002 + - name: dateRadiationRcsMax + schema: string + required: false + description: >- + Date de radiation au RCS maximale de l'entreprise, au format + JJ-MM-AAAA. + example: 17-05-2002 + - name: capitalMin + schema: string + required: false + description: Capital minimum de l'entreprise. + example: 411016200 + - name: capitalMax + schema: string + required: false + description: Capital maximum de l'entreprise. + example: 411016400 + - name: chiffreAffairesMin + schema: string + required: false + description: >- + Chiffre d'affaires minimum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 411016200 + - name: chiffreAffairesMax + schema: string + required: false + description: >- + Chiffre d'affaires maximum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 411016400 + - name: resultatMin + schema: string + required: false + description: >- + Résultat minimum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 29327000 + - name: resultatMax + schema: string + required: false + description: >- + Résultat maximum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 29327100 + - name: dateCreationMin + schema: string + required: false + description: Date de création minimale de l'entreprise, au format JJ-MM-AAAA. + example: 15-05-2002 + - name: dateCreationMax + schema: string + required: false + description: Date de création maximale de l'entreprise, au format JJ-MM-AAAA. + example: 17-05-2002 + - name: trancheEffectifMin + schema: string + required: false + description: >- + Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen). + + + **Note** : 00 ou NN donneront les mêmes résultats et veulent dire non + employeur + example: 40 + - name: trancheEffectifMax + schema: string + required: false + description: >- + Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen). + + + **Note** : 00 ou NN donneront les mêmes résultats et veulent dire non + employeur + example: 42 + - name: typeDirigeant + schema: string + required: false + description: >- + Type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + example: physique + - name: qualiteDirigeant + schema: string + required: false + description: >- + Qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + example: Administrateur + - name: nationaliteDirigeant + schema: string + required: false + description: >- + Nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise + pour une recherche d'entreprises). + example: Française + - name: nomDirigeant + schema: string + required: false + description: >- + Nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + example: Yi + - name: prenomDirigeant + schema: string + required: false + description: >- + Prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + example: Kenneth H. + - name: ageDirigeantMin + schema: integer + required: false + description: >- + Âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise + pour une recherche d'entreprises). + example: 40 + - name: ageDirigeantMax + schema: integer + required: false + description: >- + Âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise + pour une recherche d'entreprises). + example: 42 + - name: dateDeNaissanceDirigeantMin + schema: string + required: false + description: >- + Date de naissance minimale du dirigeant (ou de l'un des dirigeants de + l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA. + example: '1970-01-01T00:00:00.000Z' + - name: dateDeNaissanceDirigeantMax + schema: string + required: false + description: >- + Date de naissance maximale du dirigeant (ou de l'un des dirigeants de + l'entreprise pour une recherche d'entreprises) de l'entreprise, au + format JJ-MM-AAAA. + example: '1970-12-31T00:00:00.000Z' + - name: ageBeneficiaireMin + schema: integer + required: false + description: >- + Âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + example: 40 + - name: ageBeneficiaireMax + schema: integer + required: false + description: >- + Âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + example: 42 + - name: dateDeNaissanceBeneficiaireMin + schema: string + required: false + description: >- + Date de naissance minimale du bénéficiaire effectif (ou de l'un des + bénéficiaires effectifs de l'entreprise pour une recherche + d'entreprises), au format JJ-MM-AAAA. + example: '1970-01-01T00:00:00.000Z' + - name: dateDeNaissanceBeneficiaireMax + schema: string + required: false + description: >- + Date de naissance maximale du bénéficiaire effectif (ou de l'un des + bénéficiaires effectifs de l'entreprise pour une recherche + d'entreprises) de l'entreprise, au format JJ-MM-AAAA. + example: '1970-12-31T00:00:00.000Z' + - name: nationaliteBeneficiaire + schema: string + required: false + description: >- + Nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + example: Française + - name: dateDepotDocumentMin + schema: string + required: false + description: Date de dépôt minimale du document, au format JJ-MM-AAAA. + example: '2000-01-01T00:00:00.000Z' + - name: dateDepotDocumentMax + schema: string + required: false + description: Date de dépôt maximale du document, au format JJ-MM-AAAA. + example: '2000-12-31T00:00:00.000Z' + - name: typePublication + schema: string + required: false + description: Type de publication + example: Procédure collective + - name: datePublicationMin + schema: string + required: false + description: Date publication minimale de la publication, au format JJ-MM-AAAA. + example: '2000-01-01T00:00:00.000Z' + - name: datePublicationMax + schema: string + required: false + description: Date de publication maximale de la publication, au format JJ-MM-AAAA. + example: '2000-12-31T00:00:00.000Z' + responses: + - statusCode: '200' + description: '' + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '404' + description: Aucune entreprise ne correspond aux critères indiqués. + - statusCode: '503' + description: Service momentanément indisponible. + - url: /recherche-dirigeants + method: leadersSearchCriteriaGet + httpMethod: get + tag: Recherche + typeScriptTag: recherche + description: Recherche les dirigeants qui correspondent à des critères. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: parPage + schema: integer + required: false + description: 'Nombre de résultats affichés sur une page. Valeur par défaut : `10`.' + example: 20 + - name: page + schema: integer + required: false + description: 'Page de résultats. Valeur par défaut : `1`.' + example: 1 + - name: precision + schema: string + required: false + description: 'Niveau de précision de la recherche. Valeur par défaut : `"standard"`.' + example: standard + - name: q + schema: string + required: false + description: >- + Texte à rechercher. Nom et prénom du dirigeant pour une personne + physique, dénomination pour une personne morale. + example: Google France + - name: typeDirigeant + schema: string + required: false + description: >- + Type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + example: physique + - name: qualiteDirigeant + schema: string + required: false + description: >- + Qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + example: Administrateur + - name: nationaliteDirigeant + schema: string + required: false + description: >- + Nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise + pour une recherche d'entreprises). + example: Française + - name: nomDirigeant + schema: string + required: false + description: >- + Nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + example: Yi + - name: prenomDirigeant + schema: string + required: false + description: >- + Prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + example: Kenneth H. + - name: ageDirigeantMin + schema: integer + required: false + description: >- + Âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise + pour une recherche d'entreprises). + example: 40 + - name: ageDirigeantMax + schema: integer + required: false + description: >- + Âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise + pour une recherche d'entreprises). + example: 42 + - name: dateDeNaissanceDirigeantMin + schema: string + required: false + description: >- + Date de naissance minimale du dirigeant (ou de l'un des dirigeants de + l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA. + example: '1970-01-01T00:00:00.000Z' + - name: dateDeNaissanceDirigeantMax + schema: string + required: false + description: >- + Date de naissance maximale du dirigeant (ou de l'un des dirigeants de + l'entreprise pour une recherche d'entreprises) de l'entreprise, au + format JJ-MM-AAAA. + example: '1970-12-31T00:00:00.000Z' + - name: codeNaf + schema: string + required: false + description: >- + Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes + NAF en les séparant par des virgules. + example: 70.10Z + - name: departement + schema: string + required: false + description: >- + Numéro de département de l'un des établissements de l'entreprise. Il + est possible d'indiquer plusieurs départements en les séparant par des + virgules. + example: 75 + - name: region + schema: string + required: false + description: >- + Code de la région de l'un des établissements de l'entreprise, selon la + [nomenclature + Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il + est possible d'indiquer plusieurs codes régions en les séparant par + des virgules. + example: 11 + - name: codePostal + schema: string + required: false + description: >- + Code postal de l'un des établissements de l'entreprise. Il est + possible d'indiquer plusieurs codes postaux en les séparant par des + virgules. + example: 75009 + - name: conventionCollective + schema: string + required: false + description: Convention collective de l'entreprise. + example: 1486 + - name: categorieJuridique + schema: string + required: false + description: >- + Catégorie juridique de l'entreprise, selon la [nomenclature + Insee](https://www.insee.fr/fr/information/2028129). + + + **Note** : Le code correspond à celui de l'INSEE, à l'exception des + SASU qui auront comme code 5720 et les EURL qui auront comme code + 5498. + example: 5499 + - name: entrepriseCessee + schema: boolean + required: false + description: Activité de l'entreprise cessée ou non. + example: false + - name: statutRcs + schema: string + required: false + description: Statut au RCS + example: inscrit + - name: objetSocial + schema: string + required: false + description: Objet social de l'entreprise déclaré au RCS. + example: La conception de moteurs de recherche sur internet. + - name: dateImmatriculationRcsMin + schema: string + required: false + description: >- + Date d'immatriculation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + example: 15-05-2002 + - name: dateImmatriculationRcsMax + schema: string + required: false + description: >- + d'immatriculation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + example: 15-05-2002 + - name: dateRadiationRcsMin + schema: string + required: false + description: >- + Date de radiation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + example: 15-05-2002 + - name: dateRadiationRcsMax + schema: string + required: false + description: >- + Date de radiation au RCS maximale de l'entreprise, au format + JJ-MM-AAAA. + example: 17-05-2002 + - name: capitalMin + schema: string + required: false + description: Capital minimum de l'entreprise. + example: 411016200 + - name: capitalMax + schema: string + required: false + description: Capital maximum de l'entreprise. + example: 411016400 + - name: chiffreAffairesMin + schema: string + required: false + description: >- + Chiffre d'affaires minimum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 411016200 + - name: chiffreAffairesMax + schema: string + required: false + description: >- + Chiffre d'affaires maximum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 411016400 + - name: resultatMin + schema: string + required: false + description: >- + Résultat minimum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 29327000 + - name: resultatMax + schema: string + required: false + description: >- + Résultat maximum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 29327100 + - name: dateCreationMin + schema: string + required: false + description: Date de création minimale de l'entreprise, au format JJ-MM-AAAA. + example: 15-05-2002 + - name: dateCreationMax + schema: string + required: false + description: Date de création maximale de l'entreprise, au format JJ-MM-AAAA. + example: 17-05-2002 + - name: trancheEffectifMin + schema: string + required: false + description: >- + Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen). + + + **Note** : 00 ou NN donneront les mêmes résultats et veulent dire non + employeur + example: 40 + - name: trancheEffectifMax + schema: string + required: false + description: >- + Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen). + + + **Note** : 00 ou NN donneront les mêmes résultats et veulent dire non + employeur + example: 42 + - name: ageBeneficiaireMin + schema: integer + required: false + description: >- + Âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + example: 40 + - name: ageBeneficiaireMax + schema: integer + required: false + description: >- + Âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + example: 42 + - name: dateDeNaissanceBeneficiaireMin + schema: string + required: false + description: >- + Date de naissance minimale du bénéficiaire effectif (ou de l'un des + bénéficiaires effectifs de l'entreprise pour une recherche + d'entreprises), au format JJ-MM-AAAA. + example: '1970-01-01T00:00:00.000Z' + - name: dateDeNaissanceBeneficiaireMax + schema: string + required: false + description: >- + Date de naissance maximale du bénéficiaire effectif (ou de l'un des + bénéficiaires effectifs de l'entreprise pour une recherche + d'entreprises) de l'entreprise, au format JJ-MM-AAAA. + example: '1970-12-31T00:00:00.000Z' + - name: nationaliteBeneficiaire + schema: string + required: false + description: >- + Nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + example: Française + - name: dateDepotDocumentMin + schema: string + required: false + description: Date de dépôt minimale du document, au format JJ-MM-AAAA. + example: '2000-01-01T00:00:00.000Z' + - name: dateDepotDocumentMax + schema: string + required: false + description: Date de dépôt maximale du document, au format JJ-MM-AAAA. + example: '2000-12-31T00:00:00.000Z' + - name: typePublication + schema: string + required: false + description: Type de publication + example: Procédure collective + - name: datePublicationMin + schema: string + required: false + description: Date publication minimale de la publication, au format JJ-MM-AAAA. + example: '2000-01-01T00:00:00.000Z' + - name: datePublicationMax + schema: string + required: false + description: Date de publication maximale de la publication, au format JJ-MM-AAAA. + example: '2000-12-31T00:00:00.000Z' + - name: siren + schema: string + required: false + description: SIREN de l'entreprise. + example: null + responses: + - statusCode: '200' + description: '' + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '404' + description: Aucun dirigeant ne correspond aux critères indiqués. + - statusCode: '503' + description: Service momentanément indisponible. + - url: /recherche-beneficiaires + method: effectiveBeneficiariesSearch + httpMethod: get + tag: Recherche + typeScriptTag: recherche + description: Recherche les bénéficiaires effectifs qui correspondent à des critères. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: parPage + schema: integer + required: false + description: 'Nombre de résultats affichés sur une page. Valeur par défaut : `10`.' + example: 20 + - name: page + schema: integer + required: false + description: 'Page de résultats. Valeur par défaut : `1`.' + example: 1 + - name: precision + schema: string + required: false + description: 'Niveau de précision de la recherche. Valeur par défaut : `"standard"`.' + example: standard + - name: q + schema: string + required: false + description: Nom et/ou prénom du bénéficiaire effectif. + example: Xavier Niel + - name: ageBeneficiaireMin + schema: integer + required: false + description: >- + Âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + example: 40 + - name: ageBeneficiaireMax + schema: integer + required: false + description: >- + Âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + example: 42 + - name: dateDeNaissanceBeneficiaireMin + schema: string + required: false + description: >- + Date de naissance minimale du bénéficiaire effectif (ou de l'un des + bénéficiaires effectifs de l'entreprise pour une recherche + d'entreprises), au format JJ-MM-AAAA. + example: '1970-01-01T00:00:00.000Z' + - name: dateDeNaissanceBeneficiaireMax + schema: string + required: false + description: >- + Date de naissance maximale du bénéficiaire effectif (ou de l'un des + bénéficiaires effectifs de l'entreprise pour une recherche + d'entreprises) de l'entreprise, au format JJ-MM-AAAA. + example: '1970-12-31T00:00:00.000Z' + - name: nationaliteBeneficiaire + schema: string + required: false + description: >- + Nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + example: Française + - name: codeNaf + schema: string + required: false + description: >- + Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes + NAF en les séparant par des virgules. + example: 70.10Z + - name: departement + schema: string + required: false + description: >- + Numéro de département de l'un des établissements de l'entreprise. Il + est possible d'indiquer plusieurs départements en les séparant par des + virgules. + example: 75 + - name: region + schema: string + required: false + description: >- + Code de la région de l'un des établissements de l'entreprise, selon la + [nomenclature + Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il + est possible d'indiquer plusieurs codes régions en les séparant par + des virgules. + example: 11 + - name: codePostal + schema: string + required: false + description: >- + Code postal de l'un des établissements de l'entreprise. Il est + possible d'indiquer plusieurs codes postaux en les séparant par des + virgules. + example: 75009 + - name: conventionCollective + schema: string + required: false + description: Convention collective de l'entreprise. + example: 1486 + - name: categorieJuridique + schema: string + required: false + description: >- + Catégorie juridique de l'entreprise, selon la [nomenclature + Insee](https://www.insee.fr/fr/information/2028129). + + + **Note** : Le code correspond à celui de l'INSEE, à l'exception des + SASU qui auront comme code 5720 et les EURL qui auront comme code + 5498. + example: 5499 + - name: entrepriseCessee + schema: boolean + required: false + description: Activité de l'entreprise cessée ou non. + example: false + - name: statutRcs + schema: string + required: false + description: Statut au RCS + example: inscrit + - name: objetSocial + schema: string + required: false + description: Objet social de l'entreprise déclaré au RCS. + example: La conception de moteurs de recherche sur internet. + - name: dateImmatriculationRcsMin + schema: string + required: false + description: >- + Date d'immatriculation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + example: 15-05-2002 + - name: dateImmatriculationRcsMax + schema: string + required: false + description: >- + d'immatriculation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + example: 15-05-2002 + - name: dateRadiationRcsMin + schema: string + required: false + description: >- + Date de radiation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + example: 15-05-2002 + - name: dateRadiationRcsMax + schema: string + required: false + description: >- + Date de radiation au RCS maximale de l'entreprise, au format + JJ-MM-AAAA. + example: 17-05-2002 + - name: capitalMin + schema: string + required: false + description: Capital minimum de l'entreprise. + example: 411016200 + - name: capitalMax + schema: string + required: false + description: Capital maximum de l'entreprise. + example: 411016400 + - name: chiffreAffairesMin + schema: string + required: false + description: >- + Chiffre d'affaires minimum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 411016200 + - name: chiffreAffairesMax + schema: string + required: false + description: >- + Chiffre d'affaires maximum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 411016400 + - name: resultatMin + schema: string + required: false + description: >- + Résultat minimum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 29327000 + - name: resultatMax + schema: string + required: false + description: >- + Résultat maximum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 29327100 + - name: dateCreationMin + schema: string + required: false + description: Date de création minimale de l'entreprise, au format JJ-MM-AAAA. + example: 15-05-2002 + - name: dateCreationMax + schema: string + required: false + description: Date de création maximale de l'entreprise, au format JJ-MM-AAAA. + example: 17-05-2002 + - name: trancheEffectifMin + schema: string + required: false + description: >- + Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen). + + + **Note** : 00 ou NN donneront les mêmes résultats et veulent dire non + employeur + example: 40 + - name: trancheEffectifMax + schema: string + required: false + description: >- + Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen). + + + **Note** : 00 ou NN donneront les mêmes résultats et veulent dire non + employeur + example: 42 + - name: typeDirigeant + schema: string + required: false + description: >- + Type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + example: physique + - name: qualiteDirigeant + schema: string + required: false + description: >- + Qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + example: Administrateur + - name: nationaliteDirigeant + schema: string + required: false + description: >- + Nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise + pour une recherche d'entreprises). + example: Française + - name: nomDirigeant + schema: string + required: false + description: >- + Nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + example: Yi + - name: prenomDirigeant + schema: string + required: false + description: >- + Prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + example: Kenneth H. + - name: ageDirigeantMin + schema: integer + required: false + description: >- + Âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise + pour une recherche d'entreprises). + example: 40 + - name: ageDirigeantMax + schema: integer + required: false + description: >- + Âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise + pour une recherche d'entreprises). + example: 42 + - name: dateDeNaissanceDirigeantMin + schema: string + required: false + description: >- + Date de naissance minimale du dirigeant (ou de l'un des dirigeants de + l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA. + example: '1970-01-01T00:00:00.000Z' + - name: dateDeNaissanceDirigeantMax + schema: string + required: false + description: >- + Date de naissance maximale du dirigeant (ou de l'un des dirigeants de + l'entreprise pour une recherche d'entreprises) de l'entreprise, au + format JJ-MM-AAAA. + example: '1970-12-31T00:00:00.000Z' + - name: dateDepotDocumentMin + schema: string + required: false + description: Date de dépôt minimale du document, au format JJ-MM-AAAA. + example: '2000-01-01T00:00:00.000Z' + - name: dateDepotDocumentMax + schema: string + required: false + description: Date de dépôt maximale du document, au format JJ-MM-AAAA. + example: '2000-12-31T00:00:00.000Z' + - name: typePublication + schema: string + required: false + description: Type de publication + example: Procédure collective + - name: datePublicationMin + schema: string + required: false + description: Date publication minimale de la publication, au format JJ-MM-AAAA. + example: '2000-01-01T00:00:00.000Z' + - name: datePublicationMax + schema: string + required: false + description: Date de publication maximale de la publication, au format JJ-MM-AAAA. + example: '2000-12-31T00:00:00.000Z' + - name: siren + schema: string + required: false + description: SIREN de l'entreprise. + example: null + responses: + - statusCode: '200' + description: '' + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '404' + description: Aucun bénéficiaire effectif ne correspond aux critères indiqués. + - statusCode: '503' + description: Service momentanément indisponible. + - url: /recherche-documents + method: matchingDocumentsGet + httpMethod: get + tag: Recherche + typeScriptTag: recherche + description: Recherche les documents qui correspondent à des critères. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: parPage + schema: integer + required: false + description: 'Nombre de résultats affichés sur une page. Valeur par défaut : `10`.' + example: 20 + - name: page + schema: integer + required: false + description: 'Page de résultats. Valeur par défaut : `1`.' + example: 1 + - name: precision + schema: string + required: false + description: 'Niveau de précision de la recherche. Valeur par défaut : `"standard"`.' + example: standard + - name: q + schema: string + required: false + description: Mot-clé à rechercher dans le contenu du document. + example: Rémunération + - name: dateDepotDocumentMin + schema: string + required: false + description: Date de dépôt minimale du document, au format JJ-MM-AAAA. + example: '2000-01-01T00:00:00.000Z' + - name: dateDepotDocumentMax + schema: string + required: false + description: Date de dépôt maximale du document, au format JJ-MM-AAAA. + example: '2000-12-31T00:00:00.000Z' + - name: codeNaf + schema: string + required: false + description: >- + Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes + NAF en les séparant par des virgules. + example: 70.10Z + - name: departement + schema: string + required: false + description: >- + Numéro de département de l'un des établissements de l'entreprise. Il + est possible d'indiquer plusieurs départements en les séparant par des + virgules. + example: 75 + - name: region + schema: string + required: false + description: >- + Code de la région de l'un des établissements de l'entreprise, selon la + [nomenclature + Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il + est possible d'indiquer plusieurs codes régions en les séparant par + des virgules. + example: 11 + - name: codePostal + schema: string + required: false + description: >- + Code postal de l'un des établissements de l'entreprise. Il est + possible d'indiquer plusieurs codes postaux en les séparant par des + virgules. + example: 75009 + - name: conventionCollective + schema: string + required: false + description: Convention collective de l'entreprise. + example: 1486 + - name: categorieJuridique + schema: string + required: false + description: >- + Catégorie juridique de l'entreprise, selon la [nomenclature + Insee](https://www.insee.fr/fr/information/2028129). + + + **Note** : Le code correspond à celui de l'INSEE, à l'exception des + SASU qui auront comme code 5720 et les EURL qui auront comme code + 5498. + example: 5499 + - name: entrepriseCessee + schema: boolean + required: false + description: Activité de l'entreprise cessée ou non. + example: false + - name: statutRcs + schema: string + required: false + description: Statut au RCS + example: inscrit + - name: objetSocial + schema: string + required: false + description: Objet social de l'entreprise déclaré au RCS. + example: La conception de moteurs de recherche sur internet. + - name: dateImmatriculationRcsMin + schema: string + required: false + description: >- + Date d'immatriculation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + example: 15-05-2002 + - name: dateImmatriculationRcsMax + schema: string + required: false + description: >- + d'immatriculation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + example: 15-05-2002 + - name: dateRadiationRcsMin + schema: string + required: false + description: >- + Date de radiation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + example: 15-05-2002 + - name: dateRadiationRcsMax + schema: string + required: false + description: >- + Date de radiation au RCS maximale de l'entreprise, au format + JJ-MM-AAAA. + example: 17-05-2002 + - name: capitalMin + schema: string + required: false + description: Capital minimum de l'entreprise. + example: 411016200 + - name: capitalMax + schema: string + required: false + description: Capital maximum de l'entreprise. + example: 411016400 + - name: chiffreAffairesMin + schema: string + required: false + description: >- + Chiffre d'affaires minimum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 411016200 + - name: chiffreAffairesMax + schema: string + required: false + description: >- + Chiffre d'affaires maximum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 411016400 + - name: resultatMin + schema: string + required: false + description: >- + Résultat minimum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 29327000 + - name: resultatMax + schema: string + required: false + description: >- + Résultat maximum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 29327100 + - name: dateCreationMin + schema: string + required: false + description: Date de création minimale de l'entreprise, au format JJ-MM-AAAA. + example: 15-05-2002 + - name: dateCreationMax + schema: string + required: false + description: Date de création maximale de l'entreprise, au format JJ-MM-AAAA. + example: 17-05-2002 + - name: trancheEffectifMin + schema: string + required: false + description: >- + Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen). + + + **Note** : 00 ou NN donneront les mêmes résultats et veulent dire non + employeur + example: 40 + - name: trancheEffectifMax + schema: string + required: false + description: >- + Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen). + + + **Note** : 00 ou NN donneront les mêmes résultats et veulent dire non + employeur + example: 42 + - name: typeDirigeant + schema: string + required: false + description: >- + Type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + example: physique + - name: qualiteDirigeant + schema: string + required: false + description: >- + Qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + example: Administrateur + - name: nationaliteDirigeant + schema: string + required: false + description: >- + Nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise + pour une recherche d'entreprises). + example: Française + - name: nomDirigeant + schema: string + required: false + description: >- + Nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + example: Yi + - name: prenomDirigeant + schema: string + required: false + description: >- + Prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + example: Kenneth H. + - name: ageDirigeantMin + schema: integer + required: false + description: >- + Âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise + pour une recherche d'entreprises). + example: 40 + - name: ageDirigeantMax + schema: integer + required: false + description: >- + Âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise + pour une recherche d'entreprises). + example: 42 + - name: dateDeNaissanceDirigeantMin + schema: string + required: false + description: >- + Date de naissance minimale du dirigeant (ou de l'un des dirigeants de + l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA. + example: '1970-01-01T00:00:00.000Z' + - name: dateDeNaissanceDirigeantMax + schema: string + required: false + description: >- + Date de naissance maximale du dirigeant (ou de l'un des dirigeants de + l'entreprise pour une recherche d'entreprises) de l'entreprise, au + format JJ-MM-AAAA. + example: '1970-12-31T00:00:00.000Z' + - name: ageBeneficiaireMin + schema: integer + required: false + description: >- + Âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + example: 40 + - name: ageBeneficiaireMax + schema: integer + required: false + description: >- + Âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + example: 42 + - name: dateDeNaissanceBeneficiaireMin + schema: string + required: false + description: >- + Date de naissance minimale du bénéficiaire effectif (ou de l'un des + bénéficiaires effectifs de l'entreprise pour une recherche + d'entreprises), au format JJ-MM-AAAA. + example: '1970-01-01T00:00:00.000Z' + - name: dateDeNaissanceBeneficiaireMax + schema: string + required: false + description: >- + Date de naissance maximale du bénéficiaire effectif (ou de l'un des + bénéficiaires effectifs de l'entreprise pour une recherche + d'entreprises) de l'entreprise, au format JJ-MM-AAAA. + example: '1970-12-31T00:00:00.000Z' + - name: nationaliteBeneficiaire + schema: string + required: false + description: >- + Nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + example: Française + - name: typePublication + schema: string + required: false + description: Type de publication + example: Procédure collective + - name: datePublicationMin + schema: string + required: false + description: Date publication minimale de la publication, au format JJ-MM-AAAA. + example: '2000-01-01T00:00:00.000Z' + - name: datePublicationMax + schema: string + required: false + description: Date de publication maximale de la publication, au format JJ-MM-AAAA. + example: '2000-12-31T00:00:00.000Z' + - name: siren + schema: string + required: false + description: SIREN de l'entreprise. + example: null + responses: + - statusCode: '200' + description: '' + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '404' + description: Aucun document ne correspond aux critères indiqués. + - statusCode: '503' + description: Service momentanément indisponible. + - url: /recherche-publications + method: matchingPublicationsGet + httpMethod: get + tag: Recherche + typeScriptTag: recherche + description: Recherche les publications BODACC qui correspondent à des critères. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: parPage + schema: integer + required: false + description: 'Nombre de résultats affichés sur une page. Valeur par défaut : `10`.' + example: 20 + - name: page + schema: integer + required: false + description: 'Page de résultats. Valeur par défaut : `1`.' + example: 1 + - name: precision + schema: string + required: false + description: 'Niveau de précision de la recherche. Valeur par défaut : `"standard"`.' + example: standard + - name: q + schema: string + required: false + description: Mot-clé à rechercher dans le contenu de la publication. + example: Liquidation + - name: codeNaf + schema: string + required: false + description: >- + Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes + NAF en les séparant par des virgules. + example: 70.10Z + - name: departement + schema: string + required: false + description: >- + Numéro de département de l'un des établissements de l'entreprise. Il + est possible d'indiquer plusieurs départements en les séparant par des + virgules. + example: 75 + - name: region + schema: string + required: false + description: >- + Code de la région de l'un des établissements de l'entreprise, selon la + [nomenclature + Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il + est possible d'indiquer plusieurs codes régions en les séparant par + des virgules. + example: 11 + - name: codePostal + schema: string + required: false + description: >- + Code postal de l'un des établissements de l'entreprise. Il est + possible d'indiquer plusieurs codes postaux en les séparant par des + virgules. + example: 75009 + - name: conventionCollective + schema: string + required: false + description: Convention collective de l'entreprise. + example: 1486 + - name: categorieJuridique + schema: string + required: false + description: >- + Catégorie juridique de l'entreprise, selon la [nomenclature + Insee](https://www.insee.fr/fr/information/2028129). + + + **Note** : Le code correspond à celui de l'INSEE, à l'exception des + SASU qui auront comme code 5720 et les EURL qui auront comme code + 5498. + example: 5499 + - name: entrepriseCessee + schema: boolean + required: false + description: Activité de l'entreprise cessée ou non. + example: false + - name: statutRcs + schema: string + required: false + description: Statut au RCS + example: inscrit + - name: objetSocial + schema: string + required: false + description: Objet social de l'entreprise déclaré au RCS. + example: La conception de moteurs de recherche sur internet. + - name: dateImmatriculationRcsMin + schema: string + required: false + description: >- + Date d'immatriculation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + example: 15-05-2002 + - name: dateImmatriculationRcsMax + schema: string + required: false + description: >- + d'immatriculation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + example: 15-05-2002 + - name: dateRadiationRcsMin + schema: string + required: false + description: >- + Date de radiation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + example: 15-05-2002 + - name: dateRadiationRcsMax + schema: string + required: false + description: >- + Date de radiation au RCS maximale de l'entreprise, au format + JJ-MM-AAAA. + example: 17-05-2002 + - name: capitalMin + schema: string + required: false + description: Capital minimum de l'entreprise. + example: 411016200 + - name: capitalMax + schema: string + required: false + description: Capital maximum de l'entreprise. + example: 411016400 + - name: chiffreAffairesMin + schema: string + required: false + description: >- + Chiffre d'affaires minimum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 411016200 + - name: chiffreAffairesMax + schema: string + required: false + description: >- + Chiffre d'affaires maximum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 411016400 + - name: resultatMin + schema: string + required: false + description: >- + Résultat minimum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 29327000 + - name: resultatMax + schema: string + required: false + description: >- + Résultat maximum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + example: 29327100 + - name: dateCreationMin + schema: string + required: false + description: Date de création minimale de l'entreprise, au format JJ-MM-AAAA. + example: 15-05-2002 + - name: dateCreationMax + schema: string + required: false + description: Date de création maximale de l'entreprise, au format JJ-MM-AAAA. + example: 17-05-2002 + - name: trancheEffectifMin + schema: string + required: false + description: >- + Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen). + + + **Note** : 00 ou NN donneront les mêmes résultats et veulent dire non + employeur + example: 40 + - name: trancheEffectifMax + schema: string + required: false + description: >- + Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen). + + + **Note** : 00 ou NN donneront les mêmes résultats et veulent dire non + employeur + example: 42 + - name: typeDirigeant + schema: string + required: false + description: >- + Type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + example: physique + - name: qualiteDirigeant + schema: string + required: false + description: >- + Qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + example: Administrateur + - name: nationaliteDirigeant + schema: string + required: false + description: >- + Nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise + pour une recherche d'entreprises). + example: Française + - name: nomDirigeant + schema: string + required: false + description: >- + Nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + example: Yi + - name: prenomDirigeant + schema: string + required: false + description: >- + Prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + example: Kenneth H. + - name: ageDirigeantMin + schema: integer + required: false + description: >- + Âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise + pour une recherche d'entreprises). + example: 40 + - name: ageDirigeantMax + schema: integer + required: false + description: >- + Âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise + pour une recherche d'entreprises). + example: 42 + - name: dateDeNaissanceDirigeantMin + schema: string + required: false + description: >- + Date de naissance minimale du dirigeant (ou de l'un des dirigeants de + l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA. + example: '1970-01-01T00:00:00.000Z' + - name: dateDeNaissanceDirigeantMax + schema: string + required: false + description: >- + Date de naissance maximale du dirigeant (ou de l'un des dirigeants de + l'entreprise pour une recherche d'entreprises) de l'entreprise, au + format JJ-MM-AAAA. + example: '1970-12-31T00:00:00.000Z' + - name: ageBeneficiaireMin + schema: integer + required: false + description: >- + Âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + example: 40 + - name: ageBeneficiaireMax + schema: integer + required: false + description: >- + Âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + example: 42 + - name: dateDeNaissanceBeneficiaireMin + schema: string + required: false + description: >- + Date de naissance minimale du bénéficiaire effectif (ou de l'un des + bénéficiaires effectifs de l'entreprise pour une recherche + d'entreprises), au format JJ-MM-AAAA. + example: '1970-01-01T00:00:00.000Z' + - name: dateDeNaissanceBeneficiaireMax + schema: string + required: false + description: >- + Date de naissance maximale du bénéficiaire effectif (ou de l'un des + bénéficiaires effectifs de l'entreprise pour une recherche + d'entreprises) de l'entreprise, au format JJ-MM-AAAA. + example: '1970-12-31T00:00:00.000Z' + - name: nationaliteBeneficiaire + schema: string + required: false + description: >- + Nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + example: Française + - name: dateDepotDocumentMin + schema: string + required: false + description: Date de dépôt minimale du document, au format JJ-MM-AAAA. + example: '2000-01-01T00:00:00.000Z' + - name: dateDepotDocumentMax + schema: string + required: false + description: Date de dépôt maximale du document, au format JJ-MM-AAAA. + example: '2000-12-31T00:00:00.000Z' + - name: typePublication + schema: string + required: false + description: Type de publication + example: Procédure collective + - name: datePublicationMin + schema: string + required: false + description: Date publication minimale de la publication, au format JJ-MM-AAAA. + example: '2000-01-01T00:00:00.000Z' + - name: datePublicationMax + schema: string + required: false + description: Date de publication maximale de la publication, au format JJ-MM-AAAA. + example: '2000-12-31T00:00:00.000Z' + - name: siren + schema: string + required: false + description: SIREN de l'entreprise. + example: null + responses: + - statusCode: '200' + description: '' + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '404' + description: Aucune publication ne correspond aux critères indiqués. + - statusCode: '503' + description: Service momentanément indisponible. + - url: /suggestions + method: searchText + httpMethod: get + tag: Suggestions / Autocomplete + typeScriptTag: suggestionsAutocomplete + description: >- + Recherche les entreprises qui correspondent à un début de recherche + textuelle (type autocomplete). + parameters: + - name: q + schema: string + required: true + description: Début de recherche textuelle + example: googl + - name: longueur + schema: integer + required: false + description: 'Nombre de résultats. Maximum 100. Valeur par défaut : `10`.' + example: 20 + - name: cibles + schema: string + required: false + description: >- + Cibles de la recherche, séparées par des virgules. Valeur par défaut : + `"nom_entreprise"`. + example: nom_entreprise,siren,siret + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: Paramètres de la requête incorrects. + - url: /entreprise/comptes + method: getBySiren + httpMethod: get + tag: Comptes annuels + typeScriptTag: comptesAnnuels + description: Récupère les comptes annuels publiés d'une entreprise. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: siren + schema: string + required: false + description: SIREN de l'entreprise + example: 443061841 + - name: annee + schema: string + required: false + 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. + example: 2016,2017,2018 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: Paramètres de la requête incorrects. + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '404' + description: Comptes annuels indisponibles. + - statusCode: '503' + description: Service momentanément indisponible. + - url: /entreprise/cartographie + method: getData + httpMethod: get + tag: Cartographie + typeScriptTag: cartographie + description: >- + Récupère les données permettant d'établir une cartographie d'une + entreprise. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: siren + schema: string + required: true + description: SIREN de l'entreprise + example: 443061841 + - name: inclureEntreprisesDirigees + schema: boolean + required: false + 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: inclureEntreprisesCitees + schema: boolean + required: false + 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: inclureSci + schema: boolean + required: false + description: >- + Si vrai, la cartographie intègrera les SCI. Valeur par défaut : + `true`. + - name: autoriserModifications + schema: boolean + required: false + 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: rejeterPremierDegre + schema: boolean + required: false + 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: degre + schema: integer + required: false + 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. + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: Paramètres de la requête incorrects. + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '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é. + - url: /document/telechargement + method: downloadDocumentByToken + httpMethod: get + tag: Documents + typeScriptTag: documents + description: Télécharge un document PDF ou XLSX à partir de son token. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: token + schema: string + required: true + description: Token du document + example: QTQ0MzA2MTg0MTIwMjAwNDA3RMOpY2lzaW9uKHMpIGRlIGwnYXNzb2Npw6kgdW5pcXVl + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: Paramètres de la requête incorrects. + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '404' + description: Document indisponible. + - statusCode: '503' + description: Service momentanément indisponible. + - url: /document/extrait_pappers + method: downloadPappersExtrait + httpMethod: get + tag: Documents + typeScriptTag: documents + description: >- + Télécharge l'extrait Pappers d'une entreprise à partir de son SIREN ou + SIRET. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: siren + schema: string + required: false + description: SIREN de l'entreprise + example: 443061841 + - name: siret + schema: string + required: false + description: SIRET de l'entreprise + example: 44306184100047 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: Paramètres de la requête incorrects. + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '404' + description: Document indisponible. + - statusCode: '503' + description: Service momentanément indisponible. + - url: /document/extrait_inpi + method: getExtraitInpi + httpMethod: get + tag: Documents + typeScriptTag: documents + description: Télécharge l'extrait INPI d'une entreprise à partir de son SIREN ou SIRET. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: siren + schema: string + required: false + description: SIREN de l'entreprise + example: 443061841 + - name: siret + schema: string + required: false + description: SIRET de l'entreprise + example: 44306184100047 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: Paramètres de la requête incorrects. + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '404' + description: Document indisponible. + - statusCode: '503' + description: Service momentanément indisponible. + - url: /document/avis_situation_insee + method: downloadInseeSituation + httpMethod: get + tag: Documents + typeScriptTag: documents + description: >- + Télécharge l'avis de situation INSEE d'une entreprise à partir de son + SIREN ou SIRET. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: siren + schema: string + required: false + description: SIREN de l'entreprise + example: 443061841 + - name: siret + schema: string + required: false + description: SIRET de l'entreprise + example: 44306184100047 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: Paramètres de la requête incorrects. + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '404' + description: Document indisponible. + - statusCode: '503' + description: Service momentanément indisponible. + - url: /document/statuts + method: telechargementStatuts + httpMethod: get + tag: Documents + typeScriptTag: documents + description: >- + Télécharge les derniers statuts disponibles d'une entreprise à partir de + son SIREN ou SIRET. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: siren + schema: string + required: false + description: SIREN de l'entreprise + example: 443061841 + - name: siret + schema: string + required: false + description: SIRET de l'entreprise + example: 44306184100047 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: Paramètres de la requête incorrects. + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '404' + description: Document indisponible. + - statusCode: '503' + description: Service momentanément indisponible. + - url: /document/declaration_beneficiaires_effectifs + method: telechargementBeneficiairesEffectifs + httpMethod: get + tag: Documents + typeScriptTag: documents + description: >- + Télécharge la déclaration des bénéficiaires effectifs d'une entreprise à + partir de son SIREN. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: siren + schema: string + required: false + description: SIREN de l'entreprise + example: 443061841 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: Paramètres de la requête incorrects. + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '403' + description: Vous n'avez pas les droits pour exécuter cette requête. + - statusCode: '404' + description: Document indisponible. + - statusCode: '503' + description: Service momentanément indisponible. + - url: /document/rapport_solvabilite + method: downloadSolvabilityReport + httpMethod: get + tag: Documents + typeScriptTag: documents + description: >- + Télécharge un Rapport de solvabilité d'une entreprise à partir de son + SIREN. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: siren + schema: string + required: false + description: SIREN de l'entreprise + example: 443061841 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: Paramètres de la requête incorrects. + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '404' + description: Document indisponible. + - statusCode: '503' + description: Service momentanément indisponible. + - url: /conformite/personne_physique + method: personnePhysiqueStatusCheck + httpMethod: get + tag: Conformité + typeScriptTag: conformité + description: >- + Vérifie le statut de personne politiquement exposée et la présence de + sanctions internationales pour une personne physique. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: nom + schema: string + required: true + description: Nom de la personne physique + example: Macron + - name: prenom + schema: string + required: true + description: Prénom de la personne physique + example: Emmanuel + - name: dateDeNaissance + schema: string + required: true + description: >- + Date de naissance de la personne physique, au format AAAA-MM-JJ ou + AAAA-MM + example: '1977-12-21T00:00:00.000Z' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: Paramètres de la requête incorrects. + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '503' + description: Erreur interne. La personne physique n'a pas pu être vérifiée. + - url: /suivi-jetons + method: getTokenUsage + httpMethod: get + tag: Suivi utilisation + typeScriptTag: suiviUtilisation + description: Récupère le suivi d'utilisation des jetons. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + responses: + - statusCode: '200' + description: Suivi d'utilisation des jetons. + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '503' + description: Service momentanément indisponible. + - url: /liste + method: listDelete + httpMethod: delete + tag: Surveillance + typeScriptTag: surveillance + description: >- + Supprime une (ou plusieurs) + notification(https://www.pappers.fr/api/documentation d'une liste. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: idListe + schema: string + required: true + description: Identifiant unique de votre liste de surveillance + example: votre_identifiant_ici + - name: siren + schema: string + required: false + description: >- + Liste des sirens des notifications à supprimer, séparés par une + virgule + example: 443061841,950370973 + - name: id + schema: string + required: false + description: Liste des ids des notifications à supprimer, séparés par une virgule + example: >- + ecfca3e5fb1ce07bb3fdfe8760a28df5aa617ed4951b7f61,a67b9de66189ba98eb4aede09f4b2b565b0f18fe694da7bc + - name: supprimerTotalite + schema: boolean + required: false + description: Suppression de toutes les notifications de la liste + example: true + responses: + - statusCode: '200' + description: Nombre de notifications supprimées. + - statusCode: '400' + description: Paramètres de la requête incorrects. + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '404' + description: Liste non trouvée. + - statusCode: '503' + description: Service momentanément indisponible. + - url: /liste + method: listeDirigeantsAjout + httpMethod: post + tag: Surveillance + typeScriptTag: surveillance + description: >- + Ajoute un (ou plusieurs) + dirigeant(https://www.pappers.fr/api/documentation à une liste de + dirigeants. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: idListe + schema: string + required: true + description: Identifiant unique de votre liste de surveillance de dirigeants + example: votre_identifiant_ici + responses: + - statusCode: '200' + description: Nombre de notifications ajoutées. + - statusCode: '201' + description: Nombre de notifications ajoutées. + - statusCode: '400' + description: Paramètres de la requête incorrects. + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '403' + description: Offre dépassée. + - statusCode: '404' + description: Liste non trouvée. + - statusCode: '503' + description: Service momentanément indisponible. + - url: /liste-informations + method: addNotifications + httpMethod: post + tag: Surveillance + typeScriptTag: surveillance + description: >- + Ajoute des informations à une (ou plusieurs) + notification(https://www.pappers.fr/api/documentation. + parameters: + - name: apiToken + schema: string + required: true + description: Clé d'utilisation de l'API + example: votre_clé_ici + - name: idListe + schema: string + required: true + description: Identifiant unique de votre liste de surveillance d'entreprises + example: votre_identifiant_ici + - name: notifications + schema: array + description: '' + - name: informations + schema: string + description: '' + example: Information quelconque + responses: + - statusCode: '200' + description: Succés. + - statusCode: '400' + description: Paramètres de la requête incorrects. + - statusCode: '401' + description: Clé API incorrecte. + - statusCode: '404' + description: Liste non trouvée. + - statusCode: '503' + description: Service momentanément indisponible. +numberOfSchemas: 53 +apiDescription: > + 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 diff --git a/sdks/db/cached-method-objects/from-custom-request_peachpayments.com.yaml b/sdks/db/cached-method-objects/from-custom-request_peachpayments.com.yaml index 419f754c8a..de03e9ebed 100644 --- a/sdks/db/cached-method-objects/from-custom-request_peachpayments.com.yaml +++ b/sdks/db/cached-method-objects/from-custom-request_peachpayments.com.yaml @@ -1,4 +1,4 @@ -hash: 75f009323905243ab39b6a952138a47c14c27741bc4685a0bd52b31fe0c04ffe +hash: f5b0e79e1fb69478214155f756dede73b8689f5eb16948660a1b42d858d0e7fe methodObjects: - url: /checkout/initiate method: initiateRedirectCheckout diff --git a/sdks/db/category-cache.yaml b/sdks/db/category-cache.yaml index b927d9d714..a3b5268164 100644 --- a/sdks/db/category-cache.yaml +++ b/sdks/db/category-cache.yaml @@ -254,3 +254,4 @@ apis: Customer.io-Data Pipelines: Marketing Automation Customer.io-Journeys App: Marketing Automation Customer.io-Journeys Track: Marketing Automation + Pappers-undefined: Legal diff --git a/sdks/db/custom-request-last-fetched.yaml b/sdks/db/custom-request-last-fetched.yaml index 0239b6f2ab..1c3fa5d139 100644 --- a/sdks/db/custom-request-last-fetched.yaml +++ b/sdks/db/custom-request-last-fetched.yaml @@ -25,16 +25,16 @@ lastUpdated: walmart.com_content: 2024-03-28T20:51:51.089Z zuora.com: 2024-03-28T20:51:52.218Z launchdarkly.com: 2024-03-28T20:51:58.598Z - klarna.com_payments: 2024-03-27T21:26:15.236Z - klarna.com_checkout: 2024-03-27T21:26:30.405Z - justeattakeaway.com: 2024-03-27T21:26:32.303Z - hetzner.com: 2024-03-27T21:26:33.641Z - hsbc.com_AccountInformationCE: 2024-03-27T21:26:51.184Z - zoom.us_meeting: 2024-03-27T21:26:53.918Z - snyk.com: 2024-03-27T21:26:55.033Z - clever.com: 2024-03-27T21:26:55.471Z - digitalocean.com: 2024-03-27T21:26:56.222Z - spotify.com_1.0.0: 2024-03-27T21:26:56.755Z + klarna.com_payments: 2024-03-28T21:32:09.494Z + klarna.com_checkout: 2024-03-28T21:32:36.217Z + justeattakeaway.com: 2024-03-28T21:32:38.569Z + hetzner.com: 2024-03-28T21:32:39.991Z + hsbc.com_AccountInformationCE: 2024-03-28T21:32:58.708Z + zoom.us_meeting: 2024-03-28T21:33:01.555Z + snyk.com: 2024-03-28T21:33:02.820Z + clever.com: 2024-03-28T21:33:03.239Z + digitalocean.com: 2024-03-28T21:33:04.164Z + spotify.com_1.0.0: 2024-03-28T21:33:06.334Z circleci.com: 2024-03-28T20:48:00.448Z brex.com_Team: 2024-03-28T20:52:04.351Z brex.com_Onboarding: 2024-03-28T20:52:18.319Z @@ -46,19 +46,19 @@ lastUpdated: resend.com: 2024-03-28T20:53:54.020Z griffin.com: 2024-03-28T20:53:53.564Z onedoc.com: 2024-03-28T20:47:59.508Z - box.com: 2024-03-27T21:26:33.994Z - asana.com: 2024-03-27T21:26:35.601Z - appwrite.io_Client: 2024-03-27T21:26:34.687Z - appwrite.io_Server: 2024-03-27T21:26:34.889Z - appwrite.io_Console: 2024-03-27T21:26:35.202Z - api.video: 2024-03-27T21:26:34.466Z + box.com: 2024-03-28T21:32:40.780Z + asana.com: 2024-03-28T21:32:43.878Z + appwrite.io_Client: 2024-03-28T21:32:42.002Z + appwrite.io_Server: 2024-03-28T21:32:42.520Z + appwrite.io_Console: 2024-03-28T21:32:42.978Z + api.video: 2024-03-28T21:32:41.613Z 1password.com_Connect: 2024-03-28T20:50:59.044Z 1password.com_Partnership: 2024-03-28T20:50:53.822Z zapier.com_Embed: 2024-03-28T20:51:25.397Z synclabs.so: 2024-03-28T20:51:24.575Z - uploadthing.com: 2024-03-27T21:26:55.733Z - crowdsec.net: 2024-03-27T21:26:57.151Z - crowd4cash.ch: 2024-03-27T21:26:59.516Z + uploadthing.com: 2024-03-28T21:33:03.692Z + crowdsec.net: 2024-03-28T21:33:06.550Z + crowd4cash.ch: 2024-03-28T21:33:08.721Z posthog.com: 2024-03-28T20:50:57.739Z visier.com_Authentication: 2024-03-28T20:51:43.944Z visier.com_ConsolidatedAnalytics: 2024-03-28T20:51:44.182Z @@ -72,17 +72,17 @@ lastUpdated: visier.com_TenantManagement: 2024-03-28T20:51:46.393Z visier.com_UserManagement: 2024-03-28T20:51:46.726Z shipengine.com: 2024-03-28T20:51:48.574Z - unstructured.io: 2024-03-27T21:27:50.329Z + unstructured.io: 2024-03-28T21:34:01.398Z vantage.sh: 2024-03-28T20:51:17.638Z baremetrics.com: 2024-03-28T20:51:17.151Z - nvidia.com_NIM: 2024-03-27T21:27:42.425Z - nvidia.com_CloudFunctions: 2024-03-27T21:27:50.163Z + nvidia.com_NIM: 2024-03-28T21:33:52.592Z + nvidia.com_CloudFunctions: 2024-03-28T21:34:01.225Z langfuse.com: 2024-03-28T20:48:53.664Z dots.dev: 2024-03-28T20:50:50.948Z seel.com: 2024-03-28T20:51:23.745Z - pay.com: 2024-03-27T21:28:08.698Z - agrimetrics.co.uk: 2024-03-27T21:27:30.978Z - tremendous.com: 2024-03-27T21:27:11.215Z + pay.com: 2024-03-28T21:34:20.535Z + agrimetrics.co.uk: 2024-03-28T21:33:42.061Z + tremendous.com: 2024-03-28T21:33:22.133Z notion.com: 2024-03-27T22:35:18.546Z payfactory.io: 2024-03-27T22:35:23.803Z helcim.com: 2024-03-27T22:35:25.444Z @@ -103,8 +103,8 @@ lastUpdated: 7shifts.com: 2024-03-28T19:25:40.710Z withterminal.com: 2024-03-28T20:50:53.417Z revenium.io: 2024-03-28T19:27:37.783Z - adp.com_WorkforceNow: 2024-03-27T21:26:04.412Z - alexishr.com: 2024-03-27T21:26:08.984Z + adp.com_WorkforceNow: 2024-03-28T21:30:49.736Z + alexishr.com: 2024-03-28T21:30:53.328Z clickfunnels.com: 2024-03-27T22:35:46.096Z beamable.com: 2024-03-27T22:35:15.955Z sumsub.com: 2024-03-27T22:35:50.915Z @@ -140,8 +140,8 @@ lastUpdated: suprsend.com: 2024-03-28T20:51:40.507Z officient.io: 2024-03-28T20:51:42.757Z okta.com: 2024-03-28T20:51:40.975Z - onelogin.com: 2024-03-27T21:26:09.592Z - sqala.tech: 2024-03-27T21:28:22.176Z + onelogin.com: 2024-03-28T21:30:53.919Z + sqala.tech: 2024-03-28T21:34:35.838Z peachpayments.com: 2024-03-27T22:35:53.010Z connexpay.com: 2024-03-27T23:06:45.738Z bluetime.io: 2024-03-27T23:14:28.071Z @@ -180,10 +180,10 @@ lastUpdated: salesflare.com: 2024-03-28T20:51:26.560Z teamwork.com: 2024-03-28T21:20:12.597Z zendesk.com: 2024-03-28T21:20:10.759Z - atlassian.com_BitBucket: 2024-03-27T21:21:21.775Z - dixa.com: 2024-03-27T21:28:14.318Z + atlassian.com_BitBucket: 2024-03-28T21:34:21.373Z + dixa.com: 2024-03-28T21:34:27.411Z gladly.com: 2024-03-27T21:35:33.703Z - softledger.com: 2024-03-27T21:33:27.528Z + softledger.com: 2024-03-28T21:34:50.576Z gorgias.com: 2024-03-27T21:42:49.698Z height.app: 2024-03-27T21:48:19.119Z hive.com: 2024-03-27T21:51:42.769Z @@ -234,3 +234,4 @@ lastUpdated: customer.io_JourneysApp: 2024-03-28T21:19:48.960Z customer.io_JourneysTrack: 2024-03-28T21:20:04.457Z customer.io_DatePipelines: 2024-03-28T21:20:10.133Z + pappers.fr: 2024-03-28T21:34:52.135Z diff --git a/sdks/db/custom-request-specs/box.com.yaml b/sdks/db/custom-request-specs/box.com.yaml index 94e04ee888..c4e81341a8 100644 --- a/sdks/db/custom-request-specs/box.com.yaml +++ b/sdks/db/custom-request-specs/box.com.yaml @@ -16,7 +16,7 @@ info: name: Apache-2.0 url: http://www.apache.org/licenses/LICENSE-2.0 version: 2.0.0 - x-box-commit-hash: 9d605a3ec5 + x-box-commit-hash: a2f6edcf0a servers: - url: https://api.box.com/2.0 description: Box Platform API server @@ -312,7 +312,7 @@ paths: Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example - `?field=metadata.enterprise_12345.contractTemplate`. + `?fields=metadata.enterprise_12345.contractTemplate`. in: query example: - id @@ -4949,7 +4949,7 @@ paths: Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example - `?field=metadata.enterprise_12345.contractTemplate`. + `?fields=metadata.enterprise_12345.contractTemplate`. in: query example: - id @@ -5931,7 +5931,7 @@ paths: Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example - `?field=metadata.enterprise_12345.contractTemplate`. + `?fields=metadata.enterprise_12345.contractTemplate`. in: query example: - id diff --git a/sdks/db/custom-request-specs/digitalocean.com.yaml b/sdks/db/custom-request-specs/digitalocean.com.yaml index 4210183d2a..9b052f5913 100644 --- a/sdks/db/custom-request-specs/digitalocean.com.yaml +++ b/sdks/db/custom-request-specs/digitalocean.com.yaml @@ -18392,6 +18392,8 @@ paths: parameter to specify if the results should be for the `private` or `public` interface. Use the `direction` query parameter to specify if the results should be for `inbound` or `outbound` traffic. + + The metrics in the response body are in megabits per second (Mbps). tags: - Monitoring responses: @@ -25726,7 +25728,7 @@ components: metric_timestamp_start: in: query name: start - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. example: '1620683817' required: true schema: @@ -25734,7 +25736,7 @@ components: metric_timestamp_end: in: query name: end - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. example: '1620705417' required: true schema: diff --git a/sdks/db/custom-request-specs/hsbc.com_AccountInformationCE.yaml b/sdks/db/custom-request-specs/hsbc.com_AccountInformationCE.yaml index 4333ad9dae..11292aef4e 100644 --- a/sdks/db/custom-request-specs/hsbc.com_AccountInformationCE.yaml +++ b/sdks/db/custom-request-specs/hsbc.com_AccountInformationCE.yaml @@ -667,6 +667,8 @@ components: description: The PSU's IP address if the PSU is currently logged in with the TPP. schema: type: string + pattern: >- + ^((((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\s?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\s?),?\s?)+$ example: 12.201.45.125 x-fapi-auth-date: in: header diff --git a/sdks/db/custom-request-specs/pappers.fr.yaml b/sdks/db/custom-request-specs/pappers.fr.yaml new file mode 100644 index 0000000000..504c3268cc --- /dev/null +++ b/sdks/db/custom-request-specs/pappers.fr.yaml @@ -0,0 +1,6135 @@ +openapi: 3.0.0 +info: + 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 + title: Pappers API + contact: + name: Support technique Pappers + email: support@pappers.fr +servers: + - url: https://api.pappers.fr/v2 +paths: + /entreprise: + get: + tags: + - Fiche entreprise + summary: Récupère l'ensemble des informations disponibles sur une entreprise. + 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`. + operationId: entreprise + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + - name: siret + in: query + description: SIRET de l'entreprise + required: false + schema: + type: string + example: 44306184100047 + - name: integrer_diffusions_partielles + in: query + description: >- + Si vrai et si l'entreprise est en diffusion partielle, le retour + renverra les informations partielles disponibles. Valeur par défaut + : `false`. + required: false + schema: + type: boolean + - name: format_publications_bodacc + in: query + description: >- + Format attendu pour les publications BODACC. Valeur par défaut : + `"objet"`. + required: false + schema: + type: string + enum: + - objet + - texte + example: objet + - name: marques + in: query + description: >- + Si vrai, le retour inclura les marques éventuelles de l'entreprise. + Valeur par défaut : `false`. + required: false + schema: + type: boolean + - name: validite_tva_intracommunautaire + in: query + 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`. + required: false + schema: + type: boolean + - name: publications_bodacc_brutes + in: query + 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`. + required: false + schema: + type: boolean + - name: champs_supplementaires + in: query + 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. + 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. + description: >- + Vous devez fournir soit l'identifiant de l'association, soit le SIREN, + soit le SIRET. + operationId: association + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: id_association + in: query + description: Identifiant de l'association + required: false + schema: + type: string + example: W142005389 + - name: siret + in: query + description: SIRET de l'association + required: false + schema: + type: string + example: 95037097300014 + - name: siren + in: query + description: SIREN de l'association + 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. + 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`). + operationId: recherche + 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' + - name: q + in: query + 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. + required: false + schema: + type: string + example: Google France + - name: siege + in: query + description: Défini si la requête se base sur le siège + 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: + type: object + properties: + resultats: + type: array + description: Liste des entreprises qui correspondent à la recherche. + items: + allOf: + - $ref: '#/components/schemas/EntrepriseRecherche' + - type: object + properties: + dirigeants: + type: array + description: >- + Dirigeants de l'entreprise qui correspondent à + la recherche (si vous recherchez dans la base + dirigeants). + items: + $ref: '#/components/schemas/RepresentantRecherche' + beneficiaires: + type: array + description: >- + Bénéficiaires effectifs de l'entreprise qui + correspondent à la recherche (si vous recherchez + dans la base bénéficiaires effectifs). + items: + $ref: '#/components/schemas/Beneficiaire' + documents: + type: array + description: >- + Documents de l'entreprise qui correspondent à la + recherche (si vous recherchez dans la base + documents). + items: + $ref: '#/components/schemas/Document' + publications: + type: array + description: >- + Publications de l'entreprise qui correspondent à + la recherche (si vous recherchez dans la base + publications). + items: + allOf: + - $ref: '#/components/schemas/Publication' + - type: object + properties: + mentions: + type: array + description: >- + Mentions de la recherche dans la + publication. + items: + type: string + nb_dirigeants_total: + type: integer + description: Nombre de dirigeants total de l'entreprise. + nb_beneficiaires_total: + type: integer + description: >- + Nombre de bénéficiaires effectifs total de + l'entreprise. + nb_documents_avec_mentions: + type: integer + description: >- + Nombre de documents de l'entreprise qui + correspondent à la recherche. + nb_documents_total: + type: integer + description: Nombre de documents total de l'entreprise. + nb_publications_avec_mentions: + type: integer + description: >- + Nombre de publications de l'entreprise qui + correspondent à la recherche. + nb_publications_total: + type: integer + description: Nombre de publications total de l'entreprise. + total: + type: integer + description: Nombre d'entreprises qui correspondent à la recherche. + example: 100 + page: + type: integer + description: Page actuelle. + example: 1 + curseurSuivant: + type: string + description: >- + Présent uniquement en cas d'utilisation du paramètre + `curseur`. Contient le curseur courant à envoyer en + paramètre `curseur` de la requête suivantes. + example: QxNRrqKiBFDQq54SpHsrw8r5Z3yWZMDAAzcvwywX + '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. + description: >- + Tous les paramètres sont optionnels et servent à filtrer la recherche. + Les différents dirigeants seront renvoyées dans un tableau `resultats`. + operationId: recherche-dirigeants + parameters: + - $ref: '#/components/parameters/api_token' + - $ref: '#/components/parameters/par_page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/precision' + - name: q + in: query + description: >- + Texte à rechercher. Nom et prénom du dirigeant pour une personne + physique, dénomination pour une personne morale. + 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: + type: object + properties: + resultats: + type: array + description: Liste des dirigeants qui correspondent à la recherche. + items: + allOf: + - $ref: '#/components/schemas/RepresentantRecherche' + - type: object + properties: + entreprises: + type: array + description: >- + Liste des entreprises du dirigeant, dans la + limite de 100 entreprises. + items: + $ref: '#/components/schemas/EntrepriseRecherche' + nb_entreprises_total: + type: integer + description: Nombre d'entreprises du dirigeant au total + total: + type: integer + description: Nombre de dirigeants qui correspondent à la recherche. + example: 100 + page: + type: integer + description: Page actuelle. + example: 1 + '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. + 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`. + operationId: recherche-beneficiaires + parameters: + - $ref: '#/components/parameters/api_token' + - $ref: '#/components/parameters/par_page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/precision' + - name: q + in: query + description: Nom et/ou prénom du bénéficiaire effectif. + 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: + type: object + properties: + resultats: + type: array + description: >- + Liste des bénéficiaires effectifs qui correspondent à la + recherche. + items: + allOf: + - $ref: '#/components/schemas/Beneficiaire' + - type: object + properties: + entreprises: + type: array + description: >- + Liste des entreprises dont le bénéficiaire + effectif est bénéficiaire effectif, dans la + limite de 100 entreprises. + items: + $ref: '#/components/schemas/EntrepriseRecherche' + nb_entreprises_total: + type: integer + description: >- + Nombre d'entreprises du bénéficiaire effectif au + total. + entreprises_dirigeant: + type: array + description: >- + Liste des entreprises dont le bénéficiaire + effectif est dirigeant (sans forcément en être + bénéficiaire effectif), dans la limite de 100 + entreprises. + items: + $ref: '#/components/schemas/EntrepriseRecherche' + nb_entreprises_dirigeant_total: + type: integer + description: >- + Nombre d'entreprises dont le bénéficiaire + effectif est dirigeant au total. + total: + type: integer + description: >- + Nombre de bénéficiaires effectifs qui correspondent à la + recherche. + example: 100 + page: + type: integer + description: Page actuelle. + example: 1 + '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. + description: >- + Tous les paramètres sont optionnels et servent à filtrer la recherche. + Les différents documents seront renvoyées dans un tableau `resultats`. + operationId: recherche-documents + parameters: + - $ref: '#/components/parameters/api_token' + - $ref: '#/components/parameters/par_page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/precision' + - name: q + in: query + description: Mot-clé à rechercher dans le contenu du document. + 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: + type: object + properties: + resultats: + type: array + description: Liste des documents qui correspondent à la recherche. + items: + allOf: + - $ref: '#/components/schemas/Document' + - type: object + properties: + entreprise: + $ref: '#/components/schemas/EntrepriseRecherche' + total: + type: integer + description: Nombre de documents qui correspondent à la recherche. + example: 100 + page: + type: integer + description: Page actuelle. + example: 1 + '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. + description: >- + Tous les paramètres sont optionnels et servent à filtrer la recherche. + Les différentes publications seront renvoyées dans un tableau + `resultats`. + operationId: recherche-publications + parameters: + - $ref: '#/components/parameters/api_token' + - $ref: '#/components/parameters/par_page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/precision' + - name: q + in: query + description: Mot-clé à rechercher dans le contenu de la publication. + 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: + type: object + properties: + resultats: + type: array + description: Liste des publications qui correspondent à la recherche. + items: + allOf: + - $ref: '#/components/schemas/Publication' + - type: object + properties: + entreprise: + $ref: '#/components/schemas/EntrepriseRecherche' + total: + type: integer + description: Nombre de publications qui correspondent à la recherche. + example: 100 + page: + type: integer + description: Page actuelle. + example: 1 + '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). + 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. + operationId: suggestions + parameters: + - name: q + in: query + description: Début de recherche textuelle + required: true + schema: + type: string + example: googl + - name: longueur + in: query + description: 'Nombre de résultats. Maximum 100. Valeur par défaut : `10`.' + required: false + schema: + type: integer + example: 20 + - name: cibles + in: query + description: >- + Cibles de la recherche, séparées par des virgules. Valeur par défaut + : `"nom_entreprise"`. + 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: + type: object + properties: + resultats_nom_entreprise: + type: array + format: optional + description: >- + Liste des entreprises dont le nom (dénomination ou + nom/prénom) peut compléter la recherche textuelle. + Uniquement présent si le paramètre `cibles` contient + `nom_entreprise`. + items: + allOf: + - type: object + properties: + mention: + type: string + description: >- + Nom de l'entreprise, avec le texte recherché + encerclé d'une balise HTML ``. + - $ref: '#/components/schemas/EntrepriseRecherche' + resultats_denomination: + type: array + format: optional + description: >- + Liste des entreprises dont la dénomination peut compléter + la recherche textuelle (concerne les personnes morales + seulement). Uniquement présent si le paramètre `cibles` + contient `denomination`. + items: + allOf: + - type: object + properties: + mention: + type: string + description: >- + Dénomination de l'entreprise, avec le texte + recherché encerclé d'une balise HTML ``. + - $ref: '#/components/schemas/EntrepriseRecherche' + resultats_nom_complet: + type: array + format: optional + description: >- + Liste des entreprises dont le nom complet (nom + prénom ou + prénom + nom) peut compléter la recherche textuelle + (concerne les personnes physiques seulement). Uniquement + présent si le paramètre `cibles` contient `nom_complet`. + items: + allOf: + - type: object + properties: + mention: + type: string + description: >- + Nom complet de l'entreprise, avec le texte + recherché encerclé d'une balise HTML ``. + - $ref: '#/components/schemas/EntrepriseRecherche' + resultats_representant: + type: array + format: optional + description: >- + Liste des représentants dont le nom complet (nom + prénom + ou prénom + nom) peut compléter la recherche textuelle. + Uniquement présent si le paramètre `cibles` contient + `representant`. + items: + allOf: + - type: object + properties: + mention: + type: string + description: >- + Nom du dirigeant, avec le texte recherché + encerclé d'une balise HTML ``. + - $ref: '#/components/schemas/RepresentantSuggestions' + resultats_siren: + type: array + format: optional + description: >- + Liste des entreprises dont le numéro SIREN peut compléter + la recherche textuelle. Uniquement présent si le paramètre + `cibles` contient `siren`. + items: + allOf: + - type: object + properties: + mention: + type: string + description: >- + SIREN de l'entreprise, avec le texte recherché + encerclé d'une balise HTML ``. + - $ref: '#/components/schemas/EntrepriseRecherche' + resultats_siret: + type: array + format: optional + description: >- + Liste des entreprises dont le numéro SIRET peut compléter + la recherche textuelle. Uniquement présent si le paramètre + `cibles` contient `siret`. + items: + allOf: + - type: object + properties: + mention: + type: string + description: >- + SIRET de l'entreprise, avec le texte recherché + encerclé d'une balise HTML ``. + - $ref: '#/components/schemas/EntrepriseRecherche' + '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. + description: >- + Vous devez fournir le SIREN de l'entreprise pour laquelle vous souhaitez + obtenir les comptes annuels. + operationId: comptes-annuels + parameters: + - $ref: '#/components/parameters/api_token' + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + - name: annee + in: query + 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. + 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: + type: object + additionalProperties: + type: array + description: Comptes disponibles pour l'année correspondant à la clé. + items: + type: object + description: Année + properties: + date_depot: + type: string + description: Date de dépôt des comptes, au format AAAA-MM-JJ. + example: '2021-04-23T00:00:00.000Z' + code_greffe: + type: string + description: Code du greffe de dépôt des comptes. + example: 7501 + numero_depot: + type: string + description: Numéro de dépôt des comptes au greffe. + example: 75548 + numero_gestion: + type: string + description: Numéro de gestion au greffe. + example: 2003B09427 + date_cloture: + type: string + description: Date de cloture des comptes, au format AAAA-MM-JJ. + example: '2020-12-31T00:00:00.000Z' + date_cloture_n-1: + type: string + format: nullable + description: >- + Date de cloture des comptes n-1, lorsque présents, au + format AAAA-MM-JJ. + duree_exercice_n: + type: integer + description: Durée de l'exercice déposé, en mois. + example: 12 + duree_exercice_n-1: + type: integer + format: nullable + description: >- + Durée de l'exercice précédent, lorsque présent, en + mois. + type_comptes: + type: string + enum: + - C + - S + - K + - CS + - B + - A + description: >- + Type de comptes (C = complets ; S = simplifiés ; K = + consolidés ; CS = mélange complets/simplifiés ; B = + banques ; A = assurances). + example: C + libelle_type_comptes: + type: string + enum: + - Complets + - Simplifiés + - Consolidés + - Complets/Simplifiés + - Banques + - Assurances + description: Libellé du type de comptes. + example: Complets + devise: + type: string + description: Devise des comptes. + example: EUR + devise_origine: + type: string + format: nullable + description: Devise d'origine en cas de conversion. + confidentialite: + type: boolean + description: Confidentialité totale des comptes. + confidentialite_compte_de_resultat: + type: boolean + description: >- + Confidentialité partielle des comptes (seul le compte + de résultat est confidentiel, le reste des comptes + sont disponibles). + coherence_comptable: + type: boolean + description: >- + Vrai si les comptes sont cohérents d'un point de vue + comptable (équilibre du bilan par exemple). + type_saisie: + type: string + description: Description du type de saisie des comptes. + informations_traitement: + type: array + format: nullable + description: >- + Informations complémentaires sur le traitement des + comptes. + items: + type: string + sections: + type: array + description: Liste des sections de liasses fiscales. + items: + type: object + properties: + libelle: + type: string + description: Libellé de la section. + example: Actif (bilan) + liasses: + type: array + description: Liste des liasses fiscales de la section. + items: + type: object + properties: + code: + type: string + description: Code de la liasse. + example: AN + libelle: + type: string + description: Libellé de la liasse. + example: Terrains + colonnes: + type: array + description: Colonnes de la liasse. + items: + type: object + properties: + libelle: + type: string + description: Libellé de la colonne. + example: Montant brut année N + valeur: + type: integer + description: Valeur de la colonne. + example: 60067444 + ratios: + $ref: '#/components/schemas/Ratios' + '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. + 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. + operationId: cartographie + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: true + schema: + type: string + example: 443061841 + - name: inclure_entreprises_dirigees + in: query + 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`. + required: false + schema: + type: boolean + - name: inclure_entreprises_citees + in: query + 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`. + required: false + schema: + type: boolean + - name: inclure_sci + in: query + description: >- + Si vrai, la cartographie intègrera les SCI. Valeur par défaut : + `true`. + required: false + schema: + type: boolean + - name: autoriser_modifications + in: query + 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`. + required: false + schema: + type: boolean + - name: rejeter_premier_degre + in: query + 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`. + required: false + schema: + type: boolean + - name: degre + in: query + 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. + 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. + description: >- + Vous devez fournir le token du document. Le document vous sera envoyé au + format PDF ou XLSX. + operationId: document-telechargement + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: token + in: query + description: Token du document + 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: + type: string + format: binary + '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. + description: >- + Vous devez fournir soit le SIREN, soit le SIRET. Le document vous sera + envoyé au format PDF. + operationId: document-extrait-pappers + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + - name: siret + in: query + description: SIRET de l'entreprise + 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: + type: string + format: binary + '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: + tags: + - Documents + summary: >- + Télécharge l'extrait INPI d'une entreprise à partir de son SIREN ou + SIRET. + description: >- + Vous devez fournir soit le SIREN, soit le SIRET. Le document vous sera + envoyé au format PDF. + operationId: document-extrait-inpi + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + - name: siret + in: query + description: SIRET de l'entreprise + required: false + schema: + type: string + example: 44306184100047 + responses: + '200': + description: >- + Document disponible. Le retour contient l'extrait INPI au format + PDF. + content: + application/pdf: + schema: + type: string + format: binary + '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/avis_situation_insee: + get: + tags: + - Documents + summary: >- + Télécharge l'avis de situation INSEE d'une entreprise à partir de son + SIREN ou SIRET. + description: >- + Vous devez fournir soit le SIREN, soit le SIRET. Le document vous sera + envoyé au format PDF. + operationId: document-avis-situation-insee + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + - name: siret + in: query + description: SIRET de l'entreprise + required: false + schema: + type: string + example: 44306184100047 + responses: + '200': + description: >- + Document disponible. Le retour contient l'avis de situation au + format PDF. + content: + application/pdf: + schema: + type: string + format: binary + '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/statuts: + get: + tags: + - Documents + summary: >- + Télécharge les derniers statuts disponibles d'une entreprise à partir de + son SIREN ou SIRET. + description: >- + Vous devez fournir soit le SIREN, soit le SIRET. Le document vous sera + envoyé au format PDF. + operationId: document-status + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + - name: siret + in: query + description: SIRET de l'entreprise + required: false + schema: + type: string + example: 44306184100047 + responses: + '200': + description: Document disponible. Le retour contient les statuts au format PDF. + content: + application/pdf: + schema: + type: string + format: binary + '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/declaration_beneficiaires_effectifs: + get: + tags: + - Documents + summary: >- + Télécharge la déclaration des bénéficiaires effectifs d'une entreprise à + partir de son SIREN. + description: >- + Vous devez fournir le SIREN. Le document vous sera envoyé au format PDF. + + + Seules les autorités de contrôle (article + R. 561-57 du Code monétaire et financier en dénombre 18) et les + personnes assujetties à la lutte contre le blanchiment des capitaux et + le financement du terrorisme (article + L. 561-2 du code monétaire et financier) peuvent accéder à ces + informations. + + + Pour pouvoir utiliser cette route veuillez nous contacter au préalable à + api@pappers.fr + operationId: document-beneficiaires-effectifs + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + responses: + '200': + description: >- + Document disponible. Le retour contient la déclaration des + bénéficiaires effectifs au format PDF. + content: + application/pdf: + schema: + type: string + format: binary + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '403': + description: Vous n'avez pas les droits pour exécuter cette requête. + '404': + description: Document indisponible. + '503': + description: Service momentanément indisponible. + /document/rapport_solvabilite: + get: + tags: + - Documents + summary: >- + Télécharge un Rapport de solvabilité d'une entreprise à partir de son + SIREN. + description: Vous devez fournir le SIREN. Le document vous sera envoyé au format PDF. + operationId: document-scoring-financier + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + responses: + '200': + description: >- + Document disponible. Le retour contient le rapport de solvabilité au + format PDF. + content: + application/pdf: + schema: + type: string + format: binary + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '404': + description: Document indisponible. + '503': + description: Service momentanément indisponible. + /conformite/personne_physique: + get: + tags: + - Conformité + summary: >- + Vérifie le statut de personne politiquement exposée et la présence de + sanctions internationales pour une personne physique. + description: > + Cette route vérifie le statut de personne politiquement exposée et la + présence de sanctions internationales pour une personne physique. + + + Pour vérifier le statut de dirigeants et bénéficiaires effectifs + d'entreprises, vous pouvez directement utiliser la route `/entreprise` + avec les champs supplémentaires `personne_politiquement_exposee` et + `sanctions`. + operationId: conformite + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: nom + in: query + description: Nom de la personne physique + required: true + schema: + type: string + example: Macron + - name: prenom + in: query + description: Prénom de la personne physique + required: true + schema: + type: string + example: Emmanuel + - name: date_de_naissance + in: query + description: >- + Date de naissance de la personne physique, au format AAAA-MM-JJ ou + AAAA-MM + required: true + schema: + type: string + example: '1977-12-21T00:00:00.000Z' + responses: + '200': + description: La personne physique a pu être vérifiée. + content: + application/json: + schema: + type: object + properties: + personne_politiquement_exposee: + $ref: '#/components/schemas/PersonnePolitiquementExposee' + sanctions_en_cours: + type: boolean + format: optional + description: >- + Vaut vrai si le bénéficiaire effectif est actuellement + sous sanction. Uniquement présent si demandé dans les + champs supplémentaires. + sanctions: + type: array + description: >- + Liste des sanctions du bénéficiaire effectif. Uniquement + présent si demandé dans les champs supplémentaires. + items: + $ref: '#/components/schemas/Sanction' + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '503': + description: Erreur interne. La personne physique n'a pas pu être vérifiée. + /suivi-jetons: + get: + tags: + - Suivi utilisation + summary: Récupère le suivi d'utilisation des jetons. + description: Vous devez fournir la clé d'utilisation de l'API. + operationId: suivi-jetons + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + responses: + '200': + description: Succès + content: + application/json: + schema: + type: object + description: Suivi d'utilisation des jetons. + properties: + jetons_abonnement: + type: number + example: 10000 + description: Le nombre de jetons mensuels initiaux de votre abonnement. + jetons_abonnement_utilises: + type: number + example: 650 + description: >- + Le nombre de jetons mensuels de votre abonnement que vous + avez utilisés + jetons_pay_as_you_go_restants: + type: number + example: 0 + description: Le nombre de jetons pay as you go qu'il vous reste. + '401': + description: Clé API incorrecte. + '503': + description: Service momentanément indisponible. + /liste: + post: + tags: + - Surveillance + summary: Ajoute une (ou plusieurs) entreprise(s) à une liste d'entreprises. + description: >- + Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant + de votre liste. + operationId: surveillance-entreprise + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: id_liste + in: query + description: Identifiant unique de votre liste de surveillance d'entreprises + required: true + schema: + type: string + example: votre_identifiant_ici + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + type: object + required: + - siren + properties: + siren: + type: string + example: '443061841' + description: SIREN de l'entreprise + responses: + '200': + description: Aucun changement, les données étaient déjà présentes. + content: + application/json: + schema: + type: object + description: Nombre de notifications ajoutées. + properties: + notifications_ajoutees: + type: number + example: 0 + default: 0 + description: >- + Le nombre d'entreprises ajoutées à votre liste de + surveillance d'entreprises. + '201': + description: Créés, liste mise à jour. + content: + application/json: + schema: + type: object + description: Nombre de notifications ajoutées. + properties: + notifications_ajoutees: + type: number + example: 10 + description: >- + Le nombre d'entreprises ajoutées à votre liste de + surveillance d'entreprises. + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '403': + description: Offre dépassée. + '404': + description: Liste non trouvée. + '503': + description: Service momentanément indisponible. + /liste/: + post: + tags: + - Surveillance + summary: Ajoute un (ou plusieurs) dirigeant(s) à une liste de dirigeants. + description: >- + Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant + de votre liste. Les informations à renseigner sont différentes selon le + type de personne à ajouter (morale ou physique) + operationId: surveillance-dirigeant + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: id_liste + in: query + description: Identifiant unique de votre liste de surveillance de dirigeants + required: true + schema: + type: string + example: votre_identifiant_ici + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + type: object + required: + - siren + properties: + siren: + type: string + description: >- + SIREN de la personne morale (si ajout d'une personne + morale) + denomination: + type: string + description: >- + Dénomination de la personne morale (si ajout d'une + personne morale) + nom: + type: string + description: >- + Nom de la personne physique (si ajout d'une personne + physique) + prenom: + type: string + description: >- + Prénom de la personne physique (si ajout d'une personne + physique) + date_de_naissance: + type: string + description: >- + Date de naissance de la personne physique au format + AAAA-MM-JJ (si ajout d'une personne physique) + recherche_elargie: + type: boolean + default: false + description: >- + Active la recherche élargie du dirigeant :
  • Pour + une personne physique : c'est un cas rare mais la date de + naissance du dirigeant n'est pas toujours connue de + Pappers. Si vous activer ce filtre et que la date de + naissance est inconnue, l'alerte sera générée uniquement + sur la base du nom et prénom.
  • Pour une personne + morale : c'est un cas rare mais le SIREN du dirigeant + n'est pas toujours connu de Pappers. Si vous activer ce + filtre et que le SIREN est inconnu, l'alerte sera générée + uniquement sur la base de la dénomination. Activable + uniquement si le champ denomination est présent.
+ example: + - siren: '443061841' + denomination: Google FRANCE + - nom: Yi + prenom: Kenneth H. + date_de_naissance: '1970-01-06' + recherche_elargie: true + responses: + '200': + description: Aucun changement, les données étaient déjà présentes. + content: + application/json: + schema: + type: object + description: Nombre de notifications ajoutées. + properties: + notifications_ajoutees: + type: number + example: 0 + default: 0 + description: >- + Le nombre de dirigeants ajoutées à votre liste de + surveillance de dirigeants. + '201': + description: Créés, liste mise à jour. + content: + application/json: + schema: + type: object + description: Nombre de notifications ajoutées. + properties: + notifications_ajoutees: + type: number + example: 10 + description: >- + Le nombre de dirigeants ajoutées à votre liste de + surveillance de dirigeants. + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '403': + description: Offre dépassée. + '404': + description: Liste non trouvée. + '503': + description: Service momentanément indisponible. + delete: + tags: + - Surveillance + summary: Supprime une (ou plusieurs) notification(s) d'une liste. + description: >- + Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant + de votre liste. + operationId: surveillance-notifications-delete + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: id_liste + in: query + description: Identifiant unique de votre liste de surveillance + required: true + schema: + type: string + example: votre_identifiant_ici + - name: siren + in: query + description: >- + Liste des sirens des notifications à supprimer, séparés par une + virgule + required: false + schema: + type: string + example: 443061841,950370973 + - name: id + in: query + description: Liste des ids des notifications à supprimer, séparés par une virgule + required: false + schema: + type: string + example: >- + ecfca3e5fb1ce07bb3fdfe8760a28df5aa617ed4951b7f61,a67b9de66189ba98eb4aede09f4b2b565b0f18fe694da7bc + - name: supprimer_totalite + in: query + description: Suppression de toutes les notifications de la liste + required: false + schema: + type: boolean + example: true + responses: + '200': + description: Succés. + content: + application/json: + schema: + type: object + description: Nombre de notifications supprimées. + properties: + notifications_supprimees: + type: number + example: 10 + description: >- + Le nombre de notifications supprimées de votre liste de + surveillance. + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '404': + description: Liste non trouvée. + '503': + description: Service momentanément indisponible. + /liste-informations: + post: + tags: + - Surveillance + summary: Ajoute des informations à une (ou plusieurs) notification(s). + description: >- + Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant + de votre liste. + operationId: surveillance-liste-informations + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: id_liste + in: query + description: Identifiant unique de votre liste de surveillance d'entreprises + required: true + schema: + type: string + example: votre_identifiant_ici + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + notifications: + type: array + description: Tableau d'identifiant de notifications + items: + type: string + example: ecfca3e5fb1ce07bb3fdfe8760a28df5aa617ed4951b7f61 + informations: + type: string + example: Information quelconque + description: Information à rajouter sur les notifications + maxLength: 255 + responses: + '200': + description: Succés. + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '404': + description: Liste non trouvée. + '503': + description: Service momentanément indisponible. +components: + parameters: + api_token: + name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + par_page: + name: par_page + in: query + description: 'Nombre de résultats affichés sur une page. Valeur par défaut : `10`.' + required: false + schema: + type: integer + example: 20 + page: + name: page + in: query + description: 'Page de résultats. Valeur par défaut : `1`.' + required: false + schema: + type: integer + example: 1 + bases: + name: bases + in: query + description: >- + Bases de données dans lesquelles rechercher. Il est possible d'indiquer + plusieurs bases en les séparant par des virgules. Valeur par défaut : + `"entreprises"`. + required: false + schema: + type: string + enum: + - entreprises + - dirigeants + - beneficiaires + - documents + - publications + example: entreprises + precision: + name: precision + in: query + description: 'Niveau de précision de la recherche. Valeur par défaut : `"standard"`.' + required: false + schema: + type: string + enum: + - approximative + - standard + - exacte + example: standard + curseur: + name: curseur + in: query + description: >- + Curseur servant à parcourir l'ensemble des résultats (alternativement à + la pagination qui est limitée à 400 résultats maximum). Doit valoir `*` + pour la première requête, et doit pour les requêtes suivantes reprendre + la valeur `curseurSuivant` retournée par la dernière réponse. + required: false + schema: + type: string + example: '*' + par_curseur: + name: par_curseur + in: query + description: >- + Nombre de résultats affichés par curseur. Valeur par défaut : `50`. + Valeur minimale: `1`. Valeur maximale : `1000`. + required: false + schema: + type: integer + example: 20 + code_naf: + name: code_naf + in: query + description: >- + Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes NAF + en les séparant par des virgules. + required: false + schema: + type: string + example: 70.10Z + departement: + name: departement + in: query + description: >- + Numéro de département de l'un des établissements de l'entreprise. Il est + possible d'indiquer plusieurs départements en les séparant par des + virgules. + required: false + schema: + type: string + example: 75 + region: + name: region + in: query + description: >- + Code de la région de l'un des établissements de l'entreprise, selon la + [nomenclature + Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il + est possible d'indiquer plusieurs codes régions en les séparant par des + virgules. + required: false + schema: + type: string + example: 11 + code_postal: + name: code_postal + in: query + description: >- + Code postal de l'un des établissements de l'entreprise. Il est possible + d'indiquer plusieurs codes postaux en les séparant par des virgules. + required: false + schema: + type: string + example: 75009 + convention_collective: + name: convention_collective + in: query + description: Convention collective de l'entreprise. + required: false + schema: + type: string + example: 1486 + categorie_juridique: + name: categorie_juridique + in: query + description: >- + Catégorie juridique de l'entreprise, selon la [nomenclature + Insee](https://www.insee.fr/fr/information/2028129). + + + **Note** : Le code correspond à celui de l'INSEE, à l'exception des SASU + qui auront comme code 5720 et les EURL qui auront comme code 5498. + required: false + schema: + type: string + example: 5499 + entreprise_cessee: + name: entreprise_cessee + in: query + description: Activité de l'entreprise cessée ou non. + required: false + schema: + type: boolean + example: false + statut_rcs: + name: statut_rcs + in: query + description: Statut au RCS + required: false + schema: + type: string + enum: + - inscrit + - radie + - non inscrit + example: inscrit + objet_social: + name: objet_social + in: query + description: Objet social de l'entreprise déclaré au RCS. + required: false + schema: + type: string + example: La conception de moteurs de recherche sur internet. + date_immatriculation_rcs_min: + name: date_immatriculation_rcs_min + in: query + description: >- + Date d'immatriculation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + required: false + schema: + type: string + example: 15-05-2002 + date_immatriculation_rcs_max: + name: date_immatriculation_rcs_max + in: query + description: d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA. + required: false + schema: + type: string + example: 15-05-2002 + date_radiation_rcs_min: + name: date_radiation_rcs_min + in: query + description: Date de radiation au RCS minimale de l'entreprise, au format JJ-MM-AAAA. + required: false + schema: + type: string + example: 15-05-2002 + date_radiation_rcs_max: + name: date_radiation_rcs_max + in: query + description: Date de radiation au RCS maximale de l'entreprise, au format JJ-MM-AAAA. + required: false + schema: + type: string + example: 17-05-2002 + capital_min: + name: capital_min + in: query + description: Capital minimum de l'entreprise. + required: false + schema: + type: string + example: 411016200 + capital_max: + name: capital_max + in: query + description: Capital maximum de l'entreprise. + required: false + schema: + type: string + example: 411016400 + chiffre_affaires_min: + name: chiffre_affaires_min + in: query + description: >- + Chiffre d'affaires minimum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + required: false + schema: + type: string + example: 411016200 + chiffre_affaires_max: + name: chiffre_affaires_max + in: query + description: >- + Chiffre d'affaires maximum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + required: false + schema: + type: string + example: 411016400 + resultat_min: + name: resultat_min + in: query + description: >- + Résultat minimum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + required: false + schema: + type: string + example: 29327000 + resultat_max: + name: resultat_max + in: query + description: >- + Résultat maximum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + required: false + schema: + type: string + example: 29327100 + date_creation_min: + name: date_creation_min + in: query + description: Date de création minimale de l'entreprise, au format JJ-MM-AAAA. + required: false + schema: + type: string + example: 15-05-2002 + date_creation_max: + name: date_creation_max + in: query + description: Date de création maximale de l'entreprise, au format JJ-MM-AAAA. + required: false + schema: + type: string + example: 17-05-2002 + tranche_effectif_min: + name: tranche_effectif_min + in: query + description: >- + Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen). + + + **Note** : 00 ou NN donneront les mêmes résultats et veulent dire non + employeur + required: false + schema: + type: string + example: 40 + tranche_effectif_max: + name: tranche_effectif_max + in: query + description: >- + Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen). + + + **Note** : 00 ou NN donneront les mêmes résultats et veulent dire non + employeur + required: false + schema: + type: string + example: 42 + type_dirigeant: + name: type_dirigeant + in: query + description: >- + Type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + required: false + schema: + type: string + enum: + - physique + - morale + example: physique + qualite_dirigeant: + name: qualite_dirigeant + in: query + description: >- + Qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + required: false + schema: + type: string + example: Administrateur + nationalite_dirigeant: + name: nationalite_dirigeant + in: query + description: >- + Nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + required: false + schema: + type: string + example: Française + nom_dirigeant: + name: nom_dirigeant + in: query + description: >- + Nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + required: false + schema: + type: string + example: Yi + prenom_dirigeant: + name: prenom_dirigeant + in: query + description: >- + Prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + required: false + schema: + type: string + example: Kenneth H. + age_dirigeant_min: + name: age_dirigeant_min + in: query + description: >- + Âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + required: false + schema: + type: integer + example: 40 + age_dirigeant_max: + name: age_dirigeant_max + in: query + description: >- + Âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + required: false + schema: + type: integer + example: 42 + date_de_naissance_dirigeant_min: + name: date_de_naissance_dirigeant_min + in: query + description: >- + Date de naissance minimale du dirigeant (ou de l'un des dirigeants de + l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '1970-01-01T00:00:00.000Z' + date_de_naissance_dirigeant_max: + name: date_de_naissance_dirigeant_max + in: query + description: >- + Date de naissance maximale du dirigeant (ou de l'un des dirigeants de + l'entreprise pour une recherche d'entreprises) de l'entreprise, au + format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '1970-12-31T00:00:00.000Z' + age_beneficiaire_min: + name: age_beneficiaire_min + in: query + description: >- + Âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + required: false + schema: + type: integer + example: 40 + age_beneficiaire_max: + name: age_beneficiaire_max + in: query + description: >- + Âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + required: false + schema: + type: integer + example: 42 + date_de_naissance_beneficiaire_min: + name: date_de_naissance_beneficiaire_min + in: query + description: >- + Date de naissance minimale du bénéficiaire effectif (ou de l'un des + bénéficiaires effectifs de l'entreprise pour une recherche + d'entreprises), au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '1970-01-01T00:00:00.000Z' + date_de_naissance_beneficiaire_max: + name: date_de_naissance_beneficiaire_max + in: query + description: >- + Date de naissance maximale du bénéficiaire effectif (ou de l'un des + bénéficiaires effectifs de l'entreprise pour une recherche + d'entreprises) de l'entreprise, au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '1970-12-31T00:00:00.000Z' + nationalite_beneficiaire: + name: nationalite_beneficiaire + in: query + description: >- + Nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + required: false + schema: + type: string + example: Française + date_depot_document_min: + name: date_depot_document_min + in: query + description: Date de dépôt minimale du document, au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '2000-01-01T00:00:00.000Z' + date_depot_document_max: + name: date_depot_document_max + in: query + description: Date de dépôt maximale du document, au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '2000-12-31T00:00:00.000Z' + type_publication: + name: type_publication + in: query + description: Type de publication + required: false + schema: + type: string + enum: + - Création + - Immatriculation + - Modification + - Vente + - Radiation + - Procédure collective + - Dépôt des comptes + example: Procédure collective + date_publication_min: + name: date_publication_min + in: query + description: Date publication minimale de la publication, au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '2000-01-01T00:00:00.000Z' + date_publication_max: + name: date_publication_max + in: query + description: Date de publication maximale de la publication, au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '2000-12-31T00:00:00.000Z' + siren: + name: siren + in: query + description: SIREN de l'entreprise. + required: false + schema: + type: string + example: null + schemas: + EntrepriseBase: + type: object + properties: + siren: + type: string + example: '443061841' + description: Le numéro SIREN de l'entreprise au format xxxxxxxxx. + siren_formate: + type: string + example: 443 061 841 + description: Le numéro SIREN de l'entreprise au format xxx xxx xxx. + nom_entreprise: + type: string + example: GOOGLE FRANCE + description: >- + Le nom de l'entreprise. Il est égal à sigle + dénomination en cas de + personne morale, ou à nom + prénom en cas de personne physique. + Nullable si le paramètre `integrer_diffusions_partielles` est à + vrai. + personne_morale: + type: boolean + description: Vrai en cas de personne morale, faux en cas de personne physique. + denomination: + type: string + format: nullable + description: Dénomination de l'entreprise si personne morale. + example: GOOGLE FRANCE + nom: + type: string + format: nullable + description: Nom si personne physique. + example: null + prenom: + type: string + format: nullable + description: Prénom si personne physique. + example: null + sexe: + type: string + format: nullable + description: Sexe si personne physique. F pour féminin, M pour masculin. + example: null + code_naf: + type: string + description: Code NAF de l'entreprise. + example: 70.10Z + libelle_code_naf: + type: string + description: Libellé du code NAF de l'entreprise. + example: Activités des sièges sociaux + domaine_activite: + type: string + description: Domaine d'activité de l'entreprise. + example: Activités des sièges sociaux ; conseil de gestion + conventions_collectives: + description: Liste des conventions collectives de l'entreprise. + type: array + items: + type: object + properties: + nom: + type: string + description: Nom de la convention collective. + example: >- + Convention collective nationale applicable au personnel des + bureaux d'études techniques des cabinets d'ingénieurs-conseils + et des sociétés de conseils(BET SYNTEC) + idcc: + type: integer + description: Code IDCC de l'entreprise. + example: 1486 + confirmee: + type: boolean + description: >- + Si confirmée, l'information est issue de la DSN de + l'entreprise et fournie par le ministère du Travail. Si non + confirmée, ce n'est qu'une estimation à partir du code NAF de + l'entreprise. + pourcentage: + type: number + format: nullable + description: >- + Pourcentage de fiabilité de l'estimation. Si la convention est + confirmée, vaut null. + example: 96.2 + date_creation: + type: string + format: date + description: Date de création de l'entreprise au format AAAA-MM-JJ. + example: '2002-05-16' + date_creation_formate: + type: string + description: Date de création de l'entreprise au format JJ/MM/AAAA. + example: 16/05/2002 + entreprise_cessee: + type: boolean + description: >- + Si vrai, l'entreprise n'est plus en activité. Sinon, elle est + toujours en activité. + date_cessation: + type: string + format: nullable + description: Date de cessation de l'entreprise au format AAAA-MM-JJ. + example: '2002-05-16' + entreprise_employeuse: + type: boolean + description: Si vrai, l'entreprise a au moins un employé. + societe_a_mission: + type: boolean + format: nullable + description: Si vrai, l'entreprise est société à mission. + categorie_juridique: + type: string + description: >- + Catégorie juridique de l'entreprise, selon la [nomenclature + Insee](https://www.insee.fr/fr/information/2028129). + + + **Note** : Le code correspond à celui de l'INSEE, à l'exception des + SASU qui auront comme code 5720 et les EURL qui auront comme code + 5498. + example: '5499' + forme_juridique: + type: string + description: Forme juridique de l'entreprise. + example: Société à responsabilité limitée (SARL) + forme_exercice: + type: string + enum: + - Agent commercial + - 'Agricole : Périmètre des non actifs agricoles' + - 'Agricole : Périmètre des actifs agricoles' + - Artisanale non réglementée + - Artisanale réglementée + - Commerciale + - Libérale non réglementée + - Libérale réglementée + - Loueur meublé + - Toute forme d'activité + - Gestion de biens + - Loueur terre agricole + - Activité de prospection uniquement (non commerciale) + - Sans activité + description: Forme d'exercice de l'activité principale. + format: nullable + example: Commerciale + effectif: + type: string + description: Tranche d'effectif de l'entreprise. + example: Entre 500 et 999 salariés + effectif_min: + type: integer + description: Effectif minimal de l'entreprise. + example: 500 + effectif_max: + type: integer + description: Effectif maximal de l'entreprise. + example: 999 + tranche_effectif: + type: string + format: nullable + description: >- + Tranche d'effectif de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen#:~:text=Cette%20variable%20correspond%20%C3%A0%20la,effectif%20salari%C3%A9%20de%20l'entreprise.). + example: '41' + annee_effectif: + type: integer + format: nullable + description: >- + Année de validité des variables effectif, effectif_min et + effectif_max. + example: 2017 + capital: + type: number + format: nullable + description: Capital de l'entreprise. + example: 464884017 + statut_rcs: + type: string + format: nullable + description: Statut de l'entreprise au RCS + example: Inscrit + EntrepriseFiche: + allOf: + - $ref: '#/components/schemas/EntrepriseBase' + - type: object + properties: + siege: + $ref: '#/components/schemas/EtablissementFiche' + diffusable: + type: boolean + description: >- + Le statut de diffusion de l'entreprise. Non diffusable + correspond à une entreprise ayant demandé une diffusion + partielle de ses données. Aucune information n'est alors + disponible, sauf si vous utilisez le paramètre + `integrer_diffusions_partielles`. + sigle: + type: string + format: nullable + description: Sigle de l'entreprise si personne morale. + example: null + objet_social: + type: string + format: nullable + description: Objet social de l'entreprise. + example: >- + Fourniture de services et/ou conseils relatifs aux logiciels au + réseau internet aux réseaux télématiques ou en ligne notamment + L'intermediation en matière de vente de publicité en ligne la + promotion sous toutes ses formes de la publicité en ligne la + promotion directe de produits et services et la mise en oeuvre + de centres de traitement de l'information + capital_formate: + type: string + format: nullable + description: Capital l'entreprise au format xx xxx €. + example: "464 884 017,00\_€" + capital_actuel_si_variable: + type: string + format: nullable + description: Capital actuel de l'entreprise si variable. + example: null + devise_capital: + type: string + format: nullable + description: Devise de capital_formate et capital_actuel_si_variable. + example: Euros + numero_rcs: + type: string + format: nullable + description: Numéro RCS de l'entreprise. + example: 464884017 R.C.S. Paris + date_cloture_exercice: + type: string + format: nullable + description: Date de clôture d'exercice de l'entreprise. + example: null + date_cloture_exercice_exceptionnelle: + type: string + format: nullable + description: Date de clôture d'exercice exceptionnel de l'entreprise. + example: null + date_cloture_exercice_exceptionnelle_formate: + type: string + format: nullable + description: >- + Date de clôture d'exercice exceptionnel formatée de + l'entreprise. + example: null + prochaine_date_cloture_exercice: + type: string + format: nullable + description: Prochaine date de clôture d'exercice de l'entreprise. + example: null + prochaine_date_cloture_exercice_formate: + type: string + format: nullable + description: Prochaine date de clôture d'exercice formatée de l'entreprise. + example: null + economie_sociale_solidaire: + type: boolean + description: >- + Vrai si l'entreprise est une entreprise de l'économie sociale et + solidaire. + duree_personne_morale: + type: string + format: nullable + description: Durée de la personne morale. + example: null + dernier_traitement: + type: string + format: date + description: Date de dernier traitement de l'entreprise. + example: '2020-07-09' + derniere_mise_a_jour_sirene: + type: string + format: date + description: >- + Dernière mise à jour de la base de donnée sirène au format + AAAA-MM-JJ. + example: '2020-08-13' + derniere_mise_a_jour_rcs: + type: string + format: date + description: >- + Dernière mise à jour de la base de donnée RCS au format + AAAA-MM-JJ. + example: '2020-06-25' + statut_rcs: + type: string + enum: + - Inscrit + - Non inscrit + - Radié + description: Statut de l'entreprise au RCS. + example: Inscrit + greffe: + type: string + format: nullable + description: Greffe RCS de l'entreprise. + example: Paris + code_greffe: + type: string + format: nullable + description: Code greffe RCS de l'entreprise. + example: '7501' + date_immatriculation_rcs: + type: string + format: nullable + description: Date d'immatriculation de l'entreprise au RCS. + example: null + date_premiere_immatriculation_rcs: + type: string + format: nullable + description: Date de la première immatriculation de l'entreprise au RCS. + example: null + date_debut_activite: + type: string + format: nullable + description: Date de début d'activité de l'entreprise. + example: '2002-08-14' + date_debut_premiere_activite: + type: string + format: nullable + description: Date de début d'activité de l'entreprise. + example: null + date_radiation_rcs: + type: string + format: nullable + description: Date de radiation de l'entreprise au RCS. + example: null + statut_rne: + type: string + format: nullable + enum: + - Inscrit + - Non inscrit + - Radié + description: Statut de l'entreprise au RNE. + example: null + date_immatriculation_rne: + type: string + format: nullable + description: Date d'immatriculation de l'entreprise au RNE. + example: null + date_radiation_rne: + type: string + format: nullable + description: Date de radiation de l'entreprise au RNE. + example: null + numero_tva_intracommunautaire: + type: string + description: Numéro de TVA intracommunautaire de l'entreprise. + example: FR64443061841 + validite_tva_intracommunautaire: + type: boolean + format: optional, nullable + description: >- + Présent uniquement si le paramètre + validite_tva_intracommunautaire a été mis à vrai. + + + Si vrai, le numéro de TVA intracommunautaire est valide. Si + faux, il est invalide. Si null, la validité n'a pas pu être + vérifiée. + example: true + associe_unique: + type: boolean + format: nullable + description: >- + Si vrai, l'entreprise est à associé unique (notamment pour les + SASU et les EURL). + micro_entreprise: + type: boolean + format: optional + description: Si vrai, l'entreprise possède le statut de micro-entrepreneur + example: false + etablissements: + type: array + description: Liste des établissements de l'entreprise. + items: + $ref: '#/components/schemas/EtablissementFiche' + finances: + type: array + description: Liste des finances de l'entreprise. + items: + allOf: + - type: object + properties: + annee: + type: integer + description: Année de cloture d'exercice. + example: 2018 + date_de_cloture_exercice: + type: string + format: date + description: >- + Date de cloture de l'exercice des finances de + l'entreprise. + example: '2018-12-31' + duree_exercice: + type: integer + description: Durée de l'exercice de l'entreprise." + example: 12 + - $ref: '#/components/schemas/Ratios' + representants: + type: array + description: Liste des représentants de l'entreprise. + items: + $ref: '#/components/schemas/Representant' + beneficiaires_effectifs: + type: array + description: >- + Liste des bénéficiaires effectifs de l'entreprise (si + disponibles). + items: + type: object + properties: + date_greffe: + type: string + format: date nullable + description: >- + Date de génération des bénéficiaires effectifs, au format + AAAA-MM-JJ. + example: '2021-01-06' + type: + type: string + format: nullable + description: Type du bénéficiaire effectif + example: BE_SOC + nom: + type: string + format: nullable + description: Nom du bénéficiaire effectif. + example: McCourt JR + nom_usage: + type: string + format: nullable + description: Nom d'usage du bénéficiaire effectif. + example: null + prenom: + type: string + format: nullable + description: Prénom du bénéficiaire effectif. + example: Frank + pseudonyme: + type: string + format: nullable + example: null + date_de_naissance_formatee: + type: string + format: nullable + description: >- + Mois et année de naissance du bénéficiaire effectif, au + format MM/AAAA. + example: 08/1953 + date_de_naissance_complete_formatee: + type: string + format: date nullable + description: >- + Date de naissance complète du bénéficiaire effectif, au + format JJ/MM/AAAA. + example: 14/08/1953 + nationalite: + type: string + format: nullable + description: Nationalité du bénéficiaire effectif. + example: Américaine (Etats Unis) + code_nationalite: + type: string + format: nullable + description: Code de la nationalité du bénéficiaire effectif. + example: US + ville_de_naissance: + type: string + format: nullable + description: Ville de naissance du bénéficiaire effectif. + example: Massachusetts + pays_de_naissance: + type: string + format: nullable + description: Pays de naissance du bénéficiaire effectif. + example: ETATS-UNIS D'AMERIQUE + code_pays_de_naissance: + type: string + format: nullable + description: Code du pays de naissance du bénéficiaire effectif. + example: US + adresse_ligne_1: + type: string + format: nullable + description: Première ligne de l'adresse du bénéficiaire effectif. + example: null + adresse_ligne_2: + type: string + format: nullable + description: Deuxième ligne de l'adresse du bénéficiaire effectif. + example: 888 Seventh Avenue 43rd Floor New York (Etat de New York) + adresse_ligne_3: + type: string + format: nullable + description: Troisième ligne de l'adresse du bénéficiaire effectif. + example: null + code_postal: + type: string + format: nullable + description: Code postal du bénéficiaire effectif. + example: null + ville: + type: string + format: nullable + description: Ville du bénéficiaire effectif. + example: null + pays: + type: string + format: nullable + description: Pays du bénéficiaire effectif. + example: ETATS-UNIS D'AMERIQUE + code_pays: + type: string + format: nullable + description: Code du pays du bénéficiaire effectif. + example: US + pourcentage_parts: + type: number + format: nullable + description: >- + Parts détenues par le bénéficiaire effectif, en + pourcentage des parts totales. + pourcentage_parts_directes: + type: number + format: nullable + description: >- + Parts détenues de façon directe par le bénéficiaire + effectif, en pourcentage des parts totales. + pourcentage_parts_indirectes: + type: number + format: nullable + description: >- + Parts détenues de façon indirecte par le bénéficiaire + effectif, en pourcentage des parts totales. + pourcentage_parts_vocation_titulaire: + type: number + format: nullable + description: >- + Parts dont le bénéficiaire effectif a vocation à devenir + titulaire par l'effet d'un acte juridique, en pourcentage + des parts totales. + details_parts_directes: + type: object + format: nullable + description: >- + Détails des parts détenues de façon directe par le + bénéficiaire effectif. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Parts détenues de façon directe en pleine propriété + par le bénéficiaire effectif, en pourcentage des parts + totales. + pourcentage_nue_propriete: + type: number + description: >- + Parts détenues de façon directe en nue propriété par + le bénéficiaire effectif, en pourcentage des parts + totales. + details_parts_indirectes: + type: object + format: nullable + description: >- + Détails des parts détenues de façon indirecte par le + bénéficiaire effectif. + properties: + pourcentage_en_indivision: + type: number + description: >- + Parts détenues de façon indirecte par le biais d'une + indivision par le bénéficiaire effectif, en + pourcentage des parts totales. + pourcentage_en_personne_morale: + type: number + description: >- + Parts détenues de façon indirecte par le biais d'une + personne morale par le bénéficiaire effectif, en + pourcentage des parts totales. + details_en_indivision: + type: object + format: nullable + description: >- + Détails des parts détenues de façon indirecte par le + biais d'une indivision par le bénéficiaire effectif. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Parts détenues de façon indirecte par le biais + d'une indivision en pleine propriété par le + bénéficiaire effectif, en pourcentage des parts + totales. + pourcentage_nue_propriete: + type: number + description: >- + Parts détenues de façon indirecte par le biais + d'une indivision en nue propriété par le + bénéficiaire effectif, en pourcentage des parts + totales. + details_en_personne_morale: + type: object + format: nullable + description: >- + Détails des parts détenues de façon indirecte par le + biais d'une personne morale par le bénéficiaire + effectif. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Parts détenues de façon indirecte par le biais + d'une personne morale en pleine propriété par le + bénéficiaire effectif, en pourcentage des parts + totales. + pourcentage_nue_propriete: + type: number + description: >- + Parts détenues de façon indirecte par le biais + d'une personne morale en nue propriété par le + bénéficiaire effectif, en pourcentage des parts + totales. + details_parts_vocation_titulaire: + type: object + format: nullable + description: >- + Détails des parts dont le bénéficiaire effectif a vocation + à devenir titulaire. + properties: + pourcentage_directes: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon directe, en pourcentage des + parts totales. + pourcentage_indirectes: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon indirecte, en pourcentage + des parts totales. + details_directes: + type: object + format: nullable + description: >- + Détails des parts dont le bénéficiaire effectif a + vocation à devenir titulaire de façon directe. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon directe en pleine + propriété, en pourcentage des parts totales. + pourcentage_nue_propriete: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon directe en nue + propriété, en pourcentage des parts totales. + details_indirectes: + type: object + format: nullable + description: >- + Détails des parts dont le bénéficiaire effectif a + vocation à devenir titulaire de façon indirecte. + properties: + pourcentage_en_indivision: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon indirecte par le biais + d'une indivision, en pourcentage des parts + totales. + pourcentage_en_personne_morale: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon indirecte par le biais + d'une personne morale, en pourcentage des parts + totales. + details_en_indivision: + type: object + format: nullable + description: >- + Détails des parts dont le bénéficiaire effectif a + vocation à devenir titulaire de façon indirecte + par le biais d'une indivision. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation + à devenir titulaire de façon indirecte par le + biais d'une indivision en pleine propriété, en + pourcentage des parts totales. + pourcentage_nue_propriete: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation + à devenir titulaire de façon indirecte par le + biais d'une indivision en nue propriété, en + pourcentage des parts totales. + details_en_personne_morale: + type: object + format: nullable + description: >- + Détails des parts dont le bénéficiaire effectif a + vocation à devenir titulaire de façon indirecte + par le biais d'une personne morale. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation + à devenir titulaire de façon indirecte par le + biais d'une personne morale en pleine + propriété, en pourcentage des parts totales. + pourcentage_nue_propriete: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation + à devenir titulaire de façon indirecte par le + biais d'une personne morale en nue propriété, + en pourcentage des parts totales. + pourcentage_votes: + type: number + format: nullable + description: >- + Droits de vote détenus par le bénéficiaire effectif, en + pourcentage des droits de vote totaux. + pourcentage_votes_directs: + type: number + format: nullable + description: >- + Droits de vote détenus de façon directe par le + bénéficiaire effectif, en pourcentage des droits de vote + totaux. + pourcentage_votes_indirect: + type: number + format: nullable + description: >- + Droits de vote détenus de façon indirecte par le + bénéficiaire effectif, en pourcentage des droits de vote + totaux. + details_votes_directs: + type: object + format: nullable + description: >- + Détails des droits de vote détenus de façon directe par le + bénéficiaire effectif. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Droits de vote détenus de façon directe en pleine + propriété par le bénéficiaire effectif, en pourcentage + des droits de vote totaux. + pourcentage_nue_propriete: + type: number + description: >- + Droits de vote détenus de façon directe en nue + propriété par le bénéficiaire effectif, en pourcentage + des droits de vote totaux. + pourcentage_usufruit: + type: number + description: >- + Droits de vote détenus de façon directe en usufruit + par le bénéficiaire effectif, en pourcentage des + droits de vote totaux. + details_votes_indirects: + type: object + format: nullable + description: >- + Détails des droits de vote détenus de façon indirecte par + le bénéficiaire effectif. + properties: + pourcentage_en_indivision: + type: number + description: >- + Droits de vote détenus de façon indirecte par le biais + d'une indivision par le bénéficiaire effectif, en + pourcentage des droits de vote totaux. + pourcentage_en_personne_morale: + type: number + description: >- + Droits de vote détenus de façon indirecte par le biais + d'une personne morale par le bénéficiaire effectif, en + pourcentage des droits de vote totaux. + details_en_indivision: + type: object + format: nullable + description: >- + Détails des droits de vote détenus de façon indirecte + par le biais d'une indivision par le bénéficiaire + effectif. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une indivision en pleine propriété par le + bénéficiaire effectif, en pourcentage des droits + de vote totaux. + pourcentage_nue_propriete: + type: number + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une indivision en nue propriété par le + bénéficiaire effectif, en pourcentage des droits + de vote totaux. + pourcentage_usufruit: + type: number + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une indivision en usufruit par le + bénéficiaire effectif, en pourcentage des droits + de vote totaux. + details_en_personne_morale: + type: object + format: nullable + description: >- + Détails des droits de vote détenus de façon indirecte + par le biais d'une personne morale par le bénéficiaire + effectif. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une personne morale en pleine propriété + par le bénéficiaire effectif, en pourcentage des + droits de vote totaux. + pourcentage_nue_propriete: + type: number + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une personne morale en nue propriété par + le bénéficiaire effectif, en pourcentage des + droits de vote totaux. + pourcentage_usufruit: + type: number + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une personne morale en usufruit par le + bénéficiaire effectif, en pourcentage des droits + de vote totaux. + details_societe_de_gestion: + type: object + format: nullable + description: Détails sur la société de gestion, le cas échéant. + properties: + nom: + type: string + format: nullable + description: Nom de la société de gestion. + siren: + type: string + format: nullable + description: SIREN de la société de gestion. + greffe: + type: string + format: nullable + description: Greffe de la société de gestion. + adresse: + type: string + format: nullable + description: Adresse de la société de gestion. + code_postal: + type: string + format: nullable + description: Code postal de la société de gestion. + ville: + type: string + format: nullable + description: Ville de la société de gestion. + detention_pouvoir_decision_ag: + type: boolean + description: >- + Vaut vrai pour les moyens de contrôle sur les organes + d'administration, de gestion, de direction ou de + surveillance de la personne morale autre que le pouvoir de + nommer ou de révoquer la majorité des membres. + detention_pouvoir_nom_membre_conseil_administration: + type: boolean + description: >- + Vaut vrai si le moyen de contrôle est le pouvoir de nommer + ou de révoquer la majorité des membres des organes + d'administration, de gestion, de direction ou de + surveillance de la personne morale. + detention_autres_moyens_controle: + type: boolean + description: Vaut vrai s'il existe d'autres moyens de contrôle. + beneficiaire_representant_legal: + type: boolean + description: >- + Vaut vrai dans le cas où le bénéficiaire effectif a été + défini comme le représentant légal par défaut. + representant_legal_placement_sans_gestion_delegation: + type: boolean + description: >- + Vaut vrai dans le cas où le bénéficiaire effectif est le + représentant légal du placement collectif (cas où le + placement collectif n'a pas délégué sa gestion à une + société de gestion). + personne_politiquement_exposee: + $ref: '#/components/schemas/PersonnePolitiquementExposee' + sanctions_en_cours: + type: boolean + format: optional + description: >- + Vaut vrai si le bénéficiaire effectif est actuellement + sous sanction. Uniquement présent si demandé dans les + champs supplémentaires. + sanctions: + type: array + description: >- + Liste des sanctions du bénéficiaire effectif. Uniquement + présent si demandé dans les champs supplémentaires. + items: + $ref: '#/components/schemas/Sanction' + depots_actes: + type: array + description: Liste des actes de l'entreprise. + items: + type: object + properties: + date_depot: + type: string + format: date + description: Date de dépôt de l'acte, au format AAAA-MM-JJ. + example: '2020-04-07' + date_depot_formate: + type: string + description: Date de dépôt formatée de l'acte, au format JJ/MM/AAAA. + example: 07/04/2020 + disponible: + type: boolean + description: >- + Disponibilité de l'acte. Un acte peut être indisponible + car il a été publié avant le 1er janvier 1993 ou bien car + il est confidentiel. + nom_fichier_pdf: + type: string + description: Nom du fichier pdf de l'acte. + example: GOOGLE FRANCE - Actes du 07-04-2020.pdf + token: + type: string + description: Token de l'acte. + example: >- + QTQ0MzA2MTg0MTIwMjAwNDA3RMOpY2lzaW9uKHMpIGRlIGwnYXNzb2Npw6kgdW5pcXVl + actes: + type: array + description: Détails de l'acte. + items: + type: object + properties: + type: + type: string + description: Type de l'acte. + example: Décision(s) de l'associé unique + decision: + type: string + format: nullable + description: Décision de l'acte. + example: Augmentation du capital social + date_acte: + type: string + format: date nullable + description: Date de l'acte, au format AAAA-MM-JJ. + example: '2020-03-04' + date_acte_formate: + type: string + format: nullable + description: Date formatée de l'acte, au format JJ/MM/AAAA. + example: 04/03/2020 + comptes: + type: array + description: Liste des comptes de l'entreprise. + items: + type: object + properties: + date_depot: + type: string + format: date + description: Date de dépôt des comptes. + example: '2020-07-16' + date_depot_formate: + type: string + description: Date de dépôt formatée des comptes. + example: 16/07/2020 + date_cloture: + type: string + format: date + description: Date de clôture des comptes, au format AAAA-MM-JJ. + example: '2019-12-31' + annee_cloture: + type: integer + description: Année de clôture des comptes. + example: 2019 + confidentialite: + description: Confidentialité totale des comptes. + type: boolean + confidentialite_compte_de_resultat: + description: >- + Confidentialité partielle des comptes (seul le compte de + résultat est confidentiel, le reste des comptes sont + disponibles). + type: boolean + disponible: + description: Disponibilité des comptes au format PDF. + type: boolean + nom_fichier_pdf: + type: string + format: optional + description: Nom du fichier PDF des comptes. + example: GOOGLE FRANCE - Comptes 2019.pdf + token: + type: string + format: optional + description: Token des comptes. + example: QzQ0MzA2MTg0MTIwMjAwNzE2 + disponible_xlsx: + description: Disponibilité des comptes au format XLSX. + type: boolean + nom_fichier_xlsx: + type: string + format: optional + description: Nom du fichier XLSX des comptes. + example: GOOGLE FRANCE - Comptes 2019.xlsx + token_xlsx: + type: string + format: optional + description: Token des comptes XLSX. + example: ASQSMAA2MTg8MTIwMjAwNz2s + publications_bodacc: + type: array + description: Liste des publications au Bodacc de l'entreprise. + items: + $ref: '#/components/schemas/Bodacc' + procedures_collectives: + type: array + description: Liste des procédures collectives de l'entreprise. + items: + type: object + properties: + type: + type: string + description: Type de la procédure collective. + example: Redressement judiciaire + enum: + - Redressement judiciaire + - Liquidation judiciaire ou Procédure de sauvegarde + date_debut: + type: string + description: >- + Date de début de la procédure collective, au format + AAAA-MM-JJ. + example: '2020-04-16T00:00:00.000Z' + date_fin: + type: string + description: >- + Date de fin de la procédure collective, au format + AAAA-MM-JJ. + example: '2020-08-27T00:00:00.000Z' + publications_bodacc: + type: array + description: >- + Liste des publications relatives à la procédure + collective. + items: + $ref: '#/components/schemas/Bodacc' + procedure_collective_existe: + description: >- + Vrai si l'entreprise a des procédures collectives (en cours ou + terminées), faux sinon. + type: boolean + procedure_collective_en_cours: + description: >- + Vrai si l'entreprise a des procédures collectives en cours, faux + sinon. + type: boolean + derniers_statuts: + type: object + description: Liste des statuts de l'entreprise. + properties: + date_depot: + type: string + format: date + description: Date de dépôt des statuts, au format AAAA-MM-JJ. + example: '2020-04-07' + date_depot_formate: + type: string + description: Date de dépôt formaté des statuts, au format JJ/MM/AAAA. + example: 07/04/2020 + disponible: + description: Disponibilité des statuts. + type: boolean + nom_fichier_pdf: + type: string + description: Nom du fichier pdf des statuts. + example: GOOGLE FRANCE - Actes du 07-04-2020.pdf + token: + type: string + description: Token des statuts. + example: >- + QTQ0MzA2MTg0MTIwMjAwNDA3RMOpY2lzaW9uKHMpIGRlIGwnYXNzb2Npw6kgdW5pcXVl + type: + type: string + description: Champ "type" du document contenant les statuts. + example: Statuts mis à jour + decision: + type: string + format: nullable + description: Champ "decision" du document contenant les statuts. + example: null + date_acte: + type: string + format: date + description: Date de publication des statuts, au format AAAA-MM-JJ. + example: '2020-03-04' + date_acte_formate: + type: string + description: Date de publication des statuts, au format JJ/MM/AAAA. + example: 04/03/2020 + extrait_immatriculation: + type: object + description: Extrait d'immatriculation de l'entreprise. + properties: + token: + type: string + description: Token + example: SzQ0MzA2MTg0MQ + rnm: + type: object + format: nullable + description: >- + Informations sur l'immatriculation de l'entreprise au Répertoire + des Métiers. + properties: + date_immatriculation: + type: string + description: >- + Date d'immatriculation au Répertoire des Métiers, au format + AAAA-MM-JJ. + example: '2021-02-16T00:00:00.000Z' + date_radiation: + type: string + format: nullable + description: >- + Date de radiation du Répertoire des Métiers, le cas échéant, + au format AAAA-MM-JJ. + example: null + date_debut_activite: + type: string + description: >- + Date de début d'activé déclarée au Répertoire des Métiers, + au format AAAA-MM-JJ. + example: '2021-01-01T00:00:00.000Z' + date_cessation_activite: + type: string + format: nullable + description: >- + Date de cessation d'activité déclarée au Répertoire des + Métiers, le cas échéant, au format AAAA-MM-JJ. + example: null + chambre_des_metiers: + type: string + description: Chambre des métiers où l'entreprise est immatriculée. + example: TARN-ET-GARONNE + qualification: + type: string + description: Qualification retenue par le Répertoire des Métiers. + example: ARTISAN + derniere_mise_a_jour: + type: string + description: >- + Date de dernière mise à jour de l'entreprise au Répertoire + des Métiers, au format AAAA-MM-JJ. + example: '2021-02-22T00:00:00.000Z' + marques: + type: array + description: >- + Liste des marques françaises déposées par l'entreprise. + Uniquement présent si le paramètre "marques" a été mis à vrai. + items: + type: object + properties: + numero: + type: string + description: Numéro de la marque. + example: FR7103728 + date_enregistrement: + type: string + description: Date d'enregistrement de la marque, au format AAAA-MM-JJ. + example: '2008-12-04T00:00:00.000Z' + date_expiration: + type: string + description: Date d'expiration de la marque au format AAAA-MM-JJ. + example: '2018-12-04T00:00:00.000Z' + lieu_enregistrement: + type: string + description: Lieu d'enregistrement de la marque. + example: 92 INPI - Dépôt électronique + statut: + type: string + description: >- + Statut de la marque. La description des différents types + est disponible en page 14 du document suivant : + https://www.inpi.fr/sites/default/files/doctech_marques_v1.6.pdf. + enum: + - Demande déposée + - Demande publiée + - Demande non publiée + - Demande irrecevable après publication + - Marque enregistrée + - Renouvellement demandé + - Marque renouvelée + - Demande totalement rejetée + - Marque ayant fait l'objet d'une renonciation totale + - Marque ayant fait l'objet d'un retrait total + - Marque annulée + - Marque expirée + example: Marque enregistrée + texte: + type: string + format: nullable + description: Texte de la marque. + example: Google + type: + type: string + description: Type de la marque. + enum: + - Mixte + - Figuratif + - Hologramme + - Son + - Texte + - 3D + - Position + - Mouvement + - Multimedia + - Motifs + - Couleur + - Forme + - Autre + example: Figurative + lien_image: + type: string + format: nullable + description: Lien vers l'image déposée. + example: https://data.inpi.fr/image/marques/FRXXXXXXXX + descriptions: + type: array + description: Liste des descriptions de la marque. + items: + type: string + description: Description + example: 'Demande d’extension : Polynésie française' + classes: + type: array + description: >- + Liste des classes (produits et services) de la marque. La + liste des classes est disponible sur le document suivant : + https://www.inpi.fr/sites/default/files/classification_nice_2021_0.pdf. + items: + type: object + properties: + code: + type: string + description: Code de la classe. + example: 35 + description: + type: string + description: Description de la classe. + example: >- + Publicité ; gestion des affaires commerciales ; + administration commerciale ; travaux de bureau. + deposant: + $ref: '#/components/schemas/PersonneMarque' + mandataire: + $ref: '#/components/schemas/PersonneMarque' + evenements: + type: array + description: Liste des événements associés à la marque. + items: + type: object + properties: + type: + type: string + description: Type d'événement. + example: Publication + identifiant_evenement: + type: string + format: nullable + description: Identifiant de l'événement. + reference: + type: string + format: nullable + description: Référence de l'événement. + date: + type: string + description: Date de l'événement, au format AAAA-MM-JJ. + example: '2008-12-04T00:00:00.000Z' + numero_bopi: + type: string + description: Numéro du BOPI dans lequel l'événement a été publié. + example: 2008-12 + date_bopi: + type: string + description: Date de publication du BOPI au format AAAA-MM-JJ. + example: '2008-12-04T00:00:00.000Z' + beneficiaire: + type: string + format: nullable + description: Bénéficiaire associé à l'événement. + association: + $ref: '#/components/schemas/Association' + labels: + type: array + description: >- + Liste des labels de l'entreprise. Uniquement présent si demandé + dans les champs supplémentaires. + items: + $ref: '#/components/schemas/Labels' + scoring_non_financier: + $ref: '#/components/schemas/ScoringNonFinancier' + scoring_financier: + $ref: '#/components/schemas/ScoringFinancier' + EntrepriseRecherche: + allOf: + - $ref: '#/components/schemas/EntrepriseBase' + - type: object + properties: + siege: + $ref: '#/components/schemas/EtablissementRecherche' + villes: + type: array + description: Liste des villes où l'entreprise a au moins un établissement. + items: + type: string + example: MONTPELLIER + chiffre_affaires: + type: integer + format: nullable + description: Chiffre d'affaires de l'entreprise. + example: 411016329 + resultat: + type: integer + format: nullable + description: Résultat de l'entreprise. + example: 29327087 + effectifs_finances: + type: integer + format: nullable + description: Effectif de l'entreprise. + example: 723 + annee_finances: + type: string + format: nullable + description: >- + Année de correspondance des variables financières + (chiffre_affaires, resultat, effectifs_finances). + example: '2018' + EtablissementFiche: + type: object + properties: + siret: + type: string + description: Numéro siret de l'établissement au format xxxxxxxxxxxxxx. + example: '44306184100047' + siret_formate: + type: string + description: Numéro siret de l'établissement au format xxx xxx xxx xxxxx. + example: 443 061 841 00047 + diffusion_partielle: + type: boolean + description: >- + Si vrai, l'établissement est en diffusion partielle. Dans ce cas, + tous les champs relatifs à son adresse - en dehors de la ville et du + pays - sont à `null`. + nic: + type: string + description: Numéro NIC de l'établissement. + example: '00047' + code_postal: + type: string + format: nullable + description: Code postal de l'établissement. + example: '75009' + ville: + type: string + format: nullable + description: Ville de l'établissement. + example: PARIS 9 + pays: + type: string + format: nullable + description: Pays de l'établissement + example: France + code_pays: + type: string + format: nullable + description: Code du pays de l'établissement + example: FR + latitude: + type: number + format: nullable + description: Latitude de l'établissement. + example: 48.876947 + longitude: + type: number + format: nullable + description: Longitude de l'établissement. + example: 2.329981 + etablissement_cesse: + type: boolean + format: nullable + description: Vrai si l'établissement est cessé, faux si il est en activité. + siege: + type: boolean + format: nullable + description: Vrai si l'établissement est siège, faux s'il ne l'est pas. + etablissement_employeur: + type: boolean + format: nullable + description: Si vrai, l'établissement a au moins un employé. + effectif: + type: string + format: nullable + description: Tranche d'effectif de l'établissement. + example: Entre 500 et 999 salariés + effectif_min: + type: integer + format: nullable + description: Effectif minimal de l'établissement. + example: 500 + effectif_max: + type: integer + format: nullable + description: Effectif maximal de l'établissement. + example: 999 + tranche_effectif: + type: string + format: nullable + description: >- + Tranche d'effectif de l'établissement, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen#:~:text=Cette%20variable%20correspond%20%C3%A0%20la,effectif%20salari%C3%A9%20de%20l'entreprise.). + example: '41' + annee_effectif: + type: integer + format: nullable + description: Année correspondante à la tranche d'effectif de l'établissement. + example: 2017 + code_naf: + type: string + format: nullable + description: Code NAF de l'établissement. + example: 70.10Z + libelle_code_naf: + type: string + format: nullable + description: Libellé du code NAF de l'établissement. + example: Activités des sièges sociaux + date_de_creation: + type: string + format: nullable + example: '2011-05-12T22:00:00.000Z' + numero_voie: + type: integer + format: nullable + description: Numéro de voie de l'établissement. + example: 8 + indice_repetition: + type: string + format: nullable + description: Indice de répétition de l'établissement. + example: null + type_voie: + type: string + format: nullable + description: Type de voie de l'établissement. + example: RUE + libelle_voie: + type: string + format: nullable + description: Libellé de la voie de l'établissement. + example: DE LONDRES + complement_adresse: + type: string + format: nullable + description: Complément d'adresse de l'établissement. + example: null + adresse_ligne_1: + type: string + format: nullable + description: >- + Première ligne de l'adresse de l'établissement. Correspond à + l'ensemble des données numero_voie, indice_repetition, type_voie et + libelle_voie. + example: 8 RUE DE LONDRES + adresse_ligne_2: + type: string + format: nullable + description: >- + Seconde ligne de l'adresse de l'établissement. Est égal à + complement_adresse + example: null + date_cessation: + type: string + format: nullable + description: Date de fermeture de l'établissement + example: '2014-05-12' + enseigne: + type: string + format: nullable + description: Enseigne de l'établissement + example: FROOGLE + nom_commercial: + type: string + format: nullable + description: Nom commercial de l'établissement + example: Froogle + domiciliation: + type: object + format: nullable + properties: + nom: + type: string + format: nullable + description: Nom de l'entreprise de domiciliation + example: WORK & SHARE + siren: + type: string + format: nullable + description: Siren de l'entreprise de domiciliation + example: '828053546' + predecesseurs: + type: array + format: optional + description: Liste des prédécesseurs de l'établissement. + items: + $ref: '#/components/schemas/LienSuccession' + successeurs: + type: array + format: optional + description: Liste des successeurs de l'établissement. + items: + $ref: '#/components/schemas/LienSuccession' + EtablissementRecherche: + type: object + properties: + siret: + type: string + description: Numéro siret de l'établissement au format xxxxxxxxxxxxxx. + example: '44306184100047' + siret_formate: + type: string + description: Numéro siret de l'établissement au format xxx xxx xxx xxxxx. + example: 443 061 841 00047 + nic: + type: string + description: Numéro NIC de l'établissement. + example: '00047' + numero_voie: + type: integer + format: nullable + description: Numéro de voie de l'établissement. + example: 8 + indice_repetition: + type: string + format: nullable + description: Indice de répétition de l'établissement. + example: null + type_voie: + type: string + format: nullable + description: Type de voie de l'établissement. + example: RUE + libelle_voie: + type: string + format: nullable + description: Libellé de la voie de l'établissement. + example: DE LONDRES + complement_adresse: + type: string + format: nullable + description: Complément d'adresse de l'établissement. + example: null + adresse_ligne_1: + type: string + format: nullable + description: >- + Première ligne de l'adresse de l'établissement. Correspond à + l'ensemble des données numero_voie, indice_repetition, type_voie et + libelle_voie. + example: 8 RUE DE LONDRES + adresse_ligne_2: + type: string + format: nullable + description: >- + Seconde ligne de l'adresse de l'établissement. Est égal à + complement_adresse + example: null + code_postal: + type: string + format: nullable + description: Code postal de l'établissement. + example: '75009' + ville: + type: string + format: nullable + description: Ville de l'établissement. + example: PARIS 9 + latitude: + type: number + format: nullable + description: Latitude de l'établissement. + example: 48.876947 + longitude: + type: number + format: nullable + description: Longitude de l'établissement. + example: 2.329981 + RepresentantSuggestions: + type: object + properties: + qualite: + type: string + description: Qualité du représentant. + example: Gérant + personne_morale: + description: >- + Vrai si le représentant est une personne morale, faux si personne + physique. + type: boolean + example: false + date_prise_de_poste: + type: string + description: Date de prise de poste du représentant. + example: '2017-08-03' + denomination: + type: string + description: Dénomination du représentant si personne morale. + format: optional + example: GOOGLE FRANCE + siren: + type: string + description: Siren du représentant si personne morale. + format: optional + example: '443061841' + forme_juridique: + type: string + format: optional + description: Forme juridique du représentant si personne morale. + example: Société par actions simplifiée + sexe: + type: string + description: >- + Sexe supposé du représentant si personne physique. F pour féminin, M + pour masculin. Ce champ est estimé à partir du prénom du + représentant. + format: optional + example: M + nom: + type: string + description: Nom du représentant. + format: optional + example: Yi + prenom: + type: string + description: Prénoms du représentant. + format: optional + example: Kenneth H. + prenom_usuel: + type: string + description: Prénom usuel du représentant. + format: optional + example: Kenneth + nom_complet: + type: string + description: Nom complet du représentant. + example: Kenneth H. Yi + date_de_naissance: + type: string + description: Date de naissance du représentant. + format: optional nullable + example: '1970-01-06' + date_de_naissance_formate: + type: string + description: Date de naissance formatée du représentant. + format: optional nullable + example: 06/01/1970 + age: + type: integer + description: Age du représentant. + format: optional + example: 50 + nationalite: + type: string + description: Nationalité du représentant. + format: optional + example: Américaine (Etats Unis) + code_nationalite: + type: string + description: Code nationalité du représentant + format: optional + example: US + ville_de_naissance: + type: string + description: Ville de naissance du représentant. + format: optional + example: Séoul + pays_de_naissance: + type: string + description: Pays de naissance du représentant. + format: optional + example: COREE DU SUD + code_pays_de_naissance: + type: string + description: Code du pays de naissance du représentant. + format: optional + example: KR + adresse_ligne_1: + type: string + description: Première ligne de l'adresse du représentant. + format: nullable + example: 1600 Amphitheatre Parkway Mountain View CA 94043 + adresse_ligne_2: + type: string + description: Deuxième ligne de l'adresse du représentant. + format: nullable + example: null + adresse_ligne_3: + type: string + description: Troisième ligne de l'adresse du représentant. + format: nullable + example: null + code_postal: + type: string + description: Code postal du représentant. + format: nullable + example: null + ville: + type: string + description: Ville du représentant. + format: nullable + example: null + pays: + type: string + format: nullable + description: Pays du représentant. + example: Etats-Unis + code_pays: + type: string + format: nullable + description: Code du pays du représentant + example: US + Representant: + type: object + properties: + qualite: + type: string + description: Qualité du représentant. + example: Gérant + personne_morale: + description: >- + Vrai si le représentant est une personne morale, faux si personne + physique. + type: boolean + example: false + date_prise_de_poste: + type: string + description: Date de prise de poste du représentant. + example: '2017-08-03' + denomination: + type: string + description: Dénomination du représentant si personne morale. + format: optional + example: GOOGLE FRANCE + siren: + type: string + description: Siren du représentant si personne morale. + format: optional + example: '443061841' + forme_juridique: + type: string + format: optional + description: Forme juridique du représentant si personne morale. + example: Société par actions simplifiée + sexe: + type: string + description: >- + Sexe supposé du représentant si personne physique. F pour féminin, M + pour masculin. Ce champ est estimé à partir du prénom du + représentant. + format: optional + example: M + nom: + type: string + description: Nom du représentant. + format: optional + example: Yi + prenom: + type: string + description: Prénoms du représentant. + format: optional + example: Kenneth H. + prenom_usuel: + type: string + description: Prénom usuel du représentant. + format: optional + example: Kenneth + nom_complet: + type: string + description: Nom complet du représentant. + example: Kenneth H. Yi + date_de_naissance: + type: string + description: Date de naissance du représentant. + format: optional nullable + example: '1970-01-06' + date_de_naissance_formate: + type: string + description: Date de naissance formatée du représentant. + format: optional nullable + example: 06/01/1970 + age: + type: integer + description: Age du représentant. + format: optional + example: 50 + nationalite: + type: string + description: Nationalité du représentant. + format: optional + example: Américaine (Etats Unis) + code_nationalite: + type: string + description: Code nationalité du représentant + format: optional + example: US + ville_de_naissance: + type: string + description: Ville de naissance du représentant. + format: optional + example: Séoul + pays_de_naissance: + type: string + description: Pays de naissance du représentant. + format: optional + example: COREE DU SUD + code_pays_de_naissance: + type: string + description: Code du pays de naissance du représentant. + format: optional + example: KR + adresse_ligne_1: + type: string + description: Première ligne de l'adresse du représentant. + format: nullable + example: 1600 Amphitheatre Parkway Mountain View CA 94043 + adresse_ligne_2: + type: string + description: Deuxième ligne de l'adresse du représentant. + format: nullable + example: null + adresse_ligne_3: + type: string + description: Troisième ligne de l'adresse du représentant. + format: nullable + example: null + code_postal: + type: string + description: Code postal du représentant. + format: nullable + example: null + ville: + type: string + description: Ville du représentant. + format: nullable + example: null + pays: + type: string + format: nullable + description: Pays du représentant. + example: Etats-Unis + code_pays: + type: string + format: nullable + description: Code du pays du représentant + example: US + personne_politiquement_exposee: + $ref: '#/components/schemas/PersonnePolitiquementExposee' + sanctions_en_cours: + type: boolean + format: optional + description: >- + Vaut vrai si le représentant est actuellement sous sanction. + Uniquement présent si demandé dans les champs supplémentaires. + sanctions: + type: array + description: >- + Liste des sanctions du représentant. Uniquement présent si demandé + dans les champs supplémentaires. + items: + $ref: '#/components/schemas/Sanction' + PersonnePolitiquementExposee: + type: object + format: optional + description: >- + Informations sur le statut de personne politiquement exposée. Uniquement + présent si demandé dans les champs supplémentaires. + properties: + en_cours: + type: boolean + format: nullable + description: Vaut vrai si la personne est actuellement politiquement exposée. + fonctions: + type: array + description: >- + Liste des fonctions actuelles et passées de la personne + politiquement exposée. + items: + type: object + properties: + fonction: + type: string + description: Nom de la fonction. + example: Premier ministre + pays: + type: string + format: nullable + description: Pays associé à la fonction. + example: France + code_pays: + type: string + format: nullable + description: Code pays associé à la fonction. + example: FR + en_cours: + type: boolean + format: nullable + description: Vaut vrai si la fonction est en cours. + example: true + date_debut: + type: string + format: nullable + description: Date de début de la fonction. + example: '2020-08-20' + date_fin: + type: string + format: nullable + description: Date de fin de la fonction. + example: '2022-08-20' + sources: + type: array + description: Liste des sources. + items: + type: object + properties: + nom: + type: string + description: Nom de la source. + example: CIA World Factbook heads of state and government + url: + type: string + format: nullable + description: Lien vers la source. + example: >- + https://www.opensanctions.org/datasets/us_cia_world_factbook + Sanction: + type: object + format: optional + properties: + description: + type: string + description: Description de la sanction. + example: Interdiction de gérer + autorite: + type: string + format: nullable + description: Autorité ayant prononcé la sanction. + example: Tribunal de commerce de Paris + pays: + type: string + format: nullable + description: Pays de la sanction. + example: France + code_pays: + type: string + format: nullable + description: Code du pays de la sanction. + example: FR + en_cours: + type: boolean + format: nullable + description: Vaut vrai si la sanction est en cours. + example: false + date_debut: + type: string + format: nullable + description: Date de début de la sanction. + example: '2020-08-20' + date_fin: + type: string + format: nullable + description: Date de fin de la sanction. + example: '2022-08-20' + sources: + type: array + description: Liste des sources. + items: + type: object + properties: + nom: + type: string + description: Nom de la source. + example: CIA World Factbook heads of state and government + url: + type: string + format: nullable + description: Lien vers la source. + example: https://www.opensanctions.org/datasets/us_cia_world_factbook + RepresentantRecherche: + allOf: + - $ref: '#/components/schemas/Representant' + - type: object + properties: + actuel: + type: boolean + description: Vaut vrai si le représentant est toujours à son poste. + date_depart_de_poste: + type: string + description: >- + Date de départ de poste dans le cas où le représentant n'est + plus un représentant actuel, au format AAAA-MM-JJ. + example: null + forme_juridique: + type: string + format: nullable + description: >- + Forme juridique du représentant dans le cas d'une personne + morale. + example: null + Beneficiaire: + type: object + properties: + nom: + type: string + format: nullable + description: Nom du bénéficiaire effectif. + example: Yi + nom_usage: + type: string + format: nullable + description: Nom d'usage du bénéficiaire effectif. + example: null + prenom: + type: string + description: Prénom du bénéficiaire effectif. + example: Kenneth H. + pseudonyme: + type: string + format: nullable + description: Pseudonyme du bénéficiaire effectif. + example: null + nom_complet: + type: string + description: Nom complet du bénéficiaire effectif. + example: Kenneth H. Yi + date_de_naissance_formate: + type: string + description: >- + Mois et année de naissance du bénéficiaire effectif, au format + MM/AAAA. + example: 01/1970 + nationalite: + type: string + description: Nationalité du bénéficiaire effectif. + example: Française + pourcentage_parts: + type: number + description: >- + Parts détenues par le bénéficiaire effectif, en pourcentage des + parts totales. + pourcentage_votes: + type: number + description: >- + Droits de vote détenus par le bénéficiaire effectif, en pourcentage + des droits de vote totaux. + pourcentage_votes_indirect: + type: number + description: >- + Droits de vote détenus de façon indirecte par le bénéficiaire + effectif, en pourcentage des droits de vote totaux. + pourcentage_votes_directs: + type: number + description: >- + Droits de vote détenus de façon directe par le bénéficiaire + effectif, en pourcentage des droits de vote totaux. + detention_autres_moyens_controle: + type: boolean + description: Vaut vrai s'il existe d'autres moyens de contrôle. + beneficiaire_representant_legal: + type: boolean + description: >- + Vaut vrai dans le cas où le bénéficiaire effectif a été défini comme + le représentant légal par défaut. + adresse_ligne_1: + type: string + format: nullable + description: Première ligne de l'adresse du bénéficiaire effectif. + example: null + adresse_ligne_2: + type: string + format: nullable + description: Deuxième ligne de l'adresse du bénéficiaire effectif. + example: null + adresse_ligne_3: + type: string + format: nullable + description: Troisième ligne de l'adresse du bénéficiaire effectif. + example: null + pourcentage_parts_vocation_titulaire: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à devenir titulaire + par l'effet d'un acte juridique, en pourcentage des parts totales. + representant_legal_placement_sans_gestion_delegation: + type: boolean + format: nullable + description: >- + Vaut vrai dans le cas où le bénéficiaire effectif est le + représentant légal du placement collectif (cas où le placement + collectif n'a pas délégué sa gestion à une société de gestion). + code_postal: + type: string + format: nullable + description: Code postal du bénéficiaire effectif. + example: null + detention_pouvoir_nom_membre_conseil_administration: + type: boolean + description: >- + Vaut vrai si le moyen de contrôle est le pouvoir de nommer ou de + révoquer la majorité des membres des organes d'administration, de + gestion, de direction ou de surveillance de la personne morale. + ville: + type: string + format: nullable + description: Ville du bénéficiaire effectif. + example: null + date_de_naissance_complete_formatee: + type: string + format: date + description: >- + Date de naissance complète du bénéficiaire effectif, au format + JJ/MM/AAAA. + example: 14/08/1953 + pourcentage_parts_directes: + type: number + description: >- + Parts détenues de façon directe par le bénéficiaire effectif, en + pourcentage des parts totales. + pourcentage_parts_indirectes: + type: number + description: >- + Parts détenues de façon indirecte par le bénéficiaire effectif, en + pourcentage des parts totales. + pays_de_naissance: + type: string + format: nullable + description: Pays de naissance du bénéficiaire effectif. + example: null + code_pays_de_naissance: + type: string + format: nullable + description: Code du pays de naissance du bénéficiaire effectif. + example: null + ville_de_naissance: + type: string + format: nullable + description: Ville de naissance du bénéficiaire effectif. + example: null + detention_pouvoir_decision_ag: + type: boolean + description: >- + Vaut vrai pour les moyens de contrôle sur les organes + d'administration, de gestion, de direction ou de surveillance de la + personne morale autre que le pouvoir de nommer ou de révoquer la + majorité des membres. + pays: + type: string + format: nullable + description: Pays du bénéficiaire effectif. + example: null + date_de_naissance_formatee: + type: string + format: nullable + description: >- + Mois et année de naissance du bénéficiaire effectif, au format + MM/AAAA. + example: null + code_pays: + type: string + format: nullable + description: Code pays du bénéficiaire effectif. + example: null + Document: + type: object + properties: + type: + type: string + enum: + - acte + - comptes + description: Type de document + example: acte + date_depot: + description: Date de dépôt du document + type: string + format: date + example: '2020-08-04T00:00:00.000Z' + mentions: + type: array + description: Mentions de la recherche dans le document. + items: + type: string + discriminator: + propertyName: type + mapping: + acte: '#/components/schemas/DocumentActe' + comptes: '#/components/schemas/DocumentComptes' + DocumentActe: + allOf: + - $ref: '#/components/schemas/Document' + - type: object + properties: + titres: + type: array + description: Titres des actes associés au document + items: + type: object + properties: + type: + type: string + description: Type de l'acte + example: Décision(s) de l'associé unique + decision: + type: string + format: nullable + description: Décision de l'acte + example: Augmentation du capital social + DocumentComptes: + allOf: + - $ref: '#/components/schemas/Document' + - type: object + properties: + date_cloture: + type: string + format: date + description: Date de clôture des comptes, au format AAAA-MM-JJ. + example: '2019-12-31' + Publication: + type: object + properties: + type: + type: string + enum: + - Création + - Immatriculation + - Modification + - Vente + - Radiation + - Procédure collective + - Dépôt des comptes + description: Type de publication + example: acte + date: + description: Date de publication, au format AAAA-MM-JJ. + type: string + format: date + example: '2020-08-04T00:00:00.000Z' + contenu: + type: string + description: >- + Contenu de la publication, avec les mentions correspondant à la + recherche encerclée par une balise HTML . + Bodacc: + type: object + properties: + numero_parution: + type: string + description: Numéro de parution de la publication. + example: '20200075' + date: + type: string + description: Date de la publication, au format AAAA-MM-JJ. + example: '2020-04-16T00:00:00.000Z' + numero_annonce: + type: string + description: Numéro d'annonce de la publication. + example: '670' + bodacc: + type: string + description: Bodacc de la publication (A, B ou C). + example: B + type: + type: string + description: >- + Type de la publication parmi la liste suivante : Création, + Immatriculation, Modification, Vente, Achat, Radiation, Procédure + collective, Dépôt des comptes. + example: Modification + greffe: + type: string + description: Greffe de publication. + example: Paris + discriminator: + propertyName: type + mapping: + Création: '#/components/schemas/BodaccCreation' + Immatriculation: '#/components/schemas/BodaccImmatriculation' + Modification: '#/components/schemas/BodaccModification' + Vente: '#/components/schemas/BodaccVente' + Achat: '#/components/schemas/BodaccAchat' + Radiation: '#/components/schemas/BodaccRadiation' + Procédure collective: '#/components/schemas/BodaccProcedureCollective' + Dépôt des comptes: '#/components/schemas/BodaccDepotDesComptes' + BodaccCreation: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + type: string + format: nullable + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + example: GOOGLE FRANCE + personne_morale: + type: boolean + format: nullable + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + example: GOOGLE FRANCE + denomination: + type: string + format: nullable + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + example: GOOGLE FRANCE + nom: + type: string + format: nullable + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + prenom: + type: string + format: nullable + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + administration: + type: string + format: nullable + description: Administration (dans le cas d'une personne morale). + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + type: string + format: nullable + description: Adresse de l'entreprise concernée par la publication. + example: 8 rue de Londres 75009 Paris + capital: + type: number + format: nullable + description: Capital de l'entreprise concernée par la publication. + example: '464884017' + activite: + type: string + format: nullable + description: Activité de l'entreprise concernée par la publication. + example: >- + Fourniture de services et/ou conseils relatifs aux logiciels, au + réseau internet. + date_debut_activite: + type: string + format: nullable + description: >- + Date de début d'activité de l'entreprise concernée par la + publication, au format AAAA-MM-JJ. + example: '2020-08-02T00:00:00.000Z' + BodaccImmatriculation: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + type: string + format: nullable + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + example: GOOGLE FRANCE + personne_morale: + type: boolean + format: nullable + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + example: GOOGLE FRANCE + denomination: + type: string + format: nullable + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + example: GOOGLE FRANCE + nom: + type: string + format: nullable + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + prenom: + type: string + format: nullable + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + administration: + type: string + format: nullable + description: Administration (dans le cas d'une personne morale). + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + type: string + format: nullable + description: Adresse de l'entreprise concernée par la publication. + example: 8 rue de Londres 75009 Paris + BodaccModification: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + type: string + format: nullable + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + example: GOOGLE FRANCE + personne_morale: + type: boolean + format: nullable + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + example: GOOGLE FRANCE + denomination: + type: string + format: nullable + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + example: GOOGLE FRANCE + nom: + type: string + format: nullable + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + prenom: + type: string + format: nullable + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + administration: + type: string + format: nullable + description: Administration (dans le cas d'une personne morale). + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + type: string + format: nullable + description: Adresse de l'entreprise concernée par la publication. + example: 8 rue de Londres 75009 Paris + capital: + type: number + format: nullable + description: Capital de l'entreprise concernée par la publication. + example: '464884017' + activite: + type: string + format: nullable + description: Activité de l'entreprise concernée par la publication. + example: >- + Fourniture de services et/ou conseils relatifs aux logiciels, au + réseau internet. + description: + type: string + format: nullable + description: Description de la modification. + example: modification survenue sur le capital (augmentation) + BodaccAchat: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + type: string + format: nullable + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + example: GOOGLE FRANCE + personne_morale: + type: boolean + format: nullable + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + example: GOOGLE FRANCE + denomination: + type: string + format: nullable + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + example: GOOGLE FRANCE + nom: + type: string + format: nullable + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + prenom: + type: string + format: nullable + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + administration: + type: string + format: nullable + description: Administration (dans le cas d'une personne morale). + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + type: string + format: nullable + description: Adresse de l'entreprise concernée par la publication. + example: 8 rue de Londres 75009 Paris + commentaires: + type: string + format: nullable + description: Commentaires sur la publication. + oppositions: + type: string + format: nullable + description: Détails sur les oppositions. + declaration_creance: + type: string + format: nullable + description: Détails sur la déclaration de créance. + publication_legale: + type: string + format: nullable + description: Journal où a été publiée la publication légale. + denomination_ancien_proprietaire: + type: string + format: optional + description: Dénomination de l'ancien propriétaire de l'établisement. + siren_ancien_proprietaire: + type: string + format: optional + description: Siren de l'ancien propriétaire de l'établisement. + denomination_ancien_exploitant: + type: string + format: optional + description: Dénomination de l'ancien exploitant de l'établisement. + siren_ancien_exploitant: + type: string + format: optional + description: Siren de l'ancien exploitant de l'établisement. + BodaccVente: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + type: string + format: nullable + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + example: GOOGLE FRANCE + personne_morale: + type: boolean + format: nullable + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + example: GOOGLE FRANCE + denomination: + type: string + format: nullable + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + example: GOOGLE FRANCE + nom: + type: string + format: nullable + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + prenom: + type: string + format: nullable + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + administration: + type: string + format: nullable + description: Administration (dans le cas d'une personne morale). + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + type: string + format: nullable + description: Adresse de l'entreprise concernée par la publication. + example: 8 rue de Londres 75009 Paris + commentaires: + type: string + format: nullable + description: Commentaires sur la publication. + oppositions: + type: string + format: nullable + description: Détails sur les oppositions. + declaration_creance: + type: string + format: nullable + description: Détails sur la déclaration de créance. + publication_legale: + type: string + format: nullable + description: Journal où a été publiée la publication légale. + denomination_nouveau_proprietaire: + type: string + format: nullable + description: Dénomination du nouveau propriétaire de l'établisement. + siren_nouveau_proprietaire: + type: string + format: nullable + description: Siren du nouveau propriétaire de l'établisement. + denomination_nouvel_exploitant: + type: string + format: nullable + description: Dénomination du nouvel exploitant de l'établisement. + siren_nouvel_exploitant: + type: string + format: nullable + description: Siren du nouvel exploitant de l'établisement. + BodaccRadiation: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + BodaccProcedureCollective: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + famille: + type: string + description: Famille de la procédure collective + example: Jugement de clôture + nature: + type: string + description: Nature de la procédure collective + example: Jugement de clôture pour insuffisance d'actif + complement_jugement: + type: string + description: Complément sur le jugement de procédure collective + example: >- + Jugement prononçant la clôture de la procédure de liquidation + judiciaire pour insuffisance d'actif. + BodaccDepotDesComptes: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + date_cloture: + type: string + description: Date de clôture des comptes, au format AAAA-MM-JJ. + example: '2020-08-02T00:00:00.000Z' + type_depot: + type: string + description: Type de dépôt de comptes. + example: Comptes annuels et rapports + descriptif: + type: string + format: nullable + description: Descriptif du dépôt de comptes. + PersonneMarque: + type: object + properties: + siren: + type: string + description: Siren de l'entité, dans le cas d'une personne morale. + entite_legale: + type: string + description: Entité légale. + nom: + type: string + description: Nom de l'entité. + batiment: + type: string + description: Bâtiment de l'entité. + rue: + type: string + description: Rue de l'entité. + ville: + type: string + description: Ville de l'entité. + boite_postale: + type: string + description: Boîte postale de l'entité. + code_postal: + type: string + description: Code postal de l'entité. + code_pays: + type: string + description: Code pays de l'entité. + Ratios: + type: object + properties: + chiffre_affaires: + type: number + format: nullable + description: Chiffre d'affaires de l'entreprise. + example: 411016329 + resultat: + type: number + format: nullable + description: Résultat de l'entreprise. + example: 29327087 + effectif: + type: integer + format: nullable + description: Effectif de l'entreprise. + example: 723 + marge_brute: + type: number + format: nullable + description: Marge brute de l'entreprise. + excedent_brut_exploitation: + type: number + format: nullable + description: Excédent brut d'exploitation (EBITDA) de l'entreprise. + resultat_exploitation: + type: number + format: nullable + description: Résultat d'exploitation (EBIT) de l'entreprise. + taux_croissance_chiffre_affaires: + type: number + format: nullable + description: Taux de croissance du chiffre d'affaires (en %) de l'entreprise. + taux_marge_brute: + type: number + format: nullable + description: Taux de marge brute (en %) de l'entreprise. + taux_marge_EBITDA: + type: number + format: nullable + description: Taux de marge d'EBITDA (en %) de l'entreprise. + taux_marge_operationnelle: + type: number + format: nullable + description: Taux de marge opérationnelle (EBIT) (en %) de l'entreprise. + BFR: + type: number + format: nullable + description: BFR (Besoin en fonds de roulement) de l'entreprise. + BFR_exploitation: + type: number + format: nullable + description: BFR exploitation de l'entreprise. + BFR_hors_exploitation: + type: number + format: nullable + description: BFR hors exploitation de l'entreprise. + BFR_jours_CA: + type: number + format: nullable + description: BFR (en jours de CA) de l'entreprise. + BFR_exploitation_jours_CA: + type: number + format: nullable + description: BFR exploitation (en jours de CA) de l'entreprise. + BFR_hors_exploitation_jours_CA: + type: number + format: nullable + description: BFR hors exploitation (en jours de CA) de l'entreprise. + delai_paiement_clients_jours: + type: number + format: nullable + description: Délai de paiement clients (en jours) de l'entreprise. + delai_paiement_fournisseurs_jours: + type: number + format: nullable + description: Délai de paiement fournisseurs (en jours) de l'entreprise. + ratio_stock_CA_jours: + type: number + format: nullable + description: Ratio des stocks / CA (en jours) de l'entreprise. + capacite_autofinancement: + type: number + format: nullable + description: Capacité d'autofinancement de l'entreprise. + capacite_autofinancement_CA: + type: number + format: nullable + description: Capacité d'autofinancement / CA (en %) de l'entreprise. + fonds_roulement_net_global: + type: number + format: nullable + description: Fonds de roulement net global de l'entreprise. + couverture_BFR: + type: number + format: nullable + description: Couverture du BFR de l'entreprise. + tresorerie: + type: number + format: nullable + description: Trésorerie de l'entreprise. + dettes_financieres: + type: number + format: nullable + description: Dettes financières de l'entreprise. + capacite_remboursement: + type: number + format: nullable + description: Capacité de remboursement de l'entreprise. + ratio_endettement: + type: number + format: nullable + description: Ratio d'endettement (Gearing) de l'entreprise. + autonomie_financiere: + type: number + format: nullable + description: Autonomie financière (en %) de l'entreprise. + taux_levier: + type: number + format: nullable + description: Taux de levier (DFN/EBITDA) de l'entreprise. + etat_dettes_1_an_au_plus: + type: number + format: nullable + description: Etat des dettes à 1 an au plus de l'entreprise. + liquidite_generale: + type: number + format: nullable + description: Liquidité générale de l'entreprise. + couverture_dettes: + type: number + format: nullable + description: Couverture des dettes de l'entreprise. + marge_nette: + type: number + format: nullable + description: Marge nette (en %) de l'entreprise. + rentabilite_fonds_propres: + type: number + format: nullable + description: Rentabilité sur fonds propres (en %) de l'entreprise. + rentabilite_economique: + type: number + format: nullable + description: Rentabilité économique (en %) de l'entreprise. + valeur_ajoutee: + type: number + format: nullable + description: Valeur ajoutée de l'entreprise. + valeur_ajoutee_CA: + type: number + format: nullable + description: Valeur ajoutée / CA (en %) de l'entreprise. + salaires_charges_sociales: + type: number + format: nullable + description: Salaires et charges sociales de l'entreprise. + salaires_CA: + type: number + format: nullable + description: Salaires / CA (en %) de l'entreprise. + impots_taxes: + type: number + format: nullable + description: Impôts et taxes de l'entreprise. + Association: + type: object + format: nullable + description: Association liée à l'entreprise. + properties: + is_waldec: + type: boolean + example: 1 + description: Détermine si l'association possède un numéro WALDEC/RNA. + id_association: + type: string + example: W142005389 + description: >- + L'identifiant l'association au format Wxxxxxxxxx si WALDEC, + xxxxxxxxxxxxxx sinon. + id_ex_association: + type: string + format: nullable + example: 142004593 + description: Ancien numéro de l'association. + denomination: + type: string + format: nullable + example: COMITÉ RÉGIONAL DE BRIDGE DE BASSE NORMANDIE + description: Dénomination de l'association. + siret: + type: string + format: nullable + description: Numéro siret de l'association au format xxxxxxxxxxxxxx. + example: '95037097300014' + numero_rup: + type: string + format: nullable + description: Numéro de Reconnaissance d'Utilité Publique. + example: null + objet: + type: string + format: nullable + description: Objet de l'association. + example: >- + Grouper tous les clubs et joueurs de bridge de Basse-Normandie de + soutenir leurs efforts et de développer sous toutes ses formes la + pratique du jeu de bridge + objet_social_1: + type: string + format: nullable + description: Objet social 1 de l'association. + example: 7005 + categorie_social_1: + type: string + format: nullable + description: Libellé correspondant à l'objet social 1. + example: Bridge, jeux de cartes, échecs, dames, jeux de société... + objet_social_2: + type: string + format: nullable + description: Objet social 2 de l'association. + example: 0 + categorie_social_2: + type: string + format: nullable + description: Libellé correspondant à l'objet social 1. + example: Non connue + date_creation: + type: string + format: nullable + description: Date de déclaration de création au format AAAA-MM-JJ. + example: '1978-09-28' + date_derniere_declaration: + type: string + format: nullable + description: Date de dernière déclaration au format AAAA-MM-JJ. + example: '2019-09-18' + date_publication_creation: + type: string + format: nullable + description: >- + Date de publication du Journal Officiel de l'avis de création au + format AAAA-MM-JJ. + example: '1978-10-12' + date_declaration_dissolution: + type: string + format: nullable + description: Date de déclaration de dissolution au format AAAA-MM-JJ. + example: '2019-09-18' + groupement: + type: string + format: nullable + description: Groupement de l'association. + example: Simple + position_activite: + type: string + format: nullable + description: Position d'activité de l'association. + example: Active + nature: + type: string + format: nullable + description: Nature de l'association. + example: Simplement Declarée + site_web: + type: string + format: nullable + description: Site web de l'association. + example: null + telephone: + type: string + format: nullable + description: Numéro de téléphone de l'association. + example: null + email: + type: string + format: nullable + description: Email de l'association. + example: null + adresse_siege: + type: object + properties: + code_postal: + type: string + format: nullable + description: Code postal du siège social. + example: '14075' + code_insee: + type: string + format: nullable + description: Code insee du siège social. + example: '14118' + ville: + type: string + format: nullable + description: Ville du siège social. + example: Caen cedex 05 + numero_voie: + type: string + format: nullable + description: Numéro de voie du siège social. + example: 115ter + indice_repetition: + type: string + format: nullable + description: Indice de répétition du siège social. + example: null + type_voie: + type: string + format: nullable + description: Type de voie du siège social. + example: BD + libelle_voie: + type: string + format: nullable + description: Libellé de la voie du siège social. + example: Vanier - La Pierre Heuzé + complement_adresse: + type: string + format: nullable + description: Complément de l'adresse du siège social. + example: null + distribution: + type: string + format: nullable + description: Complément de distribution du siege social. + example: _BP 75156 + adresse_ligne_1: + type: string + format: nullable + description: Adresse complète du siège social. + example: 115ter BD Vanier - La Pierre Heuzé + adresse_ligne_2: + type: string + format: nullable + description: Renseignement supplémentaire à l'adresse du siège social. + example: null + adresse_gestionnaire: + type: object + properties: + gestionnaire: + type: string + format: nullable + description: Nom du gestionnaire de l'association. + example: null + code_postal: + type: string + format: nullable + description: Code postal du gestionnaire. + example: '14075' + ville: + type: string + format: nullable + description: Ville du gestionnaire. + example: CAEN + distribution: + type: string + format: nullable + description: Complément de distribution du gestionnaire. + example: null + adresse_ligne: + type: string + format: nullable + description: Adresse complète du gestionnaire. + example: 115TER BOULEVARD VANIER - LA PIERRE + complement_adresse: + type: string + format: nullable + description: Complément de l'adresse du gestionnaire. + example: null + indication: + type: string + format: nullable + description: Indication supplémentaire à l'adresse du gestionnaire. + example: null + pays: + type: string + format: nullable + description: Pays du gestionnaire. + example: FRANCE + observation: + type: string + format: nullable + description: Observation relative à l'association. + example: Reprise auto => date publication création au JO à vérifier + code_gestion: + type: string + format: nullable + description: >- + Code du site gestionnaire (préfecture, sous-préfecture) de + l'association. + example: 142P + dirigeant_civilite: + type: string + format: nullable + description: Civilité du dirigeant. + example: PM + derniere_maj: + type: string + format: nullable + description: >- + Date de la dernière mise à jour des informations au RNA au format + AAAA-MM-JJ. + example: '2020-03-18' + publications_joafe: + type: object + format: optional + description: Publications JOAFE. + properties: + numero_parution: + type: string + example: '20180024' + description: Numéro de parution JOAFE + date_parution: + type: string + example: '2018-06-16' + description: Date de parution JOAFE au format AAAA-MM-JJ + date_declaration: + type: string + example: '2018-06-12' + description: Date de déclaration au format AAAA-MM-JJ + numero_annonce: + type: integer + example: 1766 + description: Numéro de l'annonce JOAFE + titre: + type: string + example: ASSOCIATION QUARTIER FOSSES-JEAN + description: Nom de l'association + type: + type: string + example: Création + description: Type d'annonce (Création, Modification, Dissolution) + prefecture: + type: string + example: Hauts-de-Seine + description: Lieu de la déclaration + objet: + type: string + format: optional + example: >- + la défense des droits des habitants du quartier auprès + éventuellement des bailleurs sociaux ; aide à la gestion des + problèmes de voisinage ; superviser le prêt des Lieux Communs de + Résidences pour proposer des activités aux jeunes du quartier + (jeux, échanges, anniversaires, prêt de livres ou divers) ; + l'organisation de rencontres pluriculturelles (apprentissage de + l'art culinaire des différentes ethnies qui composent le + quartier) ; organisation de goûter et sorties, vide grenier + annuel ou semestriel plus couramment brocante ; organisation de + rencontres inter-générations retraités qui pourraient apporter + une aide aux devoirs pour les enfants (bénévolement) + description: Description de l'association + site_web: + type: string + format: optional + example: null + description: Lien du site web + adresse: + type: string + format: nullable + example: 9, avenue D'Orgemont, 92700 Colombes + description: Adresse de l'association + ScoringNonFinancier: + type: object + format: optional + description: >- + Score extra-financier de l'entreprise. Uniquement présent si demandé + dans les champs supplémentaires. + properties: + note: + type: string + format: nullable + enum: + - A + - B + - C + - D + description: Note du score extra-financier de l'entreprise. + example: B + score: + type: number + format: nullable + description: Score extra-financier de l'entreprise. + example: 34 + date_calcul: + type: string + format: nullable + description: Date de calcul du score extra-financier de l'entreprise. + example: '2024-01-17' + erreur: + type: string + format: nullable + enum: + - Données extra financières incomplètes + description: Erreur lors du calcul du score extra-financier de l'entreprise. + example: null + ScoringFinancier: + type: object + format: optional + description: >- + Score financier de l'entreprise. Uniquement présent si demandé dans les + champs supplémentaires. + properties: + note: + type: string + format: nullable + enum: + - A + - B + - C + - D + - E + - F + - G + description: Note du score extra-financier de l'entreprise. + example: C + score: + type: number + format: nullable + description: Score extra-financier de l'entreprise. + example: 10 + date_cloture_comptes: + type: string + description: Date de clôture des comptes de l'entreprise. + example: '2021-12-31' + details_score: + type: object + format: nullable + description: Détails du score financier. + properties: + score_ebit_ca: + type: number + format: nullable + example: 3.5 + score_fonds_de_roulement: + type: number + format: nullable + example: 0 + score_tresorerie_nette: + type: number + format: nullable + example: 1 + score_dettes_fiscales_va: + type: number + format: nullable + example: 0.5 + score_cash_flow: + type: number + format: nullable + example: 3.5 + score_dettes_fiscales_ca: + type: number + format: nullable + example: null + score_charges_financieres_nettes: + type: number + format: nullable + example: 1.5 + date_calcul: + type: string + format: nullable + description: Date de calcul du score extra-financier de l'entreprise. + example: '2024-01-17' + erreur: + type: string + format: nullable + enum: + - Données financières incomplètes + - Type de compte non couvert + - Secteur non couvert + - Chiffre d'affaires trop faible + description: Erreur lors du calcul du score extra-financier de l'entreprise. + example: null + Labels: + type: object + format: optional + properties: + nom: + type: string + enum: + - RGE + - QUALIOPI + - EGALITE + - BIO + - ESS + - ESUS + - SOCIETE_A_MISSION + - ORIAS + description: Nom du label. + example: RGE + nb_etablissements_concernes: + type: integer + format: nullable + description: >- + Nombre d'établissements concernés par le label, dans le cas d'un + label lié aux établissements. Null sinon. + example: 1 + certificats: + type: array + format: optional + description: 'Label RGE seulement : Liste des certificats.' + specialites: + type: array + format: optional + description: 'Label QUALIOPI seulement : Liste des spécialités.' + notes: + type: array + format: optional + description: 'Label EGALITE seulement : Liste des notes.' + numero_immatriculation: + type: string + format: optional + description: 'Label ORIAS seulement : Numéro d''immatriculation ORIAS.' + inscriptions: + type: array + format: optional + description: 'Label ORIAS seulement : Liste des inscriptions ORIAS.' + LienSuccession: + type: object + properties: + siret: + type: string + description: Numéro siret de l'établissement au format xxxxxxxxxxxxxx. + example: '44306184100047' + date: + type: string + description: Date à laquelle la succession a eu lieu. + example: '1993-20-02' + transfert_siege: + type: boolean + description: >- + Vrai si le lien de succession concerne l'établissement siège, faux + sinon. + example: false + continuite_economique: + type: boolean + description: >- + Vrai s'il y a [continuité + économique](https://www.sirene.fr/sirene/public/variable/continuiteEconomique), + faux sinon. + example: true + Cartographie: + type: object + properties: + entreprises: + type: array + description: Liste des noeuds entreprises. + items: + type: object + properties: + id: + type: string + description: Un identifiant unique du noeud. + siren: + type: string + description: SIREN de l'entreprise. + nom_entreprise: + type: string + description: Nom de l'entreprise. + personnes: + type: array + description: Liste des noeuds personnes (dirigeants ou bénéficiaires effectifs). + items: + type: object + properties: + id: + type: string + description: Un identifiant unique du noeud. + prenom: + type: string + description: SIREN de l'entreprise. + nom: + type: string + description: Nom de l'entreprise. + niveau: + type: integer + description: >- + Niveau du noeud. Le niveau 1 correspond aux dirigeants et + bénéficiaires effectifs directement liés à l'entreprise + recherchée. Le niveau 2 correspond aux autres. + liens_entreprises_personnes: + type: array + description: >- + Liste des arêtes liant les noeuds entreprises avec des noeuds + personnes. + items: + type: array + description: >- + Tableau de 2 éléments, le premier contenant l'identifiant du noeud + entreprise, le second l'identifiant du noeud personne. + items: + oneOf: + - type: string + pattern: e[0-9]+ + - type: string + pattern: p[0-9]+ + liens_entreprises_entreprises: + type: array + description: >- + Liste des arêtes liant les noeuds entreprises avec des d'autres + noeuds entreprises. + items: + type: array + description: >- + Tableau de 2 éléments, chacun étant un identifiant d'un noeud + entreprise. + items: + type: string + pattern: e[0-9]+ + modifications_effectuees: + type: object + description: Description des paramètres ayant été automatiquement modifiés. diff --git a/sdks/db/fixed-specs-cache/box-fixed-spec.yaml b/sdks/db/fixed-specs-cache/box-fixed-spec.yaml index d234376f1c..09a92ea572 100644 --- a/sdks/db/fixed-specs-cache/box-fixed-spec.yaml +++ b/sdks/db/fixed-specs-cache/box-fixed-spec.yaml @@ -43,7 +43,7 @@ rawSpecString: | name: Apache-2.0 url: http://www.apache.org/licenses/LICENSE-2.0 version: 2.0.0 - x-box-commit-hash: 9d605a3ec5 + x-box-commit-hash: a2f6edcf0a servers: - url: https://api.box.com/2.0 description: Box Platform API server @@ -339,7 +339,7 @@ rawSpecString: | Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example - `?field=metadata.enterprise_12345.contractTemplate`. + `?fields=metadata.enterprise_12345.contractTemplate`. in: query example: - id @@ -4976,7 +4976,7 @@ rawSpecString: | Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example - `?field=metadata.enterprise_12345.contractTemplate`. + `?fields=metadata.enterprise_12345.contractTemplate`. in: query example: - id @@ -5958,7 +5958,7 @@ rawSpecString: | Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example - `?field=metadata.enterprise_12345.contractTemplate`. + `?fields=metadata.enterprise_12345.contractTemplate`. in: query example: - id diff --git a/sdks/db/fixed-specs-cache/customer-io-data-pipelines-fixed-spec.yaml b/sdks/db/fixed-specs-cache/customer-io-data-pipelines-fixed-spec.yaml index 171c6f341c..b5e0861089 100644 --- a/sdks/db/fixed-specs-cache/customer-io-data-pipelines-fixed-spec.yaml +++ b/sdks/db/fixed-specs-cache/customer-io-data-pipelines-fixed-spec.yaml @@ -5,7 +5,7 @@ publishJson: clientName: CustomerIoDataPipelines metaDescription: >- Customer.io is a versatile marketing automation tool for sending relevant - messages based on behavior across web and mobile products. + messages based on behavior across web and mobile products. Impersonal messages lead to bad experiences. That's why we use real-time @@ -16,13 +16,13 @@ publishJson: Our robust platform enables you to: - Automate your product messaging, with the ability to build, test, and send - messages from one platform. + messages from one platform. - Create and manage newsletters, transactional messages, and behavioral - messages + messages - Do more with your behavior and data -- connect our powerful segmentation - and automation engine with other apps to drive user behavior and save time. + and automation engine with other apps to drive user behavior and save time. Learn more: https://customer.io diff --git a/sdks/db/fixed-specs-cache/customer-io-journeys-app-fixed-spec.yaml b/sdks/db/fixed-specs-cache/customer-io-journeys-app-fixed-spec.yaml index d8f206493e..4bd411534f 100644 --- a/sdks/db/fixed-specs-cache/customer-io-journeys-app-fixed-spec.yaml +++ b/sdks/db/fixed-specs-cache/customer-io-journeys-app-fixed-spec.yaml @@ -5,7 +5,7 @@ publishJson: clientName: CustomerIoJourneysApp metaDescription: >- Customer.io is a versatile marketing automation tool for sending relevant - messages based on behavior across web and mobile products. + messages based on behavior across web and mobile products. Impersonal messages lead to bad experiences. That's why we use real-time @@ -16,13 +16,13 @@ publishJson: Our robust platform enables you to: - Automate your product messaging, with the ability to build, test, and send - messages from one platform. + messages from one platform. - Create and manage newsletters, transactional messages, and behavioral - messages + messages - Do more with your behavior and data -- connect our powerful segmentation - and automation engine with other apps to drive user behavior and save time. + and automation engine with other apps to drive user behavior and save time. Learn more: https://customer.io diff --git a/sdks/db/fixed-specs-cache/customer-io-journeys-track-fixed-spec.yaml b/sdks/db/fixed-specs-cache/customer-io-journeys-track-fixed-spec.yaml index b8c3ecf3dd..93cdabcfe7 100644 --- a/sdks/db/fixed-specs-cache/customer-io-journeys-track-fixed-spec.yaml +++ b/sdks/db/fixed-specs-cache/customer-io-journeys-track-fixed-spec.yaml @@ -5,7 +5,7 @@ publishJson: clientName: CustomerIoJourneysTrack metaDescription: >- Customer.io is a versatile marketing automation tool for sending relevant - messages based on behavior across web and mobile products. + messages based on behavior across web and mobile products. Impersonal messages lead to bad experiences. That's why we use real-time @@ -16,13 +16,13 @@ publishJson: Our robust platform enables you to: - Automate your product messaging, with the ability to build, test, and send - messages from one platform. + messages from one platform. - Create and manage newsletters, transactional messages, and behavioral - messages + messages - Do more with your behavior and data -- connect our powerful segmentation - and automation engine with other apps to drive user behavior and save time. + and automation engine with other apps to drive user behavior and save time. Learn more: https://customer.io diff --git a/sdks/db/fixed-specs-cache/digital-ocean-fixed-spec.yaml b/sdks/db/fixed-specs-cache/digital-ocean-fixed-spec.yaml index a72cd853d3..e54671cc93 100644 --- a/sdks/db/fixed-specs-cache/digital-ocean-fixed-spec.yaml +++ b/sdks/db/fixed-specs-cache/digital-ocean-fixed-spec.yaml @@ -18415,6 +18415,8 @@ rawSpecString: | parameter to specify if the results should be for the `private` or `public` interface. Use the `direction` query parameter to specify if the results should be for `inbound` or `outbound` traffic. + + The metrics in the response body are in megabits per second (Mbps). tags: - Monitoring responses: @@ -25749,7 +25751,7 @@ rawSpecString: | metric_timestamp_start: in: query name: start - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. example: '1620683817' required: true schema: @@ -25757,7 +25759,7 @@ rawSpecString: | metric_timestamp_end: in: query name: end - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. example: '1620705417' required: true schema: diff --git a/sdks/db/fixed-specs-cache/hsbc-account-information-ce-fixed-spec.yaml b/sdks/db/fixed-specs-cache/hsbc-account-information-ce-fixed-spec.yaml index 1853fdb449..3be7f0dc9c 100644 --- a/sdks/db/fixed-specs-cache/hsbc-account-information-ce-fixed-spec.yaml +++ b/sdks/db/fixed-specs-cache/hsbc-account-information-ce-fixed-spec.yaml @@ -697,6 +697,8 @@ rawSpecString: | description: The PSU's IP address if the PSU is currently logged in with the TPP. schema: type: string + pattern: >- + ^((((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\s?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\s?),?\s?)+$ example: 12.201.45.125 x-fapi-auth-date: in: header diff --git a/sdks/db/fixed-specs-cache/pappers-fixed-spec.yaml b/sdks/db/fixed-specs-cache/pappers-fixed-spec.yaml new file mode 100644 index 0000000000..9a91e1f6f7 --- /dev/null +++ b/sdks/db/fixed-specs-cache/pappers-fixed-spec.yaml @@ -0,0 +1,6156 @@ +publishJson: + company: Pappers + serviceName: false + sdkName: pappers-{language}-sdk + clientName: Pappers + metaDescription: >- + Avec Pappers, accédez à toute toute l'information légale, juridique + financière des sociétés françaises ! + + Découvrez nos offres : https://www.pappers.fr/api et + https://www.pappers.fr/exports + apiStatusUrls: inherit + homepage: www.pappers.fr/ + developerDocumentation: www.pappers.fr/api/documentation + categories: + - finance + - legal + - legaltech + - data +rawSpecString: | + openapi: 3.0.0 + info: + 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 + title: Pappers API + contact: + name: Support technique Pappers + email: support@pappers.fr + servers: + - url: https://api.pappers.fr/v2 + paths: + /entreprise: + get: + tags: + - Fiche entreprise + summary: Récupère l'ensemble des informations disponibles sur une entreprise. + 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`. + operationId: entreprise + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + - name: siret + in: query + description: SIRET de l'entreprise + required: false + schema: + type: string + example: 44306184100047 + - name: integrer_diffusions_partielles + in: query + description: >- + Si vrai et si l'entreprise est en diffusion partielle, le retour + renverra les informations partielles disponibles. Valeur par défaut + : `false`. + required: false + schema: + type: boolean + - name: format_publications_bodacc + in: query + description: >- + Format attendu pour les publications BODACC. Valeur par défaut : + `"objet"`. + required: false + schema: + type: string + enum: + - objet + - texte + example: objet + - name: marques + in: query + description: >- + Si vrai, le retour inclura les marques éventuelles de l'entreprise. + Valeur par défaut : `false`. + required: false + schema: + type: boolean + - name: validite_tva_intracommunautaire + in: query + 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`. + required: false + schema: + type: boolean + - name: publications_bodacc_brutes + in: query + 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`. + required: false + schema: + type: boolean + - name: champs_supplementaires + in: query + 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. + 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. + description: >- + Vous devez fournir soit l'identifiant de l'association, soit le SIREN, + soit le SIRET. + operationId: association + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: id_association + in: query + description: Identifiant de l'association + required: false + schema: + type: string + example: W142005389 + - name: siret + in: query + description: SIRET de l'association + required: false + schema: + type: string + example: 95037097300014 + - name: siren + in: query + description: SIREN de l'association + 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. + 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`). + operationId: recherche + 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' + - name: q + in: query + 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. + required: false + schema: + type: string + example: Google France + - name: siege + in: query + description: Défini si la requête se base sur le siège + 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: + type: object + properties: + resultats: + type: array + description: Liste des entreprises qui correspondent à la recherche. + items: + allOf: + - $ref: '#/components/schemas/EntrepriseRecherche' + - type: object + properties: + dirigeants: + type: array + description: >- + Dirigeants de l'entreprise qui correspondent à + la recherche (si vous recherchez dans la base + dirigeants). + items: + $ref: '#/components/schemas/RepresentantRecherche' + beneficiaires: + type: array + description: >- + Bénéficiaires effectifs de l'entreprise qui + correspondent à la recherche (si vous recherchez + dans la base bénéficiaires effectifs). + items: + $ref: '#/components/schemas/Beneficiaire' + documents: + type: array + description: >- + Documents de l'entreprise qui correspondent à la + recherche (si vous recherchez dans la base + documents). + items: + $ref: '#/components/schemas/Document' + publications: + type: array + description: >- + Publications de l'entreprise qui correspondent à + la recherche (si vous recherchez dans la base + publications). + items: + allOf: + - $ref: '#/components/schemas/Publication' + - type: object + properties: + mentions: + type: array + description: >- + Mentions de la recherche dans la + publication. + items: + type: string + nb_dirigeants_total: + type: integer + description: Nombre de dirigeants total de l'entreprise. + nb_beneficiaires_total: + type: integer + description: >- + Nombre de bénéficiaires effectifs total de + l'entreprise. + nb_documents_avec_mentions: + type: integer + description: >- + Nombre de documents de l'entreprise qui + correspondent à la recherche. + nb_documents_total: + type: integer + description: Nombre de documents total de l'entreprise. + nb_publications_avec_mentions: + type: integer + description: >- + Nombre de publications de l'entreprise qui + correspondent à la recherche. + nb_publications_total: + type: integer + description: Nombre de publications total de l'entreprise. + total: + type: integer + description: Nombre d'entreprises qui correspondent à la recherche. + example: 100 + page: + type: integer + description: Page actuelle. + example: 1 + curseurSuivant: + type: string + description: >- + Présent uniquement en cas d'utilisation du paramètre + `curseur`. Contient le curseur courant à envoyer en + paramètre `curseur` de la requête suivantes. + example: QxNRrqKiBFDQq54SpHsrw8r5Z3yWZMDAAzcvwywX + '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. + description: >- + Tous les paramètres sont optionnels et servent à filtrer la recherche. + Les différents dirigeants seront renvoyées dans un tableau `resultats`. + operationId: recherche-dirigeants + parameters: + - $ref: '#/components/parameters/api_token' + - $ref: '#/components/parameters/par_page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/precision' + - name: q + in: query + description: >- + Texte à rechercher. Nom et prénom du dirigeant pour une personne + physique, dénomination pour une personne morale. + 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: + type: object + properties: + resultats: + type: array + description: Liste des dirigeants qui correspondent à la recherche. + items: + allOf: + - $ref: '#/components/schemas/RepresentantRecherche' + - type: object + properties: + entreprises: + type: array + description: >- + Liste des entreprises du dirigeant, dans la + limite de 100 entreprises. + items: + $ref: '#/components/schemas/EntrepriseRecherche' + nb_entreprises_total: + type: integer + description: Nombre d'entreprises du dirigeant au total + total: + type: integer + description: Nombre de dirigeants qui correspondent à la recherche. + example: 100 + page: + type: integer + description: Page actuelle. + example: 1 + '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. + 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`. + operationId: recherche-beneficiaires + parameters: + - $ref: '#/components/parameters/api_token' + - $ref: '#/components/parameters/par_page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/precision' + - name: q + in: query + description: Nom et/ou prénom du bénéficiaire effectif. + 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: + type: object + properties: + resultats: + type: array + description: >- + Liste des bénéficiaires effectifs qui correspondent à la + recherche. + items: + allOf: + - $ref: '#/components/schemas/Beneficiaire' + - type: object + properties: + entreprises: + type: array + description: >- + Liste des entreprises dont le bénéficiaire + effectif est bénéficiaire effectif, dans la + limite de 100 entreprises. + items: + $ref: '#/components/schemas/EntrepriseRecherche' + nb_entreprises_total: + type: integer + description: >- + Nombre d'entreprises du bénéficiaire effectif au + total. + entreprises_dirigeant: + type: array + description: >- + Liste des entreprises dont le bénéficiaire + effectif est dirigeant (sans forcément en être + bénéficiaire effectif), dans la limite de 100 + entreprises. + items: + $ref: '#/components/schemas/EntrepriseRecherche' + nb_entreprises_dirigeant_total: + type: integer + description: >- + Nombre d'entreprises dont le bénéficiaire + effectif est dirigeant au total. + total: + type: integer + description: >- + Nombre de bénéficiaires effectifs qui correspondent à la + recherche. + example: 100 + page: + type: integer + description: Page actuelle. + example: 1 + '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. + description: >- + Tous les paramètres sont optionnels et servent à filtrer la recherche. + Les différents documents seront renvoyées dans un tableau `resultats`. + operationId: recherche-documents + parameters: + - $ref: '#/components/parameters/api_token' + - $ref: '#/components/parameters/par_page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/precision' + - name: q + in: query + description: Mot-clé à rechercher dans le contenu du document. + 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: + type: object + properties: + resultats: + type: array + description: Liste des documents qui correspondent à la recherche. + items: + allOf: + - $ref: '#/components/schemas/Document' + - type: object + properties: + entreprise: + $ref: '#/components/schemas/EntrepriseRecherche' + total: + type: integer + description: Nombre de documents qui correspondent à la recherche. + example: 100 + page: + type: integer + description: Page actuelle. + example: 1 + '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. + description: >- + Tous les paramètres sont optionnels et servent à filtrer la recherche. + Les différentes publications seront renvoyées dans un tableau + `resultats`. + operationId: recherche-publications + parameters: + - $ref: '#/components/parameters/api_token' + - $ref: '#/components/parameters/par_page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/precision' + - name: q + in: query + description: Mot-clé à rechercher dans le contenu de la publication. + 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: + type: object + properties: + resultats: + type: array + description: Liste des publications qui correspondent à la recherche. + items: + allOf: + - $ref: '#/components/schemas/Publication' + - type: object + properties: + entreprise: + $ref: '#/components/schemas/EntrepriseRecherche' + total: + type: integer + description: Nombre de publications qui correspondent à la recherche. + example: 100 + page: + type: integer + description: Page actuelle. + example: 1 + '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). + 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. + operationId: suggestions + parameters: + - name: q + in: query + description: Début de recherche textuelle + required: true + schema: + type: string + example: googl + - name: longueur + in: query + description: 'Nombre de résultats. Maximum 100. Valeur par défaut : `10`.' + required: false + schema: + type: integer + example: 20 + - name: cibles + in: query + description: >- + Cibles de la recherche, séparées par des virgules. Valeur par défaut + : `"nom_entreprise"`. + 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: + type: object + properties: + resultats_nom_entreprise: + type: array + format: optional + description: >- + Liste des entreprises dont le nom (dénomination ou + nom/prénom) peut compléter la recherche textuelle. + Uniquement présent si le paramètre `cibles` contient + `nom_entreprise`. + items: + allOf: + - type: object + properties: + mention: + type: string + description: >- + Nom de l'entreprise, avec le texte recherché + encerclé d'une balise HTML ``. + - $ref: '#/components/schemas/EntrepriseRecherche' + resultats_denomination: + type: array + format: optional + description: >- + Liste des entreprises dont la dénomination peut compléter + la recherche textuelle (concerne les personnes morales + seulement). Uniquement présent si le paramètre `cibles` + contient `denomination`. + items: + allOf: + - type: object + properties: + mention: + type: string + description: >- + Dénomination de l'entreprise, avec le texte + recherché encerclé d'une balise HTML ``. + - $ref: '#/components/schemas/EntrepriseRecherche' + resultats_nom_complet: + type: array + format: optional + description: >- + Liste des entreprises dont le nom complet (nom + prénom ou + prénom + nom) peut compléter la recherche textuelle + (concerne les personnes physiques seulement). Uniquement + présent si le paramètre `cibles` contient `nom_complet`. + items: + allOf: + - type: object + properties: + mention: + type: string + description: >- + Nom complet de l'entreprise, avec le texte + recherché encerclé d'une balise HTML ``. + - $ref: '#/components/schemas/EntrepriseRecherche' + resultats_representant: + type: array + format: optional + description: >- + Liste des représentants dont le nom complet (nom + prénom + ou prénom + nom) peut compléter la recherche textuelle. + Uniquement présent si le paramètre `cibles` contient + `representant`. + items: + allOf: + - type: object + properties: + mention: + type: string + description: >- + Nom du dirigeant, avec le texte recherché + encerclé d'une balise HTML ``. + - $ref: '#/components/schemas/RepresentantSuggestions' + resultats_siren: + type: array + format: optional + description: >- + Liste des entreprises dont le numéro SIREN peut compléter + la recherche textuelle. Uniquement présent si le paramètre + `cibles` contient `siren`. + items: + allOf: + - type: object + properties: + mention: + type: string + description: >- + SIREN de l'entreprise, avec le texte recherché + encerclé d'une balise HTML ``. + - $ref: '#/components/schemas/EntrepriseRecherche' + resultats_siret: + type: array + format: optional + description: >- + Liste des entreprises dont le numéro SIRET peut compléter + la recherche textuelle. Uniquement présent si le paramètre + `cibles` contient `siret`. + items: + allOf: + - type: object + properties: + mention: + type: string + description: >- + SIRET de l'entreprise, avec le texte recherché + encerclé d'une balise HTML ``. + - $ref: '#/components/schemas/EntrepriseRecherche' + '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. + description: >- + Vous devez fournir le SIREN de l'entreprise pour laquelle vous souhaitez + obtenir les comptes annuels. + operationId: comptes-annuels + parameters: + - $ref: '#/components/parameters/api_token' + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + - name: annee + in: query + 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. + 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: + type: object + additionalProperties: + type: array + description: Comptes disponibles pour l'année correspondant à la clé. + items: + type: object + description: Année + properties: + date_depot: + type: string + description: Date de dépôt des comptes, au format AAAA-MM-JJ. + example: '2021-04-23T00:00:00.000Z' + code_greffe: + type: string + description: Code du greffe de dépôt des comptes. + example: 7501 + numero_depot: + type: string + description: Numéro de dépôt des comptes au greffe. + example: 75548 + numero_gestion: + type: string + description: Numéro de gestion au greffe. + example: 2003B09427 + date_cloture: + type: string + description: Date de cloture des comptes, au format AAAA-MM-JJ. + example: '2020-12-31T00:00:00.000Z' + date_cloture_n-1: + type: string + format: nullable + description: >- + Date de cloture des comptes n-1, lorsque présents, au + format AAAA-MM-JJ. + duree_exercice_n: + type: integer + description: Durée de l'exercice déposé, en mois. + example: 12 + duree_exercice_n-1: + type: integer + format: nullable + description: >- + Durée de l'exercice précédent, lorsque présent, en + mois. + type_comptes: + type: string + enum: + - C + - S + - K + - CS + - B + - A + description: >- + Type de comptes (C = complets ; S = simplifiés ; K = + consolidés ; CS = mélange complets/simplifiés ; B = + banques ; A = assurances). + example: C + libelle_type_comptes: + type: string + enum: + - Complets + - Simplifiés + - Consolidés + - Complets/Simplifiés + - Banques + - Assurances + description: Libellé du type de comptes. + example: Complets + devise: + type: string + description: Devise des comptes. + example: EUR + devise_origine: + type: string + format: nullable + description: Devise d'origine en cas de conversion. + confidentialite: + type: boolean + description: Confidentialité totale des comptes. + confidentialite_compte_de_resultat: + type: boolean + description: >- + Confidentialité partielle des comptes (seul le compte + de résultat est confidentiel, le reste des comptes + sont disponibles). + coherence_comptable: + type: boolean + description: >- + Vrai si les comptes sont cohérents d'un point de vue + comptable (équilibre du bilan par exemple). + type_saisie: + type: string + description: Description du type de saisie des comptes. + informations_traitement: + type: array + format: nullable + description: >- + Informations complémentaires sur le traitement des + comptes. + items: + type: string + sections: + type: array + description: Liste des sections de liasses fiscales. + items: + type: object + properties: + libelle: + type: string + description: Libellé de la section. + example: Actif (bilan) + liasses: + type: array + description: Liste des liasses fiscales de la section. + items: + type: object + properties: + code: + type: string + description: Code de la liasse. + example: AN + libelle: + type: string + description: Libellé de la liasse. + example: Terrains + colonnes: + type: array + description: Colonnes de la liasse. + items: + type: object + properties: + libelle: + type: string + description: Libellé de la colonne. + example: Montant brut année N + valeur: + type: integer + description: Valeur de la colonne. + example: 60067444 + ratios: + $ref: '#/components/schemas/Ratios' + '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. + 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. + operationId: cartographie + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: true + schema: + type: string + example: 443061841 + - name: inclure_entreprises_dirigees + in: query + 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`. + required: false + schema: + type: boolean + - name: inclure_entreprises_citees + in: query + 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`. + required: false + schema: + type: boolean + - name: inclure_sci + in: query + description: >- + Si vrai, la cartographie intègrera les SCI. Valeur par défaut : + `true`. + required: false + schema: + type: boolean + - name: autoriser_modifications + in: query + 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`. + required: false + schema: + type: boolean + - name: rejeter_premier_degre + in: query + 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`. + required: false + schema: + type: boolean + - name: degre + in: query + 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. + 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. + description: >- + Vous devez fournir le token du document. Le document vous sera envoyé au + format PDF ou XLSX. + operationId: document-telechargement + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: token + in: query + description: Token du document + 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: + type: string + format: binary + '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. + description: >- + Vous devez fournir soit le SIREN, soit le SIRET. Le document vous sera + envoyé au format PDF. + operationId: document-extrait-pappers + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + - name: siret + in: query + description: SIRET de l'entreprise + 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: + type: string + format: binary + '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: + tags: + - Documents + summary: >- + Télécharge l'extrait INPI d'une entreprise à partir de son SIREN ou + SIRET. + description: >- + Vous devez fournir soit le SIREN, soit le SIRET. Le document vous sera + envoyé au format PDF. + operationId: document-extrait-inpi + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + - name: siret + in: query + description: SIRET de l'entreprise + required: false + schema: + type: string + example: 44306184100047 + responses: + '200': + description: >- + Document disponible. Le retour contient l'extrait INPI au format + PDF. + content: + application/pdf: + schema: + type: string + format: binary + '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/avis_situation_insee: + get: + tags: + - Documents + summary: >- + Télécharge l'avis de situation INSEE d'une entreprise à partir de son + SIREN ou SIRET. + description: >- + Vous devez fournir soit le SIREN, soit le SIRET. Le document vous sera + envoyé au format PDF. + operationId: document-avis-situation-insee + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + - name: siret + in: query + description: SIRET de l'entreprise + required: false + schema: + type: string + example: 44306184100047 + responses: + '200': + description: >- + Document disponible. Le retour contient l'avis de situation au + format PDF. + content: + application/pdf: + schema: + type: string + format: binary + '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/statuts: + get: + tags: + - Documents + summary: >- + Télécharge les derniers statuts disponibles d'une entreprise à partir de + son SIREN ou SIRET. + description: >- + Vous devez fournir soit le SIREN, soit le SIRET. Le document vous sera + envoyé au format PDF. + operationId: document-status + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + - name: siret + in: query + description: SIRET de l'entreprise + required: false + schema: + type: string + example: 44306184100047 + responses: + '200': + description: Document disponible. Le retour contient les statuts au format PDF. + content: + application/pdf: + schema: + type: string + format: binary + '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/declaration_beneficiaires_effectifs: + get: + tags: + - Documents + summary: >- + Télécharge la déclaration des bénéficiaires effectifs d'une entreprise à + partir de son SIREN. + description: >- + Vous devez fournir le SIREN. Le document vous sera envoyé au format PDF. + + + Seules les autorités de contrôle (article + R. 561-57 du Code monétaire et financier en dénombre 18) et les + personnes assujetties à la lutte contre le blanchiment des capitaux et + le financement du terrorisme (article + L. 561-2 du code monétaire et financier) peuvent accéder à ces + informations. + + + Pour pouvoir utiliser cette route veuillez nous contacter au préalable à + api@pappers.fr + operationId: document-beneficiaires-effectifs + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + responses: + '200': + description: >- + Document disponible. Le retour contient la déclaration des + bénéficiaires effectifs au format PDF. + content: + application/pdf: + schema: + type: string + format: binary + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '403': + description: Vous n'avez pas les droits pour exécuter cette requête. + '404': + description: Document indisponible. + '503': + description: Service momentanément indisponible. + /document/rapport_solvabilite: + get: + tags: + - Documents + summary: >- + Télécharge un Rapport de solvabilité d'une entreprise à partir de son + SIREN. + description: Vous devez fournir le SIREN. Le document vous sera envoyé au format PDF. + operationId: document-scoring-financier + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + responses: + '200': + description: >- + Document disponible. Le retour contient le rapport de solvabilité au + format PDF. + content: + application/pdf: + schema: + type: string + format: binary + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '404': + description: Document indisponible. + '503': + description: Service momentanément indisponible. + /conformite/personne_physique: + get: + tags: + - Conformité + summary: >- + Vérifie le statut de personne politiquement exposée et la présence de + sanctions internationales pour une personne physique. + description: > + Cette route vérifie le statut de personne politiquement exposée et la + présence de sanctions internationales pour une personne physique. + + + Pour vérifier le statut de dirigeants et bénéficiaires effectifs + d'entreprises, vous pouvez directement utiliser la route `/entreprise` + avec les champs supplémentaires `personne_politiquement_exposee` et + `sanctions`. + operationId: conformite + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: nom + in: query + description: Nom de la personne physique + required: true + schema: + type: string + example: Macron + - name: prenom + in: query + description: Prénom de la personne physique + required: true + schema: + type: string + example: Emmanuel + - name: date_de_naissance + in: query + description: >- + Date de naissance de la personne physique, au format AAAA-MM-JJ ou + AAAA-MM + required: true + schema: + type: string + example: '1977-12-21T00:00:00.000Z' + responses: + '200': + description: La personne physique a pu être vérifiée. + content: + application/json: + schema: + type: object + properties: + personne_politiquement_exposee: + $ref: '#/components/schemas/PersonnePolitiquementExposee' + sanctions_en_cours: + type: boolean + format: optional + description: >- + Vaut vrai si le bénéficiaire effectif est actuellement + sous sanction. Uniquement présent si demandé dans les + champs supplémentaires. + sanctions: + type: array + description: >- + Liste des sanctions du bénéficiaire effectif. Uniquement + présent si demandé dans les champs supplémentaires. + items: + $ref: '#/components/schemas/Sanction' + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '503': + description: Erreur interne. La personne physique n'a pas pu être vérifiée. + /suivi-jetons: + get: + tags: + - Suivi utilisation + summary: Récupère le suivi d'utilisation des jetons. + description: Vous devez fournir la clé d'utilisation de l'API. + operationId: suivi-jetons + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + responses: + '200': + description: Succès + content: + application/json: + schema: + type: object + description: Suivi d'utilisation des jetons. + properties: + jetons_abonnement: + type: number + example: 10000 + description: Le nombre de jetons mensuels initiaux de votre abonnement. + jetons_abonnement_utilises: + type: number + example: 650 + description: >- + Le nombre de jetons mensuels de votre abonnement que vous + avez utilisés + jetons_pay_as_you_go_restants: + type: number + example: 0 + description: Le nombre de jetons pay as you go qu'il vous reste. + '401': + description: Clé API incorrecte. + '503': + description: Service momentanément indisponible. + /liste: + post: + tags: + - Surveillance + summary: Ajoute une (ou plusieurs) entreprise(s) à une liste d'entreprises. + description: >- + Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant + de votre liste. + operationId: surveillance-entreprise + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: id_liste + in: query + description: Identifiant unique de votre liste de surveillance d'entreprises + required: true + schema: + type: string + example: votre_identifiant_ici + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + type: object + required: + - siren + properties: + siren: + type: string + example: '443061841' + description: SIREN de l'entreprise + responses: + '200': + description: Aucun changement, les données étaient déjà présentes. + content: + application/json: + schema: + type: object + description: Nombre de notifications ajoutées. + properties: + notifications_ajoutees: + type: number + example: 0 + default: 0 + description: >- + Le nombre d'entreprises ajoutées à votre liste de + surveillance d'entreprises. + '201': + description: Créés, liste mise à jour. + content: + application/json: + schema: + type: object + description: Nombre de notifications ajoutées. + properties: + notifications_ajoutees: + type: number + example: 10 + description: >- + Le nombre d'entreprises ajoutées à votre liste de + surveillance d'entreprises. + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '403': + description: Offre dépassée. + '404': + description: Liste non trouvée. + '503': + description: Service momentanément indisponible. + /liste/: + post: + tags: + - Surveillance + summary: Ajoute un (ou plusieurs) dirigeant(s) à une liste de dirigeants. + description: >- + Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant + de votre liste. Les informations à renseigner sont différentes selon le + type de personne à ajouter (morale ou physique) + operationId: surveillance-dirigeant + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: id_liste + in: query + description: Identifiant unique de votre liste de surveillance de dirigeants + required: true + schema: + type: string + example: votre_identifiant_ici + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + type: object + required: + - siren + properties: + siren: + type: string + description: >- + SIREN de la personne morale (si ajout d'une personne + morale) + denomination: + type: string + description: >- + Dénomination de la personne morale (si ajout d'une + personne morale) + nom: + type: string + description: >- + Nom de la personne physique (si ajout d'une personne + physique) + prenom: + type: string + description: >- + Prénom de la personne physique (si ajout d'une personne + physique) + date_de_naissance: + type: string + description: >- + Date de naissance de la personne physique au format + AAAA-MM-JJ (si ajout d'une personne physique) + recherche_elargie: + type: boolean + default: false + description: >- + Active la recherche élargie du dirigeant :
  • Pour + une personne physique : c'est un cas rare mais la date de + naissance du dirigeant n'est pas toujours connue de + Pappers. Si vous activer ce filtre et que la date de + naissance est inconnue, l'alerte sera générée uniquement + sur la base du nom et prénom.
  • Pour une personne + morale : c'est un cas rare mais le SIREN du dirigeant + n'est pas toujours connu de Pappers. Si vous activer ce + filtre et que le SIREN est inconnu, l'alerte sera générée + uniquement sur la base de la dénomination. Activable + uniquement si le champ denomination est présent.
+ example: + - siren: '443061841' + denomination: Google FRANCE + - nom: Yi + prenom: Kenneth H. + date_de_naissance: '1970-01-06' + recherche_elargie: true + responses: + '200': + description: Aucun changement, les données étaient déjà présentes. + content: + application/json: + schema: + type: object + description: Nombre de notifications ajoutées. + properties: + notifications_ajoutees: + type: number + example: 0 + default: 0 + description: >- + Le nombre de dirigeants ajoutées à votre liste de + surveillance de dirigeants. + '201': + description: Créés, liste mise à jour. + content: + application/json: + schema: + type: object + description: Nombre de notifications ajoutées. + properties: + notifications_ajoutees: + type: number + example: 10 + description: >- + Le nombre de dirigeants ajoutées à votre liste de + surveillance de dirigeants. + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '403': + description: Offre dépassée. + '404': + description: Liste non trouvée. + '503': + description: Service momentanément indisponible. + delete: + tags: + - Surveillance + summary: Supprime une (ou plusieurs) notification(s) d'une liste. + description: >- + Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant + de votre liste. + operationId: surveillance-notifications-delete + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: id_liste + in: query + description: Identifiant unique de votre liste de surveillance + required: true + schema: + type: string + example: votre_identifiant_ici + - name: siren + in: query + description: >- + Liste des sirens des notifications à supprimer, séparés par une + virgule + required: false + schema: + type: string + example: 443061841,950370973 + - name: id + in: query + description: Liste des ids des notifications à supprimer, séparés par une virgule + required: false + schema: + type: string + example: >- + ecfca3e5fb1ce07bb3fdfe8760a28df5aa617ed4951b7f61,a67b9de66189ba98eb4aede09f4b2b565b0f18fe694da7bc + - name: supprimer_totalite + in: query + description: Suppression de toutes les notifications de la liste + required: false + schema: + type: boolean + example: true + responses: + '200': + description: Succés. + content: + application/json: + schema: + type: object + description: Nombre de notifications supprimées. + properties: + notifications_supprimees: + type: number + example: 10 + description: >- + Le nombre de notifications supprimées de votre liste de + surveillance. + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '404': + description: Liste non trouvée. + '503': + description: Service momentanément indisponible. + /liste-informations: + post: + tags: + - Surveillance + summary: Ajoute des informations à une (ou plusieurs) notification(s). + description: >- + Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant + de votre liste. + operationId: surveillance-liste-informations + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: id_liste + in: query + description: Identifiant unique de votre liste de surveillance d'entreprises + required: true + schema: + type: string + example: votre_identifiant_ici + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + notifications: + type: array + description: Tableau d'identifiant de notifications + items: + type: string + example: ecfca3e5fb1ce07bb3fdfe8760a28df5aa617ed4951b7f61 + informations: + type: string + example: Information quelconque + description: Information à rajouter sur les notifications + maxLength: 255 + responses: + '200': + description: Succés. + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '404': + description: Liste non trouvée. + '503': + description: Service momentanément indisponible. + components: + parameters: + api_token: + name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + par_page: + name: par_page + in: query + description: 'Nombre de résultats affichés sur une page. Valeur par défaut : `10`.' + required: false + schema: + type: integer + example: 20 + page: + name: page + in: query + description: 'Page de résultats. Valeur par défaut : `1`.' + required: false + schema: + type: integer + example: 1 + bases: + name: bases + in: query + description: >- + Bases de données dans lesquelles rechercher. Il est possible d'indiquer + plusieurs bases en les séparant par des virgules. Valeur par défaut : + `"entreprises"`. + required: false + schema: + type: string + enum: + - entreprises + - dirigeants + - beneficiaires + - documents + - publications + example: entreprises + precision: + name: precision + in: query + description: 'Niveau de précision de la recherche. Valeur par défaut : `"standard"`.' + required: false + schema: + type: string + enum: + - approximative + - standard + - exacte + example: standard + curseur: + name: curseur + in: query + description: >- + Curseur servant à parcourir l'ensemble des résultats (alternativement à + la pagination qui est limitée à 400 résultats maximum). Doit valoir `*` + pour la première requête, et doit pour les requêtes suivantes reprendre + la valeur `curseurSuivant` retournée par la dernière réponse. + required: false + schema: + type: string + example: '*' + par_curseur: + name: par_curseur + in: query + description: >- + Nombre de résultats affichés par curseur. Valeur par défaut : `50`. + Valeur minimale: `1`. Valeur maximale : `1000`. + required: false + schema: + type: integer + example: 20 + code_naf: + name: code_naf + in: query + description: >- + Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes NAF + en les séparant par des virgules. + required: false + schema: + type: string + example: 70.10Z + departement: + name: departement + in: query + description: >- + Numéro de département de l'un des établissements de l'entreprise. Il est + possible d'indiquer plusieurs départements en les séparant par des + virgules. + required: false + schema: + type: string + example: 75 + region: + name: region + in: query + description: >- + Code de la région de l'un des établissements de l'entreprise, selon la + [nomenclature + Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il + est possible d'indiquer plusieurs codes régions en les séparant par des + virgules. + required: false + schema: + type: string + example: 11 + code_postal: + name: code_postal + in: query + description: >- + Code postal de l'un des établissements de l'entreprise. Il est possible + d'indiquer plusieurs codes postaux en les séparant par des virgules. + required: false + schema: + type: string + example: 75009 + convention_collective: + name: convention_collective + in: query + description: Convention collective de l'entreprise. + required: false + schema: + type: string + example: 1486 + categorie_juridique: + name: categorie_juridique + in: query + description: >- + Catégorie juridique de l'entreprise, selon la [nomenclature + Insee](https://www.insee.fr/fr/information/2028129). + + + **Note** : Le code correspond à celui de l'INSEE, à l'exception des SASU + qui auront comme code 5720 et les EURL qui auront comme code 5498. + required: false + schema: + type: string + example: 5499 + entreprise_cessee: + name: entreprise_cessee + in: query + description: Activité de l'entreprise cessée ou non. + required: false + schema: + type: boolean + example: false + statut_rcs: + name: statut_rcs + in: query + description: Statut au RCS + required: false + schema: + type: string + enum: + - inscrit + - radie + - non inscrit + example: inscrit + objet_social: + name: objet_social + in: query + description: Objet social de l'entreprise déclaré au RCS. + required: false + schema: + type: string + example: La conception de moteurs de recherche sur internet. + date_immatriculation_rcs_min: + name: date_immatriculation_rcs_min + in: query + description: >- + Date d'immatriculation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + required: false + schema: + type: string + example: 15-05-2002 + date_immatriculation_rcs_max: + name: date_immatriculation_rcs_max + in: query + description: d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA. + required: false + schema: + type: string + example: 15-05-2002 + date_radiation_rcs_min: + name: date_radiation_rcs_min + in: query + description: Date de radiation au RCS minimale de l'entreprise, au format JJ-MM-AAAA. + required: false + schema: + type: string + example: 15-05-2002 + date_radiation_rcs_max: + name: date_radiation_rcs_max + in: query + description: Date de radiation au RCS maximale de l'entreprise, au format JJ-MM-AAAA. + required: false + schema: + type: string + example: 17-05-2002 + capital_min: + name: capital_min + in: query + description: Capital minimum de l'entreprise. + required: false + schema: + type: string + example: 411016200 + capital_max: + name: capital_max + in: query + description: Capital maximum de l'entreprise. + required: false + schema: + type: string + example: 411016400 + chiffre_affaires_min: + name: chiffre_affaires_min + in: query + description: >- + Chiffre d'affaires minimum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + required: false + schema: + type: string + example: 411016200 + chiffre_affaires_max: + name: chiffre_affaires_max + in: query + description: >- + Chiffre d'affaires maximum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + required: false + schema: + type: string + example: 411016400 + resultat_min: + name: resultat_min + in: query + description: >- + Résultat minimum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + required: false + schema: + type: string + example: 29327000 + resultat_max: + name: resultat_max + in: query + description: >- + Résultat maximum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + required: false + schema: + type: string + example: 29327100 + date_creation_min: + name: date_creation_min + in: query + description: Date de création minimale de l'entreprise, au format JJ-MM-AAAA. + required: false + schema: + type: string + example: 15-05-2002 + date_creation_max: + name: date_creation_max + in: query + description: Date de création maximale de l'entreprise, au format JJ-MM-AAAA. + required: false + schema: + type: string + example: 17-05-2002 + tranche_effectif_min: + name: tranche_effectif_min + in: query + description: >- + Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen). + + + **Note** : 00 ou NN donneront les mêmes résultats et veulent dire non + employeur + required: false + schema: + type: string + example: 40 + tranche_effectif_max: + name: tranche_effectif_max + in: query + description: >- + Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen). + + + **Note** : 00 ou NN donneront les mêmes résultats et veulent dire non + employeur + required: false + schema: + type: string + example: 42 + type_dirigeant: + name: type_dirigeant + in: query + description: >- + Type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + required: false + schema: + type: string + enum: + - physique + - morale + example: physique + qualite_dirigeant: + name: qualite_dirigeant + in: query + description: >- + Qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + required: false + schema: + type: string + example: Administrateur + nationalite_dirigeant: + name: nationalite_dirigeant + in: query + description: >- + Nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + required: false + schema: + type: string + example: Française + nom_dirigeant: + name: nom_dirigeant + in: query + description: >- + Nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + required: false + schema: + type: string + example: Yi + prenom_dirigeant: + name: prenom_dirigeant + in: query + description: >- + Prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + required: false + schema: + type: string + example: Kenneth H. + age_dirigeant_min: + name: age_dirigeant_min + in: query + description: >- + Âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + required: false + schema: + type: integer + example: 40 + age_dirigeant_max: + name: age_dirigeant_max + in: query + description: >- + Âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + required: false + schema: + type: integer + example: 42 + date_de_naissance_dirigeant_min: + name: date_de_naissance_dirigeant_min + in: query + description: >- + Date de naissance minimale du dirigeant (ou de l'un des dirigeants de + l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '1970-01-01T00:00:00.000Z' + date_de_naissance_dirigeant_max: + name: date_de_naissance_dirigeant_max + in: query + description: >- + Date de naissance maximale du dirigeant (ou de l'un des dirigeants de + l'entreprise pour une recherche d'entreprises) de l'entreprise, au + format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '1970-12-31T00:00:00.000Z' + age_beneficiaire_min: + name: age_beneficiaire_min + in: query + description: >- + Âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + required: false + schema: + type: integer + example: 40 + age_beneficiaire_max: + name: age_beneficiaire_max + in: query + description: >- + Âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + required: false + schema: + type: integer + example: 42 + date_de_naissance_beneficiaire_min: + name: date_de_naissance_beneficiaire_min + in: query + description: >- + Date de naissance minimale du bénéficiaire effectif (ou de l'un des + bénéficiaires effectifs de l'entreprise pour une recherche + d'entreprises), au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '1970-01-01T00:00:00.000Z' + date_de_naissance_beneficiaire_max: + name: date_de_naissance_beneficiaire_max + in: query + description: >- + Date de naissance maximale du bénéficiaire effectif (ou de l'un des + bénéficiaires effectifs de l'entreprise pour une recherche + d'entreprises) de l'entreprise, au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '1970-12-31T00:00:00.000Z' + nationalite_beneficiaire: + name: nationalite_beneficiaire + in: query + description: >- + Nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + required: false + schema: + type: string + example: Française + date_depot_document_min: + name: date_depot_document_min + in: query + description: Date de dépôt minimale du document, au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '2000-01-01T00:00:00.000Z' + date_depot_document_max: + name: date_depot_document_max + in: query + description: Date de dépôt maximale du document, au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '2000-12-31T00:00:00.000Z' + type_publication: + name: type_publication + in: query + description: Type de publication + required: false + schema: + type: string + enum: + - Création + - Immatriculation + - Modification + - Vente + - Radiation + - Procédure collective + - Dépôt des comptes + example: Procédure collective + date_publication_min: + name: date_publication_min + in: query + description: Date publication minimale de la publication, au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '2000-01-01T00:00:00.000Z' + date_publication_max: + name: date_publication_max + in: query + description: Date de publication maximale de la publication, au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '2000-12-31T00:00:00.000Z' + siren: + name: siren + in: query + description: SIREN de l'entreprise. + required: false + schema: + type: string + example: null + schemas: + EntrepriseBase: + type: object + properties: + siren: + type: string + example: '443061841' + description: Le numéro SIREN de l'entreprise au format xxxxxxxxx. + siren_formate: + type: string + example: 443 061 841 + description: Le numéro SIREN de l'entreprise au format xxx xxx xxx. + nom_entreprise: + type: string + example: GOOGLE FRANCE + description: >- + Le nom de l'entreprise. Il est égal à sigle + dénomination en cas de + personne morale, ou à nom + prénom en cas de personne physique. + Nullable si le paramètre `integrer_diffusions_partielles` est à + vrai. + personne_morale: + type: boolean + description: Vrai en cas de personne morale, faux en cas de personne physique. + denomination: + type: string + format: nullable + description: Dénomination de l'entreprise si personne morale. + example: GOOGLE FRANCE + nom: + type: string + format: nullable + description: Nom si personne physique. + example: null + prenom: + type: string + format: nullable + description: Prénom si personne physique. + example: null + sexe: + type: string + format: nullable + description: Sexe si personne physique. F pour féminin, M pour masculin. + example: null + code_naf: + type: string + description: Code NAF de l'entreprise. + example: 70.10Z + libelle_code_naf: + type: string + description: Libellé du code NAF de l'entreprise. + example: Activités des sièges sociaux + domaine_activite: + type: string + description: Domaine d'activité de l'entreprise. + example: Activités des sièges sociaux ; conseil de gestion + conventions_collectives: + description: Liste des conventions collectives de l'entreprise. + type: array + items: + type: object + properties: + nom: + type: string + description: Nom de la convention collective. + example: >- + Convention collective nationale applicable au personnel des + bureaux d'études techniques des cabinets d'ingénieurs-conseils + et des sociétés de conseils(BET SYNTEC) + idcc: + type: integer + description: Code IDCC de l'entreprise. + example: 1486 + confirmee: + type: boolean + description: >- + Si confirmée, l'information est issue de la DSN de + l'entreprise et fournie par le ministère du Travail. Si non + confirmée, ce n'est qu'une estimation à partir du code NAF de + l'entreprise. + pourcentage: + type: number + format: nullable + description: >- + Pourcentage de fiabilité de l'estimation. Si la convention est + confirmée, vaut null. + example: 96.2 + date_creation: + type: string + format: date + description: Date de création de l'entreprise au format AAAA-MM-JJ. + example: '2002-05-16' + date_creation_formate: + type: string + description: Date de création de l'entreprise au format JJ/MM/AAAA. + example: 16/05/2002 + entreprise_cessee: + type: boolean + description: >- + Si vrai, l'entreprise n'est plus en activité. Sinon, elle est + toujours en activité. + date_cessation: + type: string + format: nullable + description: Date de cessation de l'entreprise au format AAAA-MM-JJ. + example: '2002-05-16' + entreprise_employeuse: + type: boolean + description: Si vrai, l'entreprise a au moins un employé. + societe_a_mission: + type: boolean + format: nullable + description: Si vrai, l'entreprise est société à mission. + categorie_juridique: + type: string + description: >- + Catégorie juridique de l'entreprise, selon la [nomenclature + Insee](https://www.insee.fr/fr/information/2028129). + + + **Note** : Le code correspond à celui de l'INSEE, à l'exception des + SASU qui auront comme code 5720 et les EURL qui auront comme code + 5498. + example: '5499' + forme_juridique: + type: string + description: Forme juridique de l'entreprise. + example: Société à responsabilité limitée (SARL) + forme_exercice: + type: string + enum: + - Agent commercial + - 'Agricole : Périmètre des non actifs agricoles' + - 'Agricole : Périmètre des actifs agricoles' + - Artisanale non réglementée + - Artisanale réglementée + - Commerciale + - Libérale non réglementée + - Libérale réglementée + - Loueur meublé + - Toute forme d'activité + - Gestion de biens + - Loueur terre agricole + - Activité de prospection uniquement (non commerciale) + - Sans activité + description: Forme d'exercice de l'activité principale. + format: nullable + example: Commerciale + effectif: + type: string + description: Tranche d'effectif de l'entreprise. + example: Entre 500 et 999 salariés + effectif_min: + type: integer + description: Effectif minimal de l'entreprise. + example: 500 + effectif_max: + type: integer + description: Effectif maximal de l'entreprise. + example: 999 + tranche_effectif: + type: string + format: nullable + description: >- + Tranche d'effectif de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen#:~:text=Cette%20variable%20correspond%20%C3%A0%20la,effectif%20salari%C3%A9%20de%20l'entreprise.). + example: '41' + annee_effectif: + type: integer + format: nullable + description: >- + Année de validité des variables effectif, effectif_min et + effectif_max. + example: 2017 + capital: + type: number + format: nullable + description: Capital de l'entreprise. + example: 464884017 + statut_rcs: + type: string + format: nullable + description: Statut de l'entreprise au RCS + example: Inscrit + EntrepriseFiche: + allOf: + - $ref: '#/components/schemas/EntrepriseBase' + - type: object + properties: + siege: + $ref: '#/components/schemas/EtablissementFiche' + diffusable: + type: boolean + description: >- + Le statut de diffusion de l'entreprise. Non diffusable + correspond à une entreprise ayant demandé une diffusion + partielle de ses données. Aucune information n'est alors + disponible, sauf si vous utilisez le paramètre + `integrer_diffusions_partielles`. + sigle: + type: string + format: nullable + description: Sigle de l'entreprise si personne morale. + example: null + objet_social: + type: string + format: nullable + description: Objet social de l'entreprise. + example: >- + Fourniture de services et/ou conseils relatifs aux logiciels au + réseau internet aux réseaux télématiques ou en ligne notamment + L'intermediation en matière de vente de publicité en ligne la + promotion sous toutes ses formes de la publicité en ligne la + promotion directe de produits et services et la mise en oeuvre + de centres de traitement de l'information + capital_formate: + type: string + format: nullable + description: Capital l'entreprise au format xx xxx €. + example: "464 884 017,00\_€" + capital_actuel_si_variable: + type: string + format: nullable + description: Capital actuel de l'entreprise si variable. + example: null + devise_capital: + type: string + format: nullable + description: Devise de capital_formate et capital_actuel_si_variable. + example: Euros + numero_rcs: + type: string + format: nullable + description: Numéro RCS de l'entreprise. + example: 464884017 R.C.S. Paris + date_cloture_exercice: + type: string + format: nullable + description: Date de clôture d'exercice de l'entreprise. + example: null + date_cloture_exercice_exceptionnelle: + type: string + format: nullable + description: Date de clôture d'exercice exceptionnel de l'entreprise. + example: null + date_cloture_exercice_exceptionnelle_formate: + type: string + format: nullable + description: >- + Date de clôture d'exercice exceptionnel formatée de + l'entreprise. + example: null + prochaine_date_cloture_exercice: + type: string + format: nullable + description: Prochaine date de clôture d'exercice de l'entreprise. + example: null + prochaine_date_cloture_exercice_formate: + type: string + format: nullable + description: Prochaine date de clôture d'exercice formatée de l'entreprise. + example: null + economie_sociale_solidaire: + type: boolean + description: >- + Vrai si l'entreprise est une entreprise de l'économie sociale et + solidaire. + duree_personne_morale: + type: string + format: nullable + description: Durée de la personne morale. + example: null + dernier_traitement: + type: string + format: date + description: Date de dernier traitement de l'entreprise. + example: '2020-07-09' + derniere_mise_a_jour_sirene: + type: string + format: date + description: >- + Dernière mise à jour de la base de donnée sirène au format + AAAA-MM-JJ. + example: '2020-08-13' + derniere_mise_a_jour_rcs: + type: string + format: date + description: >- + Dernière mise à jour de la base de donnée RCS au format + AAAA-MM-JJ. + example: '2020-06-25' + statut_rcs: + type: string + enum: + - Inscrit + - Non inscrit + - Radié + description: Statut de l'entreprise au RCS. + example: Inscrit + greffe: + type: string + format: nullable + description: Greffe RCS de l'entreprise. + example: Paris + code_greffe: + type: string + format: nullable + description: Code greffe RCS de l'entreprise. + example: '7501' + date_immatriculation_rcs: + type: string + format: nullable + description: Date d'immatriculation de l'entreprise au RCS. + example: null + date_premiere_immatriculation_rcs: + type: string + format: nullable + description: Date de la première immatriculation de l'entreprise au RCS. + example: null + date_debut_activite: + type: string + format: nullable + description: Date de début d'activité de l'entreprise. + example: '2002-08-14' + date_debut_premiere_activite: + type: string + format: nullable + description: Date de début d'activité de l'entreprise. + example: null + date_radiation_rcs: + type: string + format: nullable + description: Date de radiation de l'entreprise au RCS. + example: null + statut_rne: + type: string + format: nullable + enum: + - Inscrit + - Non inscrit + - Radié + description: Statut de l'entreprise au RNE. + example: null + date_immatriculation_rne: + type: string + format: nullable + description: Date d'immatriculation de l'entreprise au RNE. + example: null + date_radiation_rne: + type: string + format: nullable + description: Date de radiation de l'entreprise au RNE. + example: null + numero_tva_intracommunautaire: + type: string + description: Numéro de TVA intracommunautaire de l'entreprise. + example: FR64443061841 + validite_tva_intracommunautaire: + type: boolean + format: optional, nullable + description: >- + Présent uniquement si le paramètre + validite_tva_intracommunautaire a été mis à vrai. + + + Si vrai, le numéro de TVA intracommunautaire est valide. Si + faux, il est invalide. Si null, la validité n'a pas pu être + vérifiée. + example: true + associe_unique: + type: boolean + format: nullable + description: >- + Si vrai, l'entreprise est à associé unique (notamment pour les + SASU et les EURL). + micro_entreprise: + type: boolean + format: optional + description: Si vrai, l'entreprise possède le statut de micro-entrepreneur + example: false + etablissements: + type: array + description: Liste des établissements de l'entreprise. + items: + $ref: '#/components/schemas/EtablissementFiche' + finances: + type: array + description: Liste des finances de l'entreprise. + items: + allOf: + - type: object + properties: + annee: + type: integer + description: Année de cloture d'exercice. + example: 2018 + date_de_cloture_exercice: + type: string + format: date + description: >- + Date de cloture de l'exercice des finances de + l'entreprise. + example: '2018-12-31' + duree_exercice: + type: integer + description: Durée de l'exercice de l'entreprise." + example: 12 + - $ref: '#/components/schemas/Ratios' + representants: + type: array + description: Liste des représentants de l'entreprise. + items: + $ref: '#/components/schemas/Representant' + beneficiaires_effectifs: + type: array + description: >- + Liste des bénéficiaires effectifs de l'entreprise (si + disponibles). + items: + type: object + properties: + date_greffe: + type: string + format: date nullable + description: >- + Date de génération des bénéficiaires effectifs, au format + AAAA-MM-JJ. + example: '2021-01-06' + type: + type: string + format: nullable + description: Type du bénéficiaire effectif + example: BE_SOC + nom: + type: string + format: nullable + description: Nom du bénéficiaire effectif. + example: McCourt JR + nom_usage: + type: string + format: nullable + description: Nom d'usage du bénéficiaire effectif. + example: null + prenom: + type: string + format: nullable + description: Prénom du bénéficiaire effectif. + example: Frank + pseudonyme: + type: string + format: nullable + example: null + date_de_naissance_formatee: + type: string + format: nullable + description: >- + Mois et année de naissance du bénéficiaire effectif, au + format MM/AAAA. + example: 08/1953 + date_de_naissance_complete_formatee: + type: string + format: date nullable + description: >- + Date de naissance complète du bénéficiaire effectif, au + format JJ/MM/AAAA. + example: 14/08/1953 + nationalite: + type: string + format: nullable + description: Nationalité du bénéficiaire effectif. + example: Américaine (Etats Unis) + code_nationalite: + type: string + format: nullable + description: Code de la nationalité du bénéficiaire effectif. + example: US + ville_de_naissance: + type: string + format: nullable + description: Ville de naissance du bénéficiaire effectif. + example: Massachusetts + pays_de_naissance: + type: string + format: nullable + description: Pays de naissance du bénéficiaire effectif. + example: ETATS-UNIS D'AMERIQUE + code_pays_de_naissance: + type: string + format: nullable + description: Code du pays de naissance du bénéficiaire effectif. + example: US + adresse_ligne_1: + type: string + format: nullable + description: Première ligne de l'adresse du bénéficiaire effectif. + example: null + adresse_ligne_2: + type: string + format: nullable + description: Deuxième ligne de l'adresse du bénéficiaire effectif. + example: 888 Seventh Avenue 43rd Floor New York (Etat de New York) + adresse_ligne_3: + type: string + format: nullable + description: Troisième ligne de l'adresse du bénéficiaire effectif. + example: null + code_postal: + type: string + format: nullable + description: Code postal du bénéficiaire effectif. + example: null + ville: + type: string + format: nullable + description: Ville du bénéficiaire effectif. + example: null + pays: + type: string + format: nullable + description: Pays du bénéficiaire effectif. + example: ETATS-UNIS D'AMERIQUE + code_pays: + type: string + format: nullable + description: Code du pays du bénéficiaire effectif. + example: US + pourcentage_parts: + type: number + format: nullable + description: >- + Parts détenues par le bénéficiaire effectif, en + pourcentage des parts totales. + pourcentage_parts_directes: + type: number + format: nullable + description: >- + Parts détenues de façon directe par le bénéficiaire + effectif, en pourcentage des parts totales. + pourcentage_parts_indirectes: + type: number + format: nullable + description: >- + Parts détenues de façon indirecte par le bénéficiaire + effectif, en pourcentage des parts totales. + pourcentage_parts_vocation_titulaire: + type: number + format: nullable + description: >- + Parts dont le bénéficiaire effectif a vocation à devenir + titulaire par l'effet d'un acte juridique, en pourcentage + des parts totales. + details_parts_directes: + type: object + format: nullable + description: >- + Détails des parts détenues de façon directe par le + bénéficiaire effectif. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Parts détenues de façon directe en pleine propriété + par le bénéficiaire effectif, en pourcentage des parts + totales. + pourcentage_nue_propriete: + type: number + description: >- + Parts détenues de façon directe en nue propriété par + le bénéficiaire effectif, en pourcentage des parts + totales. + details_parts_indirectes: + type: object + format: nullable + description: >- + Détails des parts détenues de façon indirecte par le + bénéficiaire effectif. + properties: + pourcentage_en_indivision: + type: number + description: >- + Parts détenues de façon indirecte par le biais d'une + indivision par le bénéficiaire effectif, en + pourcentage des parts totales. + pourcentage_en_personne_morale: + type: number + description: >- + Parts détenues de façon indirecte par le biais d'une + personne morale par le bénéficiaire effectif, en + pourcentage des parts totales. + details_en_indivision: + type: object + format: nullable + description: >- + Détails des parts détenues de façon indirecte par le + biais d'une indivision par le bénéficiaire effectif. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Parts détenues de façon indirecte par le biais + d'une indivision en pleine propriété par le + bénéficiaire effectif, en pourcentage des parts + totales. + pourcentage_nue_propriete: + type: number + description: >- + Parts détenues de façon indirecte par le biais + d'une indivision en nue propriété par le + bénéficiaire effectif, en pourcentage des parts + totales. + details_en_personne_morale: + type: object + format: nullable + description: >- + Détails des parts détenues de façon indirecte par le + biais d'une personne morale par le bénéficiaire + effectif. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Parts détenues de façon indirecte par le biais + d'une personne morale en pleine propriété par le + bénéficiaire effectif, en pourcentage des parts + totales. + pourcentage_nue_propriete: + type: number + description: >- + Parts détenues de façon indirecte par le biais + d'une personne morale en nue propriété par le + bénéficiaire effectif, en pourcentage des parts + totales. + details_parts_vocation_titulaire: + type: object + format: nullable + description: >- + Détails des parts dont le bénéficiaire effectif a vocation + à devenir titulaire. + properties: + pourcentage_directes: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon directe, en pourcentage des + parts totales. + pourcentage_indirectes: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon indirecte, en pourcentage + des parts totales. + details_directes: + type: object + format: nullable + description: >- + Détails des parts dont le bénéficiaire effectif a + vocation à devenir titulaire de façon directe. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon directe en pleine + propriété, en pourcentage des parts totales. + pourcentage_nue_propriete: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon directe en nue + propriété, en pourcentage des parts totales. + details_indirectes: + type: object + format: nullable + description: >- + Détails des parts dont le bénéficiaire effectif a + vocation à devenir titulaire de façon indirecte. + properties: + pourcentage_en_indivision: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon indirecte par le biais + d'une indivision, en pourcentage des parts + totales. + pourcentage_en_personne_morale: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon indirecte par le biais + d'une personne morale, en pourcentage des parts + totales. + details_en_indivision: + type: object + format: nullable + description: >- + Détails des parts dont le bénéficiaire effectif a + vocation à devenir titulaire de façon indirecte + par le biais d'une indivision. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation + à devenir titulaire de façon indirecte par le + biais d'une indivision en pleine propriété, en + pourcentage des parts totales. + pourcentage_nue_propriete: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation + à devenir titulaire de façon indirecte par le + biais d'une indivision en nue propriété, en + pourcentage des parts totales. + details_en_personne_morale: + type: object + format: nullable + description: >- + Détails des parts dont le bénéficiaire effectif a + vocation à devenir titulaire de façon indirecte + par le biais d'une personne morale. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation + à devenir titulaire de façon indirecte par le + biais d'une personne morale en pleine + propriété, en pourcentage des parts totales. + pourcentage_nue_propriete: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation + à devenir titulaire de façon indirecte par le + biais d'une personne morale en nue propriété, + en pourcentage des parts totales. + pourcentage_votes: + type: number + format: nullable + description: >- + Droits de vote détenus par le bénéficiaire effectif, en + pourcentage des droits de vote totaux. + pourcentage_votes_directs: + type: number + format: nullable + description: >- + Droits de vote détenus de façon directe par le + bénéficiaire effectif, en pourcentage des droits de vote + totaux. + pourcentage_votes_indirect: + type: number + format: nullable + description: >- + Droits de vote détenus de façon indirecte par le + bénéficiaire effectif, en pourcentage des droits de vote + totaux. + details_votes_directs: + type: object + format: nullable + description: >- + Détails des droits de vote détenus de façon directe par le + bénéficiaire effectif. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Droits de vote détenus de façon directe en pleine + propriété par le bénéficiaire effectif, en pourcentage + des droits de vote totaux. + pourcentage_nue_propriete: + type: number + description: >- + Droits de vote détenus de façon directe en nue + propriété par le bénéficiaire effectif, en pourcentage + des droits de vote totaux. + pourcentage_usufruit: + type: number + description: >- + Droits de vote détenus de façon directe en usufruit + par le bénéficiaire effectif, en pourcentage des + droits de vote totaux. + details_votes_indirects: + type: object + format: nullable + description: >- + Détails des droits de vote détenus de façon indirecte par + le bénéficiaire effectif. + properties: + pourcentage_en_indivision: + type: number + description: >- + Droits de vote détenus de façon indirecte par le biais + d'une indivision par le bénéficiaire effectif, en + pourcentage des droits de vote totaux. + pourcentage_en_personne_morale: + type: number + description: >- + Droits de vote détenus de façon indirecte par le biais + d'une personne morale par le bénéficiaire effectif, en + pourcentage des droits de vote totaux. + details_en_indivision: + type: object + format: nullable + description: >- + Détails des droits de vote détenus de façon indirecte + par le biais d'une indivision par le bénéficiaire + effectif. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une indivision en pleine propriété par le + bénéficiaire effectif, en pourcentage des droits + de vote totaux. + pourcentage_nue_propriete: + type: number + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une indivision en nue propriété par le + bénéficiaire effectif, en pourcentage des droits + de vote totaux. + pourcentage_usufruit: + type: number + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une indivision en usufruit par le + bénéficiaire effectif, en pourcentage des droits + de vote totaux. + details_en_personne_morale: + type: object + format: nullable + description: >- + Détails des droits de vote détenus de façon indirecte + par le biais d'une personne morale par le bénéficiaire + effectif. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une personne morale en pleine propriété + par le bénéficiaire effectif, en pourcentage des + droits de vote totaux. + pourcentage_nue_propriete: + type: number + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une personne morale en nue propriété par + le bénéficiaire effectif, en pourcentage des + droits de vote totaux. + pourcentage_usufruit: + type: number + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une personne morale en usufruit par le + bénéficiaire effectif, en pourcentage des droits + de vote totaux. + details_societe_de_gestion: + type: object + format: nullable + description: Détails sur la société de gestion, le cas échéant. + properties: + nom: + type: string + format: nullable + description: Nom de la société de gestion. + siren: + type: string + format: nullable + description: SIREN de la société de gestion. + greffe: + type: string + format: nullable + description: Greffe de la société de gestion. + adresse: + type: string + format: nullable + description: Adresse de la société de gestion. + code_postal: + type: string + format: nullable + description: Code postal de la société de gestion. + ville: + type: string + format: nullable + description: Ville de la société de gestion. + detention_pouvoir_decision_ag: + type: boolean + description: >- + Vaut vrai pour les moyens de contrôle sur les organes + d'administration, de gestion, de direction ou de + surveillance de la personne morale autre que le pouvoir de + nommer ou de révoquer la majorité des membres. + detention_pouvoir_nom_membre_conseil_administration: + type: boolean + description: >- + Vaut vrai si le moyen de contrôle est le pouvoir de nommer + ou de révoquer la majorité des membres des organes + d'administration, de gestion, de direction ou de + surveillance de la personne morale. + detention_autres_moyens_controle: + type: boolean + description: Vaut vrai s'il existe d'autres moyens de contrôle. + beneficiaire_representant_legal: + type: boolean + description: >- + Vaut vrai dans le cas où le bénéficiaire effectif a été + défini comme le représentant légal par défaut. + representant_legal_placement_sans_gestion_delegation: + type: boolean + description: >- + Vaut vrai dans le cas où le bénéficiaire effectif est le + représentant légal du placement collectif (cas où le + placement collectif n'a pas délégué sa gestion à une + société de gestion). + personne_politiquement_exposee: + $ref: '#/components/schemas/PersonnePolitiquementExposee' + sanctions_en_cours: + type: boolean + format: optional + description: >- + Vaut vrai si le bénéficiaire effectif est actuellement + sous sanction. Uniquement présent si demandé dans les + champs supplémentaires. + sanctions: + type: array + description: >- + Liste des sanctions du bénéficiaire effectif. Uniquement + présent si demandé dans les champs supplémentaires. + items: + $ref: '#/components/schemas/Sanction' + depots_actes: + type: array + description: Liste des actes de l'entreprise. + items: + type: object + properties: + date_depot: + type: string + format: date + description: Date de dépôt de l'acte, au format AAAA-MM-JJ. + example: '2020-04-07' + date_depot_formate: + type: string + description: Date de dépôt formatée de l'acte, au format JJ/MM/AAAA. + example: 07/04/2020 + disponible: + type: boolean + description: >- + Disponibilité de l'acte. Un acte peut être indisponible + car il a été publié avant le 1er janvier 1993 ou bien car + il est confidentiel. + nom_fichier_pdf: + type: string + description: Nom du fichier pdf de l'acte. + example: GOOGLE FRANCE - Actes du 07-04-2020.pdf + token: + type: string + description: Token de l'acte. + example: >- + QTQ0MzA2MTg0MTIwMjAwNDA3RMOpY2lzaW9uKHMpIGRlIGwnYXNzb2Npw6kgdW5pcXVl + actes: + type: array + description: Détails de l'acte. + items: + type: object + properties: + type: + type: string + description: Type de l'acte. + example: Décision(s) de l'associé unique + decision: + type: string + format: nullable + description: Décision de l'acte. + example: Augmentation du capital social + date_acte: + type: string + format: date nullable + description: Date de l'acte, au format AAAA-MM-JJ. + example: '2020-03-04' + date_acte_formate: + type: string + format: nullable + description: Date formatée de l'acte, au format JJ/MM/AAAA. + example: 04/03/2020 + comptes: + type: array + description: Liste des comptes de l'entreprise. + items: + type: object + properties: + date_depot: + type: string + format: date + description: Date de dépôt des comptes. + example: '2020-07-16' + date_depot_formate: + type: string + description: Date de dépôt formatée des comptes. + example: 16/07/2020 + date_cloture: + type: string + format: date + description: Date de clôture des comptes, au format AAAA-MM-JJ. + example: '2019-12-31' + annee_cloture: + type: integer + description: Année de clôture des comptes. + example: 2019 + confidentialite: + description: Confidentialité totale des comptes. + type: boolean + confidentialite_compte_de_resultat: + description: >- + Confidentialité partielle des comptes (seul le compte de + résultat est confidentiel, le reste des comptes sont + disponibles). + type: boolean + disponible: + description: Disponibilité des comptes au format PDF. + type: boolean + nom_fichier_pdf: + type: string + format: optional + description: Nom du fichier PDF des comptes. + example: GOOGLE FRANCE - Comptes 2019.pdf + token: + type: string + format: optional + description: Token des comptes. + example: QzQ0MzA2MTg0MTIwMjAwNzE2 + disponible_xlsx: + description: Disponibilité des comptes au format XLSX. + type: boolean + nom_fichier_xlsx: + type: string + format: optional + description: Nom du fichier XLSX des comptes. + example: GOOGLE FRANCE - Comptes 2019.xlsx + token_xlsx: + type: string + format: optional + description: Token des comptes XLSX. + example: ASQSMAA2MTg8MTIwMjAwNz2s + publications_bodacc: + type: array + description: Liste des publications au Bodacc de l'entreprise. + items: + $ref: '#/components/schemas/Bodacc' + procedures_collectives: + type: array + description: Liste des procédures collectives de l'entreprise. + items: + type: object + properties: + type: + type: string + description: Type de la procédure collective. + example: Redressement judiciaire + enum: + - Redressement judiciaire + - Liquidation judiciaire ou Procédure de sauvegarde + date_debut: + type: string + description: >- + Date de début de la procédure collective, au format + AAAA-MM-JJ. + example: '2020-04-16T00:00:00.000Z' + date_fin: + type: string + description: >- + Date de fin de la procédure collective, au format + AAAA-MM-JJ. + example: '2020-08-27T00:00:00.000Z' + publications_bodacc: + type: array + description: >- + Liste des publications relatives à la procédure + collective. + items: + $ref: '#/components/schemas/Bodacc' + procedure_collective_existe: + description: >- + Vrai si l'entreprise a des procédures collectives (en cours ou + terminées), faux sinon. + type: boolean + procedure_collective_en_cours: + description: >- + Vrai si l'entreprise a des procédures collectives en cours, faux + sinon. + type: boolean + derniers_statuts: + type: object + description: Liste des statuts de l'entreprise. + properties: + date_depot: + type: string + format: date + description: Date de dépôt des statuts, au format AAAA-MM-JJ. + example: '2020-04-07' + date_depot_formate: + type: string + description: Date de dépôt formaté des statuts, au format JJ/MM/AAAA. + example: 07/04/2020 + disponible: + description: Disponibilité des statuts. + type: boolean + nom_fichier_pdf: + type: string + description: Nom du fichier pdf des statuts. + example: GOOGLE FRANCE - Actes du 07-04-2020.pdf + token: + type: string + description: Token des statuts. + example: >- + QTQ0MzA2MTg0MTIwMjAwNDA3RMOpY2lzaW9uKHMpIGRlIGwnYXNzb2Npw6kgdW5pcXVl + type: + type: string + description: Champ "type" du document contenant les statuts. + example: Statuts mis à jour + decision: + type: string + format: nullable + description: Champ "decision" du document contenant les statuts. + example: null + date_acte: + type: string + format: date + description: Date de publication des statuts, au format AAAA-MM-JJ. + example: '2020-03-04' + date_acte_formate: + type: string + description: Date de publication des statuts, au format JJ/MM/AAAA. + example: 04/03/2020 + extrait_immatriculation: + type: object + description: Extrait d'immatriculation de l'entreprise. + properties: + token: + type: string + description: Token + example: SzQ0MzA2MTg0MQ + rnm: + type: object + format: nullable + description: >- + Informations sur l'immatriculation de l'entreprise au Répertoire + des Métiers. + properties: + date_immatriculation: + type: string + description: >- + Date d'immatriculation au Répertoire des Métiers, au format + AAAA-MM-JJ. + example: '2021-02-16T00:00:00.000Z' + date_radiation: + type: string + format: nullable + description: >- + Date de radiation du Répertoire des Métiers, le cas échéant, + au format AAAA-MM-JJ. + example: null + date_debut_activite: + type: string + description: >- + Date de début d'activé déclarée au Répertoire des Métiers, + au format AAAA-MM-JJ. + example: '2021-01-01T00:00:00.000Z' + date_cessation_activite: + type: string + format: nullable + description: >- + Date de cessation d'activité déclarée au Répertoire des + Métiers, le cas échéant, au format AAAA-MM-JJ. + example: null + chambre_des_metiers: + type: string + description: Chambre des métiers où l'entreprise est immatriculée. + example: TARN-ET-GARONNE + qualification: + type: string + description: Qualification retenue par le Répertoire des Métiers. + example: ARTISAN + derniere_mise_a_jour: + type: string + description: >- + Date de dernière mise à jour de l'entreprise au Répertoire + des Métiers, au format AAAA-MM-JJ. + example: '2021-02-22T00:00:00.000Z' + marques: + type: array + description: >- + Liste des marques françaises déposées par l'entreprise. + Uniquement présent si le paramètre "marques" a été mis à vrai. + items: + type: object + properties: + numero: + type: string + description: Numéro de la marque. + example: FR7103728 + date_enregistrement: + type: string + description: Date d'enregistrement de la marque, au format AAAA-MM-JJ. + example: '2008-12-04T00:00:00.000Z' + date_expiration: + type: string + description: Date d'expiration de la marque au format AAAA-MM-JJ. + example: '2018-12-04T00:00:00.000Z' + lieu_enregistrement: + type: string + description: Lieu d'enregistrement de la marque. + example: 92 INPI - Dépôt électronique + statut: + type: string + description: >- + Statut de la marque. La description des différents types + est disponible en page 14 du document suivant : + https://www.inpi.fr/sites/default/files/doctech_marques_v1.6.pdf. + enum: + - Demande déposée + - Demande publiée + - Demande non publiée + - Demande irrecevable après publication + - Marque enregistrée + - Renouvellement demandé + - Marque renouvelée + - Demande totalement rejetée + - Marque ayant fait l'objet d'une renonciation totale + - Marque ayant fait l'objet d'un retrait total + - Marque annulée + - Marque expirée + example: Marque enregistrée + texte: + type: string + format: nullable + description: Texte de la marque. + example: Google + type: + type: string + description: Type de la marque. + enum: + - Mixte + - Figuratif + - Hologramme + - Son + - Texte + - 3D + - Position + - Mouvement + - Multimedia + - Motifs + - Couleur + - Forme + - Autre + example: Figurative + lien_image: + type: string + format: nullable + description: Lien vers l'image déposée. + example: https://data.inpi.fr/image/marques/FRXXXXXXXX + descriptions: + type: array + description: Liste des descriptions de la marque. + items: + type: string + description: Description + example: 'Demande d’extension : Polynésie française' + classes: + type: array + description: >- + Liste des classes (produits et services) de la marque. La + liste des classes est disponible sur le document suivant : + https://www.inpi.fr/sites/default/files/classification_nice_2021_0.pdf. + items: + type: object + properties: + code: + type: string + description: Code de la classe. + example: 35 + description: + type: string + description: Description de la classe. + example: >- + Publicité ; gestion des affaires commerciales ; + administration commerciale ; travaux de bureau. + deposant: + $ref: '#/components/schemas/PersonneMarque' + mandataire: + $ref: '#/components/schemas/PersonneMarque' + evenements: + type: array + description: Liste des événements associés à la marque. + items: + type: object + properties: + type: + type: string + description: Type d'événement. + example: Publication + identifiant_evenement: + type: string + format: nullable + description: Identifiant de l'événement. + reference: + type: string + format: nullable + description: Référence de l'événement. + date: + type: string + description: Date de l'événement, au format AAAA-MM-JJ. + example: '2008-12-04T00:00:00.000Z' + numero_bopi: + type: string + description: Numéro du BOPI dans lequel l'événement a été publié. + example: 2008-12 + date_bopi: + type: string + description: Date de publication du BOPI au format AAAA-MM-JJ. + example: '2008-12-04T00:00:00.000Z' + beneficiaire: + type: string + format: nullable + description: Bénéficiaire associé à l'événement. + association: + $ref: '#/components/schemas/Association' + labels: + type: array + description: >- + Liste des labels de l'entreprise. Uniquement présent si demandé + dans les champs supplémentaires. + items: + $ref: '#/components/schemas/Labels' + scoring_non_financier: + $ref: '#/components/schemas/ScoringNonFinancier' + scoring_financier: + $ref: '#/components/schemas/ScoringFinancier' + EntrepriseRecherche: + allOf: + - $ref: '#/components/schemas/EntrepriseBase' + - type: object + properties: + siege: + $ref: '#/components/schemas/EtablissementRecherche' + villes: + type: array + description: Liste des villes où l'entreprise a au moins un établissement. + items: + type: string + example: MONTPELLIER + chiffre_affaires: + type: integer + format: nullable + description: Chiffre d'affaires de l'entreprise. + example: 411016329 + resultat: + type: integer + format: nullable + description: Résultat de l'entreprise. + example: 29327087 + effectifs_finances: + type: integer + format: nullable + description: Effectif de l'entreprise. + example: 723 + annee_finances: + type: string + format: nullable + description: >- + Année de correspondance des variables financières + (chiffre_affaires, resultat, effectifs_finances). + example: '2018' + EtablissementFiche: + type: object + properties: + siret: + type: string + description: Numéro siret de l'établissement au format xxxxxxxxxxxxxx. + example: '44306184100047' + siret_formate: + type: string + description: Numéro siret de l'établissement au format xxx xxx xxx xxxxx. + example: 443 061 841 00047 + diffusion_partielle: + type: boolean + description: >- + Si vrai, l'établissement est en diffusion partielle. Dans ce cas, + tous les champs relatifs à son adresse - en dehors de la ville et du + pays - sont à `null`. + nic: + type: string + description: Numéro NIC de l'établissement. + example: '00047' + code_postal: + type: string + format: nullable + description: Code postal de l'établissement. + example: '75009' + ville: + type: string + format: nullable + description: Ville de l'établissement. + example: PARIS 9 + pays: + type: string + format: nullable + description: Pays de l'établissement + example: France + code_pays: + type: string + format: nullable + description: Code du pays de l'établissement + example: FR + latitude: + type: number + format: nullable + description: Latitude de l'établissement. + example: 48.876947 + longitude: + type: number + format: nullable + description: Longitude de l'établissement. + example: 2.329981 + etablissement_cesse: + type: boolean + format: nullable + description: Vrai si l'établissement est cessé, faux si il est en activité. + siege: + type: boolean + format: nullable + description: Vrai si l'établissement est siège, faux s'il ne l'est pas. + etablissement_employeur: + type: boolean + format: nullable + description: Si vrai, l'établissement a au moins un employé. + effectif: + type: string + format: nullable + description: Tranche d'effectif de l'établissement. + example: Entre 500 et 999 salariés + effectif_min: + type: integer + format: nullable + description: Effectif minimal de l'établissement. + example: 500 + effectif_max: + type: integer + format: nullable + description: Effectif maximal de l'établissement. + example: 999 + tranche_effectif: + type: string + format: nullable + description: >- + Tranche d'effectif de l'établissement, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen#:~:text=Cette%20variable%20correspond%20%C3%A0%20la,effectif%20salari%C3%A9%20de%20l'entreprise.). + example: '41' + annee_effectif: + type: integer + format: nullable + description: Année correspondante à la tranche d'effectif de l'établissement. + example: 2017 + code_naf: + type: string + format: nullable + description: Code NAF de l'établissement. + example: 70.10Z + libelle_code_naf: + type: string + format: nullable + description: Libellé du code NAF de l'établissement. + example: Activités des sièges sociaux + date_de_creation: + type: string + format: nullable + example: '2011-05-12T22:00:00.000Z' + numero_voie: + type: integer + format: nullable + description: Numéro de voie de l'établissement. + example: 8 + indice_repetition: + type: string + format: nullable + description: Indice de répétition de l'établissement. + example: null + type_voie: + type: string + format: nullable + description: Type de voie de l'établissement. + example: RUE + libelle_voie: + type: string + format: nullable + description: Libellé de la voie de l'établissement. + example: DE LONDRES + complement_adresse: + type: string + format: nullable + description: Complément d'adresse de l'établissement. + example: null + adresse_ligne_1: + type: string + format: nullable + description: >- + Première ligne de l'adresse de l'établissement. Correspond à + l'ensemble des données numero_voie, indice_repetition, type_voie et + libelle_voie. + example: 8 RUE DE LONDRES + adresse_ligne_2: + type: string + format: nullable + description: >- + Seconde ligne de l'adresse de l'établissement. Est égal à + complement_adresse + example: null + date_cessation: + type: string + format: nullable + description: Date de fermeture de l'établissement + example: '2014-05-12' + enseigne: + type: string + format: nullable + description: Enseigne de l'établissement + example: FROOGLE + nom_commercial: + type: string + format: nullable + description: Nom commercial de l'établissement + example: Froogle + domiciliation: + type: object + format: nullable + properties: + nom: + type: string + format: nullable + description: Nom de l'entreprise de domiciliation + example: WORK & SHARE + siren: + type: string + format: nullable + description: Siren de l'entreprise de domiciliation + example: '828053546' + predecesseurs: + type: array + format: optional + description: Liste des prédécesseurs de l'établissement. + items: + $ref: '#/components/schemas/LienSuccession' + successeurs: + type: array + format: optional + description: Liste des successeurs de l'établissement. + items: + $ref: '#/components/schemas/LienSuccession' + EtablissementRecherche: + type: object + properties: + siret: + type: string + description: Numéro siret de l'établissement au format xxxxxxxxxxxxxx. + example: '44306184100047' + siret_formate: + type: string + description: Numéro siret de l'établissement au format xxx xxx xxx xxxxx. + example: 443 061 841 00047 + nic: + type: string + description: Numéro NIC de l'établissement. + example: '00047' + numero_voie: + type: integer + format: nullable + description: Numéro de voie de l'établissement. + example: 8 + indice_repetition: + type: string + format: nullable + description: Indice de répétition de l'établissement. + example: null + type_voie: + type: string + format: nullable + description: Type de voie de l'établissement. + example: RUE + libelle_voie: + type: string + format: nullable + description: Libellé de la voie de l'établissement. + example: DE LONDRES + complement_adresse: + type: string + format: nullable + description: Complément d'adresse de l'établissement. + example: null + adresse_ligne_1: + type: string + format: nullable + description: >- + Première ligne de l'adresse de l'établissement. Correspond à + l'ensemble des données numero_voie, indice_repetition, type_voie et + libelle_voie. + example: 8 RUE DE LONDRES + adresse_ligne_2: + type: string + format: nullable + description: >- + Seconde ligne de l'adresse de l'établissement. Est égal à + complement_adresse + example: null + code_postal: + type: string + format: nullable + description: Code postal de l'établissement. + example: '75009' + ville: + type: string + format: nullable + description: Ville de l'établissement. + example: PARIS 9 + latitude: + type: number + format: nullable + description: Latitude de l'établissement. + example: 48.876947 + longitude: + type: number + format: nullable + description: Longitude de l'établissement. + example: 2.329981 + RepresentantSuggestions: + type: object + properties: + qualite: + type: string + description: Qualité du représentant. + example: Gérant + personne_morale: + description: >- + Vrai si le représentant est une personne morale, faux si personne + physique. + type: boolean + example: false + date_prise_de_poste: + type: string + description: Date de prise de poste du représentant. + example: '2017-08-03' + denomination: + type: string + description: Dénomination du représentant si personne morale. + format: optional + example: GOOGLE FRANCE + siren: + type: string + description: Siren du représentant si personne morale. + format: optional + example: '443061841' + forme_juridique: + type: string + format: optional + description: Forme juridique du représentant si personne morale. + example: Société par actions simplifiée + sexe: + type: string + description: >- + Sexe supposé du représentant si personne physique. F pour féminin, M + pour masculin. Ce champ est estimé à partir du prénom du + représentant. + format: optional + example: M + nom: + type: string + description: Nom du représentant. + format: optional + example: Yi + prenom: + type: string + description: Prénoms du représentant. + format: optional + example: Kenneth H. + prenom_usuel: + type: string + description: Prénom usuel du représentant. + format: optional + example: Kenneth + nom_complet: + type: string + description: Nom complet du représentant. + example: Kenneth H. Yi + date_de_naissance: + type: string + description: Date de naissance du représentant. + format: optional nullable + example: '1970-01-06' + date_de_naissance_formate: + type: string + description: Date de naissance formatée du représentant. + format: optional nullable + example: 06/01/1970 + age: + type: integer + description: Age du représentant. + format: optional + example: 50 + nationalite: + type: string + description: Nationalité du représentant. + format: optional + example: Américaine (Etats Unis) + code_nationalite: + type: string + description: Code nationalité du représentant + format: optional + example: US + ville_de_naissance: + type: string + description: Ville de naissance du représentant. + format: optional + example: Séoul + pays_de_naissance: + type: string + description: Pays de naissance du représentant. + format: optional + example: COREE DU SUD + code_pays_de_naissance: + type: string + description: Code du pays de naissance du représentant. + format: optional + example: KR + adresse_ligne_1: + type: string + description: Première ligne de l'adresse du représentant. + format: nullable + example: 1600 Amphitheatre Parkway Mountain View CA 94043 + adresse_ligne_2: + type: string + description: Deuxième ligne de l'adresse du représentant. + format: nullable + example: null + adresse_ligne_3: + type: string + description: Troisième ligne de l'adresse du représentant. + format: nullable + example: null + code_postal: + type: string + description: Code postal du représentant. + format: nullable + example: null + ville: + type: string + description: Ville du représentant. + format: nullable + example: null + pays: + type: string + format: nullable + description: Pays du représentant. + example: Etats-Unis + code_pays: + type: string + format: nullable + description: Code du pays du représentant + example: US + Representant: + type: object + properties: + qualite: + type: string + description: Qualité du représentant. + example: Gérant + personne_morale: + description: >- + Vrai si le représentant est une personne morale, faux si personne + physique. + type: boolean + example: false + date_prise_de_poste: + type: string + description: Date de prise de poste du représentant. + example: '2017-08-03' + denomination: + type: string + description: Dénomination du représentant si personne morale. + format: optional + example: GOOGLE FRANCE + siren: + type: string + description: Siren du représentant si personne morale. + format: optional + example: '443061841' + forme_juridique: + type: string + format: optional + description: Forme juridique du représentant si personne morale. + example: Société par actions simplifiée + sexe: + type: string + description: >- + Sexe supposé du représentant si personne physique. F pour féminin, M + pour masculin. Ce champ est estimé à partir du prénom du + représentant. + format: optional + example: M + nom: + type: string + description: Nom du représentant. + format: optional + example: Yi + prenom: + type: string + description: Prénoms du représentant. + format: optional + example: Kenneth H. + prenom_usuel: + type: string + description: Prénom usuel du représentant. + format: optional + example: Kenneth + nom_complet: + type: string + description: Nom complet du représentant. + example: Kenneth H. Yi + date_de_naissance: + type: string + description: Date de naissance du représentant. + format: optional nullable + example: '1970-01-06' + date_de_naissance_formate: + type: string + description: Date de naissance formatée du représentant. + format: optional nullable + example: 06/01/1970 + age: + type: integer + description: Age du représentant. + format: optional + example: 50 + nationalite: + type: string + description: Nationalité du représentant. + format: optional + example: Américaine (Etats Unis) + code_nationalite: + type: string + description: Code nationalité du représentant + format: optional + example: US + ville_de_naissance: + type: string + description: Ville de naissance du représentant. + format: optional + example: Séoul + pays_de_naissance: + type: string + description: Pays de naissance du représentant. + format: optional + example: COREE DU SUD + code_pays_de_naissance: + type: string + description: Code du pays de naissance du représentant. + format: optional + example: KR + adresse_ligne_1: + type: string + description: Première ligne de l'adresse du représentant. + format: nullable + example: 1600 Amphitheatre Parkway Mountain View CA 94043 + adresse_ligne_2: + type: string + description: Deuxième ligne de l'adresse du représentant. + format: nullable + example: null + adresse_ligne_3: + type: string + description: Troisième ligne de l'adresse du représentant. + format: nullable + example: null + code_postal: + type: string + description: Code postal du représentant. + format: nullable + example: null + ville: + type: string + description: Ville du représentant. + format: nullable + example: null + pays: + type: string + format: nullable + description: Pays du représentant. + example: Etats-Unis + code_pays: + type: string + format: nullable + description: Code du pays du représentant + example: US + personne_politiquement_exposee: + $ref: '#/components/schemas/PersonnePolitiquementExposee' + sanctions_en_cours: + type: boolean + format: optional + description: >- + Vaut vrai si le représentant est actuellement sous sanction. + Uniquement présent si demandé dans les champs supplémentaires. + sanctions: + type: array + description: >- + Liste des sanctions du représentant. Uniquement présent si demandé + dans les champs supplémentaires. + items: + $ref: '#/components/schemas/Sanction' + PersonnePolitiquementExposee: + type: object + format: optional + description: >- + Informations sur le statut de personne politiquement exposée. Uniquement + présent si demandé dans les champs supplémentaires. + properties: + en_cours: + type: boolean + format: nullable + description: Vaut vrai si la personne est actuellement politiquement exposée. + fonctions: + type: array + description: >- + Liste des fonctions actuelles et passées de la personne + politiquement exposée. + items: + type: object + properties: + fonction: + type: string + description: Nom de la fonction. + example: Premier ministre + pays: + type: string + format: nullable + description: Pays associé à la fonction. + example: France + code_pays: + type: string + format: nullable + description: Code pays associé à la fonction. + example: FR + en_cours: + type: boolean + format: nullable + description: Vaut vrai si la fonction est en cours. + example: true + date_debut: + type: string + format: nullable + description: Date de début de la fonction. + example: '2020-08-20' + date_fin: + type: string + format: nullable + description: Date de fin de la fonction. + example: '2022-08-20' + sources: + type: array + description: Liste des sources. + items: + type: object + properties: + nom: + type: string + description: Nom de la source. + example: CIA World Factbook heads of state and government + url: + type: string + format: nullable + description: Lien vers la source. + example: >- + https://www.opensanctions.org/datasets/us_cia_world_factbook + Sanction: + type: object + format: optional + properties: + description: + type: string + description: Description de la sanction. + example: Interdiction de gérer + autorite: + type: string + format: nullable + description: Autorité ayant prononcé la sanction. + example: Tribunal de commerce de Paris + pays: + type: string + format: nullable + description: Pays de la sanction. + example: France + code_pays: + type: string + format: nullable + description: Code du pays de la sanction. + example: FR + en_cours: + type: boolean + format: nullable + description: Vaut vrai si la sanction est en cours. + example: false + date_debut: + type: string + format: nullable + description: Date de début de la sanction. + example: '2020-08-20' + date_fin: + type: string + format: nullable + description: Date de fin de la sanction. + example: '2022-08-20' + sources: + type: array + description: Liste des sources. + items: + type: object + properties: + nom: + type: string + description: Nom de la source. + example: CIA World Factbook heads of state and government + url: + type: string + format: nullable + description: Lien vers la source. + example: https://www.opensanctions.org/datasets/us_cia_world_factbook + RepresentantRecherche: + allOf: + - $ref: '#/components/schemas/Representant' + - type: object + properties: + actuel: + type: boolean + description: Vaut vrai si le représentant est toujours à son poste. + date_depart_de_poste: + type: string + description: >- + Date de départ de poste dans le cas où le représentant n'est + plus un représentant actuel, au format AAAA-MM-JJ. + example: null + forme_juridique: + type: string + format: nullable + description: >- + Forme juridique du représentant dans le cas d'une personne + morale. + example: null + Beneficiaire: + type: object + properties: + nom: + type: string + format: nullable + description: Nom du bénéficiaire effectif. + example: Yi + nom_usage: + type: string + format: nullable + description: Nom d'usage du bénéficiaire effectif. + example: null + prenom: + type: string + description: Prénom du bénéficiaire effectif. + example: Kenneth H. + pseudonyme: + type: string + format: nullable + description: Pseudonyme du bénéficiaire effectif. + example: null + nom_complet: + type: string + description: Nom complet du bénéficiaire effectif. + example: Kenneth H. Yi + date_de_naissance_formate: + type: string + description: >- + Mois et année de naissance du bénéficiaire effectif, au format + MM/AAAA. + example: 01/1970 + nationalite: + type: string + description: Nationalité du bénéficiaire effectif. + example: Française + pourcentage_parts: + type: number + description: >- + Parts détenues par le bénéficiaire effectif, en pourcentage des + parts totales. + pourcentage_votes: + type: number + description: >- + Droits de vote détenus par le bénéficiaire effectif, en pourcentage + des droits de vote totaux. + pourcentage_votes_indirect: + type: number + description: >- + Droits de vote détenus de façon indirecte par le bénéficiaire + effectif, en pourcentage des droits de vote totaux. + pourcentage_votes_directs: + type: number + description: >- + Droits de vote détenus de façon directe par le bénéficiaire + effectif, en pourcentage des droits de vote totaux. + detention_autres_moyens_controle: + type: boolean + description: Vaut vrai s'il existe d'autres moyens de contrôle. + beneficiaire_representant_legal: + type: boolean + description: >- + Vaut vrai dans le cas où le bénéficiaire effectif a été défini comme + le représentant légal par défaut. + adresse_ligne_1: + type: string + format: nullable + description: Première ligne de l'adresse du bénéficiaire effectif. + example: null + adresse_ligne_2: + type: string + format: nullable + description: Deuxième ligne de l'adresse du bénéficiaire effectif. + example: null + adresse_ligne_3: + type: string + format: nullable + description: Troisième ligne de l'adresse du bénéficiaire effectif. + example: null + pourcentage_parts_vocation_titulaire: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à devenir titulaire + par l'effet d'un acte juridique, en pourcentage des parts totales. + representant_legal_placement_sans_gestion_delegation: + type: boolean + format: nullable + description: >- + Vaut vrai dans le cas où le bénéficiaire effectif est le + représentant légal du placement collectif (cas où le placement + collectif n'a pas délégué sa gestion à une société de gestion). + code_postal: + type: string + format: nullable + description: Code postal du bénéficiaire effectif. + example: null + detention_pouvoir_nom_membre_conseil_administration: + type: boolean + description: >- + Vaut vrai si le moyen de contrôle est le pouvoir de nommer ou de + révoquer la majorité des membres des organes d'administration, de + gestion, de direction ou de surveillance de la personne morale. + ville: + type: string + format: nullable + description: Ville du bénéficiaire effectif. + example: null + date_de_naissance_complete_formatee: + type: string + format: date + description: >- + Date de naissance complète du bénéficiaire effectif, au format + JJ/MM/AAAA. + example: 14/08/1953 + pourcentage_parts_directes: + type: number + description: >- + Parts détenues de façon directe par le bénéficiaire effectif, en + pourcentage des parts totales. + pourcentage_parts_indirectes: + type: number + description: >- + Parts détenues de façon indirecte par le bénéficiaire effectif, en + pourcentage des parts totales. + pays_de_naissance: + type: string + format: nullable + description: Pays de naissance du bénéficiaire effectif. + example: null + code_pays_de_naissance: + type: string + format: nullable + description: Code du pays de naissance du bénéficiaire effectif. + example: null + ville_de_naissance: + type: string + format: nullable + description: Ville de naissance du bénéficiaire effectif. + example: null + detention_pouvoir_decision_ag: + type: boolean + description: >- + Vaut vrai pour les moyens de contrôle sur les organes + d'administration, de gestion, de direction ou de surveillance de la + personne morale autre que le pouvoir de nommer ou de révoquer la + majorité des membres. + pays: + type: string + format: nullable + description: Pays du bénéficiaire effectif. + example: null + date_de_naissance_formatee: + type: string + format: nullable + description: >- + Mois et année de naissance du bénéficiaire effectif, au format + MM/AAAA. + example: null + code_pays: + type: string + format: nullable + description: Code pays du bénéficiaire effectif. + example: null + Document: + type: object + properties: + type: + type: string + enum: + - acte + - comptes + description: Type de document + example: acte + date_depot: + description: Date de dépôt du document + type: string + format: date + example: '2020-08-04T00:00:00.000Z' + mentions: + type: array + description: Mentions de la recherche dans le document. + items: + type: string + discriminator: + propertyName: type + mapping: + acte: '#/components/schemas/DocumentActe' + comptes: '#/components/schemas/DocumentComptes' + DocumentActe: + allOf: + - $ref: '#/components/schemas/Document' + - type: object + properties: + titres: + type: array + description: Titres des actes associés au document + items: + type: object + properties: + type: + type: string + description: Type de l'acte + example: Décision(s) de l'associé unique + decision: + type: string + format: nullable + description: Décision de l'acte + example: Augmentation du capital social + DocumentComptes: + allOf: + - $ref: '#/components/schemas/Document' + - type: object + properties: + date_cloture: + type: string + format: date + description: Date de clôture des comptes, au format AAAA-MM-JJ. + example: '2019-12-31' + Publication: + type: object + properties: + type: + type: string + enum: + - Création + - Immatriculation + - Modification + - Vente + - Radiation + - Procédure collective + - Dépôt des comptes + description: Type de publication + example: acte + date: + description: Date de publication, au format AAAA-MM-JJ. + type: string + format: date + example: '2020-08-04T00:00:00.000Z' + contenu: + type: string + description: >- + Contenu de la publication, avec les mentions correspondant à la + recherche encerclée par une balise HTML . + Bodacc: + type: object + properties: + numero_parution: + type: string + description: Numéro de parution de la publication. + example: '20200075' + date: + type: string + description: Date de la publication, au format AAAA-MM-JJ. + example: '2020-04-16T00:00:00.000Z' + numero_annonce: + type: string + description: Numéro d'annonce de la publication. + example: '670' + bodacc: + type: string + description: Bodacc de la publication (A, B ou C). + example: B + type: + type: string + description: >- + Type de la publication parmi la liste suivante : Création, + Immatriculation, Modification, Vente, Achat, Radiation, Procédure + collective, Dépôt des comptes. + example: Modification + greffe: + type: string + description: Greffe de publication. + example: Paris + discriminator: + propertyName: type + mapping: + Création: '#/components/schemas/BodaccCreation' + Immatriculation: '#/components/schemas/BodaccImmatriculation' + Modification: '#/components/schemas/BodaccModification' + Vente: '#/components/schemas/BodaccVente' + Achat: '#/components/schemas/BodaccAchat' + Radiation: '#/components/schemas/BodaccRadiation' + Procédure collective: '#/components/schemas/BodaccProcedureCollective' + Dépôt des comptes: '#/components/schemas/BodaccDepotDesComptes' + BodaccCreation: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + type: string + format: nullable + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + example: GOOGLE FRANCE + personne_morale: + type: boolean + format: nullable + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + example: GOOGLE FRANCE + denomination: + type: string + format: nullable + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + example: GOOGLE FRANCE + nom: + type: string + format: nullable + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + prenom: + type: string + format: nullable + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + administration: + type: string + format: nullable + description: Administration (dans le cas d'une personne morale). + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + type: string + format: nullable + description: Adresse de l'entreprise concernée par la publication. + example: 8 rue de Londres 75009 Paris + capital: + type: number + format: nullable + description: Capital de l'entreprise concernée par la publication. + example: '464884017' + activite: + type: string + format: nullable + description: Activité de l'entreprise concernée par la publication. + example: >- + Fourniture de services et/ou conseils relatifs aux logiciels, au + réseau internet. + date_debut_activite: + type: string + format: nullable + description: >- + Date de début d'activité de l'entreprise concernée par la + publication, au format AAAA-MM-JJ. + example: '2020-08-02T00:00:00.000Z' + BodaccImmatriculation: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + type: string + format: nullable + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + example: GOOGLE FRANCE + personne_morale: + type: boolean + format: nullable + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + example: GOOGLE FRANCE + denomination: + type: string + format: nullable + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + example: GOOGLE FRANCE + nom: + type: string + format: nullable + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + prenom: + type: string + format: nullable + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + administration: + type: string + format: nullable + description: Administration (dans le cas d'une personne morale). + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + type: string + format: nullable + description: Adresse de l'entreprise concernée par la publication. + example: 8 rue de Londres 75009 Paris + BodaccModification: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + type: string + format: nullable + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + example: GOOGLE FRANCE + personne_morale: + type: boolean + format: nullable + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + example: GOOGLE FRANCE + denomination: + type: string + format: nullable + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + example: GOOGLE FRANCE + nom: + type: string + format: nullable + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + prenom: + type: string + format: nullable + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + administration: + type: string + format: nullable + description: Administration (dans le cas d'une personne morale). + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + type: string + format: nullable + description: Adresse de l'entreprise concernée par la publication. + example: 8 rue de Londres 75009 Paris + capital: + type: number + format: nullable + description: Capital de l'entreprise concernée par la publication. + example: '464884017' + activite: + type: string + format: nullable + description: Activité de l'entreprise concernée par la publication. + example: >- + Fourniture de services et/ou conseils relatifs aux logiciels, au + réseau internet. + description: + type: string + format: nullable + description: Description de la modification. + example: modification survenue sur le capital (augmentation) + BodaccAchat: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + type: string + format: nullable + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + example: GOOGLE FRANCE + personne_morale: + type: boolean + format: nullable + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + example: GOOGLE FRANCE + denomination: + type: string + format: nullable + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + example: GOOGLE FRANCE + nom: + type: string + format: nullable + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + prenom: + type: string + format: nullable + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + administration: + type: string + format: nullable + description: Administration (dans le cas d'une personne morale). + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + type: string + format: nullable + description: Adresse de l'entreprise concernée par la publication. + example: 8 rue de Londres 75009 Paris + commentaires: + type: string + format: nullable + description: Commentaires sur la publication. + oppositions: + type: string + format: nullable + description: Détails sur les oppositions. + declaration_creance: + type: string + format: nullable + description: Détails sur la déclaration de créance. + publication_legale: + type: string + format: nullable + description: Journal où a été publiée la publication légale. + denomination_ancien_proprietaire: + type: string + format: optional + description: Dénomination de l'ancien propriétaire de l'établisement. + siren_ancien_proprietaire: + type: string + format: optional + description: Siren de l'ancien propriétaire de l'établisement. + denomination_ancien_exploitant: + type: string + format: optional + description: Dénomination de l'ancien exploitant de l'établisement. + siren_ancien_exploitant: + type: string + format: optional + description: Siren de l'ancien exploitant de l'établisement. + BodaccVente: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + type: string + format: nullable + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + example: GOOGLE FRANCE + personne_morale: + type: boolean + format: nullable + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + example: GOOGLE FRANCE + denomination: + type: string + format: nullable + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + example: GOOGLE FRANCE + nom: + type: string + format: nullable + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + prenom: + type: string + format: nullable + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + administration: + type: string + format: nullable + description: Administration (dans le cas d'une personne morale). + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + type: string + format: nullable + description: Adresse de l'entreprise concernée par la publication. + example: 8 rue de Londres 75009 Paris + commentaires: + type: string + format: nullable + description: Commentaires sur la publication. + oppositions: + type: string + format: nullable + description: Détails sur les oppositions. + declaration_creance: + type: string + format: nullable + description: Détails sur la déclaration de créance. + publication_legale: + type: string + format: nullable + description: Journal où a été publiée la publication légale. + denomination_nouveau_proprietaire: + type: string + format: nullable + description: Dénomination du nouveau propriétaire de l'établisement. + siren_nouveau_proprietaire: + type: string + format: nullable + description: Siren du nouveau propriétaire de l'établisement. + denomination_nouvel_exploitant: + type: string + format: nullable + description: Dénomination du nouvel exploitant de l'établisement. + siren_nouvel_exploitant: + type: string + format: nullable + description: Siren du nouvel exploitant de l'établisement. + BodaccRadiation: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + BodaccProcedureCollective: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + famille: + type: string + description: Famille de la procédure collective + example: Jugement de clôture + nature: + type: string + description: Nature de la procédure collective + example: Jugement de clôture pour insuffisance d'actif + complement_jugement: + type: string + description: Complément sur le jugement de procédure collective + example: >- + Jugement prononçant la clôture de la procédure de liquidation + judiciaire pour insuffisance d'actif. + BodaccDepotDesComptes: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + date_cloture: + type: string + description: Date de clôture des comptes, au format AAAA-MM-JJ. + example: '2020-08-02T00:00:00.000Z' + type_depot: + type: string + description: Type de dépôt de comptes. + example: Comptes annuels et rapports + descriptif: + type: string + format: nullable + description: Descriptif du dépôt de comptes. + PersonneMarque: + type: object + properties: + siren: + type: string + description: Siren de l'entité, dans le cas d'une personne morale. + entite_legale: + type: string + description: Entité légale. + nom: + type: string + description: Nom de l'entité. + batiment: + type: string + description: Bâtiment de l'entité. + rue: + type: string + description: Rue de l'entité. + ville: + type: string + description: Ville de l'entité. + boite_postale: + type: string + description: Boîte postale de l'entité. + code_postal: + type: string + description: Code postal de l'entité. + code_pays: + type: string + description: Code pays de l'entité. + Ratios: + type: object + properties: + chiffre_affaires: + type: number + format: nullable + description: Chiffre d'affaires de l'entreprise. + example: 411016329 + resultat: + type: number + format: nullable + description: Résultat de l'entreprise. + example: 29327087 + effectif: + type: integer + format: nullable + description: Effectif de l'entreprise. + example: 723 + marge_brute: + type: number + format: nullable + description: Marge brute de l'entreprise. + excedent_brut_exploitation: + type: number + format: nullable + description: Excédent brut d'exploitation (EBITDA) de l'entreprise. + resultat_exploitation: + type: number + format: nullable + description: Résultat d'exploitation (EBIT) de l'entreprise. + taux_croissance_chiffre_affaires: + type: number + format: nullable + description: Taux de croissance du chiffre d'affaires (en %) de l'entreprise. + taux_marge_brute: + type: number + format: nullable + description: Taux de marge brute (en %) de l'entreprise. + taux_marge_EBITDA: + type: number + format: nullable + description: Taux de marge d'EBITDA (en %) de l'entreprise. + taux_marge_operationnelle: + type: number + format: nullable + description: Taux de marge opérationnelle (EBIT) (en %) de l'entreprise. + BFR: + type: number + format: nullable + description: BFR (Besoin en fonds de roulement) de l'entreprise. + BFR_exploitation: + type: number + format: nullable + description: BFR exploitation de l'entreprise. + BFR_hors_exploitation: + type: number + format: nullable + description: BFR hors exploitation de l'entreprise. + BFR_jours_CA: + type: number + format: nullable + description: BFR (en jours de CA) de l'entreprise. + BFR_exploitation_jours_CA: + type: number + format: nullable + description: BFR exploitation (en jours de CA) de l'entreprise. + BFR_hors_exploitation_jours_CA: + type: number + format: nullable + description: BFR hors exploitation (en jours de CA) de l'entreprise. + delai_paiement_clients_jours: + type: number + format: nullable + description: Délai de paiement clients (en jours) de l'entreprise. + delai_paiement_fournisseurs_jours: + type: number + format: nullable + description: Délai de paiement fournisseurs (en jours) de l'entreprise. + ratio_stock_CA_jours: + type: number + format: nullable + description: Ratio des stocks / CA (en jours) de l'entreprise. + capacite_autofinancement: + type: number + format: nullable + description: Capacité d'autofinancement de l'entreprise. + capacite_autofinancement_CA: + type: number + format: nullable + description: Capacité d'autofinancement / CA (en %) de l'entreprise. + fonds_roulement_net_global: + type: number + format: nullable + description: Fonds de roulement net global de l'entreprise. + couverture_BFR: + type: number + format: nullable + description: Couverture du BFR de l'entreprise. + tresorerie: + type: number + format: nullable + description: Trésorerie de l'entreprise. + dettes_financieres: + type: number + format: nullable + description: Dettes financières de l'entreprise. + capacite_remboursement: + type: number + format: nullable + description: Capacité de remboursement de l'entreprise. + ratio_endettement: + type: number + format: nullable + description: Ratio d'endettement (Gearing) de l'entreprise. + autonomie_financiere: + type: number + format: nullable + description: Autonomie financière (en %) de l'entreprise. + taux_levier: + type: number + format: nullable + description: Taux de levier (DFN/EBITDA) de l'entreprise. + etat_dettes_1_an_au_plus: + type: number + format: nullable + description: Etat des dettes à 1 an au plus de l'entreprise. + liquidite_generale: + type: number + format: nullable + description: Liquidité générale de l'entreprise. + couverture_dettes: + type: number + format: nullable + description: Couverture des dettes de l'entreprise. + marge_nette: + type: number + format: nullable + description: Marge nette (en %) de l'entreprise. + rentabilite_fonds_propres: + type: number + format: nullable + description: Rentabilité sur fonds propres (en %) de l'entreprise. + rentabilite_economique: + type: number + format: nullable + description: Rentabilité économique (en %) de l'entreprise. + valeur_ajoutee: + type: number + format: nullable + description: Valeur ajoutée de l'entreprise. + valeur_ajoutee_CA: + type: number + format: nullable + description: Valeur ajoutée / CA (en %) de l'entreprise. + salaires_charges_sociales: + type: number + format: nullable + description: Salaires et charges sociales de l'entreprise. + salaires_CA: + type: number + format: nullable + description: Salaires / CA (en %) de l'entreprise. + impots_taxes: + type: number + format: nullable + description: Impôts et taxes de l'entreprise. + Association: + type: object + format: nullable + description: Association liée à l'entreprise. + properties: + is_waldec: + type: boolean + example: 1 + description: Détermine si l'association possède un numéro WALDEC/RNA. + id_association: + type: string + example: W142005389 + description: >- + L'identifiant l'association au format Wxxxxxxxxx si WALDEC, + xxxxxxxxxxxxxx sinon. + id_ex_association: + type: string + format: nullable + example: 142004593 + description: Ancien numéro de l'association. + denomination: + type: string + format: nullable + example: COMITÉ RÉGIONAL DE BRIDGE DE BASSE NORMANDIE + description: Dénomination de l'association. + siret: + type: string + format: nullable + description: Numéro siret de l'association au format xxxxxxxxxxxxxx. + example: '95037097300014' + numero_rup: + type: string + format: nullable + description: Numéro de Reconnaissance d'Utilité Publique. + example: null + objet: + type: string + format: nullable + description: Objet de l'association. + example: >- + Grouper tous les clubs et joueurs de bridge de Basse-Normandie de + soutenir leurs efforts et de développer sous toutes ses formes la + pratique du jeu de bridge + objet_social_1: + type: string + format: nullable + description: Objet social 1 de l'association. + example: 7005 + categorie_social_1: + type: string + format: nullable + description: Libellé correspondant à l'objet social 1. + example: Bridge, jeux de cartes, échecs, dames, jeux de société... + objet_social_2: + type: string + format: nullable + description: Objet social 2 de l'association. + example: 0 + categorie_social_2: + type: string + format: nullable + description: Libellé correspondant à l'objet social 1. + example: Non connue + date_creation: + type: string + format: nullable + description: Date de déclaration de création au format AAAA-MM-JJ. + example: '1978-09-28' + date_derniere_declaration: + type: string + format: nullable + description: Date de dernière déclaration au format AAAA-MM-JJ. + example: '2019-09-18' + date_publication_creation: + type: string + format: nullable + description: >- + Date de publication du Journal Officiel de l'avis de création au + format AAAA-MM-JJ. + example: '1978-10-12' + date_declaration_dissolution: + type: string + format: nullable + description: Date de déclaration de dissolution au format AAAA-MM-JJ. + example: '2019-09-18' + groupement: + type: string + format: nullable + description: Groupement de l'association. + example: Simple + position_activite: + type: string + format: nullable + description: Position d'activité de l'association. + example: Active + nature: + type: string + format: nullable + description: Nature de l'association. + example: Simplement Declarée + site_web: + type: string + format: nullable + description: Site web de l'association. + example: null + telephone: + type: string + format: nullable + description: Numéro de téléphone de l'association. + example: null + email: + type: string + format: nullable + description: Email de l'association. + example: null + adresse_siege: + type: object + properties: + code_postal: + type: string + format: nullable + description: Code postal du siège social. + example: '14075' + code_insee: + type: string + format: nullable + description: Code insee du siège social. + example: '14118' + ville: + type: string + format: nullable + description: Ville du siège social. + example: Caen cedex 05 + numero_voie: + type: string + format: nullable + description: Numéro de voie du siège social. + example: 115ter + indice_repetition: + type: string + format: nullable + description: Indice de répétition du siège social. + example: null + type_voie: + type: string + format: nullable + description: Type de voie du siège social. + example: BD + libelle_voie: + type: string + format: nullable + description: Libellé de la voie du siège social. + example: Vanier - La Pierre Heuzé + complement_adresse: + type: string + format: nullable + description: Complément de l'adresse du siège social. + example: null + distribution: + type: string + format: nullable + description: Complément de distribution du siege social. + example: _BP 75156 + adresse_ligne_1: + type: string + format: nullable + description: Adresse complète du siège social. + example: 115ter BD Vanier - La Pierre Heuzé + adresse_ligne_2: + type: string + format: nullable + description: Renseignement supplémentaire à l'adresse du siège social. + example: null + adresse_gestionnaire: + type: object + properties: + gestionnaire: + type: string + format: nullable + description: Nom du gestionnaire de l'association. + example: null + code_postal: + type: string + format: nullable + description: Code postal du gestionnaire. + example: '14075' + ville: + type: string + format: nullable + description: Ville du gestionnaire. + example: CAEN + distribution: + type: string + format: nullable + description: Complément de distribution du gestionnaire. + example: null + adresse_ligne: + type: string + format: nullable + description: Adresse complète du gestionnaire. + example: 115TER BOULEVARD VANIER - LA PIERRE + complement_adresse: + type: string + format: nullable + description: Complément de l'adresse du gestionnaire. + example: null + indication: + type: string + format: nullable + description: Indication supplémentaire à l'adresse du gestionnaire. + example: null + pays: + type: string + format: nullable + description: Pays du gestionnaire. + example: FRANCE + observation: + type: string + format: nullable + description: Observation relative à l'association. + example: Reprise auto => date publication création au JO à vérifier + code_gestion: + type: string + format: nullable + description: >- + Code du site gestionnaire (préfecture, sous-préfecture) de + l'association. + example: 142P + dirigeant_civilite: + type: string + format: nullable + description: Civilité du dirigeant. + example: PM + derniere_maj: + type: string + format: nullable + description: >- + Date de la dernière mise à jour des informations au RNA au format + AAAA-MM-JJ. + example: '2020-03-18' + publications_joafe: + type: object + format: optional + description: Publications JOAFE. + properties: + numero_parution: + type: string + example: '20180024' + description: Numéro de parution JOAFE + date_parution: + type: string + example: '2018-06-16' + description: Date de parution JOAFE au format AAAA-MM-JJ + date_declaration: + type: string + example: '2018-06-12' + description: Date de déclaration au format AAAA-MM-JJ + numero_annonce: + type: integer + example: 1766 + description: Numéro de l'annonce JOAFE + titre: + type: string + example: ASSOCIATION QUARTIER FOSSES-JEAN + description: Nom de l'association + type: + type: string + example: Création + description: Type d'annonce (Création, Modification, Dissolution) + prefecture: + type: string + example: Hauts-de-Seine + description: Lieu de la déclaration + objet: + type: string + format: optional + example: >- + la défense des droits des habitants du quartier auprès + éventuellement des bailleurs sociaux ; aide à la gestion des + problèmes de voisinage ; superviser le prêt des Lieux Communs de + Résidences pour proposer des activités aux jeunes du quartier + (jeux, échanges, anniversaires, prêt de livres ou divers) ; + l'organisation de rencontres pluriculturelles (apprentissage de + l'art culinaire des différentes ethnies qui composent le + quartier) ; organisation de goûter et sorties, vide grenier + annuel ou semestriel plus couramment brocante ; organisation de + rencontres inter-générations retraités qui pourraient apporter + une aide aux devoirs pour les enfants (bénévolement) + description: Description de l'association + site_web: + type: string + format: optional + example: null + description: Lien du site web + adresse: + type: string + format: nullable + example: 9, avenue D'Orgemont, 92700 Colombes + description: Adresse de l'association + ScoringNonFinancier: + type: object + format: optional + description: >- + Score extra-financier de l'entreprise. Uniquement présent si demandé + dans les champs supplémentaires. + properties: + note: + type: string + format: nullable + enum: + - A + - B + - C + - D + description: Note du score extra-financier de l'entreprise. + example: B + score: + type: number + format: nullable + description: Score extra-financier de l'entreprise. + example: 34 + date_calcul: + type: string + format: nullable + description: Date de calcul du score extra-financier de l'entreprise. + example: '2024-01-17' + erreur: + type: string + format: nullable + enum: + - Données extra financières incomplètes + description: Erreur lors du calcul du score extra-financier de l'entreprise. + example: null + ScoringFinancier: + type: object + format: optional + description: >- + Score financier de l'entreprise. Uniquement présent si demandé dans les + champs supplémentaires. + properties: + note: + type: string + format: nullable + enum: + - A + - B + - C + - D + - E + - F + - G + description: Note du score extra-financier de l'entreprise. + example: C + score: + type: number + format: nullable + description: Score extra-financier de l'entreprise. + example: 10 + date_cloture_comptes: + type: string + description: Date de clôture des comptes de l'entreprise. + example: '2021-12-31' + details_score: + type: object + format: nullable + description: Détails du score financier. + properties: + score_ebit_ca: + type: number + format: nullable + example: 3.5 + score_fonds_de_roulement: + type: number + format: nullable + example: 0 + score_tresorerie_nette: + type: number + format: nullable + example: 1 + score_dettes_fiscales_va: + type: number + format: nullable + example: 0.5 + score_cash_flow: + type: number + format: nullable + example: 3.5 + score_dettes_fiscales_ca: + type: number + format: nullable + example: null + score_charges_financieres_nettes: + type: number + format: nullable + example: 1.5 + date_calcul: + type: string + format: nullable + description: Date de calcul du score extra-financier de l'entreprise. + example: '2024-01-17' + erreur: + type: string + format: nullable + enum: + - Données financières incomplètes + - Type de compte non couvert + - Secteur non couvert + - Chiffre d'affaires trop faible + description: Erreur lors du calcul du score extra-financier de l'entreprise. + example: null + Labels: + type: object + format: optional + properties: + nom: + type: string + enum: + - RGE + - QUALIOPI + - EGALITE + - BIO + - ESS + - ESUS + - SOCIETE_A_MISSION + - ORIAS + description: Nom du label. + example: RGE + nb_etablissements_concernes: + type: integer + format: nullable + description: >- + Nombre d'établissements concernés par le label, dans le cas d'un + label lié aux établissements. Null sinon. + example: 1 + certificats: + type: array + format: optional + description: 'Label RGE seulement : Liste des certificats.' + specialites: + type: array + format: optional + description: 'Label QUALIOPI seulement : Liste des spécialités.' + notes: + type: array + format: optional + description: 'Label EGALITE seulement : Liste des notes.' + numero_immatriculation: + type: string + format: optional + description: 'Label ORIAS seulement : Numéro d''immatriculation ORIAS.' + inscriptions: + type: array + format: optional + description: 'Label ORIAS seulement : Liste des inscriptions ORIAS.' + LienSuccession: + type: object + properties: + siret: + type: string + description: Numéro siret de l'établissement au format xxxxxxxxxxxxxx. + example: '44306184100047' + date: + type: string + description: Date à laquelle la succession a eu lieu. + example: '1993-20-02' + transfert_siege: + type: boolean + description: >- + Vrai si le lien de succession concerne l'établissement siège, faux + sinon. + example: false + continuite_economique: + type: boolean + description: >- + Vrai s'il y a [continuité + économique](https://www.sirene.fr/sirene/public/variable/continuiteEconomique), + faux sinon. + example: true + Cartographie: + type: object + properties: + entreprises: + type: array + description: Liste des noeuds entreprises. + items: + type: object + properties: + id: + type: string + description: Un identifiant unique du noeud. + siren: + type: string + description: SIREN de l'entreprise. + nom_entreprise: + type: string + description: Nom de l'entreprise. + personnes: + type: array + description: Liste des noeuds personnes (dirigeants ou bénéficiaires effectifs). + items: + type: object + properties: + id: + type: string + description: Un identifiant unique du noeud. + prenom: + type: string + description: SIREN de l'entreprise. + nom: + type: string + description: Nom de l'entreprise. + niveau: + type: integer + description: >- + Niveau du noeud. Le niveau 1 correspond aux dirigeants et + bénéficiaires effectifs directement liés à l'entreprise + recherchée. Le niveau 2 correspond aux autres. + liens_entreprises_personnes: + type: array + description: >- + Liste des arêtes liant les noeuds entreprises avec des noeuds + personnes. + items: + type: array + description: >- + Tableau de 2 éléments, le premier contenant l'identifiant du noeud + entreprise, le second l'identifiant du noeud personne. + items: + oneOf: + - type: string + pattern: e[0-9]+ + - type: string + pattern: p[0-9]+ + liens_entreprises_entreprises: + type: array + description: >- + Liste des arêtes liant les noeuds entreprises avec des d'autres + noeuds entreprises. + items: + type: array + description: >- + Tableau de 2 éléments, chacun étant un identifiant d'un noeud + entreprise. + items: + type: string + pattern: e[0-9]+ + modifications_effectuees: + type: object + description: Description des paramètres ayant été automatiquement modifiés. +konfigCliVersion: 1.38.34 diff --git a/sdks/db/fixed-specs/box-fixed-spec.yaml b/sdks/db/fixed-specs/box-fixed-spec.yaml index 411fb0733f..669b89856b 100644 --- a/sdks/db/fixed-specs/box-fixed-spec.yaml +++ b/sdks/db/fixed-specs/box-fixed-spec.yaml @@ -16,7 +16,7 @@ info: license: name: Apache-2.0 url: http://www.apache.org/licenses/LICENSE-2.0 - x-box-commit-hash: 9d605a3ec5 + x-box-commit-hash: a2f6edcf0a x-konfig-ignore: object-with-no-properties: true potential-incorrect-type: true @@ -735,7 +735,7 @@ paths: Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example - `?field=metadata.enterprise_12345.contractTemplate`. + `?fields=metadata.enterprise_12345.contractTemplate`. name: fields in: query example: @@ -4615,7 +4615,7 @@ paths: Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example - `?field=metadata.enterprise_12345.contractTemplate`. + `?fields=metadata.enterprise_12345.contractTemplate`. name: fields in: query example: @@ -5311,7 +5311,7 @@ paths: Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example - `?field=metadata.enterprise_12345.contractTemplate`. + `?fields=metadata.enterprise_12345.contractTemplate`. name: fields in: query example: diff --git a/sdks/db/fixed-specs/customer-io-data-pipelines-fixed-spec.yaml b/sdks/db/fixed-specs/customer-io-data-pipelines-fixed-spec.yaml index 2636f8e960..fde96bd9a3 100644 --- a/sdks/db/fixed-specs/customer-io-data-pipelines-fixed-spec.yaml +++ b/sdks/db/fixed-specs/customer-io-data-pipelines-fixed-spec.yaml @@ -1112,13 +1112,13 @@ servers: - description: The base URL for all Data Pipelines calls. url: https://cdp.customer.io/v1 tags: - - name: Tracking - name: Identification - - name: Batch - - name: Group + - name: Tracking - name: Page - name: Screenshot + - name: Group - name: Alias + - name: Batch paths: /identify: post: diff --git a/sdks/db/fixed-specs/digital-ocean-fixed-spec.yaml b/sdks/db/fixed-specs/digital-ocean-fixed-spec.yaml index 36fdf5ecf2..d05cbb9161 100644 --- a/sdks/db/fixed-specs/digital-ocean-fixed-spec.yaml +++ b/sdks/db/fixed-specs/digital-ocean-fixed-spec.yaml @@ -18138,6 +18138,8 @@ paths: parameter to specify if the results should be for the `private` or `public` interface. Use the `direction` query parameter to specify if the results should be for `inbound` or `outbound` traffic. + + The metrics in the response body are in megabits per second (Mbps). parameters: - $ref: '#/components/parameters/parameters_droplet_id' - $ref: '#/components/parameters/network_interface' @@ -25294,7 +25296,7 @@ components: - inbound - outbound metric_timestamp_start: - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. in: query name: start example: '1620683817' @@ -25302,7 +25304,7 @@ components: schema: type: string metric_timestamp_end: - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. in: query name: end example: '1620705417' diff --git a/sdks/db/fixed-specs/hsbc-account-information-ce-fixed-spec.yaml b/sdks/db/fixed-specs/hsbc-account-information-ce-fixed-spec.yaml index a662657e0f..12bed84cad 100644 --- a/sdks/db/fixed-specs/hsbc-account-information-ce-fixed-spec.yaml +++ b/sdks/db/fixed-specs/hsbc-account-information-ce-fixed-spec.yaml @@ -658,6 +658,8 @@ components: required: false schema: type: string + pattern: >- + ^((((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\s?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\s?),?\s?)+$ example: 12.201.45.125 x-fapi-auth-date: description: >- diff --git a/sdks/db/fixed-specs/pappers-fixed-spec.yaml b/sdks/db/fixed-specs/pappers-fixed-spec.yaml new file mode 100644 index 0000000000..a2e7653379 --- /dev/null +++ b/sdks/db/fixed-specs/pappers-fixed-spec.yaml @@ -0,0 +1,6103 @@ +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: + tags: + - Documents + summary: >- + Télécharge l'extrait INPI d'une entreprise à partir de son SIREN ou + SIRET. + operationId: Documents_getExtraitInpi + 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 INPI au format + PDF. + content: + application/pdf: + schema: + $ref: '#/components/schemas/DocumentsGetExtraitInpiResponse' + '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/avis_situation_insee: + get: + tags: + - Documents + summary: >- + Télécharge l'avis de situation INSEE d'une entreprise à partir de son + SIREN ou SIRET. + operationId: Documents_downloadInseeSituation + 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'avis de situation au + format PDF. + content: + application/pdf: + schema: + $ref: '#/components/schemas/DocumentsDownloadInseeSituationResponse' + '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/statuts: + get: + tags: + - Documents + summary: >- + Télécharge les derniers statuts disponibles d'une entreprise à partir de + son SIREN ou SIRET. + operationId: Documents_telechargementStatuts + 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 les statuts au format PDF. + content: + application/pdf: + schema: + $ref: '#/components/schemas/DocumentsTelechargementStatutsResponse' + '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/declaration_beneficiaires_effectifs: + get: + tags: + - Documents + summary: >- + Télécharge la déclaration des bénéficiaires effectifs d'une entreprise à + partir de son SIREN. + operationId: Documents_telechargementBeneficiairesEffectifs + description: >- + Vous devez fournir le SIREN. Le document vous sera envoyé au format PDF. + + + Seules les autorités de contrôle (article + R. 561-57 du Code monétaire et financier en dénombre 18) et les + personnes assujetties à la lutte contre le blanchiment des capitaux et + le financement du terrorisme (article + L. 561-2 du code monétaire et financier) peuvent accéder à ces + informations. + + + Pour pouvoir utiliser cette route veuillez nous contacter au préalable à + api@pappers.fr + 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 + responses: + '200': + description: >- + Document disponible. Le retour contient la déclaration des + bénéficiaires effectifs au format PDF. + content: + application/pdf: + schema: + $ref: >- + #/components/schemas/DocumentsTelechargementBeneficiairesEffectifsResponse + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '403': + description: Vous n'avez pas les droits pour exécuter cette requête. + '404': + description: Document indisponible. + '503': + description: Service momentanément indisponible. + /document/rapport_solvabilite: + get: + tags: + - Documents + summary: >- + Télécharge un Rapport de solvabilité d'une entreprise à partir de son + SIREN. + operationId: Documents_downloadSolvabilityReport + description: Vous devez fournir le SIREN. 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 + responses: + '200': + description: >- + Document disponible. Le retour contient le rapport de solvabilité au + format PDF. + content: + application/pdf: + schema: + $ref: >- + #/components/schemas/DocumentsDownloadSolvabilityReportResponse + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '404': + description: Document indisponible. + '503': + description: Service momentanément indisponible. + /conformite/personne_physique: + get: + tags: + - Conformité + summary: >- + Vérifie le statut de personne politiquement exposée et la présence de + sanctions internationales pour une personne physique. + operationId: Conformit_personnePhysiqueStatusCheck + description: > + Cette route vérifie le statut de personne politiquement exposée et la + présence de sanctions internationales pour une personne physique. + + + Pour vérifier le statut de dirigeants et bénéficiaires effectifs + d'entreprises, vous pouvez directement utiliser la route `/entreprise` + avec les champs supplémentaires `personne_politiquement_exposee` et + `sanctions`. + parameters: + - description: Clé d'utilisation de l'API + name: api_token + in: query + required: true + schema: + type: string + example: votre_clé_ici + - description: Nom de la personne physique + name: nom + in: query + required: true + schema: + type: string + example: Macron + - description: Prénom de la personne physique + name: prenom + in: query + required: true + schema: + type: string + example: Emmanuel + - description: >- + Date de naissance de la personne physique, au format AAAA-MM-JJ ou + AAAA-MM + name: date_de_naissance + in: query + required: true + schema: + type: string + example: '1977-12-21T00:00:00.000Z' + responses: + '200': + description: La personne physique a pu être vérifiée. + content: + application/json: + schema: + $ref: >- + #/components/schemas/ConformitPersonnePhysiqueStatusCheckResponse + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '503': + description: Erreur interne. La personne physique n'a pas pu être vérifiée. + /suivi-jetons: + get: + tags: + - Suivi utilisation + summary: Récupère le suivi d'utilisation des jetons. + operationId: SuiviUtilisation_getTokenUsage + description: Vous devez fournir la clé d'utilisation de l'API. + parameters: + - description: Clé d'utilisation de l'API + name: api_token + in: query + required: true + schema: + type: string + example: votre_clé_ici + responses: + '200': + description: Succès + content: + application/json: + schema: + $ref: '#/components/schemas/SuiviUtilisationGetTokenUsageResponse' + '401': + description: Clé API incorrecte. + '503': + description: Service momentanément indisponible. + /liste: + post: + tags: + - Surveillance + summary: Ajoute un (ou plusieurs) dirigeant(s) à une liste de dirigeants. + operationId: Surveillance_listeDirigeantsAjout + description: >- + Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant + de votre liste. Les informations à renseigner sont différentes selon le + type de personne à ajouter (morale ou physique) + parameters: + - description: Clé d'utilisation de l'API + name: api_token + in: query + required: true + schema: + type: string + example: votre_clé_ici + - description: Identifiant unique de votre liste de surveillance de dirigeants + name: id_liste + in: query + required: true + schema: + type: string + example: votre_identifiant_ici + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SurveillanceListeDirigeantsAjoutRequest' + responses: + '200': + description: Aucun changement, les données étaient déjà présentes. + content: + application/json: + schema: + $ref: '#/components/schemas/SurveillanceListeDirigeantsAjoutResponse' + '201': + description: Créés, liste mise à jour. + content: + application/json: + schema: + $ref: >- + #/components/schemas/SurveillanceListeDirigeantsAjout201Response + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '403': + description: Offre dépassée. + '404': + description: Liste non trouvée. + '503': + description: Service momentanément indisponible. + delete: + tags: + - Surveillance + summary: Supprime une (ou plusieurs) notification(s) d'une liste. + operationId: Surveillance_listDelete + description: >- + Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant + de votre liste. + parameters: + - description: Clé d'utilisation de l'API + name: api_token + in: query + required: true + schema: + type: string + example: votre_clé_ici + - description: Identifiant unique de votre liste de surveillance + name: id_liste + in: query + required: true + schema: + type: string + example: votre_identifiant_ici + - description: >- + Liste des sirens des notifications à supprimer, séparés par une + virgule + name: siren + in: query + required: false + schema: + type: string + example: 443061841,950370973 + - description: Liste des ids des notifications à supprimer, séparés par une virgule + name: id + in: query + required: false + schema: + type: string + example: >- + ecfca3e5fb1ce07bb3fdfe8760a28df5aa617ed4951b7f61,a67b9de66189ba98eb4aede09f4b2b565b0f18fe694da7bc + - description: Suppression de toutes les notifications de la liste + name: supprimer_totalite + in: query + required: false + schema: + type: boolean + example: true + responses: + '200': + description: Succés. + content: + application/json: + schema: + $ref: '#/components/schemas/SurveillanceListDeleteResponse' + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '404': + description: Liste non trouvée. + '503': + description: Service momentanément indisponible. + /liste-informations: + post: + tags: + - Surveillance + summary: Ajoute des informations à une (ou plusieurs) notification(s). + operationId: Surveillance_addNotifications + description: >- + Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant + de votre liste. + parameters: + - description: Clé d'utilisation de l'API + name: api_token + in: query + required: true + schema: + type: string + example: votre_clé_ici + - description: Identifiant unique de votre liste de surveillance d'entreprises + name: id_liste + in: query + required: true + schema: + type: string + example: votre_identifiant_ici + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SurveillanceAddNotificationsRequest' + responses: + '200': + description: Succés. + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '404': + description: Liste non trouvée. + '503': + description: Service momentanément indisponible. +components: + parameters: + api_token: + description: Clé d'utilisation de l'API + name: api_token + in: query + required: true + schema: + type: string + example: votre_clé_ici + par_page: + description: 'Nombre de résultats affichés sur une page. Valeur par défaut : `10`.' + name: par_page + in: query + required: false + schema: + type: integer + example: 20 + page: + description: 'Page de résultats. Valeur par défaut : `1`.' + name: page + in: query + required: false + schema: + type: integer + example: 1 + bases: + description: >- + Bases de données dans lesquelles rechercher. Il est possible d'indiquer + plusieurs bases en les séparant par des virgules. Valeur par défaut : + `"entreprises"`. + name: bases + in: query + required: false + schema: + type: string + enum: + - entreprises + - dirigeants + - beneficiaires + - documents + - publications + example: entreprises + precision: + description: 'Niveau de précision de la recherche. Valeur par défaut : `"standard"`.' + name: precision + in: query + required: false + schema: + type: string + enum: + - approximative + - standard + - exacte + example: standard + curseur: + description: >- + Curseur servant à parcourir l'ensemble des résultats (alternativement à + la pagination qui est limitée à 400 résultats maximum). Doit valoir `*` + pour la première requête, et doit pour les requêtes suivantes reprendre + la valeur `curseurSuivant` retournée par la dernière réponse. + name: curseur + in: query + required: false + schema: + type: string + example: '*' + par_curseur: + description: >- + Nombre de résultats affichés par curseur. Valeur par défaut : `50`. + Valeur minimale: `1`. Valeur maximale : `1000`. + name: par_curseur + in: query + required: false + schema: + type: integer + example: 20 + code_naf: + description: >- + Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes NAF + en les séparant par des virgules. + name: code_naf + in: query + required: false + schema: + type: string + example: 70.10Z + departement: + description: >- + Numéro de département de l'un des établissements de l'entreprise. Il est + possible d'indiquer plusieurs départements en les séparant par des + virgules. + name: departement + in: query + required: false + schema: + type: string + example: 75 + region: + description: >- + Code de la région de l'un des établissements de l'entreprise, selon la + [nomenclature + Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il + est possible d'indiquer plusieurs codes régions en les séparant par des + virgules. + name: region + in: query + required: false + schema: + type: string + example: 11 + code_postal: + description: >- + Code postal de l'un des établissements de l'entreprise. Il est possible + d'indiquer plusieurs codes postaux en les séparant par des virgules. + name: code_postal + in: query + required: false + schema: + type: string + example: 75009 + convention_collective: + description: Convention collective de l'entreprise. + name: convention_collective + in: query + required: false + schema: + type: string + example: 1486 + categorie_juridique: + description: >- + Catégorie juridique de l'entreprise, selon la [nomenclature + Insee](https://www.insee.fr/fr/information/2028129). + + + **Note** : Le code correspond à celui de l'INSEE, à l'exception des SASU + qui auront comme code 5720 et les EURL qui auront comme code 5498. + name: categorie_juridique + in: query + required: false + schema: + type: string + example: 5499 + entreprise_cessee: + description: Activité de l'entreprise cessée ou non. + name: entreprise_cessee + in: query + required: false + schema: + type: boolean + example: false + statut_rcs: + description: Statut au RCS + name: statut_rcs + in: query + required: false + schema: + type: string + enum: + - inscrit + - radie + - non inscrit + example: inscrit + objet_social: + description: Objet social de l'entreprise déclaré au RCS. + name: objet_social + in: query + required: false + schema: + type: string + example: La conception de moteurs de recherche sur internet. + date_immatriculation_rcs_min: + description: >- + Date d'immatriculation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + name: date_immatriculation_rcs_min + in: query + required: false + schema: + type: string + example: 15-05-2002 + date_immatriculation_rcs_max: + description: d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA. + name: date_immatriculation_rcs_max + in: query + required: false + schema: + type: string + example: 15-05-2002 + date_radiation_rcs_min: + description: Date de radiation au RCS minimale de l'entreprise, au format JJ-MM-AAAA. + name: date_radiation_rcs_min + in: query + required: false + schema: + type: string + example: 15-05-2002 + date_radiation_rcs_max: + description: Date de radiation au RCS maximale de l'entreprise, au format JJ-MM-AAAA. + name: date_radiation_rcs_max + in: query + required: false + schema: + type: string + example: 17-05-2002 + capital_min: + description: Capital minimum de l'entreprise. + name: capital_min + in: query + required: false + schema: + type: string + example: 411016200 + capital_max: + description: Capital maximum de l'entreprise. + name: capital_max + in: query + required: false + schema: + type: string + example: 411016400 + chiffre_affaires_min: + description: >- + Chiffre d'affaires minimum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + name: chiffre_affaires_min + in: query + required: false + schema: + type: string + example: 411016200 + chiffre_affaires_max: + description: >- + Chiffre d'affaires maximum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + name: chiffre_affaires_max + in: query + required: false + schema: + type: string + example: 411016400 + resultat_min: + description: >- + Résultat minimum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + name: resultat_min + in: query + required: false + schema: + type: string + example: 29327000 + resultat_max: + description: >- + Résultat maximum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + name: resultat_max + in: query + required: false + schema: + type: string + example: 29327100 + date_creation_min: + description: Date de création minimale de l'entreprise, au format JJ-MM-AAAA. + name: date_creation_min + in: query + required: false + schema: + type: string + example: 15-05-2002 + date_creation_max: + description: Date de création maximale de l'entreprise, au format JJ-MM-AAAA. + name: date_creation_max + in: query + required: false + schema: + type: string + example: 17-05-2002 + tranche_effectif_min: + description: >- + Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen). + + + **Note** : 00 ou NN donneront les mêmes résultats et veulent dire non + employeur + name: tranche_effectif_min + in: query + required: false + schema: + type: string + example: 40 + tranche_effectif_max: + description: >- + Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen). + + + **Note** : 00 ou NN donneront les mêmes résultats et veulent dire non + employeur + name: tranche_effectif_max + in: query + required: false + schema: + type: string + example: 42 + type_dirigeant: + description: >- + Type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + name: type_dirigeant + in: query + required: false + schema: + type: string + enum: + - physique + - morale + example: physique + qualite_dirigeant: + description: >- + Qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + name: qualite_dirigeant + in: query + required: false + schema: + type: string + example: Administrateur + nationalite_dirigeant: + description: >- + Nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + name: nationalite_dirigeant + in: query + required: false + schema: + type: string + example: Française + nom_dirigeant: + description: >- + Nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + name: nom_dirigeant + in: query + required: false + schema: + type: string + example: Yi + prenom_dirigeant: + description: >- + Prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + name: prenom_dirigeant + in: query + required: false + schema: + type: string + example: Kenneth H. + age_dirigeant_min: + description: >- + Âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + name: age_dirigeant_min + in: query + required: false + schema: + type: integer + example: 40 + age_dirigeant_max: + description: >- + Âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + name: age_dirigeant_max + in: query + required: false + schema: + type: integer + example: 42 + date_de_naissance_dirigeant_min: + description: >- + Date de naissance minimale du dirigeant (ou de l'un des dirigeants de + l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA. + name: date_de_naissance_dirigeant_min + in: query + required: false + schema: + type: string + format: date + example: '1970-01-01T00:00:00.000Z' + date_de_naissance_dirigeant_max: + description: >- + Date de naissance maximale du dirigeant (ou de l'un des dirigeants de + l'entreprise pour une recherche d'entreprises) de l'entreprise, au + format JJ-MM-AAAA. + name: date_de_naissance_dirigeant_max + in: query + required: false + schema: + type: string + format: date + example: '1970-12-31T00:00:00.000Z' + age_beneficiaire_min: + description: >- + Âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + name: age_beneficiaire_min + in: query + required: false + schema: + type: integer + example: 40 + age_beneficiaire_max: + description: >- + Âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + name: age_beneficiaire_max + in: query + required: false + schema: + type: integer + example: 42 + date_de_naissance_beneficiaire_min: + description: >- + Date de naissance minimale du bénéficiaire effectif (ou de l'un des + bénéficiaires effectifs de l'entreprise pour une recherche + d'entreprises), au format JJ-MM-AAAA. + name: date_de_naissance_beneficiaire_min + in: query + required: false + schema: + type: string + format: date + example: '1970-01-01T00:00:00.000Z' + date_de_naissance_beneficiaire_max: + description: >- + Date de naissance maximale du bénéficiaire effectif (ou de l'un des + bénéficiaires effectifs de l'entreprise pour une recherche + d'entreprises) de l'entreprise, au format JJ-MM-AAAA. + name: date_de_naissance_beneficiaire_max + in: query + required: false + schema: + type: string + format: date + example: '1970-12-31T00:00:00.000Z' + nationalite_beneficiaire: + description: >- + Nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + name: nationalite_beneficiaire + in: query + required: false + schema: + type: string + example: Française + date_depot_document_min: + description: Date de dépôt minimale du document, au format JJ-MM-AAAA. + name: date_depot_document_min + in: query + required: false + schema: + type: string + format: date + example: '2000-01-01T00:00:00.000Z' + date_depot_document_max: + description: Date de dépôt maximale du document, au format JJ-MM-AAAA. + name: date_depot_document_max + in: query + required: false + schema: + type: string + format: date + example: '2000-12-31T00:00:00.000Z' + type_publication: + description: Type de publication + name: type_publication + in: query + required: false + schema: + type: string + enum: + - Création + - Immatriculation + - Modification + - Vente + - Radiation + - Procédure collective + - Dépôt des comptes + example: Procédure collective + date_publication_min: + description: Date publication minimale de la publication, au format JJ-MM-AAAA. + name: date_publication_min + in: query + required: false + schema: + type: string + format: date + example: '2000-01-01T00:00:00.000Z' + date_publication_max: + description: Date de publication maximale de la publication, au format JJ-MM-AAAA. + name: date_publication_max + in: query + required: false + schema: + type: string + format: date + example: '2000-12-31T00:00:00.000Z' + siren: + description: SIREN de l'entreprise. + name: siren + in: query + required: false + schema: + type: string + example: null + schemas: + EntrepriseBase: + type: object + properties: + siren: + description: Le numéro SIREN de l'entreprise au format xxxxxxxxx. + type: string + example: '443061841' + siren_formate: + description: Le numéro SIREN de l'entreprise au format xxx xxx xxx. + type: string + example: 443 061 841 + nom_entreprise: + description: >- + Le nom de l'entreprise. Il est égal à sigle + dénomination en cas de + personne morale, ou à nom + prénom en cas de personne physique. + Nullable si le paramètre `integrer_diffusions_partielles` est à + vrai. + type: string + example: GOOGLE FRANCE + personne_morale: + description: Vrai en cas de personne morale, faux en cas de personne physique. + type: boolean + denomination: + description: Dénomination de l'entreprise si personne morale. + type: string + format: nullable + example: GOOGLE FRANCE + nom: + description: Nom si personne physique. + type: string + format: nullable + example: null + prenom: + description: Prénom si personne physique. + type: string + format: nullable + example: null + sexe: + description: Sexe si personne physique. F pour féminin, M pour masculin. + type: string + format: nullable + example: null + code_naf: + description: Code NAF de l'entreprise. + type: string + example: 70.10Z + libelle_code_naf: + description: Libellé du code NAF de l'entreprise. + type: string + example: Activités des sièges sociaux + domaine_activite: + description: Domaine d'activité de l'entreprise. + type: string + example: Activités des sièges sociaux ; conseil de gestion + conventions_collectives: + description: Liste des conventions collectives de l'entreprise. + type: array + items: + type: object + properties: + nom: + description: Nom de la convention collective. + type: string + example: >- + Convention collective nationale applicable au personnel des + bureaux d'études techniques des cabinets d'ingénieurs-conseils + et des sociétés de conseils(BET SYNTEC) + idcc: + description: Code IDCC de l'entreprise. + type: integer + example: 1486 + confirmee: + description: >- + Si confirmée, l'information est issue de la DSN de + l'entreprise et fournie par le ministère du Travail. Si non + confirmée, ce n'est qu'une estimation à partir du code NAF de + l'entreprise. + type: boolean + pourcentage: + description: >- + Pourcentage de fiabilité de l'estimation. Si la convention est + confirmée, vaut null. + type: number + format: nullable + example: 96.2 + date_creation: + description: Date de création de l'entreprise au format AAAA-MM-JJ. + type: string + format: date + example: '2002-05-16' + date_creation_formate: + description: Date de création de l'entreprise au format JJ/MM/AAAA. + type: string + example: 16/05/2002 + entreprise_cessee: + description: >- + Si vrai, l'entreprise n'est plus en activité. Sinon, elle est + toujours en activité. + type: boolean + date_cessation: + description: Date de cessation de l'entreprise au format AAAA-MM-JJ. + type: string + format: nullable + example: '2002-05-16' + entreprise_employeuse: + description: Si vrai, l'entreprise a au moins un employé. + type: boolean + societe_a_mission: + description: Si vrai, l'entreprise est société à mission. + type: boolean + format: nullable + categorie_juridique: + description: >- + Catégorie juridique de l'entreprise, selon la [nomenclature + Insee](https://www.insee.fr/fr/information/2028129). + + + **Note** : Le code correspond à celui de l'INSEE, à l'exception des + SASU qui auront comme code 5720 et les EURL qui auront comme code + 5498. + type: string + example: '5499' + forme_juridique: + description: Forme juridique de l'entreprise. + type: string + example: Société à responsabilité limitée (SARL) + forme_exercice: + description: Forme d'exercice de l'activité principale. + type: string + enum: + - Agent commercial + - 'Agricole : Périmètre des non actifs agricoles' + - 'Agricole : Périmètre des actifs agricoles' + - Artisanale non réglementée + - Artisanale réglementée + - Commerciale + - Libérale non réglementée + - Libérale réglementée + - Loueur meublé + - Toute forme d'activité + - Gestion de biens + - Loueur terre agricole + - Activité de prospection uniquement (non commerciale) + - Sans activité + format: nullable + example: Commerciale + effectif: + description: Tranche d'effectif de l'entreprise. + type: string + example: Entre 500 et 999 salariés + effectif_min: + description: Effectif minimal de l'entreprise. + type: integer + example: 500 + effectif_max: + description: Effectif maximal de l'entreprise. + type: integer + example: 999 + tranche_effectif: + description: >- + Tranche d'effectif de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen#:~:text=Cette%20variable%20correspond%20%C3%A0%20la,effectif%20salari%C3%A9%20de%20l'entreprise.). + type: string + format: nullable + example: '41' + annee_effectif: + description: >- + Année de validité des variables effectif, effectif_min et + effectif_max. + type: integer + format: nullable + example: 2017 + capital: + description: Capital de l'entreprise. + type: number + format: nullable + example: 464884017 + statut_rcs: + description: Statut de l'entreprise au RCS + type: string + format: nullable + example: Inscrit + EntrepriseFiche: + allOf: + - $ref: '#/components/schemas/EntrepriseBase' + - type: object + properties: + siege: + $ref: '#/components/schemas/EtablissementFiche' + diffusable: + description: >- + Le statut de diffusion de l'entreprise. Non diffusable + correspond à une entreprise ayant demandé une diffusion + partielle de ses données. Aucune information n'est alors + disponible, sauf si vous utilisez le paramètre + `integrer_diffusions_partielles`. + type: boolean + sigle: + description: Sigle de l'entreprise si personne morale. + type: string + format: nullable + example: null + objet_social: + description: Objet social de l'entreprise. + type: string + format: nullable + example: >- + Fourniture de services et/ou conseils relatifs aux logiciels au + réseau internet aux réseaux télématiques ou en ligne notamment + L'intermediation en matière de vente de publicité en ligne la + promotion sous toutes ses formes de la publicité en ligne la + promotion directe de produits et services et la mise en oeuvre + de centres de traitement de l'information + capital_formate: + description: Capital l'entreprise au format xx xxx €. + type: string + format: nullable + example: "464 884 017,00\_€" + capital_actuel_si_variable: + description: Capital actuel de l'entreprise si variable. + type: string + format: nullable + example: null + devise_capital: + description: Devise de capital_formate et capital_actuel_si_variable. + type: string + format: nullable + example: Euros + numero_rcs: + description: Numéro RCS de l'entreprise. + type: string + format: nullable + example: 464884017 R.C.S. Paris + date_cloture_exercice: + description: Date de clôture d'exercice de l'entreprise. + type: string + format: nullable + example: null + date_cloture_exercice_exceptionnelle: + description: Date de clôture d'exercice exceptionnel de l'entreprise. + type: string + format: nullable + example: null + date_cloture_exercice_exceptionnelle_formate: + description: >- + Date de clôture d'exercice exceptionnel formatée de + l'entreprise. + type: string + format: nullable + example: null + prochaine_date_cloture_exercice: + description: Prochaine date de clôture d'exercice de l'entreprise. + type: string + format: nullable + example: null + prochaine_date_cloture_exercice_formate: + description: Prochaine date de clôture d'exercice formatée de l'entreprise. + type: string + format: nullable + example: null + economie_sociale_solidaire: + description: >- + Vrai si l'entreprise est une entreprise de l'économie sociale et + solidaire. + type: boolean + duree_personne_morale: + description: Durée de la personne morale. + type: string + format: nullable + example: null + dernier_traitement: + description: Date de dernier traitement de l'entreprise. + type: string + format: date + example: '2020-07-09' + derniere_mise_a_jour_sirene: + description: >- + Dernière mise à jour de la base de donnée sirène au format + AAAA-MM-JJ. + type: string + format: date + example: '2020-08-13' + derniere_mise_a_jour_rcs: + description: >- + Dernière mise à jour de la base de donnée RCS au format + AAAA-MM-JJ. + type: string + format: date + example: '2020-06-25' + statut_rcs: + description: Statut de l'entreprise au RCS. + type: string + enum: + - Inscrit + - Non inscrit + - Radié + example: Inscrit + greffe: + description: Greffe RCS de l'entreprise. + type: string + format: nullable + example: Paris + code_greffe: + description: Code greffe RCS de l'entreprise. + type: string + format: nullable + example: '7501' + date_immatriculation_rcs: + description: Date d'immatriculation de l'entreprise au RCS. + type: string + format: nullable + example: null + date_premiere_immatriculation_rcs: + description: Date de la première immatriculation de l'entreprise au RCS. + type: string + format: nullable + example: null + date_debut_activite: + description: Date de début d'activité de l'entreprise. + type: string + format: nullable + example: '2002-08-14' + date_debut_premiere_activite: + description: Date de début d'activité de l'entreprise. + type: string + format: nullable + example: null + date_radiation_rcs: + description: Date de radiation de l'entreprise au RCS. + type: string + format: nullable + example: null + statut_rne: + description: Statut de l'entreprise au RNE. + type: string + format: nullable + enum: + - Inscrit + - Non inscrit + - Radié + example: null + date_immatriculation_rne: + description: Date d'immatriculation de l'entreprise au RNE. + type: string + format: nullable + example: null + date_radiation_rne: + description: Date de radiation de l'entreprise au RNE. + type: string + format: nullable + example: null + numero_tva_intracommunautaire: + description: Numéro de TVA intracommunautaire de l'entreprise. + type: string + example: FR64443061841 + validite_tva_intracommunautaire: + description: >- + Présent uniquement si le paramètre + validite_tva_intracommunautaire a été mis à vrai. + + + Si vrai, le numéro de TVA intracommunautaire est valide. Si + faux, il est invalide. Si null, la validité n'a pas pu être + vérifiée. + type: boolean + format: optional, nullable + example: true + associe_unique: + description: >- + Si vrai, l'entreprise est à associé unique (notamment pour les + SASU et les EURL). + type: boolean + format: nullable + micro_entreprise: + description: Si vrai, l'entreprise possède le statut de micro-entrepreneur + type: boolean + format: optional + example: false + etablissements: + description: Liste des établissements de l'entreprise. + type: array + items: + $ref: '#/components/schemas/EtablissementFiche' + finances: + description: Liste des finances de l'entreprise. + type: array + items: + allOf: + - type: object + properties: + annee: + description: Année de cloture d'exercice. + type: integer + example: 2018 + date_de_cloture_exercice: + description: >- + Date de cloture de l'exercice des finances de + l'entreprise. + type: string + format: date + example: '2018-12-31' + duree_exercice: + description: Durée de l'exercice de l'entreprise." + type: integer + example: 12 + - $ref: '#/components/schemas/Ratios' + representants: + description: Liste des représentants de l'entreprise. + type: array + items: + $ref: '#/components/schemas/Representant' + beneficiaires_effectifs: + description: >- + Liste des bénéficiaires effectifs de l'entreprise (si + disponibles). + type: array + items: + type: object + properties: + date_greffe: + description: >- + Date de génération des bénéficiaires effectifs, au format + AAAA-MM-JJ. + type: string + format: date nullable + example: '2021-01-06' + type: + description: Type du bénéficiaire effectif + type: string + format: nullable + example: BE_SOC + nom: + description: Nom du bénéficiaire effectif. + type: string + format: nullable + example: McCourt JR + nom_usage: + description: Nom d'usage du bénéficiaire effectif. + type: string + format: nullable + example: null + prenom: + description: Prénom du bénéficiaire effectif. + type: string + format: nullable + example: Frank + pseudonyme: + type: string + format: nullable + example: null + date_de_naissance_formatee: + description: >- + Mois et année de naissance du bénéficiaire effectif, au + format MM/AAAA. + type: string + format: nullable + example: 08/1953 + date_de_naissance_complete_formatee: + description: >- + Date de naissance complète du bénéficiaire effectif, au + format JJ/MM/AAAA. + type: string + format: date nullable + example: 14/08/1953 + nationalite: + description: Nationalité du bénéficiaire effectif. + type: string + format: nullable + example: Américaine (Etats Unis) + code_nationalite: + description: Code de la nationalité du bénéficiaire effectif. + type: string + format: nullable + example: US + ville_de_naissance: + description: Ville de naissance du bénéficiaire effectif. + type: string + format: nullable + example: Massachusetts + pays_de_naissance: + description: Pays de naissance du bénéficiaire effectif. + type: string + format: nullable + example: ETATS-UNIS D'AMERIQUE + code_pays_de_naissance: + description: Code du pays de naissance du bénéficiaire effectif. + type: string + format: nullable + example: US + adresse_ligne_1: + description: Première ligne de l'adresse du bénéficiaire effectif. + type: string + format: nullable + example: null + adresse_ligne_2: + description: Deuxième ligne de l'adresse du bénéficiaire effectif. + type: string + format: nullable + example: 888 Seventh Avenue 43rd Floor New York (Etat de New York) + adresse_ligne_3: + description: Troisième ligne de l'adresse du bénéficiaire effectif. + type: string + format: nullable + example: null + code_postal: + description: Code postal du bénéficiaire effectif. + type: string + format: nullable + example: null + ville: + description: Ville du bénéficiaire effectif. + type: string + format: nullable + example: null + pays: + description: Pays du bénéficiaire effectif. + type: string + format: nullable + example: ETATS-UNIS D'AMERIQUE + code_pays: + description: Code du pays du bénéficiaire effectif. + type: string + format: nullable + example: US + pourcentage_parts: + description: >- + Parts détenues par le bénéficiaire effectif, en + pourcentage des parts totales. + type: number + format: nullable + pourcentage_parts_directes: + description: >- + Parts détenues de façon directe par le bénéficiaire + effectif, en pourcentage des parts totales. + type: number + format: nullable + pourcentage_parts_indirectes: + description: >- + Parts détenues de façon indirecte par le bénéficiaire + effectif, en pourcentage des parts totales. + type: number + format: nullable + pourcentage_parts_vocation_titulaire: + description: >- + Parts dont le bénéficiaire effectif a vocation à devenir + titulaire par l'effet d'un acte juridique, en pourcentage + des parts totales. + type: number + format: nullable + details_parts_directes: + description: >- + Détails des parts détenues de façon directe par le + bénéficiaire effectif. + type: object + format: nullable + properties: + pourcentage_pleine_propriete: + description: >- + Parts détenues de façon directe en pleine propriété + par le bénéficiaire effectif, en pourcentage des parts + totales. + type: number + pourcentage_nue_propriete: + description: >- + Parts détenues de façon directe en nue propriété par + le bénéficiaire effectif, en pourcentage des parts + totales. + type: number + details_parts_indirectes: + description: >- + Détails des parts détenues de façon indirecte par le + bénéficiaire effectif. + type: object + format: nullable + properties: + pourcentage_en_indivision: + description: >- + Parts détenues de façon indirecte par le biais d'une + indivision par le bénéficiaire effectif, en + pourcentage des parts totales. + type: number + pourcentage_en_personne_morale: + description: >- + Parts détenues de façon indirecte par le biais d'une + personne morale par le bénéficiaire effectif, en + pourcentage des parts totales. + type: number + details_en_indivision: + description: >- + Détails des parts détenues de façon indirecte par le + biais d'une indivision par le bénéficiaire effectif. + type: object + format: nullable + properties: + pourcentage_pleine_propriete: + description: >- + Parts détenues de façon indirecte par le biais + d'une indivision en pleine propriété par le + bénéficiaire effectif, en pourcentage des parts + totales. + type: number + pourcentage_nue_propriete: + description: >- + Parts détenues de façon indirecte par le biais + d'une indivision en nue propriété par le + bénéficiaire effectif, en pourcentage des parts + totales. + type: number + details_en_personne_morale: + description: >- + Détails des parts détenues de façon indirecte par le + biais d'une personne morale par le bénéficiaire + effectif. + type: object + format: nullable + properties: + pourcentage_pleine_propriete: + description: >- + Parts détenues de façon indirecte par le biais + d'une personne morale en pleine propriété par le + bénéficiaire effectif, en pourcentage des parts + totales. + type: number + pourcentage_nue_propriete: + description: >- + Parts détenues de façon indirecte par le biais + d'une personne morale en nue propriété par le + bénéficiaire effectif, en pourcentage des parts + totales. + type: number + details_parts_vocation_titulaire: + description: >- + Détails des parts dont le bénéficiaire effectif a vocation + à devenir titulaire. + type: object + format: nullable + properties: + pourcentage_directes: + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon directe, en pourcentage des + parts totales. + type: number + pourcentage_indirectes: + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon indirecte, en pourcentage + des parts totales. + type: number + details_directes: + description: >- + Détails des parts dont le bénéficiaire effectif a + vocation à devenir titulaire de façon directe. + type: object + format: nullable + properties: + pourcentage_pleine_propriete: + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon directe en pleine + propriété, en pourcentage des parts totales. + type: number + pourcentage_nue_propriete: + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon directe en nue + propriété, en pourcentage des parts totales. + type: number + details_indirectes: + description: >- + Détails des parts dont le bénéficiaire effectif a + vocation à devenir titulaire de façon indirecte. + type: object + format: nullable + properties: + pourcentage_en_indivision: + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon indirecte par le biais + d'une indivision, en pourcentage des parts + totales. + type: number + pourcentage_en_personne_morale: + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon indirecte par le biais + d'une personne morale, en pourcentage des parts + totales. + type: number + details_en_indivision: + description: >- + Détails des parts dont le bénéficiaire effectif a + vocation à devenir titulaire de façon indirecte + par le biais d'une indivision. + type: object + format: nullable + properties: + pourcentage_pleine_propriete: + description: >- + Parts dont le bénéficiaire effectif a vocation + à devenir titulaire de façon indirecte par le + biais d'une indivision en pleine propriété, en + pourcentage des parts totales. + type: number + pourcentage_nue_propriete: + description: >- + Parts dont le bénéficiaire effectif a vocation + à devenir titulaire de façon indirecte par le + biais d'une indivision en nue propriété, en + pourcentage des parts totales. + type: number + details_en_personne_morale: + description: >- + Détails des parts dont le bénéficiaire effectif a + vocation à devenir titulaire de façon indirecte + par le biais d'une personne morale. + type: object + format: nullable + properties: + pourcentage_pleine_propriete: + description: >- + Parts dont le bénéficiaire effectif a vocation + à devenir titulaire de façon indirecte par le + biais d'une personne morale en pleine + propriété, en pourcentage des parts totales. + type: number + pourcentage_nue_propriete: + description: >- + Parts dont le bénéficiaire effectif a vocation + à devenir titulaire de façon indirecte par le + biais d'une personne morale en nue propriété, + en pourcentage des parts totales. + type: number + pourcentage_votes: + description: >- + Droits de vote détenus par le bénéficiaire effectif, en + pourcentage des droits de vote totaux. + type: number + format: nullable + pourcentage_votes_directs: + description: >- + Droits de vote détenus de façon directe par le + bénéficiaire effectif, en pourcentage des droits de vote + totaux. + type: number + format: nullable + pourcentage_votes_indirect: + description: >- + Droits de vote détenus de façon indirecte par le + bénéficiaire effectif, en pourcentage des droits de vote + totaux. + type: number + format: nullable + details_votes_directs: + description: >- + Détails des droits de vote détenus de façon directe par le + bénéficiaire effectif. + type: object + format: nullable + properties: + pourcentage_pleine_propriete: + description: >- + Droits de vote détenus de façon directe en pleine + propriété par le bénéficiaire effectif, en pourcentage + des droits de vote totaux. + type: number + pourcentage_nue_propriete: + description: >- + Droits de vote détenus de façon directe en nue + propriété par le bénéficiaire effectif, en pourcentage + des droits de vote totaux. + type: number + pourcentage_usufruit: + description: >- + Droits de vote détenus de façon directe en usufruit + par le bénéficiaire effectif, en pourcentage des + droits de vote totaux. + type: number + details_votes_indirects: + description: >- + Détails des droits de vote détenus de façon indirecte par + le bénéficiaire effectif. + type: object + format: nullable + properties: + pourcentage_en_indivision: + description: >- + Droits de vote détenus de façon indirecte par le biais + d'une indivision par le bénéficiaire effectif, en + pourcentage des droits de vote totaux. + type: number + pourcentage_en_personne_morale: + description: >- + Droits de vote détenus de façon indirecte par le biais + d'une personne morale par le bénéficiaire effectif, en + pourcentage des droits de vote totaux. + type: number + details_en_indivision: + description: >- + Détails des droits de vote détenus de façon indirecte + par le biais d'une indivision par le bénéficiaire + effectif. + type: object + format: nullable + properties: + pourcentage_pleine_propriete: + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une indivision en pleine propriété par le + bénéficiaire effectif, en pourcentage des droits + de vote totaux. + type: number + pourcentage_nue_propriete: + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une indivision en nue propriété par le + bénéficiaire effectif, en pourcentage des droits + de vote totaux. + type: number + pourcentage_usufruit: + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une indivision en usufruit par le + bénéficiaire effectif, en pourcentage des droits + de vote totaux. + type: number + details_en_personne_morale: + description: >- + Détails des droits de vote détenus de façon indirecte + par le biais d'une personne morale par le bénéficiaire + effectif. + type: object + format: nullable + properties: + pourcentage_pleine_propriete: + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une personne morale en pleine propriété + par le bénéficiaire effectif, en pourcentage des + droits de vote totaux. + type: number + pourcentage_nue_propriete: + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une personne morale en nue propriété par + le bénéficiaire effectif, en pourcentage des + droits de vote totaux. + type: number + pourcentage_usufruit: + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une personne morale en usufruit par le + bénéficiaire effectif, en pourcentage des droits + de vote totaux. + type: number + details_societe_de_gestion: + description: Détails sur la société de gestion, le cas échéant. + type: object + format: nullable + properties: + nom: + description: Nom de la société de gestion. + type: string + format: nullable + siren: + description: SIREN de la société de gestion. + type: string + format: nullable + greffe: + description: Greffe de la société de gestion. + type: string + format: nullable + adresse: + description: Adresse de la société de gestion. + type: string + format: nullable + code_postal: + description: Code postal de la société de gestion. + type: string + format: nullable + ville: + description: Ville de la société de gestion. + type: string + format: nullable + detention_pouvoir_decision_ag: + description: >- + Vaut vrai pour les moyens de contrôle sur les organes + d'administration, de gestion, de direction ou de + surveillance de la personne morale autre que le pouvoir de + nommer ou de révoquer la majorité des membres. + type: boolean + detention_pouvoir_nom_membre_conseil_administration: + description: >- + Vaut vrai si le moyen de contrôle est le pouvoir de nommer + ou de révoquer la majorité des membres des organes + d'administration, de gestion, de direction ou de + surveillance de la personne morale. + type: boolean + detention_autres_moyens_controle: + description: Vaut vrai s'il existe d'autres moyens de contrôle. + type: boolean + beneficiaire_representant_legal: + description: >- + Vaut vrai dans le cas où le bénéficiaire effectif a été + défini comme le représentant légal par défaut. + type: boolean + representant_legal_placement_sans_gestion_delegation: + description: >- + Vaut vrai dans le cas où le bénéficiaire effectif est le + représentant légal du placement collectif (cas où le + placement collectif n'a pas délégué sa gestion à une + société de gestion). + type: boolean + personne_politiquement_exposee: + $ref: '#/components/schemas/PersonnePolitiquementExposee' + sanctions_en_cours: + description: >- + Vaut vrai si le bénéficiaire effectif est actuellement + sous sanction. Uniquement présent si demandé dans les + champs supplémentaires. + type: boolean + format: optional + sanctions: + description: >- + Liste des sanctions du bénéficiaire effectif. Uniquement + présent si demandé dans les champs supplémentaires. + type: array + items: + $ref: '#/components/schemas/Sanction' + depots_actes: + description: Liste des actes de l'entreprise. + type: array + items: + type: object + properties: + date_depot: + description: Date de dépôt de l'acte, au format AAAA-MM-JJ. + type: string + format: date + example: '2020-04-07' + date_depot_formate: + description: Date de dépôt formatée de l'acte, au format JJ/MM/AAAA. + type: string + example: 07/04/2020 + disponible: + description: >- + Disponibilité de l'acte. Un acte peut être indisponible + car il a été publié avant le 1er janvier 1993 ou bien car + il est confidentiel. + type: boolean + nom_fichier_pdf: + description: Nom du fichier pdf de l'acte. + type: string + example: GOOGLE FRANCE - Actes du 07-04-2020.pdf + token: + description: Token de l'acte. + type: string + example: >- + QTQ0MzA2MTg0MTIwMjAwNDA3RMOpY2lzaW9uKHMpIGRlIGwnYXNzb2Npw6kgdW5pcXVl + actes: + description: Détails de l'acte. + type: array + items: + type: object + properties: + type: + description: Type de l'acte. + type: string + example: Décision(s) de l'associé unique + decision: + description: Décision de l'acte. + type: string + format: nullable + example: Augmentation du capital social + date_acte: + description: Date de l'acte, au format AAAA-MM-JJ. + type: string + format: date nullable + example: '2020-03-04' + date_acte_formate: + description: Date formatée de l'acte, au format JJ/MM/AAAA. + type: string + format: nullable + example: 04/03/2020 + comptes: + description: Liste des comptes de l'entreprise. + type: array + items: + type: object + properties: + date_depot: + description: Date de dépôt des comptes. + type: string + format: date + example: '2020-07-16' + date_depot_formate: + description: Date de dépôt formatée des comptes. + type: string + example: 16/07/2020 + date_cloture: + description: Date de clôture des comptes, au format AAAA-MM-JJ. + type: string + format: date + example: '2019-12-31' + annee_cloture: + description: Année de clôture des comptes. + type: integer + example: 2019 + confidentialite: + description: Confidentialité totale des comptes. + type: boolean + confidentialite_compte_de_resultat: + description: >- + Confidentialité partielle des comptes (seul le compte de + résultat est confidentiel, le reste des comptes sont + disponibles). + type: boolean + disponible: + description: Disponibilité des comptes au format PDF. + type: boolean + nom_fichier_pdf: + description: Nom du fichier PDF des comptes. + type: string + format: optional + example: GOOGLE FRANCE - Comptes 2019.pdf + token: + description: Token des comptes. + type: string + format: optional + example: QzQ0MzA2MTg0MTIwMjAwNzE2 + disponible_xlsx: + description: Disponibilité des comptes au format XLSX. + type: boolean + nom_fichier_xlsx: + description: Nom du fichier XLSX des comptes. + type: string + format: optional + example: GOOGLE FRANCE - Comptes 2019.xlsx + token_xlsx: + description: Token des comptes XLSX. + type: string + format: optional + example: ASQSMAA2MTg8MTIwMjAwNz2s + publications_bodacc: + description: Liste des publications au Bodacc de l'entreprise. + type: array + items: + $ref: '#/components/schemas/Bodacc' + procedures_collectives: + description: Liste des procédures collectives de l'entreprise. + type: array + items: + type: object + properties: + type: + description: Type de la procédure collective. + type: string + example: Redressement judiciaire + enum: + - Redressement judiciaire + - Liquidation judiciaire ou Procédure de sauvegarde + date_debut: + description: >- + Date de début de la procédure collective, au format + AAAA-MM-JJ. + type: string + example: '2020-04-16T00:00:00.000Z' + date_fin: + description: >- + Date de fin de la procédure collective, au format + AAAA-MM-JJ. + type: string + example: '2020-08-27T00:00:00.000Z' + publications_bodacc: + description: >- + Liste des publications relatives à la procédure + collective. + type: array + items: + $ref: '#/components/schemas/Bodacc' + procedure_collective_existe: + description: >- + Vrai si l'entreprise a des procédures collectives (en cours ou + terminées), faux sinon. + type: boolean + procedure_collective_en_cours: + description: >- + Vrai si l'entreprise a des procédures collectives en cours, faux + sinon. + type: boolean + derniers_statuts: + description: Liste des statuts de l'entreprise. + type: object + properties: + date_depot: + description: Date de dépôt des statuts, au format AAAA-MM-JJ. + type: string + format: date + example: '2020-04-07' + date_depot_formate: + description: Date de dépôt formaté des statuts, au format JJ/MM/AAAA. + type: string + example: 07/04/2020 + disponible: + description: Disponibilité des statuts. + type: boolean + nom_fichier_pdf: + description: Nom du fichier pdf des statuts. + type: string + example: GOOGLE FRANCE - Actes du 07-04-2020.pdf + token: + description: Token des statuts. + type: string + example: >- + QTQ0MzA2MTg0MTIwMjAwNDA3RMOpY2lzaW9uKHMpIGRlIGwnYXNzb2Npw6kgdW5pcXVl + type: + description: Champ "type" du document contenant les statuts. + type: string + example: Statuts mis à jour + decision: + description: Champ "decision" du document contenant les statuts. + type: string + format: nullable + example: null + date_acte: + description: Date de publication des statuts, au format AAAA-MM-JJ. + type: string + format: date + example: '2020-03-04' + date_acte_formate: + description: Date de publication des statuts, au format JJ/MM/AAAA. + type: string + example: 04/03/2020 + extrait_immatriculation: + description: Extrait d'immatriculation de l'entreprise. + type: object + properties: + token: + description: Token + type: string + example: SzQ0MzA2MTg0MQ + rnm: + description: >- + Informations sur l'immatriculation de l'entreprise au Répertoire + des Métiers. + type: object + format: nullable + properties: + date_immatriculation: + description: >- + Date d'immatriculation au Répertoire des Métiers, au format + AAAA-MM-JJ. + type: string + example: '2021-02-16T00:00:00.000Z' + date_radiation: + description: >- + Date de radiation du Répertoire des Métiers, le cas échéant, + au format AAAA-MM-JJ. + type: string + format: nullable + example: null + date_debut_activite: + description: >- + Date de début d'activé déclarée au Répertoire des Métiers, + au format AAAA-MM-JJ. + type: string + example: '2021-01-01T00:00:00.000Z' + date_cessation_activite: + description: >- + Date de cessation d'activité déclarée au Répertoire des + Métiers, le cas échéant, au format AAAA-MM-JJ. + type: string + format: nullable + example: null + chambre_des_metiers: + description: Chambre des métiers où l'entreprise est immatriculée. + type: string + example: TARN-ET-GARONNE + qualification: + description: Qualification retenue par le Répertoire des Métiers. + type: string + example: ARTISAN + derniere_mise_a_jour: + description: >- + Date de dernière mise à jour de l'entreprise au Répertoire + des Métiers, au format AAAA-MM-JJ. + type: string + example: '2021-02-22T00:00:00.000Z' + marques: + description: >- + Liste des marques françaises déposées par l'entreprise. + Uniquement présent si le paramètre "marques" a été mis à vrai. + type: array + items: + type: object + properties: + numero: + description: Numéro de la marque. + type: string + example: FR7103728 + date_enregistrement: + description: Date d'enregistrement de la marque, au format AAAA-MM-JJ. + type: string + example: '2008-12-04T00:00:00.000Z' + date_expiration: + description: Date d'expiration de la marque au format AAAA-MM-JJ. + type: string + example: '2018-12-04T00:00:00.000Z' + lieu_enregistrement: + description: Lieu d'enregistrement de la marque. + type: string + example: 92 INPI - Dépôt électronique + statut: + description: >- + Statut de la marque. La description des différents types + est disponible en page 14 du document suivant : + https://www.inpi.fr/sites/default/files/doctech_marques_v1.6.pdf. + type: string + enum: + - Demande déposée + - Demande publiée + - Demande non publiée + - Demande irrecevable après publication + - Marque enregistrée + - Renouvellement demandé + - Marque renouvelée + - Demande totalement rejetée + - Marque ayant fait l'objet d'une renonciation totale + - Marque ayant fait l'objet d'un retrait total + - Marque annulée + - Marque expirée + example: Marque enregistrée + texte: + description: Texte de la marque. + type: string + format: nullable + example: Google + type: + description: Type de la marque. + type: string + enum: + - Mixte + - Figuratif + - Hologramme + - Son + - Texte + - 3D + - Position + - Mouvement + - Multimedia + - Motifs + - Couleur + - Forme + - Autre + example: Figurative + lien_image: + description: Lien vers l'image déposée. + type: string + format: nullable + example: https://data.inpi.fr/image/marques/FRXXXXXXXX + descriptions: + description: Liste des descriptions de la marque. + type: array + items: + description: Description + type: string + example: 'Demande d’extension : Polynésie française' + classes: + description: >- + Liste des classes (produits et services) de la marque. La + liste des classes est disponible sur le document suivant : + https://www.inpi.fr/sites/default/files/classification_nice_2021_0.pdf. + type: array + items: + type: object + properties: + description: + description: Description de la classe. + type: string + example: >- + Publicité ; gestion des affaires commerciales ; + administration commerciale ; travaux de bureau. + code: + description: Code de la classe. + type: string + example: 35 + deposant: + $ref: '#/components/schemas/PersonneMarque' + mandataire: + $ref: '#/components/schemas/PersonneMarque' + evenements: + description: Liste des événements associés à la marque. + type: array + items: + type: object + properties: + type: + description: Type d'événement. + type: string + example: Publication + identifiant_evenement: + description: Identifiant de l'événement. + type: string + format: nullable + reference: + description: Référence de l'événement. + type: string + format: nullable + date: + description: Date de l'événement, au format AAAA-MM-JJ. + type: string + example: '2008-12-04T00:00:00.000Z' + numero_bopi: + description: Numéro du BOPI dans lequel l'événement a été publié. + type: string + example: 2008-12 + date_bopi: + description: Date de publication du BOPI au format AAAA-MM-JJ. + type: string + example: '2008-12-04T00:00:00.000Z' + beneficiaire: + description: Bénéficiaire associé à l'événement. + type: string + format: nullable + association: + $ref: '#/components/schemas/Association' + labels: + description: >- + Liste des labels de l'entreprise. Uniquement présent si demandé + dans les champs supplémentaires. + type: array + items: + $ref: '#/components/schemas/Labels' + scoring_non_financier: + $ref: '#/components/schemas/ScoringNonFinancier' + scoring_financier: + $ref: '#/components/schemas/ScoringFinancier' + EntrepriseRecherche: + allOf: + - $ref: '#/components/schemas/EntrepriseBase' + - type: object + properties: + siege: + $ref: '#/components/schemas/EtablissementRecherche' + villes: + description: Liste des villes où l'entreprise a au moins un établissement. + type: array + items: + type: string + example: MONTPELLIER + chiffre_affaires: + description: Chiffre d'affaires de l'entreprise. + type: integer + format: nullable + example: 411016329 + resultat: + description: Résultat de l'entreprise. + type: integer + format: nullable + example: 29327087 + effectifs_finances: + description: Effectif de l'entreprise. + type: integer + format: nullable + example: 723 + annee_finances: + description: >- + Année de correspondance des variables financières + (chiffre_affaires, resultat, effectifs_finances). + type: string + format: nullable + example: '2018' + EtablissementFiche: + type: object + properties: + siret: + description: Numéro siret de l'établissement au format xxxxxxxxxxxxxx. + type: string + example: '44306184100047' + siret_formate: + description: Numéro siret de l'établissement au format xxx xxx xxx xxxxx. + type: string + example: 443 061 841 00047 + diffusion_partielle: + description: >- + Si vrai, l'établissement est en diffusion partielle. Dans ce cas, + tous les champs relatifs à son adresse - en dehors de la ville et du + pays - sont à `null`. + type: boolean + nic: + description: Numéro NIC de l'établissement. + type: string + example: '00047' + code_postal: + description: Code postal de l'établissement. + type: string + format: nullable + example: '75009' + ville: + description: Ville de l'établissement. + type: string + format: nullable + example: PARIS 9 + pays: + description: Pays de l'établissement + type: string + format: nullable + example: France + code_pays: + description: Code du pays de l'établissement + type: string + format: nullable + example: FR + latitude: + description: Latitude de l'établissement. + type: number + format: nullable + example: 48.876947 + longitude: + description: Longitude de l'établissement. + type: number + format: nullable + example: 2.329981 + etablissement_cesse: + description: Vrai si l'établissement est cessé, faux si il est en activité. + type: boolean + format: nullable + siege: + description: Vrai si l'établissement est siège, faux s'il ne l'est pas. + type: boolean + format: nullable + etablissement_employeur: + description: Si vrai, l'établissement a au moins un employé. + type: boolean + format: nullable + effectif: + description: Tranche d'effectif de l'établissement. + type: string + format: nullable + example: Entre 500 et 999 salariés + effectif_min: + description: Effectif minimal de l'établissement. + type: integer + format: nullable + example: 500 + effectif_max: + description: Effectif maximal de l'établissement. + type: integer + format: nullable + example: 999 + tranche_effectif: + description: >- + Tranche d'effectif de l'établissement, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen#:~:text=Cette%20variable%20correspond%20%C3%A0%20la,effectif%20salari%C3%A9%20de%20l'entreprise.). + type: string + format: nullable + example: '41' + annee_effectif: + description: Année correspondante à la tranche d'effectif de l'établissement. + type: integer + format: nullable + example: 2017 + code_naf: + description: Code NAF de l'établissement. + type: string + format: nullable + example: 70.10Z + libelle_code_naf: + description: Libellé du code NAF de l'établissement. + type: string + format: nullable + example: Activités des sièges sociaux + date_de_creation: + type: string + format: nullable + example: '2011-05-12T22:00:00.000Z' + numero_voie: + description: Numéro de voie de l'établissement. + type: integer + format: nullable + example: 8 + indice_repetition: + description: Indice de répétition de l'établissement. + type: string + format: nullable + example: null + type_voie: + description: Type de voie de l'établissement. + type: string + format: nullable + example: RUE + libelle_voie: + description: Libellé de la voie de l'établissement. + type: string + format: nullable + example: DE LONDRES + complement_adresse: + description: Complément d'adresse de l'établissement. + type: string + format: nullable + example: null + adresse_ligne_1: + description: >- + Première ligne de l'adresse de l'établissement. Correspond à + l'ensemble des données numero_voie, indice_repetition, type_voie et + libelle_voie. + type: string + format: nullable + example: 8 RUE DE LONDRES + adresse_ligne_2: + description: >- + Seconde ligne de l'adresse de l'établissement. Est égal à + complement_adresse + type: string + format: nullable + example: null + date_cessation: + description: Date de fermeture de l'établissement + type: string + format: nullable + example: '2014-05-12' + enseigne: + description: Enseigne de l'établissement + type: string + format: nullable + example: FROOGLE + nom_commercial: + description: Nom commercial de l'établissement + type: string + format: nullable + example: Froogle + domiciliation: + type: object + format: nullable + properties: + nom: + description: Nom de l'entreprise de domiciliation + type: string + format: nullable + example: WORK & SHARE + siren: + description: Siren de l'entreprise de domiciliation + type: string + format: nullable + example: '828053546' + predecesseurs: + description: Liste des prédécesseurs de l'établissement. + type: array + format: optional + items: + $ref: '#/components/schemas/LienSuccession' + successeurs: + description: Liste des successeurs de l'établissement. + type: array + format: optional + items: + $ref: '#/components/schemas/LienSuccession' + EtablissementRecherche: + type: object + properties: + siret: + description: Numéro siret de l'établissement au format xxxxxxxxxxxxxx. + type: string + example: '44306184100047' + siret_formate: + description: Numéro siret de l'établissement au format xxx xxx xxx xxxxx. + type: string + example: 443 061 841 00047 + nic: + description: Numéro NIC de l'établissement. + type: string + example: '00047' + numero_voie: + description: Numéro de voie de l'établissement. + type: integer + format: nullable + example: 8 + indice_repetition: + description: Indice de répétition de l'établissement. + type: string + format: nullable + example: null + type_voie: + description: Type de voie de l'établissement. + type: string + format: nullable + example: RUE + libelle_voie: + description: Libellé de la voie de l'établissement. + type: string + format: nullable + example: DE LONDRES + complement_adresse: + description: Complément d'adresse de l'établissement. + type: string + format: nullable + example: null + adresse_ligne_1: + description: >- + Première ligne de l'adresse de l'établissement. Correspond à + l'ensemble des données numero_voie, indice_repetition, type_voie et + libelle_voie. + type: string + format: nullable + example: 8 RUE DE LONDRES + adresse_ligne_2: + description: >- + Seconde ligne de l'adresse de l'établissement. Est égal à + complement_adresse + type: string + format: nullable + example: null + code_postal: + description: Code postal de l'établissement. + type: string + format: nullable + example: '75009' + ville: + description: Ville de l'établissement. + type: string + format: nullable + example: PARIS 9 + latitude: + description: Latitude de l'établissement. + type: number + format: nullable + example: 48.876947 + longitude: + description: Longitude de l'établissement. + type: number + format: nullable + example: 2.329981 + RepresentantSuggestions: + type: object + properties: + qualite: + description: Qualité du représentant. + type: string + example: Gérant + personne_morale: + description: >- + Vrai si le représentant est une personne morale, faux si personne + physique. + type: boolean + example: false + date_prise_de_poste: + description: Date de prise de poste du représentant. + type: string + example: '2017-08-03' + denomination: + description: Dénomination du représentant si personne morale. + type: string + format: optional + example: GOOGLE FRANCE + siren: + description: Siren du représentant si personne morale. + type: string + format: optional + example: '443061841' + forme_juridique: + description: Forme juridique du représentant si personne morale. + type: string + format: optional + example: Société par actions simplifiée + sexe: + description: >- + Sexe supposé du représentant si personne physique. F pour féminin, M + pour masculin. Ce champ est estimé à partir du prénom du + représentant. + type: string + format: optional + example: M + nom: + description: Nom du représentant. + type: string + format: optional + example: Yi + prenom: + description: Prénoms du représentant. + type: string + format: optional + example: Kenneth H. + prenom_usuel: + description: Prénom usuel du représentant. + type: string + format: optional + example: Kenneth + nom_complet: + description: Nom complet du représentant. + type: string + example: Kenneth H. Yi + date_de_naissance: + description: Date de naissance du représentant. + type: string + format: optional nullable + example: '1970-01-06' + date_de_naissance_formate: + description: Date de naissance formatée du représentant. + type: string + format: optional nullable + example: 06/01/1970 + age: + description: Age du représentant. + type: integer + format: optional + example: 50 + nationalite: + description: Nationalité du représentant. + type: string + format: optional + example: Américaine (Etats Unis) + code_nationalite: + description: Code nationalité du représentant + type: string + format: optional + example: US + ville_de_naissance: + description: Ville de naissance du représentant. + type: string + format: optional + example: Séoul + pays_de_naissance: + description: Pays de naissance du représentant. + type: string + format: optional + example: COREE DU SUD + code_pays_de_naissance: + description: Code du pays de naissance du représentant. + type: string + format: optional + example: KR + adresse_ligne_1: + description: Première ligne de l'adresse du représentant. + type: string + format: nullable + example: 1600 Amphitheatre Parkway Mountain View CA 94043 + adresse_ligne_2: + description: Deuxième ligne de l'adresse du représentant. + type: string + format: nullable + example: null + adresse_ligne_3: + description: Troisième ligne de l'adresse du représentant. + type: string + format: nullable + example: null + code_postal: + description: Code postal du représentant. + type: string + format: nullable + example: null + ville: + description: Ville du représentant. + type: string + format: nullable + example: null + pays: + description: Pays du représentant. + type: string + format: nullable + example: Etats-Unis + code_pays: + description: Code du pays du représentant + type: string + format: nullable + example: US + Representant: + type: object + properties: + qualite: + description: Qualité du représentant. + type: string + example: Gérant + personne_morale: + description: >- + Vrai si le représentant est une personne morale, faux si personne + physique. + type: boolean + example: false + date_prise_de_poste: + description: Date de prise de poste du représentant. + type: string + example: '2017-08-03' + denomination: + description: Dénomination du représentant si personne morale. + type: string + format: optional + example: GOOGLE FRANCE + siren: + description: Siren du représentant si personne morale. + type: string + format: optional + example: '443061841' + forme_juridique: + description: Forme juridique du représentant si personne morale. + type: string + format: optional + example: Société par actions simplifiée + sexe: + description: >- + Sexe supposé du représentant si personne physique. F pour féminin, M + pour masculin. Ce champ est estimé à partir du prénom du + représentant. + type: string + format: optional + example: M + nom: + description: Nom du représentant. + type: string + format: optional + example: Yi + prenom: + description: Prénoms du représentant. + type: string + format: optional + example: Kenneth H. + prenom_usuel: + description: Prénom usuel du représentant. + type: string + format: optional + example: Kenneth + nom_complet: + description: Nom complet du représentant. + type: string + example: Kenneth H. Yi + date_de_naissance: + description: Date de naissance du représentant. + type: string + format: optional nullable + example: '1970-01-06' + date_de_naissance_formate: + description: Date de naissance formatée du représentant. + type: string + format: optional nullable + example: 06/01/1970 + age: + description: Age du représentant. + type: integer + format: optional + example: 50 + nationalite: + description: Nationalité du représentant. + type: string + format: optional + example: Américaine (Etats Unis) + code_nationalite: + description: Code nationalité du représentant + type: string + format: optional + example: US + ville_de_naissance: + description: Ville de naissance du représentant. + type: string + format: optional + example: Séoul + pays_de_naissance: + description: Pays de naissance du représentant. + type: string + format: optional + example: COREE DU SUD + code_pays_de_naissance: + description: Code du pays de naissance du représentant. + type: string + format: optional + example: KR + adresse_ligne_1: + description: Première ligne de l'adresse du représentant. + type: string + format: nullable + example: 1600 Amphitheatre Parkway Mountain View CA 94043 + adresse_ligne_2: + description: Deuxième ligne de l'adresse du représentant. + type: string + format: nullable + example: null + adresse_ligne_3: + description: Troisième ligne de l'adresse du représentant. + type: string + format: nullable + example: null + code_postal: + description: Code postal du représentant. + type: string + format: nullable + example: null + ville: + description: Ville du représentant. + type: string + format: nullable + example: null + pays: + description: Pays du représentant. + type: string + format: nullable + example: Etats-Unis + code_pays: + description: Code du pays du représentant + type: string + format: nullable + example: US + personne_politiquement_exposee: + $ref: '#/components/schemas/PersonnePolitiquementExposee' + sanctions_en_cours: + description: >- + Vaut vrai si le représentant est actuellement sous sanction. + Uniquement présent si demandé dans les champs supplémentaires. + type: boolean + format: optional + sanctions: + description: >- + Liste des sanctions du représentant. Uniquement présent si demandé + dans les champs supplémentaires. + type: array + items: + $ref: '#/components/schemas/Sanction' + PersonnePolitiquementExposee: + description: >- + Informations sur le statut de personne politiquement exposée. Uniquement + présent si demandé dans les champs supplémentaires. + type: object + format: optional + properties: + en_cours: + description: Vaut vrai si la personne est actuellement politiquement exposée. + type: boolean + format: nullable + fonctions: + description: >- + Liste des fonctions actuelles et passées de la personne + politiquement exposée. + type: array + items: + type: object + properties: + fonction: + description: Nom de la fonction. + type: string + example: Premier ministre + pays: + description: Pays associé à la fonction. + type: string + format: nullable + example: France + code_pays: + description: Code pays associé à la fonction. + type: string + format: nullable + example: FR + en_cours: + description: Vaut vrai si la fonction est en cours. + type: boolean + format: nullable + example: true + date_debut: + description: Date de début de la fonction. + type: string + format: nullable + example: '2020-08-20' + date_fin: + description: Date de fin de la fonction. + type: string + format: nullable + example: '2022-08-20' + sources: + description: Liste des sources. + type: array + items: + type: object + properties: + nom: + description: Nom de la source. + type: string + example: CIA World Factbook heads of state and government + url: + description: Lien vers la source. + type: string + format: nullable + example: >- + https://www.opensanctions.org/datasets/us_cia_world_factbook + Sanction: + type: object + format: optional + properties: + description: + description: Description de la sanction. + type: string + example: Interdiction de gérer + autorite: + description: Autorité ayant prononcé la sanction. + type: string + format: nullable + example: Tribunal de commerce de Paris + pays: + description: Pays de la sanction. + type: string + format: nullable + example: France + code_pays: + description: Code du pays de la sanction. + type: string + format: nullable + example: FR + en_cours: + description: Vaut vrai si la sanction est en cours. + type: boolean + format: nullable + example: false + date_debut: + description: Date de début de la sanction. + type: string + format: nullable + example: '2020-08-20' + date_fin: + description: Date de fin de la sanction. + type: string + format: nullable + example: '2022-08-20' + sources: + description: Liste des sources. + type: array + items: + type: object + properties: + nom: + description: Nom de la source. + type: string + example: CIA World Factbook heads of state and government + url: + description: Lien vers la source. + type: string + format: nullable + example: https://www.opensanctions.org/datasets/us_cia_world_factbook + RepresentantRecherche: + allOf: + - $ref: '#/components/schemas/Representant' + - type: object + properties: + actuel: + description: Vaut vrai si le représentant est toujours à son poste. + type: boolean + date_depart_de_poste: + description: >- + Date de départ de poste dans le cas où le représentant n'est + plus un représentant actuel, au format AAAA-MM-JJ. + type: string + example: null + forme_juridique: + description: >- + Forme juridique du représentant dans le cas d'une personne + morale. + type: string + format: nullable + example: null + Beneficiaire: + type: object + properties: + nom: + description: Nom du bénéficiaire effectif. + type: string + format: nullable + example: Yi + nom_usage: + description: Nom d'usage du bénéficiaire effectif. + type: string + format: nullable + example: null + prenom: + description: Prénom du bénéficiaire effectif. + type: string + example: Kenneth H. + pseudonyme: + description: Pseudonyme du bénéficiaire effectif. + type: string + format: nullable + example: null + nom_complet: + description: Nom complet du bénéficiaire effectif. + type: string + example: Kenneth H. Yi + date_de_naissance_formate: + description: >- + Mois et année de naissance du bénéficiaire effectif, au format + MM/AAAA. + type: string + example: 01/1970 + nationalite: + description: Nationalité du bénéficiaire effectif. + type: string + example: Française + pourcentage_parts: + description: >- + Parts détenues par le bénéficiaire effectif, en pourcentage des + parts totales. + type: number + pourcentage_votes: + description: >- + Droits de vote détenus par le bénéficiaire effectif, en pourcentage + des droits de vote totaux. + type: number + pourcentage_votes_indirect: + description: >- + Droits de vote détenus de façon indirecte par le bénéficiaire + effectif, en pourcentage des droits de vote totaux. + type: number + pourcentage_votes_directs: + description: >- + Droits de vote détenus de façon directe par le bénéficiaire + effectif, en pourcentage des droits de vote totaux. + type: number + detention_autres_moyens_controle: + description: Vaut vrai s'il existe d'autres moyens de contrôle. + type: boolean + beneficiaire_representant_legal: + description: >- + Vaut vrai dans le cas où le bénéficiaire effectif a été défini comme + le représentant légal par défaut. + type: boolean + adresse_ligne_1: + description: Première ligne de l'adresse du bénéficiaire effectif. + type: string + format: nullable + example: null + adresse_ligne_2: + description: Deuxième ligne de l'adresse du bénéficiaire effectif. + type: string + format: nullable + example: null + adresse_ligne_3: + description: Troisième ligne de l'adresse du bénéficiaire effectif. + type: string + format: nullable + example: null + pourcentage_parts_vocation_titulaire: + description: >- + Parts dont le bénéficiaire effectif a vocation à devenir titulaire + par l'effet d'un acte juridique, en pourcentage des parts totales. + type: number + representant_legal_placement_sans_gestion_delegation: + description: >- + Vaut vrai dans le cas où le bénéficiaire effectif est le + représentant légal du placement collectif (cas où le placement + collectif n'a pas délégué sa gestion à une société de gestion). + type: boolean + format: nullable + code_postal: + description: Code postal du bénéficiaire effectif. + type: string + format: nullable + example: null + detention_pouvoir_nom_membre_conseil_administration: + description: >- + Vaut vrai si le moyen de contrôle est le pouvoir de nommer ou de + révoquer la majorité des membres des organes d'administration, de + gestion, de direction ou de surveillance de la personne morale. + type: boolean + ville: + description: Ville du bénéficiaire effectif. + type: string + format: nullable + example: null + date_de_naissance_complete_formatee: + description: >- + Date de naissance complète du bénéficiaire effectif, au format + JJ/MM/AAAA. + type: string + format: date + example: 14/08/1953 + pourcentage_parts_directes: + description: >- + Parts détenues de façon directe par le bénéficiaire effectif, en + pourcentage des parts totales. + type: number + pourcentage_parts_indirectes: + description: >- + Parts détenues de façon indirecte par le bénéficiaire effectif, en + pourcentage des parts totales. + type: number + pays_de_naissance: + description: Pays de naissance du bénéficiaire effectif. + type: string + format: nullable + example: null + code_pays_de_naissance: + description: Code du pays de naissance du bénéficiaire effectif. + type: string + format: nullable + example: null + ville_de_naissance: + description: Ville de naissance du bénéficiaire effectif. + type: string + format: nullable + example: null + detention_pouvoir_decision_ag: + description: >- + Vaut vrai pour les moyens de contrôle sur les organes + d'administration, de gestion, de direction ou de surveillance de la + personne morale autre que le pouvoir de nommer ou de révoquer la + majorité des membres. + type: boolean + pays: + description: Pays du bénéficiaire effectif. + type: string + format: nullable + example: null + date_de_naissance_formatee: + description: >- + Mois et année de naissance du bénéficiaire effectif, au format + MM/AAAA. + type: string + format: nullable + example: null + code_pays: + description: Code pays du bénéficiaire effectif. + type: string + format: nullable + example: null + Document: + type: object + properties: + type: + description: Type de document + type: string + enum: + - acte + - comptes + example: acte + date_depot: + description: Date de dépôt du document + type: string + format: date + example: '2020-08-04T00:00:00.000Z' + mentions: + description: Mentions de la recherche dans le document. + type: array + items: + type: string + discriminator: + propertyName: type + mapping: + acte: '#/components/schemas/DocumentActe' + comptes: '#/components/schemas/DocumentComptes' + DocumentActe: + allOf: + - $ref: '#/components/schemas/Document' + - type: object + properties: + titres: + description: Titres des actes associés au document + type: array + items: + type: object + properties: + type: + description: Type de l'acte + type: string + example: Décision(s) de l'associé unique + decision: + description: Décision de l'acte + type: string + format: nullable + example: Augmentation du capital social + DocumentComptes: + allOf: + - $ref: '#/components/schemas/Document' + - type: object + properties: + date_cloture: + description: Date de clôture des comptes, au format AAAA-MM-JJ. + type: string + format: date + example: '2019-12-31' + Publication: + type: object + properties: + type: + description: Type de publication + type: string + enum: + - Création + - Immatriculation + - Modification + - Vente + - Radiation + - Procédure collective + - Dépôt des comptes + example: acte + date: + description: Date de publication, au format AAAA-MM-JJ. + type: string + format: date + example: '2020-08-04T00:00:00.000Z' + contenu: + description: >- + Contenu de la publication, avec les mentions correspondant à la + recherche encerclée par une balise HTML . + type: string + Bodacc: + type: object + properties: + numero_parution: + description: Numéro de parution de la publication. + type: string + example: '20200075' + date: + description: Date de la publication, au format AAAA-MM-JJ. + type: string + example: '2020-04-16T00:00:00.000Z' + numero_annonce: + description: Numéro d'annonce de la publication. + type: string + example: '670' + bodacc: + description: Bodacc de la publication (A, B ou C). + type: string + example: B + type: + description: >- + Type de la publication parmi la liste suivante : Création, + Immatriculation, Modification, Vente, Achat, Radiation, Procédure + collective, Dépôt des comptes. + type: string + example: Modification + greffe: + description: Greffe de publication. + type: string + example: Paris + discriminator: + propertyName: type + mapping: + Création: '#/components/schemas/BodaccCreation' + Immatriculation: '#/components/schemas/BodaccImmatriculation' + Modification: '#/components/schemas/BodaccModification' + Vente: '#/components/schemas/BodaccVente' + Achat: '#/components/schemas/BodaccAchat' + Radiation: '#/components/schemas/BodaccRadiation' + Procédure collective: '#/components/schemas/BodaccProcedureCollective' + Dépôt des comptes: '#/components/schemas/BodaccDepotDesComptes' + BodaccCreation: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + type: string + format: nullable + example: GOOGLE FRANCE + personne_morale: + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + type: boolean + format: nullable + example: true + denomination: + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + type: string + format: nullable + example: GOOGLE FRANCE + nom: + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + type: string + format: nullable + prenom: + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + type: string + format: nullable + administration: + description: Administration (dans le cas d'une personne morale). + type: string + format: nullable + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + description: Adresse de l'entreprise concernée par la publication. + type: string + format: nullable + example: 8 rue de Londres 75009 Paris + capital: + description: Capital de l'entreprise concernée par la publication. + type: number + format: nullable + example: 464884017 + activite: + description: Activité de l'entreprise concernée par la publication. + type: string + format: nullable + example: >- + Fourniture de services et/ou conseils relatifs aux logiciels, au + réseau internet. + date_debut_activite: + description: >- + Date de début d'activité de l'entreprise concernée par la + publication, au format AAAA-MM-JJ. + type: string + format: nullable + example: '2020-08-02T00:00:00.000Z' + BodaccImmatriculation: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + type: string + format: nullable + example: GOOGLE FRANCE + personne_morale: + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + type: boolean + format: nullable + example: true + denomination: + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + type: string + format: nullable + example: GOOGLE FRANCE + nom: + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + type: string + format: nullable + prenom: + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + type: string + format: nullable + administration: + description: Administration (dans le cas d'une personne morale). + type: string + format: nullable + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + description: Adresse de l'entreprise concernée par la publication. + type: string + format: nullable + example: 8 rue de Londres 75009 Paris + BodaccModification: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + description: + description: Description de la modification. + type: string + format: nullable + example: modification survenue sur le capital (augmentation) + nom_entreprise: + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + type: string + format: nullable + example: GOOGLE FRANCE + personne_morale: + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + type: boolean + format: nullable + example: true + denomination: + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + type: string + format: nullable + example: GOOGLE FRANCE + nom: + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + type: string + format: nullable + prenom: + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + type: string + format: nullable + administration: + description: Administration (dans le cas d'une personne morale). + type: string + format: nullable + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + description: Adresse de l'entreprise concernée par la publication. + type: string + format: nullable + example: 8 rue de Londres 75009 Paris + capital: + description: Capital de l'entreprise concernée par la publication. + type: number + format: nullable + example: 464884017 + activite: + description: Activité de l'entreprise concernée par la publication. + type: string + format: nullable + example: >- + Fourniture de services et/ou conseils relatifs aux logiciels, au + réseau internet. + BodaccAchat: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + type: string + format: nullable + example: GOOGLE FRANCE + personne_morale: + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + type: boolean + format: nullable + example: true + denomination: + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + type: string + format: nullable + example: GOOGLE FRANCE + nom: + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + type: string + format: nullable + prenom: + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + type: string + format: nullable + administration: + description: Administration (dans le cas d'une personne morale). + type: string + format: nullable + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + description: Adresse de l'entreprise concernée par la publication. + type: string + format: nullable + example: 8 rue de Londres 75009 Paris + commentaires: + description: Commentaires sur la publication. + type: string + format: nullable + oppositions: + description: Détails sur les oppositions. + type: string + format: nullable + declaration_creance: + description: Détails sur la déclaration de créance. + type: string + format: nullable + publication_legale: + description: Journal où a été publiée la publication légale. + type: string + format: nullable + denomination_ancien_proprietaire: + description: Dénomination de l'ancien propriétaire de l'établisement. + type: string + format: optional + siren_ancien_proprietaire: + description: Siren de l'ancien propriétaire de l'établisement. + type: string + format: optional + denomination_ancien_exploitant: + description: Dénomination de l'ancien exploitant de l'établisement. + type: string + format: optional + siren_ancien_exploitant: + description: Siren de l'ancien exploitant de l'établisement. + type: string + format: optional + BodaccVente: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + type: string + format: nullable + example: GOOGLE FRANCE + personne_morale: + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + type: boolean + format: nullable + example: true + denomination: + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + type: string + format: nullable + example: GOOGLE FRANCE + nom: + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + type: string + format: nullable + prenom: + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + type: string + format: nullable + administration: + description: Administration (dans le cas d'une personne morale). + type: string + format: nullable + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + description: Adresse de l'entreprise concernée par la publication. + type: string + format: nullable + example: 8 rue de Londres 75009 Paris + commentaires: + description: Commentaires sur la publication. + type: string + format: nullable + oppositions: + description: Détails sur les oppositions. + type: string + format: nullable + declaration_creance: + description: Détails sur la déclaration de créance. + type: string + format: nullable + publication_legale: + description: Journal où a été publiée la publication légale. + type: string + format: nullable + denomination_nouveau_proprietaire: + description: Dénomination du nouveau propriétaire de l'établisement. + type: string + format: nullable + siren_nouveau_proprietaire: + description: Siren du nouveau propriétaire de l'établisement. + type: string + format: nullable + denomination_nouvel_exploitant: + description: Dénomination du nouvel exploitant de l'établisement. + type: string + format: nullable + siren_nouvel_exploitant: + description: Siren du nouvel exploitant de l'établisement. + type: string + format: nullable + BodaccRadiation: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + BodaccProcedureCollective: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + famille: + description: Famille de la procédure collective + type: string + example: Jugement de clôture + nature: + description: Nature de la procédure collective + type: string + example: Jugement de clôture pour insuffisance d'actif + complement_jugement: + description: Complément sur le jugement de procédure collective + type: string + example: >- + Jugement prononçant la clôture de la procédure de liquidation + judiciaire pour insuffisance d'actif. + BodaccDepotDesComptes: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + date_cloture: + description: Date de clôture des comptes, au format AAAA-MM-JJ. + type: string + example: '2020-08-02T00:00:00.000Z' + type_depot: + description: Type de dépôt de comptes. + type: string + example: Comptes annuels et rapports + descriptif: + description: Descriptif du dépôt de comptes. + type: string + format: nullable + PersonneMarque: + type: object + properties: + siren: + description: Siren de l'entité, dans le cas d'une personne morale. + type: string + entite_legale: + description: Entité légale. + type: string + nom: + description: Nom de l'entité. + type: string + batiment: + description: Bâtiment de l'entité. + type: string + rue: + description: Rue de l'entité. + type: string + ville: + description: Ville de l'entité. + type: string + boite_postale: + description: Boîte postale de l'entité. + type: string + code_postal: + description: Code postal de l'entité. + type: string + code_pays: + description: Code pays de l'entité. + type: string + Ratios: + type: object + properties: + chiffre_affaires: + description: Chiffre d'affaires de l'entreprise. + type: number + format: nullable + example: 411016329 + resultat: + description: Résultat de l'entreprise. + type: number + format: nullable + example: 29327087 + effectif: + description: Effectif de l'entreprise. + type: integer + format: nullable + example: 723 + marge_brute: + description: Marge brute de l'entreprise. + type: number + format: nullable + excedent_brut_exploitation: + description: Excédent brut d'exploitation (EBITDA) de l'entreprise. + type: number + format: nullable + resultat_exploitation: + description: Résultat d'exploitation (EBIT) de l'entreprise. + type: number + format: nullable + taux_croissance_chiffre_affaires: + description: Taux de croissance du chiffre d'affaires (en %) de l'entreprise. + type: number + format: nullable + taux_marge_brute: + description: Taux de marge brute (en %) de l'entreprise. + type: number + format: nullable + taux_marge_EBITDA: + description: Taux de marge d'EBITDA (en %) de l'entreprise. + type: number + format: nullable + taux_marge_operationnelle: + description: Taux de marge opérationnelle (EBIT) (en %) de l'entreprise. + type: number + format: nullable + BFR: + description: BFR (Besoin en fonds de roulement) de l'entreprise. + type: number + format: nullable + BFR_exploitation: + description: BFR exploitation de l'entreprise. + type: number + format: nullable + BFR_hors_exploitation: + description: BFR hors exploitation de l'entreprise. + type: number + format: nullable + BFR_jours_CA: + description: BFR (en jours de CA) de l'entreprise. + type: number + format: nullable + BFR_exploitation_jours_CA: + description: BFR exploitation (en jours de CA) de l'entreprise. + type: number + format: nullable + BFR_hors_exploitation_jours_CA: + description: BFR hors exploitation (en jours de CA) de l'entreprise. + type: number + format: nullable + delai_paiement_clients_jours: + description: Délai de paiement clients (en jours) de l'entreprise. + type: number + format: nullable + delai_paiement_fournisseurs_jours: + description: Délai de paiement fournisseurs (en jours) de l'entreprise. + type: number + format: nullable + ratio_stock_CA_jours: + description: Ratio des stocks / CA (en jours) de l'entreprise. + type: number + format: nullable + capacite_autofinancement: + description: Capacité d'autofinancement de l'entreprise. + type: number + format: nullable + capacite_autofinancement_CA: + description: Capacité d'autofinancement / CA (en %) de l'entreprise. + type: number + format: nullable + fonds_roulement_net_global: + description: Fonds de roulement net global de l'entreprise. + type: number + format: nullable + couverture_BFR: + description: Couverture du BFR de l'entreprise. + type: number + format: nullable + tresorerie: + description: Trésorerie de l'entreprise. + type: number + format: nullable + dettes_financieres: + description: Dettes financières de l'entreprise. + type: number + format: nullable + capacite_remboursement: + description: Capacité de remboursement de l'entreprise. + type: number + format: nullable + ratio_endettement: + description: Ratio d'endettement (Gearing) de l'entreprise. + type: number + format: nullable + autonomie_financiere: + description: Autonomie financière (en %) de l'entreprise. + type: number + format: nullable + taux_levier: + description: Taux de levier (DFN/EBITDA) de l'entreprise. + type: number + format: nullable + etat_dettes_1_an_au_plus: + description: Etat des dettes à 1 an au plus de l'entreprise. + type: number + format: nullable + liquidite_generale: + description: Liquidité générale de l'entreprise. + type: number + format: nullable + couverture_dettes: + description: Couverture des dettes de l'entreprise. + type: number + format: nullable + marge_nette: + description: Marge nette (en %) de l'entreprise. + type: number + format: nullable + rentabilite_fonds_propres: + description: Rentabilité sur fonds propres (en %) de l'entreprise. + type: number + format: nullable + rentabilite_economique: + description: Rentabilité économique (en %) de l'entreprise. + type: number + format: nullable + valeur_ajoutee: + description: Valeur ajoutée de l'entreprise. + type: number + format: nullable + valeur_ajoutee_CA: + description: Valeur ajoutée / CA (en %) de l'entreprise. + type: number + format: nullable + salaires_charges_sociales: + description: Salaires et charges sociales de l'entreprise. + type: number + format: nullable + salaires_CA: + description: Salaires / CA (en %) de l'entreprise. + type: number + format: nullable + impots_taxes: + description: Impôts et taxes de l'entreprise. + type: number + format: nullable + Association: + description: Association liée à l'entreprise. + type: object + format: nullable + properties: + is_waldec: + description: Détermine si l'association possède un numéro WALDEC/RNA. + type: boolean + example: true + id_association: + description: >- + L'identifiant l'association au format Wxxxxxxxxx si WALDEC, + xxxxxxxxxxxxxx sinon. + type: string + example: W142005389 + id_ex_association: + description: Ancien numéro de l'association. + type: string + format: nullable + example: 142004593 + denomination: + description: Dénomination de l'association. + type: string + format: nullable + example: COMITÉ RÉGIONAL DE BRIDGE DE BASSE NORMANDIE + siret: + description: Numéro siret de l'association au format xxxxxxxxxxxxxx. + type: string + format: nullable + example: '95037097300014' + numero_rup: + description: Numéro de Reconnaissance d'Utilité Publique. + type: string + format: nullable + example: null + objet: + description: Objet de l'association. + type: string + format: nullable + example: >- + Grouper tous les clubs et joueurs de bridge de Basse-Normandie de + soutenir leurs efforts et de développer sous toutes ses formes la + pratique du jeu de bridge + objet_social_1: + description: Objet social 1 de l'association. + type: string + format: nullable + example: 7005 + categorie_social_1: + description: Libellé correspondant à l'objet social 1. + type: string + format: nullable + example: Bridge, jeux de cartes, échecs, dames, jeux de société... + objet_social_2: + description: Objet social 2 de l'association. + type: string + format: nullable + example: 0 + categorie_social_2: + description: Libellé correspondant à l'objet social 1. + type: string + format: nullable + example: Non connue + date_creation: + description: Date de déclaration de création au format AAAA-MM-JJ. + type: string + format: nullable + example: '1978-09-28' + date_derniere_declaration: + description: Date de dernière déclaration au format AAAA-MM-JJ. + type: string + format: nullable + example: '2019-09-18' + date_publication_creation: + description: >- + Date de publication du Journal Officiel de l'avis de création au + format AAAA-MM-JJ. + type: string + format: nullable + example: '1978-10-12' + date_declaration_dissolution: + description: Date de déclaration de dissolution au format AAAA-MM-JJ. + type: string + format: nullable + example: '2019-09-18' + groupement: + description: Groupement de l'association. + type: string + format: nullable + example: Simple + position_activite: + description: Position d'activité de l'association. + type: string + format: nullable + example: Active + nature: + description: Nature de l'association. + type: string + format: nullable + example: Simplement Declarée + site_web: + description: Site web de l'association. + type: string + format: nullable + example: null + telephone: + description: Numéro de téléphone de l'association. + type: string + format: nullable + example: null + email: + description: Email de l'association. + type: string + format: nullable + example: null + adresse_siege: + type: object + properties: + code_postal: + description: Code postal du siège social. + type: string + format: nullable + example: '14075' + code_insee: + description: Code insee du siège social. + type: string + format: nullable + example: '14118' + ville: + description: Ville du siège social. + type: string + format: nullable + example: Caen cedex 05 + numero_voie: + description: Numéro de voie du siège social. + type: string + format: nullable + example: 115ter + indice_repetition: + description: Indice de répétition du siège social. + type: string + format: nullable + example: null + type_voie: + description: Type de voie du siège social. + type: string + format: nullable + example: BD + libelle_voie: + description: Libellé de la voie du siège social. + type: string + format: nullable + example: Vanier - La Pierre Heuzé + complement_adresse: + description: Complément de l'adresse du siège social. + type: string + format: nullable + example: null + distribution: + description: Complément de distribution du siege social. + type: string + format: nullable + example: _BP 75156 + adresse_ligne_1: + description: Adresse complète du siège social. + type: string + format: nullable + example: 115ter BD Vanier - La Pierre Heuzé + adresse_ligne_2: + description: Renseignement supplémentaire à l'adresse du siège social. + type: string + format: nullable + example: null + adresse_gestionnaire: + type: object + properties: + gestionnaire: + description: Nom du gestionnaire de l'association. + type: string + format: nullable + example: null + code_postal: + description: Code postal du gestionnaire. + type: string + format: nullable + example: '14075' + ville: + description: Ville du gestionnaire. + type: string + format: nullable + example: CAEN + distribution: + description: Complément de distribution du gestionnaire. + type: string + format: nullable + example: null + adresse_ligne: + description: Adresse complète du gestionnaire. + type: string + format: nullable + example: 115TER BOULEVARD VANIER - LA PIERRE + complement_adresse: + description: Complément de l'adresse du gestionnaire. + type: string + format: nullable + example: null + indication: + description: Indication supplémentaire à l'adresse du gestionnaire. + type: string + format: nullable + example: null + pays: + description: Pays du gestionnaire. + type: string + format: nullable + example: FRANCE + observation: + description: Observation relative à l'association. + type: string + format: nullable + example: Reprise auto => date publication création au JO à vérifier + code_gestion: + description: >- + Code du site gestionnaire (préfecture, sous-préfecture) de + l'association. + type: string + format: nullable + example: 142P + dirigeant_civilite: + description: Civilité du dirigeant. + type: string + format: nullable + example: PM + derniere_maj: + description: >- + Date de la dernière mise à jour des informations au RNA au format + AAAA-MM-JJ. + type: string + format: nullable + example: '2020-03-18' + publications_joafe: + description: Publications JOAFE. + type: object + format: optional + properties: + numero_parution: + description: Numéro de parution JOAFE + type: string + example: '20180024' + date_parution: + description: Date de parution JOAFE au format AAAA-MM-JJ + type: string + example: '2018-06-16' + date_declaration: + description: Date de déclaration au format AAAA-MM-JJ + type: string + example: '2018-06-12' + numero_annonce: + description: Numéro de l'annonce JOAFE + type: integer + example: 1766 + titre: + description: Nom de l'association + type: string + example: ASSOCIATION QUARTIER FOSSES-JEAN + type: + description: Type d'annonce (Création, Modification, Dissolution) + type: string + example: Création + prefecture: + description: Lieu de la déclaration + type: string + example: Hauts-de-Seine + objet: + description: Description de l'association + type: string + format: optional + example: >- + la défense des droits des habitants du quartier auprès + éventuellement des bailleurs sociaux ; aide à la gestion des + problèmes de voisinage ; superviser le prêt des Lieux Communs de + Résidences pour proposer des activités aux jeunes du quartier + (jeux, échanges, anniversaires, prêt de livres ou divers) ; + l'organisation de rencontres pluriculturelles (apprentissage de + l'art culinaire des différentes ethnies qui composent le + quartier) ; organisation de goûter et sorties, vide grenier + annuel ou semestriel plus couramment brocante ; organisation de + rencontres inter-générations retraités qui pourraient apporter + une aide aux devoirs pour les enfants (bénévolement) + site_web: + description: Lien du site web + type: string + format: optional + example: null + adresse: + description: Adresse de l'association + type: string + format: nullable + example: 9, avenue D'Orgemont, 92700 Colombes + ScoringNonFinancier: + description: >- + Score extra-financier de l'entreprise. Uniquement présent si demandé + dans les champs supplémentaires. + type: object + format: optional + properties: + note: + description: Note du score extra-financier de l'entreprise. + type: string + format: nullable + enum: + - A + - B + - C + - D + example: B + score: + description: Score extra-financier de l'entreprise. + type: number + format: nullable + example: 34 + date_calcul: + description: Date de calcul du score extra-financier de l'entreprise. + type: string + format: nullable + example: '2024-01-17' + erreur: + description: Erreur lors du calcul du score extra-financier de l'entreprise. + type: string + format: nullable + enum: + - Données extra financières incomplètes + example: null + ScoringFinancier: + description: >- + Score financier de l'entreprise. Uniquement présent si demandé dans les + champs supplémentaires. + type: object + format: optional + properties: + note: + description: Note du score extra-financier de l'entreprise. + type: string + format: nullable + enum: + - A + - B + - C + - D + - E + - F + - G + example: C + score: + description: Score extra-financier de l'entreprise. + type: number + format: nullable + example: 10 + date_cloture_comptes: + description: Date de clôture des comptes de l'entreprise. + type: string + example: '2021-12-31' + details_score: + description: Détails du score financier. + type: object + format: nullable + properties: + score_ebit_ca: + type: number + format: nullable + example: 3.5 + score_fonds_de_roulement: + type: number + format: nullable + example: 0 + score_tresorerie_nette: + type: number + format: nullable + example: 1 + score_dettes_fiscales_va: + type: number + format: nullable + example: 0.5 + score_cash_flow: + type: number + format: nullable + example: 3.5 + score_dettes_fiscales_ca: + type: number + format: nullable + example: .nan + score_charges_financieres_nettes: + type: number + format: nullable + example: 1.5 + date_calcul: + description: Date de calcul du score extra-financier de l'entreprise. + type: string + format: nullable + example: '2024-01-17' + erreur: + description: Erreur lors du calcul du score extra-financier de l'entreprise. + type: string + format: nullable + enum: + - Données financières incomplètes + - Type de compte non couvert + - Secteur non couvert + - Chiffre d'affaires trop faible + example: null + Labels: + type: object + format: optional + properties: + nom: + description: Nom du label. + type: string + enum: + - RGE + - QUALIOPI + - EGALITE + - BIO + - ESS + - ESUS + - SOCIETE_A_MISSION + - ORIAS + example: RGE + nb_etablissements_concernes: + description: >- + Nombre d'établissements concernés par le label, dans le cas d'un + label lié aux établissements. Null sinon. + type: integer + format: nullable + example: 1 + certificats: + description: 'Label RGE seulement : Liste des certificats.' + type: array + format: optional + items: + description: >- + WARNING: Missing items property in array schema. Missing items + property has been filled with this AnyType schema. + specialites: + description: 'Label QUALIOPI seulement : Liste des spécialités.' + type: array + format: optional + items: + description: >- + WARNING: Missing items property in array schema. Missing items + property has been filled with this AnyType schema. + notes: + description: 'Label EGALITE seulement : Liste des notes.' + type: array + format: optional + items: + description: >- + WARNING: Missing items property in array schema. Missing items + property has been filled with this AnyType schema. + numero_immatriculation: + description: 'Label ORIAS seulement : Numéro d''immatriculation ORIAS.' + type: string + format: optional + inscriptions: + description: 'Label ORIAS seulement : Liste des inscriptions ORIAS.' + type: array + format: optional + items: + description: >- + WARNING: Missing items property in array schema. Missing items + property has been filled with this AnyType schema. + LienSuccession: + type: object + properties: + siret: + description: Numéro siret de l'établissement au format xxxxxxxxxxxxxx. + type: string + example: '44306184100047' + date: + description: Date à laquelle la succession a eu lieu. + type: string + example: '1993-20-02' + transfert_siege: + description: >- + Vrai si le lien de succession concerne l'établissement siège, faux + sinon. + type: boolean + example: false + continuite_economique: + description: >- + Vrai s'il y a [continuité + économique](https://www.sirene.fr/sirene/public/variable/continuiteEconomique), + faux sinon. + type: boolean + example: true + Cartographie: + type: object + properties: + entreprises: + description: Liste des noeuds entreprises. + type: array + items: + type: object + properties: + id: + description: Un identifiant unique du noeud. + type: string + siren: + description: SIREN de l'entreprise. + type: string + nom_entreprise: + description: Nom de l'entreprise. + type: string + personnes: + description: Liste des noeuds personnes (dirigeants ou bénéficiaires effectifs). + type: array + items: + type: object + properties: + id: + description: Un identifiant unique du noeud. + type: string + prenom: + description: SIREN de l'entreprise. + type: string + nom: + description: Nom de l'entreprise. + type: string + niveau: + description: >- + Niveau du noeud. Le niveau 1 correspond aux dirigeants et + bénéficiaires effectifs directement liés à l'entreprise + recherchée. Le niveau 2 correspond aux autres. + type: integer + liens_entreprises_personnes: + description: >- + Liste des arêtes liant les noeuds entreprises avec des noeuds + personnes. + type: array + items: + description: >- + Tableau de 2 éléments, le premier contenant l'identifiant du noeud + entreprise, le second l'identifiant du noeud personne. + type: array + items: + oneOf: + - type: string + pattern: e[0-9]+ + - type: string + pattern: p[0-9]+ + liens_entreprises_entreprises: + description: >- + Liste des arêtes liant les noeuds entreprises avec des d'autres + noeuds entreprises. + type: array + items: + description: >- + Tableau de 2 éléments, chacun étant un identifiant d'un noeud + entreprise. + type: array + items: + type: string + pattern: e[0-9]+ + modifications_effectuees: + description: Description des paramètres ayant été automatiquement modifiés. + type: object + SurveillanceListeDirigeantsAjoutRequest: + type: array + items: + type: object + required: + - siren + properties: + siren: + description: SIREN de la personne morale (si ajout d'une personne morale) + type: string + denomination: + description: >- + Dénomination de la personne morale (si ajout d'une personne + morale) + type: string + nom: + description: Nom de la personne physique (si ajout d'une personne physique) + type: string + prenom: + description: Prénom de la personne physique (si ajout d'une personne physique) + type: string + date_de_naissance: + description: >- + Date de naissance de la personne physique au format AAAA-MM-JJ (si + ajout d'une personne physique) + type: string + recherche_elargie: + description: >- + Active la recherche élargie du dirigeant :
  • Pour une + personne physique : c'est un cas rare mais la date de naissance du + dirigeant n'est pas toujours connue de Pappers. Si vous activer ce + filtre et que la date de naissance est inconnue, l'alerte sera + générée uniquement sur la base du nom et prénom.
  • Pour une + personne morale : c'est un cas rare mais le SIREN du dirigeant + n'est pas toujours connu de Pappers. Si vous activer ce filtre et + que le SIREN est inconnu, l'alerte sera générée uniquement sur la + base de la dénomination. Activable uniquement si le champ + denomination est présent.
+ type: boolean + default: false + example: + - siren: '443061841' + denomination: Google FRANCE + - nom: Yi + prenom: Kenneth H. + date_de_naissance: '1970-01-06' + recherche_elargie: true + SurveillanceAddNotificationsRequest: + type: object + properties: + notifications: + description: Tableau d'identifiant de notifications + type: array + items: + type: string + example: ecfca3e5fb1ce07bb3fdfe8760a28df5aa617ed4951b7f61 + informations: + description: Information à rajouter sur les notifications + type: string + example: Information quelconque + maxLength: 255 + RechercheCriteriaEnterprisesGetResponse: + type: object + properties: + resultats: + description: Liste des entreprises qui correspondent à la recherche. + type: array + items: + allOf: + - $ref: '#/components/schemas/EntrepriseRecherche' + - type: object + properties: + dirigeants: + description: >- + Dirigeants de l'entreprise qui correspondent à la + recherche (si vous recherchez dans la base dirigeants). + type: array + items: + $ref: '#/components/schemas/RepresentantRecherche' + beneficiaires: + description: >- + Bénéficiaires effectifs de l'entreprise qui correspondent + à la recherche (si vous recherchez dans la base + bénéficiaires effectifs). + type: array + items: + $ref: '#/components/schemas/Beneficiaire' + documents: + description: >- + Documents de l'entreprise qui correspondent à la recherche + (si vous recherchez dans la base documents). + type: array + items: + $ref: '#/components/schemas/Document' + publications: + description: >- + Publications de l'entreprise qui correspondent à la + recherche (si vous recherchez dans la base publications). + type: array + items: + allOf: + - $ref: '#/components/schemas/Publication' + - type: object + properties: + mentions: + description: Mentions de la recherche dans la publication. + type: array + items: + type: string + nb_dirigeants_total: + description: Nombre de dirigeants total de l'entreprise. + type: integer + nb_beneficiaires_total: + description: Nombre de bénéficiaires effectifs total de l'entreprise. + type: integer + nb_documents_avec_mentions: + description: >- + Nombre de documents de l'entreprise qui correspondent à la + recherche. + type: integer + nb_documents_total: + description: Nombre de documents total de l'entreprise. + type: integer + nb_publications_avec_mentions: + description: >- + Nombre de publications de l'entreprise qui correspondent à + la recherche. + type: integer + nb_publications_total: + description: Nombre de publications total de l'entreprise. + type: integer + total: + description: Nombre d'entreprises qui correspondent à la recherche. + type: integer + example: 100 + page: + description: Page actuelle. + type: integer + example: 1 + curseurSuivant: + description: >- + Présent uniquement en cas d'utilisation du paramètre `curseur`. + Contient le curseur courant à envoyer en paramètre `curseur` de la + requête suivantes. + type: string + example: QxNRrqKiBFDQq54SpHsrw8r5Z3yWZMDAAzcvwywX + RechercheLeadersSearchCriteriaGetResponse: + type: object + properties: + resultats: + description: Liste des dirigeants qui correspondent à la recherche. + type: array + items: + allOf: + - $ref: '#/components/schemas/RepresentantRecherche' + - type: object + properties: + entreprises: + description: >- + Liste des entreprises du dirigeant, dans la limite de 100 + entreprises. + type: array + items: + $ref: '#/components/schemas/EntrepriseRecherche' + nb_entreprises_total: + description: Nombre d'entreprises du dirigeant au total + type: integer + total: + description: Nombre de dirigeants qui correspondent à la recherche. + type: integer + example: 100 + page: + description: Page actuelle. + type: integer + example: 1 + RechercheEffectiveBeneficiariesSearchResponse: + type: object + properties: + resultats: + description: Liste des bénéficiaires effectifs qui correspondent à la recherche. + type: array + items: + allOf: + - $ref: '#/components/schemas/Beneficiaire' + - type: object + properties: + entreprises: + description: >- + Liste des entreprises dont le bénéficiaire effectif est + bénéficiaire effectif, dans la limite de 100 entreprises. + type: array + items: + $ref: '#/components/schemas/EntrepriseRecherche' + nb_entreprises_total: + description: Nombre d'entreprises du bénéficiaire effectif au total. + type: integer + entreprises_dirigeant: + description: >- + Liste des entreprises dont le bénéficiaire effectif est + dirigeant (sans forcément en être bénéficiaire effectif), + dans la limite de 100 entreprises. + type: array + items: + $ref: '#/components/schemas/EntrepriseRecherche' + nb_entreprises_dirigeant_total: + description: >- + Nombre d'entreprises dont le bénéficiaire effectif est + dirigeant au total. + type: integer + total: + description: Nombre de bénéficiaires effectifs qui correspondent à la recherche. + type: integer + example: 100 + page: + description: Page actuelle. + type: integer + example: 1 + RechercheMatchingDocumentsGetResponse: + type: object + properties: + resultats: + description: Liste des documents qui correspondent à la recherche. + type: array + items: + allOf: + - $ref: '#/components/schemas/Document' + - type: object + properties: + entreprise: + $ref: '#/components/schemas/EntrepriseRecherche' + total: + description: Nombre de documents qui correspondent à la recherche. + type: integer + example: 100 + page: + description: Page actuelle. + type: integer + example: 1 + RechercheMatchingPublicationsGetResponse: + type: object + properties: + resultats: + description: Liste des publications qui correspondent à la recherche. + type: array + items: + allOf: + - $ref: '#/components/schemas/Publication' + - type: object + properties: + entreprise: + $ref: '#/components/schemas/EntrepriseRecherche' + total: + description: Nombre de publications qui correspondent à la recherche. + type: integer + example: 100 + page: + description: Page actuelle. + type: integer + example: 1 + SuggestionsAutocompleteSearchTextResponse: + type: object + properties: + resultats_nom_entreprise: + description: >- + Liste des entreprises dont le nom (dénomination ou nom/prénom) peut + compléter la recherche textuelle. Uniquement présent si le paramètre + `cibles` contient `nom_entreprise`. + type: array + format: optional + items: + allOf: + - type: object + properties: + mention: + description: >- + Nom de l'entreprise, avec le texte recherché encerclé + d'une balise HTML ``. + type: string + - $ref: '#/components/schemas/EntrepriseRecherche' + resultats_denomination: + description: >- + Liste des entreprises dont la dénomination peut compléter la + recherche textuelle (concerne les personnes morales seulement). + Uniquement présent si le paramètre `cibles` contient `denomination`. + type: array + format: optional + items: + allOf: + - type: object + properties: + mention: + description: >- + Dénomination de l'entreprise, avec le texte recherché + encerclé d'une balise HTML ``. + type: string + - $ref: '#/components/schemas/EntrepriseRecherche' + resultats_nom_complet: + description: >- + Liste des entreprises dont le nom complet (nom + prénom ou prénom + + nom) peut compléter la recherche textuelle (concerne les personnes + physiques seulement). Uniquement présent si le paramètre `cibles` + contient `nom_complet`. + type: array + format: optional + items: + allOf: + - type: object + properties: + mention: + description: >- + Nom complet de l'entreprise, avec le texte recherché + encerclé d'une balise HTML ``. + type: string + - $ref: '#/components/schemas/EntrepriseRecherche' + resultats_representant: + description: >- + Liste des représentants dont le nom complet (nom + prénom ou prénom + + nom) peut compléter la recherche textuelle. Uniquement présent si + le paramètre `cibles` contient `representant`. + type: array + format: optional + items: + allOf: + - type: object + properties: + mention: + description: >- + Nom du dirigeant, avec le texte recherché encerclé d'une + balise HTML ``. + type: string + - $ref: '#/components/schemas/RepresentantSuggestions' + resultats_siren: + description: >- + Liste des entreprises dont le numéro SIREN peut compléter la + recherche textuelle. Uniquement présent si le paramètre `cibles` + contient `siren`. + type: array + format: optional + items: + allOf: + - type: object + properties: + mention: + description: >- + SIREN de l'entreprise, avec le texte recherché encerclé + d'une balise HTML ``. + type: string + - $ref: '#/components/schemas/EntrepriseRecherche' + resultats_siret: + description: >- + Liste des entreprises dont le numéro SIRET peut compléter la + recherche textuelle. Uniquement présent si le paramètre `cibles` + contient `siret`. + type: array + format: optional + items: + allOf: + - type: object + properties: + mention: + description: >- + SIRET de l'entreprise, avec le texte recherché encerclé + d'une balise HTML ``. + type: string + - $ref: '#/components/schemas/EntrepriseRecherche' + ComptesAnnuelsGetBySirenResponse: + type: object + additionalProperties: + description: Comptes disponibles pour l'année correspondant à la clé. + type: array + items: + description: Année + type: object + properties: + date_depot: + description: Date de dépôt des comptes, au format AAAA-MM-JJ. + type: string + example: '2021-04-23T00:00:00.000Z' + code_greffe: + description: Code du greffe de dépôt des comptes. + type: string + example: 7501 + numero_depot: + description: Numéro de dépôt des comptes au greffe. + type: string + example: 75548 + numero_gestion: + description: Numéro de gestion au greffe. + type: string + example: 2003B09427 + date_cloture: + description: Date de cloture des comptes, au format AAAA-MM-JJ. + type: string + example: '2020-12-31T00:00:00.000Z' + date_cloture_n-1: + description: >- + Date de cloture des comptes n-1, lorsque présents, au format + AAAA-MM-JJ. + type: string + format: nullable + duree_exercice_n: + description: Durée de l'exercice déposé, en mois. + type: integer + example: 12 + duree_exercice_n-1: + description: Durée de l'exercice précédent, lorsque présent, en mois. + type: integer + format: nullable + type_comptes: + description: >- + Type de comptes (C = complets ; S = simplifiés ; K = consolidés + ; CS = mélange complets/simplifiés ; B = banques ; A = + assurances). + type: string + enum: + - C + - S + - K + - CS + - B + - A + example: C + libelle_type_comptes: + description: Libellé du type de comptes. + type: string + enum: + - Complets + - Simplifiés + - Consolidés + - Complets/Simplifiés + - Banques + - Assurances + example: Complets + devise: + description: Devise des comptes. + type: string + example: EUR + devise_origine: + description: Devise d'origine en cas de conversion. + type: string + format: nullable + confidentialite: + description: Confidentialité totale des comptes. + type: boolean + confidentialite_compte_de_resultat: + description: >- + Confidentialité partielle des comptes (seul le compte de + résultat est confidentiel, le reste des comptes sont + disponibles). + type: boolean + coherence_comptable: + description: >- + Vrai si les comptes sont cohérents d'un point de vue comptable + (équilibre du bilan par exemple). + type: boolean + type_saisie: + description: Description du type de saisie des comptes. + type: string + informations_traitement: + description: Informations complémentaires sur le traitement des comptes. + type: array + format: nullable + items: + type: string + sections: + description: Liste des sections de liasses fiscales. + type: array + items: + type: object + properties: + libelle: + description: Libellé de la section. + type: string + example: Actif (bilan) + liasses: + description: Liste des liasses fiscales de la section. + type: array + items: + type: object + properties: + code: + description: Code de la liasse. + type: string + example: AN + libelle: + description: Libellé de la liasse. + type: string + example: Terrains + colonnes: + description: Colonnes de la liasse. + type: array + items: + type: object + properties: + libelle: + description: Libellé de la colonne. + type: string + example: Montant brut année N + valeur: + description: Valeur de la colonne. + type: integer + example: 60067444 + ratios: + $ref: '#/components/schemas/Ratios' + DocumentsDownloadDocumentByTokenResponse: + type: string + format: binary + DocumentsDownloadPappersExtraitResponse: + type: string + format: binary + DocumentsGetExtraitInpiResponse: + type: string + format: binary + DocumentsDownloadInseeSituationResponse: + type: string + format: binary + DocumentsTelechargementStatutsResponse: + type: string + format: binary + DocumentsTelechargementBeneficiairesEffectifsResponse: + type: string + format: binary + DocumentsDownloadSolvabilityReportResponse: + type: string + format: binary + ConformitPersonnePhysiqueStatusCheckResponse: + type: object + properties: + personne_politiquement_exposee: + $ref: '#/components/schemas/PersonnePolitiquementExposee' + sanctions_en_cours: + description: >- + Vaut vrai si le bénéficiaire effectif est actuellement sous + sanction. Uniquement présent si demandé dans les champs + supplémentaires. + type: boolean + format: optional + sanctions: + description: >- + Liste des sanctions du bénéficiaire effectif. Uniquement présent si + demandé dans les champs supplémentaires. + type: array + items: + $ref: '#/components/schemas/Sanction' + SuiviUtilisationGetTokenUsageResponse: + description: Suivi d'utilisation des jetons. + type: object + properties: + jetons_abonnement: + description: Le nombre de jetons mensuels initiaux de votre abonnement. + type: number + example: 10000 + jetons_abonnement_utilises: + description: >- + Le nombre de jetons mensuels de votre abonnement que vous avez + utilisés + type: number + example: 650 + jetons_pay_as_you_go_restants: + description: Le nombre de jetons pay as you go qu'il vous reste. + type: number + example: 0 + SurveillanceListDeleteResponse: + description: Nombre de notifications supprimées. + type: object + properties: + notifications_supprimees: + description: >- + Le nombre de notifications supprimées de votre liste de + surveillance. + type: number + example: 10 + SurveillanceListeDirigeantsAjoutResponse: + description: Nombre de notifications ajoutées. + type: object + properties: + notifications_ajoutees: + description: >- + Le nombre de dirigeants ajoutées à votre liste de surveillance de + dirigeants. + type: number + example: 0 + default: 0 + SurveillanceListeDirigeantsAjout201Response: + description: Nombre de notifications ajoutées. + type: object + properties: + notifications_ajoutees: + description: >- + Le nombre de dirigeants ajoutées à votre liste de surveillance de + dirigeants. + type: number + example: 10 diff --git a/sdks/db/generate-repository-description-cache/customer-io-data-pipelines.json b/sdks/db/generate-repository-description-cache/customer-io-data-pipelines.json index f183a0f6bd..24d51fb013 100644 --- a/sdks/db/generate-repository-description-cache/customer-io-data-pipelines.json +++ b/sdks/db/generate-repository-description-cache/customer-io-data-pipelines.json @@ -1,3 +1,4 @@ { - "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products. \n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform. \n- Create and manage newsletters, transactional messages, and behavioral messages \n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time. \n\nLearn more: https://customer.io": "Customer.io is a versatile marketing automation tool that uses real-time data to send personalized messages for web and mobile products. Automate product messaging, manage newsletters, transactional messages, and behavioral messages, and connect with other apps for enhanced user engagement." + "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products. \n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform. \n- Create and manage newsletters, transactional messages, and behavioral messages \n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time. \n\nLearn more: https://customer.io": "Customer.io is a versatile marketing automation tool that uses real-time data to send personalized messages for web and mobile products. Automate product messaging, manage newsletters, transactional messages, and behavioral messages, and connect with other apps for enhanced user engagement.", + "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products.\n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform.\n- Create and manage newsletters, transactional messages, and behavioral messages\n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time.\n\nLearn more: https://customer.io": "Customer.io is a versatile marketing automation tool that uses real-time data to deliver personalized messages across web and mobile products, including event reminders, onboarding emails, newsletters, and more. Automate messaging, create newsletters, and connect with other apps to drive user behavior." } \ No newline at end of file diff --git a/sdks/db/generate-repository-description-cache/customer-io-journeys-app.json b/sdks/db/generate-repository-description-cache/customer-io-journeys-app.json index 2a99bce5a4..71991e2ccc 100644 --- a/sdks/db/generate-repository-description-cache/customer-io-journeys-app.json +++ b/sdks/db/generate-repository-description-cache/customer-io-journeys-app.json @@ -1,3 +1,4 @@ { - "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products. \n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform. \n- Create and manage newsletters, transactional messages, and behavioral messages \n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time. \n\nLearn more: https://customer.io": "Customer.io offers versatile marketing automation tools to personalize messages based on user behavior, ensuring timely and relevant communication across web and mobile platforms. Automate product messaging, newsletters, and more with real-time data integration for optimal user engagement and efficiency." + "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products. \n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform. \n- Create and manage newsletters, transactional messages, and behavioral messages \n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time. \n\nLearn more: https://customer.io": "Customer.io offers versatile marketing automation tools to personalize messages based on user behavior, ensuring timely and relevant communication across web and mobile platforms. Automate product messaging, newsletters, and more with real-time data integration for optimal user engagement and efficiency.", + "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products.\n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform.\n- Create and manage newsletters, transactional messages, and behavioral messages\n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time.\n\nLearn more: https://customer.io": "Customer.io is a dynamic tool for personalized marketing automation. Utilize real-time data to send targeted messages across web and mobile products, improving user experiences and engagement. Automate messaging and connect with other apps for effective user behavior management." } \ No newline at end of file diff --git a/sdks/db/generate-repository-description-cache/customer-io-journeys-track.json b/sdks/db/generate-repository-description-cache/customer-io-journeys-track.json index df14d65dbc..17d07f7263 100644 --- a/sdks/db/generate-repository-description-cache/customer-io-journeys-track.json +++ b/sdks/db/generate-repository-description-cache/customer-io-journeys-track.json @@ -1,3 +1,4 @@ { - "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products. \n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform. \n- Create and manage newsletters, transactional messages, and behavioral messages \n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time. \n\nLearn more: https://customer.io": "Customer.io is a versatile marketing automation tool that sends relevant messages based on user behavior across web and mobile. Real-time data ensures personalized messaging, from event reminders to onboarding emails. Automate product messaging, newsletters, and more with powerful segmentation and automation capabilities." + "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products. \n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform. \n- Create and manage newsletters, transactional messages, and behavioral messages \n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time. \n\nLearn more: https://customer.io": "Customer.io is a versatile marketing automation tool that sends relevant messages based on user behavior across web and mobile. Real-time data ensures personalized messaging, from event reminders to onboarding emails. Automate product messaging, newsletters, and more with powerful segmentation and automation capabilities.", + "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products.\n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform.\n- Create and manage newsletters, transactional messages, and behavioral messages\n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time.\n\nLearn more: https://customer.io": "Customer.io offers a versatile marketing automation tool for personalized messaging based on user behavior. Automate product messaging, newsletters, and more to connect with users effectively and save time. Customer.io's {language} SDK for Journeys Track API generated by Konfig (https://konfigthis.com/)." } \ No newline at end of file diff --git a/sdks/db/generate-repository-description-cache/pappers.json b/sdks/db/generate-repository-description-cache/pappers.json new file mode 100644 index 0000000000..9469c392f1 --- /dev/null +++ b/sdks/db/generate-repository-description-cache/pappers.json @@ -0,0 +1,3 @@ +{ + "Avec Pappers, accédez à toute toute l'information légale, juridique financière des sociétés françaises !\nDécouvrez nos offres : https://www.pappers.fr/api et https://www.pappers.fr/exports": "Avec Pappers, accédez à toute toute l'information légale, juridique financière des sociétés françaises ! Découvrez nos offres : https://www.pappers.fr/api et https://www.pappers.fr/exports. Pappers's {language} SDK generated by Konfig (https://konfigthis.com/)." +} \ No newline at end of file diff --git a/sdks/db/intermediate-fixed-specs/box/openapi.yaml b/sdks/db/intermediate-fixed-specs/box/openapi.yaml index 94e04ee888..c4e81341a8 100644 --- a/sdks/db/intermediate-fixed-specs/box/openapi.yaml +++ b/sdks/db/intermediate-fixed-specs/box/openapi.yaml @@ -16,7 +16,7 @@ info: name: Apache-2.0 url: http://www.apache.org/licenses/LICENSE-2.0 version: 2.0.0 - x-box-commit-hash: 9d605a3ec5 + x-box-commit-hash: a2f6edcf0a servers: - url: https://api.box.com/2.0 description: Box Platform API server @@ -312,7 +312,7 @@ paths: Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example - `?field=metadata.enterprise_12345.contractTemplate`. + `?fields=metadata.enterprise_12345.contractTemplate`. in: query example: - id @@ -4949,7 +4949,7 @@ paths: Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example - `?field=metadata.enterprise_12345.contractTemplate`. + `?fields=metadata.enterprise_12345.contractTemplate`. in: query example: - id @@ -5931,7 +5931,7 @@ paths: Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example - `?field=metadata.enterprise_12345.contractTemplate`. + `?fields=metadata.enterprise_12345.contractTemplate`. in: query example: - id diff --git a/sdks/db/intermediate-fixed-specs/digitalocean/openapi.yaml b/sdks/db/intermediate-fixed-specs/digitalocean/openapi.yaml index 4210183d2a..9b052f5913 100644 --- a/sdks/db/intermediate-fixed-specs/digitalocean/openapi.yaml +++ b/sdks/db/intermediate-fixed-specs/digitalocean/openapi.yaml @@ -18392,6 +18392,8 @@ paths: parameter to specify if the results should be for the `private` or `public` interface. Use the `direction` query parameter to specify if the results should be for `inbound` or `outbound` traffic. + + The metrics in the response body are in megabits per second (Mbps). tags: - Monitoring responses: @@ -25726,7 +25728,7 @@ components: metric_timestamp_start: in: query name: start - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. example: '1620683817' required: true schema: @@ -25734,7 +25736,7 @@ components: metric_timestamp_end: in: query name: end - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. example: '1620705417' required: true schema: diff --git a/sdks/db/intermediate-fixed-specs/hsbc/account-information-ce/openapi.yaml b/sdks/db/intermediate-fixed-specs/hsbc/account-information-ce/openapi.yaml index 4333ad9dae..11292aef4e 100644 --- a/sdks/db/intermediate-fixed-specs/hsbc/account-information-ce/openapi.yaml +++ b/sdks/db/intermediate-fixed-specs/hsbc/account-information-ce/openapi.yaml @@ -667,6 +667,8 @@ components: description: The PSU's IP address if the PSU is currently logged in with the TPP. schema: type: string + pattern: >- + ^((((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\s?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\s?),?\s?)+$ example: 12.201.45.125 x-fapi-auth-date: in: header diff --git a/sdks/db/intermediate-fixed-specs/pappers/openapi.yaml b/sdks/db/intermediate-fixed-specs/pappers/openapi.yaml new file mode 100644 index 0000000000..504c3268cc --- /dev/null +++ b/sdks/db/intermediate-fixed-specs/pappers/openapi.yaml @@ -0,0 +1,6135 @@ +openapi: 3.0.0 +info: + 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 + title: Pappers API + contact: + name: Support technique Pappers + email: support@pappers.fr +servers: + - url: https://api.pappers.fr/v2 +paths: + /entreprise: + get: + tags: + - Fiche entreprise + summary: Récupère l'ensemble des informations disponibles sur une entreprise. + 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`. + operationId: entreprise + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + - name: siret + in: query + description: SIRET de l'entreprise + required: false + schema: + type: string + example: 44306184100047 + - name: integrer_diffusions_partielles + in: query + description: >- + Si vrai et si l'entreprise est en diffusion partielle, le retour + renverra les informations partielles disponibles. Valeur par défaut + : `false`. + required: false + schema: + type: boolean + - name: format_publications_bodacc + in: query + description: >- + Format attendu pour les publications BODACC. Valeur par défaut : + `"objet"`. + required: false + schema: + type: string + enum: + - objet + - texte + example: objet + - name: marques + in: query + description: >- + Si vrai, le retour inclura les marques éventuelles de l'entreprise. + Valeur par défaut : `false`. + required: false + schema: + type: boolean + - name: validite_tva_intracommunautaire + in: query + 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`. + required: false + schema: + type: boolean + - name: publications_bodacc_brutes + in: query + 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`. + required: false + schema: + type: boolean + - name: champs_supplementaires + in: query + 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. + 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. + description: >- + Vous devez fournir soit l'identifiant de l'association, soit le SIREN, + soit le SIRET. + operationId: association + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: id_association + in: query + description: Identifiant de l'association + required: false + schema: + type: string + example: W142005389 + - name: siret + in: query + description: SIRET de l'association + required: false + schema: + type: string + example: 95037097300014 + - name: siren + in: query + description: SIREN de l'association + 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. + 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`). + operationId: recherche + 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' + - name: q + in: query + 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. + required: false + schema: + type: string + example: Google France + - name: siege + in: query + description: Défini si la requête se base sur le siège + 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: + type: object + properties: + resultats: + type: array + description: Liste des entreprises qui correspondent à la recherche. + items: + allOf: + - $ref: '#/components/schemas/EntrepriseRecherche' + - type: object + properties: + dirigeants: + type: array + description: >- + Dirigeants de l'entreprise qui correspondent à + la recherche (si vous recherchez dans la base + dirigeants). + items: + $ref: '#/components/schemas/RepresentantRecherche' + beneficiaires: + type: array + description: >- + Bénéficiaires effectifs de l'entreprise qui + correspondent à la recherche (si vous recherchez + dans la base bénéficiaires effectifs). + items: + $ref: '#/components/schemas/Beneficiaire' + documents: + type: array + description: >- + Documents de l'entreprise qui correspondent à la + recherche (si vous recherchez dans la base + documents). + items: + $ref: '#/components/schemas/Document' + publications: + type: array + description: >- + Publications de l'entreprise qui correspondent à + la recherche (si vous recherchez dans la base + publications). + items: + allOf: + - $ref: '#/components/schemas/Publication' + - type: object + properties: + mentions: + type: array + description: >- + Mentions de la recherche dans la + publication. + items: + type: string + nb_dirigeants_total: + type: integer + description: Nombre de dirigeants total de l'entreprise. + nb_beneficiaires_total: + type: integer + description: >- + Nombre de bénéficiaires effectifs total de + l'entreprise. + nb_documents_avec_mentions: + type: integer + description: >- + Nombre de documents de l'entreprise qui + correspondent à la recherche. + nb_documents_total: + type: integer + description: Nombre de documents total de l'entreprise. + nb_publications_avec_mentions: + type: integer + description: >- + Nombre de publications de l'entreprise qui + correspondent à la recherche. + nb_publications_total: + type: integer + description: Nombre de publications total de l'entreprise. + total: + type: integer + description: Nombre d'entreprises qui correspondent à la recherche. + example: 100 + page: + type: integer + description: Page actuelle. + example: 1 + curseurSuivant: + type: string + description: >- + Présent uniquement en cas d'utilisation du paramètre + `curseur`. Contient le curseur courant à envoyer en + paramètre `curseur` de la requête suivantes. + example: QxNRrqKiBFDQq54SpHsrw8r5Z3yWZMDAAzcvwywX + '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. + description: >- + Tous les paramètres sont optionnels et servent à filtrer la recherche. + Les différents dirigeants seront renvoyées dans un tableau `resultats`. + operationId: recherche-dirigeants + parameters: + - $ref: '#/components/parameters/api_token' + - $ref: '#/components/parameters/par_page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/precision' + - name: q + in: query + description: >- + Texte à rechercher. Nom et prénom du dirigeant pour une personne + physique, dénomination pour une personne morale. + 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: + type: object + properties: + resultats: + type: array + description: Liste des dirigeants qui correspondent à la recherche. + items: + allOf: + - $ref: '#/components/schemas/RepresentantRecherche' + - type: object + properties: + entreprises: + type: array + description: >- + Liste des entreprises du dirigeant, dans la + limite de 100 entreprises. + items: + $ref: '#/components/schemas/EntrepriseRecherche' + nb_entreprises_total: + type: integer + description: Nombre d'entreprises du dirigeant au total + total: + type: integer + description: Nombre de dirigeants qui correspondent à la recherche. + example: 100 + page: + type: integer + description: Page actuelle. + example: 1 + '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. + 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`. + operationId: recherche-beneficiaires + parameters: + - $ref: '#/components/parameters/api_token' + - $ref: '#/components/parameters/par_page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/precision' + - name: q + in: query + description: Nom et/ou prénom du bénéficiaire effectif. + 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: + type: object + properties: + resultats: + type: array + description: >- + Liste des bénéficiaires effectifs qui correspondent à la + recherche. + items: + allOf: + - $ref: '#/components/schemas/Beneficiaire' + - type: object + properties: + entreprises: + type: array + description: >- + Liste des entreprises dont le bénéficiaire + effectif est bénéficiaire effectif, dans la + limite de 100 entreprises. + items: + $ref: '#/components/schemas/EntrepriseRecherche' + nb_entreprises_total: + type: integer + description: >- + Nombre d'entreprises du bénéficiaire effectif au + total. + entreprises_dirigeant: + type: array + description: >- + Liste des entreprises dont le bénéficiaire + effectif est dirigeant (sans forcément en être + bénéficiaire effectif), dans la limite de 100 + entreprises. + items: + $ref: '#/components/schemas/EntrepriseRecherche' + nb_entreprises_dirigeant_total: + type: integer + description: >- + Nombre d'entreprises dont le bénéficiaire + effectif est dirigeant au total. + total: + type: integer + description: >- + Nombre de bénéficiaires effectifs qui correspondent à la + recherche. + example: 100 + page: + type: integer + description: Page actuelle. + example: 1 + '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. + description: >- + Tous les paramètres sont optionnels et servent à filtrer la recherche. + Les différents documents seront renvoyées dans un tableau `resultats`. + operationId: recherche-documents + parameters: + - $ref: '#/components/parameters/api_token' + - $ref: '#/components/parameters/par_page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/precision' + - name: q + in: query + description: Mot-clé à rechercher dans le contenu du document. + 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: + type: object + properties: + resultats: + type: array + description: Liste des documents qui correspondent à la recherche. + items: + allOf: + - $ref: '#/components/schemas/Document' + - type: object + properties: + entreprise: + $ref: '#/components/schemas/EntrepriseRecherche' + total: + type: integer + description: Nombre de documents qui correspondent à la recherche. + example: 100 + page: + type: integer + description: Page actuelle. + example: 1 + '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. + description: >- + Tous les paramètres sont optionnels et servent à filtrer la recherche. + Les différentes publications seront renvoyées dans un tableau + `resultats`. + operationId: recherche-publications + parameters: + - $ref: '#/components/parameters/api_token' + - $ref: '#/components/parameters/par_page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/precision' + - name: q + in: query + description: Mot-clé à rechercher dans le contenu de la publication. + 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: + type: object + properties: + resultats: + type: array + description: Liste des publications qui correspondent à la recherche. + items: + allOf: + - $ref: '#/components/schemas/Publication' + - type: object + properties: + entreprise: + $ref: '#/components/schemas/EntrepriseRecherche' + total: + type: integer + description: Nombre de publications qui correspondent à la recherche. + example: 100 + page: + type: integer + description: Page actuelle. + example: 1 + '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). + 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. + operationId: suggestions + parameters: + - name: q + in: query + description: Début de recherche textuelle + required: true + schema: + type: string + example: googl + - name: longueur + in: query + description: 'Nombre de résultats. Maximum 100. Valeur par défaut : `10`.' + required: false + schema: + type: integer + example: 20 + - name: cibles + in: query + description: >- + Cibles de la recherche, séparées par des virgules. Valeur par défaut + : `"nom_entreprise"`. + 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: + type: object + properties: + resultats_nom_entreprise: + type: array + format: optional + description: >- + Liste des entreprises dont le nom (dénomination ou + nom/prénom) peut compléter la recherche textuelle. + Uniquement présent si le paramètre `cibles` contient + `nom_entreprise`. + items: + allOf: + - type: object + properties: + mention: + type: string + description: >- + Nom de l'entreprise, avec le texte recherché + encerclé d'une balise HTML ``. + - $ref: '#/components/schemas/EntrepriseRecherche' + resultats_denomination: + type: array + format: optional + description: >- + Liste des entreprises dont la dénomination peut compléter + la recherche textuelle (concerne les personnes morales + seulement). Uniquement présent si le paramètre `cibles` + contient `denomination`. + items: + allOf: + - type: object + properties: + mention: + type: string + description: >- + Dénomination de l'entreprise, avec le texte + recherché encerclé d'une balise HTML ``. + - $ref: '#/components/schemas/EntrepriseRecherche' + resultats_nom_complet: + type: array + format: optional + description: >- + Liste des entreprises dont le nom complet (nom + prénom ou + prénom + nom) peut compléter la recherche textuelle + (concerne les personnes physiques seulement). Uniquement + présent si le paramètre `cibles` contient `nom_complet`. + items: + allOf: + - type: object + properties: + mention: + type: string + description: >- + Nom complet de l'entreprise, avec le texte + recherché encerclé d'une balise HTML ``. + - $ref: '#/components/schemas/EntrepriseRecherche' + resultats_representant: + type: array + format: optional + description: >- + Liste des représentants dont le nom complet (nom + prénom + ou prénom + nom) peut compléter la recherche textuelle. + Uniquement présent si le paramètre `cibles` contient + `representant`. + items: + allOf: + - type: object + properties: + mention: + type: string + description: >- + Nom du dirigeant, avec le texte recherché + encerclé d'une balise HTML ``. + - $ref: '#/components/schemas/RepresentantSuggestions' + resultats_siren: + type: array + format: optional + description: >- + Liste des entreprises dont le numéro SIREN peut compléter + la recherche textuelle. Uniquement présent si le paramètre + `cibles` contient `siren`. + items: + allOf: + - type: object + properties: + mention: + type: string + description: >- + SIREN de l'entreprise, avec le texte recherché + encerclé d'une balise HTML ``. + - $ref: '#/components/schemas/EntrepriseRecherche' + resultats_siret: + type: array + format: optional + description: >- + Liste des entreprises dont le numéro SIRET peut compléter + la recherche textuelle. Uniquement présent si le paramètre + `cibles` contient `siret`. + items: + allOf: + - type: object + properties: + mention: + type: string + description: >- + SIRET de l'entreprise, avec le texte recherché + encerclé d'une balise HTML ``. + - $ref: '#/components/schemas/EntrepriseRecherche' + '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. + description: >- + Vous devez fournir le SIREN de l'entreprise pour laquelle vous souhaitez + obtenir les comptes annuels. + operationId: comptes-annuels + parameters: + - $ref: '#/components/parameters/api_token' + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + - name: annee + in: query + 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. + 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: + type: object + additionalProperties: + type: array + description: Comptes disponibles pour l'année correspondant à la clé. + items: + type: object + description: Année + properties: + date_depot: + type: string + description: Date de dépôt des comptes, au format AAAA-MM-JJ. + example: '2021-04-23T00:00:00.000Z' + code_greffe: + type: string + description: Code du greffe de dépôt des comptes. + example: 7501 + numero_depot: + type: string + description: Numéro de dépôt des comptes au greffe. + example: 75548 + numero_gestion: + type: string + description: Numéro de gestion au greffe. + example: 2003B09427 + date_cloture: + type: string + description: Date de cloture des comptes, au format AAAA-MM-JJ. + example: '2020-12-31T00:00:00.000Z' + date_cloture_n-1: + type: string + format: nullable + description: >- + Date de cloture des comptes n-1, lorsque présents, au + format AAAA-MM-JJ. + duree_exercice_n: + type: integer + description: Durée de l'exercice déposé, en mois. + example: 12 + duree_exercice_n-1: + type: integer + format: nullable + description: >- + Durée de l'exercice précédent, lorsque présent, en + mois. + type_comptes: + type: string + enum: + - C + - S + - K + - CS + - B + - A + description: >- + Type de comptes (C = complets ; S = simplifiés ; K = + consolidés ; CS = mélange complets/simplifiés ; B = + banques ; A = assurances). + example: C + libelle_type_comptes: + type: string + enum: + - Complets + - Simplifiés + - Consolidés + - Complets/Simplifiés + - Banques + - Assurances + description: Libellé du type de comptes. + example: Complets + devise: + type: string + description: Devise des comptes. + example: EUR + devise_origine: + type: string + format: nullable + description: Devise d'origine en cas de conversion. + confidentialite: + type: boolean + description: Confidentialité totale des comptes. + confidentialite_compte_de_resultat: + type: boolean + description: >- + Confidentialité partielle des comptes (seul le compte + de résultat est confidentiel, le reste des comptes + sont disponibles). + coherence_comptable: + type: boolean + description: >- + Vrai si les comptes sont cohérents d'un point de vue + comptable (équilibre du bilan par exemple). + type_saisie: + type: string + description: Description du type de saisie des comptes. + informations_traitement: + type: array + format: nullable + description: >- + Informations complémentaires sur le traitement des + comptes. + items: + type: string + sections: + type: array + description: Liste des sections de liasses fiscales. + items: + type: object + properties: + libelle: + type: string + description: Libellé de la section. + example: Actif (bilan) + liasses: + type: array + description: Liste des liasses fiscales de la section. + items: + type: object + properties: + code: + type: string + description: Code de la liasse. + example: AN + libelle: + type: string + description: Libellé de la liasse. + example: Terrains + colonnes: + type: array + description: Colonnes de la liasse. + items: + type: object + properties: + libelle: + type: string + description: Libellé de la colonne. + example: Montant brut année N + valeur: + type: integer + description: Valeur de la colonne. + example: 60067444 + ratios: + $ref: '#/components/schemas/Ratios' + '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. + 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. + operationId: cartographie + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: true + schema: + type: string + example: 443061841 + - name: inclure_entreprises_dirigees + in: query + 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`. + required: false + schema: + type: boolean + - name: inclure_entreprises_citees + in: query + 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`. + required: false + schema: + type: boolean + - name: inclure_sci + in: query + description: >- + Si vrai, la cartographie intègrera les SCI. Valeur par défaut : + `true`. + required: false + schema: + type: boolean + - name: autoriser_modifications + in: query + 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`. + required: false + schema: + type: boolean + - name: rejeter_premier_degre + in: query + 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`. + required: false + schema: + type: boolean + - name: degre + in: query + 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. + 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. + description: >- + Vous devez fournir le token du document. Le document vous sera envoyé au + format PDF ou XLSX. + operationId: document-telechargement + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: token + in: query + description: Token du document + 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: + type: string + format: binary + '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. + description: >- + Vous devez fournir soit le SIREN, soit le SIRET. Le document vous sera + envoyé au format PDF. + operationId: document-extrait-pappers + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + - name: siret + in: query + description: SIRET de l'entreprise + 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: + type: string + format: binary + '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: + tags: + - Documents + summary: >- + Télécharge l'extrait INPI d'une entreprise à partir de son SIREN ou + SIRET. + description: >- + Vous devez fournir soit le SIREN, soit le SIRET. Le document vous sera + envoyé au format PDF. + operationId: document-extrait-inpi + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + - name: siret + in: query + description: SIRET de l'entreprise + required: false + schema: + type: string + example: 44306184100047 + responses: + '200': + description: >- + Document disponible. Le retour contient l'extrait INPI au format + PDF. + content: + application/pdf: + schema: + type: string + format: binary + '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/avis_situation_insee: + get: + tags: + - Documents + summary: >- + Télécharge l'avis de situation INSEE d'une entreprise à partir de son + SIREN ou SIRET. + description: >- + Vous devez fournir soit le SIREN, soit le SIRET. Le document vous sera + envoyé au format PDF. + operationId: document-avis-situation-insee + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + - name: siret + in: query + description: SIRET de l'entreprise + required: false + schema: + type: string + example: 44306184100047 + responses: + '200': + description: >- + Document disponible. Le retour contient l'avis de situation au + format PDF. + content: + application/pdf: + schema: + type: string + format: binary + '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/statuts: + get: + tags: + - Documents + summary: >- + Télécharge les derniers statuts disponibles d'une entreprise à partir de + son SIREN ou SIRET. + description: >- + Vous devez fournir soit le SIREN, soit le SIRET. Le document vous sera + envoyé au format PDF. + operationId: document-status + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + - name: siret + in: query + description: SIRET de l'entreprise + required: false + schema: + type: string + example: 44306184100047 + responses: + '200': + description: Document disponible. Le retour contient les statuts au format PDF. + content: + application/pdf: + schema: + type: string + format: binary + '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/declaration_beneficiaires_effectifs: + get: + tags: + - Documents + summary: >- + Télécharge la déclaration des bénéficiaires effectifs d'une entreprise à + partir de son SIREN. + description: >- + Vous devez fournir le SIREN. Le document vous sera envoyé au format PDF. + + + Seules les autorités de contrôle (article + R. 561-57 du Code monétaire et financier en dénombre 18) et les + personnes assujetties à la lutte contre le blanchiment des capitaux et + le financement du terrorisme (article + L. 561-2 du code monétaire et financier) peuvent accéder à ces + informations. + + + Pour pouvoir utiliser cette route veuillez nous contacter au préalable à + api@pappers.fr + operationId: document-beneficiaires-effectifs + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + responses: + '200': + description: >- + Document disponible. Le retour contient la déclaration des + bénéficiaires effectifs au format PDF. + content: + application/pdf: + schema: + type: string + format: binary + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '403': + description: Vous n'avez pas les droits pour exécuter cette requête. + '404': + description: Document indisponible. + '503': + description: Service momentanément indisponible. + /document/rapport_solvabilite: + get: + tags: + - Documents + summary: >- + Télécharge un Rapport de solvabilité d'une entreprise à partir de son + SIREN. + description: Vous devez fournir le SIREN. Le document vous sera envoyé au format PDF. + operationId: document-scoring-financier + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: siren + in: query + description: SIREN de l'entreprise + required: false + schema: + type: string + example: 443061841 + responses: + '200': + description: >- + Document disponible. Le retour contient le rapport de solvabilité au + format PDF. + content: + application/pdf: + schema: + type: string + format: binary + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '404': + description: Document indisponible. + '503': + description: Service momentanément indisponible. + /conformite/personne_physique: + get: + tags: + - Conformité + summary: >- + Vérifie le statut de personne politiquement exposée et la présence de + sanctions internationales pour une personne physique. + description: > + Cette route vérifie le statut de personne politiquement exposée et la + présence de sanctions internationales pour une personne physique. + + + Pour vérifier le statut de dirigeants et bénéficiaires effectifs + d'entreprises, vous pouvez directement utiliser la route `/entreprise` + avec les champs supplémentaires `personne_politiquement_exposee` et + `sanctions`. + operationId: conformite + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: nom + in: query + description: Nom de la personne physique + required: true + schema: + type: string + example: Macron + - name: prenom + in: query + description: Prénom de la personne physique + required: true + schema: + type: string + example: Emmanuel + - name: date_de_naissance + in: query + description: >- + Date de naissance de la personne physique, au format AAAA-MM-JJ ou + AAAA-MM + required: true + schema: + type: string + example: '1977-12-21T00:00:00.000Z' + responses: + '200': + description: La personne physique a pu être vérifiée. + content: + application/json: + schema: + type: object + properties: + personne_politiquement_exposee: + $ref: '#/components/schemas/PersonnePolitiquementExposee' + sanctions_en_cours: + type: boolean + format: optional + description: >- + Vaut vrai si le bénéficiaire effectif est actuellement + sous sanction. Uniquement présent si demandé dans les + champs supplémentaires. + sanctions: + type: array + description: >- + Liste des sanctions du bénéficiaire effectif. Uniquement + présent si demandé dans les champs supplémentaires. + items: + $ref: '#/components/schemas/Sanction' + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '503': + description: Erreur interne. La personne physique n'a pas pu être vérifiée. + /suivi-jetons: + get: + tags: + - Suivi utilisation + summary: Récupère le suivi d'utilisation des jetons. + description: Vous devez fournir la clé d'utilisation de l'API. + operationId: suivi-jetons + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + responses: + '200': + description: Succès + content: + application/json: + schema: + type: object + description: Suivi d'utilisation des jetons. + properties: + jetons_abonnement: + type: number + example: 10000 + description: Le nombre de jetons mensuels initiaux de votre abonnement. + jetons_abonnement_utilises: + type: number + example: 650 + description: >- + Le nombre de jetons mensuels de votre abonnement que vous + avez utilisés + jetons_pay_as_you_go_restants: + type: number + example: 0 + description: Le nombre de jetons pay as you go qu'il vous reste. + '401': + description: Clé API incorrecte. + '503': + description: Service momentanément indisponible. + /liste: + post: + tags: + - Surveillance + summary: Ajoute une (ou plusieurs) entreprise(s) à une liste d'entreprises. + description: >- + Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant + de votre liste. + operationId: surveillance-entreprise + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: id_liste + in: query + description: Identifiant unique de votre liste de surveillance d'entreprises + required: true + schema: + type: string + example: votre_identifiant_ici + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + type: object + required: + - siren + properties: + siren: + type: string + example: '443061841' + description: SIREN de l'entreprise + responses: + '200': + description: Aucun changement, les données étaient déjà présentes. + content: + application/json: + schema: + type: object + description: Nombre de notifications ajoutées. + properties: + notifications_ajoutees: + type: number + example: 0 + default: 0 + description: >- + Le nombre d'entreprises ajoutées à votre liste de + surveillance d'entreprises. + '201': + description: Créés, liste mise à jour. + content: + application/json: + schema: + type: object + description: Nombre de notifications ajoutées. + properties: + notifications_ajoutees: + type: number + example: 10 + description: >- + Le nombre d'entreprises ajoutées à votre liste de + surveillance d'entreprises. + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '403': + description: Offre dépassée. + '404': + description: Liste non trouvée. + '503': + description: Service momentanément indisponible. + /liste/: + post: + tags: + - Surveillance + summary: Ajoute un (ou plusieurs) dirigeant(s) à une liste de dirigeants. + description: >- + Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant + de votre liste. Les informations à renseigner sont différentes selon le + type de personne à ajouter (morale ou physique) + operationId: surveillance-dirigeant + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: id_liste + in: query + description: Identifiant unique de votre liste de surveillance de dirigeants + required: true + schema: + type: string + example: votre_identifiant_ici + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + type: object + required: + - siren + properties: + siren: + type: string + description: >- + SIREN de la personne morale (si ajout d'une personne + morale) + denomination: + type: string + description: >- + Dénomination de la personne morale (si ajout d'une + personne morale) + nom: + type: string + description: >- + Nom de la personne physique (si ajout d'une personne + physique) + prenom: + type: string + description: >- + Prénom de la personne physique (si ajout d'une personne + physique) + date_de_naissance: + type: string + description: >- + Date de naissance de la personne physique au format + AAAA-MM-JJ (si ajout d'une personne physique) + recherche_elargie: + type: boolean + default: false + description: >- + Active la recherche élargie du dirigeant :
  • Pour + une personne physique : c'est un cas rare mais la date de + naissance du dirigeant n'est pas toujours connue de + Pappers. Si vous activer ce filtre et que la date de + naissance est inconnue, l'alerte sera générée uniquement + sur la base du nom et prénom.
  • Pour une personne + morale : c'est un cas rare mais le SIREN du dirigeant + n'est pas toujours connu de Pappers. Si vous activer ce + filtre et que le SIREN est inconnu, l'alerte sera générée + uniquement sur la base de la dénomination. Activable + uniquement si le champ denomination est présent.
+ example: + - siren: '443061841' + denomination: Google FRANCE + - nom: Yi + prenom: Kenneth H. + date_de_naissance: '1970-01-06' + recherche_elargie: true + responses: + '200': + description: Aucun changement, les données étaient déjà présentes. + content: + application/json: + schema: + type: object + description: Nombre de notifications ajoutées. + properties: + notifications_ajoutees: + type: number + example: 0 + default: 0 + description: >- + Le nombre de dirigeants ajoutées à votre liste de + surveillance de dirigeants. + '201': + description: Créés, liste mise à jour. + content: + application/json: + schema: + type: object + description: Nombre de notifications ajoutées. + properties: + notifications_ajoutees: + type: number + example: 10 + description: >- + Le nombre de dirigeants ajoutées à votre liste de + surveillance de dirigeants. + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '403': + description: Offre dépassée. + '404': + description: Liste non trouvée. + '503': + description: Service momentanément indisponible. + delete: + tags: + - Surveillance + summary: Supprime une (ou plusieurs) notification(s) d'une liste. + description: >- + Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant + de votre liste. + operationId: surveillance-notifications-delete + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: id_liste + in: query + description: Identifiant unique de votre liste de surveillance + required: true + schema: + type: string + example: votre_identifiant_ici + - name: siren + in: query + description: >- + Liste des sirens des notifications à supprimer, séparés par une + virgule + required: false + schema: + type: string + example: 443061841,950370973 + - name: id + in: query + description: Liste des ids des notifications à supprimer, séparés par une virgule + required: false + schema: + type: string + example: >- + ecfca3e5fb1ce07bb3fdfe8760a28df5aa617ed4951b7f61,a67b9de66189ba98eb4aede09f4b2b565b0f18fe694da7bc + - name: supprimer_totalite + in: query + description: Suppression de toutes les notifications de la liste + required: false + schema: + type: boolean + example: true + responses: + '200': + description: Succés. + content: + application/json: + schema: + type: object + description: Nombre de notifications supprimées. + properties: + notifications_supprimees: + type: number + example: 10 + description: >- + Le nombre de notifications supprimées de votre liste de + surveillance. + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '404': + description: Liste non trouvée. + '503': + description: Service momentanément indisponible. + /liste-informations: + post: + tags: + - Surveillance + summary: Ajoute des informations à une (ou plusieurs) notification(s). + description: >- + Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant + de votre liste. + operationId: surveillance-liste-informations + parameters: + - name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + - name: id_liste + in: query + description: Identifiant unique de votre liste de surveillance d'entreprises + required: true + schema: + type: string + example: votre_identifiant_ici + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + notifications: + type: array + description: Tableau d'identifiant de notifications + items: + type: string + example: ecfca3e5fb1ce07bb3fdfe8760a28df5aa617ed4951b7f61 + informations: + type: string + example: Information quelconque + description: Information à rajouter sur les notifications + maxLength: 255 + responses: + '200': + description: Succés. + '400': + description: Paramètres de la requête incorrects. + '401': + description: Clé API incorrecte. + '404': + description: Liste non trouvée. + '503': + description: Service momentanément indisponible. +components: + parameters: + api_token: + name: api_token + in: query + description: Clé d'utilisation de l'API + required: true + schema: + type: string + example: votre_clé_ici + par_page: + name: par_page + in: query + description: 'Nombre de résultats affichés sur une page. Valeur par défaut : `10`.' + required: false + schema: + type: integer + example: 20 + page: + name: page + in: query + description: 'Page de résultats. Valeur par défaut : `1`.' + required: false + schema: + type: integer + example: 1 + bases: + name: bases + in: query + description: >- + Bases de données dans lesquelles rechercher. Il est possible d'indiquer + plusieurs bases en les séparant par des virgules. Valeur par défaut : + `"entreprises"`. + required: false + schema: + type: string + enum: + - entreprises + - dirigeants + - beneficiaires + - documents + - publications + example: entreprises + precision: + name: precision + in: query + description: 'Niveau de précision de la recherche. Valeur par défaut : `"standard"`.' + required: false + schema: + type: string + enum: + - approximative + - standard + - exacte + example: standard + curseur: + name: curseur + in: query + description: >- + Curseur servant à parcourir l'ensemble des résultats (alternativement à + la pagination qui est limitée à 400 résultats maximum). Doit valoir `*` + pour la première requête, et doit pour les requêtes suivantes reprendre + la valeur `curseurSuivant` retournée par la dernière réponse. + required: false + schema: + type: string + example: '*' + par_curseur: + name: par_curseur + in: query + description: >- + Nombre de résultats affichés par curseur. Valeur par défaut : `50`. + Valeur minimale: `1`. Valeur maximale : `1000`. + required: false + schema: + type: integer + example: 20 + code_naf: + name: code_naf + in: query + description: >- + Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes NAF + en les séparant par des virgules. + required: false + schema: + type: string + example: 70.10Z + departement: + name: departement + in: query + description: >- + Numéro de département de l'un des établissements de l'entreprise. Il est + possible d'indiquer plusieurs départements en les séparant par des + virgules. + required: false + schema: + type: string + example: 75 + region: + name: region + in: query + description: >- + Code de la région de l'un des établissements de l'entreprise, selon la + [nomenclature + Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il + est possible d'indiquer plusieurs codes régions en les séparant par des + virgules. + required: false + schema: + type: string + example: 11 + code_postal: + name: code_postal + in: query + description: >- + Code postal de l'un des établissements de l'entreprise. Il est possible + d'indiquer plusieurs codes postaux en les séparant par des virgules. + required: false + schema: + type: string + example: 75009 + convention_collective: + name: convention_collective + in: query + description: Convention collective de l'entreprise. + required: false + schema: + type: string + example: 1486 + categorie_juridique: + name: categorie_juridique + in: query + description: >- + Catégorie juridique de l'entreprise, selon la [nomenclature + Insee](https://www.insee.fr/fr/information/2028129). + + + **Note** : Le code correspond à celui de l'INSEE, à l'exception des SASU + qui auront comme code 5720 et les EURL qui auront comme code 5498. + required: false + schema: + type: string + example: 5499 + entreprise_cessee: + name: entreprise_cessee + in: query + description: Activité de l'entreprise cessée ou non. + required: false + schema: + type: boolean + example: false + statut_rcs: + name: statut_rcs + in: query + description: Statut au RCS + required: false + schema: + type: string + enum: + - inscrit + - radie + - non inscrit + example: inscrit + objet_social: + name: objet_social + in: query + description: Objet social de l'entreprise déclaré au RCS. + required: false + schema: + type: string + example: La conception de moteurs de recherche sur internet. + date_immatriculation_rcs_min: + name: date_immatriculation_rcs_min + in: query + description: >- + Date d'immatriculation au RCS minimale de l'entreprise, au format + JJ-MM-AAAA. + required: false + schema: + type: string + example: 15-05-2002 + date_immatriculation_rcs_max: + name: date_immatriculation_rcs_max + in: query + description: d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA. + required: false + schema: + type: string + example: 15-05-2002 + date_radiation_rcs_min: + name: date_radiation_rcs_min + in: query + description: Date de radiation au RCS minimale de l'entreprise, au format JJ-MM-AAAA. + required: false + schema: + type: string + example: 15-05-2002 + date_radiation_rcs_max: + name: date_radiation_rcs_max + in: query + description: Date de radiation au RCS maximale de l'entreprise, au format JJ-MM-AAAA. + required: false + schema: + type: string + example: 17-05-2002 + capital_min: + name: capital_min + in: query + description: Capital minimum de l'entreprise. + required: false + schema: + type: string + example: 411016200 + capital_max: + name: capital_max + in: query + description: Capital maximum de l'entreprise. + required: false + schema: + type: string + example: 411016400 + chiffre_affaires_min: + name: chiffre_affaires_min + in: query + description: >- + Chiffre d'affaires minimum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + required: false + schema: + type: string + example: 411016200 + chiffre_affaires_max: + name: chiffre_affaires_max + in: query + description: >- + Chiffre d'affaires maximum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + required: false + schema: + type: string + example: 411016400 + resultat_min: + name: resultat_min + in: query + description: >- + Résultat minimum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + required: false + schema: + type: string + example: 29327000 + resultat_max: + name: resultat_max + in: query + description: >- + Résultat maximum de l'entreprise. + + + **Note** : Filtrer sur ce critère restreint énormément les entreprises + retournées car cela élimine d'office toutes les entreprises dont les + comptes ne sont pas publiés. + required: false + schema: + type: string + example: 29327100 + date_creation_min: + name: date_creation_min + in: query + description: Date de création minimale de l'entreprise, au format JJ-MM-AAAA. + required: false + schema: + type: string + example: 15-05-2002 + date_creation_max: + name: date_creation_max + in: query + description: Date de création maximale de l'entreprise, au format JJ-MM-AAAA. + required: false + schema: + type: string + example: 17-05-2002 + tranche_effectif_min: + name: tranche_effectif_min + in: query + description: >- + Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen). + + + **Note** : 00 ou NN donneront les mêmes résultats et veulent dire non + employeur + required: false + schema: + type: string + example: 40 + tranche_effectif_max: + name: tranche_effectif_max + in: query + description: >- + Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen). + + + **Note** : 00 ou NN donneront les mêmes résultats et veulent dire non + employeur + required: false + schema: + type: string + example: 42 + type_dirigeant: + name: type_dirigeant + in: query + description: >- + Type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + required: false + schema: + type: string + enum: + - physique + - morale + example: physique + qualite_dirigeant: + name: qualite_dirigeant + in: query + description: >- + Qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + required: false + schema: + type: string + example: Administrateur + nationalite_dirigeant: + name: nationalite_dirigeant + in: query + description: >- + Nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + required: false + schema: + type: string + example: Française + nom_dirigeant: + name: nom_dirigeant + in: query + description: >- + Nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + required: false + schema: + type: string + example: Yi + prenom_dirigeant: + name: prenom_dirigeant + in: query + description: >- + Prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une + recherche d'entreprises). + required: false + schema: + type: string + example: Kenneth H. + age_dirigeant_min: + name: age_dirigeant_min + in: query + description: >- + Âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + required: false + schema: + type: integer + example: 40 + age_dirigeant_max: + name: age_dirigeant_max + in: query + description: >- + Âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise pour + une recherche d'entreprises). + required: false + schema: + type: integer + example: 42 + date_de_naissance_dirigeant_min: + name: date_de_naissance_dirigeant_min + in: query + description: >- + Date de naissance minimale du dirigeant (ou de l'un des dirigeants de + l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '1970-01-01T00:00:00.000Z' + date_de_naissance_dirigeant_max: + name: date_de_naissance_dirigeant_max + in: query + description: >- + Date de naissance maximale du dirigeant (ou de l'un des dirigeants de + l'entreprise pour une recherche d'entreprises) de l'entreprise, au + format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '1970-12-31T00:00:00.000Z' + age_beneficiaire_min: + name: age_beneficiaire_min + in: query + description: >- + Âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + required: false + schema: + type: integer + example: 40 + age_beneficiaire_max: + name: age_beneficiaire_max + in: query + description: >- + Âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + required: false + schema: + type: integer + example: 42 + date_de_naissance_beneficiaire_min: + name: date_de_naissance_beneficiaire_min + in: query + description: >- + Date de naissance minimale du bénéficiaire effectif (ou de l'un des + bénéficiaires effectifs de l'entreprise pour une recherche + d'entreprises), au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '1970-01-01T00:00:00.000Z' + date_de_naissance_beneficiaire_max: + name: date_de_naissance_beneficiaire_max + in: query + description: >- + Date de naissance maximale du bénéficiaire effectif (ou de l'un des + bénéficiaires effectifs de l'entreprise pour une recherche + d'entreprises) de l'entreprise, au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '1970-12-31T00:00:00.000Z' + nationalite_beneficiaire: + name: nationalite_beneficiaire + in: query + description: >- + Nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires + effectifs de l'entreprise pour une recherche d'entreprises). + required: false + schema: + type: string + example: Française + date_depot_document_min: + name: date_depot_document_min + in: query + description: Date de dépôt minimale du document, au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '2000-01-01T00:00:00.000Z' + date_depot_document_max: + name: date_depot_document_max + in: query + description: Date de dépôt maximale du document, au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '2000-12-31T00:00:00.000Z' + type_publication: + name: type_publication + in: query + description: Type de publication + required: false + schema: + type: string + enum: + - Création + - Immatriculation + - Modification + - Vente + - Radiation + - Procédure collective + - Dépôt des comptes + example: Procédure collective + date_publication_min: + name: date_publication_min + in: query + description: Date publication minimale de la publication, au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '2000-01-01T00:00:00.000Z' + date_publication_max: + name: date_publication_max + in: query + description: Date de publication maximale de la publication, au format JJ-MM-AAAA. + required: false + schema: + type: string + format: date + example: '2000-12-31T00:00:00.000Z' + siren: + name: siren + in: query + description: SIREN de l'entreprise. + required: false + schema: + type: string + example: null + schemas: + EntrepriseBase: + type: object + properties: + siren: + type: string + example: '443061841' + description: Le numéro SIREN de l'entreprise au format xxxxxxxxx. + siren_formate: + type: string + example: 443 061 841 + description: Le numéro SIREN de l'entreprise au format xxx xxx xxx. + nom_entreprise: + type: string + example: GOOGLE FRANCE + description: >- + Le nom de l'entreprise. Il est égal à sigle + dénomination en cas de + personne morale, ou à nom + prénom en cas de personne physique. + Nullable si le paramètre `integrer_diffusions_partielles` est à + vrai. + personne_morale: + type: boolean + description: Vrai en cas de personne morale, faux en cas de personne physique. + denomination: + type: string + format: nullable + description: Dénomination de l'entreprise si personne morale. + example: GOOGLE FRANCE + nom: + type: string + format: nullable + description: Nom si personne physique. + example: null + prenom: + type: string + format: nullable + description: Prénom si personne physique. + example: null + sexe: + type: string + format: nullable + description: Sexe si personne physique. F pour féminin, M pour masculin. + example: null + code_naf: + type: string + description: Code NAF de l'entreprise. + example: 70.10Z + libelle_code_naf: + type: string + description: Libellé du code NAF de l'entreprise. + example: Activités des sièges sociaux + domaine_activite: + type: string + description: Domaine d'activité de l'entreprise. + example: Activités des sièges sociaux ; conseil de gestion + conventions_collectives: + description: Liste des conventions collectives de l'entreprise. + type: array + items: + type: object + properties: + nom: + type: string + description: Nom de la convention collective. + example: >- + Convention collective nationale applicable au personnel des + bureaux d'études techniques des cabinets d'ingénieurs-conseils + et des sociétés de conseils(BET SYNTEC) + idcc: + type: integer + description: Code IDCC de l'entreprise. + example: 1486 + confirmee: + type: boolean + description: >- + Si confirmée, l'information est issue de la DSN de + l'entreprise et fournie par le ministère du Travail. Si non + confirmée, ce n'est qu'une estimation à partir du code NAF de + l'entreprise. + pourcentage: + type: number + format: nullable + description: >- + Pourcentage de fiabilité de l'estimation. Si la convention est + confirmée, vaut null. + example: 96.2 + date_creation: + type: string + format: date + description: Date de création de l'entreprise au format AAAA-MM-JJ. + example: '2002-05-16' + date_creation_formate: + type: string + description: Date de création de l'entreprise au format JJ/MM/AAAA. + example: 16/05/2002 + entreprise_cessee: + type: boolean + description: >- + Si vrai, l'entreprise n'est plus en activité. Sinon, elle est + toujours en activité. + date_cessation: + type: string + format: nullable + description: Date de cessation de l'entreprise au format AAAA-MM-JJ. + example: '2002-05-16' + entreprise_employeuse: + type: boolean + description: Si vrai, l'entreprise a au moins un employé. + societe_a_mission: + type: boolean + format: nullable + description: Si vrai, l'entreprise est société à mission. + categorie_juridique: + type: string + description: >- + Catégorie juridique de l'entreprise, selon la [nomenclature + Insee](https://www.insee.fr/fr/information/2028129). + + + **Note** : Le code correspond à celui de l'INSEE, à l'exception des + SASU qui auront comme code 5720 et les EURL qui auront comme code + 5498. + example: '5499' + forme_juridique: + type: string + description: Forme juridique de l'entreprise. + example: Société à responsabilité limitée (SARL) + forme_exercice: + type: string + enum: + - Agent commercial + - 'Agricole : Périmètre des non actifs agricoles' + - 'Agricole : Périmètre des actifs agricoles' + - Artisanale non réglementée + - Artisanale réglementée + - Commerciale + - Libérale non réglementée + - Libérale réglementée + - Loueur meublé + - Toute forme d'activité + - Gestion de biens + - Loueur terre agricole + - Activité de prospection uniquement (non commerciale) + - Sans activité + description: Forme d'exercice de l'activité principale. + format: nullable + example: Commerciale + effectif: + type: string + description: Tranche d'effectif de l'entreprise. + example: Entre 500 et 999 salariés + effectif_min: + type: integer + description: Effectif minimal de l'entreprise. + example: 500 + effectif_max: + type: integer + description: Effectif maximal de l'entreprise. + example: 999 + tranche_effectif: + type: string + format: nullable + description: >- + Tranche d'effectif de l'entreprise, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen#:~:text=Cette%20variable%20correspond%20%C3%A0%20la,effectif%20salari%C3%A9%20de%20l'entreprise.). + example: '41' + annee_effectif: + type: integer + format: nullable + description: >- + Année de validité des variables effectif, effectif_min et + effectif_max. + example: 2017 + capital: + type: number + format: nullable + description: Capital de l'entreprise. + example: 464884017 + statut_rcs: + type: string + format: nullable + description: Statut de l'entreprise au RCS + example: Inscrit + EntrepriseFiche: + allOf: + - $ref: '#/components/schemas/EntrepriseBase' + - type: object + properties: + siege: + $ref: '#/components/schemas/EtablissementFiche' + diffusable: + type: boolean + description: >- + Le statut de diffusion de l'entreprise. Non diffusable + correspond à une entreprise ayant demandé une diffusion + partielle de ses données. Aucune information n'est alors + disponible, sauf si vous utilisez le paramètre + `integrer_diffusions_partielles`. + sigle: + type: string + format: nullable + description: Sigle de l'entreprise si personne morale. + example: null + objet_social: + type: string + format: nullable + description: Objet social de l'entreprise. + example: >- + Fourniture de services et/ou conseils relatifs aux logiciels au + réseau internet aux réseaux télématiques ou en ligne notamment + L'intermediation en matière de vente de publicité en ligne la + promotion sous toutes ses formes de la publicité en ligne la + promotion directe de produits et services et la mise en oeuvre + de centres de traitement de l'information + capital_formate: + type: string + format: nullable + description: Capital l'entreprise au format xx xxx €. + example: "464 884 017,00\_€" + capital_actuel_si_variable: + type: string + format: nullable + description: Capital actuel de l'entreprise si variable. + example: null + devise_capital: + type: string + format: nullable + description: Devise de capital_formate et capital_actuel_si_variable. + example: Euros + numero_rcs: + type: string + format: nullable + description: Numéro RCS de l'entreprise. + example: 464884017 R.C.S. Paris + date_cloture_exercice: + type: string + format: nullable + description: Date de clôture d'exercice de l'entreprise. + example: null + date_cloture_exercice_exceptionnelle: + type: string + format: nullable + description: Date de clôture d'exercice exceptionnel de l'entreprise. + example: null + date_cloture_exercice_exceptionnelle_formate: + type: string + format: nullable + description: >- + Date de clôture d'exercice exceptionnel formatée de + l'entreprise. + example: null + prochaine_date_cloture_exercice: + type: string + format: nullable + description: Prochaine date de clôture d'exercice de l'entreprise. + example: null + prochaine_date_cloture_exercice_formate: + type: string + format: nullable + description: Prochaine date de clôture d'exercice formatée de l'entreprise. + example: null + economie_sociale_solidaire: + type: boolean + description: >- + Vrai si l'entreprise est une entreprise de l'économie sociale et + solidaire. + duree_personne_morale: + type: string + format: nullable + description: Durée de la personne morale. + example: null + dernier_traitement: + type: string + format: date + description: Date de dernier traitement de l'entreprise. + example: '2020-07-09' + derniere_mise_a_jour_sirene: + type: string + format: date + description: >- + Dernière mise à jour de la base de donnée sirène au format + AAAA-MM-JJ. + example: '2020-08-13' + derniere_mise_a_jour_rcs: + type: string + format: date + description: >- + Dernière mise à jour de la base de donnée RCS au format + AAAA-MM-JJ. + example: '2020-06-25' + statut_rcs: + type: string + enum: + - Inscrit + - Non inscrit + - Radié + description: Statut de l'entreprise au RCS. + example: Inscrit + greffe: + type: string + format: nullable + description: Greffe RCS de l'entreprise. + example: Paris + code_greffe: + type: string + format: nullable + description: Code greffe RCS de l'entreprise. + example: '7501' + date_immatriculation_rcs: + type: string + format: nullable + description: Date d'immatriculation de l'entreprise au RCS. + example: null + date_premiere_immatriculation_rcs: + type: string + format: nullable + description: Date de la première immatriculation de l'entreprise au RCS. + example: null + date_debut_activite: + type: string + format: nullable + description: Date de début d'activité de l'entreprise. + example: '2002-08-14' + date_debut_premiere_activite: + type: string + format: nullable + description: Date de début d'activité de l'entreprise. + example: null + date_radiation_rcs: + type: string + format: nullable + description: Date de radiation de l'entreprise au RCS. + example: null + statut_rne: + type: string + format: nullable + enum: + - Inscrit + - Non inscrit + - Radié + description: Statut de l'entreprise au RNE. + example: null + date_immatriculation_rne: + type: string + format: nullable + description: Date d'immatriculation de l'entreprise au RNE. + example: null + date_radiation_rne: + type: string + format: nullable + description: Date de radiation de l'entreprise au RNE. + example: null + numero_tva_intracommunautaire: + type: string + description: Numéro de TVA intracommunautaire de l'entreprise. + example: FR64443061841 + validite_tva_intracommunautaire: + type: boolean + format: optional, nullable + description: >- + Présent uniquement si le paramètre + validite_tva_intracommunautaire a été mis à vrai. + + + Si vrai, le numéro de TVA intracommunautaire est valide. Si + faux, il est invalide. Si null, la validité n'a pas pu être + vérifiée. + example: true + associe_unique: + type: boolean + format: nullable + description: >- + Si vrai, l'entreprise est à associé unique (notamment pour les + SASU et les EURL). + micro_entreprise: + type: boolean + format: optional + description: Si vrai, l'entreprise possède le statut de micro-entrepreneur + example: false + etablissements: + type: array + description: Liste des établissements de l'entreprise. + items: + $ref: '#/components/schemas/EtablissementFiche' + finances: + type: array + description: Liste des finances de l'entreprise. + items: + allOf: + - type: object + properties: + annee: + type: integer + description: Année de cloture d'exercice. + example: 2018 + date_de_cloture_exercice: + type: string + format: date + description: >- + Date de cloture de l'exercice des finances de + l'entreprise. + example: '2018-12-31' + duree_exercice: + type: integer + description: Durée de l'exercice de l'entreprise." + example: 12 + - $ref: '#/components/schemas/Ratios' + representants: + type: array + description: Liste des représentants de l'entreprise. + items: + $ref: '#/components/schemas/Representant' + beneficiaires_effectifs: + type: array + description: >- + Liste des bénéficiaires effectifs de l'entreprise (si + disponibles). + items: + type: object + properties: + date_greffe: + type: string + format: date nullable + description: >- + Date de génération des bénéficiaires effectifs, au format + AAAA-MM-JJ. + example: '2021-01-06' + type: + type: string + format: nullable + description: Type du bénéficiaire effectif + example: BE_SOC + nom: + type: string + format: nullable + description: Nom du bénéficiaire effectif. + example: McCourt JR + nom_usage: + type: string + format: nullable + description: Nom d'usage du bénéficiaire effectif. + example: null + prenom: + type: string + format: nullable + description: Prénom du bénéficiaire effectif. + example: Frank + pseudonyme: + type: string + format: nullable + example: null + date_de_naissance_formatee: + type: string + format: nullable + description: >- + Mois et année de naissance du bénéficiaire effectif, au + format MM/AAAA. + example: 08/1953 + date_de_naissance_complete_formatee: + type: string + format: date nullable + description: >- + Date de naissance complète du bénéficiaire effectif, au + format JJ/MM/AAAA. + example: 14/08/1953 + nationalite: + type: string + format: nullable + description: Nationalité du bénéficiaire effectif. + example: Américaine (Etats Unis) + code_nationalite: + type: string + format: nullable + description: Code de la nationalité du bénéficiaire effectif. + example: US + ville_de_naissance: + type: string + format: nullable + description: Ville de naissance du bénéficiaire effectif. + example: Massachusetts + pays_de_naissance: + type: string + format: nullable + description: Pays de naissance du bénéficiaire effectif. + example: ETATS-UNIS D'AMERIQUE + code_pays_de_naissance: + type: string + format: nullable + description: Code du pays de naissance du bénéficiaire effectif. + example: US + adresse_ligne_1: + type: string + format: nullable + description: Première ligne de l'adresse du bénéficiaire effectif. + example: null + adresse_ligne_2: + type: string + format: nullable + description: Deuxième ligne de l'adresse du bénéficiaire effectif. + example: 888 Seventh Avenue 43rd Floor New York (Etat de New York) + adresse_ligne_3: + type: string + format: nullable + description: Troisième ligne de l'adresse du bénéficiaire effectif. + example: null + code_postal: + type: string + format: nullable + description: Code postal du bénéficiaire effectif. + example: null + ville: + type: string + format: nullable + description: Ville du bénéficiaire effectif. + example: null + pays: + type: string + format: nullable + description: Pays du bénéficiaire effectif. + example: ETATS-UNIS D'AMERIQUE + code_pays: + type: string + format: nullable + description: Code du pays du bénéficiaire effectif. + example: US + pourcentage_parts: + type: number + format: nullable + description: >- + Parts détenues par le bénéficiaire effectif, en + pourcentage des parts totales. + pourcentage_parts_directes: + type: number + format: nullable + description: >- + Parts détenues de façon directe par le bénéficiaire + effectif, en pourcentage des parts totales. + pourcentage_parts_indirectes: + type: number + format: nullable + description: >- + Parts détenues de façon indirecte par le bénéficiaire + effectif, en pourcentage des parts totales. + pourcentage_parts_vocation_titulaire: + type: number + format: nullable + description: >- + Parts dont le bénéficiaire effectif a vocation à devenir + titulaire par l'effet d'un acte juridique, en pourcentage + des parts totales. + details_parts_directes: + type: object + format: nullable + description: >- + Détails des parts détenues de façon directe par le + bénéficiaire effectif. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Parts détenues de façon directe en pleine propriété + par le bénéficiaire effectif, en pourcentage des parts + totales. + pourcentage_nue_propriete: + type: number + description: >- + Parts détenues de façon directe en nue propriété par + le bénéficiaire effectif, en pourcentage des parts + totales. + details_parts_indirectes: + type: object + format: nullable + description: >- + Détails des parts détenues de façon indirecte par le + bénéficiaire effectif. + properties: + pourcentage_en_indivision: + type: number + description: >- + Parts détenues de façon indirecte par le biais d'une + indivision par le bénéficiaire effectif, en + pourcentage des parts totales. + pourcentage_en_personne_morale: + type: number + description: >- + Parts détenues de façon indirecte par le biais d'une + personne morale par le bénéficiaire effectif, en + pourcentage des parts totales. + details_en_indivision: + type: object + format: nullable + description: >- + Détails des parts détenues de façon indirecte par le + biais d'une indivision par le bénéficiaire effectif. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Parts détenues de façon indirecte par le biais + d'une indivision en pleine propriété par le + bénéficiaire effectif, en pourcentage des parts + totales. + pourcentage_nue_propriete: + type: number + description: >- + Parts détenues de façon indirecte par le biais + d'une indivision en nue propriété par le + bénéficiaire effectif, en pourcentage des parts + totales. + details_en_personne_morale: + type: object + format: nullable + description: >- + Détails des parts détenues de façon indirecte par le + biais d'une personne morale par le bénéficiaire + effectif. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Parts détenues de façon indirecte par le biais + d'une personne morale en pleine propriété par le + bénéficiaire effectif, en pourcentage des parts + totales. + pourcentage_nue_propriete: + type: number + description: >- + Parts détenues de façon indirecte par le biais + d'une personne morale en nue propriété par le + bénéficiaire effectif, en pourcentage des parts + totales. + details_parts_vocation_titulaire: + type: object + format: nullable + description: >- + Détails des parts dont le bénéficiaire effectif a vocation + à devenir titulaire. + properties: + pourcentage_directes: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon directe, en pourcentage des + parts totales. + pourcentage_indirectes: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon indirecte, en pourcentage + des parts totales. + details_directes: + type: object + format: nullable + description: >- + Détails des parts dont le bénéficiaire effectif a + vocation à devenir titulaire de façon directe. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon directe en pleine + propriété, en pourcentage des parts totales. + pourcentage_nue_propriete: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon directe en nue + propriété, en pourcentage des parts totales. + details_indirectes: + type: object + format: nullable + description: >- + Détails des parts dont le bénéficiaire effectif a + vocation à devenir titulaire de façon indirecte. + properties: + pourcentage_en_indivision: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon indirecte par le biais + d'une indivision, en pourcentage des parts + totales. + pourcentage_en_personne_morale: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à + devenir titulaire de façon indirecte par le biais + d'une personne morale, en pourcentage des parts + totales. + details_en_indivision: + type: object + format: nullable + description: >- + Détails des parts dont le bénéficiaire effectif a + vocation à devenir titulaire de façon indirecte + par le biais d'une indivision. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation + à devenir titulaire de façon indirecte par le + biais d'une indivision en pleine propriété, en + pourcentage des parts totales. + pourcentage_nue_propriete: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation + à devenir titulaire de façon indirecte par le + biais d'une indivision en nue propriété, en + pourcentage des parts totales. + details_en_personne_morale: + type: object + format: nullable + description: >- + Détails des parts dont le bénéficiaire effectif a + vocation à devenir titulaire de façon indirecte + par le biais d'une personne morale. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation + à devenir titulaire de façon indirecte par le + biais d'une personne morale en pleine + propriété, en pourcentage des parts totales. + pourcentage_nue_propriete: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation + à devenir titulaire de façon indirecte par le + biais d'une personne morale en nue propriété, + en pourcentage des parts totales. + pourcentage_votes: + type: number + format: nullable + description: >- + Droits de vote détenus par le bénéficiaire effectif, en + pourcentage des droits de vote totaux. + pourcentage_votes_directs: + type: number + format: nullable + description: >- + Droits de vote détenus de façon directe par le + bénéficiaire effectif, en pourcentage des droits de vote + totaux. + pourcentage_votes_indirect: + type: number + format: nullable + description: >- + Droits de vote détenus de façon indirecte par le + bénéficiaire effectif, en pourcentage des droits de vote + totaux. + details_votes_directs: + type: object + format: nullable + description: >- + Détails des droits de vote détenus de façon directe par le + bénéficiaire effectif. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Droits de vote détenus de façon directe en pleine + propriété par le bénéficiaire effectif, en pourcentage + des droits de vote totaux. + pourcentage_nue_propriete: + type: number + description: >- + Droits de vote détenus de façon directe en nue + propriété par le bénéficiaire effectif, en pourcentage + des droits de vote totaux. + pourcentage_usufruit: + type: number + description: >- + Droits de vote détenus de façon directe en usufruit + par le bénéficiaire effectif, en pourcentage des + droits de vote totaux. + details_votes_indirects: + type: object + format: nullable + description: >- + Détails des droits de vote détenus de façon indirecte par + le bénéficiaire effectif. + properties: + pourcentage_en_indivision: + type: number + description: >- + Droits de vote détenus de façon indirecte par le biais + d'une indivision par le bénéficiaire effectif, en + pourcentage des droits de vote totaux. + pourcentage_en_personne_morale: + type: number + description: >- + Droits de vote détenus de façon indirecte par le biais + d'une personne morale par le bénéficiaire effectif, en + pourcentage des droits de vote totaux. + details_en_indivision: + type: object + format: nullable + description: >- + Détails des droits de vote détenus de façon indirecte + par le biais d'une indivision par le bénéficiaire + effectif. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une indivision en pleine propriété par le + bénéficiaire effectif, en pourcentage des droits + de vote totaux. + pourcentage_nue_propriete: + type: number + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une indivision en nue propriété par le + bénéficiaire effectif, en pourcentage des droits + de vote totaux. + pourcentage_usufruit: + type: number + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une indivision en usufruit par le + bénéficiaire effectif, en pourcentage des droits + de vote totaux. + details_en_personne_morale: + type: object + format: nullable + description: >- + Détails des droits de vote détenus de façon indirecte + par le biais d'une personne morale par le bénéficiaire + effectif. + properties: + pourcentage_pleine_propriete: + type: number + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une personne morale en pleine propriété + par le bénéficiaire effectif, en pourcentage des + droits de vote totaux. + pourcentage_nue_propriete: + type: number + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une personne morale en nue propriété par + le bénéficiaire effectif, en pourcentage des + droits de vote totaux. + pourcentage_usufruit: + type: number + description: >- + Droits de vote détenus de façon indirecte par le + biais d'une personne morale en usufruit par le + bénéficiaire effectif, en pourcentage des droits + de vote totaux. + details_societe_de_gestion: + type: object + format: nullable + description: Détails sur la société de gestion, le cas échéant. + properties: + nom: + type: string + format: nullable + description: Nom de la société de gestion. + siren: + type: string + format: nullable + description: SIREN de la société de gestion. + greffe: + type: string + format: nullable + description: Greffe de la société de gestion. + adresse: + type: string + format: nullable + description: Adresse de la société de gestion. + code_postal: + type: string + format: nullable + description: Code postal de la société de gestion. + ville: + type: string + format: nullable + description: Ville de la société de gestion. + detention_pouvoir_decision_ag: + type: boolean + description: >- + Vaut vrai pour les moyens de contrôle sur les organes + d'administration, de gestion, de direction ou de + surveillance de la personne morale autre que le pouvoir de + nommer ou de révoquer la majorité des membres. + detention_pouvoir_nom_membre_conseil_administration: + type: boolean + description: >- + Vaut vrai si le moyen de contrôle est le pouvoir de nommer + ou de révoquer la majorité des membres des organes + d'administration, de gestion, de direction ou de + surveillance de la personne morale. + detention_autres_moyens_controle: + type: boolean + description: Vaut vrai s'il existe d'autres moyens de contrôle. + beneficiaire_representant_legal: + type: boolean + description: >- + Vaut vrai dans le cas où le bénéficiaire effectif a été + défini comme le représentant légal par défaut. + representant_legal_placement_sans_gestion_delegation: + type: boolean + description: >- + Vaut vrai dans le cas où le bénéficiaire effectif est le + représentant légal du placement collectif (cas où le + placement collectif n'a pas délégué sa gestion à une + société de gestion). + personne_politiquement_exposee: + $ref: '#/components/schemas/PersonnePolitiquementExposee' + sanctions_en_cours: + type: boolean + format: optional + description: >- + Vaut vrai si le bénéficiaire effectif est actuellement + sous sanction. Uniquement présent si demandé dans les + champs supplémentaires. + sanctions: + type: array + description: >- + Liste des sanctions du bénéficiaire effectif. Uniquement + présent si demandé dans les champs supplémentaires. + items: + $ref: '#/components/schemas/Sanction' + depots_actes: + type: array + description: Liste des actes de l'entreprise. + items: + type: object + properties: + date_depot: + type: string + format: date + description: Date de dépôt de l'acte, au format AAAA-MM-JJ. + example: '2020-04-07' + date_depot_formate: + type: string + description: Date de dépôt formatée de l'acte, au format JJ/MM/AAAA. + example: 07/04/2020 + disponible: + type: boolean + description: >- + Disponibilité de l'acte. Un acte peut être indisponible + car il a été publié avant le 1er janvier 1993 ou bien car + il est confidentiel. + nom_fichier_pdf: + type: string + description: Nom du fichier pdf de l'acte. + example: GOOGLE FRANCE - Actes du 07-04-2020.pdf + token: + type: string + description: Token de l'acte. + example: >- + QTQ0MzA2MTg0MTIwMjAwNDA3RMOpY2lzaW9uKHMpIGRlIGwnYXNzb2Npw6kgdW5pcXVl + actes: + type: array + description: Détails de l'acte. + items: + type: object + properties: + type: + type: string + description: Type de l'acte. + example: Décision(s) de l'associé unique + decision: + type: string + format: nullable + description: Décision de l'acte. + example: Augmentation du capital social + date_acte: + type: string + format: date nullable + description: Date de l'acte, au format AAAA-MM-JJ. + example: '2020-03-04' + date_acte_formate: + type: string + format: nullable + description: Date formatée de l'acte, au format JJ/MM/AAAA. + example: 04/03/2020 + comptes: + type: array + description: Liste des comptes de l'entreprise. + items: + type: object + properties: + date_depot: + type: string + format: date + description: Date de dépôt des comptes. + example: '2020-07-16' + date_depot_formate: + type: string + description: Date de dépôt formatée des comptes. + example: 16/07/2020 + date_cloture: + type: string + format: date + description: Date de clôture des comptes, au format AAAA-MM-JJ. + example: '2019-12-31' + annee_cloture: + type: integer + description: Année de clôture des comptes. + example: 2019 + confidentialite: + description: Confidentialité totale des comptes. + type: boolean + confidentialite_compte_de_resultat: + description: >- + Confidentialité partielle des comptes (seul le compte de + résultat est confidentiel, le reste des comptes sont + disponibles). + type: boolean + disponible: + description: Disponibilité des comptes au format PDF. + type: boolean + nom_fichier_pdf: + type: string + format: optional + description: Nom du fichier PDF des comptes. + example: GOOGLE FRANCE - Comptes 2019.pdf + token: + type: string + format: optional + description: Token des comptes. + example: QzQ0MzA2MTg0MTIwMjAwNzE2 + disponible_xlsx: + description: Disponibilité des comptes au format XLSX. + type: boolean + nom_fichier_xlsx: + type: string + format: optional + description: Nom du fichier XLSX des comptes. + example: GOOGLE FRANCE - Comptes 2019.xlsx + token_xlsx: + type: string + format: optional + description: Token des comptes XLSX. + example: ASQSMAA2MTg8MTIwMjAwNz2s + publications_bodacc: + type: array + description: Liste des publications au Bodacc de l'entreprise. + items: + $ref: '#/components/schemas/Bodacc' + procedures_collectives: + type: array + description: Liste des procédures collectives de l'entreprise. + items: + type: object + properties: + type: + type: string + description: Type de la procédure collective. + example: Redressement judiciaire + enum: + - Redressement judiciaire + - Liquidation judiciaire ou Procédure de sauvegarde + date_debut: + type: string + description: >- + Date de début de la procédure collective, au format + AAAA-MM-JJ. + example: '2020-04-16T00:00:00.000Z' + date_fin: + type: string + description: >- + Date de fin de la procédure collective, au format + AAAA-MM-JJ. + example: '2020-08-27T00:00:00.000Z' + publications_bodacc: + type: array + description: >- + Liste des publications relatives à la procédure + collective. + items: + $ref: '#/components/schemas/Bodacc' + procedure_collective_existe: + description: >- + Vrai si l'entreprise a des procédures collectives (en cours ou + terminées), faux sinon. + type: boolean + procedure_collective_en_cours: + description: >- + Vrai si l'entreprise a des procédures collectives en cours, faux + sinon. + type: boolean + derniers_statuts: + type: object + description: Liste des statuts de l'entreprise. + properties: + date_depot: + type: string + format: date + description: Date de dépôt des statuts, au format AAAA-MM-JJ. + example: '2020-04-07' + date_depot_formate: + type: string + description: Date de dépôt formaté des statuts, au format JJ/MM/AAAA. + example: 07/04/2020 + disponible: + description: Disponibilité des statuts. + type: boolean + nom_fichier_pdf: + type: string + description: Nom du fichier pdf des statuts. + example: GOOGLE FRANCE - Actes du 07-04-2020.pdf + token: + type: string + description: Token des statuts. + example: >- + QTQ0MzA2MTg0MTIwMjAwNDA3RMOpY2lzaW9uKHMpIGRlIGwnYXNzb2Npw6kgdW5pcXVl + type: + type: string + description: Champ "type" du document contenant les statuts. + example: Statuts mis à jour + decision: + type: string + format: nullable + description: Champ "decision" du document contenant les statuts. + example: null + date_acte: + type: string + format: date + description: Date de publication des statuts, au format AAAA-MM-JJ. + example: '2020-03-04' + date_acte_formate: + type: string + description: Date de publication des statuts, au format JJ/MM/AAAA. + example: 04/03/2020 + extrait_immatriculation: + type: object + description: Extrait d'immatriculation de l'entreprise. + properties: + token: + type: string + description: Token + example: SzQ0MzA2MTg0MQ + rnm: + type: object + format: nullable + description: >- + Informations sur l'immatriculation de l'entreprise au Répertoire + des Métiers. + properties: + date_immatriculation: + type: string + description: >- + Date d'immatriculation au Répertoire des Métiers, au format + AAAA-MM-JJ. + example: '2021-02-16T00:00:00.000Z' + date_radiation: + type: string + format: nullable + description: >- + Date de radiation du Répertoire des Métiers, le cas échéant, + au format AAAA-MM-JJ. + example: null + date_debut_activite: + type: string + description: >- + Date de début d'activé déclarée au Répertoire des Métiers, + au format AAAA-MM-JJ. + example: '2021-01-01T00:00:00.000Z' + date_cessation_activite: + type: string + format: nullable + description: >- + Date de cessation d'activité déclarée au Répertoire des + Métiers, le cas échéant, au format AAAA-MM-JJ. + example: null + chambre_des_metiers: + type: string + description: Chambre des métiers où l'entreprise est immatriculée. + example: TARN-ET-GARONNE + qualification: + type: string + description: Qualification retenue par le Répertoire des Métiers. + example: ARTISAN + derniere_mise_a_jour: + type: string + description: >- + Date de dernière mise à jour de l'entreprise au Répertoire + des Métiers, au format AAAA-MM-JJ. + example: '2021-02-22T00:00:00.000Z' + marques: + type: array + description: >- + Liste des marques françaises déposées par l'entreprise. + Uniquement présent si le paramètre "marques" a été mis à vrai. + items: + type: object + properties: + numero: + type: string + description: Numéro de la marque. + example: FR7103728 + date_enregistrement: + type: string + description: Date d'enregistrement de la marque, au format AAAA-MM-JJ. + example: '2008-12-04T00:00:00.000Z' + date_expiration: + type: string + description: Date d'expiration de la marque au format AAAA-MM-JJ. + example: '2018-12-04T00:00:00.000Z' + lieu_enregistrement: + type: string + description: Lieu d'enregistrement de la marque. + example: 92 INPI - Dépôt électronique + statut: + type: string + description: >- + Statut de la marque. La description des différents types + est disponible en page 14 du document suivant : + https://www.inpi.fr/sites/default/files/doctech_marques_v1.6.pdf. + enum: + - Demande déposée + - Demande publiée + - Demande non publiée + - Demande irrecevable après publication + - Marque enregistrée + - Renouvellement demandé + - Marque renouvelée + - Demande totalement rejetée + - Marque ayant fait l'objet d'une renonciation totale + - Marque ayant fait l'objet d'un retrait total + - Marque annulée + - Marque expirée + example: Marque enregistrée + texte: + type: string + format: nullable + description: Texte de la marque. + example: Google + type: + type: string + description: Type de la marque. + enum: + - Mixte + - Figuratif + - Hologramme + - Son + - Texte + - 3D + - Position + - Mouvement + - Multimedia + - Motifs + - Couleur + - Forme + - Autre + example: Figurative + lien_image: + type: string + format: nullable + description: Lien vers l'image déposée. + example: https://data.inpi.fr/image/marques/FRXXXXXXXX + descriptions: + type: array + description: Liste des descriptions de la marque. + items: + type: string + description: Description + example: 'Demande d’extension : Polynésie française' + classes: + type: array + description: >- + Liste des classes (produits et services) de la marque. La + liste des classes est disponible sur le document suivant : + https://www.inpi.fr/sites/default/files/classification_nice_2021_0.pdf. + items: + type: object + properties: + code: + type: string + description: Code de la classe. + example: 35 + description: + type: string + description: Description de la classe. + example: >- + Publicité ; gestion des affaires commerciales ; + administration commerciale ; travaux de bureau. + deposant: + $ref: '#/components/schemas/PersonneMarque' + mandataire: + $ref: '#/components/schemas/PersonneMarque' + evenements: + type: array + description: Liste des événements associés à la marque. + items: + type: object + properties: + type: + type: string + description: Type d'événement. + example: Publication + identifiant_evenement: + type: string + format: nullable + description: Identifiant de l'événement. + reference: + type: string + format: nullable + description: Référence de l'événement. + date: + type: string + description: Date de l'événement, au format AAAA-MM-JJ. + example: '2008-12-04T00:00:00.000Z' + numero_bopi: + type: string + description: Numéro du BOPI dans lequel l'événement a été publié. + example: 2008-12 + date_bopi: + type: string + description: Date de publication du BOPI au format AAAA-MM-JJ. + example: '2008-12-04T00:00:00.000Z' + beneficiaire: + type: string + format: nullable + description: Bénéficiaire associé à l'événement. + association: + $ref: '#/components/schemas/Association' + labels: + type: array + description: >- + Liste des labels de l'entreprise. Uniquement présent si demandé + dans les champs supplémentaires. + items: + $ref: '#/components/schemas/Labels' + scoring_non_financier: + $ref: '#/components/schemas/ScoringNonFinancier' + scoring_financier: + $ref: '#/components/schemas/ScoringFinancier' + EntrepriseRecherche: + allOf: + - $ref: '#/components/schemas/EntrepriseBase' + - type: object + properties: + siege: + $ref: '#/components/schemas/EtablissementRecherche' + villes: + type: array + description: Liste des villes où l'entreprise a au moins un établissement. + items: + type: string + example: MONTPELLIER + chiffre_affaires: + type: integer + format: nullable + description: Chiffre d'affaires de l'entreprise. + example: 411016329 + resultat: + type: integer + format: nullable + description: Résultat de l'entreprise. + example: 29327087 + effectifs_finances: + type: integer + format: nullable + description: Effectif de l'entreprise. + example: 723 + annee_finances: + type: string + format: nullable + description: >- + Année de correspondance des variables financières + (chiffre_affaires, resultat, effectifs_finances). + example: '2018' + EtablissementFiche: + type: object + properties: + siret: + type: string + description: Numéro siret de l'établissement au format xxxxxxxxxxxxxx. + example: '44306184100047' + siret_formate: + type: string + description: Numéro siret de l'établissement au format xxx xxx xxx xxxxx. + example: 443 061 841 00047 + diffusion_partielle: + type: boolean + description: >- + Si vrai, l'établissement est en diffusion partielle. Dans ce cas, + tous les champs relatifs à son adresse - en dehors de la ville et du + pays - sont à `null`. + nic: + type: string + description: Numéro NIC de l'établissement. + example: '00047' + code_postal: + type: string + format: nullable + description: Code postal de l'établissement. + example: '75009' + ville: + type: string + format: nullable + description: Ville de l'établissement. + example: PARIS 9 + pays: + type: string + format: nullable + description: Pays de l'établissement + example: France + code_pays: + type: string + format: nullable + description: Code du pays de l'établissement + example: FR + latitude: + type: number + format: nullable + description: Latitude de l'établissement. + example: 48.876947 + longitude: + type: number + format: nullable + description: Longitude de l'établissement. + example: 2.329981 + etablissement_cesse: + type: boolean + format: nullable + description: Vrai si l'établissement est cessé, faux si il est en activité. + siege: + type: boolean + format: nullable + description: Vrai si l'établissement est siège, faux s'il ne l'est pas. + etablissement_employeur: + type: boolean + format: nullable + description: Si vrai, l'établissement a au moins un employé. + effectif: + type: string + format: nullable + description: Tranche d'effectif de l'établissement. + example: Entre 500 et 999 salariés + effectif_min: + type: integer + format: nullable + description: Effectif minimal de l'établissement. + example: 500 + effectif_max: + type: integer + format: nullable + description: Effectif maximal de l'établissement. + example: 999 + tranche_effectif: + type: string + format: nullable + description: >- + Tranche d'effectif de l'établissement, selon la [nomenclature + Sirene](https://www.sirene.fr/sirene/public/variable/tefen#:~:text=Cette%20variable%20correspond%20%C3%A0%20la,effectif%20salari%C3%A9%20de%20l'entreprise.). + example: '41' + annee_effectif: + type: integer + format: nullable + description: Année correspondante à la tranche d'effectif de l'établissement. + example: 2017 + code_naf: + type: string + format: nullable + description: Code NAF de l'établissement. + example: 70.10Z + libelle_code_naf: + type: string + format: nullable + description: Libellé du code NAF de l'établissement. + example: Activités des sièges sociaux + date_de_creation: + type: string + format: nullable + example: '2011-05-12T22:00:00.000Z' + numero_voie: + type: integer + format: nullable + description: Numéro de voie de l'établissement. + example: 8 + indice_repetition: + type: string + format: nullable + description: Indice de répétition de l'établissement. + example: null + type_voie: + type: string + format: nullable + description: Type de voie de l'établissement. + example: RUE + libelle_voie: + type: string + format: nullable + description: Libellé de la voie de l'établissement. + example: DE LONDRES + complement_adresse: + type: string + format: nullable + description: Complément d'adresse de l'établissement. + example: null + adresse_ligne_1: + type: string + format: nullable + description: >- + Première ligne de l'adresse de l'établissement. Correspond à + l'ensemble des données numero_voie, indice_repetition, type_voie et + libelle_voie. + example: 8 RUE DE LONDRES + adresse_ligne_2: + type: string + format: nullable + description: >- + Seconde ligne de l'adresse de l'établissement. Est égal à + complement_adresse + example: null + date_cessation: + type: string + format: nullable + description: Date de fermeture de l'établissement + example: '2014-05-12' + enseigne: + type: string + format: nullable + description: Enseigne de l'établissement + example: FROOGLE + nom_commercial: + type: string + format: nullable + description: Nom commercial de l'établissement + example: Froogle + domiciliation: + type: object + format: nullable + properties: + nom: + type: string + format: nullable + description: Nom de l'entreprise de domiciliation + example: WORK & SHARE + siren: + type: string + format: nullable + description: Siren de l'entreprise de domiciliation + example: '828053546' + predecesseurs: + type: array + format: optional + description: Liste des prédécesseurs de l'établissement. + items: + $ref: '#/components/schemas/LienSuccession' + successeurs: + type: array + format: optional + description: Liste des successeurs de l'établissement. + items: + $ref: '#/components/schemas/LienSuccession' + EtablissementRecherche: + type: object + properties: + siret: + type: string + description: Numéro siret de l'établissement au format xxxxxxxxxxxxxx. + example: '44306184100047' + siret_formate: + type: string + description: Numéro siret de l'établissement au format xxx xxx xxx xxxxx. + example: 443 061 841 00047 + nic: + type: string + description: Numéro NIC de l'établissement. + example: '00047' + numero_voie: + type: integer + format: nullable + description: Numéro de voie de l'établissement. + example: 8 + indice_repetition: + type: string + format: nullable + description: Indice de répétition de l'établissement. + example: null + type_voie: + type: string + format: nullable + description: Type de voie de l'établissement. + example: RUE + libelle_voie: + type: string + format: nullable + description: Libellé de la voie de l'établissement. + example: DE LONDRES + complement_adresse: + type: string + format: nullable + description: Complément d'adresse de l'établissement. + example: null + adresse_ligne_1: + type: string + format: nullable + description: >- + Première ligne de l'adresse de l'établissement. Correspond à + l'ensemble des données numero_voie, indice_repetition, type_voie et + libelle_voie. + example: 8 RUE DE LONDRES + adresse_ligne_2: + type: string + format: nullable + description: >- + Seconde ligne de l'adresse de l'établissement. Est égal à + complement_adresse + example: null + code_postal: + type: string + format: nullable + description: Code postal de l'établissement. + example: '75009' + ville: + type: string + format: nullable + description: Ville de l'établissement. + example: PARIS 9 + latitude: + type: number + format: nullable + description: Latitude de l'établissement. + example: 48.876947 + longitude: + type: number + format: nullable + description: Longitude de l'établissement. + example: 2.329981 + RepresentantSuggestions: + type: object + properties: + qualite: + type: string + description: Qualité du représentant. + example: Gérant + personne_morale: + description: >- + Vrai si le représentant est une personne morale, faux si personne + physique. + type: boolean + example: false + date_prise_de_poste: + type: string + description: Date de prise de poste du représentant. + example: '2017-08-03' + denomination: + type: string + description: Dénomination du représentant si personne morale. + format: optional + example: GOOGLE FRANCE + siren: + type: string + description: Siren du représentant si personne morale. + format: optional + example: '443061841' + forme_juridique: + type: string + format: optional + description: Forme juridique du représentant si personne morale. + example: Société par actions simplifiée + sexe: + type: string + description: >- + Sexe supposé du représentant si personne physique. F pour féminin, M + pour masculin. Ce champ est estimé à partir du prénom du + représentant. + format: optional + example: M + nom: + type: string + description: Nom du représentant. + format: optional + example: Yi + prenom: + type: string + description: Prénoms du représentant. + format: optional + example: Kenneth H. + prenom_usuel: + type: string + description: Prénom usuel du représentant. + format: optional + example: Kenneth + nom_complet: + type: string + description: Nom complet du représentant. + example: Kenneth H. Yi + date_de_naissance: + type: string + description: Date de naissance du représentant. + format: optional nullable + example: '1970-01-06' + date_de_naissance_formate: + type: string + description: Date de naissance formatée du représentant. + format: optional nullable + example: 06/01/1970 + age: + type: integer + description: Age du représentant. + format: optional + example: 50 + nationalite: + type: string + description: Nationalité du représentant. + format: optional + example: Américaine (Etats Unis) + code_nationalite: + type: string + description: Code nationalité du représentant + format: optional + example: US + ville_de_naissance: + type: string + description: Ville de naissance du représentant. + format: optional + example: Séoul + pays_de_naissance: + type: string + description: Pays de naissance du représentant. + format: optional + example: COREE DU SUD + code_pays_de_naissance: + type: string + description: Code du pays de naissance du représentant. + format: optional + example: KR + adresse_ligne_1: + type: string + description: Première ligne de l'adresse du représentant. + format: nullable + example: 1600 Amphitheatre Parkway Mountain View CA 94043 + adresse_ligne_2: + type: string + description: Deuxième ligne de l'adresse du représentant. + format: nullable + example: null + adresse_ligne_3: + type: string + description: Troisième ligne de l'adresse du représentant. + format: nullable + example: null + code_postal: + type: string + description: Code postal du représentant. + format: nullable + example: null + ville: + type: string + description: Ville du représentant. + format: nullable + example: null + pays: + type: string + format: nullable + description: Pays du représentant. + example: Etats-Unis + code_pays: + type: string + format: nullable + description: Code du pays du représentant + example: US + Representant: + type: object + properties: + qualite: + type: string + description: Qualité du représentant. + example: Gérant + personne_morale: + description: >- + Vrai si le représentant est une personne morale, faux si personne + physique. + type: boolean + example: false + date_prise_de_poste: + type: string + description: Date de prise de poste du représentant. + example: '2017-08-03' + denomination: + type: string + description: Dénomination du représentant si personne morale. + format: optional + example: GOOGLE FRANCE + siren: + type: string + description: Siren du représentant si personne morale. + format: optional + example: '443061841' + forme_juridique: + type: string + format: optional + description: Forme juridique du représentant si personne morale. + example: Société par actions simplifiée + sexe: + type: string + description: >- + Sexe supposé du représentant si personne physique. F pour féminin, M + pour masculin. Ce champ est estimé à partir du prénom du + représentant. + format: optional + example: M + nom: + type: string + description: Nom du représentant. + format: optional + example: Yi + prenom: + type: string + description: Prénoms du représentant. + format: optional + example: Kenneth H. + prenom_usuel: + type: string + description: Prénom usuel du représentant. + format: optional + example: Kenneth + nom_complet: + type: string + description: Nom complet du représentant. + example: Kenneth H. Yi + date_de_naissance: + type: string + description: Date de naissance du représentant. + format: optional nullable + example: '1970-01-06' + date_de_naissance_formate: + type: string + description: Date de naissance formatée du représentant. + format: optional nullable + example: 06/01/1970 + age: + type: integer + description: Age du représentant. + format: optional + example: 50 + nationalite: + type: string + description: Nationalité du représentant. + format: optional + example: Américaine (Etats Unis) + code_nationalite: + type: string + description: Code nationalité du représentant + format: optional + example: US + ville_de_naissance: + type: string + description: Ville de naissance du représentant. + format: optional + example: Séoul + pays_de_naissance: + type: string + description: Pays de naissance du représentant. + format: optional + example: COREE DU SUD + code_pays_de_naissance: + type: string + description: Code du pays de naissance du représentant. + format: optional + example: KR + adresse_ligne_1: + type: string + description: Première ligne de l'adresse du représentant. + format: nullable + example: 1600 Amphitheatre Parkway Mountain View CA 94043 + adresse_ligne_2: + type: string + description: Deuxième ligne de l'adresse du représentant. + format: nullable + example: null + adresse_ligne_3: + type: string + description: Troisième ligne de l'adresse du représentant. + format: nullable + example: null + code_postal: + type: string + description: Code postal du représentant. + format: nullable + example: null + ville: + type: string + description: Ville du représentant. + format: nullable + example: null + pays: + type: string + format: nullable + description: Pays du représentant. + example: Etats-Unis + code_pays: + type: string + format: nullable + description: Code du pays du représentant + example: US + personne_politiquement_exposee: + $ref: '#/components/schemas/PersonnePolitiquementExposee' + sanctions_en_cours: + type: boolean + format: optional + description: >- + Vaut vrai si le représentant est actuellement sous sanction. + Uniquement présent si demandé dans les champs supplémentaires. + sanctions: + type: array + description: >- + Liste des sanctions du représentant. Uniquement présent si demandé + dans les champs supplémentaires. + items: + $ref: '#/components/schemas/Sanction' + PersonnePolitiquementExposee: + type: object + format: optional + description: >- + Informations sur le statut de personne politiquement exposée. Uniquement + présent si demandé dans les champs supplémentaires. + properties: + en_cours: + type: boolean + format: nullable + description: Vaut vrai si la personne est actuellement politiquement exposée. + fonctions: + type: array + description: >- + Liste des fonctions actuelles et passées de la personne + politiquement exposée. + items: + type: object + properties: + fonction: + type: string + description: Nom de la fonction. + example: Premier ministre + pays: + type: string + format: nullable + description: Pays associé à la fonction. + example: France + code_pays: + type: string + format: nullable + description: Code pays associé à la fonction. + example: FR + en_cours: + type: boolean + format: nullable + description: Vaut vrai si la fonction est en cours. + example: true + date_debut: + type: string + format: nullable + description: Date de début de la fonction. + example: '2020-08-20' + date_fin: + type: string + format: nullable + description: Date de fin de la fonction. + example: '2022-08-20' + sources: + type: array + description: Liste des sources. + items: + type: object + properties: + nom: + type: string + description: Nom de la source. + example: CIA World Factbook heads of state and government + url: + type: string + format: nullable + description: Lien vers la source. + example: >- + https://www.opensanctions.org/datasets/us_cia_world_factbook + Sanction: + type: object + format: optional + properties: + description: + type: string + description: Description de la sanction. + example: Interdiction de gérer + autorite: + type: string + format: nullable + description: Autorité ayant prononcé la sanction. + example: Tribunal de commerce de Paris + pays: + type: string + format: nullable + description: Pays de la sanction. + example: France + code_pays: + type: string + format: nullable + description: Code du pays de la sanction. + example: FR + en_cours: + type: boolean + format: nullable + description: Vaut vrai si la sanction est en cours. + example: false + date_debut: + type: string + format: nullable + description: Date de début de la sanction. + example: '2020-08-20' + date_fin: + type: string + format: nullable + description: Date de fin de la sanction. + example: '2022-08-20' + sources: + type: array + description: Liste des sources. + items: + type: object + properties: + nom: + type: string + description: Nom de la source. + example: CIA World Factbook heads of state and government + url: + type: string + format: nullable + description: Lien vers la source. + example: https://www.opensanctions.org/datasets/us_cia_world_factbook + RepresentantRecherche: + allOf: + - $ref: '#/components/schemas/Representant' + - type: object + properties: + actuel: + type: boolean + description: Vaut vrai si le représentant est toujours à son poste. + date_depart_de_poste: + type: string + description: >- + Date de départ de poste dans le cas où le représentant n'est + plus un représentant actuel, au format AAAA-MM-JJ. + example: null + forme_juridique: + type: string + format: nullable + description: >- + Forme juridique du représentant dans le cas d'une personne + morale. + example: null + Beneficiaire: + type: object + properties: + nom: + type: string + format: nullable + description: Nom du bénéficiaire effectif. + example: Yi + nom_usage: + type: string + format: nullable + description: Nom d'usage du bénéficiaire effectif. + example: null + prenom: + type: string + description: Prénom du bénéficiaire effectif. + example: Kenneth H. + pseudonyme: + type: string + format: nullable + description: Pseudonyme du bénéficiaire effectif. + example: null + nom_complet: + type: string + description: Nom complet du bénéficiaire effectif. + example: Kenneth H. Yi + date_de_naissance_formate: + type: string + description: >- + Mois et année de naissance du bénéficiaire effectif, au format + MM/AAAA. + example: 01/1970 + nationalite: + type: string + description: Nationalité du bénéficiaire effectif. + example: Française + pourcentage_parts: + type: number + description: >- + Parts détenues par le bénéficiaire effectif, en pourcentage des + parts totales. + pourcentage_votes: + type: number + description: >- + Droits de vote détenus par le bénéficiaire effectif, en pourcentage + des droits de vote totaux. + pourcentage_votes_indirect: + type: number + description: >- + Droits de vote détenus de façon indirecte par le bénéficiaire + effectif, en pourcentage des droits de vote totaux. + pourcentage_votes_directs: + type: number + description: >- + Droits de vote détenus de façon directe par le bénéficiaire + effectif, en pourcentage des droits de vote totaux. + detention_autres_moyens_controle: + type: boolean + description: Vaut vrai s'il existe d'autres moyens de contrôle. + beneficiaire_representant_legal: + type: boolean + description: >- + Vaut vrai dans le cas où le bénéficiaire effectif a été défini comme + le représentant légal par défaut. + adresse_ligne_1: + type: string + format: nullable + description: Première ligne de l'adresse du bénéficiaire effectif. + example: null + adresse_ligne_2: + type: string + format: nullable + description: Deuxième ligne de l'adresse du bénéficiaire effectif. + example: null + adresse_ligne_3: + type: string + format: nullable + description: Troisième ligne de l'adresse du bénéficiaire effectif. + example: null + pourcentage_parts_vocation_titulaire: + type: number + description: >- + Parts dont le bénéficiaire effectif a vocation à devenir titulaire + par l'effet d'un acte juridique, en pourcentage des parts totales. + representant_legal_placement_sans_gestion_delegation: + type: boolean + format: nullable + description: >- + Vaut vrai dans le cas où le bénéficiaire effectif est le + représentant légal du placement collectif (cas où le placement + collectif n'a pas délégué sa gestion à une société de gestion). + code_postal: + type: string + format: nullable + description: Code postal du bénéficiaire effectif. + example: null + detention_pouvoir_nom_membre_conseil_administration: + type: boolean + description: >- + Vaut vrai si le moyen de contrôle est le pouvoir de nommer ou de + révoquer la majorité des membres des organes d'administration, de + gestion, de direction ou de surveillance de la personne morale. + ville: + type: string + format: nullable + description: Ville du bénéficiaire effectif. + example: null + date_de_naissance_complete_formatee: + type: string + format: date + description: >- + Date de naissance complète du bénéficiaire effectif, au format + JJ/MM/AAAA. + example: 14/08/1953 + pourcentage_parts_directes: + type: number + description: >- + Parts détenues de façon directe par le bénéficiaire effectif, en + pourcentage des parts totales. + pourcentage_parts_indirectes: + type: number + description: >- + Parts détenues de façon indirecte par le bénéficiaire effectif, en + pourcentage des parts totales. + pays_de_naissance: + type: string + format: nullable + description: Pays de naissance du bénéficiaire effectif. + example: null + code_pays_de_naissance: + type: string + format: nullable + description: Code du pays de naissance du bénéficiaire effectif. + example: null + ville_de_naissance: + type: string + format: nullable + description: Ville de naissance du bénéficiaire effectif. + example: null + detention_pouvoir_decision_ag: + type: boolean + description: >- + Vaut vrai pour les moyens de contrôle sur les organes + d'administration, de gestion, de direction ou de surveillance de la + personne morale autre que le pouvoir de nommer ou de révoquer la + majorité des membres. + pays: + type: string + format: nullable + description: Pays du bénéficiaire effectif. + example: null + date_de_naissance_formatee: + type: string + format: nullable + description: >- + Mois et année de naissance du bénéficiaire effectif, au format + MM/AAAA. + example: null + code_pays: + type: string + format: nullable + description: Code pays du bénéficiaire effectif. + example: null + Document: + type: object + properties: + type: + type: string + enum: + - acte + - comptes + description: Type de document + example: acte + date_depot: + description: Date de dépôt du document + type: string + format: date + example: '2020-08-04T00:00:00.000Z' + mentions: + type: array + description: Mentions de la recherche dans le document. + items: + type: string + discriminator: + propertyName: type + mapping: + acte: '#/components/schemas/DocumentActe' + comptes: '#/components/schemas/DocumentComptes' + DocumentActe: + allOf: + - $ref: '#/components/schemas/Document' + - type: object + properties: + titres: + type: array + description: Titres des actes associés au document + items: + type: object + properties: + type: + type: string + description: Type de l'acte + example: Décision(s) de l'associé unique + decision: + type: string + format: nullable + description: Décision de l'acte + example: Augmentation du capital social + DocumentComptes: + allOf: + - $ref: '#/components/schemas/Document' + - type: object + properties: + date_cloture: + type: string + format: date + description: Date de clôture des comptes, au format AAAA-MM-JJ. + example: '2019-12-31' + Publication: + type: object + properties: + type: + type: string + enum: + - Création + - Immatriculation + - Modification + - Vente + - Radiation + - Procédure collective + - Dépôt des comptes + description: Type de publication + example: acte + date: + description: Date de publication, au format AAAA-MM-JJ. + type: string + format: date + example: '2020-08-04T00:00:00.000Z' + contenu: + type: string + description: >- + Contenu de la publication, avec les mentions correspondant à la + recherche encerclée par une balise HTML . + Bodacc: + type: object + properties: + numero_parution: + type: string + description: Numéro de parution de la publication. + example: '20200075' + date: + type: string + description: Date de la publication, au format AAAA-MM-JJ. + example: '2020-04-16T00:00:00.000Z' + numero_annonce: + type: string + description: Numéro d'annonce de la publication. + example: '670' + bodacc: + type: string + description: Bodacc de la publication (A, B ou C). + example: B + type: + type: string + description: >- + Type de la publication parmi la liste suivante : Création, + Immatriculation, Modification, Vente, Achat, Radiation, Procédure + collective, Dépôt des comptes. + example: Modification + greffe: + type: string + description: Greffe de publication. + example: Paris + discriminator: + propertyName: type + mapping: + Création: '#/components/schemas/BodaccCreation' + Immatriculation: '#/components/schemas/BodaccImmatriculation' + Modification: '#/components/schemas/BodaccModification' + Vente: '#/components/schemas/BodaccVente' + Achat: '#/components/schemas/BodaccAchat' + Radiation: '#/components/schemas/BodaccRadiation' + Procédure collective: '#/components/schemas/BodaccProcedureCollective' + Dépôt des comptes: '#/components/schemas/BodaccDepotDesComptes' + BodaccCreation: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + type: string + format: nullable + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + example: GOOGLE FRANCE + personne_morale: + type: boolean + format: nullable + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + example: GOOGLE FRANCE + denomination: + type: string + format: nullable + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + example: GOOGLE FRANCE + nom: + type: string + format: nullable + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + prenom: + type: string + format: nullable + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + administration: + type: string + format: nullable + description: Administration (dans le cas d'une personne morale). + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + type: string + format: nullable + description: Adresse de l'entreprise concernée par la publication. + example: 8 rue de Londres 75009 Paris + capital: + type: number + format: nullable + description: Capital de l'entreprise concernée par la publication. + example: '464884017' + activite: + type: string + format: nullable + description: Activité de l'entreprise concernée par la publication. + example: >- + Fourniture de services et/ou conseils relatifs aux logiciels, au + réseau internet. + date_debut_activite: + type: string + format: nullable + description: >- + Date de début d'activité de l'entreprise concernée par la + publication, au format AAAA-MM-JJ. + example: '2020-08-02T00:00:00.000Z' + BodaccImmatriculation: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + type: string + format: nullable + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + example: GOOGLE FRANCE + personne_morale: + type: boolean + format: nullable + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + example: GOOGLE FRANCE + denomination: + type: string + format: nullable + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + example: GOOGLE FRANCE + nom: + type: string + format: nullable + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + prenom: + type: string + format: nullable + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + administration: + type: string + format: nullable + description: Administration (dans le cas d'une personne morale). + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + type: string + format: nullable + description: Adresse de l'entreprise concernée par la publication. + example: 8 rue de Londres 75009 Paris + BodaccModification: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + type: string + format: nullable + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + example: GOOGLE FRANCE + personne_morale: + type: boolean + format: nullable + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + example: GOOGLE FRANCE + denomination: + type: string + format: nullable + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + example: GOOGLE FRANCE + nom: + type: string + format: nullable + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + prenom: + type: string + format: nullable + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + administration: + type: string + format: nullable + description: Administration (dans le cas d'une personne morale). + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + type: string + format: nullable + description: Adresse de l'entreprise concernée par la publication. + example: 8 rue de Londres 75009 Paris + capital: + type: number + format: nullable + description: Capital de l'entreprise concernée par la publication. + example: '464884017' + activite: + type: string + format: nullable + description: Activité de l'entreprise concernée par la publication. + example: >- + Fourniture de services et/ou conseils relatifs aux logiciels, au + réseau internet. + description: + type: string + format: nullable + description: Description de la modification. + example: modification survenue sur le capital (augmentation) + BodaccAchat: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + type: string + format: nullable + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + example: GOOGLE FRANCE + personne_morale: + type: boolean + format: nullable + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + example: GOOGLE FRANCE + denomination: + type: string + format: nullable + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + example: GOOGLE FRANCE + nom: + type: string + format: nullable + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + prenom: + type: string + format: nullable + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + administration: + type: string + format: nullable + description: Administration (dans le cas d'une personne morale). + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + type: string + format: nullable + description: Adresse de l'entreprise concernée par la publication. + example: 8 rue de Londres 75009 Paris + commentaires: + type: string + format: nullable + description: Commentaires sur la publication. + oppositions: + type: string + format: nullable + description: Détails sur les oppositions. + declaration_creance: + type: string + format: nullable + description: Détails sur la déclaration de créance. + publication_legale: + type: string + format: nullable + description: Journal où a été publiée la publication légale. + denomination_ancien_proprietaire: + type: string + format: optional + description: Dénomination de l'ancien propriétaire de l'établisement. + siren_ancien_proprietaire: + type: string + format: optional + description: Siren de l'ancien propriétaire de l'établisement. + denomination_ancien_exploitant: + type: string + format: optional + description: Dénomination de l'ancien exploitant de l'établisement. + siren_ancien_exploitant: + type: string + format: optional + description: Siren de l'ancien exploitant de l'établisement. + BodaccVente: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + nom_entreprise: + type: string + format: nullable + description: >- + Nom de l'entreprise concernée par la publication. Correspond à + la dénomination en cas de personne morale et à nom + prenom en + cas de personne physique. + example: GOOGLE FRANCE + personne_morale: + type: boolean + format: nullable + description: >- + Vrai si l'entreprise concernée par la publication est une + personne morale, faux si c'est une personne physique. + example: GOOGLE FRANCE + denomination: + type: string + format: nullable + description: >- + Dénomination de l'entreprise concernée par la publication + (uniquement en cas de personne morale). + example: GOOGLE FRANCE + nom: + type: string + format: nullable + description: >- + Nom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + prenom: + type: string + format: nullable + description: >- + Prénom de la personne physique concernée par la publication + (uniquement en cas de personne physique). + administration: + type: string + format: nullable + description: Administration (dans le cas d'une personne morale). + example: 'Président : xxxx ; Commissaire aux comptes titulaire : xxxx' + adresse: + type: string + format: nullable + description: Adresse de l'entreprise concernée par la publication. + example: 8 rue de Londres 75009 Paris + commentaires: + type: string + format: nullable + description: Commentaires sur la publication. + oppositions: + type: string + format: nullable + description: Détails sur les oppositions. + declaration_creance: + type: string + format: nullable + description: Détails sur la déclaration de créance. + publication_legale: + type: string + format: nullable + description: Journal où a été publiée la publication légale. + denomination_nouveau_proprietaire: + type: string + format: nullable + description: Dénomination du nouveau propriétaire de l'établisement. + siren_nouveau_proprietaire: + type: string + format: nullable + description: Siren du nouveau propriétaire de l'établisement. + denomination_nouvel_exploitant: + type: string + format: nullable + description: Dénomination du nouvel exploitant de l'établisement. + siren_nouvel_exploitant: + type: string + format: nullable + description: Siren du nouvel exploitant de l'établisement. + BodaccRadiation: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + BodaccProcedureCollective: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + famille: + type: string + description: Famille de la procédure collective + example: Jugement de clôture + nature: + type: string + description: Nature de la procédure collective + example: Jugement de clôture pour insuffisance d'actif + complement_jugement: + type: string + description: Complément sur le jugement de procédure collective + example: >- + Jugement prononçant la clôture de la procédure de liquidation + judiciaire pour insuffisance d'actif. + BodaccDepotDesComptes: + allOf: + - $ref: '#/components/schemas/Bodacc' + - type: object + properties: + date_cloture: + type: string + description: Date de clôture des comptes, au format AAAA-MM-JJ. + example: '2020-08-02T00:00:00.000Z' + type_depot: + type: string + description: Type de dépôt de comptes. + example: Comptes annuels et rapports + descriptif: + type: string + format: nullable + description: Descriptif du dépôt de comptes. + PersonneMarque: + type: object + properties: + siren: + type: string + description: Siren de l'entité, dans le cas d'une personne morale. + entite_legale: + type: string + description: Entité légale. + nom: + type: string + description: Nom de l'entité. + batiment: + type: string + description: Bâtiment de l'entité. + rue: + type: string + description: Rue de l'entité. + ville: + type: string + description: Ville de l'entité. + boite_postale: + type: string + description: Boîte postale de l'entité. + code_postal: + type: string + description: Code postal de l'entité. + code_pays: + type: string + description: Code pays de l'entité. + Ratios: + type: object + properties: + chiffre_affaires: + type: number + format: nullable + description: Chiffre d'affaires de l'entreprise. + example: 411016329 + resultat: + type: number + format: nullable + description: Résultat de l'entreprise. + example: 29327087 + effectif: + type: integer + format: nullable + description: Effectif de l'entreprise. + example: 723 + marge_brute: + type: number + format: nullable + description: Marge brute de l'entreprise. + excedent_brut_exploitation: + type: number + format: nullable + description: Excédent brut d'exploitation (EBITDA) de l'entreprise. + resultat_exploitation: + type: number + format: nullable + description: Résultat d'exploitation (EBIT) de l'entreprise. + taux_croissance_chiffre_affaires: + type: number + format: nullable + description: Taux de croissance du chiffre d'affaires (en %) de l'entreprise. + taux_marge_brute: + type: number + format: nullable + description: Taux de marge brute (en %) de l'entreprise. + taux_marge_EBITDA: + type: number + format: nullable + description: Taux de marge d'EBITDA (en %) de l'entreprise. + taux_marge_operationnelle: + type: number + format: nullable + description: Taux de marge opérationnelle (EBIT) (en %) de l'entreprise. + BFR: + type: number + format: nullable + description: BFR (Besoin en fonds de roulement) de l'entreprise. + BFR_exploitation: + type: number + format: nullable + description: BFR exploitation de l'entreprise. + BFR_hors_exploitation: + type: number + format: nullable + description: BFR hors exploitation de l'entreprise. + BFR_jours_CA: + type: number + format: nullable + description: BFR (en jours de CA) de l'entreprise. + BFR_exploitation_jours_CA: + type: number + format: nullable + description: BFR exploitation (en jours de CA) de l'entreprise. + BFR_hors_exploitation_jours_CA: + type: number + format: nullable + description: BFR hors exploitation (en jours de CA) de l'entreprise. + delai_paiement_clients_jours: + type: number + format: nullable + description: Délai de paiement clients (en jours) de l'entreprise. + delai_paiement_fournisseurs_jours: + type: number + format: nullable + description: Délai de paiement fournisseurs (en jours) de l'entreprise. + ratio_stock_CA_jours: + type: number + format: nullable + description: Ratio des stocks / CA (en jours) de l'entreprise. + capacite_autofinancement: + type: number + format: nullable + description: Capacité d'autofinancement de l'entreprise. + capacite_autofinancement_CA: + type: number + format: nullable + description: Capacité d'autofinancement / CA (en %) de l'entreprise. + fonds_roulement_net_global: + type: number + format: nullable + description: Fonds de roulement net global de l'entreprise. + couverture_BFR: + type: number + format: nullable + description: Couverture du BFR de l'entreprise. + tresorerie: + type: number + format: nullable + description: Trésorerie de l'entreprise. + dettes_financieres: + type: number + format: nullable + description: Dettes financières de l'entreprise. + capacite_remboursement: + type: number + format: nullable + description: Capacité de remboursement de l'entreprise. + ratio_endettement: + type: number + format: nullable + description: Ratio d'endettement (Gearing) de l'entreprise. + autonomie_financiere: + type: number + format: nullable + description: Autonomie financière (en %) de l'entreprise. + taux_levier: + type: number + format: nullable + description: Taux de levier (DFN/EBITDA) de l'entreprise. + etat_dettes_1_an_au_plus: + type: number + format: nullable + description: Etat des dettes à 1 an au plus de l'entreprise. + liquidite_generale: + type: number + format: nullable + description: Liquidité générale de l'entreprise. + couverture_dettes: + type: number + format: nullable + description: Couverture des dettes de l'entreprise. + marge_nette: + type: number + format: nullable + description: Marge nette (en %) de l'entreprise. + rentabilite_fonds_propres: + type: number + format: nullable + description: Rentabilité sur fonds propres (en %) de l'entreprise. + rentabilite_economique: + type: number + format: nullable + description: Rentabilité économique (en %) de l'entreprise. + valeur_ajoutee: + type: number + format: nullable + description: Valeur ajoutée de l'entreprise. + valeur_ajoutee_CA: + type: number + format: nullable + description: Valeur ajoutée / CA (en %) de l'entreprise. + salaires_charges_sociales: + type: number + format: nullable + description: Salaires et charges sociales de l'entreprise. + salaires_CA: + type: number + format: nullable + description: Salaires / CA (en %) de l'entreprise. + impots_taxes: + type: number + format: nullable + description: Impôts et taxes de l'entreprise. + Association: + type: object + format: nullable + description: Association liée à l'entreprise. + properties: + is_waldec: + type: boolean + example: 1 + description: Détermine si l'association possède un numéro WALDEC/RNA. + id_association: + type: string + example: W142005389 + description: >- + L'identifiant l'association au format Wxxxxxxxxx si WALDEC, + xxxxxxxxxxxxxx sinon. + id_ex_association: + type: string + format: nullable + example: 142004593 + description: Ancien numéro de l'association. + denomination: + type: string + format: nullable + example: COMITÉ RÉGIONAL DE BRIDGE DE BASSE NORMANDIE + description: Dénomination de l'association. + siret: + type: string + format: nullable + description: Numéro siret de l'association au format xxxxxxxxxxxxxx. + example: '95037097300014' + numero_rup: + type: string + format: nullable + description: Numéro de Reconnaissance d'Utilité Publique. + example: null + objet: + type: string + format: nullable + description: Objet de l'association. + example: >- + Grouper tous les clubs et joueurs de bridge de Basse-Normandie de + soutenir leurs efforts et de développer sous toutes ses formes la + pratique du jeu de bridge + objet_social_1: + type: string + format: nullable + description: Objet social 1 de l'association. + example: 7005 + categorie_social_1: + type: string + format: nullable + description: Libellé correspondant à l'objet social 1. + example: Bridge, jeux de cartes, échecs, dames, jeux de société... + objet_social_2: + type: string + format: nullable + description: Objet social 2 de l'association. + example: 0 + categorie_social_2: + type: string + format: nullable + description: Libellé correspondant à l'objet social 1. + example: Non connue + date_creation: + type: string + format: nullable + description: Date de déclaration de création au format AAAA-MM-JJ. + example: '1978-09-28' + date_derniere_declaration: + type: string + format: nullable + description: Date de dernière déclaration au format AAAA-MM-JJ. + example: '2019-09-18' + date_publication_creation: + type: string + format: nullable + description: >- + Date de publication du Journal Officiel de l'avis de création au + format AAAA-MM-JJ. + example: '1978-10-12' + date_declaration_dissolution: + type: string + format: nullable + description: Date de déclaration de dissolution au format AAAA-MM-JJ. + example: '2019-09-18' + groupement: + type: string + format: nullable + description: Groupement de l'association. + example: Simple + position_activite: + type: string + format: nullable + description: Position d'activité de l'association. + example: Active + nature: + type: string + format: nullable + description: Nature de l'association. + example: Simplement Declarée + site_web: + type: string + format: nullable + description: Site web de l'association. + example: null + telephone: + type: string + format: nullable + description: Numéro de téléphone de l'association. + example: null + email: + type: string + format: nullable + description: Email de l'association. + example: null + adresse_siege: + type: object + properties: + code_postal: + type: string + format: nullable + description: Code postal du siège social. + example: '14075' + code_insee: + type: string + format: nullable + description: Code insee du siège social. + example: '14118' + ville: + type: string + format: nullable + description: Ville du siège social. + example: Caen cedex 05 + numero_voie: + type: string + format: nullable + description: Numéro de voie du siège social. + example: 115ter + indice_repetition: + type: string + format: nullable + description: Indice de répétition du siège social. + example: null + type_voie: + type: string + format: nullable + description: Type de voie du siège social. + example: BD + libelle_voie: + type: string + format: nullable + description: Libellé de la voie du siège social. + example: Vanier - La Pierre Heuzé + complement_adresse: + type: string + format: nullable + description: Complément de l'adresse du siège social. + example: null + distribution: + type: string + format: nullable + description: Complément de distribution du siege social. + example: _BP 75156 + adresse_ligne_1: + type: string + format: nullable + description: Adresse complète du siège social. + example: 115ter BD Vanier - La Pierre Heuzé + adresse_ligne_2: + type: string + format: nullable + description: Renseignement supplémentaire à l'adresse du siège social. + example: null + adresse_gestionnaire: + type: object + properties: + gestionnaire: + type: string + format: nullable + description: Nom du gestionnaire de l'association. + example: null + code_postal: + type: string + format: nullable + description: Code postal du gestionnaire. + example: '14075' + ville: + type: string + format: nullable + description: Ville du gestionnaire. + example: CAEN + distribution: + type: string + format: nullable + description: Complément de distribution du gestionnaire. + example: null + adresse_ligne: + type: string + format: nullable + description: Adresse complète du gestionnaire. + example: 115TER BOULEVARD VANIER - LA PIERRE + complement_adresse: + type: string + format: nullable + description: Complément de l'adresse du gestionnaire. + example: null + indication: + type: string + format: nullable + description: Indication supplémentaire à l'adresse du gestionnaire. + example: null + pays: + type: string + format: nullable + description: Pays du gestionnaire. + example: FRANCE + observation: + type: string + format: nullable + description: Observation relative à l'association. + example: Reprise auto => date publication création au JO à vérifier + code_gestion: + type: string + format: nullable + description: >- + Code du site gestionnaire (préfecture, sous-préfecture) de + l'association. + example: 142P + dirigeant_civilite: + type: string + format: nullable + description: Civilité du dirigeant. + example: PM + derniere_maj: + type: string + format: nullable + description: >- + Date de la dernière mise à jour des informations au RNA au format + AAAA-MM-JJ. + example: '2020-03-18' + publications_joafe: + type: object + format: optional + description: Publications JOAFE. + properties: + numero_parution: + type: string + example: '20180024' + description: Numéro de parution JOAFE + date_parution: + type: string + example: '2018-06-16' + description: Date de parution JOAFE au format AAAA-MM-JJ + date_declaration: + type: string + example: '2018-06-12' + description: Date de déclaration au format AAAA-MM-JJ + numero_annonce: + type: integer + example: 1766 + description: Numéro de l'annonce JOAFE + titre: + type: string + example: ASSOCIATION QUARTIER FOSSES-JEAN + description: Nom de l'association + type: + type: string + example: Création + description: Type d'annonce (Création, Modification, Dissolution) + prefecture: + type: string + example: Hauts-de-Seine + description: Lieu de la déclaration + objet: + type: string + format: optional + example: >- + la défense des droits des habitants du quartier auprès + éventuellement des bailleurs sociaux ; aide à la gestion des + problèmes de voisinage ; superviser le prêt des Lieux Communs de + Résidences pour proposer des activités aux jeunes du quartier + (jeux, échanges, anniversaires, prêt de livres ou divers) ; + l'organisation de rencontres pluriculturelles (apprentissage de + l'art culinaire des différentes ethnies qui composent le + quartier) ; organisation de goûter et sorties, vide grenier + annuel ou semestriel plus couramment brocante ; organisation de + rencontres inter-générations retraités qui pourraient apporter + une aide aux devoirs pour les enfants (bénévolement) + description: Description de l'association + site_web: + type: string + format: optional + example: null + description: Lien du site web + adresse: + type: string + format: nullable + example: 9, avenue D'Orgemont, 92700 Colombes + description: Adresse de l'association + ScoringNonFinancier: + type: object + format: optional + description: >- + Score extra-financier de l'entreprise. Uniquement présent si demandé + dans les champs supplémentaires. + properties: + note: + type: string + format: nullable + enum: + - A + - B + - C + - D + description: Note du score extra-financier de l'entreprise. + example: B + score: + type: number + format: nullable + description: Score extra-financier de l'entreprise. + example: 34 + date_calcul: + type: string + format: nullable + description: Date de calcul du score extra-financier de l'entreprise. + example: '2024-01-17' + erreur: + type: string + format: nullable + enum: + - Données extra financières incomplètes + description: Erreur lors du calcul du score extra-financier de l'entreprise. + example: null + ScoringFinancier: + type: object + format: optional + description: >- + Score financier de l'entreprise. Uniquement présent si demandé dans les + champs supplémentaires. + properties: + note: + type: string + format: nullable + enum: + - A + - B + - C + - D + - E + - F + - G + description: Note du score extra-financier de l'entreprise. + example: C + score: + type: number + format: nullable + description: Score extra-financier de l'entreprise. + example: 10 + date_cloture_comptes: + type: string + description: Date de clôture des comptes de l'entreprise. + example: '2021-12-31' + details_score: + type: object + format: nullable + description: Détails du score financier. + properties: + score_ebit_ca: + type: number + format: nullable + example: 3.5 + score_fonds_de_roulement: + type: number + format: nullable + example: 0 + score_tresorerie_nette: + type: number + format: nullable + example: 1 + score_dettes_fiscales_va: + type: number + format: nullable + example: 0.5 + score_cash_flow: + type: number + format: nullable + example: 3.5 + score_dettes_fiscales_ca: + type: number + format: nullable + example: null + score_charges_financieres_nettes: + type: number + format: nullable + example: 1.5 + date_calcul: + type: string + format: nullable + description: Date de calcul du score extra-financier de l'entreprise. + example: '2024-01-17' + erreur: + type: string + format: nullable + enum: + - Données financières incomplètes + - Type de compte non couvert + - Secteur non couvert + - Chiffre d'affaires trop faible + description: Erreur lors du calcul du score extra-financier de l'entreprise. + example: null + Labels: + type: object + format: optional + properties: + nom: + type: string + enum: + - RGE + - QUALIOPI + - EGALITE + - BIO + - ESS + - ESUS + - SOCIETE_A_MISSION + - ORIAS + description: Nom du label. + example: RGE + nb_etablissements_concernes: + type: integer + format: nullable + description: >- + Nombre d'établissements concernés par le label, dans le cas d'un + label lié aux établissements. Null sinon. + example: 1 + certificats: + type: array + format: optional + description: 'Label RGE seulement : Liste des certificats.' + specialites: + type: array + format: optional + description: 'Label QUALIOPI seulement : Liste des spécialités.' + notes: + type: array + format: optional + description: 'Label EGALITE seulement : Liste des notes.' + numero_immatriculation: + type: string + format: optional + description: 'Label ORIAS seulement : Numéro d''immatriculation ORIAS.' + inscriptions: + type: array + format: optional + description: 'Label ORIAS seulement : Liste des inscriptions ORIAS.' + LienSuccession: + type: object + properties: + siret: + type: string + description: Numéro siret de l'établissement au format xxxxxxxxxxxxxx. + example: '44306184100047' + date: + type: string + description: Date à laquelle la succession a eu lieu. + example: '1993-20-02' + transfert_siege: + type: boolean + description: >- + Vrai si le lien de succession concerne l'établissement siège, faux + sinon. + example: false + continuite_economique: + type: boolean + description: >- + Vrai s'il y a [continuité + économique](https://www.sirene.fr/sirene/public/variable/continuiteEconomique), + faux sinon. + example: true + Cartographie: + type: object + properties: + entreprises: + type: array + description: Liste des noeuds entreprises. + items: + type: object + properties: + id: + type: string + description: Un identifiant unique du noeud. + siren: + type: string + description: SIREN de l'entreprise. + nom_entreprise: + type: string + description: Nom de l'entreprise. + personnes: + type: array + description: Liste des noeuds personnes (dirigeants ou bénéficiaires effectifs). + items: + type: object + properties: + id: + type: string + description: Un identifiant unique du noeud. + prenom: + type: string + description: SIREN de l'entreprise. + nom: + type: string + description: Nom de l'entreprise. + niveau: + type: integer + description: >- + Niveau du noeud. Le niveau 1 correspond aux dirigeants et + bénéficiaires effectifs directement liés à l'entreprise + recherchée. Le niveau 2 correspond aux autres. + liens_entreprises_personnes: + type: array + description: >- + Liste des arêtes liant les noeuds entreprises avec des noeuds + personnes. + items: + type: array + description: >- + Tableau de 2 éléments, le premier contenant l'identifiant du noeud + entreprise, le second l'identifiant du noeud personne. + items: + oneOf: + - type: string + pattern: e[0-9]+ + - type: string + pattern: p[0-9]+ + liens_entreprises_entreprises: + type: array + description: >- + Liste des arêtes liant les noeuds entreprises avec des d'autres + noeuds entreprises. + items: + type: array + description: >- + Tableau de 2 éléments, chacun étant un identifiant d'un noeud + entreprise. + items: + type: string + pattern: e[0-9]+ + modifications_effectuees: + type: object + description: Description des paramètres ayant été automatiquement modifiés. diff --git a/sdks/db/processed-custom-request-cache/pappers.fr.yaml b/sdks/db/processed-custom-request-cache/pappers.fr.yaml new file mode 100644 index 0000000000..2a14459b82 --- /dev/null +++ b/sdks/db/processed-custom-request-cache/pappers.fr.yaml @@ -0,0 +1,41 @@ +processed: + securitySchemes: {} + apiBaseUrl: https://api.pappers.fr/v2 + apiVersion: 2.13.0 + apiDescription: > + 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 + apiTitle: Pappers API + endpoints: 22 + sdkMethods: 23 + schemas: 32 + parameters: 306 + contactEmail: support@pappers.fr + originalCustomRequest: + type: GET + url: https://www.pappers.fr/api_v2.yaml?20231125 + customRequestSpecFilename: pappers.fr.yaml + difficultyScore: 115.5 diff --git a/sdks/db/progress/pappers-progress.yaml b/sdks/db/progress/pappers-progress.yaml new file mode 100644 index 0000000000..dd6ae1bb44 --- /dev/null +++ b/sdks/db/progress/pappers-progress.yaml @@ -0,0 +1,288 @@ +examples: {} +examples_2: {} +examples_3: {} +ignorePotentialIncorrectType: true +operationIds: + /association: + get: FicheAssociation_getInfo + /conformite/personne_physique: + get: Conformit_personnePhysiqueStatusCheck + /document/avis_situation_insee: + get: Documents_downloadInseeSituation + /document/declaration_beneficiaires_effectifs: + get: Documents_telechargementBeneficiairesEffectifs + /document/extrait_inpi: + get: Documents_getExtraitInpi + /document/extrait_pappers: + get: Documents_downloadPappersExtrait + /document/rapport_solvabilite: + get: Documents_downloadSolvabilityReport + /document/statuts: + get: Documents_telechargementStatuts + /document/telechargement: + get: Documents_downloadDocumentByToken + /entreprise: + get: FicheEntreprise_getInformation + /entreprise/cartographie: + get: Cartographie_getData + /entreprise/comptes: + get: ComptesAnnuels_getBySiren + /liste: + post: Surveillance_listeAjouter + /liste-informations: + post: Surveillance_addNotifications + /liste/: + delete: Surveillance_listDelete + post: Surveillance_listeDirigeantsAjout + /recherche: + get: Recherche_criteriaEnterprisesGet + /recherche-beneficiaires: + get: Recherche_effectiveBeneficiariesSearch + /recherche-dirigeants: + get: Recherche_leadersSearchCriteriaGet + /recherche-documents: + get: Recherche_matchingDocumentsGet + /recherche-publications: + get: Recherche_matchingPublicationsGet + /suggestions: + get: SuggestionsAutocomplete_searchText + /suivi-jetons: + get: SuiviUtilisation_getTokenUsage +operationTags: {} +renameTags: {} +requestSchemaNames: + /liste: + post: + application/json: SurveillanceListeDirigeantsAjoutRequest + /liste-informations: + post: + application/json: SurveillanceAddNotificationsRequest +responseDescriptions: {} +responseSchemaNames: + /conformite/personne_physique: + get: + '200': + application/json: ConformitPersonnePhysiqueStatusCheckResponse + /document/avis_situation_insee: + get: + '200': + application/pdf: DocumentsDownloadInseeSituationResponse + /document/declaration_beneficiaires_effectifs: + get: + '200': + application/pdf: DocumentsTelechargementBeneficiairesEffectifsResponse + /document/extrait_inpi: + get: + '200': + application/pdf: DocumentsGetExtraitInpiResponse + /document/extrait_pappers: + get: + '200': + application/pdf: DocumentsDownloadPappersExtraitResponse + /document/rapport_solvabilite: + get: + '200': + application/pdf: DocumentsDownloadSolvabilityReportResponse + /document/statuts: + get: + '200': + application/pdf: DocumentsTelechargementStatutsResponse + /document/telechargement: + get: + '200': + application/pdf: DocumentsDownloadDocumentByTokenResponse + /entreprise/comptes: + get: + '200': + application/json: ComptesAnnuelsGetBySirenResponse + /liste: + delete: + '200': + application/json: SurveillanceListDeleteResponse + post: + '200': + application/json: SurveillanceListeDirigeantsAjoutResponse + '201': + application/json: SurveillanceListeDirigeantsAjout201Response + /recherche: + get: + '200': + application/json: RechercheCriteriaEnterprisesGetResponse + /recherche-beneficiaires: + get: + '200': + application/json: RechercheEffectiveBeneficiariesSearchResponse + /recherche-dirigeants: + get: + '200': + application/json: RechercheLeadersSearchCriteriaGetResponse + /recherche-documents: + get: + '200': + application/json: RechercheMatchingDocumentsGetResponse + /recherche-publications: + get: + '200': + application/json: RechercheMatchingPublicationsGetResponse + /suggestions: + get: + '200': + application/json: SuggestionsAutocompleteSearchTextResponse + /suivi-jetons: + get: + '200': + application/json: SuiviUtilisationGetTokenUsageResponse +securityParameters: + age_beneficiaire_max: + query: false + age_beneficiaire_min: + query: false + age_dirigeant_max: + query: false + age_dirigeant_min: + query: false + annee: + query: false + api_token: + query: false + autoriser_modifications: + query: false + bases: + query: false + capital_max: + query: false + capital_min: + query: false + categorie_juridique: + query: false + champs_supplementaires: + query: false + chiffre_affaires_max: + query: false + chiffre_affaires_min: + query: false + cibles: + query: false + code_naf: + query: false + code_postal: + query: false + convention_collective: + query: false + curseur: + query: false + date_creation_max: + query: false + date_creation_min: + query: false + date_de_naissance: + query: false + date_de_naissance_beneficiaire_max: + query: false + date_de_naissance_beneficiaire_min: + query: false + date_de_naissance_dirigeant_max: + query: false + date_de_naissance_dirigeant_min: + query: false + date_depot_document_max: + query: false + date_depot_document_min: + query: false + date_immatriculation_rcs_max: + query: false + date_immatriculation_rcs_min: + query: false + date_publication_max: + query: false + date_publication_min: + query: false + date_radiation_rcs_max: + query: false + date_radiation_rcs_min: + query: false + degre: + query: false + departement: + query: false + entreprise_cessee: + query: false + format_publications_bodacc: + query: false + id: + query: false + id_association: + query: false + id_liste: + query: false + inclure_entreprises_citees: + query: false + inclure_entreprises_dirigees: + query: false + inclure_sci: + query: false + integrer_diffusions_partielles: + query: false + longueur: + query: false + marques: + query: false + nationalite_beneficiaire: + query: false + nationalite_dirigeant: + query: false + nom: + query: false + nom_dirigeant: + query: false + objet_social: + query: false + page: + query: false + par_curseur: + query: false + par_page: + query: false + precision: + query: false + prenom: + query: false + prenom_dirigeant: + query: false + publications_bodacc_brutes: + query: false + q: + query: false + qualite_dirigeant: + query: false + region: + query: false + rejeter_premier_degre: + query: false + resultat_max: + query: false + resultat_min: + query: false + siege: + query: false + siren: + query: false + siret: + query: false + statut_rcs: + query: false + supprimer_totalite: + query: false + token: + query: false + tranche_effectif_max: + query: false + tranche_effectif_min: + query: false + type_dirigeant: + query: false + type_publication: + query: false + validite_tva_intracommunautaire: + query: false +validServerUrls: {} diff --git a/sdks/db/published/from-custom-request_box.com.json b/sdks/db/published/from-custom-request_box.com.json index 13400aab25..1058b3b319 100644 --- a/sdks/db/published/from-custom-request_box.com.json +++ b/sdks/db/published/from-custom-request_box.com.json @@ -408,7 +408,7 @@ "name": "fields", "schema": "array", "required": false, - "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", + "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?fields=metadata.enterprise_12345.contractTemplate`.", "example": [ "id", "type", @@ -889,8 +889,8 @@ "url": "/files/upload_sessions", "method": "createSessionForUpload", "httpMethod": "post", - "tag": "Uploads (Chunked)", - "typeScriptTag": "uploadsChunked", + "tag": "Uploads (https://developer.box.com/reference/", + "typeScriptTag": "uploadsHttps:DeveloperBoxComReference", "description": "Create upload session", "parameters": [ { @@ -946,8 +946,8 @@ "url": "/files/{file_id}/upload_sessions", "method": "createSessionForUpload", "httpMethod": "post", - "tag": "Uploads (Chunked)", - "typeScriptTag": "uploadsChunked", + "tag": "Uploads (https://developer.box.com/reference/", + "typeScriptTag": "uploadsHttps:DeveloperBoxComReference", "description": "Create upload session for existing file", "parameters": [ { @@ -991,8 +991,8 @@ "url": "/files/upload_sessions/{upload_session_id}", "method": "removeUploadSession", "httpMethod": "delete", - "tag": "Uploads (Chunked)", - "typeScriptTag": "uploadsChunked", + "tag": "Uploads (https://developer.box.com/reference/", + "typeScriptTag": "uploadsHttps:DeveloperBoxComReference", "description": "Remove upload session", "parameters": [ { @@ -1018,8 +1018,8 @@ "url": "/files/upload_sessions/{upload_session_id}", "method": "info", "httpMethod": "get", - "tag": "Uploads (Chunked)", - "typeScriptTag": "uploadsChunked", + "tag": "Uploads (https://developer.box.com/reference/", + "typeScriptTag": "uploadsHttps:DeveloperBoxComReference", "description": "Get upload session", "parameters": [ { @@ -1045,8 +1045,8 @@ "url": "/files/upload_sessions/{upload_session_id}", "method": "filePartUpdate", "httpMethod": "put", - "tag": "Uploads (Chunked)", - "typeScriptTag": "uploadsChunked", + "tag": "Uploads (https://developer.box.com/reference/", + "typeScriptTag": "uploadsHttps:DeveloperBoxComReference", "description": "Upload part of file", "parameters": [ { @@ -1098,8 +1098,8 @@ "url": "/files/upload_sessions/{upload_session_id}/parts", "method": "listParts", "httpMethod": "get", - "tag": "Uploads (Chunked)", - "typeScriptTag": "uploadsChunked", + "tag": "Uploads (https://developer.box.com/reference/", + "typeScriptTag": "uploadsHttps:DeveloperBoxComReference", "description": "List parts", "parameters": [ { @@ -1140,8 +1140,8 @@ "url": "/files/upload_sessions/{upload_session_id}/commit", "method": "commitSession", "httpMethod": "post", - "tag": "Uploads (Chunked)", - "typeScriptTag": "uploadsChunked", + "tag": "Uploads (https://developer.box.com/reference/", + "typeScriptTag": "uploadsHttps:DeveloperBoxComReference", "description": "Commit upload session", "parameters": [ { @@ -1364,8 +1364,8 @@ "url": "/files/{file_id}/collaborations", "method": "fileAccessList", "httpMethod": "get", - "tag": "Collaborations (List)", - "typeScriptTag": "collaborationsList", + "tag": "Collaborations (https://developer.box.com/reference/", + "typeScriptTag": "collaborationsHttps:DeveloperBoxComReference", "description": "List file collaborations", "parameters": [ { @@ -1810,8 +1810,8 @@ "url": "/files/{file_id}/metadata", "method": "listFileMetadata", "httpMethod": "get", - "tag": "Metadata instances (Files)", - "typeScriptTag": "metadataInstancesFiles", + "tag": "Metadata instances (https://developer.box.com/reference/", + "typeScriptTag": "metadataInstancesHttps:DeveloperBoxComReference", "description": "List metadata instances on file", "parameters": [ { @@ -2003,8 +2003,8 @@ "url": "/files/{file_id}/metadata/{scope}/{template_key}", "method": "removeInstance", "httpMethod": "delete", - "tag": "Metadata instances (Files)", - "typeScriptTag": "metadataInstancesFiles", + "tag": "Metadata instances (https://developer.box.com/reference/", + "typeScriptTag": "metadataInstancesHttps:DeveloperBoxComReference", "description": "Remove metadata instance from file", "parameters": [ { @@ -2056,8 +2056,8 @@ "url": "/files/{file_id}/metadata/{scope}/{template_key}", "method": "getInstance", "httpMethod": "get", - "tag": "Metadata instances (Files)", - "typeScriptTag": "metadataInstancesFiles", + "tag": "Metadata instances (https://developer.box.com/reference/", + "typeScriptTag": "metadataInstancesHttps:DeveloperBoxComReference", "description": "Get metadata instance on file", "parameters": [ { @@ -2109,8 +2109,8 @@ "url": "/files/{file_id}/metadata/{scope}/{template_key}", "method": "applyTemplate", "httpMethod": "post", - "tag": "Metadata instances (Files)", - "typeScriptTag": "metadataInstancesFiles", + "tag": "Metadata instances (https://developer.box.com/reference/", + "typeScriptTag": "metadataInstancesHttps:DeveloperBoxComReference", "description": "Create metadata instance on file", "parameters": [ { @@ -2162,8 +2162,8 @@ "url": "/files/{file_id}/metadata/{scope}/{template_key}", "method": "updateInstanceOnFile", "httpMethod": "put", - "tag": "Metadata instances (Files)", - "typeScriptTag": "metadataInstancesFiles", + "tag": "Metadata instances (https://developer.box.com/reference/", + "typeScriptTag": "metadataInstancesHttps:DeveloperBoxComReference", "description": "Update metadata instance on file", "parameters": [ { @@ -2349,8 +2349,8 @@ "url": "/files/{file_id}/watermark", "method": "removeWatermark", "httpMethod": "delete", - "tag": "Watermarks (Files)", - "typeScriptTag": "watermarksFiles", + "tag": "Watermarks (https://developer.box.com/reference/", + "typeScriptTag": "watermarksHttps:DeveloperBoxComReference", "description": "Remove watermark from file", "parameters": [ { @@ -2380,8 +2380,8 @@ "url": "/files/{file_id}/watermark", "method": "get", "httpMethod": "get", - "tag": "Watermarks (Files)", - "typeScriptTag": "watermarksFiles", + "tag": "Watermarks (https://developer.box.com/reference/", + "typeScriptTag": "watermarksHttps:DeveloperBoxComReference", "description": "Get watermark on file", "parameters": [ { @@ -2411,8 +2411,8 @@ "url": "/files/{file_id}/watermark", "method": "applyWatermarkToFile", "httpMethod": "put", - "tag": "Watermarks (Files)", - "typeScriptTag": "watermarksFiles", + "tag": "Watermarks (https://developer.box.com/reference/", + "typeScriptTag": "watermarksHttps:DeveloperBoxComReference", "description": "Apply watermark to file", "parameters": [ { @@ -2739,7 +2739,7 @@ "name": "fields", "schema": "array", "required": false, - "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", + "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?fields=metadata.enterprise_12345.contractTemplate`.", "example": [ "id", "type", @@ -3030,7 +3030,7 @@ "name": "fields", "schema": "array", "required": false, - "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", + "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?fields=metadata.enterprise_12345.contractTemplate`.", "example": [ "id", "type", @@ -3263,8 +3263,8 @@ "url": "/folders/{folder_id}/collaborations", "method": "folderAccess", "httpMethod": "get", - "tag": "Collaborations (List)", - "typeScriptTag": "collaborationsList", + "tag": "Collaborations (https://developer.box.com/reference/", + "typeScriptTag": "collaborationsHttps:DeveloperBoxComReference", "description": "List folder collaborations", "parameters": [ { @@ -3374,8 +3374,8 @@ "url": "/folders/{folder_id}/metadata", "method": "listOnFolder", "httpMethod": "get", - "tag": "Metadata instances (Folders)", - "typeScriptTag": "metadataInstancesFolders", + "tag": "Metadata instances (https://developer.box.com/reference/", + "typeScriptTag": "metadataInstancesHttps:DeveloperBoxComReference", "description": "List metadata instances on folder", "parameters": [ { @@ -3567,8 +3567,8 @@ "url": "/folders/{folder_id}/metadata/{scope}/{template_key}", "method": "removeInstance", "httpMethod": "delete", - "tag": "Metadata instances (Folders)", - "typeScriptTag": "metadataInstancesFolders", + "tag": "Metadata instances (https://developer.box.com/reference/", + "typeScriptTag": "metadataInstancesHttps:DeveloperBoxComReference", "description": "Remove metadata instance from folder", "parameters": [ { @@ -3620,8 +3620,8 @@ "url": "/folders/{folder_id}/metadata/{scope}/{template_key}", "method": "getFolderMetadataInstance", "httpMethod": "get", - "tag": "Metadata instances (Folders)", - "typeScriptTag": "metadataInstancesFolders", + "tag": "Metadata instances (https://developer.box.com/reference/", + "typeScriptTag": "metadataInstancesHttps:DeveloperBoxComReference", "description": "Get metadata instance on folder", "parameters": [ { @@ -3673,8 +3673,8 @@ "url": "/folders/{folder_id}/metadata/{scope}/{template_key}", "method": "applyTemplate", "httpMethod": "post", - "tag": "Metadata instances (Folders)", - "typeScriptTag": "metadataInstancesFolders", + "tag": "Metadata instances (https://developer.box.com/reference/", + "typeScriptTag": "metadataInstancesHttps:DeveloperBoxComReference", "description": "Create metadata instance on folder", "parameters": [ { @@ -3726,8 +3726,8 @@ "url": "/folders/{folder_id}/metadata/{scope}/{template_key}", "method": "updateInstanceOnFolder", "httpMethod": "put", - "tag": "Metadata instances (Folders)", - "typeScriptTag": "metadataInstancesFolders", + "tag": "Metadata instances (https://developer.box.com/reference/", + "typeScriptTag": "metadataInstancesHttps:DeveloperBoxComReference", "description": "Update metadata instance on folder", "parameters": [ { @@ -3853,8 +3853,8 @@ "url": "/folders/{folder_id}/watermark", "method": "removeFolderWatermark", "httpMethod": "delete", - "tag": "Watermarks (Folders)", - "typeScriptTag": "watermarksFolders", + "tag": "Watermarks (https://developer.box.com/reference/", + "typeScriptTag": "watermarksHttps:DeveloperBoxComReference", "description": "Remove watermark from folder", "parameters": [ { @@ -3884,8 +3884,8 @@ "url": "/folders/{folder_id}/watermark", "method": "getFolderWatermark", "httpMethod": "get", - "tag": "Watermarks (Folders)", - "typeScriptTag": "watermarksFolders", + "tag": "Watermarks (https://developer.box.com/reference/", + "typeScriptTag": "watermarksHttps:DeveloperBoxComReference", "description": "Get watermark for folder", "parameters": [ { @@ -3915,8 +3915,8 @@ "url": "/folders/{folder_id}/watermark", "method": "applyToFolder", "httpMethod": "put", - "tag": "Watermarks (Folders)", - "typeScriptTag": "watermarksFolders", + "tag": "Watermarks (https://developer.box.com/reference/", + "typeScriptTag": "watermarksHttps:DeveloperBoxComReference", "description": "Apply watermark to folder", "parameters": [ { @@ -5152,8 +5152,8 @@ "url": "/collaborations", "method": "collaborations", "httpMethod": "get", - "tag": "Collaborations (List)", - "typeScriptTag": "collaborationsList", + "tag": "Collaborations (https://developer.box.com/reference/", + "typeScriptTag": "collaborationsHttps:DeveloperBoxComReference", "description": "List pending collaborations", "parameters": [ { @@ -5341,7 +5341,7 @@ "name": "sizeRange", "schema": "array", "required": false, - "description": "Limits the search results to any items with a size within\na given file size range. This applied to files and folders.\n\nSize ranges are defined as comma separated list of a lower\nand upper byte size limit (inclusive).\n\nThe upper and lower bound can be omitted to create open ranges.", + "description": "Limits the search results to any items with a size within\na given file size range. This applied to files and folders.\n\nSize ranges are defined as comma separated list of a lower\nand upper byte size limit (https://developer.box.com/reference/.\n\nThe upper and lower bound can be omitted to create open ranges.", "example": [ 1000000, 5000000 @@ -5424,7 +5424,7 @@ "name": "sort", "schema": "string", "required": false, - "description": "Defines the order in which search results are returned. This API\ndefaults to returning items by relevance unless this parameter is\nexplicitly specified.\n\n* `relevance` (default) returns the results sorted by relevance to the\nquery search term. The relevance is based on the occurrence of the search\nterm in the items name, description, content, and additional properties.\n* `modified_at` returns the results ordered in descending order by date\nat which the item was last modified.", + "description": "Defines the order in which search results are returned. This API\ndefaults to returning items by relevance unless this parameter is\nexplicitly specified.\n\n* `relevance` (https://developer.box.com/reference/ returns the results sorted by relevance to the\nquery search term. The relevance is based on the occurrence of the search\nterm in the items name, description, content, and additional properties.\n* `modified_at` returns the results ordered in descending order by date\nat which the item was last modified.", "example": "modified_at", "default": "relevance" }, @@ -5902,8 +5902,8 @@ "url": "/shared_items", "method": "getBySharedLink", "httpMethod": "get", - "tag": "Shared links (Files)", - "typeScriptTag": "sharedLinksFiles", + "tag": "Shared links (https://developer.box.com/reference/", + "typeScriptTag": "sharedLinksHttps:DeveloperBoxComReference", "description": "Find file for shared link", "parameters": [ { @@ -5951,8 +5951,8 @@ "url": "/files/{file_id}#get_shared_link", "method": "getSharedLinkInfo", "httpMethod": "get", - "tag": "Shared links (Files)", - "typeScriptTag": "sharedLinksFiles", + "tag": "Shared links (https://developer.box.com/reference/", + "typeScriptTag": "sharedLinksHttps:DeveloperBoxComReference", "description": "Get shared link for file", "parameters": [ { @@ -5997,8 +5997,8 @@ "url": "/files/{file_id}#add_shared_link", "method": "addSharedLinkToFile", "httpMethod": "put", - "tag": "Shared links (Files)", - "typeScriptTag": "sharedLinksFiles", + "tag": "Shared links (https://developer.box.com/reference/", + "typeScriptTag": "sharedLinksHttps:DeveloperBoxComReference", "description": "Add shared link to file", "parameters": [ { @@ -6060,8 +6060,8 @@ "url": "/files/{file_id}#update_shared_link", "method": "updateLinkOnFile", "httpMethod": "put", - "tag": "Shared links (Files)", - "typeScriptTag": "sharedLinksFiles", + "tag": "Shared links (https://developer.box.com/reference/", + "typeScriptTag": "sharedLinksHttps:DeveloperBoxComReference", "description": "Update shared link on file", "parameters": [ { @@ -6123,8 +6123,8 @@ "url": "/files/{file_id}#remove_shared_link", "method": "removeSharedLink", "httpMethod": "put", - "tag": "Shared links (Files)", - "typeScriptTag": "sharedLinksFiles", + "tag": "Shared links (https://developer.box.com/reference/", + "typeScriptTag": "sharedLinksHttps:DeveloperBoxComReference", "description": "Remove shared link from file", "parameters": [ { @@ -6183,8 +6183,8 @@ "url": "/shared_items#folders", "method": "findFolderBySharedLink", "httpMethod": "get", - "tag": "Shared links (Folders)", - "typeScriptTag": "sharedLinksFolders", + "tag": "Shared links (https://developer.box.com/reference/", + "typeScriptTag": "sharedLinksHttps:DeveloperBoxComReference", "description": "Find folder for shared link", "parameters": [ { @@ -6232,8 +6232,8 @@ "url": "/folders/{folder_id}#get_shared_link", "method": "getSharedLinkForFolder", "httpMethod": "get", - "tag": "Shared links (Folders)", - "typeScriptTag": "sharedLinksFolders", + "tag": "Shared links (https://developer.box.com/reference/", + "typeScriptTag": "sharedLinksHttps:DeveloperBoxComReference", "description": "Get shared link for folder", "parameters": [ { @@ -6278,8 +6278,8 @@ "url": "/folders/{folder_id}#add_shared_link", "method": "addLinkToFolder", "httpMethod": "put", - "tag": "Shared links (Folders)", - "typeScriptTag": "sharedLinksFolders", + "tag": "Shared links (https://developer.box.com/reference/", + "typeScriptTag": "sharedLinksHttps:DeveloperBoxComReference", "description": "Add shared link to folder", "parameters": [ { @@ -6341,8 +6341,8 @@ "url": "/folders/{folder_id}#update_shared_link", "method": "updateFolderSharedLink", "httpMethod": "put", - "tag": "Shared links (Folders)", - "typeScriptTag": "sharedLinksFolders", + "tag": "Shared links (https://developer.box.com/reference/", + "typeScriptTag": "sharedLinksHttps:DeveloperBoxComReference", "description": "Update shared link on folder", "parameters": [ { @@ -6404,8 +6404,8 @@ "url": "/folders/{folder_id}#remove_shared_link", "method": "removeFromFolder", "httpMethod": "put", - "tag": "Shared links (Folders)", - "typeScriptTag": "sharedLinksFolders", + "tag": "Shared links (https://developer.box.com/reference/", + "typeScriptTag": "sharedLinksHttps:DeveloperBoxComReference", "description": "Remove shared link from folder", "parameters": [ { @@ -8375,8 +8375,8 @@ "url": "/groups/{group_id}/collaborations", "method": "groupAccessDetails", "httpMethod": "get", - "tag": "Collaborations (List)", - "typeScriptTag": "collaborationsList", + "tag": "Collaborations (https://developer.box.com/reference/", + "typeScriptTag": "collaborationsHttps:DeveloperBoxComReference", "description": "List group collaborations", "parameters": [ { @@ -12603,7 +12603,7 @@ "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/box/imagePreview.jpg", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/box/favicon.png", "clientNameCamelCase": "box", - "lastUpdated": "2024-03-27T20:29:17.115Z", + "lastUpdated": "2024-03-28T21:38:28.766Z", "typescriptSdkUsageCode": "import { Box } from 'box-typescript-sdk';\n\nconst box = new Box({\n clientId: \"CLIENT_ID\",\n clientSecret: \"CLIENT_SECRET\",\n redirectUri: \"REDIRECT_URI\"\n})", "typescriptSdkFirstRequestCode": "// Authorize user\nconst authorizeResponse = box.authorization.authorize({\n responseType: \"code\"\n clientId: \"ly1nj6n11vionaie65emwzk575hnnmrk\"\n redirectUri: \"http://example.com/auth/callback\"\n state: \"my_state\"\n scope: \"admin_readwrite\"\n})", "fixedSpecFileName": "box-fixed-spec.yaml" diff --git a/sdks/db/published/from-custom-request_customer.io_DatePipelines.json b/sdks/db/published/from-custom-request_customer.io_DatePipelines.json index 69a7e4e4bb..3790ac5b22 100644 --- a/sdks/db/published/from-custom-request_customer.io_DatePipelines.json +++ b/sdks/db/published/from-custom-request_customer.io_DatePipelines.json @@ -24,7 +24,7 @@ "serviceName": "Data Pipelines", "sdkName": "customer-io-data-pipelines-{language}-sdk", "clientName": "CustomerIoDataPipelines", - "metaDescription": "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products. \n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform. \n- Create and manage newsletters, transactional messages, and behavioral messages \n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time. \n\nLearn more: https://customer.io", + "metaDescription": "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products.\n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform.\n- Create and manage newsletters, transactional messages, and behavioral messages\n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time.\n\nLearn more: https://customer.io", "apiStatusUrls": "inherit", "homepage": "customer.io/", "developerDocumentation": "customer.io/docs/api/cdp/", @@ -182,14 +182,14 @@ ] } ], - "repositoryDescription": "Customer.io is a versatile marketing automation tool that uses real-time data to send personalized messages for web and mobile products. Automate product messaging, manage newsletters, transactional messages, and behavioral messages, and connect with other apps for enhanced user engagement.", + "repositoryDescription": "Customer.io is a versatile marketing automation tool that uses real-time data to deliver personalized messages across web and mobile products, including event reminders, onboarding emails, newsletters, and more. Automate messaging, create newsletters, and connect with other apps to drive user behavior.", "logo": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/data-pipelines/logo.png", "openApiRaw": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/data-pipelines/openapi.yaml", "openApiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/customer-io/data-pipelines/openapi.yaml", "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/data-pipelines/imagePreview.png", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/data-pipelines/favicon.png", "clientNameCamelCase": "customerIoDataPipelines", - "lastUpdated": "2024-03-28T21:25:19.896Z", + "lastUpdated": "2024-03-28T21:38:28.766Z", "typescriptSdkUsageCode": "import { CustomerIoDataPipelines } from 'customer-io-data-pipelines-typescript-sdk';\n\nconst customerIoDataPipelines = new CustomerIoDataPipelines({\n /*\n * The Data Pipelines API uses a basic authentication scheme with your API key. Because basic authorization typically expects a username and password combination, you'll use the API Key as the username and leave the password blank—base64 encoding your credentials in the format `API_key:`. \n * \n */\n username: \"USERNAME\",\n password: \"PASSWORD\"\n})", "typescriptSdkFirstRequestCode": "// Identify\nconst personTraitsAssignmentResponse = customerIoDataPipelines.identification.personTraitsAssignment()", "fixedSpecFileName": "customer-io-data-pipelines-fixed-spec.yaml" diff --git a/sdks/db/published/from-custom-request_customer.io_JourneysApp.json b/sdks/db/published/from-custom-request_customer.io_JourneysApp.json index 1001d55f49..84e2d95f43 100644 --- a/sdks/db/published/from-custom-request_customer.io_JourneysApp.json +++ b/sdks/db/published/from-custom-request_customer.io_JourneysApp.json @@ -24,7 +24,7 @@ "serviceName": "Journeys App", "sdkName": "customer-io-journeys-app-{language}-sdk", "clientName": "CustomerIoJourneysApp", - "metaDescription": "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products. \n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform. \n- Create and manage newsletters, transactional messages, and behavioral messages \n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time. \n\nLearn more: https://customer.io", + "metaDescription": "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products.\n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform.\n- Create and manage newsletters, transactional messages, and behavioral messages\n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time.\n\nLearn more: https://customer.io", "apiStatusUrls": "inherit", "homepage": "customer.io", "developerDocumentation": "customer.io/docs/api/app/", @@ -3435,14 +3435,14 @@ ] } ], - "repositoryDescription": "Customer.io offers versatile marketing automation tools to personalize messages based on user behavior, ensuring timely and relevant communication across web and mobile platforms. Automate product messaging, newsletters, and more with real-time data integration for optimal user engagement and efficiency.", + "repositoryDescription": "Customer.io is a dynamic tool for personalized marketing automation. Utilize real-time data to send targeted messages across web and mobile products, improving user experiences and engagement. Automate messaging and connect with other apps for effective user behavior management.", "logo": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-app/logo.png", "openApiRaw": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-app/openapi.yaml", "openApiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/customer-io/journeys-app/openapi.yaml", "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-app/imagePreview.png", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-app/favicon.png", "clientNameCamelCase": "customerIoJourneysApp", - "lastUpdated": "2024-03-28T21:25:19.896Z", + "lastUpdated": "2024-03-28T21:38:28.766Z", "typescriptSdkUsageCode": "import { CustomerIoJourneysApp } from 'customer-io-journeys-app-typescript-sdk';\n\nconst customerIoJourneysApp = new CustomerIoJourneysApp({\n /*\n * The App API uses a bearer authentication scheme.\n * \n * You can generate a bearer token, known as an **App API Key**, with a defined scope in [your account settings](https://fly.customer.io/settings/api_credentials?keyType=app). [Learn more about bearer authorization in Customer.io](https://customer.io/docs/api/app/).\n * \n */\n bearerAuth: \"BEARER_AUTH\"\n})", "typescriptSdkFirstRequestCode": "// Trigger a broadcast\nconst triggerBroadcastResponse = customerIoJourneysApp.sendMessages.triggerBroadcast()", "fixedSpecFileName": "customer-io-journeys-app-fixed-spec.yaml" diff --git a/sdks/db/published/from-custom-request_customer.io_JourneysTrack.json b/sdks/db/published/from-custom-request_customer.io_JourneysTrack.json index bca22c76e8..673d4463a1 100644 --- a/sdks/db/published/from-custom-request_customer.io_JourneysTrack.json +++ b/sdks/db/published/from-custom-request_customer.io_JourneysTrack.json @@ -24,7 +24,7 @@ "serviceName": "Journeys Track", "sdkName": "customer-io-journeys-track-{language}-sdk", "clientName": "CustomerIoJourneysTrack", - "metaDescription": "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products. \n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform. \n- Create and manage newsletters, transactional messages, and behavioral messages \n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time. \n\nLearn more: https://customer.io", + "metaDescription": "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products.\n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform.\n- Create and manage newsletters, transactional messages, and behavioral messages\n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time.\n\nLearn more: https://customer.io", "apiStatusUrls": "inherit", "homepage": "customer.io", "developerDocumentation": "customer.io/docs/api/track/", @@ -541,14 +541,14 @@ ] } ], - "repositoryDescription": "Customer.io is a versatile marketing automation tool that sends relevant messages based on user behavior across web and mobile. Real-time data ensures personalized messaging, from event reminders to onboarding emails. Automate product messaging, newsletters, and more with powerful segmentation and automation capabilities.", + "repositoryDescription": "Customer.io offers a versatile marketing automation tool for personalized messaging based on user behavior. Automate product messaging, newsletters, and more to connect with users effectively and save time. Customer.io's {language} SDK for Journeys Track API generated by Konfig (https://konfigthis.com/).", "logo": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-track/logo.png", "openApiRaw": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-track/openapi.yaml", "openApiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/customer-io/journeys-track/openapi.yaml", "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-track/imagePreview.png", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-track/favicon.png", "clientNameCamelCase": "customerIoJourneysTrack", - "lastUpdated": "2024-03-28T21:25:19.896Z", + "lastUpdated": "2024-03-28T21:38:28.766Z", "typescriptSdkUsageCode": "import { CustomerIoJourneysTrack } from 'customer-io-journeys-track-typescript-sdk';\n\nconst customerIoJourneysTrack = new CustomerIoJourneysTrack({\n /*\n * The Track API uses a basic authentication scheme. Your credentials are your **Site ID** and your **API key**, **Base-64 encoded** in the format `site_id:api_key`.\n * \n * You can find your Site ID and API key on the [Track API Keys page](https://fly.customer.io/settings/api_credentials).\n * \n */\n username: \"USERNAME\",\n password: \"PASSWORD\"\n})", "typescriptSdkFirstRequestCode": "// Find your account region\nconst findAccountRegionResponse = customerIoJourneysTrack.trackRegion.findAccountRegion()", "fixedSpecFileName": "customer-io-journeys-track-fixed-spec.yaml" diff --git a/sdks/db/published/from-custom-request_digitalocean.com.json b/sdks/db/published/from-custom-request_digitalocean.com.json index e6ef92c04d..0929f26b75 100644 --- a/sdks/db/published/from-custom-request_digitalocean.com.json +++ b/sdks/db/published/from-custom-request_digitalocean.com.json @@ -4300,7 +4300,7 @@ "httpMethod": "get", "tag": "Databases", "typeScriptTag": "databases", - "description": "List Connection Pools (PostgreSQL)", + "description": "List Connection Pools (https://docs.digitalocean.com/reference/api/api-reference/", "parameters": [ { "name": "databaseClusterUuid", @@ -4343,7 +4343,7 @@ "httpMethod": "post", "tag": "Databases", "typeScriptTag": "databases", - "description": "Add a New Connection Pool (PostgreSQL)", + "description": "Add a New Connection Pool (https://docs.digitalocean.com/reference/api/api-reference/", "parameters": [ { "name": "databaseClusterUuid", @@ -4445,7 +4445,7 @@ "httpMethod": "delete", "tag": "Databases", "typeScriptTag": "databases", - "description": "Delete a Connection Pool (PostgreSQL)", + "description": "Delete a Connection Pool (https://docs.digitalocean.com/reference/api/api-reference/", "parameters": [ { "name": "databaseClusterUuid", @@ -4495,7 +4495,7 @@ "httpMethod": "get", "tag": "Databases", "typeScriptTag": "databases", - "description": "Retrieve Existing Connection Pool (PostgreSQL)", + "description": "Retrieve Existing Connection Pool (https://docs.digitalocean.com/reference/api/api-reference/", "parameters": [ { "name": "databaseClusterUuid", @@ -4545,7 +4545,7 @@ "httpMethod": "put", "tag": "Databases", "typeScriptTag": "databases", - "description": "Update Connection Pools (PostgreSQL)", + "description": "Update Connection Pools (https://docs.digitalocean.com/reference/api/api-reference/", "parameters": [ { "name": "databaseClusterUuid", @@ -6668,7 +6668,7 @@ "httpMethod": "delete", "tag": "Droplets", "typeScriptTag": "droplets", - "description": "Destroy a Droplet and All of its Associated Resources (Dangerous)", + "description": "Destroy a Droplet and All of its Associated Resources (https://docs.digitalocean.com/reference/api/api-reference/", "parameters": [ { "name": "dropletId", @@ -8296,7 +8296,7 @@ "name": "imageId", "schema": "undefined", "required": true, - "description": "A unique number (id) or string (slug) used to identify and reference a\nspecific image.\n\n**Public** images can be identified by image `id` or `slug`.\n\n**Private** images *must* be identified by image `id`.\n" + "description": "A unique number (https://docs.digitalocean.com/reference/api/api-reference/ or string (https://docs.digitalocean.com/reference/api/api-reference/ used to identify and reference a\nspecific image.\n\n**Public** images can be identified by image `id` or `slug`.\n\n**Private** images *must* be identified by image `id`.\n" } ], "responses": [ @@ -9035,7 +9035,7 @@ "httpMethod": "delete", "tag": "Kubernetes", "typeScriptTag": "kubernetes", - "description": "Delete a Cluster and All of its Associated Resources (Dangerous)", + "description": "Delete a Cluster and All of its Associated Resources (https://docs.digitalocean.com/reference/api/api-reference/", "parameters": [ { "name": "clusterId", @@ -10819,14 +10819,14 @@ "name": "start", "schema": "string", "required": true, - "description": "Timestamp to start metric window.", + "description": "UNIX timestamp to start metric window.", "example": "1620683817" }, { "name": "end", "schema": "string", "required": true, - "description": "Timestamp to end metric window.", + "description": "UNIX timestamp to end metric window.", "example": "1620705417" } ], @@ -10872,14 +10872,14 @@ "name": "start", "schema": "string", "required": true, - "description": "Timestamp to start metric window.", + "description": "UNIX timestamp to start metric window.", "example": "1620683817" }, { "name": "end", "schema": "string", "required": true, - "description": "Timestamp to end metric window.", + "description": "UNIX timestamp to end metric window.", "example": "1620705417" } ], @@ -10925,14 +10925,14 @@ "name": "start", "schema": "string", "required": true, - "description": "Timestamp to start metric window.", + "description": "UNIX timestamp to start metric window.", "example": "1620683817" }, { "name": "end", "schema": "string", "required": true, - "description": "Timestamp to end metric window.", + "description": "UNIX timestamp to end metric window.", "example": "1620705417" } ], @@ -10978,14 +10978,14 @@ "name": "start", "schema": "string", "required": true, - "description": "Timestamp to start metric window.", + "description": "UNIX timestamp to start metric window.", "example": "1620683817" }, { "name": "end", "schema": "string", "required": true, - "description": "Timestamp to end metric window.", + "description": "UNIX timestamp to end metric window.", "example": "1620705417" } ], @@ -11031,14 +11031,14 @@ "name": "start", "schema": "string", "required": true, - "description": "Timestamp to start metric window.", + "description": "UNIX timestamp to start metric window.", "example": "1620683817" }, { "name": "end", "schema": "string", "required": true, - "description": "Timestamp to end metric window.", + "description": "UNIX timestamp to end metric window.", "example": "1620705417" } ], @@ -11084,14 +11084,14 @@ "name": "start", "schema": "string", "required": true, - "description": "Timestamp to start metric window.", + "description": "UNIX timestamp to start metric window.", "example": "1620683817" }, { "name": "end", "schema": "string", "required": true, - "description": "Timestamp to end metric window.", + "description": "UNIX timestamp to end metric window.", "example": "1620705417" } ], @@ -11137,14 +11137,14 @@ "name": "start", "schema": "string", "required": true, - "description": "Timestamp to start metric window.", + "description": "UNIX timestamp to start metric window.", "example": "1620683817" }, { "name": "end", "schema": "string", "required": true, - "description": "Timestamp to end metric window.", + "description": "UNIX timestamp to end metric window.", "example": "1620705417" } ], @@ -11190,14 +11190,14 @@ "name": "start", "schema": "string", "required": true, - "description": "Timestamp to start metric window.", + "description": "UNIX timestamp to start metric window.", "example": "1620683817" }, { "name": "end", "schema": "string", "required": true, - "description": "Timestamp to end metric window.", + "description": "UNIX timestamp to end metric window.", "example": "1620705417" } ], @@ -11243,14 +11243,14 @@ "name": "start", "schema": "string", "required": true, - "description": "Timestamp to start metric window.", + "description": "UNIX timestamp to start metric window.", "example": "1620683817" }, { "name": "end", "schema": "string", "required": true, - "description": "Timestamp to end metric window.", + "description": "UNIX timestamp to end metric window.", "example": "1620705417" } ], @@ -11296,14 +11296,14 @@ "name": "start", "schema": "string", "required": true, - "description": "Timestamp to start metric window.", + "description": "UNIX timestamp to start metric window.", "example": "1620683817" }, { "name": "end", "schema": "string", "required": true, - "description": "Timestamp to end metric window.", + "description": "UNIX timestamp to end metric window.", "example": "1620705417" } ], @@ -11349,14 +11349,14 @@ "name": "start", "schema": "string", "required": true, - "description": "Timestamp to start metric window.", + "description": "UNIX timestamp to start metric window.", "example": "1620683817" }, { "name": "end", "schema": "string", "required": true, - "description": "Timestamp to end metric window.", + "description": "UNIX timestamp to end metric window.", "example": "1620705417" } ], @@ -11409,14 +11409,14 @@ "name": "start", "schema": "string", "required": true, - "description": "Timestamp to start metric window.", + "description": "UNIX timestamp to start metric window.", "example": "1620683817" }, { "name": "end", "schema": "string", "required": true, - "description": "Timestamp to end metric window.", + "description": "UNIX timestamp to end metric window.", "example": "1620705417" } ], @@ -11469,14 +11469,14 @@ "name": "start", "schema": "string", "required": true, - "description": "Timestamp to start metric window.", + "description": "UNIX timestamp to start metric window.", "example": "1620683817" }, { "name": "end", "schema": "string", "required": true, - "description": "Timestamp to end metric window.", + "description": "UNIX timestamp to end metric window.", "example": "1620705417" } ], @@ -11529,14 +11529,14 @@ "name": "start", "schema": "string", "required": true, - "description": "Timestamp to start metric window.", + "description": "UNIX timestamp to start metric window.", "example": "1620683817" }, { "name": "end", "schema": "string", "required": true, - "description": "Timestamp to end metric window.", + "description": "UNIX timestamp to end metric window.", "example": "1620705417" } ], @@ -12559,7 +12559,7 @@ "httpMethod": "get", "tag": "Container Registry", "typeScriptTag": "containerRegistry", - "description": "List All Container Registry Repositories (V2)", + "description": "List All Container Registry Repositories (https://docs.digitalocean.com/reference/api/api-reference/", "parameters": [ { "name": "perPage", @@ -15583,7 +15583,7 @@ "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/digitalocean/imagePreview.png", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/digitalocean/favicon.png", "clientNameCamelCase": "digitalOcean", - "lastUpdated": "2024-03-27T01:23:25.425Z", + "lastUpdated": "2024-03-28T21:38:28.766Z", "typescriptSdkUsageCode": "import { DigitalOcean } from 'digital-ocean-typescript-sdk';\n\nconst digitalOcean = new DigitalOcean({\n /*\n * ## OAuth Authentication\n * \n * In order to interact with the DigitalOcean API, you or your application must\n * authenticate.\n * \n * The DigitalOcean API handles this through OAuth, an open standard for\n * authorization. OAuth allows you to delegate access to your account in full\n * or in read-only mode.\n * \n * You can generate an OAuth token by visiting the [Apps & API](https://cloud.digitalocean.com/account/api/tokens)\n * section of the DigitalOcean control panel for your account.\n * \n * An OAuth token functions as a complete authentication request. In effect, it\n * acts as a substitute for a username and password pair.\n * \n * Because of this, it is absolutely **essential** that you keep your OAuth\n * tokens secure. In fact, upon generation, the web interface will only display\n * each token a single time in order to prevent the token from being compromised.\n * \n * DigitalOcean access tokens begin with an identifiable prefix in order to\n * distinguish them from other similar tokens.\n * \n * - `dop_v1_` for personal access tokens generated in the control panel\n * - `doo_v1_` for tokens generated by applications using [the OAuth flow](https://docs.digitalocean.com/reference/api/oauth-api/)\n * - `dor_v1_` for OAuth refresh tokens\n * \n * ### How to Authenticate with OAuth\n * \n * In order to make an authenticated request, include a bearer-type\n * `Authorization` header containing your OAuth token. All requests must be\n * made over HTTPS.\n * \n * ### Authenticate with a Bearer Authorization Header\n * \n * ```\n * curl -X $HTTP_METHOD -H \"Authorization: Bearer $DIGITALOCEAN_TOKEN\" \"https://api.digitalocean.com/v2/$OBJECT\"\n * ```\n * \n */\n bearerAuth: \"BEARER_AUTH\"\n})", "typescriptSdkFirstRequestCode": "// List 1-Click Applications\nconst listResponse = digitalOcean.1ClickApplications.list({\n type: \"kubernetes\"\n})", "fixedSpecFileName": "digital-ocean-fixed-spec.yaml" diff --git a/sdks/db/published/from-custom-request_pappers.fr.json b/sdks/db/published/from-custom-request_pappers.fr.json new file mode 100644 index 0000000000..2a6ae6f859 --- /dev/null +++ b/sdks/db/published/from-custom-request_pappers.fr.json @@ -0,0 +1,2829 @@ +{ + "securitySchemes": {}, + "apiBaseUrl": "https://api.pappers.fr/v2", + "apiVersion": "2.13.0", + "apiDescription": "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.\n\nVous devez indiquer votre clé d'API dans les requêtes, en utilisant le paramètre `api_token`.\n\nL'URL d'accès à l'API est https://api.pappers.fr/v2/\n\nLien vers la documentation de la V1 : https://www.pappers.fr/api/documentation/v1\n\nLien vers la documentation de la V3 : https://www.pappers.fr/api/documentation/v3\n\nLien vers la documentation de l'API internationale : https://www.pappers.in/api/documentation\n\nL'historique des modifications (changelog) est accessible à l'url suivante : https://www.pappers.fr/api/changelog\n", + "apiTitle": "Pappers API", + "endpoints": 22, + "sdkMethods": 23, + "schemas": 53, + "parameters": 306, + "contactEmail": "support@pappers.fr", + "originalCustomRequest": { + "type": "GET", + "url": "https://www.pappers.fr/api_v2.yaml?20231125" + }, + "customRequestSpecFilename": "pappers.fr.yaml", + "difficultyScore": 115.5, + "difficulty": "Medium", + "company": "Pappers", + "sdkName": "pappers-{language}-sdk", + "clientName": "Pappers", + "metaDescription": "Avec Pappers, accédez à toute toute l'information légale, juridique financière des sociétés françaises !\nDécouvrez nos offres : https://www.pappers.fr/api et https://www.pappers.fr/exports", + "apiStatusUrls": "inherit", + "homepage": "www.pappers.fr/", + "developerDocumentation": "www.pappers.fr/api/documentation", + "categories": [ + "finance", + "legal", + "legaltech", + "data" + ], + "category": "Legal", + "methods": [ + { + "url": "/entreprise", + "method": "getInformation", + "httpMethod": "get", + "tag": "Fiche entreprise", + "typeScriptTag": "ficheEntreprise", + "description": "Récupère l'ensemble des informations disponibles sur une entreprise.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "siren", + "schema": "string", + "required": false, + "description": "SIREN de l'entreprise", + "example": 443061841 + }, + { + "name": "siret", + "schema": "string", + "required": false, + "description": "SIRET de l'entreprise", + "example": 44306184100047 + }, + { + "name": "integrerDiffusionsPartielles", + "schema": "boolean", + "required": false, + "description": "Si vrai et si l'entreprise est en diffusion partielle, le retour renverra les informations partielles disponibles. Valeur par défaut : `false`." + }, + { + "name": "formatPublicationsBodacc", + "schema": "string", + "required": false, + "description": "Format attendu pour les publications BODACC. Valeur par défaut : `\"objet\"`.", + "example": "objet" + }, + { + "name": "marques", + "schema": "boolean", + "required": false, + "description": "Si vrai, le retour inclura les marques éventuelles de l'entreprise. Valeur par défaut : `false`." + }, + { + "name": "validiteTvaIntracommunautaire", + "schema": "boolean", + "required": false, + "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": "publicationsBodaccBrutes", + "schema": "boolean", + "required": false, + "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": "champsSupplementaires", + "schema": "string", + "required": false, + "description": "Liste des champs supplémentaires à inclure dans le retour. Certains champs peuvent entraîner une consommation de jetons supplémentaires.\n\nChamps supplémentaires disponibles :\n- `sites_internet` : 1 jeton supplémentaire\n- `telephone` : 1 jeton supplémentaire *\n- `email` : 1 jeton supplémentaire *\n- `enseigne_1` : gratuit\n- `enseigne_2` : gratuit\n- `enseigne_3` : gratuit\n- `distribution_speciale` : gratuit\n- `code_cedex` : gratuit\n- `libelle_cedex` : gratuit\n- `code_commune` : gratuit\n- `code_region` : gratuit\n- `region` : gratuit\n- `code_departement` : gratuit\n- `departement` : gratuit\n- `nomenclature_code_naf` : gratuit\n- `labels` : gratuit\n- `labels:orias` : 0.5 jeton supplémentaire\n- `micro_entreprise` : gratuit\n- `sanctions` : 1 jeton supplémentaire\n- `personne_politiquement_exposee` : 1 jeton supplémentaire\n- `scoring_financier` : 10 jetons supplémentaires\n- `scoring_non_financier` : 10 jetons supplémentaires\n\n\\* : le coût des champs `telephone` et `email` est de 1 jeton supplémentaire au total, même si les deux sont demandés.\n", + "example": "site_internet,telephone" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "206", + "description": "" + }, + { + "statusCode": "400", + "description": "Paramètres de la requête incorrects." + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "404", + "description": "Entreprise inexistante." + } + ] + }, + { + "url": "/association", + "method": "getInfo", + "httpMethod": "get", + "tag": "Fiche association", + "typeScriptTag": "ficheAssociation", + "description": "Récupère l'ensemble des informations disponibles sur une association.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "idAssociation", + "schema": "string", + "required": false, + "description": "Identifiant de l'association", + "example": "W142005389" + }, + { + "name": "siret", + "schema": "string", + "required": false, + "description": "SIRET de l'association", + "example": 95037097300014 + }, + { + "name": "siren", + "schema": "string", + "required": false, + "description": "SIREN de l'association", + "example": 950370973 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Association liée à l'entreprise." + }, + { + "statusCode": "400", + "description": "Paramètres de la requête incorrects." + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "404", + "description": "Association inexistante." + }, + { + "statusCode": "503", + "description": "Service momentanément indisponible." + } + ] + }, + { + "url": "/recherche", + "method": "criteriaEnterprisesGet", + "httpMethod": "get", + "tag": "Recherche", + "typeScriptTag": "recherche", + "description": "Recherche les entreprises qui correspondent à des critères.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page de résultats. Valeur par défaut : `1`.", + "example": 1 + }, + { + "name": "parPage", + "schema": "integer", + "required": false, + "description": "Nombre de résultats affichés sur une page. Valeur par défaut : `10`.", + "example": 20 + }, + { + "name": "curseur", + "schema": "string", + "required": false, + "description": "Curseur servant à parcourir l'ensemble des résultats (alternativement à la pagination qui est limitée à 400 résultats maximum). Doit valoir `*` pour la première requête, et doit pour les requêtes suivantes reprendre la valeur `curseurSuivant` retournée par la dernière réponse.", + "example": "*" + }, + { + "name": "parCurseur", + "schema": "integer", + "required": false, + "description": "Nombre de résultats affichés par curseur. Valeur par défaut : `50`. Valeur minimale: `1`. Valeur maximale : `1000`.", + "example": 20 + }, + { + "name": "bases", + "schema": "string", + "required": false, + "description": "Bases de données dans lesquelles rechercher. Il est possible d'indiquer plusieurs bases en les séparant par des virgules. Valeur par défaut : `\"entreprises\"`.", + "example": "entreprises" + }, + { + "name": "precision", + "schema": "string", + "required": false, + "description": "Niveau de précision de la recherche. Valeur par défaut : `\"standard\"`.", + "example": "standard" + }, + { + "name": "q", + "schema": "string", + "required": false, + "description": "Texte à rechercher. Dénomination pour une personne morale, nom et prénom pour une personne physique.\nSi vous recherchez dans plusieurs bases, ce paramètre sera utilisé pour rechercher dans toutes les bases.", + "example": "Google France" + }, + { + "name": "siege", + "schema": "string", + "required": false, + "description": "Défini si la requête se base sur le siège", + "example": "true" + }, + { + "name": "codeNaf", + "schema": "string", + "required": false, + "description": "Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes NAF en les séparant par des virgules.", + "example": "70.10Z" + }, + { + "name": "departement", + "schema": "string", + "required": false, + "description": "Numéro de département de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs départements en les séparant par des virgules.", + "example": 75 + }, + { + "name": "region", + "schema": "string", + "required": false, + "description": "Code de la région de l'un des établissements de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il est possible d'indiquer plusieurs codes régions en les séparant par des virgules.", + "example": 11 + }, + { + "name": "codePostal", + "schema": "string", + "required": false, + "description": "Code postal de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs codes postaux en les séparant par des virgules.", + "example": 75009 + }, + { + "name": "conventionCollective", + "schema": "string", + "required": false, + "description": "Convention collective de l'entreprise.", + "example": 1486 + }, + { + "name": "categorieJuridique", + "schema": "string", + "required": false, + "description": "Catégorie juridique de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/2028129). \n\n**Note** : Le code correspond à celui de l'INSEE, à l'exception des SASU qui auront comme code 5720 et les EURL qui auront comme code 5498.", + "example": 5499 + }, + { + "name": "entrepriseCessee", + "schema": "boolean", + "required": false, + "description": "Activité de l'entreprise cessée ou non.", + "example": false + }, + { + "name": "statutRcs", + "schema": "string", + "required": false, + "description": "Statut au RCS", + "example": "inscrit" + }, + { + "name": "objetSocial", + "schema": "string", + "required": false, + "description": "Objet social de l'entreprise déclaré au RCS.", + "example": "La conception de moteurs de recherche sur internet." + }, + { + "name": "dateImmatriculationRcsMin", + "schema": "string", + "required": false, + "description": "Date d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateImmatriculationRcsMax", + "schema": "string", + "required": false, + "description": "d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateRadiationRcsMin", + "schema": "string", + "required": false, + "description": "Date de radiation au RCS minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateRadiationRcsMax", + "schema": "string", + "required": false, + "description": "Date de radiation au RCS maximale de l'entreprise, au format JJ-MM-AAAA.", + "example": "17-05-2002" + }, + { + "name": "capitalMin", + "schema": "string", + "required": false, + "description": "Capital minimum de l'entreprise.", + "example": 411016200 + }, + { + "name": "capitalMax", + "schema": "string", + "required": false, + "description": "Capital maximum de l'entreprise.", + "example": 411016400 + }, + { + "name": "chiffreAffairesMin", + "schema": "string", + "required": false, + "description": "Chiffre d'affaires minimum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 411016200 + }, + { + "name": "chiffreAffairesMax", + "schema": "string", + "required": false, + "description": "Chiffre d'affaires maximum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 411016400 + }, + { + "name": "resultatMin", + "schema": "string", + "required": false, + "description": "Résultat minimum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 29327000 + }, + { + "name": "resultatMax", + "schema": "string", + "required": false, + "description": "Résultat maximum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 29327100 + }, + { + "name": "dateCreationMin", + "schema": "string", + "required": false, + "description": "Date de création minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateCreationMax", + "schema": "string", + "required": false, + "description": "Date de création maximale de l'entreprise, au format JJ-MM-AAAA.", + "example": "17-05-2002" + }, + { + "name": "trancheEffectifMin", + "schema": "string", + "required": false, + "description": "Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/sirene/public/variable/tefen).\n\n**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur", + "example": 40 + }, + { + "name": "trancheEffectifMax", + "schema": "string", + "required": false, + "description": "Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/sirene/public/variable/tefen).\n\n**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur", + "example": 42 + }, + { + "name": "typeDirigeant", + "schema": "string", + "required": false, + "description": "Type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "physique" + }, + { + "name": "qualiteDirigeant", + "schema": "string", + "required": false, + "description": "Qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Administrateur" + }, + { + "name": "nationaliteDirigeant", + "schema": "string", + "required": false, + "description": "Nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Française" + }, + { + "name": "nomDirigeant", + "schema": "string", + "required": false, + "description": "Nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Yi" + }, + { + "name": "prenomDirigeant", + "schema": "string", + "required": false, + "description": "Prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Kenneth H." + }, + { + "name": "ageDirigeantMin", + "schema": "integer", + "required": false, + "description": "Âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": 40 + }, + { + "name": "ageDirigeantMax", + "schema": "integer", + "required": false, + "description": "Âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": 42 + }, + { + "name": "dateDeNaissanceDirigeantMin", + "schema": "string", + "required": false, + "description": "Date de naissance minimale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA.", + "example": "1970-01-01T00:00:00.000Z" + }, + { + "name": "dateDeNaissanceDirigeantMax", + "schema": "string", + "required": false, + "description": "Date de naissance maximale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA.", + "example": "1970-12-31T00:00:00.000Z" + }, + { + "name": "ageBeneficiaireMin", + "schema": "integer", + "required": false, + "description": "Âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises).", + "example": 40 + }, + { + "name": "ageBeneficiaireMax", + "schema": "integer", + "required": false, + "description": "Âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises).", + "example": 42 + }, + { + "name": "dateDeNaissanceBeneficiaireMin", + "schema": "string", + "required": false, + "description": "Date de naissance minimale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA.", + "example": "1970-01-01T00:00:00.000Z" + }, + { + "name": "dateDeNaissanceBeneficiaireMax", + "schema": "string", + "required": false, + "description": "Date de naissance maximale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA.", + "example": "1970-12-31T00:00:00.000Z" + }, + { + "name": "nationaliteBeneficiaire", + "schema": "string", + "required": false, + "description": "Nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises).", + "example": "Française" + }, + { + "name": "dateDepotDocumentMin", + "schema": "string", + "required": false, + "description": "Date de dépôt minimale du document, au format JJ-MM-AAAA.", + "example": "2000-01-01T00:00:00.000Z" + }, + { + "name": "dateDepotDocumentMax", + "schema": "string", + "required": false, + "description": "Date de dépôt maximale du document, au format JJ-MM-AAAA.", + "example": "2000-12-31T00:00:00.000Z" + }, + { + "name": "typePublication", + "schema": "string", + "required": false, + "description": "Type de publication", + "example": "Procédure collective" + }, + { + "name": "datePublicationMin", + "schema": "string", + "required": false, + "description": "Date publication minimale de la publication, au format JJ-MM-AAAA.", + "example": "2000-01-01T00:00:00.000Z" + }, + { + "name": "datePublicationMax", + "schema": "string", + "required": false, + "description": "Date de publication maximale de la publication, au format JJ-MM-AAAA.", + "example": "2000-12-31T00:00:00.000Z" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "404", + "description": "Aucune entreprise ne correspond aux critères indiqués." + }, + { + "statusCode": "503", + "description": "Service momentanément indisponible." + } + ] + }, + { + "url": "/recherche-dirigeants", + "method": "leadersSearchCriteriaGet", + "httpMethod": "get", + "tag": "Recherche", + "typeScriptTag": "recherche", + "description": "Recherche les dirigeants qui correspondent à des critères.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "parPage", + "schema": "integer", + "required": false, + "description": "Nombre de résultats affichés sur une page. Valeur par défaut : `10`.", + "example": 20 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page de résultats. Valeur par défaut : `1`.", + "example": 1 + }, + { + "name": "precision", + "schema": "string", + "required": false, + "description": "Niveau de précision de la recherche. Valeur par défaut : `\"standard\"`.", + "example": "standard" + }, + { + "name": "q", + "schema": "string", + "required": false, + "description": "Texte à rechercher. Nom et prénom du dirigeant pour une personne physique, dénomination pour une personne morale.", + "example": "Google France" + }, + { + "name": "typeDirigeant", + "schema": "string", + "required": false, + "description": "Type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "physique" + }, + { + "name": "qualiteDirigeant", + "schema": "string", + "required": false, + "description": "Qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Administrateur" + }, + { + "name": "nationaliteDirigeant", + "schema": "string", + "required": false, + "description": "Nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Française" + }, + { + "name": "nomDirigeant", + "schema": "string", + "required": false, + "description": "Nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Yi" + }, + { + "name": "prenomDirigeant", + "schema": "string", + "required": false, + "description": "Prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Kenneth H." + }, + { + "name": "ageDirigeantMin", + "schema": "integer", + "required": false, + "description": "Âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": 40 + }, + { + "name": "ageDirigeantMax", + "schema": "integer", + "required": false, + "description": "Âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": 42 + }, + { + "name": "dateDeNaissanceDirigeantMin", + "schema": "string", + "required": false, + "description": "Date de naissance minimale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA.", + "example": "1970-01-01T00:00:00.000Z" + }, + { + "name": "dateDeNaissanceDirigeantMax", + "schema": "string", + "required": false, + "description": "Date de naissance maximale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA.", + "example": "1970-12-31T00:00:00.000Z" + }, + { + "name": "codeNaf", + "schema": "string", + "required": false, + "description": "Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes NAF en les séparant par des virgules.", + "example": "70.10Z" + }, + { + "name": "departement", + "schema": "string", + "required": false, + "description": "Numéro de département de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs départements en les séparant par des virgules.", + "example": 75 + }, + { + "name": "region", + "schema": "string", + "required": false, + "description": "Code de la région de l'un des établissements de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il est possible d'indiquer plusieurs codes régions en les séparant par des virgules.", + "example": 11 + }, + { + "name": "codePostal", + "schema": "string", + "required": false, + "description": "Code postal de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs codes postaux en les séparant par des virgules.", + "example": 75009 + }, + { + "name": "conventionCollective", + "schema": "string", + "required": false, + "description": "Convention collective de l'entreprise.", + "example": 1486 + }, + { + "name": "categorieJuridique", + "schema": "string", + "required": false, + "description": "Catégorie juridique de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/2028129). \n\n**Note** : Le code correspond à celui de l'INSEE, à l'exception des SASU qui auront comme code 5720 et les EURL qui auront comme code 5498.", + "example": 5499 + }, + { + "name": "entrepriseCessee", + "schema": "boolean", + "required": false, + "description": "Activité de l'entreprise cessée ou non.", + "example": false + }, + { + "name": "statutRcs", + "schema": "string", + "required": false, + "description": "Statut au RCS", + "example": "inscrit" + }, + { + "name": "objetSocial", + "schema": "string", + "required": false, + "description": "Objet social de l'entreprise déclaré au RCS.", + "example": "La conception de moteurs de recherche sur internet." + }, + { + "name": "dateImmatriculationRcsMin", + "schema": "string", + "required": false, + "description": "Date d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateImmatriculationRcsMax", + "schema": "string", + "required": false, + "description": "d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateRadiationRcsMin", + "schema": "string", + "required": false, + "description": "Date de radiation au RCS minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateRadiationRcsMax", + "schema": "string", + "required": false, + "description": "Date de radiation au RCS maximale de l'entreprise, au format JJ-MM-AAAA.", + "example": "17-05-2002" + }, + { + "name": "capitalMin", + "schema": "string", + "required": false, + "description": "Capital minimum de l'entreprise.", + "example": 411016200 + }, + { + "name": "capitalMax", + "schema": "string", + "required": false, + "description": "Capital maximum de l'entreprise.", + "example": 411016400 + }, + { + "name": "chiffreAffairesMin", + "schema": "string", + "required": false, + "description": "Chiffre d'affaires minimum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 411016200 + }, + { + "name": "chiffreAffairesMax", + "schema": "string", + "required": false, + "description": "Chiffre d'affaires maximum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 411016400 + }, + { + "name": "resultatMin", + "schema": "string", + "required": false, + "description": "Résultat minimum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 29327000 + }, + { + "name": "resultatMax", + "schema": "string", + "required": false, + "description": "Résultat maximum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 29327100 + }, + { + "name": "dateCreationMin", + "schema": "string", + "required": false, + "description": "Date de création minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateCreationMax", + "schema": "string", + "required": false, + "description": "Date de création maximale de l'entreprise, au format JJ-MM-AAAA.", + "example": "17-05-2002" + }, + { + "name": "trancheEffectifMin", + "schema": "string", + "required": false, + "description": "Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/sirene/public/variable/tefen).\n\n**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur", + "example": 40 + }, + { + "name": "trancheEffectifMax", + "schema": "string", + "required": false, + "description": "Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/sirene/public/variable/tefen).\n\n**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur", + "example": 42 + }, + { + "name": "ageBeneficiaireMin", + "schema": "integer", + "required": false, + "description": "Âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises).", + "example": 40 + }, + { + "name": "ageBeneficiaireMax", + "schema": "integer", + "required": false, + "description": "Âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises).", + "example": 42 + }, + { + "name": "dateDeNaissanceBeneficiaireMin", + "schema": "string", + "required": false, + "description": "Date de naissance minimale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA.", + "example": "1970-01-01T00:00:00.000Z" + }, + { + "name": "dateDeNaissanceBeneficiaireMax", + "schema": "string", + "required": false, + "description": "Date de naissance maximale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA.", + "example": "1970-12-31T00:00:00.000Z" + }, + { + "name": "nationaliteBeneficiaire", + "schema": "string", + "required": false, + "description": "Nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises).", + "example": "Française" + }, + { + "name": "dateDepotDocumentMin", + "schema": "string", + "required": false, + "description": "Date de dépôt minimale du document, au format JJ-MM-AAAA.", + "example": "2000-01-01T00:00:00.000Z" + }, + { + "name": "dateDepotDocumentMax", + "schema": "string", + "required": false, + "description": "Date de dépôt maximale du document, au format JJ-MM-AAAA.", + "example": "2000-12-31T00:00:00.000Z" + }, + { + "name": "typePublication", + "schema": "string", + "required": false, + "description": "Type de publication", + "example": "Procédure collective" + }, + { + "name": "datePublicationMin", + "schema": "string", + "required": false, + "description": "Date publication minimale de la publication, au format JJ-MM-AAAA.", + "example": "2000-01-01T00:00:00.000Z" + }, + { + "name": "datePublicationMax", + "schema": "string", + "required": false, + "description": "Date de publication maximale de la publication, au format JJ-MM-AAAA.", + "example": "2000-12-31T00:00:00.000Z" + }, + { + "name": "siren", + "schema": "string", + "required": false, + "description": "SIREN de l'entreprise.", + "example": null + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "404", + "description": "Aucun dirigeant ne correspond aux critères indiqués." + }, + { + "statusCode": "503", + "description": "Service momentanément indisponible." + } + ] + }, + { + "url": "/recherche-beneficiaires", + "method": "effectiveBeneficiariesSearch", + "httpMethod": "get", + "tag": "Recherche", + "typeScriptTag": "recherche", + "description": "Recherche les bénéficiaires effectifs qui correspondent à des critères.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "parPage", + "schema": "integer", + "required": false, + "description": "Nombre de résultats affichés sur une page. Valeur par défaut : `10`.", + "example": 20 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page de résultats. Valeur par défaut : `1`.", + "example": 1 + }, + { + "name": "precision", + "schema": "string", + "required": false, + "description": "Niveau de précision de la recherche. Valeur par défaut : `\"standard\"`.", + "example": "standard" + }, + { + "name": "q", + "schema": "string", + "required": false, + "description": "Nom et/ou prénom du bénéficiaire effectif.", + "example": "Xavier Niel" + }, + { + "name": "ageBeneficiaireMin", + "schema": "integer", + "required": false, + "description": "Âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises).", + "example": 40 + }, + { + "name": "ageBeneficiaireMax", + "schema": "integer", + "required": false, + "description": "Âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises).", + "example": 42 + }, + { + "name": "dateDeNaissanceBeneficiaireMin", + "schema": "string", + "required": false, + "description": "Date de naissance minimale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA.", + "example": "1970-01-01T00:00:00.000Z" + }, + { + "name": "dateDeNaissanceBeneficiaireMax", + "schema": "string", + "required": false, + "description": "Date de naissance maximale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA.", + "example": "1970-12-31T00:00:00.000Z" + }, + { + "name": "nationaliteBeneficiaire", + "schema": "string", + "required": false, + "description": "Nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises).", + "example": "Française" + }, + { + "name": "codeNaf", + "schema": "string", + "required": false, + "description": "Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes NAF en les séparant par des virgules.", + "example": "70.10Z" + }, + { + "name": "departement", + "schema": "string", + "required": false, + "description": "Numéro de département de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs départements en les séparant par des virgules.", + "example": 75 + }, + { + "name": "region", + "schema": "string", + "required": false, + "description": "Code de la région de l'un des établissements de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il est possible d'indiquer plusieurs codes régions en les séparant par des virgules.", + "example": 11 + }, + { + "name": "codePostal", + "schema": "string", + "required": false, + "description": "Code postal de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs codes postaux en les séparant par des virgules.", + "example": 75009 + }, + { + "name": "conventionCollective", + "schema": "string", + "required": false, + "description": "Convention collective de l'entreprise.", + "example": 1486 + }, + { + "name": "categorieJuridique", + "schema": "string", + "required": false, + "description": "Catégorie juridique de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/2028129). \n\n**Note** : Le code correspond à celui de l'INSEE, à l'exception des SASU qui auront comme code 5720 et les EURL qui auront comme code 5498.", + "example": 5499 + }, + { + "name": "entrepriseCessee", + "schema": "boolean", + "required": false, + "description": "Activité de l'entreprise cessée ou non.", + "example": false + }, + { + "name": "statutRcs", + "schema": "string", + "required": false, + "description": "Statut au RCS", + "example": "inscrit" + }, + { + "name": "objetSocial", + "schema": "string", + "required": false, + "description": "Objet social de l'entreprise déclaré au RCS.", + "example": "La conception de moteurs de recherche sur internet." + }, + { + "name": "dateImmatriculationRcsMin", + "schema": "string", + "required": false, + "description": "Date d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateImmatriculationRcsMax", + "schema": "string", + "required": false, + "description": "d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateRadiationRcsMin", + "schema": "string", + "required": false, + "description": "Date de radiation au RCS minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateRadiationRcsMax", + "schema": "string", + "required": false, + "description": "Date de radiation au RCS maximale de l'entreprise, au format JJ-MM-AAAA.", + "example": "17-05-2002" + }, + { + "name": "capitalMin", + "schema": "string", + "required": false, + "description": "Capital minimum de l'entreprise.", + "example": 411016200 + }, + { + "name": "capitalMax", + "schema": "string", + "required": false, + "description": "Capital maximum de l'entreprise.", + "example": 411016400 + }, + { + "name": "chiffreAffairesMin", + "schema": "string", + "required": false, + "description": "Chiffre d'affaires minimum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 411016200 + }, + { + "name": "chiffreAffairesMax", + "schema": "string", + "required": false, + "description": "Chiffre d'affaires maximum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 411016400 + }, + { + "name": "resultatMin", + "schema": "string", + "required": false, + "description": "Résultat minimum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 29327000 + }, + { + "name": "resultatMax", + "schema": "string", + "required": false, + "description": "Résultat maximum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 29327100 + }, + { + "name": "dateCreationMin", + "schema": "string", + "required": false, + "description": "Date de création minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateCreationMax", + "schema": "string", + "required": false, + "description": "Date de création maximale de l'entreprise, au format JJ-MM-AAAA.", + "example": "17-05-2002" + }, + { + "name": "trancheEffectifMin", + "schema": "string", + "required": false, + "description": "Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/sirene/public/variable/tefen).\n\n**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur", + "example": 40 + }, + { + "name": "trancheEffectifMax", + "schema": "string", + "required": false, + "description": "Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/sirene/public/variable/tefen).\n\n**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur", + "example": 42 + }, + { + "name": "typeDirigeant", + "schema": "string", + "required": false, + "description": "Type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "physique" + }, + { + "name": "qualiteDirigeant", + "schema": "string", + "required": false, + "description": "Qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Administrateur" + }, + { + "name": "nationaliteDirigeant", + "schema": "string", + "required": false, + "description": "Nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Française" + }, + { + "name": "nomDirigeant", + "schema": "string", + "required": false, + "description": "Nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Yi" + }, + { + "name": "prenomDirigeant", + "schema": "string", + "required": false, + "description": "Prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Kenneth H." + }, + { + "name": "ageDirigeantMin", + "schema": "integer", + "required": false, + "description": "Âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": 40 + }, + { + "name": "ageDirigeantMax", + "schema": "integer", + "required": false, + "description": "Âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": 42 + }, + { + "name": "dateDeNaissanceDirigeantMin", + "schema": "string", + "required": false, + "description": "Date de naissance minimale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA.", + "example": "1970-01-01T00:00:00.000Z" + }, + { + "name": "dateDeNaissanceDirigeantMax", + "schema": "string", + "required": false, + "description": "Date de naissance maximale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA.", + "example": "1970-12-31T00:00:00.000Z" + }, + { + "name": "dateDepotDocumentMin", + "schema": "string", + "required": false, + "description": "Date de dépôt minimale du document, au format JJ-MM-AAAA.", + "example": "2000-01-01T00:00:00.000Z" + }, + { + "name": "dateDepotDocumentMax", + "schema": "string", + "required": false, + "description": "Date de dépôt maximale du document, au format JJ-MM-AAAA.", + "example": "2000-12-31T00:00:00.000Z" + }, + { + "name": "typePublication", + "schema": "string", + "required": false, + "description": "Type de publication", + "example": "Procédure collective" + }, + { + "name": "datePublicationMin", + "schema": "string", + "required": false, + "description": "Date publication minimale de la publication, au format JJ-MM-AAAA.", + "example": "2000-01-01T00:00:00.000Z" + }, + { + "name": "datePublicationMax", + "schema": "string", + "required": false, + "description": "Date de publication maximale de la publication, au format JJ-MM-AAAA.", + "example": "2000-12-31T00:00:00.000Z" + }, + { + "name": "siren", + "schema": "string", + "required": false, + "description": "SIREN de l'entreprise.", + "example": null + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "404", + "description": "Aucun bénéficiaire effectif ne correspond aux critères indiqués." + }, + { + "statusCode": "503", + "description": "Service momentanément indisponible." + } + ] + }, + { + "url": "/recherche-documents", + "method": "matchingDocumentsGet", + "httpMethod": "get", + "tag": "Recherche", + "typeScriptTag": "recherche", + "description": "Recherche les documents qui correspondent à des critères.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "parPage", + "schema": "integer", + "required": false, + "description": "Nombre de résultats affichés sur une page. Valeur par défaut : `10`.", + "example": 20 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page de résultats. Valeur par défaut : `1`.", + "example": 1 + }, + { + "name": "precision", + "schema": "string", + "required": false, + "description": "Niveau de précision de la recherche. Valeur par défaut : `\"standard\"`.", + "example": "standard" + }, + { + "name": "q", + "schema": "string", + "required": false, + "description": "Mot-clé à rechercher dans le contenu du document.", + "example": "Rémunération" + }, + { + "name": "dateDepotDocumentMin", + "schema": "string", + "required": false, + "description": "Date de dépôt minimale du document, au format JJ-MM-AAAA.", + "example": "2000-01-01T00:00:00.000Z" + }, + { + "name": "dateDepotDocumentMax", + "schema": "string", + "required": false, + "description": "Date de dépôt maximale du document, au format JJ-MM-AAAA.", + "example": "2000-12-31T00:00:00.000Z" + }, + { + "name": "codeNaf", + "schema": "string", + "required": false, + "description": "Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes NAF en les séparant par des virgules.", + "example": "70.10Z" + }, + { + "name": "departement", + "schema": "string", + "required": false, + "description": "Numéro de département de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs départements en les séparant par des virgules.", + "example": 75 + }, + { + "name": "region", + "schema": "string", + "required": false, + "description": "Code de la région de l'un des établissements de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il est possible d'indiquer plusieurs codes régions en les séparant par des virgules.", + "example": 11 + }, + { + "name": "codePostal", + "schema": "string", + "required": false, + "description": "Code postal de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs codes postaux en les séparant par des virgules.", + "example": 75009 + }, + { + "name": "conventionCollective", + "schema": "string", + "required": false, + "description": "Convention collective de l'entreprise.", + "example": 1486 + }, + { + "name": "categorieJuridique", + "schema": "string", + "required": false, + "description": "Catégorie juridique de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/2028129). \n\n**Note** : Le code correspond à celui de l'INSEE, à l'exception des SASU qui auront comme code 5720 et les EURL qui auront comme code 5498.", + "example": 5499 + }, + { + "name": "entrepriseCessee", + "schema": "boolean", + "required": false, + "description": "Activité de l'entreprise cessée ou non.", + "example": false + }, + { + "name": "statutRcs", + "schema": "string", + "required": false, + "description": "Statut au RCS", + "example": "inscrit" + }, + { + "name": "objetSocial", + "schema": "string", + "required": false, + "description": "Objet social de l'entreprise déclaré au RCS.", + "example": "La conception de moteurs de recherche sur internet." + }, + { + "name": "dateImmatriculationRcsMin", + "schema": "string", + "required": false, + "description": "Date d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateImmatriculationRcsMax", + "schema": "string", + "required": false, + "description": "d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateRadiationRcsMin", + "schema": "string", + "required": false, + "description": "Date de radiation au RCS minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateRadiationRcsMax", + "schema": "string", + "required": false, + "description": "Date de radiation au RCS maximale de l'entreprise, au format JJ-MM-AAAA.", + "example": "17-05-2002" + }, + { + "name": "capitalMin", + "schema": "string", + "required": false, + "description": "Capital minimum de l'entreprise.", + "example": 411016200 + }, + { + "name": "capitalMax", + "schema": "string", + "required": false, + "description": "Capital maximum de l'entreprise.", + "example": 411016400 + }, + { + "name": "chiffreAffairesMin", + "schema": "string", + "required": false, + "description": "Chiffre d'affaires minimum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 411016200 + }, + { + "name": "chiffreAffairesMax", + "schema": "string", + "required": false, + "description": "Chiffre d'affaires maximum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 411016400 + }, + { + "name": "resultatMin", + "schema": "string", + "required": false, + "description": "Résultat minimum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 29327000 + }, + { + "name": "resultatMax", + "schema": "string", + "required": false, + "description": "Résultat maximum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 29327100 + }, + { + "name": "dateCreationMin", + "schema": "string", + "required": false, + "description": "Date de création minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateCreationMax", + "schema": "string", + "required": false, + "description": "Date de création maximale de l'entreprise, au format JJ-MM-AAAA.", + "example": "17-05-2002" + }, + { + "name": "trancheEffectifMin", + "schema": "string", + "required": false, + "description": "Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/sirene/public/variable/tefen).\n\n**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur", + "example": 40 + }, + { + "name": "trancheEffectifMax", + "schema": "string", + "required": false, + "description": "Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/sirene/public/variable/tefen).\n\n**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur", + "example": 42 + }, + { + "name": "typeDirigeant", + "schema": "string", + "required": false, + "description": "Type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "physique" + }, + { + "name": "qualiteDirigeant", + "schema": "string", + "required": false, + "description": "Qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Administrateur" + }, + { + "name": "nationaliteDirigeant", + "schema": "string", + "required": false, + "description": "Nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Française" + }, + { + "name": "nomDirigeant", + "schema": "string", + "required": false, + "description": "Nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Yi" + }, + { + "name": "prenomDirigeant", + "schema": "string", + "required": false, + "description": "Prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Kenneth H." + }, + { + "name": "ageDirigeantMin", + "schema": "integer", + "required": false, + "description": "Âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": 40 + }, + { + "name": "ageDirigeantMax", + "schema": "integer", + "required": false, + "description": "Âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": 42 + }, + { + "name": "dateDeNaissanceDirigeantMin", + "schema": "string", + "required": false, + "description": "Date de naissance minimale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA.", + "example": "1970-01-01T00:00:00.000Z" + }, + { + "name": "dateDeNaissanceDirigeantMax", + "schema": "string", + "required": false, + "description": "Date de naissance maximale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA.", + "example": "1970-12-31T00:00:00.000Z" + }, + { + "name": "ageBeneficiaireMin", + "schema": "integer", + "required": false, + "description": "Âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises).", + "example": 40 + }, + { + "name": "ageBeneficiaireMax", + "schema": "integer", + "required": false, + "description": "Âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises).", + "example": 42 + }, + { + "name": "dateDeNaissanceBeneficiaireMin", + "schema": "string", + "required": false, + "description": "Date de naissance minimale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA.", + "example": "1970-01-01T00:00:00.000Z" + }, + { + "name": "dateDeNaissanceBeneficiaireMax", + "schema": "string", + "required": false, + "description": "Date de naissance maximale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA.", + "example": "1970-12-31T00:00:00.000Z" + }, + { + "name": "nationaliteBeneficiaire", + "schema": "string", + "required": false, + "description": "Nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises).", + "example": "Française" + }, + { + "name": "typePublication", + "schema": "string", + "required": false, + "description": "Type de publication", + "example": "Procédure collective" + }, + { + "name": "datePublicationMin", + "schema": "string", + "required": false, + "description": "Date publication minimale de la publication, au format JJ-MM-AAAA.", + "example": "2000-01-01T00:00:00.000Z" + }, + { + "name": "datePublicationMax", + "schema": "string", + "required": false, + "description": "Date de publication maximale de la publication, au format JJ-MM-AAAA.", + "example": "2000-12-31T00:00:00.000Z" + }, + { + "name": "siren", + "schema": "string", + "required": false, + "description": "SIREN de l'entreprise.", + "example": null + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "404", + "description": "Aucun document ne correspond aux critères indiqués." + }, + { + "statusCode": "503", + "description": "Service momentanément indisponible." + } + ] + }, + { + "url": "/recherche-publications", + "method": "matchingPublicationsGet", + "httpMethod": "get", + "tag": "Recherche", + "typeScriptTag": "recherche", + "description": "Recherche les publications BODACC qui correspondent à des critères.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "parPage", + "schema": "integer", + "required": false, + "description": "Nombre de résultats affichés sur une page. Valeur par défaut : `10`.", + "example": 20 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page de résultats. Valeur par défaut : `1`.", + "example": 1 + }, + { + "name": "precision", + "schema": "string", + "required": false, + "description": "Niveau de précision de la recherche. Valeur par défaut : `\"standard\"`.", + "example": "standard" + }, + { + "name": "q", + "schema": "string", + "required": false, + "description": "Mot-clé à rechercher dans le contenu de la publication.", + "example": "Liquidation" + }, + { + "name": "codeNaf", + "schema": "string", + "required": false, + "description": "Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes NAF en les séparant par des virgules.", + "example": "70.10Z" + }, + { + "name": "departement", + "schema": "string", + "required": false, + "description": "Numéro de département de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs départements en les séparant par des virgules.", + "example": 75 + }, + { + "name": "region", + "schema": "string", + "required": false, + "description": "Code de la région de l'un des établissements de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il est possible d'indiquer plusieurs codes régions en les séparant par des virgules.", + "example": 11 + }, + { + "name": "codePostal", + "schema": "string", + "required": false, + "description": "Code postal de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs codes postaux en les séparant par des virgules.", + "example": 75009 + }, + { + "name": "conventionCollective", + "schema": "string", + "required": false, + "description": "Convention collective de l'entreprise.", + "example": 1486 + }, + { + "name": "categorieJuridique", + "schema": "string", + "required": false, + "description": "Catégorie juridique de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/2028129). \n\n**Note** : Le code correspond à celui de l'INSEE, à l'exception des SASU qui auront comme code 5720 et les EURL qui auront comme code 5498.", + "example": 5499 + }, + { + "name": "entrepriseCessee", + "schema": "boolean", + "required": false, + "description": "Activité de l'entreprise cessée ou non.", + "example": false + }, + { + "name": "statutRcs", + "schema": "string", + "required": false, + "description": "Statut au RCS", + "example": "inscrit" + }, + { + "name": "objetSocial", + "schema": "string", + "required": false, + "description": "Objet social de l'entreprise déclaré au RCS.", + "example": "La conception de moteurs de recherche sur internet." + }, + { + "name": "dateImmatriculationRcsMin", + "schema": "string", + "required": false, + "description": "Date d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateImmatriculationRcsMax", + "schema": "string", + "required": false, + "description": "d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateRadiationRcsMin", + "schema": "string", + "required": false, + "description": "Date de radiation au RCS minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateRadiationRcsMax", + "schema": "string", + "required": false, + "description": "Date de radiation au RCS maximale de l'entreprise, au format JJ-MM-AAAA.", + "example": "17-05-2002" + }, + { + "name": "capitalMin", + "schema": "string", + "required": false, + "description": "Capital minimum de l'entreprise.", + "example": 411016200 + }, + { + "name": "capitalMax", + "schema": "string", + "required": false, + "description": "Capital maximum de l'entreprise.", + "example": 411016400 + }, + { + "name": "chiffreAffairesMin", + "schema": "string", + "required": false, + "description": "Chiffre d'affaires minimum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 411016200 + }, + { + "name": "chiffreAffairesMax", + "schema": "string", + "required": false, + "description": "Chiffre d'affaires maximum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 411016400 + }, + { + "name": "resultatMin", + "schema": "string", + "required": false, + "description": "Résultat minimum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 29327000 + }, + { + "name": "resultatMax", + "schema": "string", + "required": false, + "description": "Résultat maximum de l'entreprise.\n\n**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.", + "example": 29327100 + }, + { + "name": "dateCreationMin", + "schema": "string", + "required": false, + "description": "Date de création minimale de l'entreprise, au format JJ-MM-AAAA.", + "example": "15-05-2002" + }, + { + "name": "dateCreationMax", + "schema": "string", + "required": false, + "description": "Date de création maximale de l'entreprise, au format JJ-MM-AAAA.", + "example": "17-05-2002" + }, + { + "name": "trancheEffectifMin", + "schema": "string", + "required": false, + "description": "Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/sirene/public/variable/tefen).\n\n**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur", + "example": 40 + }, + { + "name": "trancheEffectifMax", + "schema": "string", + "required": false, + "description": "Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/sirene/public/variable/tefen).\n\n**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur", + "example": 42 + }, + { + "name": "typeDirigeant", + "schema": "string", + "required": false, + "description": "Type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "physique" + }, + { + "name": "qualiteDirigeant", + "schema": "string", + "required": false, + "description": "Qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Administrateur" + }, + { + "name": "nationaliteDirigeant", + "schema": "string", + "required": false, + "description": "Nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Française" + }, + { + "name": "nomDirigeant", + "schema": "string", + "required": false, + "description": "Nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Yi" + }, + { + "name": "prenomDirigeant", + "schema": "string", + "required": false, + "description": "Prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": "Kenneth H." + }, + { + "name": "ageDirigeantMin", + "schema": "integer", + "required": false, + "description": "Âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": 40 + }, + { + "name": "ageDirigeantMax", + "schema": "integer", + "required": false, + "description": "Âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises).", + "example": 42 + }, + { + "name": "dateDeNaissanceDirigeantMin", + "schema": "string", + "required": false, + "description": "Date de naissance minimale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA.", + "example": "1970-01-01T00:00:00.000Z" + }, + { + "name": "dateDeNaissanceDirigeantMax", + "schema": "string", + "required": false, + "description": "Date de naissance maximale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA.", + "example": "1970-12-31T00:00:00.000Z" + }, + { + "name": "ageBeneficiaireMin", + "schema": "integer", + "required": false, + "description": "Âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises).", + "example": 40 + }, + { + "name": "ageBeneficiaireMax", + "schema": "integer", + "required": false, + "description": "Âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises).", + "example": 42 + }, + { + "name": "dateDeNaissanceBeneficiaireMin", + "schema": "string", + "required": false, + "description": "Date de naissance minimale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA.", + "example": "1970-01-01T00:00:00.000Z" + }, + { + "name": "dateDeNaissanceBeneficiaireMax", + "schema": "string", + "required": false, + "description": "Date de naissance maximale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA.", + "example": "1970-12-31T00:00:00.000Z" + }, + { + "name": "nationaliteBeneficiaire", + "schema": "string", + "required": false, + "description": "Nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises).", + "example": "Française" + }, + { + "name": "dateDepotDocumentMin", + "schema": "string", + "required": false, + "description": "Date de dépôt minimale du document, au format JJ-MM-AAAA.", + "example": "2000-01-01T00:00:00.000Z" + }, + { + "name": "dateDepotDocumentMax", + "schema": "string", + "required": false, + "description": "Date de dépôt maximale du document, au format JJ-MM-AAAA.", + "example": "2000-12-31T00:00:00.000Z" + }, + { + "name": "typePublication", + "schema": "string", + "required": false, + "description": "Type de publication", + "example": "Procédure collective" + }, + { + "name": "datePublicationMin", + "schema": "string", + "required": false, + "description": "Date publication minimale de la publication, au format JJ-MM-AAAA.", + "example": "2000-01-01T00:00:00.000Z" + }, + { + "name": "datePublicationMax", + "schema": "string", + "required": false, + "description": "Date de publication maximale de la publication, au format JJ-MM-AAAA.", + "example": "2000-12-31T00:00:00.000Z" + }, + { + "name": "siren", + "schema": "string", + "required": false, + "description": "SIREN de l'entreprise.", + "example": null + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "404", + "description": "Aucune publication ne correspond aux critères indiqués." + }, + { + "statusCode": "503", + "description": "Service momentanément indisponible." + } + ] + }, + { + "url": "/suggestions", + "method": "searchText", + "httpMethod": "get", + "tag": "Suggestions / Autocomplete", + "typeScriptTag": "suggestionsAutocomplete", + "description": "Recherche les entreprises qui correspondent à un début de recherche textuelle (type autocomplete).", + "parameters": [ + { + "name": "q", + "schema": "string", + "required": true, + "description": "Début de recherche textuelle", + "example": "googl" + }, + { + "name": "longueur", + "schema": "integer", + "required": false, + "description": "Nombre de résultats. Maximum 100. Valeur par défaut : `10`.", + "example": 20 + }, + { + "name": "cibles", + "schema": "string", + "required": false, + "description": "Cibles de la recherche, séparées par des virgules. Valeur par défaut : `\"nom_entreprise\"`.", + "example": "nom_entreprise,siren,siret" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "Paramètres de la requête incorrects." + } + ] + }, + { + "url": "/entreprise/comptes", + "method": "getBySiren", + "httpMethod": "get", + "tag": "Comptes annuels", + "typeScriptTag": "comptesAnnuels", + "description": "Récupère les comptes annuels publiés d'une entreprise.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "siren", + "schema": "string", + "required": false, + "description": "SIREN de l'entreprise", + "example": 443061841 + }, + { + "name": "annee", + "schema": "string", + "required": false, + "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.", + "example": "2016,2017,2018" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "Paramètres de la requête incorrects." + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "404", + "description": "Comptes annuels indisponibles." + }, + { + "statusCode": "503", + "description": "Service momentanément indisponible." + } + ] + }, + { + "url": "/entreprise/cartographie", + "method": "getData", + "httpMethod": "get", + "tag": "Cartographie", + "typeScriptTag": "cartographie", + "description": "Récupère les données permettant d'établir une cartographie d'une entreprise.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "siren", + "schema": "string", + "required": true, + "description": "SIREN de l'entreprise", + "example": 443061841 + }, + { + "name": "inclureEntreprisesDirigees", + "schema": "boolean", + "required": false, + "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": "inclureEntreprisesCitees", + "schema": "boolean", + "required": false, + "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": "inclureSci", + "schema": "boolean", + "required": false, + "description": "Si vrai, la cartographie intègrera les SCI. Valeur par défaut : `true`." + }, + { + "name": "autoriserModifications", + "schema": "boolean", + "required": false, + "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": "rejeterPremierDegre", + "schema": "boolean", + "required": false, + "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": "degre", + "schema": "integer", + "required": false, + "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." + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "Paramètres de la requête incorrects." + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "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é." + } + ] + }, + { + "url": "/document/telechargement", + "method": "downloadDocumentByToken", + "httpMethod": "get", + "tag": "Documents", + "typeScriptTag": "documents", + "description": "Télécharge un document PDF ou XLSX à partir de son token.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "token", + "schema": "string", + "required": true, + "description": "Token du document", + "example": "QTQ0MzA2MTg0MTIwMjAwNDA3RMOpY2lzaW9uKHMpIGRlIGwnYXNzb2Npw6kgdW5pcXVl" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "Paramètres de la requête incorrects." + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "404", + "description": "Document indisponible." + }, + { + "statusCode": "503", + "description": "Service momentanément indisponible." + } + ] + }, + { + "url": "/document/extrait_pappers", + "method": "downloadPappersExtrait", + "httpMethod": "get", + "tag": "Documents", + "typeScriptTag": "documents", + "description": "Télécharge l'extrait Pappers d'une entreprise à partir de son SIREN ou SIRET.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "siren", + "schema": "string", + "required": false, + "description": "SIREN de l'entreprise", + "example": 443061841 + }, + { + "name": "siret", + "schema": "string", + "required": false, + "description": "SIRET de l'entreprise", + "example": 44306184100047 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "Paramètres de la requête incorrects." + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "404", + "description": "Document indisponible." + }, + { + "statusCode": "503", + "description": "Service momentanément indisponible." + } + ] + }, + { + "url": "/document/extrait_inpi", + "method": "getExtraitInpi", + "httpMethod": "get", + "tag": "Documents", + "typeScriptTag": "documents", + "description": "Télécharge l'extrait INPI d'une entreprise à partir de son SIREN ou SIRET.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "siren", + "schema": "string", + "required": false, + "description": "SIREN de l'entreprise", + "example": 443061841 + }, + { + "name": "siret", + "schema": "string", + "required": false, + "description": "SIRET de l'entreprise", + "example": 44306184100047 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "Paramètres de la requête incorrects." + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "404", + "description": "Document indisponible." + }, + { + "statusCode": "503", + "description": "Service momentanément indisponible." + } + ] + }, + { + "url": "/document/avis_situation_insee", + "method": "downloadInseeSituation", + "httpMethod": "get", + "tag": "Documents", + "typeScriptTag": "documents", + "description": "Télécharge l'avis de situation INSEE d'une entreprise à partir de son SIREN ou SIRET.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "siren", + "schema": "string", + "required": false, + "description": "SIREN de l'entreprise", + "example": 443061841 + }, + { + "name": "siret", + "schema": "string", + "required": false, + "description": "SIRET de l'entreprise", + "example": 44306184100047 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "Paramètres de la requête incorrects." + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "404", + "description": "Document indisponible." + }, + { + "statusCode": "503", + "description": "Service momentanément indisponible." + } + ] + }, + { + "url": "/document/statuts", + "method": "telechargementStatuts", + "httpMethod": "get", + "tag": "Documents", + "typeScriptTag": "documents", + "description": "Télécharge les derniers statuts disponibles d'une entreprise à partir de son SIREN ou SIRET.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "siren", + "schema": "string", + "required": false, + "description": "SIREN de l'entreprise", + "example": 443061841 + }, + { + "name": "siret", + "schema": "string", + "required": false, + "description": "SIRET de l'entreprise", + "example": 44306184100047 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "Paramètres de la requête incorrects." + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "404", + "description": "Document indisponible." + }, + { + "statusCode": "503", + "description": "Service momentanément indisponible." + } + ] + }, + { + "url": "/document/declaration_beneficiaires_effectifs", + "method": "telechargementBeneficiairesEffectifs", + "httpMethod": "get", + "tag": "Documents", + "typeScriptTag": "documents", + "description": "Télécharge la déclaration des bénéficiaires effectifs d'une entreprise à partir de son SIREN.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "siren", + "schema": "string", + "required": false, + "description": "SIREN de l'entreprise", + "example": 443061841 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "Paramètres de la requête incorrects." + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "403", + "description": "Vous n'avez pas les droits pour exécuter cette requête." + }, + { + "statusCode": "404", + "description": "Document indisponible." + }, + { + "statusCode": "503", + "description": "Service momentanément indisponible." + } + ] + }, + { + "url": "/document/rapport_solvabilite", + "method": "downloadSolvabilityReport", + "httpMethod": "get", + "tag": "Documents", + "typeScriptTag": "documents", + "description": "Télécharge un Rapport de solvabilité d'une entreprise à partir de son SIREN.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "siren", + "schema": "string", + "required": false, + "description": "SIREN de l'entreprise", + "example": 443061841 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "Paramètres de la requête incorrects." + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "404", + "description": "Document indisponible." + }, + { + "statusCode": "503", + "description": "Service momentanément indisponible." + } + ] + }, + { + "url": "/conformite/personne_physique", + "method": "personnePhysiqueStatusCheck", + "httpMethod": "get", + "tag": "Conformité", + "typeScriptTag": "conformité", + "description": "Vérifie le statut de personne politiquement exposée et la présence de sanctions internationales pour une personne physique.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "nom", + "schema": "string", + "required": true, + "description": "Nom de la personne physique", + "example": "Macron" + }, + { + "name": "prenom", + "schema": "string", + "required": true, + "description": "Prénom de la personne physique", + "example": "Emmanuel" + }, + { + "name": "dateDeNaissance", + "schema": "string", + "required": true, + "description": "Date de naissance de la personne physique, au format AAAA-MM-JJ ou AAAA-MM", + "example": "1977-12-21T00:00:00.000Z" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "Paramètres de la requête incorrects." + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "503", + "description": "Erreur interne. La personne physique n'a pas pu être vérifiée." + } + ] + }, + { + "url": "/suivi-jetons", + "method": "getTokenUsage", + "httpMethod": "get", + "tag": "Suivi utilisation", + "typeScriptTag": "suiviUtilisation", + "description": "Récupère le suivi d'utilisation des jetons.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Suivi d'utilisation des jetons." + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "503", + "description": "Service momentanément indisponible." + } + ] + }, + { + "url": "/liste", + "method": "listDelete", + "httpMethod": "delete", + "tag": "Surveillance", + "typeScriptTag": "surveillance", + "description": "Supprime une (ou plusieurs) notification(https://www.pappers.fr/api/documentation d'une liste.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "idListe", + "schema": "string", + "required": true, + "description": "Identifiant unique de votre liste de surveillance", + "example": "votre_identifiant_ici" + }, + { + "name": "siren", + "schema": "string", + "required": false, + "description": "Liste des sirens des notifications à supprimer, séparés par une virgule", + "example": "443061841,950370973" + }, + { + "name": "id", + "schema": "string", + "required": false, + "description": "Liste des ids des notifications à supprimer, séparés par une virgule", + "example": "ecfca3e5fb1ce07bb3fdfe8760a28df5aa617ed4951b7f61,a67b9de66189ba98eb4aede09f4b2b565b0f18fe694da7bc" + }, + { + "name": "supprimerTotalite", + "schema": "boolean", + "required": false, + "description": "Suppression de toutes les notifications de la liste", + "example": true + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Nombre de notifications supprimées." + }, + { + "statusCode": "400", + "description": "Paramètres de la requête incorrects." + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "404", + "description": "Liste non trouvée." + }, + { + "statusCode": "503", + "description": "Service momentanément indisponible." + } + ] + }, + { + "url": "/liste", + "method": "listeDirigeantsAjout", + "httpMethod": "post", + "tag": "Surveillance", + "typeScriptTag": "surveillance", + "description": "Ajoute un (ou plusieurs) dirigeant(https://www.pappers.fr/api/documentation à une liste de dirigeants.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "idListe", + "schema": "string", + "required": true, + "description": "Identifiant unique de votre liste de surveillance de dirigeants", + "example": "votre_identifiant_ici" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Nombre de notifications ajoutées." + }, + { + "statusCode": "201", + "description": "Nombre de notifications ajoutées." + }, + { + "statusCode": "400", + "description": "Paramètres de la requête incorrects." + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "403", + "description": "Offre dépassée." + }, + { + "statusCode": "404", + "description": "Liste non trouvée." + }, + { + "statusCode": "503", + "description": "Service momentanément indisponible." + } + ] + }, + { + "url": "/liste-informations", + "method": "addNotifications", + "httpMethod": "post", + "tag": "Surveillance", + "typeScriptTag": "surveillance", + "description": "Ajoute des informations à une (ou plusieurs) notification(https://www.pappers.fr/api/documentation.", + "parameters": [ + { + "name": "apiToken", + "schema": "string", + "required": true, + "description": "Clé d'utilisation de l'API", + "example": "votre_clé_ici" + }, + { + "name": "idListe", + "schema": "string", + "required": true, + "description": "Identifiant unique de votre liste de surveillance d'entreprises", + "example": "votre_identifiant_ici" + }, + { + "name": "notifications", + "schema": "array", + "description": "" + }, + { + "name": "informations", + "schema": "string", + "description": "", + "example": "Information quelconque" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Succés." + }, + { + "statusCode": "400", + "description": "Paramètres de la requête incorrects." + }, + { + "statusCode": "401", + "description": "Clé API incorrecte." + }, + { + "statusCode": "404", + "description": "Liste non trouvée." + }, + { + "statusCode": "503", + "description": "Service momentanément indisponible." + } + ] + } + ], + "repositoryDescription": "Avec Pappers, accédez à toute toute l'information légale, juridique financière des sociétés françaises ! Découvrez nos offres : https://www.pappers.fr/api et https://www.pappers.fr/exports. Pappers's {language} SDK generated by Konfig (https://konfigthis.com/).", + "logo": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/pappers/logo.png", + "openApiRaw": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/pappers/openapi.yaml", + "openApiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/pappers/openapi.yaml", + "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/pappers/imagePreview.webp", + "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/pappers/favicon.png", + "clientNameCamelCase": "pappers", + "lastUpdated": "2024-03-28T21:38:28.766Z", + "typescriptSdkUsageCode": "import { Pappers } from 'pappers-typescript-sdk';\n\nconst pappers = new Pappers()", + "typescriptSdkFirstRequestCode": "// Récupère l'ensemble des informations disponibles sur une entreprise.\nconst getInformationResponse = pappers.ficheEntreprise.getInformation({\n apiToken: \"votre_clé_ici\"\n siren: 443061841\n siret: 44306184100047\n formatPublicationsBodacc: \"objet\"\n champsSupplementaires: \"site_internet,telephone\"\n})", + "fixedSpecFileName": "pappers-fixed-spec.yaml" +} \ No newline at end of file diff --git a/sdks/db/published/from-custom-request_peachpayments.com.json b/sdks/db/published/from-custom-request_peachpayments.com.json index b4486b5a6d..7504703be8 100644 --- a/sdks/db/published/from-custom-request_peachpayments.com.json +++ b/sdks/db/published/from-custom-request_peachpayments.com.json @@ -22,7 +22,7 @@ }, "customRequestSpecFilename": "peachpayments.com.yaml", "difficultyScore": 114.75, - "difficulty": "Medium", + "difficulty": "Easy", "company": "Peach Payments", "sdkName": "peach-payments-{language}-sdk", "clientName": "PeachPayments", @@ -2113,7 +2113,7 @@ "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/peach-payments/imagePreview.png", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/peach-payments/favicon.png", "clientNameCamelCase": "peachPayments", - "lastUpdated": "2024-03-28T20:41:27.489Z", + "lastUpdated": "2024-03-28T21:38:28.766Z", "typescriptSdkUsageCode": "import { PeachPayments } from 'peach-payments-typescript-sdk';\n\nconst peachPayments = new PeachPayments({\n // Merchant-level authentication (https://developer.peachpayments.com/docs/checkout-js-authentication).\n bearerAuth: \"BEARER_AUTH\"\n})", "typescriptSdkFirstRequestCode": "// Initiate redirect-based Checkout\nconst initiateRedirectCheckoutResponse = peachPayments.checkoutGeneration.initiateRedirectCheckout({\n referer: \"https://mydemostore.com\"\n authentication.entityId: \"8ac7a4ca68c22c4d0168c2caab2e0025\"\n signature: \"a668342244a9c77b08a2f9090d033d6e2610b431a5c0ca975f32035ed06164f4\"\n merchantTransactionId: \"OrderNo453432\"\n amount: 1010.22\n paymentType: \"DB\"\n currency: \"ZAR\"\n nonce: \"UNQ00012345678\"\n shopperResultUrl: \"https://mydemostore.com/OrderNo453432\"\n defaultPaymentMethod: \"CARD\"\n forceDefaultMethod: \"false\"\n merchantInvoiceId: \"INV-0001\"\n cancelUrl: \"https://mydemostore.com/OrderNo453432/cancelled\"\n notificationUrl: \"https://mydemostore.com/OrderNo453432/webhook\"\n customParameters[name]: \"name: Name1 value: Value1\"\n customer.merchantCustomerId: 971020\n customer.givenName: \"John\"\n customer.surname: \"Smith\"\n customer.mobile: 27123456789\n customer.email: \"johnsmith@mail.com\"\n customer.status: \"EXISTING\"\n customer.birthDate: \"1970-02-17\"\n customer.ip: \"192.168.1.1\"\n customer.phone: 27123456789\n customer.idNumber: 9001010000084\n billing.street1: \"1 Example Road\"\n billing.street2: \"LocalityA\"\n billing.city: \"Cape Town\"\n billing.company: \"CompanyA\"\n billing.country: \"ZA\"\n billing.state: \"Western Cape\"\n billing.postcode: 1234\n shipping.street1: \"1 Example Road\"\n shipping.street2: \"LocalityA\"\n shipping.city: \"Cape Town\"\n shipping.company: \"CompanyA\"\n shipping.postcode: 1234\n shipping.country: \"ZA\"\n shipping.state: \"Western Cape\"\n cart.tax: \"15.00\"\n cart.shippingAmount: \"12.25\"\n cart.discount: \"02.25\"\n createRegistration: \"false\"\n originator: \"Webstore\"\n})", "fixedSpecFileName": "peach-payments-fixed-spec.yaml" diff --git a/sdks/db/spec-data/from-custom-request_pappers.fr.json b/sdks/db/spec-data/from-custom-request_pappers.fr.json new file mode 100644 index 0000000000..6799e1d97e --- /dev/null +++ b/sdks/db/spec-data/from-custom-request_pappers.fr.json @@ -0,0 +1,19 @@ +{ + "securitySchemes": {}, + "apiBaseUrl": "https://api.pappers.fr/v2", + "apiVersion": "2.13.0", + "apiDescription": "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.\n\nVous devez indiquer votre clé d'API dans les requêtes, en utilisant le paramètre `api_token`.\n\nL'URL d'accès à l'API est https://api.pappers.fr/v2/\n\nLien vers la documentation de la V1 : https://www.pappers.fr/api/documentation/v1\n\nLien vers la documentation de la V3 : https://www.pappers.fr/api/documentation/v3\n\nLien vers la documentation de l'API internationale : https://www.pappers.in/api/documentation\n\nL'historique des modifications (changelog) est accessible à l'url suivante : https://www.pappers.fr/api/changelog\n", + "apiTitle": "Pappers API", + "endpoints": 22, + "sdkMethods": 23, + "schemas": 32, + "parameters": 306, + "contactEmail": "support@pappers.fr", + "originalCustomRequest": { + "type": "GET", + "url": "https://www.pappers.fr/api_v2.yaml?20231125" + }, + "customRequestSpecFilename": "pappers.fr.yaml", + "difficultyScore": 115.5, + "difficulty": "Medium" +} \ No newline at end of file diff --git a/sdks/db/spec-data/from-custom-request_peachpayments.com.json b/sdks/db/spec-data/from-custom-request_peachpayments.com.json index f9fced5623..31fda3b474 100644 --- a/sdks/db/spec-data/from-custom-request_peachpayments.com.json +++ b/sdks/db/spec-data/from-custom-request_peachpayments.com.json @@ -22,5 +22,5 @@ }, "customRequestSpecFilename": "peachpayments.com.yaml", "difficultyScore": 114.75, - "difficulty": "Medium" + "difficulty": "Easy" } \ No newline at end of file diff --git a/sdks/publish.yaml b/sdks/publish.yaml index 4b38d20b18..eca58e61ee 100644 --- a/sdks/publish.yaml +++ b/sdks/publish.yaml @@ -6687,3 +6687,22 @@ publish: serviceName: Journeys Track sdkName: customer-io-journeys-track-{language}-sdk clientName: CustomerIoJourneysTrack + from-custom-request_pappers.fr: + homepage: www.pappers.fr/ + company: Pappers + developerDocumentation: www.pappers.fr/api/documentation + apiStatusUrls: inherit + metaDescription: >- + Avec Pappers, accédez à toute toute l'information légale, juridique + financière des sociétés françaises ! + + Découvrez nos offres : https://www.pappers.fr/api et + https://www.pappers.fr/exports + categories: + - finance + - legal + - legaltech + - data + serviceName: false + sdkName: pappers-{language}-sdk + clientName: Pappers diff --git a/sdks/src/collect-from-custom-requests.ts b/sdks/src/collect-from-custom-requests.ts index 374d7698ce..ccc167094a 100644 --- a/sdks/src/collect-from-custom-requests.ts +++ b/sdks/src/collect-from-custom-requests.ts @@ -2186,7 +2186,11 @@ const customRequests: Record = { "bulksms.com": { type: "GET", url: "https://www.bulksms.com/developer/json/v1/swagger.yaml?v=9" - } + }, + "pappers.fr": { + type: "GET", + url: "https://www.pappers.fr/api_v2.yaml?20231125", + }, }; async function downloadOpenApiSpecFromMintlify({ @@ -2518,7 +2522,7 @@ async function processCustomRequest({ if ( lastFetched !== undefined && process.env.FILTER_CUSTOM === undefined && - lastFetched > new Date(Date.now() - 1000 * 60 * 60 * 24) + lastFetched > new Date(Date.now() - 1000 * 60 * 60 * 24 * 7) ) { console.log(`Skip fetching ${key} due to last fetched being recent`); const cachedProcessedCustomRequest = getCachedProcessedCustomRequest({