Skip to main content
POST
/
platform
/
files
/
{fileId}
/
audit-report
Create file audit report
curl --request POST \
  --url https://api.rootkey.ai/api-v1/platform/files/{fileId}/audit-report \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "framework": "NIS2",
  "periodStart": "2023-11-07T05:31:56Z",
  "periodEnd": "2023-11-07T05:31:56Z"
}
'
{
  "reportId": "cmpr_abc123",
  "status": "PENDING"
}

Authorizations

​
x-api-key
string
header
required

ROOTKey API key (rk_live_... for production, rk_test_... for the test network).

Path Parameters

​
fileId
string
required

Body

application/json
​
framework
enum<string>
default:NIS2
Available options:
NIS2,
DORA
​
periodStart
string<date-time>

Reporting period start (defaults to file createdAt)

​
periodEnd
string<date-time>

Reporting period end (defaults to now)

Response

Report generation job accepted

​
reportId
string
required

ID of the created compliance report

Example:

"cmpr_abc123"

​
status
enum<string>
required

Initial status; the report is processed asynchronously

Available options:
PENDING