Generate and Submit Key Auth OTP API
IMPORTANT NOTE: While calling Sign API, if you had set OTP Authentication for Key uses, you need to first call GenKeyAuthOTP and SetKeyAuthOTP to enable key uses. The related error codes are: 'OA03A' or 'OA03B' or 'OA04' If these error codes are returned then call GenKeyAuthOTP and to submit received OTP call SetKeyAuthOTP API before trying to call Sign API again.
GenKeyAuthOTP action
GenKeyAuthOTP action is used to generate Private Key Authorization OTP and send by sms and eMail of owner CSC.
HTTP Method: GET
Query String Param:
|
Property
|
Description
|
Data Type
|
|
KeyLabel
|
KeyLabel of Private Key for which Authorization OTP is to be generated.
|
String
|
|
ClientAppProfName
|
(Optional) Client Application Profile Name if Key Authorization is to be done for specific client application.
|
String
|
Sample Url:
https://api.signer.digital/signer/KeyAuthV1/GenKeyAuthOTP?CscId=<===YourCscId===>&Password=<== Pwd ==>&KeyLabel=InvoiceSigner&CertProfileName=MyBillingERP
Please note that CscId and Password may be in headers.
Response: RespErrPl
|
Property
|
Description
|
Data Type
|
|
Status_cd
|
"1" for success, "0" for Failure.
|
String
|
|
Error_cd
|
Error code in case of error.
|
String
|
|
Message
|
Error message in case of error.
|
String
|
SetKeyAuthOTP action
SetKeyAuthOTP action is used to submit Private Key Authorization OTP to Kluis to refresh authorization.
HTTP Method: POST
Query String Param: None
Body: ReqSetKeyAuthOTP
|
Property
|
Description
|
Data Type
|
|
OTP
|
OTP received on mobile or eMail for Pvt. Key Authorization.
|
String
|
|
KeyLabel
|
KeyLabel of Private Key for which Authorization OTP is to be submitted.
|
String
|
|
ClientAppProfName
|
(Optional) Client Application Profile Name if Key Authorization is to be done for specific client application. This should be same as in Generate OTP API call.
|
String
|
Sample Url:
https://api.signer.digital/signer/KeyAuthV1/SetKeyAuthOTP
Please note that CscId and Password may be in headers.
Response: RespErrPl
|
Property
|
Description
|
Data Type
|
|
Status_cd
|
"1" for success, "0" for Failure.
|
String
|
|
Error_cd
|
Error code in case of error.
|
String
|
|
Message
|
Error message in case of error.
|
String
|
