Compliance Assessment Service API Documentation
  • Overview
  • Core Concepts
  • API Reference
Product
  • Pricing
Company
  • About Us
  • Contact
Legal
  • Privacy Policy

© 2026 Precognox. All rights reserved.

Information
info-controller
    Get application infoget
framework-controller
    List all frameworksgetList framework criteriaget
assessment-controller
    Submit assessmentpostPoll assessment statusgetGet assessment resultsgetCancel assessmentdelete
assessment-feedback-controller
    Submit assessment feedbackpost
content-processing-controller
    Submit file for content processingpostSubmit URL for content processingpostGet content processing statusgetBatch status checkpostGet extracted contentgetCancel content processingdeleteRefresh content processingpost
Schemas
Compliance Manager Backend API
Compliance Manager Backend API

Schemas


ErrorResponse

Standard error response
timestamp
​string · date-time

Timestamp when the error occurred

status
​integer · int32

HTTP status code

error
​string

HTTP status reason phrase

message
​string

Detailed error message

FrameworkResponseDTO

Compliance framework with associated criteria
id
​integer · int64

Unique identifier of the framework

name
​string

Name of the framework

codeName
​string

Code name of the framework

description
​string

Description of the framework

​CriterionRequestDTO[]

List of criteria associated with the framework

CriterionRequestDTO

A compliance criterion within a framework
name
​string · required

The full name of the criterion

codeName
​string · required

The code name of the criterion

description
​string · required

The description of the criterion

AssessmentRequestConfiguration

Configuration for an assessment request
expertId
​string · required

The ID of the expert who carries out the assessment

frameworkCodeName
​string · required

The code name of the framework to which the criterion belongs

criteriaCodeNames
​string[]

The code names of the criteria on which the assessment is based. If omitted, all criteria of the framework are assessed.

assessmentProcessId
​string

The ID of the assessment process, serves as to group assessment responses together. If omitted, a new UUID is generated.

llmCall
​boolean

To be able to overwrite the LLM call flag

AssessmentsResponseDTO

Response containing the status and results of an assessment process
assessmentProcessId
​string

Unique identifier of the assessment process

status
​string · enum

Current status of the assessment process

Enum values:
PENDING
RUNNING
COMPLETED
FAILED
CANCELLED
completion
​number · float · min: 0 · max: 1

Completion percentage of the assessment process (0.0 to 1.0)

​AssessmentResponseDTO[]

List of assessment responses (populated when status is COMPLETED)

AssessmentResponseDTO

Result of a single criterion assessment
id
​integer · int64

Unique identifier of the assessment result

assessmentProcessId
​string

Unique identifier of the assessment process

inputTokens
​integer · int32

Input tokens used in the assessment

outputTokens
​integer · int32

Output tokens generated by the assessment

processingTimeMs
​integer · int64

Processing time in milliseconds

expertId
​string

Identifier of the expert who performed the assessment

fileNames
​string[]

List of file names associated with the assessment

urls
​string[]

List of URLs associated with the assessment

frameworkCodeName
​string

Code name of the framework used in the assessment

criterionCodeName
​string

Code name of the criterion used in the assessment

category
​string

Category of the assessment result (e.g. SUFFICIENTLY REGULATED, NOT SUFFICIENTLY REGULATED, MISSING)

rationale
​string

Rationale behind the assessment result (markdown formatted)

​CitationDTO[]

List of citations supporting the assessment result

CitationDTO

A citation referencing a specific passage in a source document
fileName
​string

Name of the source file

content
​string

Quoted text content of the citation

heading
​string

Section heading where the citation was found

startIndex
​integer · int32

Start character index of the citation in the extracted content

endIndex
​integer · int32

End character index of the citation in the extracted content

AssessmentFeedbackRequestDTO

Request body for submitting feedback on an assessment result
expertId
​string · required

The ID of the expert who is rating the assessment

rationalFeedback
​string · required

The feedback on the rationale provided by the expert

assessmentResponseId
​integer · int64

The ID of the assessment response being rated

categoryFeedback
​string · enum

The corrected category according to the expert

Enum values:
SUFFICIENTLY_REGULATED
NOT_SUFFICIENTLY_REGULATED
MISSING

ContentProcessingResponseDTO

Response containing the status and metadata of a content processing job
uuid
​string

Unique identifier of the content processing job

sourceType
​string · enum

Type of content source

Enum values:
FILE
URL
sourceUrl
​string

Original URL (for URL sources)

fileName
​string

Name of the processed file

status
​string · enum

Current status of the content processing job

Enum values:
PENDING
RUNNING
COMPLETED
FAILED
CANCELLED
error
​string

Error message if the job failed

createdAt
​string · date-time

Timestamp when the job was created

completedAt
​string · date-time

Timestamp when the job completed

fetchedAt
​string · date-time

Timestamp when URL content was last fetched

UrlSubmitRequestDTO

Request body for submitting a URL for content processing
url
​string

The URL to process for text extraction

BatchStatusRequestDTO

Request body for batch status check of content processing jobs
uuids
​string[]

List of content processing job UUIDs to check

On this page
  • ErrorResponse
  • FrameworkResponseDTO
  • CriterionRequestDTO
  • AssessmentRequestConfiguration
  • AssessmentsResponseDTO
  • AssessmentResponseDTO
  • CitationDTO
  • AssessmentFeedbackRequestDTO
  • ContentProcessingResponseDTO
  • UrlSubmitRequestDTO
  • BatchStatusRequestDTO