Sign in

v1

latestOpenAPI 3.0.0Proprietary - Commercial Use Only2026-08-06172139621.6 KB
Assessment

Gets a single document detail for a specific assessment of a monitored company.

Retrieves a single document for the specified assessment, including document metadata, summary, status, issuer, organization, and issues.

get/api/v2/companies/{id}/assessments/{assessmentId}/documents/{documentId}

Path parameters

idinteger required
Example:123

The id of the company whose assessment document will be retrieved.

assessmentIdinteger required
Example:456

The id of the assessment whose document will be retrieved.

documentIdinteger required
Example:789

The id of the assessment document to retrieve.

Response

Assessment document detail retrieved successfully.

DocumentIdinteger required

Unique identifier for the document.

Namestring

Name of the document including extension.

Sizeinteger nullable

Size of the document in bytes.

UploadDatestring date-time nullable

Date and time when the document was uploaded.

UploadedBystring

User who uploaded the document. If the document was uploaded via the API, the value will be "API". If uploaded via the portal, the value will be the uploader's full name.

Status'Waiting' | 'InProgress' | 'Completed' | 'ParseError'

Status of the document.

Summarystring

Summary or description of the document.

Datestring date-time nullable

Date of the document.

DateSourcestring

Source of the document date.

ValidUntilDatestring nullable

Date until which the document is valid.

Typestring

Type/category of the document.

IssuerNamestring

Name of the issuer of the document.

StatusMessagestring nullable

Status message of the document.

OrganizationNamestring

Name of the organization related to the document.

Example response

{
  "DocumentId": 2048,
  "Name": "Annual Security Audit 2025.pdf",
  "Size": 512000,
  "UploadDate": "2025-08-15T09:30:00.000Z",
  "UploadedBy": "John Doe",
  "Status": "Completed",
  "Summary": "This audit report provides a comprehensive review of the organization's security controls, highlights areas of improvement, and includes recommendations for mitigating identified risks. The assessment covers network infrastructure, endpoint protection, and incident response readiness.",
  "Date": "2025-08-15T09:30:00.000Z",
  "DateSource": "Audit Completion Date",
  "ValidUntilDate": "2026-07-30",
  "Type": "Audit Report",
  "IssuerName": "CyberTrust Solutions",
  "StatusMessage": "Document parsing error.",
  "OrganizationName": "Acme Corp",
  "Issues": [
    {
      "Id": "SEC-2025-001",
      "Description": "Unpatched critical vulnerability detected in web server.",
      "Details": "The Apache server running on 10.0.0.5 is missing security patch CVE-2025-1234. Immediate remediation is recommended."
    }
  ]
}