Register

Registers a new device. In production, a device for a connected account that has no active production device yet makes that account active, and is refused with 402 connected_account_limit_reached once your organization has as many active connected accounts as your Enterprise contract allows. Revoke every production device of a connected account to stop it counting.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The payload to register a device with ZATCA using a one-time password from the Fatoora portal.

string
required
length ≤ 64

The common name of the device.

string
required
length ≤ 255

The one-time password (OTP) generated on the ZATCA Fatoora portal: on the Fatoora Simulation Portal for a simulation device, on the live portal for a production device. It expires one hour after it is generated.

Headers
string

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

string

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.

Connected accounts are part of the E-invoicing Platform Enterprise plan. Without it, production requests for a connected account are refused with enterprise_plan_required, and only a simulation API key can create or change a connected account, so you can build and test your integration before you contact sales.

string

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

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json