Skip to content
POST/api/v1/compliance/approvals

Create/transition an approval workflow

Creates a workflow or applies a state transition (draft/in_review/approved/rejected/changes_requested); each transition writes a tamper-evident audit row. role=admin.

Authentication

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

Request body required

Schema
{
  "application/json": {
    "schema": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "action": {
              "type": "string",
              "enum": [
                "create"
              ]
            },
            "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)$"
            },
            "resourceType": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            },
            "resourceId": {
              "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)$"
            },
            "title": {
              "type": "string",
              "minLength": 1,
              "maxLength": 500
            },
            "description": {
              "type": "string",
              "maxLength": 20000
            },
            "requiredApproverRoles": {
              "default": [
                "owner",
                "admin"
              ],
              "minItems": 1,
              "maxItems": 4,
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "owner",
                  "admin",
                  "member",
                  "viewer"
                ]
              }
            },
            "requiredApprovals": {
              "default": 1,
              "type": "integer",
              "minimum": 1,
              "maximum": 20
            },
            "deploymentGate": {
              "default": false,
              "type": "boolean"
            }
          },
          "required": [
            "action",
            "orgId",
            "resourceType",
            "title",
            "requiredApproverRoles",
            "requiredApprovals",
            "deploymentGate"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "action": {
              "type": "string",
              "enum": [
                "transition"
              ]
            },
            "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)$"
            },
            "workflowId": {
              "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)$"
            },
            "decision": {
              "type": "string",
              "enum": [
                "submit",
                "approve",
                "reject",
                "request_changes",
                "reopen"
              ]
            },
            "comment": {
              "type": "string",
              "maxLength": 20000
            }
          },
          "required": [
            "action",
            "orgId",
            "workflowId",
            "decision"
          ],
          "additionalProperties": false
        }
      ]
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Workflow state.
400(no description)
401(no description)
403Forbidden — insufficient role for this operation.
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/compliance/approvals \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \

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/approvals",
});
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/approvals")
print(response)

Go

package main

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

func main() {
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/compliance/approvals", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403429

Other Compliance endpoints