# ministryofjustice/opg-digideps architecture

> Architecture diagram of the GitHub repository ministryofjustice/opg-digideps, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ministryofjustice/opg-digideps
- Repository: https://github.com/ministryofjustice/opg-digideps

## Overview

Complete the deputy report is a Symfony service with deputy-facing reporting and a VPN-restricted case-manager review area. The principal workflow is deputies using the frontend to prepare and submit reports, with case managers reviewing submissions in the admin area. The repository also contains user registration, organisation management, deputyship ingestion, and reporting/statistics capabilities. The excerpts show frontend report operations calling the REST client and backend report handling; many other routes and integrations are documented only by the file tree, so their connections are not asserted here.

Main entry points: [`client/app/src/Service/Client/RestClient.php`](https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Service/Client/RestClient.php) (REST Client), [`client/app/src/Service/Client/Internal/ReportApi.php`](https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Service/Client/Internal/ReportApi.php) (Report API Client), [`api/app/src/Controller/Report/ReportController.php`](https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Controller/Report/ReportController.php) (Report Controller), [`client/app/src/Service/Client/Internal/UserApi.php`](https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Service/Client/Internal/UserApi.php) (User API Client)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["Deputy and Admin Frontend"]
  node_user_ui["User and Registration UI<br/>[UserController.php]"]
  node_report_ui["Report UI"]
  node_admin_review["Admin Review"]
  node_org_ui["Organisation UI"]
  node_rest_client["REST Client<br/>[RestClient.php]"]
  node_user_api_client["User API Client<br/>[UserApi.php]"]
  node_report_api_client["Report API Client<br/>[ReportApi.php]"]
  node_gov_table["GOV Table<br/>[Table.php]"]
end

subgraph group_backend["API and Domain"]
  node_api_entry["API Controllers"]
  node_report_controller["Report Controller"]
  node_user_controller["User Controller<br/>[UserController.php]"]
  node_report_service["Report Service<br/>[ReportService.php]"]
  node_registration["Deputyship Registration"]
end

subgraph group_persistence["Domain Data"]
  node_report_data[("Report Data<br/>[Report.php]")]
  node_checklist_data[("Checklist Data<br/>[Checklist.php]")]
  node_client_data[("Client Data<br/>[Client.php]")]
  node_user_data[("User Data<br/>[User.php]")]
  node_client_repo["Client Repository"]
  node_user_repo["User Repository<br/>[UserRepository.php]"]
end

subgraph group_support["Supporting Services"]
  node_audit["Audit Events<br/>[AuditEvents.php]"]
  node_event_dispatch["Event Dispatcher"]
  node_redis_tokens[("Token Storage<br/>[RedisStorage.php]")]
  node_s3_storage["File Storage<br/>[S3Storage.php]"]
  node_self_register["Registration Data"]
end

node_deputies(("Deputies"))
node_case_managers(("Case Managers"))

node_deputies -->|"register"| node_user_ui
node_deputies -->|"prepare reports"| node_report_ui
node_case_managers -->|"review submissions"| node_admin_review
node_report_ui -->|"submits via"| node_report_api_client
node_report_api_client -->|"calls"| node_rest_client
node_user_ui -->|"calls"| node_rest_client
node_user_api_client -->|"calls"| node_rest_client
node_rest_client -.->|"sends HTTP requests"| node_api_entry
node_api_entry -.->|"routes report requests"| node_report_controller
node_report_controller -->|"handles report data"| node_report_data
node_report_controller -.->|"uses"| node_report_service
node_user_controller -->|"queries users"| node_user_repo
node_user_controller -->|"queries clients"| node_client_repo
node_report_data -->|"belongs to"| node_client_data
node_user_data -->|"relates users"| node_client_data
node_admin_review -.->|"loads report data"| node_report_api_client
node_registration -.->|"uses registration data"| node_self_register
node_report_api_client -->|"dispatches submission events"| node_event_dispatch
node_user_api_client -->|"dispatches user events"| node_event_dispatch
node_rest_client -->|"reads auth tokens"| node_redis_tokens

