Create review with attachment
Submit a review for a specific control with file attachment(s) and return the review with stored attachments
https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}/reviews/with-filecurl --request POST \
--url 'https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}/reviews/with-file' \
--header 'Authorization: Bearer <token>' \
--form 'review=<review>' \
--form 'files=@<file>' \
--form 'description=<description>' \
--form 'isPublic=<isPublic>' \
--form 'retentionPeriod=<retentionPeriod>'const form = new FormData();
form.append("review", "<review>");
form.append("files", file); // a File or Blob
form.append("description", "<description>");
form.append("isPublic", "<isPublic>");
form.append("retentionPeriod", "<retentionPeriod>");
const response = await fetch("https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}/reviews/with-file", {
method: "POST",
headers: {
"Authorization": "Bearer <token>"
},
body: form
});
const data = await response.json();declare const file: Blob;
interface ReviewWithAttachmentsResponse {
attachments?: Record<string, unknown>[];
review?: Record<string, unknown>;
}
const form = new FormData();
form.append("review", "<review>");
form.append("files", file); // a File or Blob
form.append("description", "<description>");
form.append("isPublic", "<isPublic>");
form.append("retentionPeriod", "<retentionPeriod>");
const response = await fetch("https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}/reviews/with-file", {
method: "POST",
headers: {
"Authorization": "Bearer <token>"
},
body: form
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);
const data: ReviewWithAttachmentsResponse = await response.json();import requests
response = requests.post(
"https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}/reviews/with-file",
headers={
"Authorization": "Bearer <token>",
},
data={
"review": "<review>",
"description": "<description>",
"isPublic": "<isPublic>",
"retentionPeriod": "<retentionPeriod>",
},
files={"files": open("<file>", "rb")},
)
response.raise_for_status()
print(response.json())package main
import (
"bytes"
"fmt"
"io"
"mime/multipart"
"net/http"
"os"
"path/filepath"
)
func main() {
var body bytes.Buffer
form := multipart.NewWriter(&body)
if err := form.WriteField("review", "<review>"); err != nil {
panic(err)
}
file, err := os.Open("<file>")
if err != nil {
panic(err)
}
defer file.Close()
part, err := form.CreateFormFile("files", filepath.Base(file.Name()))
if err != nil {
panic(err)
}
if _, err := io.Copy(part, file); err != nil {
panic(err)
}
if err := form.WriteField("description", "<description>"); err != nil {
panic(err)
}
if err := form.WriteField("isPublic", "<isPublic>"); err != nil {
panic(err)
}
if err := form.WriteField("retentionPeriod", "<retentionPeriod>"); err != nil {
panic(err)
}
if err := form.Close(); err != nil {
panic(err)
}
req, err := http.NewRequest(http.MethodPost, "https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}/reviews/with-file", &body)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <token>")
req.Header.Set("Content-Type", form.FormDataContentType())
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
data, err := io.ReadAll(res.Body)
if err != nil {
panic(err)
}
fmt.Println(res.Status, string(data))
}import java.io.ByteArrayOutputStream;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
public class Example {
public static void main(String[] args) throws Exception {
String boundary = "GuardianBoundary" + System.nanoTime();
ByteArrayOutputStream form = new ByteArrayOutputStream();
form.writeBytes(("--" + boundary + "\r\nContent-Disposition: form-data; name=\"review\"\r\n\r\n<review>\r\n").getBytes(StandardCharsets.UTF_8));
Path file = Path.of("<file>");
form.writeBytes(("--" + boundary + "\r\nContent-Disposition: form-data; name=\"files\"; filename=\"" + file.getFileName() + "\"\r\n\r\n").getBytes(StandardCharsets.UTF_8));
form.writeBytes(Files.readAllBytes(file));
form.writeBytes("\r\n".getBytes(StandardCharsets.UTF_8));
form.writeBytes(("--" + boundary + "\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n<description>\r\n").getBytes(StandardCharsets.UTF_8));
form.writeBytes(("--" + boundary + "\r\nContent-Disposition: form-data; name=\"isPublic\"\r\n\r\n<isPublic>\r\n").getBytes(StandardCharsets.UTF_8));
form.writeBytes(("--" + boundary + "\r\nContent-Disposition: form-data; name=\"retentionPeriod\"\r\n\r\n<retentionPeriod>\r\n").getBytes(StandardCharsets.UTF_8));
form.writeBytes(("--" + boundary + "--\r\n").getBytes(StandardCharsets.UTF_8));
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}/reviews/with-file"))
.header("Authorization", "Bearer <token>")
.header("Content-Type", "multipart/form-data; boundary=" + boundary)
.method("POST", HttpRequest.BodyPublishers.ofByteArray(form.toByteArray()))
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}/reviews/with-file");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
using var form = new MultipartFormDataContent();
form.Add(new StringContent("<review>"), "review");
form.Add(new StreamContent(File.OpenRead("<file>")), "files", Path.GetFileName("<file>"));
form.Add(new StringContent("<description>"), "description");
form.Add(new StringContent("<isPublic>"), "isPublic");
form.Add(new StringContent("<retentionPeriod>"), "retentionPeriod");
request.Content = form;
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");<?php
$ch = curl_init('https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}/reviews/with-file');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer <token>',
],
CURLOPT_POSTFIELDS => [
'review' => '<review>',
'files' => new CURLFile('<file>'),
'description' => '<description>',
'isPublic' => '<isPublic>',
'retentionPeriod' => '<retentionPeriod>',
],
CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;require "net/http"
uri = URI("https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}/reviews/with-file")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request.set_form([
["review", "<review>"],
["files", File.open("<file>")],
["description", "<description>"],
["isPublic", "<isPublic>"],
["retentionPeriod", "<retentionPeriod>"],
], "multipart/form-data")
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"// Cargo.toml dependencies: reqwest (features "multipart"), tokio (features "full")
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let form = reqwest::multipart::Form::new()
.text("review", "<review>")
.part("files", reqwest::multipart::Part::bytes(std::fs::read("<file>")?).file_name("<file>"))
.text("description", "<description>")
.text("isPublic", "<isPublic>")
.text("retentionPeriod", "<retentionPeriod>");
let response = reqwest::Client::new()
.post("https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}/reviews/with-file")
.header("Authorization", "Bearer <token>")
.multipart(form)
.send()
.await?;
println!("{} {}", response.status(), response.text().await?);
Ok(())
}Authorizations
BearerAuth· API key in header "Authorization" — Type "Bearer" followed by a space and JWT token.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
projectIdrequired | string | Project ID, UUID (urn:uuid optional), or slug:my-project |
appliedPolicyIdrequired | string | Applied policy ID, slug:my-policy, or urn:cid:bafy... |
appliedPolicyControlIdrequired | string | Applied policy control ID, code:AC-1, or urn:cid:bafy... |
Form parameters
| Name | Type | Description |
|---|---|---|
reviewrequired | string | Review JSON string |
files | file | Attachment files |
description | string | Attachment description |
isPublic | string | Whether the file is public |
retentionPeriod | string | Retention policy |
Responses
201Created review with attachments
attachmentscore.FileAttachment[]Show properties
Array of
core.FileAttachmentassessmentDeclarationIdintegerAssessmentDeclarationID is set instead when the file belongs to an agent assessment's declaration
cidstringcontentTypestringdeclarationIdintegerdescriptionstringfileNamestringidintegerisPublicbooleanretentionExpiresstring<date-time>reviewIdintegersizeBytesintegerstoragePathstringuploadedAtstring<date-time>uploadedBystringuploadedByDidstringread-onlyVerifiable actor; uploadedBy is the label
reviewcore.ReviewA reviewer's verdict on a control, recording the outcome and any supporting evidence
Show core.Review
appliedPolicyControlIdintegerread-onlyTaken from the path on create
attachmentCidstring[]read-onlyDerived from the uploaded bytes; not stored
cidstringread-onlyAssigned by the Integrity Service
commentTypeobjectOnly used when outcome is COMMENT
Show properties
object— Only used when outcome is COMMENTcreatedAtstring<date-time>read-onlyextraobjectHashed into the CID; not stored
Show properties
Map of
stringfileAttachmentscore.FileAttachment[]read-onlyUpload via the with-file endpoint
Show properties
Array of
core.FileAttachmentassessmentDeclarationIdintegerAssessmentDeclarationID is set instead when the file belongs to an agent assessment's declaration
cidstringcontentTypestringdeclarationIdintegerdescriptionstringfileNamestringidintegerisPublicbooleanretentionExpiresstring<date-time>reviewIdintegersizeBytesintegerstoragePathstringuploadedAtstring<date-time>uploadedBystringuploadedByDidstringread-onlyVerifiable actor; uploadedBy is the label
idintegerread-onlyoutcomecore.ReviewOutcomeOne of
NON_COMPLIANTNOT_APPLICABLECOMPLIANTCOMMENTstatementstringsubjectLinestringsubmittedAtstring<date-time>read-onlysubmittedBystringDefaults to the caller identity
submittedByDidstringread-onlyVerifiable actor; submittedBy is the label
updatedAtstring<date-time>read-only
{
"attachments": [
{
"assessmentDeclarationId": 0,
"cid": "string",
"contentType": "string",
"declarationId": 0,
"description": "string",
"fileName": "string",
"id": 0,
"isPublic": true,
"retentionExpires": "2025-01-01T00:00:00Z",
"reviewId": 0,
"sizeBytes": 0,
"storagePath": "string",
"uploadedAt": "2025-01-01T00:00:00Z",
"uploadedBy": "string"
}
],
"review": {
"commentType": {},
"extra": {
"key": "string"
},
"outcome": "NON_COMPLIANT",
"statement": "string",
"subjectLine": "string",
"submittedBy": "string"
}
}400Bad request - Invalid IDs or review data
errorstring
{
"error": "Invalid request body"
}401Unauthorized - Authentication required
errorstring
{
"error": "Invalid request body"
}403Forbidden - Insufficient permissions for this review outcome
errorstring
{
"error": "Invalid request body"
}404No matching control found in applied policy
errorstring
{
"error": "Invalid request body"
}500Internal server error
errorstring
{
"error": "Invalid request body"
}