WAwafeq
Device

Revoke

Changed on

Endpoint for revoking the specific device.

post/zatca/devices/{id}/revoke/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/zatca/devices/{id}/revoke/
  • Auth
    API key in header Authorization

Path parameters

idstring required

A unique value identifying this device.

Headers

X-ZATCA-Branchstring

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used as a branch name

X-ZATCA-Connected-Account-Idstring

The unique identifier of the connected account you're operating on behalf of.

Connected accounts should be used only for Platforms and White Label integrations that onboard customers and report documents on their behalf. Omit the X-ZATCA-Connected-Account-Id header when registering devices or reporting documents for your own organization. See the Platforms and White Label guide.

X-ZATCA-Environmentstring

The ZATCA environment to use, one of ['production', 'simulation']. A ZATCA API key (starting with zatca_live_ or zatca_sim_) already names its environment, so the header is optional with it and must match it when sent. Other API keys and OAuth tokens need it.

Response

branchstring required

The TIN of the individual member under the Group VAT number the device belongs to.

common_namestring required

The common name of the device.

connected_accountstring nullable required

The id of the connected account the device belongs to, if any.

idstring required

The id of the object.

status'pending' | 'active' | 'failed' | 'revoked' required

Enrollment state of a ZATCA device.

View the enum reference

Changes

  • 6b4a622bbb4fRevision changes
    • breaking

      removed the request body

    • info

      the header request parameter X-ZATCA-Environment became optional

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status