Renew PCSID

This API is used to Renew the PCSID.

Request Method

POST

Request URL

{{BASE_URL}}/Api/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	Validations and Example	Description
vat	String	Required	Mandatory
password	String	Required	Mandatory

Request Body

Parameter	Data Type	Validations and Example	Description
Otp	String		Mandatory
DeviceId	String		Mandatory
Certificate	String		Mandatory

Sample Request

{
    "Otp": "123456",
    "DeviceId": "A990A739-62B7-4988-8B96-4D72977DA436",
    "Certificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0F00SBSRVFVRVNULS0tLS0NCk1JSUNBVENDQWFnQ0FRQXdhakVMTUFrR0ExVUVCaE1DVTBFeEV6QVJCZ05WQkFzTUNqTXhNVEV6TXpjeE1Ea3gNCkhUQWJCZ05WQkFvTUZFVjJhVzVqYVdKc1pjS2dVMjlzZFhScGIyNXpNU2N3SlFZRFZRUUREQjVGVmxNdE16RXgNCk1UTXpOekV3T1Mwek1URXhNek0zTVRBNU1EQXdNRE13V1RBVEJnY3Foa2pPUFFJQkJnZ3Foa2pPUFFNQkJ3TkMNCkFBU0lhWlV1YmtWK0Jwd3h1cVdhdmVlaHBQckNhNFlaQXhvQmlYakRzSGFoNlJFR0ZDMHM1SUxGbmwvcUlYM0oNCkU5MXI2MjUxRjYyN2VoWUwzSExrdm1lWG9JSGJNSUhZQmdrcWhraUc5dzBCQ1E0eGdjb3dnY2N3SkFZSkt3WUINCkJBR0NOeFFDQkJjTUZWQlNSVnBCVkVOQkxVTnZaR1V0VTJsbmJtbHVaekNCbmdZRFZSMFJCSUdXTUlHVHBJR1ENCk1JR05NVHN3T1FZRFZRUUVEREl4TFVWV1Uzd3lMVVZXVTN3ekxURmtNalpsT1RsbExUbGhaR1V0TkdVeE5TMDQNCk4yVXdMVFF6WWpFMU9URmtObVV6TlRFZk1CMEdDZ21TSm9tVDhpeGtBUUVNRHpNeE1URXpNemN4TURrd01EQXcNCk16RU5NQXNHQTFVRURBd0VNVEF3TURFUk1BOEdBMVVFR2d3SVNrSlNRVFkxTXpReEN6QUpCZ05WQkE4TUFrbFUNCk1Bb0dDQ3FHU000OUJBTUNBMGNBTUVRQ0lBTnlEdXd3NTFJa2JsY2F0TXBNQld5K0Y1WWFKeURibnNTNWtsU2kNCnNKTVhBaUIwdGRGc0FwMmYyazFBdTRZbk0vamw5cWREWFFQZzdDZjVLZ05JellSczFRPT0NCi0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQ0K"
}

Response Status Codes

HTTP Status Code	Description
200	For a successful PCSID/Production generation.
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.
500	HTTP Internal Server Error. Returned when the service faces internal errors.

Response Schema

Parameter	Data Type	Description
Status	String	Mandatory
DeviceId	String	Mandatory
ErrorList	Array	optional

Sample Response

Success - HTTP Status Code - 200

{
    "Status": "GENERATED",
    "DeviceId": "A990A739-62B7-4988-8B96-4D72977DA436",
    "ErrorList": null
}

Error Message

{
    "ErrorList": "Object reference not set to an instance of an object."
}

API Validations

1. The Device ID and valid OTP for which the certificate is being renewal needs to be already present in Evs Engine before making this API request.

2. When PCSID has been renewed, expiry for the certificate has also been extended.

API Constraints

1. This API needs to be authenticated with a valid user name or vat number and password. If it is not present or is invalid, the API will generate an error.

2. If the user name and password is valid, but the user does not have the authorization to generate Invoice, 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.