# Compliance ### CERTIFY_MODEL **Status: Implemented** Attests compliance of a Model Version to the Matter, Zigbee or Aliro certification. `REVOKE_MODEL_CERTIFICATION` should be used for revoking (disabling) the compliance. It's possible to call `CERTIFY_MODEL` for revoked model versions to enable them back. The corresponding Model and Model Version are not required to be present in the ledger. It can be added later by Vendors. If the Model Version is present on the ledger, then `softwareVersionString` and `cDVersionNumber` must match the values stored in the Model Version. It must be called for every compliant device for use cases where compliance is tracked on ledger. It can be used for use cases where only revocation is tracked on the ledger to remove a Model Version from the revocation list. - Parameters: - vid: `uint16` - Model vendor ID (positive non-zero) - pid: `uint16` - Model product ID (positive non-zero) - softwareVersion: `uint32` - Software Version of model - softwareVersionString: `string` - Software Version String of model - certificationType: `string` - Certification program applied to the model. Supported values are `zigbee`, `matter` or `aliro`. - specificationVersion: `uint32` - Specification version applicable to the device model, and it matches the SpecificationVersion attribute in the Basic Information Cluster of a device running the software certified by this DeviceModel record. For example, for `1.4.2.0` version this field should contain `0x01040200`. - certificationDate: `string` - The date of model certification (rfc3339 encoded), for example 2019-10-12T07:20:50.52Z - cdCertificateId: `string` - Connectivity Standards Alliance certification's certificate ID for the Certification that applies to this record. The value of this field is used in the Certification Declaration's `certificate_id` field for products using the VendorID, ProductID and SoftwareVersion in this schema entry. **Must be exactly 19 characters.** - reason: `optional(string)` - Optional comment describing the reason of certification - cdVersionNumber: `optional(uint32)` - CD Version Number of the certification - familyId: `optional(string)` - Product family to which the certified model belongs. Typical family IDs have the prefix FAM followed by a sequence of alphanumeric characters (e.g. FAM123456). - supportedClusters: `optional(string)` - Application cluster IDs supported by the device, as hexadecimal numbers in a comma-separated list. For example, for an Extended Color Light (implementing Matter 1.5) this field would contain (at least) 0x0003,0x0004,0x0006,0x0008,0x0062,0x0300. - certificationRoute: `optional(string)` - Various certification paths, such as Fully Tested, Certification by Similarity, Family/Portfolio Certification, Certification Transfer etc. Supported values are `fullTested`, `similarity`, `rapid-recert`, `fastTrack`, `ctp`, `family`, and `portfolio`. Note that some values could be added or removed in the future. - programType: `optional(string)` - Product type. Supported values are `endProduct`, `softwareComponent` or `compliantPlatform`. - programTypeVersion: `optional(string)` - Version of programType (see `programType` flag for supported programs). Can be used when `programType` is provided. - transport: `optional(string)` - Underlying communication technology the device uses to connect and exchange data. Supported transports are `thread`, `wi-fi`, `ethernet`, `bluetooth` and `nfc`. When multiple transports supported - should be used with comma-separator (e.g. `wi-fi,ethernet,bluetooth`). - parentChild: `optional(string)` - Parent vs. child characteristic when using the Product Family Certification or Portfolio Certification Program. Supported values are `parent` and `child`. - schemaVersion: `optional(uint16)` - Schema version to support backward/forward compatability. Should be equal to **`1`** (default 1, the v1 schema introduces `specificationVersion` and deprecates `compliantPlatformUsed` / `compliantPlatformVersion` / `OSVersion` / `certificationIDOfSoftwareComponent`). - compliantPlatformUsed: `optional(string)` - **Deprecated.** Certification ID of the compliant platform used with the product. - compliantPlatformVersion: `optional(string)` - **Deprecated.** Certified firmware version of Compliant Platform. - certificationIDOfSoftwareComponent: `optional(string)` - **Deprecated.** Certification ID of a software component. - OSVersion: `optional(string)` - **Deprecated.** Name and version of an operating system separated by whitespace. For example, `Android 16` or `iOS 26.4`. - In State: - `compliance/ComplianceInfo/value////` - `compliance/CertifiedModel/value////` - Who can send: - CertificationCenter - CLI command: - `dcld tx compliance certify-model --vid= --pid= --softwareVersion= --softwareVersionString= --certificationType= --specificationVersion= --certificationDate= --cdCertificateId= --from=` - CLI command full: - `dcld tx compliance certify-model --vid= --pid= --softwareVersion= --softwareVersionString= --certificationType= --specificationVersion= --certificationDate= --cdCertificateId= --reason= --cdVersionNumber= --familyId= --supportedClusters= --certificationRoute= --programType= --programTypeVersion= --transport= --parentChild= --schemaVersion= --from=` ### UPDATE_COMPLIANCE_INFO **Status: Implemented** Updates a compliance info by VID, PID, Software Version and Certification Type. - Parameters: - vid: `uint16` - Model vendor ID (positive non-zero) - pid: `uint16` - Model product ID (positive non-zero) - softwareVersion: `uint32` - Software Version of model - certificationType: `string` - Certification program applied to the model. Supported values are `zigbee`, `matter` or `aliro`. - specificationVersion: `optional(uint32)` - Specification version applicable to the device model, and it matches the SpecificationVersion attribute in the Basic Information Cluster of a device running the software certified by this DeviceModel record. For example, for `1.4.2.0` version this field should contain `0x01040200`. - certificationDate: `optional(string)` - The date of model certification (rfc3339 encoded), for example 2019-10-12T07:20:50.52Z - cdCertificateId: `optional(string)` - Connectivity Standards Alliance certification's certificate ID for the Certification that applies to this record. The value of this field is used in the Certification Declaration's `certificate_id` field for products using the VendorID, ProductID and SoftwareVersion in this schema entry. **When provided, must be exactly 19 characters.** - reason: `optional(string)` - Optional comment describing the reason of certification - cdVersionNumber: `optional(string)` - CD Version Number of the certification (uint32-parsable string), must be the same as the associated model version - owner: `optional(string)` - Owner of the compliance info record - familyId: `optional(string)` - Product family to which the certified model belongs. Typical family IDs have the prefix FAM followed by a sequence of alphanumeric characters (e.g. FAM123456). - supportedClusters: `optional(string)` - Application cluster IDs supported by the device, as hexadecimal numbers in a comma-separated list. For example, for an Extended Color Light (implementing Matter 1.5) this field would contain (at least) 0x0003,0x0004,0x0006,0x0008,0x0062,0x0300. - certificationRoute: `optional(string)` - Various certification paths, such as Fully Tested, Certification by Similarity, Family/Portfolio Certification, Certification Transfer etc. Supported values are `fullTested`, `similarity`, `rapid-recert`, `fastTrack`, `ctp`, `family`, and `portfolio`. Note that some values could be added or removed in the future. - programType: `optional(string)` - Product type. Supported values are `endProduct`, `softwareComponent` or `compliantPlatform`. - programTypeVersion: `optional(string)` - Version of programType (see `programType` flag for supported programs). Can be used when `programType` is provided. - transport: `optional(string)` - Underlying communication technology the device uses to connect and exchange data. Supported transports are `thread`, `wi-fi`, `ethernet`, `bluetooth` and `nfc`. When multiple transports supported - should be used with comma-separator (e.g. `wi-fi,ethernet,bluetooth`). - parentChild: `optional(string)` - Parent vs. child characteristic when using the Product Family Certification or Portfolio Certification Program. Supported values are `parent` and `child`. - schemaVersion: `optional(uint16)` - Schema version to support backward/forward compatability. Should be equal to **`1`** (default 1, the v1 schema introduces `specificationVersion` and deprecates `compliantPlatformUsed` / `compliantPlatformVersion` / `OSVersion` / `certificationIDOfSoftwareComponent`). - compliantPlatformUsed: `optional(string)` - **Deprecated.** Certification ID of the compliant platform used with the product. - compliantPlatformVersion: `optional(string)` - **Deprecated.** Certified firmware version of Compliant Platform. - certificationIDOfSoftwareComponent: `optional(string)` - **Deprecated.** Certification ID of a software component. - OSVersion: `optional(string)` - **Deprecated.** Name and version of an operating system separated by whitespace. For example, `Android 16` or `iOS 26.4`. - Who can send: - CertificationCenter - CLI command: - `dcld tx compliance update-compliance-info --vid= --pid= --softwareVersion= --certificationType= --from=` - CLI command full: - `dcld tx compliance update-compliance-info --vid= --pid= --softwareVersion= --certificationType= --specificationVersion= --cdVersionNumber= --certificationDate= --reason= --cdCertificateId= --owner= --certificationRoute= --programType= --programTypeVersion= --transport= --familyId= --supportedClusters= --parentChild= --schemaVersion= --from=` - REST API: - `/dcl/compliance/update-compliance-info` ### DELETE_COMPLIANCE_INFO **Status: Implemented** Delete compliance of the Model Version to the Matter, Zigbee or Aliro certification. The corresponding Compliance Info is required to be present on the ledger - Parameters: - vid: `uint16` - Model vendor ID (positive non-zero) - pid: `uint16` - Model product ID (positive non-zero) - softwareVersion: `uint32` - Software Version of model - certificationType: `string` - Certification program applied to the model. Supported values are `zigbee`, `matter` or `aliro`. - Who can send: - CertificationCenter - CLI command: - `dcld tx compliance delete-compliance-info --vid= --pid= --softwareVersion= --certificationType= --from=` ### REVOKE_MODEL_CERTIFICATION **Status: Implemented** Revoke compliance of the Model Version to the Matter, Zigbee or Aliro certification. The corresponding Model Version must be present on the ledger, and `softwareVersionString` and `cDVersionNumber` must match the values stored in the Model Version. It can be used in cases where every compliance result is written on the ledger (`CERTIFY_MODEL` was called), or cases where only revocation list is stored on the ledger. - Parameters: - vid: `uint16` - Model vendor ID (positive non-zero) - pid: `uint16` - Model product ID (positive non-zero) - softwareVersion: `uint32` - Software Version of model - softwareVersionString: `string` - Software Version String of model - certificationType: `string` - Certification program applied to the model. Supported values are `zigbee`, `matter` or `aliro`. - revocationDate: `string` - The date of model revocation (rfc3339 encoded), for example 2019-10-12T07:20:50.52Z - reason: `optional(string)` - Optional comment describing the reason of revocation - cdVersionNumber: `optional(uint32)` - CD Version Number of the certification - schemaVersion: `optional(uint16)` - Schema version to support backward/forward compatability. Should be equal to **`1`** (default 1). - In State: - `compliance/ComplianceInfo/value////` - `compliance/RevokedModel/value////` - Who can send: - CertificationCenter - CLI command: - `dcld tx compliance revoke-model --vid= --pid= --softwareVersion= --softwareVersionString= --certificationType= --revocationDate= --from=` - CLI command full: - `dcld tx compliance revoke-model --vid= --pid= --softwareVersion= --softwareVersionString= --certificationType= --revocationDate= --reason= --cdVersionNumber= --schemaVersion= --from=` ### PROVISION_MODEL **Status: Implemented** Sets a provisional certification state for a Model Version. It allows production and distribution of the Model Version to occur in parallel with certification (with potential software fixes yielding a higher SoftwareVersion which gets certification). The corresponding Model and Model Version are not required to be present in the ledger. It can be added later by Vendors. If the Model Version is present on the ledger, then `softwareVersionString` and `cDVersionNumber` must match the values stored in the Model Version. Can not be set if there is already a certification record on the ledger (certified or revoked). - Parameters: - vid: `uint16` - Model vendor ID (positive non-zero) - pid: `uint16` - Model product ID (positive non-zero) - softwareVersion: `uint32` - Software Version of model - softwareVersionString: `string` - Software Version String of model - certificationType: `string` - Certification program applied to the model. Supported values are `zigbee`, `matter` or `aliro`. - specificationVersion: `uint32` - Specification version applicable to the device model, and it matches the SpecificationVersion attribute in the Basic Information Cluster of a device running the software certified by this DeviceModel record. For example, for `1.4.2.0` version this field should contain `0x01040200`. - provisionalDate: `string` - The date of model provisional certification (rfc3339 encoded), for example 2019-10-12T07:20:50.52Z - cdCertificateId: `string` - Connectivity Standards Alliance certification's certificate ID for the Certification that applies to this record. The value of this field is used in the Certification Declaration's `certificate_id` field for products using the VendorID, ProductID and SoftwareVersion in this schema entry. **Must be exactly 19 characters.** - reason: `optional(string)` - Optional comment describing the reason of provisioning - cdVersionNumber: `optional(uint32)` - CD Version Number of the certification - familyId: `optional(string)` - Product family to which the certified model belongs. Typical family IDs have the prefix FAM followed by a sequence of alphanumeric characters (e.g. FAM123456). - supportedClusters: `optional(string)` - Application cluster IDs supported by the device, as hexadecimal numbers in a comma-separated list. For example, for an Extended Color Light (implementing Matter 1.5) this field would contain (at least) 0x0003,0x0004,0x0006,0x0008,0x0062,0x0300. - certificationRoute: `optional(string)` - Various certification paths, such as Fully Tested, Certification by Similarity, Family/Portfolio Certification, Certification Transfer etc. Supported values are `fullTested`, `similarity`, `rapid-recert`, `fastTrack`, `ctp`, `family`, and `portfolio`. Note that some values could be added or removed in the future. - programType: `optional(string)` - Product type. Supported values are `endProduct`, `softwareComponent` or `compliantPlatform`. - programTypeVersion: `optional(string)` - Version of programType (see `programType` flag for supported programs). Can be used when `programType` is provided. - transport: `optional(string)` - Underlying communication technology the device uses to connect and exchange data. Supported transports are `thread`, `wi-fi`, `ethernet`, `bluetooth` and `nfc`. When multiple transports supported - should be used with comma-separator (e.g. `wi-fi,ethernet,bluetooth`). - parentChild: `optional(string)` - Parent vs. child characteristic when using the Product Family Certification or Portfolio Certification Program. Supported values are `parent` and `child`. - schemaVersion: `optional(uint16)` - Schema version to support backward/forward compatability. Should be equal to **`1`** (default 1, the v1 schema introduces `specificationVersion` and deprecates `compliantPlatformUsed` / `compliantPlatformVersion` / `OSVersion` / `certificationIDOfSoftwareComponent`). - compliantPlatformUsed: `optional(string)` - **Deprecated.** Certification ID of the compliant platform used with the product. - compliantPlatformVersion: `optional(string)` - **Deprecated.** Certified firmware version of Compliant Platform. - certificationIDOfSoftwareComponent: `optional(string)` - **Deprecated.** Certification ID of a software component. - OSVersion: `optional(string)` - **Deprecated.** Name and version of an operating system separated by whitespace. For example, `Android 16` or `iOS 26.4`. - In State: - `compliance/ComplianceInfo/value////` - `compliance/ProvisionalModel/value////` - Who can send: - CertificationCenter - CLI command: - `dcld tx compliance provision-model --vid= --pid= --softwareVersion= --softwareVersionString= --certificationType= --specificationVersion= --provisionalDate= --cdCertificateId= --from=` - CLI command full: - `dcld tx compliance provision-model --vid= --pid= --softwareVersion= --softwareVersionString= --certificationType= --specificationVersion= --provisionalDate= --cdCertificateId= --reason= --cdVersionNumber= --familyId= --supportedClusters= --certificationRoute= --programType= --programTypeVersion= --transport= --parentChild= --schemaVersion= --from=` ### GET_CERTIFIED_MODEL **Status: Implemented** Gets a structure containing the Model Version / Certification Type key (`vid`, `pid`, `softwareVersion`, `certificationType`) and a flag (`value`) indicating whether the given Model Version is compliant to `certificationType` standard. This is the aggregation of compliance and revocation information for every vid/pid/softwareVersion/certificationType. It should be used in cases where compliance is tracked on the ledger. This function responds with `NotFound` (404 code) if Model Version was never certified earlier. This function returns `true` if compliance information is found on ledger and it's in `certified` state. You can use `GET_COMPLICE_INFO` method to get the whole compliance information. - Parameters: - vid: `uint16` - Model vendor ID (positive non-zero uint16) - pid: `uint16` - Model product ID (positive non-zero uint16) - softwareVersion: `uint32` - Software Version of model (uint32) - certification_type: `string` - Certification program applied to the model. Supported values are `zigbee`, `matter` or `aliro`. - CLI command: - `dcld query compliance certified-model --vid= --pid= --softwareVersion= --certificationType=` - REST API: - GET `/dcl/compliance/certified-models/{vid}/{pid}/{software_version}/{certification_type}` ### GET_REVOKED_MODEL **Status: Implemented** Gets a structure containing the Model Version / Certification Type key (`vid`, `pid`, `softwareVersion`, `certificationType`) and a flag (`value`) indicating whether the given Model Version is revoked for `certificationType` standard. It contains information about revocation only, so it should be used in cases where only revocation is tracked on the ledger. This function responds with `NotFound` (404 code) if Model Version was never certified or revoked earlier. This function returns `true` if compliance information is found on ledger and it's in `revoked` state. You can use `GET_COMPLICE_INFO` method to get the whole compliance information. - Parameters: - vid: `uint16` - Model vendor ID (positive non-zero uint16) - pid: `uint16` - Model product ID (positive non-zero uint16) - softwareVersion: `uint32` - Software Version of model (uint32) - certification_type: `string` - Certification program applied to the model. Supported values are `zigbee`, `matter` or `aliro`. - CLI command: - `dcld query compliance revoked-model --vid= --pid= --softwareVersion= --certificationType=` - REST API: - GET `/dcl/compliance/revoked-models/{vid}/{pid}/{software_version}/{certification_type}` ### GET_PROVISIONAL_MODEL **Status: Implemented** Gets a structure containing the Model Version / Certification Type key (`vid`, `pid`, `softwareVersion`, `certificationType`) and a flag (`value`) indicating whether the given Model Version is in provisional state for `certificationType` standard. This function responds with `NotFound` (404 code) if Model Version was never provisioned or certified earlier. This function returns `true` if compliance information is found on the ledger and it's in `provisional` state. You can use `GET_COMPLICE_INFO` method to get the whole compliance information. - Parameters: - vid: `uint16` - Model vendor ID (positive non-zero uint16) - pid: `uint16` - Model product ID (positive non-zero uint16) - softwareVersion: `uint32` - Software Version of model (uint32) - certification_type: `string` - Certification program applied to the model. Supported values are `zigbee`, `matter` or `aliro`. - CLI command: - `dcld query compliance provisional-model --vid= --pid= --softwareVersion= --certificationType=` - REST API: - GET `/dcl/compliance/provisional-models/{vid}/{pid}/{software_version}/{certification_type}` ### GET_COMPLIANCE_INFO **Status: Implemented** Gets compliance information associated with the Model Version and Certification Type (identified by the `vid`, `pid`, `softwareVersion` and `certification_type`). It can be used instead of GET_CERTIFIED_MODEL / GET_REVOKED_MODEL / GET_PROVISIONAL_MODEL methods to get the whole compliance information without additional state check. This function responds with `NotFound` (404 code) if compliance information is not found in store. - Parameters: - vid: `uint16` - Model vendor ID (positive non-zero uint16) - pid: `uint16` - Model product ID (positive non-zero uint16) - softwareVersion: `uint32` - Software Version of model (uint32) - certification_type: `string` - Certification program applied to the model. Supported values are `zigbee`, `matter` or `aliro`. - CLI command: - `dcld query compliance compliance-info --vid= --pid= --softwareVersion= --certificationType=` - REST API: - GET `/dcl/compliance/compliance-info/{vid}/{pid}/{software_version}/{certification_type}` ### GET_DEVICE_SOFTWARE_COMPLIANCE **Status: Implemented** Gets device software compliance associated with the `cDCertificateId`. This function responds with `NotFound` (404 code) if device software compliance is not found in store. - Parameters: - cDCertificateId: `string` - CD Certificate ID - CLI command: - `dcld query compliance device-software-compliance --cDCertificateId=` - REST API: - GET `/dcl/compliance/device-software-compliance/{cDCertificateId}` ### GET_ALL_CERTIFIED_MODELS **Status: Implemented** Gets all compliant Model Versions for all vendors (`vid`s). This is the aggregation of compliance and revocation information for every vid/pid. It should be used in cases where compliance is tracked on ledger. Should be sent to trusted nodes only. - Parameters: - Common pagination parameters (see [pagination-params](#common-pagination-parameters)) - CLI command: - `dcld query compliance all-certified-models` - REST API: - GET `/dcl/compliance/certified-models` ### GET_ALL_REVOKED_MODELS **Status: Implemented** Gets all revoked Model Versions for all vendors (`vid`s). It contains information about revocation only, so it should be used in cases where only revocation is tracked on the ledger. Should be sent to trusted nodes only. - Parameters: - Common pagination parameters (see [pagination-params](#common-pagination-parameters)) - CLI command: - `dcld query compliance all-revoked-models` - REST API: - GET `/dcl/compliance/revoked-models` ### GET_ALL_PROVISIONAL_MODELS **Status: Implemented** Gets all Model Versions in provisional state for all vendors (`vid`s). Should be sent to trusted nodes only. - Parameters: - Common pagination parameters (see [pagination-params](#common-pagination-parameters)) - CLI command: - `dcld query compliance all-provisional-models` - REST API: - GET `/dcl/compliance/provisional-models` ### GET_ALL_COMPLIANCE_INFO_RECORDS **Status: Implemented** Gets all stored compliance information records for all vendors (`vid`s). Should be sent to trusted nodes only. - Parameters: - Common pagination parameters (see [pagination-params](#common-pagination-parameters)) - CLI command: - `dcld query compliance all-compliance-info` - REST API: - GET `/dcl/compliance/compliance-info` ### GET_ALL_DEVICE_SOFTWARE_COMPLIANCES **Status: Implemented** Gets all stored device software compliance's. Should be sent to trusted nodes only. - Parameters: - Common pagination parameters (see [pagination-params](#common-pagination-parameters)) - CLI command: - `dcld query compliance all-device-software-compliance` - REST API: - GET `/dcl/compliance/device-software-compliance`