Sovereign OS Compliance iPaaS API — OpenAPI 1.0.0
<!-- GENERATED by scripts/render-platform-map-api-docs.mjs — do not hand-edit; edit apps/agent-bff/openapi/<spec>.json and re-run. --> Scope: The published reference for Sovereign OS Compliance iPaaS API. 5 paths — the measured spec-vs-implementation coverage lives in the complete API inventory. Status: rendered 2026-11-09 from the OpenAPI source for Sovereign OS Compliance iPaaS API — regenerate with node scripts/render-platform-map-api-docs.mjs. See also: the OpenAPI spec index.
Servers
| URL | Notes |
|---|---|
| http://localhost:3030 | Agent BFF (local development) |
Paths — 5 paths / 5 operations
| Method | Path | Operation ID | Summary |
|---|---|---|---|
| POST | /v1/compliance/workflow/start | — | Start a compliance workflow |
| POST | /v1/compliance/workflow/callback | — | Receive FSM callback |
| GET | /v1/compliance/workflow/{bindingId} | — | Get workflow status |
| GET | /v1/compliance/workflows | — | List active compliance workflows |
| POST | /v1/compliance/webhook/{source} | — | Generic webhook ingress |
Operations
POST /v1/compliance/workflow/start
Summary: Start a compliance workflow Description: Initiates a new compliance workflow instance (EUDR, CBAM, VCM, etc.)
Tags: Compliance Workflows Request body:
Content type: application/json
| Field | Type | Notes |
|---|---|---|
| fsm_type | string | FSM definition type (e.g., eudr:compliance:v1, cbam:mrv:v1) |
| resource_id | string | Resource ID to bind the workflow to |
| caller_id | string | Identity of the caller |
| metadata | object | Additional workflow metadata |
Responses:
| Status | Meaning |
|---|---|
| 200 | Workflow started successfully |
| 400 | Missing required fields |
| 404 | FSM definition not found |
POST /v1/compliance/workflow/callback
Summary: Receive FSM callback Description: Async callback from compliance workers to advance FSM state
Tags: Compliance Workflows Request body:
Content type: application/json
| Field | Type | Notes |
|---|---|---|
| binding_id | string | |
| event | string | |
| caller_id | string | |
| metadata | object |
Responses:
| Status | Meaning |
|---|---|
| 200 | Callback processed |
| 404 | Binding not found |
GET /v1/compliance/workflow/{bindingId}
Summary: Get workflow status Description: Retrieve current state and metadata of a compliance workflow
Tags: Compliance Workflows
Parameters:
| Name | In | Required | Type | Notes |
|---|---|---|---|---|
| bindingId | path | yes | string |
Responses:
| Status | Meaning |
|---|---|
| 200 | Workflow status |
| 404 | Binding not found |
GET /v1/compliance/workflows
Summary: List active compliance workflows Description: List all active compliance workflow instances
Tags: Compliance Workflows
Parameters:
| Name | In | Required | Type | Notes |
|---|---|---|---|---|
| fsm_type | query | no | string | Filter by FSM type |
| limit | query | no | int |
Responses:
| Status | Meaning |
|---|---|
| 200 | List of workflows |
POST /v1/compliance/webhook/{source}
Summary: Generic webhook ingress Description: Receive webhooks from external compliance systems
Tags: Webhooks
Parameters:
| Name | In | Required | Type | Notes |
|---|---|---|---|---|
| source | path | yes | string | Source system identifier |
Request body:
Content type: application/json
| Field | Type | Notes |
|---|---|---|
| (scalar body) | object |
Responses:
| Status | Meaning |
|---|---|
| 200 | Webhook processed |
| 400 | Invalid webhook payload |
Full specification — verbatim source of truth
{
"openapi": "3.0.3",
"info": {
"title": "Sovereign OS Compliance iPaaS API",
"description": "Compliance workflow management, document generation, and regulatory reporting endpoints.",
"version": "1.0.0",
"contact": {
"name": "Sovereign OS Platform"
}
},
"servers": [
{
"url": "http://localhost:3030",
"description": "Agent BFF (local development)"
}
],
"paths": {
"/v1/compliance/workflow/start": {
"post": {
"summary": "Start a compliance workflow",
"description": "Initiates a new compliance workflow instance (EUDR, CBAM, VCM, etc.)",
"tags": [
"Compliance Workflows"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"fsm_type"
],
"properties": {
"fsm_type": {
"type": "string",
"description": "FSM definition type (e.g., eudr:compliance:v1, cbam:mrv:v1)",
"example": "eudr:compliance:v1"
},
"resource_id": {
"type": "string",
"description": "Resource ID to bind the workflow to"
},
"caller_id": {
"type": "string",
"description": "Identity of the caller"
},
"metadata": {
"type": "object",
"description": "Additional workflow metadata"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Workflow started successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"binding_id": {
"type": "string"
},
"fsm_type": {
"type": "string"
},
"initial_state": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
}
}
}
},
"400": {
"description": "Missing required fields"
},
"404": {
"description": "FSM definition not found"
}
}
}
},
"/v1/compliance/workflow/callback": {
"post": {
"summary": "Receive FSM callback",
"description": "Async callback from compliance workers to advance FSM state",
"tags": [
"Compliance Workflows"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"binding_id",
"event"
],
"properties": {
"binding_id": {
"type": "string"
},
"event": {
"type": "string"
},
"caller_id": {
"type": "string"
},
"metadata": {
"type": "object"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Callback processed"
},
"404": {
"description": "Binding not found"
}
}
}
},
"/v1/compliance/workflow/{bindingId}": {
"get": {
"summary": "Get workflow status",
"description": "Retrieve current state and metadata of a compliance workflow",
"tags": [
"Compliance Workflows"
],
"parameters": [
{
"name": "bindingId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Workflow status",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"binding_id": {
"type": "string"
},
"current_state": {
"type": "string"
},
"fsm_type": {
"type": "string"
},
"metadata": {
"type": "object"
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
}
}
}
},
"404": {
"description": "Binding not found"
}
}
}
},
"/v1/compliance/workflows": {
"get": {
"summary": "List active compliance workflows",
"description": "List all active compliance workflow instances",
"tags": [
"Compliance Workflows"
],
"parameters": [
{
"name": "fsm_type",
"in": "query",
"schema": {
"type": "string"
},
"description": "Filter by FSM type"
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"default": 50
}
}
],
"responses": {
"200": {
"description": "List of workflows",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"workflows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"binding_id": {
"type": "string"
},
"current_state": {
"type": "string"
},
"fsm_type": {
"type": "string"
}
}
}
},
"count": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"/v1/compliance/webhook/{source}": {
"post": {
"summary": "Generic webhook ingress",
"description": "Receive webhooks from external compliance systems",
"tags": [
"Webhooks"
],
"parameters": [
{
"name": "source",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Source system identifier"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Webhook processed"
},
"400": {
"description": "Invalid webhook payload"
}
}
}
}
},
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
},
"security": [
{
"bearerAuth": []
}
]
}