Skip to main content

List Key Controls

Endpoint

GET /api/v1/controls/key-controls

Query Parameters

ParameterTypeDescription
archivedbooleanInclude archived controls (default: false)
pageintegerPage number
page_sizeintegerItems per page

Response

{
  "data": [
    {
      "id": "kc-uuid-001",
      "name": "Automated Credit Scoring and Risk Rating",
      "description": "Standardized credit scoring using bureau data",
      "archived": false,
      "created_at": "2026-01-01T00:00:00Z",
      "sub_controls": [
        {
          "id": "sc-uuid-001",
          "name": "Bureau Data Verification",
          "tod": "B",
          "toe": "2",
          "total_effectiveness": "Effective"
        },
        {
          "id": "sc-uuid-002",
          "name": "Income Verification",
          "tod": "A",
          "toe": "1",
          "total_effectiveness": "Highly Effective"
        }
      ]
    }
  ],
  "pagination": { ... }
}

List Sub-Controls

Endpoint

GET /api/v1/controls/sub-controls

Query Parameters

ParameterTypeDescription
key_control_idUUIDFilter by parent key control
archivedbooleanInclude archived (default: false)

Response

{
  "data": [
    {
      "id": "sc-uuid-001",
      "key_control_id": "kc-uuid-001",
      "name": "Bureau Data Verification",
      "description": "Verification of credit bureau data",
      "tod": "B",
      "toe": "2",
      "total_effectiveness": "Effective",
      "testing_date": "2026-01-10",
      "tested_by": "John Smith",
      "archived": false
    }
  ]
}