curl
curl -X GET "https://sandbox-api.sannos.ai/v2/documents/01ABCDOCUME/status" \
-H "X-API-Key: $EVE_COMPANY_KEY"const res = await fetch("https://sandbox-api.sannos.ai/v2/documents/01ABCDOCUME/status", {
method: "GET",
headers: { "X-API-Key": process.env.EVE_COMPANY_KEY },
});
const data = await res.json();import os, requests
res = requests.get(
"https://sandbox-api.sannos.ai/v2/documents/01ABCDOCUME/status",
headers={"X-API-Key": os.environ["EVE_COMPANY_KEY"]},
)
data = res.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.sannos.ai/v2/documents/{documentId}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox-api.sannos.ai/v2/documents/{documentId}/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox-api.sannos.ai/v2/documents/{documentId}/status")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.sannos.ai/v2/documents/{documentId}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"createdAt": "2023-11-07T05:31:56Z",
"documentId": "<string>",
"fileName": "<string>",
"status": "<string>",
"childDocuments": [
{
"displayName": "<string>",
"fileName": "<string>",
"pageCount": 123
}
],
"completedItems": 0,
"errorMessage": "<string>",
"failedItems": 0,
"pageCount": 0,
"processedAt": "2023-11-07T05:31:56Z",
"progressPercentage": 0,
"resultSummary": {
"averageScore": 123,
"failedCount": 0,
"passedCount": 0,
"warningCount": 0
},
"totalItems": 0
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}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 processingPending- Queued for AI processingProcessing- Currently being analyzedProcessed- Complete, call/resultendpoint for full resultsFailed- Error occurred, checkerrorMessagefield
Progress Information:
progressPercentage- Completion percentage (0-100)totalItems- Total compliance items to analyzecompletedItems- Items successfully processedfailedItems- 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.
GET
/
v2
/
documents
/
{documentId}
/
status
curl
curl -X GET "https://sandbox-api.sannos.ai/v2/documents/01ABCDOCUME/status" \
-H "X-API-Key: $EVE_COMPANY_KEY"const res = await fetch("https://sandbox-api.sannos.ai/v2/documents/01ABCDOCUME/status", {
method: "GET",
headers: { "X-API-Key": process.env.EVE_COMPANY_KEY },
});
const data = await res.json();import os, requests
res = requests.get(
"https://sandbox-api.sannos.ai/v2/documents/01ABCDOCUME/status",
headers={"X-API-Key": os.environ["EVE_COMPANY_KEY"]},
)
data = res.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.sannos.ai/v2/documents/{documentId}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox-api.sannos.ai/v2/documents/{documentId}/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox-api.sannos.ai/v2/documents/{documentId}/status")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.sannos.ai/v2/documents/{documentId}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"createdAt": "2023-11-07T05:31:56Z",
"documentId": "<string>",
"fileName": "<string>",
"status": "<string>",
"childDocuments": [
{
"displayName": "<string>",
"fileName": "<string>",
"pageCount": 123
}
],
"completedItems": 0,
"errorMessage": "<string>",
"failedItems": 0,
"pageCount": 0,
"processedAt": "2023-11-07T05:31:56Z",
"progressPercentage": 0,
"resultSummary": {
"averageScore": 123,
"failedCount": 0,
"passedCount": 0,
"warningCount": 0
},
"totalItems": 0
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Path Parameters
Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes