{ "openapi" : "3.1.0", "components" : { "schemas" : { "ActivityCodeValue" : { "type" : "object", "properties" : { "value" : { "type" : "string" }, "included" : { "type" : "boolean", "examples" : [ true ], "description" : "The value must be included if TRUE and excluded if FALSE." } } }, "ActivityCodesFilter" : { "type" : "object", "description" : "company activity code search filter", "properties" : { "scope" : { "$ref" : "#/components/schemas/Scope" }, "values" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivityCodeValue" } } } }, "ActivityKeywordsFilter" : { "type" : "object", "description" : "keyword search filter based on company activity", "properties" : { "matchWithAnyKeywords" : { "type" : "array", "items" : { "type" : "string" } } } }, "AdministrativeArea1" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "label" : { "type" : "string" }, "children" : { "type" : "array", "items" : { "type" : "string" } } } }, "AdministrativeArea1Filter" : { "type" : "object", "description" : "location filter based on administrative areas 1. In France, corresponds to the geographical region", "properties" : { "values" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AdministrativeArea1Value" } } } }, "AdministrativeArea1Value" : { "type" : "object", "properties" : { "included" : { "type" : "boolean", "examples" : [ true ], "description" : "The value must be included if TRUE and excluded if FALSE." }, "value" : { "type" : "string", "examples" : [ "11" ], "description" : "Administrative areas 1 code. In France, corresponds to the geographical region code" } } }, "AdministrativeArea2" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "label" : { "type" : "string" }, "administrativeArea1" : { "$ref" : "#/components/schemas/AdministrativeArea1" } } }, "AdministrativeArea2Filter" : { "type" : "object", "description" : "location filter based on administrative areas 2. In France, corresponds to the geographical department", "properties" : { "values" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AdministrativeArea2Value" } } } }, "AdministrativeArea2Value" : { "type" : "object", "properties" : { "included" : { "type" : "boolean", "examples" : [ true ], "description" : "The value must be included if TRUE and excluded if FALSE." }, "value" : { "type" : "string", "examples" : [ "92" ], "description" : "Administrative areas 2 code. In France, corresponds to the geographical department code" } } }, "AffiliatedBusinessTriggerSignal" : { "type" : "object", "properties" : { "id" : { "type" : "string", "examples" : [ "8.3:542051180:2026_7" ], "description" : "business trigger signal id" }, "btId" : { "type" : "string", "examples" : [ "frey-8.3-bag:fr-482755741:fr-508965993-2026-03-fr-482755741:acquiring" ], "description" : "business trigger signal internal id" }, "publishedDate" : { "type" : "string", "examples" : [ "2026-02-09" ], "description" : "Date of publication of the business trigger signal" }, "subCategoryId" : { "type" : "string", "examples" : [ "8.3" ], "description" : "the business trigger signal sub category id" }, "company" : { "$ref" : "#/components/schemas/Company" }, "content" : { "$ref" : "#/components/schemas/AffiliatedBusinessTriggerSignalContent" } } }, "AffiliatedBusinessTriggerSignalContent" : { "type" : "object", "description" : "Affiliated business trigger signal content", "properties" : { "url" : { "type" : "string", "examples" : [ "https://www.riskassur-hebdo.com/actu01/actu_auto.php?adr=1201261129" ], "description" : "business triggers signal url. The URL is returned only if the source is web." }, "description" : { "type" : "string", "examples" : [ "https://www.riskassur-hebdo.com/actu01/actu_auto.php?adr=1201261129" ], "description" : "business triggers signal description." }, "headline" : { "type" : "string", "examples" : [ "Ellisphere consolide son organisation en integrant Infotrade Sparklane" ], "description" : "business triggers signal headline." }, "text" : { "type" : "string", "examples" : [ "Le groupe Ellisphere franchit une nouvelle étape dans la structuration de son modèle en annonçant l'absorption, à compter du 1er janvier 2026, de sa filiale Infotrade, connue sous la marque Sparklane..." ], "description" : "business triggers signal text." }, "source" : { "type" : "string", "examples" : [ "web" ], "description" : "business triggers signal source." }, "attributes" : { "type" : "object", "examples" : [ { "techno_name" : "Matomo", "techno_vendor" : "Matomo", "techno_category" : "System Analytics & Monitoring" } ], "additionalProperties" : { }, "description" : "business triggers signal attributes. Check the reference endpoint to see the list of eligible attributes for a subcategory of business trigger signals." }, "news" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/News" }, "description" : "List of news items associated with business signals. There may be more news items from different sources covering the same topic. Used mainly for web sources.." }, "administrativeArea2" : { "type" : "array", "examples" : [ [ 92 ] ], "items" : { "type" : "string" }, "description" : "County codes associated with business trigger signals" } } }, "Attribute" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "label" : { "type" : "string" }, "type" : { "type" : "string" }, "isEnum" : { "type" : "boolean" }, "allowedValues" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ValueLabel" } }, "isGlobal" : { "type" : "boolean" } } }, "BusinessTrigger" : { "type" : "object", "properties" : { "key" : { "type" : "string" }, "url" : { "type" : "string" }, "description" : { "type" : "string" }, "headline" : { "type" : "string" }, "text" : { "type" : "string" }, "publishedDate" : { "$ref" : "#/components/schemas/Date" }, "companies" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MentionedCompany" } } } }, "BusinessTriggerPeriod" : { "type" : "string", "enum" : [ "NOW_MINUS_THREE_MONTHS", "NOW_MINUS_SIX_MONTHS", "NOW_MINUS_NINE_MONTHS", "NOW_MINUS_TWELVE_MONTHS", "NOW_MINUS_TWENTY_FOUR_MONTHS" ] }, "BusinessTriggerReferenceType" : { "type" : "string", "enum" : [ "CATEGORIES", "ATTRIBUTES", "COUNTRIES" ] }, "BusinessTriggerSignal" : { "type" : "object", "properties" : { "id" : { "type" : "string", "examples" : [ "8.3:542051180:2026_7" ], "description" : "business trigger signal id" }, "btId" : { "type" : "string", "examples" : [ "frey-8.3-bag:fr-482755741:fr-508965993-2026-03-fr-482755741:acquiring" ], "description" : "business trigger signal internal id" }, "publishedDate" : { "type" : "string", "examples" : [ "2026-02-09" ], "description" : "Date of publication of the business trigger signal" }, "subCategoryId" : { "type" : "string", "examples" : [ "8.3" ], "description" : "the business trigger signal sub category id" }, "company" : { "$ref" : "#/components/schemas/Company" }, "content" : { "$ref" : "#/components/schemas/BusinessTriggerSignalContent" } } }, "BusinessTriggerSignalContent" : { "type" : "object", "description" : "Business trigger signal content", "properties" : { "url" : { "type" : "string", "examples" : [ "https://www.riskassur-hebdo.com/actu01/actu_auto.php?adr=1201261129" ], "description" : "business triggers signal url. The URL is returned only if the source is web." }, "description" : { "type" : "string", "examples" : [ "https://www.riskassur-hebdo.com/actu01/actu_auto.php?adr=1201261129" ], "description" : "business triggers signal description." }, "headline" : { "type" : "string", "examples" : [ "Ellisphere consolide son organisation en integrant Infotrade Sparklane" ], "description" : "business triggers signal headline." }, "text" : { "type" : "string", "examples" : [ "Le groupe Ellisphere franchit une nouvelle étape dans la structuration de son modèle en annonçant l'absorption, à compter du 1er janvier 2026, de sa filiale Infotrade, connue sous la marque Sparklane..." ], "description" : "business triggers signal text." }, "source" : { "type" : "string", "examples" : [ "web" ], "description" : "business triggers signal source." }, "attributes" : { "type" : "object", "examples" : [ { "techno_name" : "Matomo", "techno_vendor" : "Matomo", "techno_category" : "System Analytics & Monitoring" } ], "additionalProperties" : { }, "description" : "business triggers signal attributes. Check the reference endpoint to see the list of eligible attributes for a subcategory of business trigger signals." }, "news" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/News" }, "description" : "List of news items associated with business signals. There may be more news items from different sources covering the same topic. Used mainly for web sources.." }, "administrativeArea2" : { "type" : "array", "examples" : [ [ 92 ] ], "items" : { "type" : "string" }, "description" : "County codes associated with business trigger signals" }, "affiliatedBusinessTriggerSignals" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AffiliatedBusinessTriggerSignal" }, "description" : "List of business trigger signals affiliated with the main business signal.." } } }, "BusinessTriggerSignalReferences" : { "type" : "object", "properties" : { "categories" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Category" }, "description" : "the categories of business trigger signals available" }, "availableCountries" : { "type" : "array", "items" : { "type" : "string" }, "description" : "available countries" }, "attributes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Attribute" }, "description" : "list of all available attributes. You can see the accepted attributes in each business trigger signal subcategory." } } }, "BusinessTriggerSignalsFilters" : { "type" : "object", "description" : "filters for searching for business trigger signals", "properties" : { "companyIdsFilter" : { "$ref" : "#/components/schemas/CompanyIdsFilter", "type" : "object", "description" : "filters by company ids" }, "categoryFilters" : { "type" : "array", "examples" : [ [ "2.1" ] ], "uniqueItems" : true, "items" : { "$ref" : "#/components/schemas/CategoryFilter" }, "description" : "filter by business trigger signal subcategories, keywords... Check the reference endpoint to see the list of available subcategories." }, "sources" : { "type" : "array", "examples" : [ [ "WEB" ] ], "uniqueItems" : true, "items" : { "$ref" : "#/components/schemas/BusinessTriggerSource" }, "description" : "filter by business trigger signal source." }, "period" : { "$ref" : "#/components/schemas/Period" } } }, "BusinessTriggerSource" : { "type" : "string", "enum" : [ "INTERNAL", "WEB", "LEGAL" ] }, "Category" : { "type" : "object", "properties" : { "id" : { "type" : "string", "examples" : [ "1" ], "description" : "business trigger signal category identifier" }, "labels" : { "type" : "object", "examples" : [ { "fr" : "Innovation" } ], "additionalProperties" : { "type" : "string" }, "description" : "business trigger signal category labels" }, "subCategories" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubCategory" }, "description" : "lists of subcategories related to the business signal trigger category" } } }, "Category1" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "label" : { "type" : "string" }, "subCategories" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubCategory1" } } } }, "CategoryFilter" : { "type" : "object", "properties" : { "subCategoryId" : { "type" : "string", "examples" : [ "2.1" ], "description" : "filter by business trigger signal subcategory. Check the reference endpoint to see the list of available subcategories." }, "matchWithAllKeywords" : { "type" : "array", "examples" : [ [ "datascience", "scoring" ] ], "uniqueItems" : true, "items" : { "type" : "string" }, "description" : "filter by keywords. All keywords must be present in the content of the business trigger." }, "matchWithAnyKeywords" : { "type" : "array", "examples" : [ [ "datascience", "scoring" ] ], "uniqueItems" : true, "items" : { "type" : "string" }, "description" : "filter by keywords. At least one of the keywords must be present in the content of the business trigger." } } }, "CompaniesListWorkflowCategory" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "enabled" : { "type" : "boolean", "writeOnly" : true }, "forbiddenMoveToCategories" : { "type" : "array", "items" : { "type" : "string" } }, "labels" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "CompaniesSearchRequest" : { "type" : "object", "properties" : { "searchTermFilter" : { "$ref" : "#/components/schemas/CompanySearchTermFilter", "type" : "object", "description" : "Search filter by term. Use to search for companies that match the term entered." }, "targetFilters" : { "$ref" : "#/components/schemas/TargetFilters", "type" : "object", "description" : "Multiple company search filters. Allows you to target companies based on various criteria." }, "country" : { "$ref" : "#/components/schemas/CompanyCountry", "type" : "string", "description" : "the country used for searching for companies" }, "pageNumber" : { "type" : "integer", "format" : "int32", "examples" : [ 2 ], "description" : "page number you want to retrieve. Use for pagination. Can be null for the first call." }, "onlyCount" : { "type" : "boolean", "examples" : [ true ], "description" : "allows you to countCompanies the number of companies without returning the details. This parameter can be used to estimate the maximum number of results." } } }, "Company" : { "type" : "object", "description" : "Company associated with the business trigger signal", "properties" : { "companyNumber" : { "type" : "string", "examples" : [ "508965993" ], "description" : "Company number (In France corresponds to the SIREN number)" }, "companyName" : { "type" : "string", "examples" : [ "ELLISPHERE" ], "description" : "Company name" } } }, "Company1" : { "type" : "object", "properties" : { "uniqueId" : { "type" : "string" }, "name" : { "type" : "string" }, "companyNumber" : { "type" : "string" }, "establishmentNumber" : { "type" : "string" }, "zip" : { "type" : "string" }, "town" : { "type" : "string" }, "address" : { "type" : "string" }, "activityId" : { "type" : "string" }, "activityLabel" : { "type" : "string" }, "needScore" : { "type" : "number", "format" : "double" }, "fitScore" : { "type" : "number", "format" : "double" }, "country" : { "type" : "string" }, "countryISO" : { "type" : "string" }, "category" : { "type" : "string" }, "reminderDate" : { "$ref" : "#/components/schemas/ZonedDateTime" } } }, "CompanyCountry" : { "type" : "string", "enum" : [ "fr", "de", "uk", "nl", "it", "es", "be" ] }, "CompanyCountry1" : { "type" : "string", "enum" : [ "fr", "de", "uk", "nl", "it", "es", "be" ] }, "CompanyDetail" : { "type" : "object", "properties" : { "uniqueId" : { "type" : "string" }, "compNumber" : { "type" : "string" }, "estNumber" : { "type" : "string" }, "head" : { "type" : "boolean" }, "name" : { "type" : "string" }, "zip" : { "type" : "string" }, "town" : { "type" : "string" }, "townCode" : { "type" : "string" }, "address" : { "type" : "string" }, "address1" : { "type" : "string" }, "address2" : { "type" : "string" }, "address3" : { "type" : "string" }, "address4" : { "type" : "string" }, "activityId" : { "type" : "string" }, "activityLabel" : { "type" : "string" }, "administrativeArea1Id" : { "type" : "string" }, "administrativeArea1Label" : { "type" : "string" }, "administrativeArea2Id" : { "type" : "string" }, "administrativeArea2Label" : { "type" : "string" }, "capital" : { "type" : "integer", "format" : "int64" }, "consolidatedEmployeeNumber" : { "type" : "integer", "format" : "int64" }, "consolidatedTurnover" : { "type" : "integer", "format" : "int64" }, "country" : { "type" : "string" }, "currency" : { "type" : "string" }, "employeeNumber" : { "type" : "integer", "format" : "int64" }, "establishmentCount" : { "type" : "integer", "format" : "int64" }, "estEmployeeNumber" : { "type" : "integer", "format" : "int64" }, "financialScore" : { "type" : "string" }, "foreignShareholder" : { "type" : "integer", "format" : "int32" }, "foreignSubsidiary" : { "type" : "integer", "format" : "int32" }, "isTopParent" : { "type" : "boolean" }, "longitude" : { "type" : "number", "format" : "double" }, "latitude" : { "type" : "number", "format" : "double" }, "legalFormGroupId" : { "type" : "string" }, "legalFormGroupLabel" : { "type" : "string" }, "legalFormId" : { "type" : "string" }, "legalFormLabel" : { "type" : "string" }, "nic" : { "type" : "string" }, "phone" : { "type" : "string" }, "phoneHead" : { "type" : "string" }, "registrationDate" : { "$ref" : "#/components/schemas/Date" }, "turnover" : { "type" : "integer", "format" : "int64" }, "turnoverDate" : { "$ref" : "#/components/schemas/Date" }, "ultimateHeadCompNumber" : { "type" : "string" }, "ultimateHeadName" : { "type" : "string" }, "vatNumber" : { "type" : "string" }, "urlLinkedIn" : { "type" : "string" }, "urlWebsite" : { "type" : "string" }, "primaryDomain" : { "type" : "string" }, "linkedinSearchContactUrl" : { "type" : "string" } } }, "CompanyId" : { "type" : "object", "properties" : { "value" : { "type" : "string" }, "included" : { "type" : "boolean", "examples" : [ true ], "description" : "The value must be included if TRUE and excluded if FALSE." } } }, "CompanyIdFilter" : { "type" : "object", "description" : "search filter based on company identifiers", "properties" : { "companyIdType" : { "$ref" : "#/components/schemas/CompanyIdType" }, "values" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CompanyId" } } } }, "CompanyIdType" : { "type" : "string", "enum" : [ "COMPANY_NUMBER", "ESTABLISHMENT_NUMBER" ], "description" : "Company identifier type. The type is associated with the id defined in the companyId field. Allows you to filter contacts for a company.\n\nCOMPANY_NUMBER: This is the SIREN number for France.\n\nESTABLISHMENT_NUMBER: This is the SIRET number for France.\n" }, "CompanyIdType1" : { "type" : "string", "enum" : [ "COMPANY_NUMBER", "ESTABLISHMENT_NUMBER" ], "description" : "Company identifier type. The type is associated with the id defined in the companyId field. Allows you to filter contacts for a company.
COMPANY_NUMBER : This is the SIREN number for France.
ESTABLISHMENT_NUMBER. This is the SIRET number for France." }, "CompanyIdType2" : { "type" : "string", "enum" : [ "COMPANY_NUMBER", "ESTABLISHMENT_NUMBER" ] }, "CompanyIdType3" : { "type" : "string", "enum" : [ "COMPANY_NUMBER", "ESTABLISHMENT_NUMBER" ] }, "CompanyIdsFilter" : { "type" : "object", "properties" : { "companyIds" : { "type" : "array", "examples" : [ [ 508965993 ] ], "uniqueItems" : true, "items" : { "type" : "string" }, "description" : "Desired company identifiers. The identifier is associated with the type defined in the companyIdType field. Allows you to filter contacts for a company." }, "companyIdType" : { "$ref" : "#/components/schemas/CompanyIdType" } } }, "CompanyList" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "userId" : { "type" : "integer", "format" : "int64" }, "clientId" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "datasource" : { "$ref" : "#/components/schemas/Datasource" } } }, "CompanyScoringModelFilters" : { "type" : "object", "required" : [ "companyScoringModelId" ], "description" : "filter to search for business trigger signal using the configuration of a company scoring model", "properties" : { "companyScoringModelId" : { "type" : "integer", "format" : "int64", "examples" : [ 1 ], "description" : "company scoring model id. See companies scoring model endpoints to retrieve id" }, "companyIdsFilter" : { "$ref" : "#/components/schemas/CompanyIdsFilter", "type" : "object", "description" : "filters by company ids" }, "period" : { "$ref" : "#/components/schemas/Period", "type" : "object", "description" : "filters by period. This will automatically overload the period defined in all business signals in the company scoring model." } } }, "CompanySearchFilters" : { "type" : "object", "properties" : { "categories" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "CompanySearchParams" : { "type" : "object", "required" : [ "filters" ], "properties" : { "filters" : { "$ref" : "#/components/schemas/CompanySearchFilters" }, "pageSize" : { "type" : "integer", "format" : "int32", "maximum" : 100, "minimum" : 1 }, "pageId" : { "type" : "integer", "format" : "int32" } } }, "CompanySearchResult" : { "type" : "object", "properties" : { "companies" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Company1" } }, "count" : { "type" : "integer", "format" : "int32" }, "pageSize" : { "type" : "integer", "format" : "int32" }, "nextPageId" : { "type" : "integer", "format" : "int32" } } }, "CompanySearchTermFilter" : { "type" : "object", "properties" : { "term" : { "type" : "string", "examples" : [ "ellisph" ], "description" : "name of the company you are searching for" }, "headOnly" : { "type" : "boolean", "examples" : [ true ], "description" : "allows you to retrieve only headquarters in search results" } } }, "CompanyToScore" : { "type" : "object", "required" : [ "companyId", "companyIdType" ], "properties" : { "companyId" : { "type" : "string", "minLength" : 1 }, "companyIdType" : { "$ref" : "#/components/schemas/CompanyIdType3" } } }, "ContactCountryReference" : { "type" : "object", "properties" : { "datasource" : { "$ref" : "#/components/schemas/Datasource" }, "titles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ContactTitle" } }, "ranks" : { "type" : "array", "deprecated" : true, "items" : { "$ref" : "#/components/schemas/JobTitleRank" } }, "services" : { "type" : "array", "deprecated" : true, "items" : { "$ref" : "#/components/schemas/JobTitleService" } }, "subservices" : { "type" : "array", "deprecated" : true, "items" : { "$ref" : "#/components/schemas/JobTitleSubService" } }, "functions" : { "type" : "array", "deprecated" : true, "items" : { "$ref" : "#/components/schemas/OldJobTitleFunction" } }, "jobClassificationReferences" : { "$ref" : "#/components/schemas/JobClassificationReferences" }, "administrativeAreas1" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AdministrativeArea1" } }, "administrativeAreas2" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AdministrativeArea2" } }, "country" : { "$ref" : "#/components/schemas/CompanyCountry1" }, "countryLabel" : { "type" : "string" }, "countryISOLabel" : { "type" : "string" } } }, "ContactKeyType" : { "type" : "string", "enum" : [ "DATALAKE_CONTACT_ID", "ENRICHED_CONTACT_ID", "CONTACT_G_KEY" ] }, "ContactReferencesTypes" : { "type" : "string", "enum" : [ "TITLES", "LOCATION_ADMINISTRATIVE_AREA1", "LOCATION_ADMINISTRATIVE_AREA2", "JOB_CLASSIFICATIONS_RANKS", "JOB_CLASSIFICATIONS_DEPARTMENTS", "JOB_CLASSIFICATIONS_SUBDEPARTMENTS", "JOB_CLASSIFICATIONS_FUNCTIONS", "OLD_JOB_CLASSIFICATIONS_RANKS", "OLD_JOB_CLASSIFICATIONS_SERVICES", "OLD_JOB_CLASSIFICATIONS_SUBSERVICES", "OLD_JOB_CLASSIFICATIONS_FUNCTIONS" ] }, "ContactTitle" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "label" : { "type" : "string" }, "longLabel" : { "type" : "string" } } }, "CreditBalance" : { "type" : "object", "properties" : { "creditType" : { "$ref" : "#/components/schemas/CreditType" }, "remaining" : { "type" : "number", "format" : "double" }, "used" : { "type" : "number", "format" : "double" }, "renewDate" : { "$ref" : "#/components/schemas/LocalDate" } } }, "CreditType" : { "type" : "string", "enum" : [ "EMAIL_AND_MOBILE_PHONE", "EMAIL", "MOBILE_PHONE" ] }, "DatalakeContact" : { "type" : "object", "properties" : { "contactGKey" : { "type" : "string" }, "contactCompanyKey" : { "type" : "string" }, "compNumber" : { "type" : "string" }, "salutation" : { "type" : "string" }, "firstname" : { "type" : "string" }, "lastname" : { "type" : "string" }, "jobTitleDetails" : { "$ref" : "#/components/schemas/JobTitleDetailsDTO" }, "linkedinUrl" : { "type" : "string" }, "linkedinId" : { "type" : "string" }, "legal" : { "type" : "boolean" }, "enriched" : { "type" : "boolean" }, "enrichedContactId" : { "type" : "integer", "format" : "int64" }, "canEnrichEmail" : { "type" : "boolean" }, "canEnrichPhone" : { "type" : "boolean" }, "emailEnrichmentInProgress" : { "type" : "boolean" }, "phoneEnrichmentInProgress" : { "type" : "boolean" }, "optout" : { "type" : "boolean" }, "unsubscribedDate" : { "$ref" : "#/components/schemas/ZonedDateTime" }, "id" : { "type" : "string", "deprecated" : true }, "rank" : { "type" : "integer", "deprecated" : true, "format" : "int32" }, "rankLabel" : { "type" : "string", "deprecated" : true }, "serviceReference" : { "type" : "string", "deprecated" : true }, "serviceReferenceLabel" : { "type" : "string", "deprecated" : true }, "subserviceReference" : { "type" : "string", "deprecated" : true }, "subserviceReferenceLabel" : { "type" : "string", "deprecated" : true }, "functionReference" : { "type" : "string" }, "functionReferenceLabel" : { "type" : "string", "deprecated" : true }, "functionLabel" : { "type" : "string", "deprecated" : true } } }, "Datasource" : { "type" : "string", "enum" : [ "FR", "UK", "BE", "DE", "NL", "ES", "IT" ] }, "Date" : { "type" : "string", "format" : "date", "examples" : [ "2022-03-10" ] }, "DeprecatedEnrichedCompanyContacts" : { "type" : "object", "deprecated" : true, "properties" : { "companyNumber" : { "type" : "string" }, "linkedinSearchContactUrl" : { "type" : "string" }, "enrichedContacts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeprecatedEnrichedContact" } } } }, "DeprecatedEnrichedContact" : { "type" : "object", "deprecated" : true, "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "companyNumber" : { "type" : "string" }, "companyUniqueId" : { "type" : "string" }, "salutation" : { "type" : "string" }, "firstname" : { "type" : "string" }, "lastname" : { "type" : "string" }, "email" : { "type" : "string" }, "phone" : { "type" : "string" }, "availableEmails" : { "type" : "array", "items" : { "type" : "string" } }, "availablePhones" : { "type" : "array", "items" : { "type" : "string" } }, "rank" : { "type" : "integer", "format" : "int32" }, "service" : { "type" : "string" }, "subService" : { "type" : "string" }, "functionLabel" : { "type" : "string" }, "linkedinUrl" : { "type" : "string" }, "linkedinId" : { "type" : "string" }, "legal" : { "type" : "boolean" }, "datalakeContactId" : { "type" : "integer", "format" : "int64" }, "optout" : { "type" : "boolean" } } }, "EmployeeNumberFilter" : { "type" : "object", "description" : "employee number filter", "properties" : { "min" : { "type" : "integer", "format" : "int64" }, "includeLower" : { "type" : "boolean" }, "max" : { "type" : "integer", "format" : "int64" }, "includeUpper" : { "type" : "boolean" }, "includeNullValue" : { "type" : "boolean" }, "scope" : { "$ref" : "#/components/schemas/Scope1" } } }, "EnrichedContact" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "contactCompanyKey" : { "type" : "string" }, "contactGKey" : { "type" : "string" }, "companyNumber" : { "type" : "string" }, "companyUniqueId" : { "type" : "string" }, "salutation" : { "type" : "string" }, "firstname" : { "type" : "string" }, "lastname" : { "type" : "string" }, "email" : { "type" : "string" }, "phone" : { "type" : "string" }, "availableEmails" : { "type" : "array", "items" : { "type" : "string" } }, "availablePhones" : { "type" : "array", "items" : { "type" : "string" } }, "linkedinUrl" : { "type" : "string" }, "linkedinId" : { "type" : "string" }, "legal" : { "type" : "boolean" }, "optout" : { "type" : "boolean" }, "unsubscribedDate" : { "$ref" : "#/components/schemas/ZonedDateTime" }, "canEnrichEmail" : { "type" : "boolean" }, "canEnrichPhone" : { "type" : "boolean" }, "emailEnrichmentInProgress" : { "type" : "boolean" }, "phoneEnrichmentInProgress" : { "type" : "boolean" }, "genericContact" : { "type" : "boolean" }, "jobTitleDetails" : { "$ref" : "#/components/schemas/JobTitleDetailsDTO" }, "datasource" : { "type" : "string" }, "createdAt" : { "$ref" : "#/components/schemas/ZonedDateTime" }, "datalakeContactId" : { "type" : "integer", "deprecated" : true, "format" : "int64" }, "rank" : { "type" : "integer", "deprecated" : true, "format" : "int32" }, "rankLabel" : { "type" : "string", "deprecated" : true }, "serviceReference" : { "type" : "string", "deprecated" : true }, "serviceReferenceLabel" : { "type" : "string", "deprecated" : true }, "subserviceReference" : { "type" : "string", "deprecated" : true }, "subserviceReferenceLabel" : { "type" : "string", "deprecated" : true }, "functionReference" : { "type" : "string", "deprecated" : true }, "functionReferenceLabel" : { "type" : "string", "deprecated" : true }, "functionLabel" : { "type" : "string", "deprecated" : true } } }, "EnrichmentCreditType" : { "type" : "string", "enum" : [ "EMAIL", "EMAIL_AND_MOBILE_PHONE", "MOBILE_PHONE" ] }, "EnrichmentRequestParameters" : { "type" : "object", "properties" : { "contactKeyType" : { "$ref" : "#/components/schemas/ContactKeyType" }, "contactKey" : { "type" : "string" }, "contactCountry" : { "type" : "string" }, "enrichmentCreditType" : { "$ref" : "#/components/schemas/EnrichmentCreditType" } } }, "ExplainField" : { "type" : "object", "description" : "field present in the company that matches the term sent", "properties" : { "fieldName" : { "type" : "string", "examples" : [ "le_alias" ], "description" : "field name present in the company that matches the term sent" }, "fieldValue" : { "type" : "string", "examples" : [ "ellisphere" ], "description" : "field value present in the company that matches the term sent" } } }, "FitScorePolarity" : { "type" : "object", "properties" : { "positive" : { "type" : "boolean" }, "title" : { "type" : "string" }, "value" : { "type" : "number", "format" : "double" } } }, "JobClassificationReferences" : { "type" : "object", "properties" : { "ranks" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/JobTitleRank" } }, "departments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/JobTitleDepartment" } }, "subDepartments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/JobTitleSubDepartment" } }, "functions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/JobTitleFunction" } } } }, "JobTitleClassificationDTO" : { "type" : "object", "properties" : { "codeRank" : { "type" : "integer", "format" : "int32" }, "codeDepartment" : { "type" : "string" }, "codeSubDepartment" : { "type" : "string" }, "codeFunction" : { "type" : "string" }, "labelRank" : { "type" : "string" }, "labelDepartment" : { "type" : "string" }, "labelSubDepartment" : { "type" : "string" }, "labelFunction" : { "type" : "string" } } }, "JobTitleDepartment" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "label" : { "type" : "string" } } }, "JobTitleDetailsDTO" : { "type" : "object", "properties" : { "contactId" : { "type" : "integer", "format" : "int64" }, "functionLabel" : { "type" : "string" }, "jobTitleClassifications" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/JobTitleClassificationDTO" } }, "updatedFromDatalakeAt" : { "$ref" : "#/components/schemas/ZonedDateTime" } } }, "JobTitleFunction" : { "type" : "object", "properties" : { "label" : { "type" : "string" }, "code" : { "type" : "string" }, "rank" : { "$ref" : "#/components/schemas/JobTitleRank" }, "subDepartment" : { "$ref" : "#/components/schemas/JobTitleSubDepartment" } } }, "JobTitleRank" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "label" : { "type" : "string" } } }, "JobTitleService" : { "type" : "object", "deprecated" : true, "properties" : { "code" : { "type" : "string" }, "label" : { "type" : "string" } } }, "JobTitleSubDepartment" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "label" : { "type" : "string" }, "department" : { "$ref" : "#/components/schemas/JobTitleDepartment" } } }, "JobTitleSubService" : { "type" : "object", "deprecated" : true, "properties" : { "code" : { "type" : "string" }, "label" : { "type" : "string" }, "service" : { "$ref" : "#/components/schemas/JobTitleService" } } }, "LocalDate" : { "type" : "string", "format" : "date", "examples" : [ "2022-03-10" ] }, "MentionedCompany" : { "type" : "object", "properties" : { "companyNumber" : { "type" : "string" }, "companyName" : { "type" : "string" }, "subCategories" : { "type" : "array", "items" : { "type" : "string" } } } }, "ModelSummary" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "datasource" : { "type" : "string" }, "name" : { "type" : "string" } } }, "NeedScorePolarity" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "details" : { "type" : "string" }, "id" : { "type" : "string" }, "positive" : { "type" : "boolean" }, "value" : { "type" : "number", "format" : "double" } } }, "News" : { "type" : "object", "properties" : { "newsId" : { "type" : "string", "examples" : [ "frey-web_a5aaf933fbf732d0957e9d023c6a794eef8d1e459e1a4921935e0808226587d7" ], "description" : "news id" }, "language" : { "type" : "string", "examples" : [ "fr-fr" ], "description" : "language of current events" }, "title" : { "type" : "string", "examples" : [ "Ellisphere consolide son organisation en integrant Infotrade Sparklane" ], "description" : "news title" }, "text" : { "type" : "string", "examples" : [ "Le groupe Ellisphere franchit une nouvelle étape dans la structuration de son modèle en annonçant l'absorption, à compter du 1er janvier 2026, de sa filiale Infotrade, connue sous la marque Sparklane..." ], "description" : "news text content" }, "publicationDate" : { "type" : "string", "examples" : [ "2026-02-09" ], "description" : "Date of publication of the news" }, "url" : { "type" : "string", "examples" : [ "https://www.riskassur-hebdo.com/actu01/actu_auto.php?adr=1201261129" ], "description" : "business triggers signal url. The URL is returned only if the source is web." } } }, "OldJobTitleFunction" : { "type" : "object", "deprecated" : true, "properties" : { "code" : { "type" : "string" }, "rank" : { "$ref" : "#/components/schemas/JobTitleRank" }, "subservice" : { "$ref" : "#/components/schemas/JobTitleSubService" }, "label" : { "type" : "string" } } }, "OnboardingSummary" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "status" : { "type" : "string" } } }, "OnboardingUpdateParams" : { "type" : "object", "required" : [ "file" ], "properties" : { "file" : { "type" : "string", "format" : "binary" }, "filename" : { "type" : "string" } } }, "Period" : { "type" : "object", "required" : [ "startDate" ], "description" : "filter by date of occurrence of the business trigger signal.", "properties" : { "startDate" : { "type" : "string", "examples" : [ "2025-06-01" ], "description" : "Start date of the period." }, "endDate" : { "type" : "string", "examples" : [ "2026-01-01" ], "description" : "End date of the period. This date may be null; if so, the current date will automatically be used as the end date." } } }, "Product" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "stripeProductId" : { "type" : "string" }, "name" : { "type" : "string" }, "credits" : { "type" : "integer", "format" : "int64" }, "stripePlans" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StripePriceInformation" } }, "websiteDisplayOrder" : { "type" : "integer", "format" : "int32" } } }, "ProductSubscriptionParams" : { "type" : "object", "properties" : { "productId" : { "type" : "integer", "format" : "int64" }, "licencesCount" : { "type" : "integer", "deprecated" : true, "format" : "int32" } } }, "Scope" : { "type" : "string", "enum" : [ "COMPANY" ] }, "Scope1" : { "type" : "string", "enum" : [ "COMPANY", "CONSOLIDATED", "GROUP" ] }, "Scope2" : { "type" : "string", "enum" : [ "COMPANY", "CONSOLIDATED", "GROUP" ] }, "ScoredCompany" : { "type" : "object", "properties" : { "companyUniqueId" : { "type" : "string" }, "companyId" : { "type" : "string" }, "companyIdType" : { "$ref" : "#/components/schemas/CompanyIdType3" }, "needScore" : { "type" : "number", "format" : "double" }, "fitScore" : { "type" : "number", "format" : "double" }, "lastModelCalculations" : { "type" : "object", "additionalProperties" : { "type" : "string", "format" : "date", "examples" : [ "2022-03-10" ] } }, "modelId" : { "type" : "integer", "format" : "int64" }, "fitScorePolarities" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FitScorePolarity" } }, "needScorePolarities" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NeedScorePolarity" } } } }, "SearchBusinessTriggerSignalsRequest" : { "type" : "object", "required" : [ "country" ], "properties" : { "customFilters" : { "$ref" : "#/components/schemas/BusinessTriggerSignalsFilters" }, "companyScoringModelFilters" : { "$ref" : "#/components/schemas/CompanyScoringModelFilters" }, "country" : { "type" : "string", "examples" : [ "fr" ], "description" : "the country assigned to business trigger signals" }, "pageNumber" : { "type" : "integer", "format" : "int32", "examples" : [ 1 ], "description" : "allows you to specify the page number you want to retrieve. This attribute is used by pagination. For the first page, you do not need to specify the page." }, "includeBusinessTriggerContent" : { "type" : "boolean", "examples" : [ true ], "description" : "allows you to retrieve the complete content of the business trigger signal (associated news, etc.)" }, "onlyCount" : { "type" : "boolean", "examples" : [ true ], "description" : "allows you to countCompanies the number of signals without returning the details of the signals. This parameter can be used to estimate the maximum number of results." } } }, "SearchBusinessTriggerSignalsResult" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int64", "examples" : [ 245 ], "description" : "number of business trigger signals found" }, "nextPageNumber" : { "type" : "integer", "format" : "int32", "examples" : [ 2 ], "description" : "Next page number. Used for pagination. Can be null if there are no more pages. " }, "pageSize" : { "type" : "integer", "format" : "int32", "examples" : [ 30 ], "description" : "Number of items per page. Used for pagination." }, "estimateMaxCreditCost" : { "type" : "number", "format" : "double", "examples" : [ 352 ], "description" : "Estimated maximum number of signals if you retrieve all pages. Return only if the request parameter onlyCount=true." }, "businessTriggerSignals" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BusinessTriggerSignal" }, "description" : "business trigger signals total number" } } }, "SearchBusinessTriggersResult" : { "type" : "object", "properties" : { "businessTriggers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BusinessTrigger" } }, "count" : { "type" : "integer", "format" : "int64" }, "nextPage" : { "type" : "string" } } }, "SearchCompaniesResult" : { "type" : "object", "properties" : { "pageNumber" : { "type" : "integer", "format" : "int32", "examples" : [ 1 ], "description" : "page number returned." }, "count" : { "type" : "integer", "format" : "int64", "examples" : [ 152 ], "description" : "total number of companies." }, "nextPageNumber" : { "type" : "integer", "format" : "int32", "examples" : [ 152 ], "description" : "Next page number. Used for pagination. May be null if no more results" }, "pageSize" : { "type" : "integer", "format" : "int32", "examples" : [ 30 ], "description" : "Number of items per page. Used for pagination." }, "estimateCreditCost" : { "type" : "number", "format" : "double", "examples" : [ 15230 ], "description" : "Estimated maximum number of companies if you retrieve all pages. Return only if the request parameter onlyCount=true." }, "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SearchCompany" } } } }, "SearchCompany" : { "type" : "object", "properties" : { "uniqueId" : { "type" : "string", "examples" : [ "FR-85191594200029" ], "description" : "Company unique Id." }, "name" : { "type" : "string", "examples" : [ "ELLISPHERE" ], "description" : "Company name" }, "companyNumber" : { "type" : "string", "examples" : [ "482755741" ], "description" : "Company number (In France corresponds to the SIREN number)" }, "establishmentNumber" : { "type" : "string", "examples" : [ "482755741" ], "description" : "Establishment number (In France corresponds to the SIREN number)" }, "activityId" : { "type" : "string", "examples" : [ "8291Z" ], "description" : "Industry code (NAF/APE Code)" }, "activityLabel" : { "type" : "string", "examples" : [ "Activités des agences de recouvrement de factures et des sociétés d'information financière sur la clientèle" ], "description" : "Industry label (NAF/APE label)" }, "head" : { "type" : "boolean", "examples" : [ true ], "description" : "Main office (True/False)" }, "town" : { "type" : "string", "examples" : [ "PUTEAUX" ], "description" : "Town code" }, "address" : { "type" : "string", "examples" : [ "100 JARDINS BOIELDIEU 100 101 TOUR FRANKLIN 92800 PUTEAUX FRANCE" ], "description" : "Full Address" }, "zip" : { "type" : "string", "examples" : [ "92800" ], "description" : "Postal code" }, "searchTermResultExplain" : { "$ref" : "#/components/schemas/SearchTermResultExplain" } } }, "SearchCompanyResult" : { "type" : "object", "properties" : { "uniqueId" : { "type" : "string" }, "compNumber" : { "type" : "string" }, "estNumber" : { "type" : "string" }, "name" : { "type" : "string" }, "zip" : { "type" : "string" }, "town" : { "type" : "string" }, "address" : { "type" : "string" } } }, "SearchDatalakeContactRequest" : { "type" : "object", "required" : [ "companyIdType", "country" ], "properties" : { "companyIds" : { "type" : "array", "deprecated" : true, "uniqueItems" : true, "items" : { "type" : "string" } }, "companyId" : { "type" : "string" }, "companyIdType" : { "$ref" : "#/components/schemas/CompanyIdType1" }, "country" : { "$ref" : "#/components/schemas/CompanyCountry1" }, "pageId" : { "type" : "string" }, "functionLabelFullTextTerm" : { "type" : "string" }, "rankCodes" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "departmentCodes" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "subDepartmentCodes" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "functionCodes" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "administrativeAreas2" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "SearchDatalakeContactsResult" : { "type" : "object", "properties" : { "nextPageId" : { "type" : "string" }, "previousPageId" : { "type" : "string" }, "pageId" : { "type" : "string" }, "pageSize" : { "type" : "integer", "format" : "int32" }, "count" : { "type" : "integer", "format" : "int64" }, "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DatalakeContact" } } } }, "SearchEnrichedContactRequest" : { "type" : "object", "properties" : { "companyIds" : { "type" : "array", "deprecated" : true, "uniqueItems" : true, "items" : { "type" : "string" } }, "companyId" : { "type" : "string", "examples" : [ "508965993" ], "description" : "Desired company identifier. The identifier is associated with the type defined in the companyIdType field. Allows you to filter contacts for a company." }, "companyIdType" : { "$ref" : "#/components/schemas/CompanyIdType1" }, "country" : { "$ref" : "#/components/schemas/CompanyCountry1" }, "pageId" : { "type" : "string" }, "functionLabelFullTextTerm" : { "type" : "string" }, "rankCodes" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "departmentCodes" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "subDepartmentCodes" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "functionCodes" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "administrativeAreas2" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "searchUnsubscribedContactRequest" : { "$ref" : "#/components/schemas/SearchUnsubscribedContactRequest" } } }, "SearchEnrichedContactsResult" : { "type" : "object", "properties" : { "nextPageId" : { "type" : "string" }, "previousPageId" : { "type" : "string" }, "pageId" : { "type" : "string" }, "pageSize" : { "type" : "integer", "format" : "int32" }, "count" : { "type" : "integer", "format" : "int64" }, "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EnrichedContact" } } } }, "SearchTermResultExplain" : { "type" : "object", "description" : "Allows you to explain the result of a full-text search by indicating the names of fields that match the term sent.", "properties" : { "fieldsExplain" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ExplainField" } }, "score" : { "type" : "number", "format" : "double", "examples" : [ 96.31016 ], "description" : "Company score relative to the term sent" } } }, "SearchUnsubscribedContactRequest" : { "type" : "object", "properties" : { "isUnsubscribedContact" : { "type" : "boolean" }, "minUnsubscribedDate" : { "$ref" : "#/components/schemas/ZonedDateTime" }, "maxUnsubscribedDate" : { "$ref" : "#/components/schemas/ZonedDateTime" } } }, "StripeCheckoutSession" : { "type" : "object", "properties" : { "sessionId" : { "type" : "string" } } }, "StripeCheckoutSessionParameters" : { "type" : "object", "properties" : { "redirectSuccessUrl" : { "type" : "string" }, "redirectFailedUrl" : { "type" : "string" }, "priceId" : { "type" : "string" }, "email" : { "type" : "string" } } }, "StripeConfiguration" : { "type" : "object", "properties" : { "stripePublicKey" : { "type" : "string" } } }, "StripeFrequencyBilling" : { "type" : "string", "enum" : [ "month", "year" ] }, "StripePriceInformation" : { "type" : "object", "properties" : { "productId" : { "type" : "string" }, "frequencyBilling" : { "$ref" : "#/components/schemas/StripeFrequencyBilling" }, "description" : { "type" : "string" }, "priceId" : { "type" : "string" }, "unitAmount" : { "type" : "integer", "format" : "int64" }, "amountEuros" : { "type" : "integer", "format" : "int64" }, "currency" : { "type" : "string" } } }, "SubCategory" : { "type" : "object", "properties" : { "id" : { "type" : "string", "examples" : [ "1.2" ], "description" : "business trigger signal subcategory identifier" }, "labels" : { "type" : "object", "examples" : [ { "fr" : "Innovation / Invention" } ], "additionalProperties" : { "type" : "string" }, "description" : "business trigger signal subcategory labels" }, "attributeNames" : { "type" : "array", "examples" : [ [ "source_category", "admin_area_2" ] ], "items" : { "type" : "string" }, "description" : "name of attributes associated with the subcategory" } } }, "SubCategory1" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "label" : { "type" : "string" }, "attributes" : { "type" : "array", "items" : { "type" : "string" } } } }, "SubscriptionRequest" : { "type" : "object", "required" : [ "email", "password", "companyNumber", "companyName", "companyJurisdiction", "firstname", "lastname", "language", "products" ], "properties" : { "email" : { "type" : "string", "pattern" : "\\S" }, "password" : { "type" : "string", "pattern" : "\\S" }, "companyNumber" : { "type" : "string", "pattern" : "\\S" }, "companyName" : { "type" : "string", "pattern" : "\\S" }, "companyJurisdiction" : { "type" : "string", "pattern" : "\\S" }, "firstname" : { "type" : "string", "pattern" : "\\S" }, "lastname" : { "type" : "string", "pattern" : "\\S" }, "language" : { "type" : "string", "pattern" : "\\S" }, "products" : { "type" : "array", "minItems" : 1, "items" : { "$ref" : "#/components/schemas/ProductSubscriptionParams" } } } }, "TargetFilters" : { "type" : "object", "properties" : { "administrativeArea1Filter" : { "$ref" : "#/components/schemas/AdministrativeArea1Filter" }, "administrativeArea2Filter" : { "$ref" : "#/components/schemas/AdministrativeArea2Filter" }, "zipCodeFilter" : { "$ref" : "#/components/schemas/ZipCodeFilter" }, "turnoverFilter" : { "$ref" : "#/components/schemas/TurnoverFilter" }, "employeeNumberFilter" : { "$ref" : "#/components/schemas/EmployeeNumberFilter" }, "activityKeywordFilter" : { "$ref" : "#/components/schemas/ActivityKeywordsFilter" }, "activityCodeFilter" : { "$ref" : "#/components/schemas/ActivityCodesFilter" }, "companyIdFilter" : { "$ref" : "#/components/schemas/CompanyIdFilter" }, "headOnly" : { "type" : "boolean", "description" : "Filter allowing you to return only the main establishment (head office) if TRUE, secondary establishments if FALSE, or all companies if not specified." } } }, "TargetListCompany" : { "type" : "object", "properties" : { "uniqueId" : { "type" : "string" }, "category" : { "type" : "string" }, "skippedEndDate" : { "$ref" : "#/components/schemas/Date" }, "categoryReason" : { "$ref" : "#/components/schemas/WorkflowCategoryReason" } } }, "TurnoverFilter" : { "type" : "object", "description" : "turnover filter", "properties" : { "min" : { "type" : "integer", "format" : "int64" }, "includeLower" : { "type" : "boolean" }, "max" : { "type" : "integer", "format" : "int64" }, "includeUpper" : { "type" : "boolean" }, "includeNullValue" : { "type" : "boolean" }, "scope" : { "$ref" : "#/components/schemas/Scope2" } } }, "ValueLabel" : { "type" : "object", "properties" : { "value" : { "type" : "string" }, "label" : { "type" : "string" } } }, "WorkflowCategoryReason" : { "type" : "string", "enum" : [ "OFF_TARGET", "INSUFFICIENT_BUDGET", "COMPETITOR", "OTHER" ] }, "ZipCodeFilter" : { "type" : "object", "description" : "location filter based on zip code", "properties" : { "values" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ZipCodeValue" } } } }, "ZipCodeValue" : { "type" : "object", "properties" : { "included" : { "type" : "boolean", "examples" : [ true ], "description" : "The value must be included if TRUE and excluded if FALSE." }, "value" : { "type" : "string", "examples" : [ "92800" ], "description" : "zip code" } } }, "ZonedDateTime" : { "type" : "string", "format" : "date-time", "examples" : [ "2022-03-10T12:15:50-04:00" ] } }, "securitySchemes" : { "keycloak" : { "type" : "http", "description" : "You must include your API key or access token (JWT) in the “Authorization” header.

Example:
Authorization: Bearer API_KEY_OR_ACCESS_TOKEN", "name" : "Authorization", "in" : "header", "scheme" : "bearer" } } }, "tags" : [ { "name" : "Business Trigger Signals", "description" : "These endpoints allow you to manage business trigger signals.\nA business trigger signal is a piece of information or an indicator suggesting that a company may have a specific or imminent business need, and therefore represents an opportunity to offer your products or services.\n\nExamples of business signals include: fundraising, appointment of a new executive, obtaining a building permit, launching a new project, hiring, or acquiring another company.\n" }, { "name" : "Business Triggers", "description" : "These endpoints allow you to manage business triggers. A business signal is a piece of information or an indicator suggesting that a company may have a specific or imminent business need, and therefore represents an opportunity to offer your products or services.\nExamples of business signals include: fundraising, appointment of a new executive, obtaining a building permit, launching a new project, hiring, or acquiring another company." }, { "name" : "Companies Search", "description" : "These endpoints allow you to search for companies." }, { "name" : "Contacts", "description" : "These endpoints allow you to manage contacts. You can search for contacts from our datalake to enrich their details (email or phone number), and also retrieve contacts you have already enriched in the past." } ], "paths" : { "/api/business-trigger-signal-references" : { "get" : { "summary" : "Retrieve references", "description" : "This endpoint returns the references associated with the content of business signals.\n\nYou will need this to retrieve the labels associated with certain fields of a business signal and also to find out the different possible filter values.\n", "tags" : [ "Business Trigger Signals" ], "parameters" : [ { "description" : "Business trigger signals reference type filter. To be sent only if you wish to retrieve some of the references.\n\nCATEGORIES: the categories of business trigger signals available\n\nATTRIBUTES: list of all available attributes. You can see the accepted attributes in each business trigger signal subcategory\n\nCOUNTRIES: available countries\n", "name" : "referencesTypes", "in" : "query", "schema" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/components/schemas/BusinessTriggerReferenceType" } } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BusinessTriggerSignalReferences" } } } } }, "security" : [ { "keycloak" : [ ] } ] } }, "/api/business-trigger-signals/search" : { "post" : { "summary" : "Search business trigger signals", "description" : "This endpoint allows you to search for business trigger signals from companies using filters: company numbers, signal subcategories, period, ...\n\nThere are two types of search:\n\nBy companies scoring model, which allows you to retrieve the signal configuration on the model to search for associated signals. To use it, you must enter the ‘companyScoringModelFilters’ attribute in the query.\n\nBy custom filters, which allows you to search for business triggers signals using various criteria (company numbers, signal subcategories, period...). To use it, you must enter the ‘customFilters’ attribute in the query.\n\nYou cannot combine the two types of filters.\n\nThis endpoint will return a maximum of 20 business trigger signals per page.\n\n Before retrieving all business signals, you can estimate the maximum number of results by using the query parameter onlyCount=true.\n\nThis endpoint is subject to a rate limit of X requests/second, X requests/minute, X requests/hour.\n", "tags" : [ "Business Trigger Signals" ], "requestBody" : { "content" : { "application/json" : { "examples" : { "search by companies and subcategories" : { "value" : { "customFilters" : { "companyIdsFilter" : { "companyIds" : [ "482755741", "542051180" ], "companyIdType" : "COMPANY_NUMBER" }, "categoryFilters" : [ { "subCategoryId" : "8.3" }, { "subCategoryId" : "8.2" } ], "period" : { "startDate" : "2025-06-01", "endDate" : "2026-02-15" } }, "country" : "fr", "includeBusinessTriggerContent" : true } }, "search by companies and subcategory with keywords " : { "value" : { "customFilters" : { "companyIdsFilter" : { "companyIds" : [ "482755741", "542051180" ], "companyIdType" : "COMPANY_NUMBER" }, "categoryFilters" : [ { "subCategoryId" : "8.3", "matchWithAnyKeywords" : [ "Sparklane" ], "matchWithAllKeywords" : [ "Infotrade Sparklane", "absorption" ] } ], "period" : { "startDate" : "2025-06-01", "endDate" : "2026-02-15" } }, "country" : "fr", "includeBusinessTriggerContent" : true } }, "search by companies and company scoring model Id " : { "value" : { "companyScoringModelFilters" : { "companyNumbers" : [ "482755741", "542051180" ], "companyScoringModelId" : 1 }, "country" : "fr", "includeBusinessTriggerContent" : true } } }, "schema" : { "$ref" : "#/components/schemas/SearchBusinessTriggerSignalsRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchBusinessTriggerSignalsResult" } } } }, "400" : { "description" : "Bad Request" } }, "security" : [ { "keycloak" : [ ] } ] } }, "/api/business-triggers/categories" : { "get" : { "summary" : "Retrieve the list of categories and sub-categories of Business Triggers", "tags" : [ "Business Triggers" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Category1" } } } } } }, "security" : [ { "keycloak" : [ ] } ] } }, "/api/business-triggers/countries" : { "get" : { "summary" : "Retrieve the list of countries available for the Business Triggers", "tags" : [ "Business Triggers" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } } }, "security" : [ { "keycloak" : [ ] } ] } }, "/api/business-triggers/mentioned-companies/{companyNumber}" : { "get" : { "summary" : "Search for Business Triggers that mention a company.", "tags" : [ "Business Triggers" ], "parameters" : [ { "name" : "companyNumber", "in" : "path", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "description" : "country", "name" : "country", "required" : true, "in" : "query", "schema" : { "type" : "string", "pattern" : "\\S" } }, { "description" : "filter by model id", "name" : "modelId", "required" : false, "in" : "query", "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "page number", "name" : "pageNumber", "required" : false, "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "description" : "page size (min=1 - max=100)", "name" : "pageSize", "required" : false, "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "maximum" : 100, "minimum" : 1 } }, { "description" : "filter by sources (allowed values: internal, web, legal)", "name" : "sources", "required" : false, "in" : "query", "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BusinessTriggerSource" } } }, { "description" : "start of the research period", "name" : "startPeriod", "required" : false, "in" : "query", "schema" : { "$ref" : "#/components/schemas/BusinessTriggerPeriod" } }, { "description" : "filter by subcategories", "name" : "subCategories", "required" : false, "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchBusinessTriggersResult" } } } } }, "security" : [ { "keycloak" : [ ] } ] } }, "/api/companies" : { "get" : { "summary" : "Search companies that matches a term", "parameters" : [ { "description" : "Country concerned by the research", "name" : "country", "required" : true, "in" : "query", "schema" : { "$ref" : "#/components/schemas/CompanyCountry" } }, { "description" : "The desired company fields", "name" : "fields", "required" : false, "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "Results number limit", "name" : "limit", "required" : false, "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "Search query term", "name" : "q", "required" : true, "in" : "query", "schema" : { "type" : "string", "pattern" : "\\S" } }, { "description" : "Get matching establishments", "name" : "withEstablishments", "required" : false, "in" : "query", "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SearchCompanyResult" } } } } } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Companies Resource" ] } }, "/api/companies/countries" : { "get" : { "summary" : "Retrieves the list of countries available for the company search", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Companies Resource" ] } }, "/api/companies/fields" : { "get" : { "summary" : "Retrieves the list of available company fields ", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Companies Resource" ] } }, "/api/companies/search" : { "post" : { "summary" : "Search companies", "description" : "This endpoint allows you to search for companies based on various criteria.\n\nThere are two types of search:\n\nSearch by term, which allows you to search for a company or term that matches the company name, brand, emblem... To use this, you must enter the ‘searchTermFilter’ attribute in the query.\n\nTarget search, which allows you to search for companies using various criteria (location, turnover, activities, etc.). To use it, you must enter the ‘targetFilters’ attribute in the query.\n\nYou cannot combine the two types of filters.\n\n Before retrieving all companies, you can estimate the maximum number of results by using the query parameter onlyCount=true.\n\nThis endpoint is subject to a rate limit of X requests/second, X requests/minute, X requests/hour.\n\nThis endpoint returns a maximum of 30 companies per page.\n", "tags" : [ "Companies Search" ], "requestBody" : { "content" : { "application/json" : { "examples" : { "search companies by multiple criteria" : { "value" : { "targetFilters" : { "administrativeArea1Filter" : { "values" : [ { "value" : "11", "included" : true } ] }, "administrativeArea2Filter" : { "values" : [ { "value" : "92", "included" : true } ] }, "zipCodeFilter" : { "values" : [ { "value" : "92800", "included" : true } ] }, "turnoverFilter" : { "min" : 45000000, "includeLower" : true, "max" : 49000000, "includeUpper" : true, "includeNullValue" : false, "scope" : "COMPANY" }, "employeeNumberFilter" : { "min" : 250, "includeLower" : true, "max" : 350, "includeUpper" : true, "scope" : "CONSOLIDATED" }, "activityKeywordFilter" : { "matchWithAnyKeywords" : [ "risque", "data", "scoring" ] }, "activityCodeFilter" : { "scope" : "COMPANY", "values" : [ { "value" : "8291Z", "included" : true } ] }, "companyIdFilter" : { "companyIdType" : "COMPANY_NUMBER", "values" : [ { "value" : "482755741", "included" : true } ] }, "headOnly" : true }, "country" : "fr" } }, "search companies by term" : { "value" : { "searchTermFilter" : { "headOnly" : "true", "term" : "Ellisph" }, "country" : "fr" } } }, "schema" : { "$ref" : "#/components/schemas/CompaniesSearchRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchCompaniesResult" } } } }, "400" : { "description" : "Bad Request" } }, "security" : [ { "keycloak" : [ ] } ] } }, "/api/companies/{companyId}" : { "get" : { "summary" : "Retrieves information from a company", "parameters" : [ { "description" : "Company identifier", "name" : "companyId", "required" : true, "in" : "path", "schema" : { "type" : "string" } }, { "description" : "Company id type", "name" : "companyIdType", "required" : true, "in" : "query", "schema" : { "$ref" : "#/components/schemas/CompanyIdType2" } }, { "description" : "Country of the company", "name" : "country", "required" : true, "in" : "query", "schema" : { "$ref" : "#/components/schemas/CompanyCountry" } }, { "description" : "The desired company fields", "name" : "fields", "required" : false, "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CompanyDetail" } } } } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Companies Resource" ] } }, "/api/company-lists" : { "get" : { "summary" : "Retrieves all lists.", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CompanyList" } } } } } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Company Lists Resource" ] } }, "/api/company-lists/{companyListId}/categories" : { "get" : { "summary" : "Retrieves categories from a list.", "parameters" : [ { "description" : "Company list identifier", "name" : "companyListId", "required" : true, "in" : "path", "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CompaniesListWorkflowCategory" } } } } } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Company Lists Resource" ] } }, "/api/company-lists/{companyListId}/companies" : { "put" : { "summary" : "Updates companies from a list.", "parameters" : [ { "description" : "Company list identifier", "name" : "companyListId", "required" : true, "in" : "path", "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TargetListCompany" } } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" }, "400" : { "description" : "Bad Request" } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Company Lists Resource" ] } }, "/api/company-lists/{companyListId}/company-searches" : { "post" : { "summary" : "Search companies in a list.", "parameters" : [ { "description" : "Company list identifier", "name" : "companyListId", "required" : true, "in" : "path", "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CompanySearchParams" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CompanySearchResult" } } } }, "400" : { "description" : "Bad Request" } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Company Lists Resource" ] } }, "/api/company-lists/{companyListId}/sparks" : { "get" : { "summary" : "Retrieves Sparks companies from a list.", "deprecated" : true, "parameters" : [ { "description" : "Company list identifier", "name" : "companyListId", "required" : true, "in" : "path", "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CompanySearchResult" } } } } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Company Lists Resource" ] } }, "/api/contact-enrichments" : { "post" : { "summary" : "Launches an email or phone enrichment for a contact.", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EnrichmentRequestParameters" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK" }, "400" : { "description" : "Bad Request" } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Contact Enrichments Resource" ] } }, "/api/contact-enrichments/{queryId}" : { "get" : { "summary" : "Retrieves the result of a contact enrichment query.", "parameters" : [ { "description" : "Enrichment query id", "name" : "queryId", "required" : true, "in" : "path", "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK" } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Contact Enrichments Resource" ] } }, "/api/contact-references" : { "get" : { "summary" : "Retrieve contacts references", "description" : "Retrieve all contact references. These references can be used to add filters in contact searches, but also to label values.", "tags" : [ "Contacts" ], "parameters" : [ { "name" : "country", "in" : "query", "schema" : { "$ref" : "#/components/schemas/CompanyCountry1" } }, { "name" : "referencesTypes", "in" : "query", "schema" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/components/schemas/ContactReferencesTypes" } } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ContactCountryReference" } } } } } }, "security" : [ { "keycloak" : [ ] } ] } }, "/api/contacts" : { "get" : { "summary" : "Retrieve enriched contacts & linkedin url", "description" : "Retrieves all enriched contacts and linkedin search contact url for a company", "deprecated" : true, "tags" : [ "Contacts" ], "parameters" : [ { "description" : "Company Number (SIREN)", "name" : "companyNumber", "required" : true, "in" : "query", "schema" : { "type" : "string", "pattern" : "\\S" } }, { "description" : "Country concerned by the research", "name" : "country", "required" : true, "in" : "query", "schema" : { "type" : "string", "pattern" : "\\S" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeprecatedEnrichedCompanyContacts" } } } } }, "security" : [ { "keycloak" : [ ] } ] } }, "/api/credits" : { "get" : { "summary" : "Retrieves the remaining enable credits and the next renew date", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CreditBalance" } } } } } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Credits Resource" ] } }, "/api/datalake-contacts-searches" : { "post" : { "summary" : "Search contacts", "description" : "Search for contacts from our data lake available for contact information enrichment.", "tags" : [ "Contacts" ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchDatalakeContactRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchDatalakeContactsResult" } } } }, "400" : { "description" : "Bad Request" } }, "security" : [ { "keycloak" : [ ] } ] } }, "/api/datalake-contacts/countries" : { "get" : { "summary" : "Retrieve countries from contacts", "description" : "Retrieve the list of countries available for the contacts search", "tags" : [ "Contacts" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } } }, "security" : [ { "keycloak" : [ ] } ] } }, "/api/enriched-contacts-searches" : { "post" : { "summary" : "Search enriched contacts", "description" : "Search your enriched contacts", "tags" : [ "Contacts" ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchEnrichedContactRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchEnrichedContactsResult" } } } }, "400" : { "description" : "Bad Request" } }, "security" : [ { "keycloak" : [ ] } ] } }, "/api/enriched-contacts/countries" : { "get" : { "summary" : "Retrieve countries from enriched contacts", "description" : "Retrieve the list of countries available for the enriched contacts search", "tags" : [ "Contacts" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } } }, "security" : [ { "keycloak" : [ ] } ] } }, "/api/enriched-contacts/{enrichedContactId}" : { "get" : { "summary" : "Retrieve enriched contact", "description" : "Retrieve one enriched contact", "tags" : [ "Contacts" ], "parameters" : [ { "description" : "Enriched Contact Identifier", "name" : "enrichedContactId", "required" : true, "in" : "path", "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EnrichedContact" } } } } }, "security" : [ { "keycloak" : [ ] } ] } }, "/api/models" : { "get" : { "summary" : "Get all models of user.", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ModelSummary" } } } } } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Models Resource" ] } }, "/api/models/{modelId}/company-scores" : { "post" : { "summary" : "Score a company using a Predict model (get fit score and need score).", "parameters" : [ { "name" : "modelId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CompanyToScore" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScoredCompany" } } } }, "400" : { "description" : "Bad Request" } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Models Resource" ] } }, "/api/onboardings" : { "get" : { "summary" : "Get all onboarding of client.", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OnboardingSummary" } } } } } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Onboardings Resource" ] } }, "/api/onboardings/{sourceId}/onboarding-files" : { "post" : { "summary" : "Upload onboarding file.", "parameters" : [ { "name" : "sourceId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/OnboardingUpdateParams" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK" } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Onboardings Resource" ] } }, "/api/products" : { "get" : { "summary" : "Retrieve products", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Product" } } } } } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Products Resource" ] } }, "/api/stripe-checkout-sessions" : { "post" : { "summary" : "create checkout stripe session", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StripeCheckoutSessionParameters" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StripeCheckoutSession" } } } }, "400" : { "description" : "Bad Request" } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Stripe Resource" ] } }, "/api/stripe-configurations" : { "post" : { "summary" : "build Stripe configuration", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StripeConfiguration" } } } } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Stripe Resource" ] } }, "/api/stripe-events" : { "post" : { "summary" : "publish stripe events", "parameters" : [ { "name" : "Stripe-Signature", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "string" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK" } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Stripe Resource" ] } }, "/api/subscription-requests" : { "post" : { "summary" : "Create a subscription request.", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK" }, "400" : { "description" : "Bad Request" } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Subscription Requests Resource" ] } }, "/api/subscription-requests/validate" : { "get" : { "summary" : "Validate a subscription request.", "parameters" : [ { "name" : "email", "in" : "query", "schema" : { "type" : "string" }, "required" : true }, { "name" : "uuid", "in" : "query", "schema" : { "type" : "string" }, "required" : true } ], "responses" : { "200" : { "description" : "OK" } }, "security" : [ { "keycloak" : [ ] } ], "tags" : [ "Subscription Requests Resource" ] } } }, "info" : { "title" : "SHARE", "version" : "6.6.3-SNAPSHOT", "description" : "Welcome to the Ellisphere API !

To use the API endpoints, you must include your API key or access token (JWT) in the Authorization header.

Example:
Authorization: Bearer API_KEY_OR_ACCESS_TOKEN." }, "servers" : [ { "url" : "/v6" } ] }