Get document processing status

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

{
  "documentId": "<string>",
  "fileName": "<string>",
  "status": "<string>",
  "progressPercentage": 123,
  "totalItems": 123,
  "completedItems": 123,
  "failedItems": 123,
  "pageCount": 123,
  "childDocuments": [
    {
      "displayName": "<string>",
      "fileName": "<string>",
      "pageCount": 123
    }
  ],
  "resultSummary": {
    "averageScore": 123,
    "passedCount": 123,
    "failedCount": 123,
    "warningCount": 123
  },
  "errorMessage": "<string>",
  "processedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z"
}

Documents

Get document processing status

Get document processing status and progress.

Poll Interval: Recommended 3-5 minutes between requests.

Status Values:

New - Uploaded, not yet submitted for processing
Pending - Queued for AI processing
Processing - Currently being analyzed
Processed - Complete, call /result endpoint for full results
Failed - Error occurred, check errorMessage field

Progress Information:

progressPercentage - Completion percentage (0-100)
totalItems - Total compliance items to analyze
completedItems - Items successfully processed
failedItems - Items that failed processing

Result Summary: When status is Processed, includes summary statistics:

averageScore - Overall compliance score (0-100)
passedCount, failedCount, warningCount - Item counts by status

Billing Page Count:

pageCount - Total billing pages for the document (ceil(normalized chars / 1800)). Naturally 0 until the document is indexed.
childDocuments[] - Per-child billing breakdown for consolidated submissions. Each entry has displayName (original file name), fileName (system file name), and pageCount (billing pages for that child). Always present (empty when the document has no children); during the transition window historical children may read 0 while the parent total is correct.

GET

documents

{documentId}

status

Get document processing status

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

{
  "documentId": "<string>",
  "fileName": "<string>",
  "status": "<string>",
  "progressPercentage": 123,
  "totalItems": 123,
  "completedItems": 123,
  "failedItems": 123,
  "pageCount": 123,
  "childDocuments": [
    {
      "displayName": "<string>",
      "fileName": "<string>",
      "pageCount": 123
    }
  ],
  "resultSummary": {
    "averageScore": 123,
    "passedCount": 123,
    "failedCount": 123,
    "warningCount": 123
  },
  "errorMessage": "<string>",
  "processedAt": "2023-11-07T05:31:56Z",
  "createdAt": "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

Response

documentId

string

fileName

string

status

string

progressPercentage

number<double>

totalItems

integer<int32>

completedItems

integer<int32>

failedItems

integer<int32>

pageCount

integer<int32>

childDocuments

object[]

Show child attributes

resultSummary

object

Show child attributes

errorMessage

string | null

processedAt

string<date-time> | null

createdAt

string<date-time>

Submit documents for compliance processing Reprocess a failed or cancelled document