Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Qualio

Qualio Compliance Intelligence API

The Compliance Intelligence API from Qualio — 11 operation(s) for compliance intelligence.

Documentation Provider Profile APIs.io OpenAPI GitHub

Qualio Compliance Intelligence API is one of 11 APIs that Qualio publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Compliance Intelligence. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 31 operations across 11 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 0.1.

Requests are made against a single base URL, https://api.qualio.com.

31 operations 11 paths 6 schemas 2 DELETE8 GET11 OPTIONS2 PATCH4 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1
Base URL
https://api.qualio.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Qualio Compliance Intelligence API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (api_key). By default, every request must be authenticated.

Paths & Operations 31

Across 11 paths, the API surfaces 31 operations — 2 DELETE, 8 GET, 11 OPTIONS, 2 PATCH, 4 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Compliance Intelligence 31
GET
/v1/compliance/frameworks
List frameworks
listComplianceFrameworks 3 params → 200400403429
OPTIONS
/v1/compliance/frameworks
Lists the compliance frameworks in your Qualio instance. A framework is a compliance standard (for example ISO 13485, ISO 9001, or GDPR) that groups the requirements your organisation has committed t…
listComplianceFrameworksOptions 3 params → 200
POST
/v1/compliance/frameworks
Create a framework
createComplianceFramework body → 201400403429
PUT
/v1/compliance/frameworks/{frameworkId}
Update a framework
updateComplianceFramework 1 param body → 200400403404429
OPTIONS
/v1/compliance/frameworks/{frameworkId}
Updates a compliance framework identified by its numeric id. This is a partial update: include only the fields you want to change. Omitting a field leaves its current value unchanged. Pass null for d…
updateComplianceFrameworkOptions 1 param → 200
GET
/v1/compliance/frameworks/{frameworkId}
Get a framework
getComplianceFramework 1 param → 200400403404429
DELETE
/v1/compliance/frameworks/{frameworkId}
Delete a framework
deleteComplianceFramework 1 param → 204400403404429
PATCH
/v1/compliance/frameworks/{frameworkId}/status
Update a framework status
updateComplianceFrameworkStatus 1 param body → 200400403404429
OPTIONS
/v1/compliance/frameworks/{frameworkId}/status
Updates the lifecycle status of a compliance framework for your Qualio instance. The status controls whether the framework is actively tracked: disabled (not currently in use), implementing (controls…
updateComplianceFrameworkStatusOptions 1 param → 200
GET
/v1/compliance/requirements
List requirements
listComplianceRequirements 3 params → 200400403429
OPTIONS
/v1/compliance/requirements
Lists the compliance requirements in your Qualio instance. A requirement is an individual clause or control obligation from a compliance framework that your organisation has committed to meet. Each r…
listComplianceRequirementsOptions 3 params → 200
POST
/v1/compliance/requirements
Create a requirement
createComplianceRequirement body → 201400403404429
PUT
/v1/compliance/requirements/{requirementId}
Update a requirement
updateComplianceRequirement 1 param body → 200400403404429
OPTIONS
/v1/compliance/requirements/{requirementId}
Updates a compliance requirement identified by its numeric id. This is a partial update: include only the fields you want to change. Omitting a field leaves its current value unchanged. Pass null for…
updateComplianceRequirementOptions 1 param → 200
DELETE
/v1/compliance/requirements/{requirementId}
Delete a requirement
deleteComplianceRequirement 1 param → 204400403404429
PATCH
/v1/compliance/requirements/{requirementId}/status
Update a requirement status
updateComplianceRequirementStatus 1 param body → 200400403404429
OPTIONS
/v1/compliance/requirements/{requirementId}/status
Updates the assessment status of a compliance requirement for your Qualio instance. The status reflects the current compliance posture for the requirement: notstarted (assessment has not begun), inpr…
updateComplianceRequirementStatusOptions 1 param → 200
GET
/v1/compliance/controls
List controls
listComplianceControls 4 params → 200400403429
OPTIONS
/v1/compliance/controls
Lists the compliance controls in your Qualio instance. A control is a measure your organisation implements to satisfy one or more compliance requirements. Controls are either Qualio-managed (built-in…
listComplianceControlsOptions 4 params → 200
POST
/v1/compliance/controls
Create a control
createComplianceControl body → 201400403429
GET
/v1/compliance/controls/{controlId}
Get a control
getComplianceControl 1 param → 200400403404429
OPTIONS
/v1/compliance/controls/{controlId}
Retrieves a single compliance control in your Qualio instance, including the evidence and definitions linked to it. A control is a measure your organisation implements to satisfy one or more complian…
getComplianceControlOptions 1 param → 200
PUT
/v1/compliance/controls/{controlId}
Update a control
updateComplianceControl 1 param body → 200400403404429
GET
/v1/compliance/evidence
List evidence
listComplianceEvidence 3 params → 200400403429
OPTIONS
/v1/compliance/evidence
Lists the compliance evidence in your Qualio instance. Evidence is the documentation and records that demonstrate a control is defined and operating — for example linked Qualio documents, externall…
listComplianceEvidenceOptions 3 params → 200
GET
/v1/compliance/gaps
List gaps
listComplianceGaps 5 params → 200400403429
OPTIONS
/v1/compliance/gaps
Lists the compliance gaps in your Qualio instance. A gap is a shortfall identified against a control — for example a control that is missing objective evidence or whose evidence does not satisfy it…
listComplianceGapsOptions 5 params → 200
POST
/v1/compliance/gaps
Create a gap
createComplianceGap body → 201400403429
GET
/v1/compliance/gaps/{gapId}
Get a gap
getComplianceGap 1 param → 200400403404429
OPTIONS
/v1/compliance/gaps/{gapId}
Retrieves a single compliance gap in your Qualio instance. A gap is a shortfall identified against a control — for example a control that is missing objective evidence or whose evidence does not sa…
getComplianceGapOptions 1 param → 200
PUT
/v1/compliance/gaps/{gapId}
Update a gap
updateComplianceGap 1 param body → 200400403404429

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are genericBadRequestResponse (2 properties), genericBadRequest400ParametersResponse (2 properties), genericBadRequest400PathResponse (2 properties), throttledResponse (1 property). Each schema is shown below with its type and property counts.

generic404
A generic response when a resource can't be found
genericForbiddenResponse
object
1 property 1 required
genericBadRequest400PathResponse
object
2 properties 2 required
genericBadRequest400ParametersResponse
object
2 properties 2 required
throttledResponse
object
1 property 1 required
genericBadRequestResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qualio-compliance-intelligence-api-openapi.yml Raw ↑

Other APIs Qualio publishes across the network.

Qualio Audit Trail API
AE Profile APIs.io
Qualio Change Management API
AE Profile APIs.io
Qualio Design Controls API
AE Profile APIs.io
Qualio Documents API
AE Profile APIs.io
Qualio Events API
AE Profile APIs.io
Qualio Resource Library API
AE Profile APIs.io
Qualio Suppliers API
AE Profile APIs.io
Qualio Tags API
AE Profile APIs.io
Qualio Training API
AE Profile APIs.io
Qualio User Management API
AE Profile APIs.io
#Compliance Intelligence
← Back to Q APIs
API Details
ID
qualio:qualio-compliance-intelligence-api
Base URL
https://api.qualio.com
Docs
https://developer-portal.qualio.com/
Provider
Qualio
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network