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

ZATCA Production CSID Renewal API

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

Requests are submitted via HTTP POST to '/einvoice/production/csids/renewalapi'. Required parameters: 'OTP' (header parameter), '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 Renewal Request return?

For Production CSID Renewal Request (POST '/einvoice/production/csids/renewalapi'), 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/renewalapi

Renews an X509 Certificate (CSID) based on submitted CSR.

Parameters

header parameters

OTPstringrequired

OTP

Accept-Languagestringoptional

Accept-Language

Accept-Versionstringrequired

Accept-Version

Request Body

application/jsonrequired

csrstringoptional

csr

Example: "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQjJEQ0NBWDRDQVFBd1NERUxNQWtHQTFVRUJoTUNVMEV4RlRBVEJnTlZCQXNNREZKNWFXRmtJRUp5WVc1agphREVPTUF3R0ExVUVDZ3dGU21WeWFYSXhFakFRQmdOVkJBTU1DVEV5Tnk0d0xqQXVNVEJXTUJBR0J5cUdTTTQ5CkFnRUdCU3VCQkFBS0EwSUFCS2E0VG53UVBBQWp2cDAxV081UEgreXJlR2lkRkxXK2VTMUR5NXAxVkxMMktmZjQKRGg5dG9zZGphQ2ptNjBDc1AwQ09UZGNHdDROMnRmOHA2VkNmQW55Z2dkWXdnZE1HQ1NxR1NJYjNEUUVKRGpHQgp4VENCd2pBa0Jna3JCZ0VFQVlJM0ZBSUVGeE1WVkZOVVdrRlVRMEV0UTI5a1pTMVRhV2R1YVc1bk1JR1pCZ05WCkhSRUVnWkV3Z1k2a2dZc3dnWWd4S0RBbUJnTlZCQVFNSHpFdFZHVnpkSHd5TFZSbGMzUjhNeTB6TlRRek5UUXoKTlRnNE16UXpNalV4SHpBZEJnb0praWFKay9Jc1pBRUJEQTh6TVRBeE1qSXpPVE0xTURBd01ETXhEVEFMQmdOVgpCQXdNQkRFeE1EQXhFVEFQQmdOVkJCb01DRk5oYlhCc1pTQkZNUmt3RndZRFZRUVBEQkJUWVcxd2JHVWdRblZ6CmMybHVaWE56TUFvR0NDcUdTTTQ5QkFNQ0EwZ0FNRVVDSVFDVUxlaUFOc1FYZVpYejRVYjlxWkRGaUNJWlNXeXkKSE1odmpibjFzTnZsaFFJZ08zaFNVeEgvNkl5ckZzeXF2cHc3NnlyaVRQSzE3VHdONHhEK0lpaFpQR3c9Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQ=="

Response

returns a Base64 encoded X509 certificate

Frequently Asked Questions

Requests are submitted via HTTP POST to /einvoice/production/csids/renewalapi. Required parameters: OTP (header parameter), 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 Renewal Request (POST /einvoice/production/csids/renewalapi), 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.).

Renews an X509 Certificate (CSID) based on submitted CSR.

Production CSID Onboarding Request

Reporting API Request

POST/einvoice/production/csids/renewalapi

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

2 method: 'POST',

3 headers: {

4 OTP: "value",

5 Accept-Language: "value",

6 Accept-Version: "value",

7 Content-Type: "application/json"

8},

9 body: JSON.stringify({

10 "csr": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQjJEQ0NBWDRDQVFBd1NERUxNQWtHQTFVRUJoTUNVMEV4RlRBVEJnTlZCQXNNREZKNWFXRmtJRUp5WVc1agphREVPTUF3R0ExVUVDZ3dGU21WeWFYSXhFakFRQmdOVkJBTU1DVEV5Tnk0d0xqQXVNVEJXTUJBR0J5cUdTTTQ5CkFnRUdCU3VCQkFBS0EwSUFCS2E0VG53UVBBQWp2cDAxV081UEgreXJlR2lkRkxXK2VTMUR5NXAxVkxMMktmZjQKRGg5dG9zZGphQ2ptNjBDc1AwQ09UZGNHdDROMnRmOHA2VkNmQW55Z2dkWXdnZE1HQ1NxR1NJYjNEUUVKRGpHQgp4VENCd2pBa0Jna3JCZ0VFQVlJM0ZBSUVGeE1WVkZOVVdrRlVRMEV0UTI5a1pTMVRhV2R1YVc1bk1JR1pCZ05WCkhSRUVnWkV3Z1k2a2dZc3dnWWd4S0RBbUJnTlZCQVFNSHpFdFZHVnpkSHd5TFZSbGMzUjhNeTB6TlRRek5UUXoKTlRnNE16UXpNalV4SHpBZEJnb0praWFKay9Jc1pBRUJEQTh6TVRBeE1qSXpPVE0xTURBd01ETXhEVEFMQmdOVgpCQXdNQkRFeE1EQXhFVEFQQmdOVkJCb01DRk5oYlhCc1pTQkZNUmt3RndZRFZRUVBEQkJUWVcxd2JHVWdRblZ6CmMybHVaWE56TUFvR0NDcUdTTTQ5QkFNQ0EwZ0FNRVVDSVFDVUxlaUFOc1FYZVpYejRVYjlxWkRGaUNJWlNXeXkKSE1odmpibjFzTnZsaFFJZ08zaFNVeEgvNkl5ckZzeXF2cHc3NnlyaVRQSzE3VHdONHhEK0lpaFpQR3c9Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQ=="

11}),

12});

14const data = await response.json();

15console.log(data);

No example available.