Introduction to Regulatory Compliance Reporting with GetComplianceReport
This article applies to MetaDefender Endpoint Security SDK 4.3.6404.0 and later on Windows, 4.3.5791.0 and later on macOS, and 4.3.5406.0 and later on Linux.
What is GetComplianceReport?
GetComplianceReport (method 1035) collects the device-state evidence needed to assess an endpoint against a compliance framework, and returns it in a single call. You name the framework, for example PCI DSS 4.0.1, and the SDK returns the evidence for each control in that framework: which security products are installed in each category, and the state of each product, such as real-time protection, firewall, encryption or missing patches.
Key points:
Evidence, not a verdict. The SDK never returns pass or fail. Your application applies its own compliance logic, for example in your compliance dashboard.
One call. No separate load or detect step is needed. The SDK runs the required detection and state calls internally.
Same on every platform. Windows, macOS and Linux share the same input, output schema, controls and error codes. The values inside reflect each platform's own detection results.
Additive. No existing method changes. Integrations that do not call method
1035are unaffected.No separate license. The method is covered by your existing OESIS compliance license.
Data-driven. Frameworks, framework versions and controls are defined in the SDK data package (
libwaresource), so new frameworks that reuse existing controls can be added through a data package update, without an SDK upgrade.
Supported frameworks
|
| Controls returned | Requirement IDs |
|---|---|---|---|
|
| 12 | None. Framework-agnostic evidence. |
|
| 6 | PCI DSS 4.0.1 requirement IDs per control |
These are the only two combinations available as of November 2026. Both values are matched exactly and are case-sensitive: PCI_DSS or 4.0 is not accepted. New combinations will be announced in the OESIS Framework release notes, and this article will be updated.
If you need support for a framework or framework version that is not listed here, open a support case with the details of your request:
the framework name and version (for example, the standard and the exact revision you report against),
the controls or requirement IDs you need evidence for, if any,
the platforms you need it on (Windows, macOS, Linux).
Controls per framework
The response includes only the controls the SDK can collect evidence for, in the framework's order.
Control ID | Description |
|
| PCI DSS 4.0.1 requirement IDs |
|---|---|---|---|---|
| Antimalware | Yes | Yes | 5.1, 5.2, 5.3 |
| Encryption at rest | Yes | Yes | 3.5, 3.6 |
| Firewall | Yes | Yes | 1.4.2 |
| VPN (remote access) | Yes* | Yes* | 8.3.1, 8.4.2 |
| Data loss prevention | Yes* | Yes* | 4.2, 12.3.2 |
| Patch management | Yes | Yes | 6.3.3 |
| Anti-phishing | Yes | No | |
| Vulnerability management | Yes | No | |
| Remote control | Yes | No | |
| Public file sharing | Yes | No | |
| Web conference | Yes | No | |
| Backup | Yes | No |
* For vpn and dlp, the evidence is product detection only (detect.detected_products), without additional state calls.
How to use GetComplianceReport
Initialize the SDK with
wa_api_setup, as your integration already does.Call
GetComplianceReportthroughwa_api_invokewithframework_idandframework_version(see Input).Read the
endpointcontext and thecontrols[]array from the response.Apply your own compliance logic to the evidence, for example "an antimalware product is installed, real-time protection is on, and definitions are current".
Tear down the SDK with
wa_api_teardownwhen your integration finishes.
Input
Field | Type | Required | Description |
|---|---|---|---|
| Integer | Yes |
|
| String | Yes | Framework to report on: |
| String | Yes | Version of that framework: |
Both framework_id and framework_version are required in every mode, including generic.
PCI DSS 4.0.1 report
Generic report
Response structure
A successful call returns code 0 and the following fields:
Field | Description |
|---|---|
| The requested framework, echoed back. |
| Time the report was produced, in Unix epoch seconds (string). |
| Device context, collected once: |
| One entry per control the framework returns (see the table above). |
| The control ID and its description. |
| The framework's requirement IDs for the control. Present for |
| The |
| An object keyed by call name that holds the result of each follow-up call made for that product, for example |
A trimmed example for one control (values are illustrative):
How failures inside a report are handled
If a follow-up call fails for one product, for example
GetFirewallState, that entry inmethodsholds the call's error code instead of a result. The rest of the report is still returned, with code0.If
DetectProductsfails for a control,detectholds its error and has nodetected_products.If the compliance data in the data package is missing or malformed, the whole call fails and no partial report is returned, because an inaccurate compliance report is worse than none.
Error codes
Return code | Meaning |
|---|---|
| The report was generated. |
|
|
|
|
| Required compliance data is not available in the data package. |
| Required compliance data in the data package is malformed. |
| An internal inconsistency in the compliance data prevented evidence collection. This is a data package issue, not a request issue. |
| An underlying detection call returned a result the SDK did not expect. This is an internal issue, not a request issue. |
| Unexpected failure. |
If you receive -14, -15, -45 or -58, retrying is unlikely to help. Update to the latest data package, and if the error persists, open a support case with the json_in, json_out and SDK debug logs.
Related resources
OESIS V4 method reference (
GetComplianceReport, method1035)
If Further Assistance is required, please proceed to log a support case or chatting with our support engineer.