Parent API: KSA e-Invoice API Quickstart guide Authentication guide

ZATCA Production CSID Onboarding API

Q: What parameters and payload format are required for Production CSID Onboarding Request?

Requests are submitted via HTTP POST to '/einvoice/production/csids/onboardingapi'. Required parameters: 'Accept-Version' (header parameter). A JSON request body ('Content-Type: application/json') is accepted per the schema specifications shown in the request documentation.

Q: What response status codes and format does Production CSID Onboarding Request return?

For Production CSID Onboarding Request (POST '/einvoice/production/csids/onboardingapi'), responses are returned in JSON format ('application/json'). Documented response codes in the specification include: HTTP 200 (returns a Base64 encoded X509 certificate), HTTP 400 (HTTP Bad Request. Returned when the submitted request is invalid.), HTTP 401 (Returned when username and password are not added or added as wrong values.), HTTP 500 (HTTP Internal Server Error. Returned when the service faces internal errors.).

POSThttps://apisandbox.whitebooks.in/einvoice/production/csids/onboardingapi

This Production CSID is a simulation of ZATCA rootCA moreover it is used to sign einvoice documents and authenticate einvoicing api calls.

Parameters

header parameters

Auth-Keystringoptional

Auth-Key

Accept-Versionstringrequired

Accept-Version

Request Body

application/jsonrequired

compliance_request_idstringoptional

compliance_request_id

Example: "1234567890123"

Response

returns a Base64 encoded X509 certificate

Frequently Asked Questions

Requests are submitted via HTTP POST to /einvoice/production/csids/onboardingapi. Required parameters: Accept-Version (header parameter). A JSON request body (Content-Type: application/json) is accepted per the schema specifications shown in the request documentation.

For Production CSID Onboarding Request (POST /einvoice/production/csids/onboardingapi), responses are returned in JSON format (application/json). Documented response codes in the specification include: HTTP 200 (returns a Base64 encoded X509 certificate), HTTP 400 (HTTP Bad Request. Returned when the submitted request is invalid.), HTTP 401 (Returned when username and password are not added or added as wrong values.), HTTP 500 (HTTP Internal Server Error. Returned when the service faces internal errors.).

This Production CSID is a simulation of ZATCA rootCA moreover it is used to sign einvoice documents and authenticate einvoicing api calls.

Compliance Invoice Request

Production CSID Renewal Request

POST/einvoice/production/csids/onboardingapi

1const response = await fetch('https://apisandbox.whitebooks.in/einvoice/production/csids/onboardingapi', {

2 method: 'POST',

3 headers: {

4 Auth-Key: "value",

5 Accept-Version: "value",

6 Content-Type: "application/json"

7},

8 body: JSON.stringify({

9 "compliance_request_id": "1234567890123"

10}),

11});

13const data = await response.json();

14console.log(data);

No example available.