Skip to content

Get Resource Compliance

GET
/compliance/resources/{resourceId}

Computes the compliance status for each obligation of a specific Resource. For each Action the Resource must fulfill, returns the status: compliant (valid certificate exists), expiring (certificate expires within thresholdDays), or non_compliant (no valid certificate). Includes the latest certificate if any. Compliance is computed at query time, never persisted.

resourceId
required
string
thresholdDays
required
number
X-Space-Id
required
string format: uuid

UUID of the target Space (tenant boundary). Validated against user access.

Array<object>
object
action
required

The action this obligation relates to

object
actionId
required

Action ID

string format: uuid
Example
660e8400-e29b-41d4-a716-446655440000
name
required

Action name

string
Example
Fire safety training
type
required

Action type

string
Allowed values: training health check ppe maintenance
Example
training
targetResourceType
required

Target resource type

string
Allowed values: person equipment environment substance
Example
person
validityValue
required

Validity duration value

number
Example
5
validityUnit
required

Validity duration unit

string
Allowed values: year month day
Example
year
status
required

Compliance status

string
Allowed values: compliant expiring non_compliant
Example
compliant
certificate

Latest certificate (if any)

object
id
required

Certificate ID

string format: uuid
Example
880e8400-e29b-41d4-a716-446655440000
name
required

Certificate name

string
Example
Fire safety certificate 2026
issuedAt
required

Issue date (ISO 8601)

string
Example
2026-01-15
expiresAt
required

Expiration date (ISO 8601)

string
Example
2031-01-15

Unauthorized — missing or invalid JWT

Forbidden — insufficient permissions

Resource not found