Confirm or override file risk score
curl --request POST \
--url https://api.uk.veridox.ai/files/{fileId}/risk-score/confirm \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"confirmation_reason": "<string>"
}
'import requests
url = "https://api.uk.veridox.ai/files/{fileId}/risk-score/confirm"
payload = { "confirmation_reason": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({confirmation_reason: '<string>'})
};
fetch('https://api.uk.veridox.ai/files/{fileId}/risk-score/confirm', 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.uk.veridox.ai/files/{fileId}/risk-score/confirm",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'confirmation_reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.uk.veridox.ai/files/{fileId}/risk-score/confirm"
payload := strings.NewReader("{\n \"confirmation_reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.uk.veridox.ai/files/{fileId}/risk-score/confirm")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"confirmation_reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uk.veridox.ai/files/{fileId}/risk-score/confirm")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"confirmation_reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}Files
Confirm or Override Risk Score
Confirm the current AI-generated risk score or override it with a new value.
POST
/
files
/
{fileId}
/
risk-score
/
confirm
Confirm or override file risk score
curl --request POST \
--url https://api.uk.veridox.ai/files/{fileId}/risk-score/confirm \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"confirmation_reason": "<string>"
}
'import requests
url = "https://api.uk.veridox.ai/files/{fileId}/risk-score/confirm"
payload = { "confirmation_reason": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({confirmation_reason: '<string>'})
};
fetch('https://api.uk.veridox.ai/files/{fileId}/risk-score/confirm', 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.uk.veridox.ai/files/{fileId}/risk-score/confirm",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'confirmation_reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.uk.veridox.ai/files/{fileId}/risk-score/confirm"
payload := strings.NewReader("{\n \"confirmation_reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.uk.veridox.ai/files/{fileId}/risk-score/confirm")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"confirmation_reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uk.veridox.ai/files/{fileId}/risk-score/confirm")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"confirmation_reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}Allow users to confirm the current AI-generated risk score or override it with a new value. This endpoint allows for human-in-the-loop validation of automated findings. An optional confirmation reason can be provided to document the decision.
Best Practices
- Document Decisions: Always provide a
confirmation_reasonwhen overriding AI assessments to maintain a clear audit trail. - Review Full Analysis: Always examine the detailed findings from the Get File Analysis endpoint before confirming or changing a score.
- Wait for Completion: Risk scores can only be confirmed once the file analysis has successfully reached the
settledstatus.
Authorizations
Path Parameters
File ID
Body
application/json
Response
Risk score confirmation created successfully
The response is of type object.
Was this page helpful?
⌘I