Skip to content

Platform APIs and environments

Endpoints

NameMethodPath in the documentPurposeUsed by JooDax
Compliance CSIDPOST/complianceSends the CSR with an OTP from the FATOORA portal and returns the compliance certificate (binarySecurityToken), its secret and the request ID.Yes
Compliance invoice checkPOST/compliance/invoicesChecks sample documents signed with the compliance certificate before the production certificate is issued. The technical guidelines list three documents per type: invoice, debit note, credit note.Yes
Production CSID (onboarding)POST/production/csidsExchanges the compliance request ID for the production certificate (PCSID) used for stamping and reporting from then on.Yes
Production CSID (renewal)PATCH/production/csidsRenews the production certificate with a new CSR and a new OTP; the old certificate is revoked.No
Reporting (single)POST/invoices/reporting/singleReports a signed simplified document (invoice or note): 200 accepted, 202 accepted with warnings, 400 rejected, 409 already reported.Yes
Clearance (single)POST/invoices/clearance/singleClears a standard document; the platform returns it stamped with a QR code (clearedInvoice). Returns 303 when ZATCA has switched clearance off, in which case the document is sent through reporting.No

Environments

EnvironmentPurpose
Developer portal (Integration Sandbox)https://gw-fatoora.zatca.gov.sa/e-invoicing/developer-portalA test environment for developers; nothing sent there counts with ZATCA and its certificates do not work in production. The API pages show sample OTPs (such as 123345) but do not say that any OTP is accepted.
Simulationhttps://gw-fatoora.zatca.gov.sa/e-invoicing/simulationAn optional environment for end-to-end testing before production, with devices onboarded separately from production and an OTP from the FATOORA simulation portal valid for one hour.
Production (core)https://gw-fatoora.zatca.gov.sa/e-invoicing/coreThe live environment for reporting and clearance. OTPs come from the FATOORA portal (up to 100 per request, each valid for one hour); there is no API for them.

Sources

  1. Integration Sandbox API pages (Swagger): reporting, clearance, compliance, production CSID, renewal (ve-Invoicing Sandbox Release 2.1.0 (page lists 2.1.1 as latest)) — ZATCA

Checked on: 4 November 2026. What concerns JooDax is taken from the programs’ own code.