SEsecurityscorecard
reports

Generate a Company Partnership report

Changed on 
Note: requesting a report for a company where score is still calculating will be accepted,
but might fail to generate if a score is not determined soon enough.
It's recommended to check a score is available before requesting a report
post/reports/partnership

Request

  • Base URL
    https://api.securityscorecard.io
  • URL
    https://api.securityscorecard.io/reports/partnership
  • Auth
    API key in header Authorization

Request body

Example request

{
  "scorecard_identifier": "example.com"
}

Response

a reference to the created report

idstring required

Identifier

formatstring
titlestring
report_typestring
created_atstring date-time

created date

is_newboolean

Example response

{
  "id": "aea7dae2-370f-4279-a458-4c7cb9661778",
  "params": {
    "domain": "example.com"
  },
  "created_at": "2020-01-01T00:00:00.000Z"
}

Changes

  • b465b4846039Revision changes
    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • 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 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

      added the optional property to the 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

      added the optional property to the response with the status

    • info

      the response property became required 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