Get document compliance results

curl --request GET \
  --url http://localhost/v1/documents/{documentId}/result \
  --header 'X-API-Key: <api-key>'

{
  "documentId": "<string>",
  "fileName": "<string>",
  "status": "<string>",
  "pageCount": 123,
  "childDocuments": [
    {
      "displayName": "<string>",
      "fileName": "<string>",
      "pageCount": 123
    }
  ],
  "complianceItems": [
    {
      "id": "<string>",
      "controlItemId": "<string>",
      "controlItemName": "<string>",
      "controlClusterId": "<string>",
      "controlId": "<string>",
      "controlClusterName": "<string>",
      "controlItemObjective": "<string>",
      "controlItemExternalId": "<string>",
      "status": "<string>",
      "units": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "result": {
        "score": 123,
        "explanation": {
          "strength": "<string>",
          "gaps": [
            {
              "topic": "<string>",
              "description": "<string>",
              "pageRefs": [
                {
                  "documentId": "<string>",
                  "pages": [
                    "<string>"
                  ],
                  "documentName": "<string>"
                }
              ]
            }
          ],
          "explanation": "<string>",
          "pageRefs": [
            {
              "documentId": "<string>",
              "pages": [
                "<string>"
              ],
              "documentName": "<string>"
            }
          ],
          "riskIdentification": {
            "riskDescription": [
              {
                "title": "<string>"
              }
            ]
          },
          "compensationControls": [
            {
              "title": "<string>"
            }
          ]
        },
        "recommendations": [
          {
            "gapIdentified": "<string>",
            "actionableRecommendation": "<string>",
            "suggestedTextLocation": "<string>",
            "suggestedTextToBeAdded": "<string>"
          }
        ]
      }
    }
  ],
  "processedAt": "2023-11-07T05:31:56Z"
}

Documents

Get document compliance results

Get compliance analysis results for a processed document.

Prerequisites: Document status must be Processed. Call /status first to verify.

Compliance Level Filter: Use the complianceLevel query parameter to filter items by their score level. Multiple values are supported — items matching any of the specified levels are returned.

Accepted values (matched by best name similarity against configured score bands):

Not Compliant
Partially Compliant
Mostly Compliant
Fully Compliant

Multiple values — two formats supported:

Comma-separated: ?complianceLevel=Not Compliant,Partially Compliant
Repeated parameter: ?complianceLevel=Not Compliant&complianceLevel=Partially Compliant

Omit complianceLevel to return all items regardless of score.

Field Selection: Use the fields query parameter to return only specific fields. Accepts comma-separated dot-notation paths. Omit fields to return the full response.

Available field paths:

Top-level:

documentId
fileName
status
pageCount
processedAt
complianceItems
childDocuments

Per child document (childDocuments.*):

childDocuments.displayName
childDocuments.fileName
childDocuments.pageCount

Per compliance item (complianceItems.*):

complianceItems.id
complianceItems.controlItemId
complianceItems.controlItemName
complianceItems.controlClusterId
complianceItems.controlClusterName
complianceItems.controlItemObjective
complianceItems.controlItemExternalId
complianceItems.status
complianceItems.units.name — schema column name (e.g. “Category”)
complianceItems.units.value — schema column value (e.g. “CC1”)
complianceItems.result.score — compliance score 0–100
complianceItems.result.explanation.strength
complianceItems.result.explanation.explanation
complianceItems.result.explanation.gaps.topic
complianceItems.result.explanation.gaps.description
complianceItems.result.explanation.gaps.pageRefs.documentId
complianceItems.result.explanation.gaps.pageRefs.pages
complianceItems.result.explanation.gaps.pageRefs.documentName
complianceItems.result.explanation.pageRefs.documentId
complianceItems.result.explanation.pageRefs.pages
complianceItems.result.explanation.pageRefs.documentName
complianceItems.result.explanation.riskIdentification.riskDescription.title
complianceItems.result.explanation.compensationControls.title
complianceItems.result.recommendations.gapIdentified
complianceItems.result.recommendations.actionableRecommendation
complianceItems.result.recommendations.suggestedTextLocation
complianceItems.result.recommendations.suggestedTextToBeAdded

