Skip to content
UltimateTeam.ai Docs

Real-time SOC 2 control status

GET
/api/v1/compliance/soc2/status
curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/compliance/soc2/status \
  --header 'X-API-Key: <X-API-Key>'

Returns the most recent evidence status for every SOC 2 control (37 controls across 5 trust principles) plus aggregate counts and the latest hash chain verification result.

Authorizations

Section titled “Authorizations”

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
ComplianceStatusEnvelope

Typed envelope for GET /api/v1/compliance/soc2/status.

object
data
required
ComplianceStatusResponse

Response body for GET /api/v1/compliance/soc2/status.

object
controls
Controls
Array<object>
SOC2ControlStatus

One row in the SOC 2 dashboard table.

Attributes: id: Canonical control id (e.g. SEC-CC-01). trust_principle: One of Security, Availability, Processing Integrity, Confidentiality, Privacy. status: Current operational status of the control’s evidence. last_collected: ISO timestamp of the most recent evidence upload. last_entry_hash: 64-char hex digest of the latest hash chain entry. evidence_excerpt: Trimmed stdout/stderr from the latest run.

object
evidence_excerpt
Any of:
string
id
required
Id

Canonical control id

string
last_collected
Any of:
string
last_entry_hash
Any of:
string
status
required
Status

Operational status

string
Allowed values: passing failing stale no_data
trust_principle
required
Trust Principle

SOC 2 Trust Services Criterion

string
summary
required
SOC2StatusSummary

Aggregate counts for the SOC 2 status snapshot.

object
by_principle
By Principle

Per-principle status counts

object
key
additional properties
SOC2PrincipleSummary

Pass/fail counts grouped by trust principle.

object
failing
Failing
integer
0
no_data
No Data
integer
0
passing
Passing
integer
0
stale
Stale
integer
0
expected_total
required
Expected Total

Expected control count from controls-mapping.md

integer
failing
Failing
integer
0
hash_chain_verified
Hash Chain Verified

Whether the recent hash chain window verifies cleanly

boolean
latest_collection_at
Any of:
string
no_data
No Data
integer
0
passing
Passing
integer
0
stale
Stale
integer
0
total_controls
required
Total Controls

Total number of controls (37)

integer
meta
required
ResponseMeta

Standard metadata attached to every API response.

object
request_id
required
Request Id

Unique request identifier

string
timestamp
required
Timestamp

Server timestamp of the response

string format: date-time
Example
{
  "data": {
    "controls": [
      {
        "status": "passing"
      }
    ],
    "summary": {
      "by_principle": {
        "additionalProperty": {
          "failing": 0,
          "no_data": 0,
          "passing": 0,
          "stale": 0
        }
      },
      "failing": 0,
      "hash_chain_verified": false,
      "no_data": 0,
      "passing": 0,
      "stale": 0
    }
  }
}