Receipt Controls

For one receipt (tenant-scoped), the framework control IDs each of its checks satisfies under the in-force pack. Optional ?framework filters to one.

GET /v1/compliance/receipts/{id}/controls

Controls a receipt’s checks satisfy

cURL

curl --request GET \
  --url https://api.example.com/v1/compliance/receipts/{id}/controls \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/v1/compliance/receipts/{id}/controls"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/compliance/receipts/{id}/controls', 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/v1/compliance/receipts/{id}/controls",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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/v1/compliance/receipts/{id}/controls"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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/v1/compliance/receipts/{id}/controls")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/compliance/receipts/{id}/controls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "receiptId": "018f1234-5678-7abc-def0-123456789abc",
  "receiptPackVersion": "v1",
  "checks": [
    {
      "name": "policy",
      "result": "allow"
    }
  ],
  "verified": true,
  "frameworks": [
    {
      "framework": "eu_ai_act",
      "resolution": "stamped",
      "controls": [
        {
          "id": "eu_ai_act:art_12",
          "title": "Record-keeping — automatic logging of events",
          "coverage": "enforced",
          "check": "GUARDRAIL",
          "result": "PASS"
        }
      ],
      "version": "v1",
      "disclaimer": "<string>",
      "packHash": "b7e1c2f4a8d6e0f3c1a9b5d7e2f4a6c8d0b2e4f6a8c0d2e4f6a8c0d2e4f6a8c0"
    }
  ],
  "note": null
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

receipt_id (UUID)

Query Parameters

framework · string

Example:

"eu_ai_act"

Response

200

application/json

receiptId · string · required

Example:

"018f1234-5678-7abc-def0-123456789abc"

receiptPackVersion · string · required

The compliance pack-set version stamped on the receipt at emit time (unsigned side channel). Empty string when unstamped (old receipt or WARDIN_COMPLIANCE_PACK_VERSION unset). Per-framework resolution says whether this stamp resolved to a known pack.

Example:

"v1"

checks · object[] · required

Show child attributes

verified · boolean · required

Whether the receipt’s ED25519 signature cryptographically verified.

Example:

true

frameworks · object[] · required

Show child attributes

note · string | null

Caveat surfaced when verified is false; null when the receipt verified.

Example:

null