newtraincomply.PublicApi

Get list of all Agreements.

Controller for managing Certificates.

Retrieves a list of all certificates.

Returns the list of certificates. If something goes wrong on the server.

Updates a certificate's basic details.

The ID of the certificate. The updated certificate details. If the certificate was updated successfully. If the request is invalid. If the certificate is not found. If something goes wrong on the server.

Controller for managing Certificate Signatures.

Uploads a new signature image.

Payload for signature upload. If the signature was uploaded successfully. If the file is invalid. If something goes wrong on the server.

Retrieves a list of all available signatures.

Returns the list of signatures. If something goes wrong on the server.

Deletes a specific signature by its ID.

The ID of the signature to delete. If the signature was deleted successfully. If the signature is not found. If something goes wrong on the server.

Get all assets with filtering and pagination support.

The request containing filter criteria and pagination parameters. Returns a paginated list of assets.

Get asset details by ID for viewing.

The asset ID. Returns detailed asset information.

Get asset details by ID for edit drawer population.

The asset ID. Returns asset data formatted for edit drawer.

Create a new asset.

The request containing asset information. Returns success or error response.

Update an existing asset.

The request containing updated asset information. Returns success or error response.

Get HIPAA Agreement file URL for a software asset.

The asset ID. Returns HIPAA agreement file URL or error response.

Add HIPAA Agreement to a software asset.

The asset ID. The request containing HIPAA agreement type and file. Returns success or error response.

Delete an asset by ID.

The asset ID. Returns success or error response.

Controller for Compliance Officers - view and update compliance officer assignments.

Gets all compliance officers with their role types, primary and secondary officers.

Pagination and search parameters List of compliance officers with pagination

Updates the primary and/or secondary officers for a compliance role type.

Update request with role ID and officer assignments Success or error response

Gets a list of users available to be assigned as officers (not already assigned as primary or secondary in any role type).

Optional role ID to exclude officers from that specific role List of available users

Gets the compliance settings for the organization.

Compliance settings including allow multiple officer roles flag

Updates the compliance settings for the organization.

Settings update request Success or error response

Controller for Compliance Roadmap - view and update compliance steps.

Gets all compliance roadmap steps with progress information.

List of compliance steps with overall progress

Updates the status of a specific compliance step.

The step number (1-9) The status update request Success or error response

Get incident configuration for the organization

Update incident configuration for the organization

Returns all incidents for given criteria and returns paginated response.

Creates a new incident

Updates an existing incident

Get incident detail by ID

Reassign incident to a new investigator

Get breach assessment for an incident

Begin investigation for an incident

Submit breach assessment

Review incident by Compliance Officer

Confirm determination by Compliance Officer

Revise determination by Compliance Officer

Close an incident

Generate Individual Notice Letter template

Generate OCR Breach Notification Form template

Generate Media Notice template (for breaches affecting >500 individuals)

Generate evidence pack (PDF or ZIP)

Get audit logs for an incident

Get incident history timeline

Get breach notifications for an incident

Update a breach notification

Change the status of a breach notification (Pending or Completed)

Returns all incidents for given criteria and returns paginated response.

Controller for role management - CRUD operations.

Get all user list.

Returns the list of users. If something goes wrong on the server.

Get all teams list.

Returns the list of teams. If something goes wrong on the server.

Get all roles list.

Returns the list of roles. If something goes wrong on the server.

Get all locations list.

Returns the list of locations. If something goes wrong on the server.

Get all department list.

Returns the list of departments. If something goes wrong on the server.

Get all knowledge assessments list.

Returns the list of knowledge assessments. If something goes wrong on the server.

Get all learning paths list.

Returns the list of learning paths. If something goes wrong on the server.

Get all service-providers list.

Returns the list of learning paths. If something goes wrong on the server.

Get all service-provider templates list.

Returns the list of learning paths. If something goes wrong on the server.

Get all service-provider-categories list.

Returns the list of learning paths. If something goes wrong on the server.

Get all trainings list.

Returns the list of trainings. If something goes wrong on the server.