Examples:

?fields=documentId,status,complianceItems.controlItemName,complianceItems.result.score — minimal with scores
?fields=documentId,complianceItems.id,complianceItems.result.recommendations — IDs with recommendations
?fields=documentId,complianceItems.result.explanation.gaps — only gaps

Dot notation traverses nested objects and arrays automatically.

Response includes:

documentId - Unique identifier of the document
fileName - Original file name
status - Processing status (should be Processed)
pageCount - Total billing pages (ceil(normalized chars / 1800)); 0 until indexed
childDocuments[] - Per-child billing breakdown for consolidated submissions (displayName, fileName, pageCount); empty when no children
processedAt - Timestamp when processing completed (UTC)
complianceItems[] - Complete list of compliance items analyzed with per-item results

Compliance Item Results: Each item includes:

controlItemId, controlItemName - Control being evaluated
controlClusterId, controlClusterName - Parent control cluster
controlItemObjective - Objective of the control item
controlItemExternalId - External ID (e.g., CC1.1)
units[] - Schema key/value pairs (name, value)
status - Processing status for this item
result - Detailed analysis when available

Result Details:

result.score - Compliance score (0-100)
result.explanation.explanation - AI-generated analysis
result.explanation.strength - What the document does well
result.explanation.gaps[] - Missing or weak areas (topic, description, pageRefs with documentId, documentName, pages)
result.explanation.pageRefs[] - Page references (documentId, documentName, pages)
result.explanation.riskIdentification.riskDescription[] - Identified risks (title)
result.explanation.compensationControls[] - Compensation controls (title)
result.recommendations[] - Improvements (gapIdentified, actionableRecommendation, suggestedTextLocation, suggestedTextToBeAdded)

GET

documents

{documentId}

result

Get document compliance results

curl --request GET \
  --url http://localhost/v1/documents/{documentId}/result \
  --header 'X-API-Key: <api-key>'

{
  "documentId": "<string>",
  "fileName": "<string>",
  "status": "<string>",
  "pageCount": 123,
  "childDocuments": [
    {
      "displayName": "<string>",
      "fileName": "<string>",
      "pageCount": 123
    }
  ],
  "complianceItems": [
    {
      "id": "<string>",
      "controlItemId": "<string>",
      "controlItemName": "<string>",
      "controlClusterId": "<string>",
      "controlId": "<string>",
      "controlClusterName": "<string>",
      "controlItemObjective": "<string>",
      "controlItemExternalId": "<string>",
      "status": "<string>",
      "units": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "result": {
        "score": 123,
        "explanation": {
          "strength": "<string>",
          "gaps": [
            {
              "topic": "<string>",
              "description": "<string>",
              "pageRefs": [
                {
                  "documentId": "<string>",
                  "pages": [
                    "<string>"
                  ],
                  "documentName": "<string>"
                }
              ]
            }
          ],
          "explanation": "<string>",
          "pageRefs": [
            {
              "documentId": "<string>",
              "pages": [
                "<string>"
              ],
              "documentName": "<string>"
            }
          ],
          "riskIdentification": {
            "riskDescription": [
              {
                "title": "<string>"
              }
            ]
          },
          "compensationControls": [
            {
              "title": "<string>"
            }
          ]
        },
        "recommendations": [
          {
            "gapIdentified": "<string>",
            "actionableRecommendation": "<string>",
            "suggestedTextLocation": "<string>",
            "suggestedTextToBeAdded": "<string>"
          }
        ]
      }
    }
  ],
  "processedAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key

string

header

required

API Key provided by Eve Admin Portal. Include this header in all authenticated requests.

Path Parameters

documentId

string

required

Query Parameters

fields

string | null

complianceLevel

string | null

Response

documentId

string

fileName

string

status

string

pageCount

integer<int32>

childDocuments

object[]

Show child attributes

complianceItems

object[]

Show child attributes

processedAt

string<date-time> | null

Reprocess a failed or cancelled document Get v1controlsitems