---
title: "API Documentation"
account: beis
slug: api-documentation
---

# API Documentation

- Operations: 207
- Versions: 15 (latest `f5f4d893b86b`)
- Source: https://raw.githubusercontent.com/UKGovernmentBEIS/CCA/main/uk-cca-app-web/projects/cca-api/src/assets/swagger.yaml
- OpenAPI document: https://skmtc-service-production.skmtc.workers.dev/v1/apis/beis/api-documentation/revisions/f5f4d893b86b/schema

## Operations

207 in total, by tag:

- Target Period Performance Data Report of the Account (4)
- Sector Users registration (3)
- Request Notes (7)
- Regulator users registration (2)
- Operator users registration (3)
- Notification Templates (3)
- Mi Reports User defined (7)
- Target Period Performance Data Report of the Facility (4)
- Facility Audit Controller (2)
- Account Notes (7)
- Validate Password (1)
- Users Security Setup (2)
- Forgot Password (3)
- Users (3)
- Tasks (5)
- Tasks Assignment (3)
- Request task attachments handling (2)
- Buy-out and surplus info (7)
- Subsistence fees run info view (3)
- Subsistence fees MoA view (4)
- Subsistence fees MoA received amount controller (3)
- Subsistence fees MoA target unit view (3)
- Subsector association scheme details update (1)
- Sector Users invitation (1)
- Sector association scheme details update (2)
- Sector scheme document upload (1)
- Sector Association authorities (4)
- Sector association target unit accounts info (2)
- Sector association subsistence fees (1)
- Sector-Level Performance Data View Pages (2)
- Sector-Level Performance Account Template Data View Pages (1)
- Sector Association Details update (2)
- Sector Associations site contacts (2)
- Requests (4)
- Regulator Users (6)
- Regulator Authorities (7)
- Operator Users invitation (1)
- MiReports system (3)
- File Evidences upload (1)
- Document Templates (3)
- Cca Requests (1)
- Ca site contacts (2)
- Ca external contacts (5)
- Buy-out and surplus transactions info view (1)
- Buy out surplus transaction update controller (2)
- Terms and conditions (3)
- Update Target Unit Account (4)
- Sector Users (5)
- Operator Users (5)
- Operator Authorities (3)
- Update Facility Data (2)
- Buy-out and surplus cost info (2)
- User signatures (1)
- Underlying Agreements (1)
- Target Unit Account info view (2)
- Target Period Performance Account Template Data Report of the Account (3)
- Performance data reporting view info (1)
- Subsistence fees MoA facility view (1)
- Subsector association info view (1)
- Sector Association Scheme Documents (1)
- Sector association scheme (2)
- Sector association info view (2)
- Request actions (2)
- Request action file documents handling (1)
- Request action attachments handling (1)
- Request items (1)
- Unassigned Items (1)
- Items Assigned To Others (1)
- Items Assigned To Me (1)
- File Notes (1)
- File Evidences (1)
- File Documents (1)
- File Document Templates (1)
- File Attachments (1)
- Facility (2)
- Facility info view (2)
- Document Template Files (1)
- Reference Data (1)
- Companies information (1)
- Certification Period view info (1)
- Cca Authorities (1)
- Buy-out and surplus transaction info view (5)
- Authorities (3)
- UI Configuration (1)
- Tasks Release (1)

Every operation, with a link to its markdown: https://skmtc.dev/beis/apis/api-documentation/llms.txt