Compliance

Compliance dashboard composite

get

Composite compliance dashboard — HIPAA status, retention, credentials summary.

Aggregates compliance signals into a single dashboard view.

Permissions: admin, owner.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

Composite compliance health overview.

hipaa_statusstringRequired

retention_daysinteger · nullableRequired

legal_holdbooleanRequired

total_credentialsintegerRequired

active_credentialsintegerRequired

last_audit_exportstring · nullableRequired

generated_atstringRequired

429

Rate limited

get/v1/{workspace_id}/compliance/dashboard

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/compliance/dashboard HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "hipaa_status": "text",
  "retention_days": 1,
  "legal_hold": true,
  "total_credentials": 1,
  "active_credentials": 1,
  "last_audit_export": "text",
  "generated_at": "text"
}

HIPAA compliance evidence report

get

HIPAA compliance evidence report.

Aggregates audit statistics, retention policy, encryption status, and API key summary for the specified period. Identity-specific fields (MFA, SSO, lockout) return null pending integration.

Permissions: admin, owner.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Query parameters

report_period_daysinteger · min: 1 · max: 365Optional

Report period in days

Default: 90

Responses

200

Successful Response

application/json

generated_atstringRequired

report_period_daysintegerRequired

workspace_idstring · uuidRequired

compliance_statusstringRequired

422

Validation Error

application/json

429

Rate limited

get/v1/{workspace_id}/compliance/hipaa

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/compliance/hipaa HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "generated_at": "text",
  "report_period_days": 1,
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "audit_summary": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "retention_policy": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "encryption": {
    "ANY_ADDITIONAL_PROPERTY": true
  },
  "access_controls": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "api_key_summary": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "compliance_status": "text"
}

Access review export

get

Access review export for SOC2 attestation.

Lists all API key credentials with role, status, and activity dates. Download, review, and upload signed attestation for SOC2 compliance.

Permissions: admin, owner.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

generated_atstringRequired

workspace_idstring · uuidRequired

total_credentialsintegerRequired

jwt_credentials_notestringRequired

429

Rate limited

get/v1/{workspace_id}/compliance/access-review

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/compliance/access-review HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "generated_at": "text",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "credentials": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "total_credentials": 1,
  "jwt_credentials_note": "text"
}