Skip to main content

getCompanyDetails

This method retrieves the details of your company.

Parameters

Parameter

Type

Optional

Description

companyId

String

Yes

The company's ID. The default value is the ID of the company linked to the user who generated the API key.

Return value

This method returns an Object containing the details of the selected company:

  • type (Integer): The company type: 0 for Partner, 1 for Customer

  • name (String): The name of the company

  • id (String): The ID of the company

  • address (String): The address of the company

  • phone (String): The phone of the company

  • canBeManagedByAbove (Boolean): The security management status for the company: true, if the security can be managed by Partner companies.

  • enforce2FA (Boolean): Specifies if the Two Factor Authentication (2FA) is enforced for user accounts belonging to the selected company.

  • skip2FAPeriod (Integer): The duration, in days, that the users can be exempted from providing a two-factor authentication code at login.

  • isSuspended (Boolean): Company account status: true, if the company is suspended.

  • createdAt (String): The UTC date and time at which the company was created

  • country (String): The country code in ISO 3166 format. If the code is not specified, the String has the value N/A.

  • state (String): The company's state or primary administrative subdivision of operation (in ISO 3166 format). If not specified, the String has the value N/A.

  • industry (Integer): The industry the company operates in. It can have one of the following values:

    • 0 - UNDEFINED

    • 1 - AEROSPACE

    • 101 - AEROSPACE_MANUFACTURING

    • 102 - AEROSPACE_TECHNOLOGY_RESEARCH

    • 2 - AGRICULTURE

    • 201 - AGRICULTURE_CHEMICALS_FERTILIZERS

    • 202 - AGRICULTURE_CROP_AND_ANIMAL_PRODUCTION

    • 203 - AGRICULTURE_FARM_MACHINERY

    • 204 - AGRICULTURE_FARMING

    • 205 - AGRICULTURE_FISHING

    • 206 - AGRICULTURE_FORESTRY

    • 207 - AGRICULTURE_HUNTING

    • 208 - AGRICULTURE_PRODUCTS

    • 3 - ARTS_ENTERTAINMENT

    • 301 - ARTS_ENTERTAINMENT_CULTURAL_ACTIVITIES

    • 302 - ARTS_ENTERTAINMENT_GAMBLING

    • 4 - AUTOMOTIVE

    • 401 - AUTOMOTIVE_AUTO_TRUCK_MOTORCYCLE_PARTS

    • 402 - AUTOMOTIVE_MACHINERY

    • 403 - AUTOMOTIVE_MANUFACTURERS

    • 404 - AUTOMOTIVE_MARKETING

    • 5 - BUSINESS_ASSOCIATIONS

    • 6 - CHEMICALS

    • 7 - COMMERCIAL_SERVICES

    • 701 - COMMERCIAL_SERVICES_VETERINARY

    • 8 - CONGLOMERATE

    • 9 - CONSTRUCTION

    • 901 - CONSTRUCTION_CIVIL_ENGINEERING

    • 902 - CONSTRUCTION_CONSTRUCTION_OF_BUILDINGS

    • 903 - CONSTRUCTION_CONTRACTORS

    • 904 - CONSTRUCTION_ENGINEERING

    • 905 - CONSTRUCTION_MATERIALS

    • 906 - CONSTRUCTION_SPECIALISED

    • 907 - CONSTRUCTION_UTILITY_SYSTEMS

    • 10 - CONSULTING

    • 11 - CONTAINERS_PACKAGING

    • 12 - DEFENSE

    • 1201 - DEFENSE_SHIPBUILDING_AIRCRAFT

    • 1202 - DEFENSE_SPACE

    • 1203 - DEFENSE_WEAPONS

    • 13 - EDUCATION_RESEARCH

    • 1301 - EDUCATION_RESEARCH_SCIENTIFIC_RESEARCH_AND_DEVELOPMENT

    • 14 - ENERGY

    • 1401 - ENERGY_EQUIPMENT_TECHNOLOGIES

    • 1402 - ENERGY_INFRASTRUCTURE

    • 1403 - ENERGY_OIL_GAS_CONSUMABLE_FUELS

    • 1404 - ENERGY_RENEWABLE_ENERGY

    • 15 - ENGINEERING

    • 16 - FINANCIAL_SERVICES

    • 1601 - FINANCIAL_SERVICES_BANKS

    • 1602 - FINANCIAL_SERVICES_DIVERSIFIED

    • 1603 - FINANCIAL_SERVICES_INSURANCE

    • 1604 - FINANCIAL_SERVICES_INVESTMENT

    • 1605 - FINANCIAL_SERVICES_REAL_ESTATE

    • 17 - FOOD_BEVERAGES

    • 18 - GOVERNMENT

    • 1801 - GOVERNMENT_LOCAL

    • 1802 - GOVERNMENT_NATIONAL

    • 1803 - GOVERNMENT_PRIVATE_CONTRACTORS

    • 1804 - GOVERNMENT_PUBLIC_ADMINISTRATION_AND_DEFENSE

    • 1805 - GOVERNMENT_PUBLIC_SERVICES

    • 1806 - GOVERNMENT_REGIONAL

    • 19 - HEALTHCARE

    • 1901 - HEALTHCARE_EQUIPMENT_SERVICES

    • 1902 - HEALTHCARE_PHARMACEUTICALS_BIOTECHNOLOGY_LIFE_SCIENCES

    • 1903 - HEALTHCARE_RESEARCH

    • 20 - HOSPITALITY_LEISURE

    • 2001 - HOSPITALITY_LEISURE_HOTEL_MOTELS_CRUISE_LINES

    • 2002 - HOSPITALITY_LEISURE_LEISURE_RECREATION

    • 2003 - HOSPITALITY_LEISURE_RESTAURANT_BARS

    • 21 - MANUFACTURING

    • 2101 - MANUFACTURING_BASIC_METALS

    • 2102 - MANUFACTURING_BEVERAGES

    • 2103 - MANUFACTURING_CHEMICALS_PRODUCTS

    • 2104 - MANUFACTURING_ELECTRICAL_EQUIPMENT

    • 2105 - MANUFACTURING_ELECTRONICS

    • 2106 - MANUFACTURING_FABRICATED_METAL_PRODUCTS

    • 2107 - MANUFACTURING_FOOD_PRODUCTS

    • 2108 - MANUFACTURING_FURNITURE

    • 2109 - MANUFACTURING_MACHINERY_EQUIPMENT

    • 2110 - MANUFACTURING_MOTOR_VEHICLES

    • 2111 - MANUFACTURING_NON_METALLIC_MINERAL_PRODUCTS

    • 2112 - MANUFACTURING_PAPER_PRODUCTS

    • 2113 - MANUFACTURING_PETROLEUM_PRODUCTS

    • 2114 - MANUFACTURING_PHARMACEUTICAL_PRODUCTS

    • 2115 - MANUFACTURING_TEXTILES

    • 2116 - MANUFACTURING_TOBACCO

    • 2117 - MANUFACTURING_TRANSPORT

    • 2118 - MANUFACTURING_WEARING_APPAREL

    • 2119 - MANUFACTURING_WOOD

    • 22 - MARINE

    • 23 - MEDIA

    • 2301 - MEDIA_ADVERTISING_MARKETING

    • 2302 - MEDIA_BROADCASTING

    • 2303 - MEDIA_ENTERTAINMENT

    • 2304 - MEDIA_PUBLISHING

    • 24 - MINING

    • 2401 - MINING_COAL_AND_LIGNITE

    • 2402 - MINING_METAL_ORES

    • 2403 - MINING_PETROLEUM_AND_NATURAL_GAS

    • 2404 - MINING_PRECIOUS_METALS

    • 2405 - MINING_QUARRYING

    • 2406 - MINING_SERVICES

    • 25 - NON_PROFIT

    • 26 - OFFICES_OF_LAWYERS

    • 27 - PAPER_FOREST_PRODUCTS

    • 28 - RETAIL

    • 2801 - RETAIL_BEVERAGES

    • 2802 - RETAIL_BOOKS_AND_NEWS

    • 2803 - RETAIL_BUILDING_MATERIALS

    • 2804 - RETAIL_CLOTHING_STORES

    • 2805 - RETAIL_DISTRIBUTORS

    • 2806 - RETAIL_ELECTRONIC_SHOPPING

    • 2807 - RETAIL_ELECTRONICS

    • 2808 - RETAIL_GASOLINE_STATIONS

    • 2809 - RETAIL_HOME_FURNISHING

    • 2810 - RETAIL_LUXURY_STORES

    • 2811 - RETAIL_MULTILINE_RETAIL

    • 2812 - RETAIL_PERSONAL_CARE_STORES

    • 2813 - RETAIL_SPECIALTY_FOOD_STORES

    • 2814 - RETAIL_SUPERMARKETS

    • 2815 - RETAIL_SUPPLIES_STORES

    • 2816 - RETAIL_VEHICLES

    • 29 - SUPPORT_SERVICE_ACTIVITIES

    • 2901 - SUPPORT_SERVICE_ACTIVITIES_BUSINESS_SUPPORT

    • 2902 - SUPPORT_SERVICE_ACTIVITIES_EMPLOYMENT

    • 2903 - SUPPORT_SERVICE_ACTIVITIES_MAINTENANCE_SERVICES

    • 2904 - SUPPORT_SERVICE_ACTIVITIES_RENTAL_AND_LEASING

    • 2905 - SUPPORT_SERVICE_ACTIVITIES_SECURITY_AND_INVESTIGATION

    • 2906 - SUPPORT_SERVICE_ACTIVITIES_SOCIAL_ASSISTANCE

    • 2907 - SUPPORT_SERVICE_ACTIVITIES_TRAVEL_AGENCY

    • 30 - TECHNOLOGY

    • 3001 - TECHNOLOGY_ARTIFICIAL_INTELLIGENCE

    • 3002 - TECHNOLOGY_ELECTRONIC_EQUIPMENT_COMPONENTS

    • 3003 - TECHNOLOGY_HARDWARE

    • 3004 - TECHNOLOGY_IT_SERVICES

    • 3005 - TECHNOLOGY_SECURITY

    • 3006 - TECHNOLOGY_SEMICONDUCTORS_SEMICONDUCTOR_EQUIPMENT

    • 3007 - TECHNOLOGY_SOFTWARE

    • 31 - TELECOMMUNICATIONS_SERVICES

    • 3101 - TELECOMMUNICATIONS_SERVICES_COMMUNICATIONS_INFRASTRUCTURE

    • 3102 - TELECOMMUNICATIONS_SERVICES_INTEGRATED_TELECOMMUNICATIONS

    • 3103 - TELECOMMUNICATIONS_SERVICES_WIRELESS_TELECOMMUNICATIONS

    • 32 - TRANSPORTATION

    • 3201 - TRANSPORTATION_AIR_TRANSPORTATION

    • 3202 - TRANSPORTATION_DEEP_SEA_COASTAL_AND_GREAT_LAKES_WATER_TRANSPORTATION

    • 3203 - TRANSPORTATION_GENERAL_FREIGHT_TRUCKING

    • 3204 - TRANSPORTATION_INFRASTRUCTURE

    • 3205 - TRANSPORTATION_INLAND_WATER_TRANSPORTATION

    • 3206 - TRANSPORTATION_PIPELINE_TRANSPORTATION

    • 3207 - TRANSPORTATION_POSTAL_AND_COURIER

    • 3208 - TRANSPORTATION_RAIL_TRANSPORTATION

    • 3209 - TRANSPORTATION_ROAD_TRANSPORTATION

    • 3210 - TRANSPORTATION_SIGHTSEEING

    • 3211 - TRANSPORTATION_URBAN_TRANSIT_SYSTEMS

    • 3212 - TRANSPORTATION_WATER_TRANSPORTATION

    • 33 - UTILITIES

    • 3301 - UTILITIES_ELECTRICITY_GAS

    • 3302 - UTILITIES_WATER_SUPPLY

    • 34 - WHOLESALE

    • 3401 - WHOLESALE_APPAREL

    • 3402 - WHOLESALE_BEVERAGES

    • 3403 - WHOLESALE_BUILDING_MATERIALS

    • 3404 - WHOLESALE_CHEMICALS

    • 3405 - WHOLESALE_DRUGS

    • 3406 - WHOLESALE_ELECTRONIC_MARKETS

    • 3407 - WHOLESALE_ELECTRONICS

    • 3408 - WHOLESALE_FARM_PRODUCTS

    • 3409 - WHOLESALE_GROCERY

    • 3410 - WHOLESALE_HOME_FURNISHING

    • 3411 - WHOLESALE_METAL_AND_MINERAL

    • 3412 - WHOLESALE_NONDURABLE_GOODS

    • 3413 - WHOLESALE_PETROLEUM

    • 3414 - WHOLESALE_SUPPLIES

    • 3415 - WHOLESALE_VEHICLES

  • contactPerson (Object): The details of the contact person for GravityZone:

    • fullName (String): Their first name and surname

    • email (String): Their business email address

    • phoneNumber (String): Their business phone number

    • companyRole (String): Their position in the company

    Note

    • If any field under this object has a value, all fields will be returned, regardless of whether they have a value assigned or not.

    • This field is returned only when contact person information has been configured for the company.

  • mdrContactInformation (Object): The details of the contact person for MDR

    The object might contain:

    • fullName (String): The first name and surname of the contact person for MDR

    • email (String): The business email address of the contact person for MDR

    • phoneNumber (String): The business phone number of the contact person for MDR

    Important

    MDR contact details are returned exclusively for companies with a valid annual MDR license.

  • riskScore (Object): Information about the company's security risks:

    • value (String): The company's security risk score value in percentage. It is broken down into misconfigurations, app vulnerabilities, human risks, and adjusted by the health industry modifier.

    • impact (String): The company's security risk impact (Low, Medium, or High)

    • misconfigurations (String): The percentage of misconfigurations in the company's security risk score

    • appVulnerabilities (String): The percentage of app vulnerabilities in the company's security risk score

    • humanRisks (String): The percentage of human risks in the company's security risk score

    • industryModifier (String): Dynamically adjusts your company score based on CVEs discovered in your environment that have already been exploited at the industry level.

  • customFields (Object): The custom fields for the company, if defined by a Partner

  • duplicateClosedIncidentsOnUpdate (Boolean): When set to:

    • true: Updates found on a closed incident trigger the creation of a new incident.

    • false: If updates are detected on a closed incident, the incident is reopened.

