curl
curl -X GET "https://sandbox-api.sannos.ai/v2/documents/01ABCDOCUME/result?fields=value&complianceLevel=value" \
-H "X-API-Key: $EVE_COMPANY_KEY"const res = await fetch("https://sandbox-api.sannos.ai/v2/documents/01ABCDOCUME/result?fields=value&complianceLevel=value", {
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/result?fields=value&complianceLevel=value",
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}/result",
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}/result"
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}/result")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.sannos.ai/v2/documents/{documentId}/result")
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{
"complianceItems": [
{
"controlClusterId": "<string>",
"controlClusterName": "<string>",
"controlId": "<string>",
"controlItemId": "<string>",
"controlItemName": "<string>",
"id": "<string>",
"status": "<string>",
"controlItemExternalId": "<string>",
"controlItemObjective": "<string>",
"result": {
"explanation": {
"explanation": "<string>",
"gaps": [
{
"description": "<string>",
"pageRefs": [
{
"documentId": "<string>",
"documentName": "<string>",
"pages": [
"<string>"
]
}
],
"referenceDocumentRefs": [
{
"documentName": "<string>",
"isAvailable": true,
"label": "<string>",
"pages": [
"<string>"
],
"quote": "<string>",
"quoteVerified": true,
"referenceDocumentId": "<string>",
"section": "<string>"
}
],
"topic": "<string>"
}
],
"strength": "<string>",
"compensationControls": [
{
"title": "<string>"
}
],
"pageRefs": [
{
"documentId": "<string>",
"documentName": "<string>",
"pages": [
"<string>"
]
}
],
"referenceDocumentRefs": [
{
"documentName": "<string>",
"isAvailable": true,
"label": "<string>",
"pages": [
"<string>"
],
"quote": "<string>",
"quoteVerified": true,
"referenceDocumentId": "<string>",
"section": "<string>"
}
],
"riskIdentification": {
"riskDescription": [
{
"title": "<string>"
}
]
}
},
"recommendations": [
{
"actionableRecommendation": "<string>",
"gapIdentified": "<string>",
"referenceDocumentRefs": [
{
"documentName": "<string>",
"isAvailable": true,
"label": "<string>",
"pages": [
"<string>"
],
"quote": "<string>",
"quoteVerified": true,
"referenceDocumentId": "<string>",
"section": "<string>"
}
],
"suggestedTextLocation": "<string>",
"suggestedTextToBeAdded": "<string>"
}
],
"score": 0
},
"units": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"documentId": "<string>",
"fileName": "<string>",
"status": "<string>",
"childDocuments": [
{
"displayName": "<string>",
"fileName": "<string>",
"pageCount": 123
}
],
"pageCount": 0,
"processedAt": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}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, matched by best name similarity against
configured score bands. Provide as comma-separated or repeated parameters.
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.
GET
/
v2
/
documents
/
{documentId}
/
result
curl
curl -X GET "https://sandbox-api.sannos.ai/v2/documents/01ABCDOCUME/result?fields=value&complianceLevel=value" \
-H "X-API-Key: $EVE_COMPANY_KEY"const res = await fetch("https://sandbox-api.sannos.ai/v2/documents/01ABCDOCUME/result?fields=value&complianceLevel=value", {
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/result?fields=value&complianceLevel=value",
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}/result",
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}/result"
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}/result")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.sannos.ai/v2/documents/{documentId}/result")
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{
"complianceItems": [
{
"controlClusterId": "<string>",
"controlClusterName": "<string>",
"controlId": "<string>",
"controlItemId": "<string>",
"controlItemName": "<string>",
"id": "<string>",
"status": "<string>",
"controlItemExternalId": "<string>",
"controlItemObjective": "<string>",
"result": {
"explanation": {
"explanation": "<string>",
"gaps": [
{
"description": "<string>",
"pageRefs": [
{
"documentId": "<string>",
"documentName": "<string>",
"pages": [
"<string>"
]
}
],
"referenceDocumentRefs": [
{
"documentName": "<string>",
"isAvailable": true,
"label": "<string>",
"pages": [
"<string>"
],
"quote": "<string>",
"quoteVerified": true,
"referenceDocumentId": "<string>",
"section": "<string>"
}
],
"topic": "<string>"
}
],
"strength": "<string>",
"compensationControls": [
{
"title": "<string>"
}
],
"pageRefs": [
{
"documentId": "<string>",
"documentName": "<string>",
"pages": [
"<string>"
]
}
],
"referenceDocumentRefs": [
{
"documentName": "<string>",
"isAvailable": true,
"label": "<string>",
"pages": [
"<string>"
],
"quote": "<string>",
"quoteVerified": true,
"referenceDocumentId": "<string>",
"section": "<string>"
}
],
"riskIdentification": {
"riskDescription": [
{
"title": "<string>"
}
]
}
},
"recommendations": [
{
"actionableRecommendation": "<string>",
"gapIdentified": "<string>",
"referenceDocumentRefs": [
{
"documentName": "<string>",
"isAvailable": true,
"label": "<string>",
"pages": [
"<string>"
],
"quote": "<string>",
"quoteVerified": true,
"referenceDocumentId": "<string>",
"section": "<string>"
}
],
"suggestedTextLocation": "<string>",
"suggestedTextToBeAdded": "<string>"
}
],
"score": 0
},
"units": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"documentId": "<string>",
"fileName": "<string>",
"status": "<string>",
"childDocuments": [
{
"displayName": "<string>",
"fileName": "<string>",
"pageCount": 123
}
],
"pageCount": 0,
"processedAt": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Path Parameters
Response
Successful Response