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

content-processing-controller


Submit file for content processing

POST
https://dev-compliance-assessment.precognox.com
/api/v1/content-processing/file

Upload a document file (PDF, DOCX) for text extraction. Returns a job UUID for polling status.

Submit file for content processing › Headers

KEYCLOAK_SUBJECT
​string · uuid · required

UUID of the authenticated partner (set by the API gateway from the Keycloak access token)

Submit file for content processing › Request Body

file
​string · required

The document file to process (PDF, DOCX)

Submit file for content processing › Responses

Accepted — content processing job created. Use the Location header to poll for status.

Response containing the status and metadata of a content processing job
ContentProcessingResponseDTO
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

POST/api/v1/content-processing/file
curl --request POST \ --url https://dev-compliance-assessment.precognox.com/api/v1/content-processing/file \ --header 'Content-Type: multipart/form-data' \ --header 'KEYCLOAK_SUBJECT: <string>' \ --form file=file
shell
Example Request Body
{ "file": "file" }
json
Example Responses
{ "uuid": "uuid", "sourceType": "FILE", "sourceUrl": "sourceUrl", "fileName": "fileName", "status": "PENDING", "error": "error", "createdAt": "2024-08-25T15:00:00Z", "completedAt": "2024-08-25T15:00:00Z", "fetchedAt": "2024-08-25T15:00:00Z" }
json
application/json

Submit URL for content processing

POST
https://dev-compliance-assessment.precognox.com
/api/v1/content-processing/url

Submit a URL for web page text extraction. Returns a job UUID for polling status.

Submit URL for content processing › Headers

KEYCLOAK_SUBJECT
​string · uuid · required

UUID of the authenticated partner (set by the API gateway from the Keycloak access token)

Submit URL for content processing › Request Body

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

The URL to process for text extraction

Submit URL for content processing › Responses

Accepted — content processing job created. Use the Location header to poll for status.

Response containing the status and metadata of a content processing job
ContentProcessingResponseDTO
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

POST/api/v1/content-processing/url
curl --request POST \ --url https://dev-compliance-assessment.precognox.com/api/v1/content-processing/url \ --header 'Content-Type: application/json' \ --header 'KEYCLOAK_SUBJECT: <string>' \ --data '{ "url": "url" }'
shell
Example Request Body
{ "url": "url" }
json
Example Responses
{ "uuid": "uuid", "sourceType": "FILE", "sourceUrl": "sourceUrl", "fileName": "fileName", "status": "PENDING", "error": "error", "createdAt": "2024-08-25T15:00:00Z", "completedAt": "2024-08-25T15:00:00Z", "fetchedAt": "2024-08-25T15:00:00Z" }
json
application/json

Get content processing status

GET
https://dev-compliance-assessment.precognox.com
/api/v1/content-processing/{uuid}/status

Retrieve the current status of a content processing job. Returns 303 See Other with a Location header pointing to the content endpoint when the job is completed.

Get content processing status › path Parameters

uuid
​string · required

Unique identifier of the content processing job

Get content processing status › Headers

KEYCLOAK_SUBJECT
​string · uuid · required

UUID of the authenticated partner (set by the API gateway from the Keycloak access token)

Get content processing status › Responses

OK — job is still in progress

Response containing the status and metadata of a content processing job
ContentProcessingResponseDTO
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

GET/api/v1/content-processing/{uuid}/status
curl --request GET \ --url https://dev-compliance-assessment.precognox.com/api/v1/content-processing/:uuid/status \ --header 'KEYCLOAK_SUBJECT: <string>'
shell
Example Responses
{ "uuid": "uuid", "sourceType": "FILE", "sourceUrl": "sourceUrl", "fileName": "fileName", "status": "PENDING", "error": "error", "createdAt": "2024-08-25T15:00:00Z", "completedAt": "2024-08-25T15:00:00Z", "fetchedAt": "2024-08-25T15:00:00Z" }
json
application/json

Batch status check

POST
https://dev-compliance-assessment.precognox.com
/api/v1/content-processing/status/batch

Retrieve the status of multiple content processing jobs at once.

Batch status check › Headers

KEYCLOAK_SUBJECT
​string · uuid · required

UUID of the authenticated partner (set by the API gateway from the Keycloak access token)

Batch status check › Request Body

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

List of content processing job UUIDs to check

Batch status check › Responses

200

OK

​ContentProcessingResponseDTO[]
Response containing the status and metadata of a content processing job
ContentProcessingResponseDTO
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

POST/api/v1/content-processing/status/batch
curl --request POST \ --url https://dev-compliance-assessment.precognox.com/api/v1/content-processing/status/batch \ --header 'Content-Type: application/json' \ --header 'KEYCLOAK_SUBJECT: <string>' \ --data ' { "uuids": [ "string" ] } '
shell
Example Request Body
{ "uuids": [ "string" ] }
json
Example Responses
[ { "uuid": "uuid", "sourceType": "FILE", "sourceUrl": "sourceUrl", "fileName": "fileName", "status": "PENDING", "error": "error", "createdAt": "2024-08-25T15:00:00Z", "completedAt": "2024-08-25T15:00:00Z", "fetchedAt": "2024-08-25T15:00:00Z" } ]
json
application/json

Get extracted content

GET
https://dev-compliance-assessment.precognox.com
/api/v1/content-processing/{uuid}/content

Retrieve the extracted text content of a completed content processing job.

Get extracted content › path Parameters

uuid
​string · required

Unique identifier of the content processing job

Get extracted content › Headers

KEYCLOAK_SUBJECT
​string · uuid · required

UUID of the authenticated partner (set by the API gateway from the Keycloak access token)

Get extracted content › Responses

OK — extracted text content

string
GET/api/v1/content-processing/{uuid}/content
curl --request GET \ --url https://dev-compliance-assessment.precognox.com/api/v1/content-processing/:uuid/content \ --header 'KEYCLOAK_SUBJECT: <string>'
shell
Example Responses
string
text
text/plain

Cancel content processing

DELETE
https://dev-compliance-assessment.precognox.com
/api/v1/content-processing/{uuid}

Cancel and delete a content processing job.

Cancel content processing › path Parameters

uuid
​string · required

Unique identifier of the content processing job

Cancel content processing › Headers

KEYCLOAK_SUBJECT
​string · uuid · required

UUID of the authenticated partner (set by the API gateway from the Keycloak access token)

Cancel content processing › Responses

OK — content processing job cancelled

No data returned
DELETE/api/v1/content-processing/{uuid}
curl --request DELETE \ --url https://dev-compliance-assessment.precognox.com/api/v1/content-processing/:uuid \ --header 'KEYCLOAK_SUBJECT: <string>'
shell
Example Responses
No example specified for this content type

Refresh content processing

POST
https://dev-compliance-assessment.precognox.com
/api/v1/content-processing/{uuid}/refresh

Re-trigger content processing for a previously submitted job. Useful for retrying failed jobs or refreshing stale content.

Refresh content processing › path Parameters

uuid
​string · required

Unique identifier of the content processing job

Refresh content processing › Headers

KEYCLOAK_SUBJECT
​string · uuid · required

UUID of the authenticated partner (set by the API gateway from the Keycloak access token)

Refresh content processing › Responses

Accepted — content processing job refreshed. Use the Location header to poll for status.

Response containing the status and metadata of a content processing job
ContentProcessingResponseDTO
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

POST/api/v1/content-processing/{uuid}/refresh
curl --request POST \ --url https://dev-compliance-assessment.precognox.com/api/v1/content-processing/:uuid/refresh \ --header 'KEYCLOAK_SUBJECT: <string>'
shell
Example Responses
{ "uuid": "uuid", "sourceType": "FILE", "sourceUrl": "sourceUrl", "fileName": "fileName", "status": "PENDING", "error": "error", "createdAt": "2024-08-25T15:00:00Z", "completedAt": "2024-08-25T15:00:00Z", "fetchedAt": "2024-08-25T15:00:00Z" }
json
application/json

assessment-feedback-controller