Example

Request:

{
    "params": {
        "companyId": "5493dcd2b1a43df00b7b23c6"
    },
    "jsonrpc": "2.0",
    "method": "getCompanyDetails",
    "id": "0df7568c-59c1-48e0-a31b-18d83e6d9810"
}

Response:

{
    "id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
    "jsonrpc": "2.0",
    "result": {
        "type": 1,
        "name": "Example LTD",
        "id": "54aeab40b1a43dc0467b23e9",
        "address": "Str Example No 1",
        "phone": "0040740000001",
        "canBeManagedByAbove": true,
        "enforce2FA": true,
        "skip2FAPeriod": 3,
        "isSuspended": false,
        "createdAt": "2017-01-28T15:01:15",
        "country": "CA",
        "state": "CA-BC",
        "industry": 2,
        "contactPerson": {
            "fullName": "Stephen Jhonson",
            "email": "stephen.jhonsons@example.email.com",
            "phoneNumber": "0040740000001",
            "companyRole": "Owner / President"
        },
        "mdrContactInformation": {
            "phoneNumber": "+409999999999",
            "fullName": "Contact",
            "email": "mdrcontact@nebula.local"
        },
        "riskScore": {
            "value": "87%",
            "impact": "High",
            "misconfigurations": "70%",
            "appVulnerabilities": "11%",
            "humanRisks": "19%",
            "industryModifier": "6%"
        },
        "duplicateClosedIncidentsOnUpdate": false,
    }
}
In this section: