Get compliance results for a specific document
curl --request GET \
--url https://api.example.com/policies/{policyId}/documents/compliance/{documentId}import requests
url = "https://api.example.com/policies/{policyId}/documents/compliance/{documentId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/policies/{policyId}/documents/compliance/{documentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/policies/{policyId}/documents/compliance/{documentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://api.example.com/policies/{policyId}/documents/compliance/{documentId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/policies/{policyId}/documents/compliance/{documentId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/policies/{policyId}/documents/compliance/{documentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"documentId": "<string>",
"results": [
{
"passed": true,
"message": "<string>",
"metadata": {}
}
],
"aiMetadata": {},
"checkedAt": "<string>",
"override": {
"overriddenBy": "<string>",
"overriddenAt": "<string>",
"previousStatus": "<string>",
"originalStatus": "<string>"
}
}{
"title": "DOCUMENT_COMPLIANCE_FAILED"
}document-compliance
Get compliance results for a specific document
GET
/
policies
/
{policyId}
/
documents
/
compliance
/
{documentId}
Get compliance results for a specific document
curl --request GET \
--url https://api.example.com/policies/{policyId}/documents/compliance/{documentId}import requests
url = "https://api.example.com/policies/{policyId}/documents/compliance/{documentId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/policies/{policyId}/documents/compliance/{documentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/policies/{policyId}/documents/compliance/{documentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://api.example.com/policies/{policyId}/documents/compliance/{documentId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/policies/{policyId}/documents/compliance/{documentId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/policies/{policyId}/documents/compliance/{documentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"documentId": "<string>",
"results": [
{
"passed": true,
"message": "<string>",
"metadata": {}
}
],
"aiMetadata": {},
"checkedAt": "<string>",
"override": {
"overriddenBy": "<string>",
"overriddenAt": "<string>",
"previousStatus": "<string>",
"originalStatus": "<string>"
}
}{
"title": "DOCUMENT_COMPLIANCE_FAILED"
}Response
Document ID
Overall compliance status
Available options:
PENDING, COMPLIANT, NON_COMPLIANT, FAILED, SKIPPED Results for each compliance rule
Show child attributes
Show child attributes
AI compliance metadata
Last check timestamp
Override metadata if compliance was manually overridden
Show child attributes
Show child attributes
Was this page helpful?
⌘I

