Skip to content
POST/api/v1/compliance

Run a compliance check

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/api-keys.

Request body required

Example

{
  "orgId": "00000000-0000-0000-0000-000000000000",
  "framework": "string",
  "systemName": "string",
  "riskLevel": "minimal",
  "checklist": [
    {}
  ]
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "orgId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "framework": {
          "type": "string",
          "minLength": 1,
          "maxLength": 120
        },
        "systemName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "riskLevel": {
          "type": "string",
          "enum": [
            "minimal",
            "limited",
            "high",
            "unacceptable"
          ]
        },
        "checklist": {
          "maxItems": 500,
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": {}
          }
        }
      },
      "required": [
        "orgId",
        "framework",
        "systemName"
      ],
      "additionalProperties": false
    }
  }
}

Response

All status codes

201Compliance check result

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/compliance \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "orgId": "00000000-0000-0000-0000-000000000000", "framework": "string", "systemName": "string", "riskLevel": "minimal", "checklist": [ {} ] }'

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "POST",
  path: "/api/v1/compliance",
  body: {
    "orgId": "00000000-0000-0000-0000-000000000000",
    "framework": "string",
    "systemName": "string",
    "riskLevel": "minimal",
    "checklist": [
      {}
    ]
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="POST",
    path="/api/v1/compliance",
    body={
    "orgId": "00000000-0000-0000-0000-000000000000",
    "framework": "string",
    "systemName": "string",
    "riskLevel": "minimal",
    "checklist": [
        {}
    ]
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"orgId":"00000000-0000-0000-0000-000000000000","framework":"string","systemName":"string","riskLevel":"minimal","checklist":[{}]}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/compliance", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Other Compliance endpoints