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

# ESOS API Documentation

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

## Operations

138 in total, by tag:

- Verifier users registration (2)
- Verification Bodies (6)
- Request Notes (7)
- Notification Templates (3)
- Account Notes (7)
- VB site contacts (2)
- MiReports (4)
- Ca site contacts (2)
- Verifier Users Invitation (2)
- Verifier authorities (6)
- User token (1)
- Users Security Setup (3)
- Forgot Password (3)
- Users (4)
- Tasks (2)
- Tasks Assignment (3)
- Request task attachments handling (2)
- Requests (5)
- Regulator Users (6)
- Regulator users registration (1)
- Regulator Authorities (7)
- Organisation account update (1)
- Organisation account onboarding registries (4)
- Operator users registration (3)
- Operator Users invitation (1)
- Operator Authorities (4)
- Document Templates (3)
- Ca external contacts (5)
- Account verification body (4)
- Verifier Users (4)
- Operator Users (4)
- NOC Reports (1)
- Unassigned Items (1)
- Items Assigned To Others (1)
- Items Assigned To Me (1)
- User signatures (1)
- Terms and conditions (1)
- Request actions (2)
- Request action file documents handling (1)
- Request action attachments handling (1)
- Organisation accounts (2)
- Organisation account view (1)
- Request items (1)
- File Notes (1)
- File Documents (1)
- File Document Templates (1)
- File Attachments (1)
- Document Template Files (1)
- Reference Data (1)
- Companies information (1)
- Authorities (4)
- UI Configuration (1)
- Tasks Release (1)

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