Sign in

v1

latestOpenAPI 3.1.12026-07-242899061.7 MB
TOE Reports

This resource allows the ordering and downloading of toe reports

This endpoint provides the ordering of the following toe reports:

  • Executive Report - The Executive Report (executive-report) provides an executive summary of the RiskRecon ratings and security performance metrics.
  • Summary Report - The RiskRecon Summary Report (summary-report) provides the summary RiskRecon ratings and security performance metrics.
  • Detailed Report - The RiskRecon Detailed Report (detailed-report) provides the RiskRecon ratings, security performance metrics, and detailed findings and recommendations.
  • Action Plan - The action plan (action-plan) on this toe.
post/v1/toe_reports

Request body

toe_idstring required

The TOE to use to get pdf report

report_type'executive-report' | 'summary-report' | 'detailed-report' | 'action-plan' required

Executive Report (executive-report), Summary Report (summary-report), Detailed Report (detailed-report), Action Plan (action-plan)

Example request

{
  "toe_id": "5976423a-ee35-11e3-8569-14109ff1a304",
  "report_type": "summary-report"
}

Response

OK

request_idnumber

The unique ID of the request.

toe_idstring

TEO on which report was requested

toe_namestring

The Company or entity name.

analysis_idnumber

The unique analysis Id

report_typestring

The unique name of the report.

report_keystring

The unique name of the report.

statusstring

The current status of the request.

Example response

{
  "request_id": 123,
  "toe_id": "5976423a-ee35-11e3-8569-14109ff1a304",
  "toe_name": "Sample Enterprises, USA",
  "analysis_id": 51233544,
  "report_type": "executive-report",
  "report_key": "company-overview-report-Sample-Enterprises,-USA-4635645253-2024-1-9:10-21-18.pdf",
  "status": "pending"
}