click node_user_ui "https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Controller/UserController.php"
click node_report_ui "https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Controller/Report/ReportController.php"
click node_admin_review "https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Controller/Admin/Client/ReportController.php"
click node_org_ui "https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Controller/Org/OrganisationController.php"
click node_rest_client "https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Service/Client/RestClient.php"
click node_user_api_client "https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Service/Client/Internal/UserApi.php"
click node_report_api_client "https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Service/Client/Internal/ReportApi.php"
click node_gov_table "https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Components/GOV/Table/Table.php"
click node_api_entry "https://github.com/ministryofjustice/opg-digideps/tree/main/api/app/src/Controller"
click node_report_controller "https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Controller/Report/ReportController.php"
click node_user_controller "https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Controller/UserController.php"
click node_report_service "https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Service/ReportService.php"
click node_registration "https://github.com/ministryofjustice/opg-digideps/tree/main/api/app/src/v2/Registration"
click node_report_data "https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Entity/Report/Report.php"
click node_checklist_data "https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Entity/Report/Checklist.php"
click node_client_data "https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Entity/Client.php"
click node_user_data "https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Entity/User.php"
click node_client_repo "https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Repository/ClientRepository.php"
click node_user_repo "https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Repository/UserRepository.php"
click node_audit "https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Service/Audit/AuditEvents.php"
click node_event_dispatch "https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/EventDispatcher/ObservableEventDispatcher.php"
click node_redis_tokens "https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Service/Client/TokenStorage/RedisStorage.php"
click node_s3_storage "https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Service/File/Storage/S3Storage.php"
click node_self_register "https://github.com/ministryofjustice/opg-digideps/blob/main/common/src/Registration/SelfRegisterData.php"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_user_ui,node_report_ui,node_admin_review,node_org_ui,node_rest_client,node_user_api_client,node_report_api_client,node_gov_table toneBlue
class node_api_entry,node_report_controller,node_user_controller,node_report_service,node_registration toneAmber
class node_report_data,node_checklist_data,node_client_data,node_user_data,node_client_repo,node_user_repo toneMint
class node_audit,node_event_dispatch,node_redis_tokens,node_s3_storage,node_self_register toneRose
class node_deputies,node_case_managers toneIndigo
```

## Components

### Deputy and Admin Frontend

- [User and Registration UI](https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Controller/UserController.php): `client/app/src/Controller/UserController.php`
- [Report UI](https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Controller/Report/ReportController.php): `client/app/src/Controller/Report/ReportController.php`
- [Admin Review](https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Controller/Admin/Client/ReportController.php): `client/app/src/Controller/Admin/Client/ReportController.php`
- [Organisation UI](https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Controller/Org/OrganisationController.php): `client/app/src/Controller/Org/OrganisationController.php`
- [REST Client](https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Service/Client/RestClient.php): `client/app/src/Service/Client/RestClient.php`
- [User API Client](https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Service/Client/Internal/UserApi.php): `client/app/src/Service/Client/Internal/UserApi.php`
- [Report API Client](https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Service/Client/Internal/ReportApi.php): `client/app/src/Service/Client/Internal/ReportApi.php`
- [GOV Table](https://github.com/ministryofjustice/opg-digideps/blob/main/client/app/src/Components/GOV/Table/Table.php): `client/app/src/Components/GOV/Table/Table.php`

### API and Domain

- [API Controllers](https://github.com/ministryofjustice/opg-digideps/tree/main/api/app/src/Controller): `api/app/src/Controller`
- [Report Controller](https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Controller/Report/ReportController.php): `api/app/src/Controller/Report/ReportController.php`
- [User Controller](https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Controller/UserController.php): `api/app/src/Controller/UserController.php`
- [Report Service](https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Service/ReportService.php): `api/app/src/Service/ReportService.php`
- [Deputyship Registration](https://github.com/ministryofjustice/opg-digideps/tree/main/api/app/src/v2/Registration): `api/app/src/v2/Registration`

### Domain Data

- [Report Data](https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Entity/Report/Report.php): `api/app/src/Entity/Report/Report.php`
- [Checklist Data](https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Entity/Report/Checklist.php): `api/app/src/Entity/Report/Checklist.php`
- [Client Data](https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Entity/Client.php): `api/app/src/Entity/Client.php`
- [User Data](https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Entity/User.php): `api/app/src/Entity/User.php`
- [Client Repository](https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Repository/ClientRepository.php): `api/app/src/Repository/ClientRepository.php`
- [User Repository](https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Repository/UserRepository.php): `api/app/src/Repository/UserRepository.php`

### Supporting Services

- [Audit Events](https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Service/Audit/AuditEvents.php): `api/app/src/Service/Audit/AuditEvents.php`
- [Event Dispatcher](https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/EventDispatcher/ObservableEventDispatcher.php): `api/app/src/EventDispatcher/ObservableEventDispatcher.php`
- [Token Storage](https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Service/Client/TokenStorage/RedisStorage.php): `api/app/src/Service/Client/TokenStorage/RedisStorage.php`
- [File Storage](https://github.com/ministryofjustice/opg-digideps/blob/main/api/app/src/Service/File/Storage/S3Storage.php): `api/app/src/Service/File/Storage/S3Storage.php`
- [Registration Data](https://github.com/ministryofjustice/opg-digideps/blob/main/common/src/Registration/SelfRegisterData.php): `common/src/Registration/SelfRegisterData.php`

### Other components

- **Deputies**
- **Case Managers**

## Connections

- Deputies → User and Registration UI: register
- Deputies → Report UI: prepare reports
- Case Managers → Admin Review: review submissions
- Report UI → Report API Client: submits via (evidence: `client/app/src/Controller/Report/ReportController.php`)
- Report API Client → REST Client: calls (evidence: `client/app/src/Service/Client/Internal/ReportApi.php`)
- User and Registration UI → REST Client: calls (evidence: `client/app/src/Controller/UserController.php`)
- User API Client → REST Client: calls (evidence: `client/app/src/Service/Client/Internal/UserApi.php`)
- REST Client → API Controllers: sends HTTP requests
- API Controllers → Report Controller: routes report requests (evidence: `api/app/src/Controller/Report/ReportController.php`)
- Report Controller → Report Data: handles report data (evidence: `api/app/src/Controller/Report/ReportController.php`)
- Report Controller → Report Service: uses (evidence: `api/app/src/Controller/Report/ReportController.php`)
- User Controller → User Repository: queries users (evidence: `api/app/src/Controller/UserController.php`)
- User Controller → Client Repository: queries clients (evidence: `api/app/src/Controller/UserController.php`)
- Report Data → Client Data: belongs to (evidence: `api/app/src/Entity/Report/Report.php`)
- User Data → Client Data: relates users (evidence: `api/app/src/Entity/User.php`)
- Admin Review → Report API Client: loads report data (evidence: `client/app/src/Controller/Admin/Client/ReportController.php`)
- Deputyship Registration → Registration Data: uses registration data
- Report API Client → Event Dispatcher: dispatches submission events (evidence: `client/app/src/Service/Client/Internal/ReportApi.php`)
- User API Client → Event Dispatcher: dispatches user events (evidence: `client/app/src/Service/Client/Internal/UserApi.php`)
- REST Client → Token Storage: reads auth tokens (evidence: `client/app/src/Service/Client/RestClient.php`)
