CSC Utility API
GetCscDetails action
GetCscDetails action returns CscID and ApiBaseUrl for given UserID (registered eMailId and password)
HTTP Method: GET
CscId is not required for this API call but UserID is required.
Sample Url:
https://api.signer.digital/signer/CscUtilsV1/GetCscDetails?UserId=<===Your UserId (email)===>&Password=<===YourPassword===>
Response: APIResp
|
Property
|
Description
|
Data Type
|
|
Status_cd
|
"1" for success, "0" for Failure.
|
Double
|
|
Data
|
Json containt 2 properties: CscId, and ApiBaseUrl
|
Json
|
GetApiBalance action
HTTP Method: GET
Sample Url:
https://api.signer.digital/signer/CscUtilsV1/GetApiBalance?CscId=<===YourAspId===>&Password=<===YourPassword===>
Response:
|
Property
|
Description
|
Data Type
|
|
ApiBal
|
Api Balance in Pre-paid CSC Account.
|
Double
|
|
ApiBalExpDt
|
Api Balance Expiary Date.
|
DateTime
|
GetCertProfiles action
HTTP Method: GET
Sample Url:
https://api.signer.digital/signer/CscUtilsV1/GetCertProfiles?CscId=<===YourAspId===>&Password=<===YourPassword===>
Response: List<CSCCertProfile>
|
Property
|
Description
|
Data Type
|
|
ProfileName
|
Profile Name.
|
String
|
|
ProfileActive
|
Is Profile Active.
|
Boolean
|
InitChangeCscPassword action
HTTP Method: GET
Sample Url:
https://api.signer.digital/signer/CscUtilsV1/InitChangeCscPassword
Response: APIResp
|
Property
|
Description
|
Data Type
|
|
Status_cd
|
"1" for success, "0" for Failure.
|
Double
|
|
Data
|
"Document Signer PIN Changed Successful."
|
String
|
On Error: Return type is RespErrPl
ConfirmCscPwdOTP action
HTTP Method: POST
Sample Url:
https://api.signer.digital/signer/CscUtilsV1/ConfirmCscPwdOTP
Request: CscPasswordChangeReq
|
Property
|
Description
|
Data Type
|
|
OTP
|
OTP received on mobile number of Csc for changing Csc Password
|
String
|
|
NewPassword
|
New CSC Password to be set.
|
String
|
Response: APIResp
|
Property
|
Description
|
Data Type
|
|
Status_cd
|
"1" for success, "0" for Failure.
|
Double
|
|
Data
|
"CSC Password Changed Successful."
|
String
|
On Error: Return type is RespErrPl
InitChangeDocSignerPin action
HTTP Method: GET
Query Param: KeyLabel - Kluis Doc Signer Key Label
Sample Url:
https://api.signer.digital/signer/CscUtilsV1/InitChangedocSignerPin?KeyLabel=<Kluis Doc Signer Key Label>
Response: APIResp
|
Property
|
Description
|
Data Type
|
|
Status_cd
|
"1" for success, "0" for Failure.
|
Double
|
|
Data
|
"Document Signer PIN Changed Successful."
|
String
|
On Error: Return type is RespErrPl
ConfirmDocSignerPinOTP action
HTTP Method: POST
Sample Url:
https://api.signer.digital/signer/CscUtilsV1/ConfirmDocSignerPinOTP
Request: ChangeDocSignerPinReq
|
Property
|
Description
|
Data Type
|
|
KeyLabel
|
Document Signer KeyLabel for CscId.
|
String
|
|
OTP
|
OTP received on mobile number of Csc for changing Doc Signer Pin
|
String
|
|
OldPin
|
Old Doc Signer Pin.
|
String
|
|
NewPin
|
New Doc Signer Pin to be set.
|
String
|
Response: APIResp
|
Property
|
Description
|
Data Type
|
|
Status_cd
|
"1" for success, "0" for Failure.
|
Double
|
|
Data
|
"Document Signer PIN Changed Successful."
|
String
|
On Error: Return type is RespErrPl
---------------
