SEsecurityscorecard
scores

Get a company information and scorecard summary

Changed on

Get a company information and scorecard summary

get/companies/{scorecard_identifier}

Request

  • Base URL
    https://api.securityscorecard.io
  • URL
    https://api.securityscorecard.io/companies/{scorecard_identifier}
  • Auth
    API key in header Authorization

Path parameters

scorecard_identifierstring required

primary identifier of a company or scorecard in SecurityScorecard. To determine this value, company must be added to a portfolio first.

Query parameters

with_provisional_statusboolean

return if score is provisional

Response

Get all the domain tags of the parent domain

namestring required
domainstring required

primary domain of the company

grade'A' | 'B' | 'C' | 'D' | 'F' | '?' required

a security scorecard grade (A to F), or '?' if it's calculating.

grade_urlstring

url to an image depicting the grade

scoreinteger required

security score from 0 to 100. this property is undefined if score is still being calculated.

industrystring required

industry (unique identifier). 'unknown' if this wasn't yet determined.

size'unknown' | 'size_1_to_10' | 'size_11_to_50' | 'size_51_to_200' | 'size_201_to_500' | 'size_501_to_1000' | 'size_1001_to_5000' | 'size_5001_to_10000' | 'size_more_than_10000' required

a company described based on number of employees

uuidstring

Identifier

last30day_score_changeinteger

The delta score in 30 days

is_customboolean nullable

Is custom scorecard

is_entityboolean nullable

Is an entity

is_un_publishedboolean nullable

Is unpublished

created_atstring date-time nullable

created date

disputedboolean

Is disputed

provisionalboolean

Indicates if the score is provisional, it is included if with_provisional_status is true

descriptionstring

description

Example response

{
  "name": "Example Ltd.",
  "domain": "example.com",
  "grade": "A",
  "score": 95,
  "industry": "technology",
  "size": "size_501_to_1000",
  "uuid": "aea7dae2-370f-4279-a458-4c7cb9661778",
  "last30day_score_change": 1,
  "created_at": "2020-01-01T00:00:00.000Z",
  "description": "Example description",
  "factors": [
    {
      "name": "network_security",
      "score": 95,
      "grade": "A",
      "issue_summary": [
        {
          "severity": "medium",
          "type": "cookie_secure_flag",
          "count": 5,
          "detail_url": "https://api.securityscorecard.io/companies/example.com/issues/cookie_secure_flag",
          "total_score_impact": 0.034
        }
      ]
    }
  ]
}

Changes

  • b465b4846039Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      media type application/json; charset=utf-8 was changed to application/json for the response status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response's property default value 0 was added for the status

    • info

      response property disputed deprecated

    • info

      response property is_entity deprecated

    • info

      response property is_un_published deprecated

    • info

      the response's property pattern ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$ was added for the status

    • info

      the response's property pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ was added for the status