Get all Compliance roles list.

Returns the list of roles. If something goes wrong on the server.

Get all users who have compliance permissions.

Returns the list of users having compliance permisisons.. If something goes wrong on the server.

Get all Compliance users list.

Returns the list of users. If something goes wrong on the server.

Get all incident categories list.

Returns the list of incident categories. If something goes wrong on the server.

Get all policy types list.

Returns the list policy types. If something goes wrong on the server.

Get all policy categories list.

Returns the list policy categories. If something goes wrong on the server.

Get all training categories list.

Returns the list of training categories. If something goes wrong on the server.

Get primary and secondary compliance officers for investigators dropdown

Returns the list of compliance officers. If something goes wrong on the server.

Controller for managing departments - includes CRUD operations and status updates.

Constructor to inject department service.

The admin department service

Creates a new department.

Department creation request data Created department details or error response

Lists all departments with optional filters.

Filtering and pagination options List of departments or error response

Gets the details of a department by its unique identifier.

The unique identifier (GUID) of the department Department details or not found/error response

Updates the details of an existing department.

The unique identifier of the department to update Update data for the department Updated department details or error response

Deletes a department by its unique identifier.

The unique identifier of the department to delete Success or error response

Recovers a previously deleted department.

The unique identifier of the department to recover Success or error response

Controller for managing locations - CRUD operations and status updates.

Creates a new location.

Lists all locations with optional filters.

Gets a location by its ID.

Updates a location.

Deletes a location by ID.

Recovers a previously deleted location by ID.

Updates the status of a location (e.g., Active/Inactive).

Controller for organizations - CRUD operations.

Creates a new organization.

The organization creation request. Returns the newly created organization. If the request is invalid. If something goes wrong on the server.

Gets an organization by ID.

The organization ID. Returns the organization. If the organization is not found. If something goes wrong on the server.

Updates an existing organization.

The ID of the organization to update. The updated organization information. Returns the updated organization. If the request is invalid. If the organization is not found. If something goes wrong on the server.

Controller for Knowledge Assessments - create, view, update, delete, recover.

Create new knowledge assessment

assign teams/users/departments to the selected knowledge assessment

linking training with the selected knowledge assessment

linking learning paths with the selected knowledge assessment

Get paginated list of knowledge assessments

Get knowledge assessment by ID

Get knowledge assessment result by attempt Id

Get knowledge assessment full details by ID for update/edit scenarios.

Get knowledge assessment trainings.

Get knowledge assessment learning paths.

Update knowledge assessment by ID

Archive knowledge assessment by ID

Delete knowledge assessment by ID

Recover deleted knowledge assessment by ID

Controller for Learning Paths - create - view - update.

Create a new learning-path

assign a new learning-path

link assessment with a learning-path (assessment appears as last item in sequence).

Unlink assessment from a learning-path (removes it from the end of the sequence).

Get list of all learning paths.

Get a single learning path detAILS

Get a single learning path details for edit scenario

Update learning paths by using ID.

Archives learning paths by using ID.

Delete learning paths by ID.

Recover learning paths by ID.

Update a learning path reminder

Get list of learning path reminder settings.

Get learning path records (trainee progress)

Admin-only read-only endpoints for querying the permanent notification log Used for audit, dispute resolution, and compliance defense

Get notification log entries with filters (admin only, read-only)

Response model for notification log entries

Controller for managing organizational chart and hierarchy.

Gets the complete organization chart including CEO and all hierarchies.

Returns the organization chart. If something goes wrong on the server.

Sets or updates the CEO for the organization.

The request containing the CEO user ID. Returns the updated organization chart. If the request is invalid. If the user is not found. If something goes wrong on the server.

Adds reporting relationships to the organizational hierarchy. Multiple users can be assigned to report to a single manager.

The request containing manager and reporting user IDs. Returns the updated organization chart. If the request is invalid or would create a circular reference. If the manager or reporting users are not found. If something goes wrong on the server.

Removes a user's reporting relationship from the hierarchy.

