v1

latestOpenAPI 3.1.12026-07-269084337.9 KB
Device

Revoke

Endpoint for revoking the specific device.

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

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

X-ZATCA-Environmentstring required

The zatca environment to use, available options are ['production', 'simulation']

Request body

common_namestring required

The common name of the device.

idstring required

The id of the object.

status'pending' | 'active' | 'failed' | 'revoked' required
  • pending - Pending
  • active - Active
  • failed - Failed
  • revoked - Revoked

Full information for StatusEnum

Response

common_namestring required

The common name of the device.

idstring required

The id of the object.

status'pending' | 'active' | 'failed' | 'revoked' required
  • pending - Pending
  • active - Active
  • failed - Failed
  • revoked - Revoked

Full information for StatusEnum