Below is a quick overview to using some of these resources, more detailed instructions are provided as links to the respective sections in our API reference, where you can find every resource and operation available.
This is the starting point.
Portfolios let you organize scorecards and you can create and manipulate them using our API.
We only calculate scorecards that were added to a portfolio so you must add a scorecard to a portfolio before accessing scorecard data.
For more details see portfolios API reference.
We keep scorecards for every company with a digital footprint, you can find statistics about our scorecard catalog in our Trust Portal
Some customers can also create and publish custom scorecards for subsidiaries or other subsets of a regular scorecard.
To generate a scorecard for a new company scorecard simply add a new scorecard to a portfolio using any domain associated to that company.
For any date range within the last 12 months you can also obtain score history (overall, per factor, industry, industry per factor) and event log. Events in a scorecard event log explain score changes and work as a news feed of scorecard updates like new issues, issues getting resolved, and reported breaches.
You can request some of the portfolio and scorecard reports available in our platform, list recently generated reports and download the generated file (eg. csv, pdf) when they complete.
For details see reports API reference.
Setup alerts to get notifications on different scorecard changes, and then list recent notifications.
For details see alerts API reference.
You can also automate additional actions to improve the security posture of your company or the companies in your ecosystem:
- Get a score plan for any scorecard by specifying a target score
- Refute issues
- Invite companies improve their score. All invited companies gain a free account to access their own scorecard and improve their security posture.
While we keep a level of feature parity with the SecurityScorecard web application some functionality might not be available yet for programatic usage.
If there's anything missing you're trying to use in your integration, we are eager to hear about it! Please contact us at [email protected].
Updated over 3 years ago
Check some code samples using these resources