The ID of the user whose reporting relationship should be removed. If the relationship was removed successfully. If the user has direct reports that need to be reassigned first. If the reporting relationship is not found. If something goes wrong on the server.

Gets all users eligible to be selected as CEO.

Returns the list of eligible users. If something goes wrong on the server.

Gets all users eligible to be selected as reporting users (excludes CEO) and also as Reporting To users.

Returns the list of eligible users. If something goes wrong on the server.

Update a reminder for Training, Knowledge Assessment, or Learning Path

Get reminder settings for Training, Knowledge Assessment, or Learning Path

Controller for managing Retake Requests (list, view, approve, deny).

Get paginated list of retake requests

Pagination and search options Filter by status: All, Pending, Approved, or Denied

Get retake request by ID

Approve retake request by ID

Deny retake request by ID

Controller for managing role-based permissions.

Retrieves permissions assigned to a specific role.

The ID of the role. Returns the list of permissions for the role. If the role is not found. If something goes wrong on the server.

Updates permissions for a specific role

A sample request payload: PUT /api/permissions { "roleId": "11111111-1111-1111-1111-111111111111", "permissions": [ { "permissionId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" }, { "permissionId": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb" } ] } The payload must include both Admin and User permissions in a single array. Returns the updated permission result. If the request is invalid. If the role is not found. If something goes wrong on the server.

Controller for role management - CRUD operations.

Creates a new role.

The role creation request. Returns the newly created role. If the request is invalid. If something goes wrong on the server.

Gets a role by ID.

The role ID. Returns the role. If the role is not found. If something goes wrong on the server.

Gets all roles.

Returns the list of roles. If something goes wrong on the server.

Updates an existing role.

The ID of the role to update. The updated role information. Returns the updated role. If the request is invalid. If the role is not found. If something goes wrong on the server.

Deletes a role by ID.

Updates an existing role.

The ID of the role to update. The updated role information. Returns the updated role. If the request is invalid. If the role is not found. If something goes wrong on the server.

Controller for managing teams.

Creates a new team.

Team creation data. Returns the created team. If the request is invalid. If something goes wrong on the server.

Retrieves all teams.

Returns the list of teams. If something goes wrong on the server.

Updates an existing team.

Team ID. Updated team data. Returns the updated team. If the request is invalid. If the team is not found. If something goes wrong on the server.

Deletes a team by ID.

Team ID. If the team was deleted successfully. If the team is not found. If something goes wrong on the server.

Remove a user from the team by using user ID.

Team ID. User ID. If the user was removed successfully. If the user is not found. If something goes wrong on the server.

Recover a team by using team ID.

Team ID. If the user was removed successfully. If the user is not found. If something goes wrong on the server.

Controller for managing users.

Creates a new user.

A sample request payload for user creation.: POST /users { "name": "Shakil Ahmad Khan", "email": "shakil@yopmail.com", "phoneNumber": "3470434033", "countryCode": "+92", "roleId": "SOMEROLEIDHERE", "designation": "Senior Full Stack Developer", "teams": [ { "teamId": "SOMTEAMIDHERE" } ] } User creation data. Returns the created user. If the request is invalid. If something goes wrong on the server.

Imports a list of users from Excel/CSV.

Retrieves all users.

Returns the list of users. If something goes wrong on the server.

Updates an existing user.

User ID. Updated user data. Returns the updated user. If the request is invalid. If the user is not found. If something goes wrong on the server.

Deletes a user by ID.

User ID. If the user was deleted successfully. If the user is not found. If something goes wrong on the server.

Updates the status of a user (e.g., Active/Inactive).

User ID. Returns the updated user. If the request is invalid. If the user is not found. If something goes wrong on the server.

Resend invitation email on the specified user email address

Returns the success scenario. If the request is invalid. If the user is not found. If something goes wrong on the server.

Accept the joining invitation

Returns the success scenario. If the request is invalid. If the user is not found. If something goes wrong on the server.

Recover a user by using user ID.

User ID. If the user was removed successfully. If the user is not found. If something goes wrong on the server.

Retrieves all active users.

Returns the list of users. If something goes wrong on the server.

Retrieves a simplified list of all users with id, name, designation, and MFA status for MFA management.

Returns the simplified list of users. If the user is not authenticated. If the user does not have permission. If no users are found. If something goes wrong on the server.

Updates an existing user ID list with given role Id.

User ID. Updated user data. Returns the updated user. If the request is invalid. If the user is not found. If something goes wrong on the server.

Security audit logs (HIPAA Information System Activity Review). Access: Organization Account Administrators and optional Security Officer role.

Gets security audit logs for the organization, grouped by date (newest first).

Optional filter: from date (UTC). Optional filter: to date (UTC). Max number of entries (default 500, max 1000).

Exports security audit logs to Excel.

Optional filter: from date (UTC). Optional filter: to date (UTC).

Create a new service provider

Get list of all service provider.

Get details of service provider.

remove reminder of service provider.

Get agreements for a specific service provider

Add/create an agreement for a specific service provider

Delete an agreement for a specific service provider

Get all HIPAA documentation for a service provider

Get HIPAA documentation by ID

Create HIPAA documentation

Update HIPAA documentation

Delete HIPAA documentation

Assign risk assessment (send email)

Upload vendor assessment

Update uploaded vendor assessment

Get risk assessment details for a service provider

Resend risk assessment email for a sent assessment

Base controller for admin training operations. Shared logic for policies, procedures, courses, company, HIPAA policies, HIPAA courses, HIPAA procedures.

Controller for company training - create - view - update.

Controller for course training - create - view - update.

Controller for HIPAA course training - create - view - update.

Controller for HIPAA policy training - create - view - update. IMPORTANT NAMING CLARIFICATION: - Frontend displays this as "HIPAA Policy and Procedures" - Backend saves it as "HippaPolicies" (TrainingCategoryEnum.HippaPolicies) - This controller handles Training entities with Category = HippaPolicies, NOT Policy entities - Policy entities are handled by PoliciesController (/api/Policies) Route: /api/compliance/hippa-policies This is the correct controller for the endpoint: /api/compliance/hippa-policies?queryType=linkedAssessment

Controller for HIPAA procedure training - create - view - update.

Controller for policy training - create - view - update.

Create a new training for policy

Upload a new training for policy

Assign a training to a company

Update a training reminder

Get company training analytics for admin.

Download attestation agreement as PDF.

Get list of all policy reminder settings.

Link a knowledge assessment to a training

Get list of all policy trainings.

Get list of all history of a policy training.

Get details of a specific policy training by ID.

Get details of a specific history record of a policy training by ID.

Get details of a specific policy training by ID for edit/update scenario.

Update policy training by using training ID.

Archives policy training by using ID.

Delete policy training by ID.

Recover policy training by ID.

Get assessment records for a specific policy training.

Get progress records for a specific policy training.

Controller for procedure training - create - view - update.

Admin-only endpoints to issue a one-time MFA reset passkey for a target user and to view the reset history for that user. The user-facing passkey-login path lives on the public auth controller.

Controller for authentication - login - register - etc.

Performs authentication - a quick login

A sample request payload for authentication.: POST /authenticate { "email": "johndoe@yopmail.com", "password": "Secret@123" } Email address and password. Returns the access token. Returns a list of errors if the request is invalid. When no account is found for the provided email and password.

Updates an access token.

The Refresh Token (RefreshToken). Returns a new access token. Returns a list of errors if the request is invalid. Unauthorized. When no access token is found.

Performs registration/Signup

A sample request payload for registration.: POST /authenticate { "name": "John Doe", "email": "johndoe@yopmail.com", "organizationName": "XYZ Organization", "phoneNumber": "3470412122", "countryCode": "+92", "password": "Secret@123", "confirmPassword": "Secret@123", "IsAgreeTermsAndConditions": true } Email address and password. Returns the newly created user + token. Returns a list of errors if the request is invalid. When there is some kind of conflicts in the data. When something went wrong!.

Resend an email for account verification

A sample request payload for resend account verification email.: POST /resend-account-verification-email { "email": "johndoe@yopmail.com" } Email address to send account verification email. Returns a success message indicating an email send to your registered email. Returns a list of errors if the request is invalid. When the requested account is already activated. When something went wrong!.

Performs account verification - a verification to make the account active

A sample request payload for authentication.: POST /verify-account { "token": "VerificationToken", } Verification token. Returns a success indicating account verified. Returns an error if there is some kind of error When no token is found. When there is some kind of conflict. If something went wrong!

Sends a reset password link to the user's email address.

Request contains the email address where the reset email link will be sent Email with reset password link has been sent successfully. Returns a list of errors if the request is invalid. If the provided email address is not found. When something went wrong on the server.

Resets the user's password using the provided reset token.

Password has been reset successfully. Returns a list of errors if the request is invalid. If the reset token is invalid or expired. When something went wrong on the server.

Logs out the current user by revoking all tokens and recording a Logout audit event.

Logged out successfully. Unauthorized.

Get all categories

Get category by ID

Update a category

Create a new category

Delete a category

Unified notifications controller for all modules (Training, Compliance, Incident, etc.) Provides endpoints for listing, marking read/unread, dismissing, and getting unread counts

Get notifications for the current user (newest first). Supports filtering by read state (all|read|unread), audience (User/Admin/Both), and module.

Mark a notification as read

Mark a notification as unread

Dismiss a notification (soft delete from view; audit record retained)

Mark all notifications as read

Builds the frontend path for the notification's related item. Paths match Nuxt routes in EzTrainComply_Frontend_V2 (composables/useNotificationNavigation.ts and pages/). When audience is User or Both, returns user-mode paths (/user-mode/...); otherwise admin paths.

Response model for notification list with counts

Response model for individual notification

Frontend path to the related item (matches Nuxt routes in EzTrainComply_Frontend_V2). Use for the View button link, e.g. router.push(itemLink).

Controller for Sending/Initiating OTP + OTP Verification

Triggers an OTP Code - on available sources e.g Email, Mobile number.

Returns a response indicating the result of the operation.

Triggers an OTP Code - on available sources e.g Email, Mobile number.

Returns a response indicating the result of the operation.

Controller for Policy entities (HIPAA Compliance Policies). IMPORTANT: This is DIFFERENT from HippaPolicyController - This controller handles Policy entities (Domain.Entities.ComplianceManagement.HIPPA_Compliance.Policy) - Route: /api/Policies - HippaPolicyController handles Training entities with Category = HippaPolicies - Route: /api/compliance/hippa-policies (Frontend shows as "HIPAA Policy and Procedures") If you're looking for the endpoint /api/compliance/hippa-policies, use HippaPolicyController instead.

Retrieves all attestation tracking records.

An ApiResponse containing a list of attestation tracking records.

Retrieves attestation tracking records by filter criteria.

The filter criteria including paging and search parameters. An ApiResponse containing a paged list of attestation tracking records.

Controller for user profile - get - update - etc

Initializes a new instance of the class.

The profile service. The OTP manager service.

Retrieves user profile by ID.

Returns the user profile.

Updates user profile information.

The request containing profile updates. Returns the updated profile information.

Deletes user profile by ID.

Returns a response indicating the result of the operation.

Updates user profile picture.

The request containing the new profile picture. Returns the updated profile information.

Changes user password.

The request containing old and new passwords. Returns a response indicating the result of the operation.

Updates the Is2FaEnabled property for a user.

The request containing userId and Is2FaEnabled flag. Returns a response indicating the result of the operation.

Returns the MFA enable/disable history for a single user (admin-only). Sourced from SecurityAuditLog rows of types MfaEnabled / MfaDisabled.

Marks MFA verification as complete after successful external MFA verification.

Returns a response indicating the result of the operation.

Configures MFA session timeout settings for the authenticated user.

MFA frequency configuration data. Returns a response indicating the result of the operation.

Configures inactivity timeout (logout session) settings for the authenticated user.

Inactivity timeout configuration data. Returns a response indicating the result of the operation.

Public controller for certificate verification (no authentication required)

Verify a certificate by its ID (public endpoint, no authentication required)

The certificate ID to verify Returns certificate verification details If the certificate is not found If something goes wrong on the server

Download a certificate PDF by its ID (public endpoint, no authentication required)

The certificate ID to download Returns the certificate PDF file If the certificate is not found If something goes wrong on the server

Public controller for vendor assessment submission (token-based authentication)

Get vendor assessment instance by token (validates token and returns assessment details)

Start vendor assessment (returns existing assessment instance for vendor assessments) This endpoint accepts vendor assessment tokens and returns the assessment details

Submit vendor assessment (validates token and submits answers)

Controller for Sending/Initiating OTP + OTP Verification

Get user settings

Returns a response indicating the result of the operation.

Update user settings

Returns a response indicating the result of the operation.

Endpoints for the in-app Help & Support pages (contact support, feature request).

Submits a Contact Support request and emails the support team.

Submits a Feature Request and emails the product team.

Controller for managing Certificates.

Retrieves the list of all user completed trainings with certificate Ids.

Returns the list of all user trainings with certificate Ids. If something goes wrong on the server.

Retrieves a link to certificate.

Returns the link of certificate. If something goes wrong on the server.

Controller for user-facing incident operations.

Get all incidents reported by the current user

Get user incident by ID

Get user incident by ID for edit

Report a new incident (User side)

Update an existing incident (User side)

Delete user incident

Controller for user-facing knowledge-assessments operations.

Get list of available Knowledge Assessments for the users.

Get detail of available Knowledge Assessment for the user against the assessment Id.

Get the user's last attempt result for this assessment (My Knowledge Assessment Result). Returns status (Passed/Failed), attempt = total number of attempts made, total score, and per-question result (Correct/Wrong/Optional, question text, answer, score).

Save user submitted knowledge assessment.

Controller for user-facing learning paths operations.

Get list of available learning paths for the users.

Get learning path detail with paginated trainings list.

Controller for Retake Trainings and Assessments.

Create a new retake request for a training or assessment.

Returns the message of request created successfully. If something goes wrong on the server.

Fetches the list of user retake requests for trainings and assessments.

Pagination and search options Filter by status: All, Pending, Approved, or Denied Returns the list of retake requests If something goes wrong on the server.

Controller for user-facing company training operations.

Controller for user-facing course training operations.

Controller for user-facing HIPAA course training operations.

Controller for user-facing HIPAA policy training operations.

Controller for user-facing policy training operations.

Controller for user-facing procedure training operations.

Base controller for user-facing training operations. Shared logic for policies, procedures, courses, company, HIPAA policies, and HIPAA courses.

Class responsible for standardizing API responses.

Indicates whether the request was successful.

The HTTP status code.

The success or failure message

List with the request errors if it was unsuccessful.

Creates a response with HTTP Status 200 and message

Creates a response with HTTP Status code 204

A response with HTTP Status 302 (FOUND)

A response with HTTP Status 302 (FOUND).

message to be displayed in the response.

Creates a response with HTTP Status 304 (NotModified)

Creates a response with HTTP Status 304 (NotModified).

message to be displayed in the response.

Creates a response with HTTP Status 400.

Error message to be displayed in the response.

Creates a response with HTTP Status 400.

List of errors to be displayed in the response.

Creates a response with HTTP Status 401.

Error message to be displayed in the response.

Creates a response with HTTP Status 402 (Payment Required)

Creates a response with HTTP Status 402 (Payment Required).

message to be displayed in the response.

Creates a response with HTTP Status 403.

Error message to be displayed in the response.

Creates a response with HTTP Status 404.

Creates a response with HTTP Status 409.

Creates a response with HTTP Status 409

The error message displayed to be in the response.

Creates a response with HTTP Status 410.

Message to be displayed in the response.

Creates a response with HTTP Status 422.

Message to be displayed in the response.

Creates a response with HTTP Status 423.

Message to be displayed in the response.

Creates a response with HTTP Status 500.

Creates a response with HTTP Status 200.