SEsecurityscorecard
scores

Get a company's expanded risk

Changed on

Get a company's expanded risk

get/companies/{scorecard_identifier}/expanded-risk

Request

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

Path parameters

scorecard_identifierstring required

primary identifier of a company or scorecard

Query parameters

category'adverse' | 'corruption' | 'financial crime' | 'high risk industry' | 'pep' | 'relative or associate' | 'sanctions' | 'state owned company' | 'terrorism' | 'watchlist'

optionally filter events by category. accepts one value at a time.

confidence'low' | 'unlikely' | 'medium' | 'high'

optionally filter events by confidence. accepts one value at a time.

pageinteger

optionally specify which page of results to return

limitinteger

optionally specify how many results to return per page (max 1000). Larger result sets must be retrieved by paginating with page.

Response

Get the expanded risk associated to the given scorecard

sizeinteger required

The number of records to be returned per page

totalinteger required

The total number of records matching the given query

Example response

{
  "entries": [
    {
      "scorecard_domain": "example.com",
      "scorecard_id": "aea7dae2-370f-4279-a458-4c7cb9661778",
      "source_url": "https://example.com/scanned",
      "company_name": "Example Ltd.",
      "confidence": "High",
      "category": "STATE_OWNED_COMPANY",
      "sub_category": "SOE: Govt Owned Corp",
      "event": "SOE involved in Public Services",
      "event_urls": [
        "https://example.com/event1"
      ],
      "comments": "Example comment",
      "primary_source": "Website",
      "created_at": "2020-01-01T00:00:00.000Z",
      "updated_date": "2020-01-01T00:00:00.000Z"
    }
  ],
  "size": 100,
  "total": 999
}

Changes

  • b465b4846039Revision changes
    • breaking

      for the query request parameter limit, the max was decreased from 5000.00 to 1000.00

    • breaking

      the / response's property type changed from no type to object for status

    • info

      removed from the response body allOf list for the response 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

      the response property became required for the status

    • 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

    • 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

      added the required property to the response with the status

    • info

      added the required property to the response with the status