Skip to content
/Certifications

Create a file certification

Request

Creates a new certification from uploaded files (upload session)

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Request payload for creating a file certification

titlestringrequired

Title of the certification

generate_pdf_reportboolean

Whether to generate a PDF report (defaults to true)

webhook_urlstring, (uri)

Optional webhook URL for completion notification. Callbacks are signed per the Standard Webhooks specification. The payload uses a standard envelope with type, timestamp and data fields.

metadataobject

Optional metadata key-value pairs

upload_session_tokenstringrequired

Token received from file-certifications-attachments step

curl -i -X POST \
  https://truescreen.redocly.app/_mock/openapi/v1/file-certifications \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Files to certify",
    "upload_session_token": "aaabbbccc",
    "webhook_url": "https://example.com/callback",
    "metadata": {
      "name": "John Doe",
      "email": "john.doe@example.com"
    }
  }'

Responses

Created file certification

Bodyapplication/json
report_idstringrequired

Unique report identifier

statusstringrequired

Certification status

credits_amountnumberrequired

Credits consumed

titlestringrequired

Title of the certification

created_atstring, (date-time)required

Creation timestamp

Response
{
  "report_id": "1111-1111-1111-1111",
  "status": "pending",
  "credits_amount": 1,
  "title": "Files to certify",
  "created_at": "2026-01-01T00:00:00Z"
}