Renew PCSID

Renews PCSID for an existing Device ID.

Request Method

POST

Request URL

{{BASE_URL}}/onboarding/renew-pcsid

Replace the {{BASE_URL}} with the one mentioned here based on whether you are using sandbox or production.

Request Headers

Parameter	Data Type	Field Validations	Description
x-cleartax-auth-token	String	Cannot be empty.	Mandatory. User auth token.
vat	String	Cannot be empty	Mandatory. VAT or Group VAT of the entity.

Request Path Params

There are no path parameters for this API.

Request Query Params

There are no query parameters for this API.

Request Body

Parameter	Data Type	Field Validations	Description
DeviceId	String	Cannot be empty.	Mandatory. The Device ID of the EGS Unit.
Otp	String	Should be a valid OTP.	Mandatory. The one time password generated by the user on the ZATCA portal. OTP once generated is valid only for 1 hour.

Sample Request

{
    "DeviceId": "2de86546-2b63-48a4-a81f-2b6d492aa261",
    "Otp": "123345"
}

Response Status Codes

HTTP Status Code	Description
200	For a successful PCSID renewal.
400	For any kind of validation issues.
401	If the user is not authenticated for the operation.
403	If the user is not authorized for the operation.

Response Schema

Parameter	Data Type	Field Validations	Description
Status	String	Enum: GENERATED FAILED	Mandatory. The status of PCSID Renewal. GENERATED: On successful renewal. FAILED: On validation issues.
DeviceId	String	MaxLength: 36	Mandatory. UUID. An identifier to exclusively identify the device getting onboarded. On successful Device ID generation, the field value will contain a UUID. On failure, the field will not be present in the response.
ErrorList	Array	NA	Optional. Validation Errors. An array of Error Details Objects. In case there are no errors, this will be an empty Array ([]).

Sample Response

Success - HTTP Status Code - 200

{
    "Status": "GENERATED",
    "DeviceId": "eb645fd8-ee2e-4bdd-82b6-b69c91c9178d",
    "ErrorList": []
}

Error - HTTP Status Code - 400

{
    "Status": "FAILED",
    "DeviceId": "72c6ab4f-c0bd-4ccf-b857-f12efd22b41a",
    "ErrorList": [
        {
            "ErrorCode": "6003",
            "ErrorMessage": "First time generation of PCSID was not completed",
            "ErrorSource": "CLEARTAX"
        }
    ]
}

API Validations

1. The DeviceId for which the PCSID is intended to be renewed, should already have an existing PCSID.

API Constraints

1. This API needs to be authenticated with a valid user authentication token. If the auth token is not present or is invalid, the API will return HTTP Status Code 401.

2. If the auth token is valid, but the user does not have the authorization to generate device ID, then the API will return HTTP Status Code 403. The user, whose auth token is used, should have an Admin role for the particular VAT used in the request.