PKI or Public Key Infrastructure is the defined framework of encryption and cybersecurity that secures interchanges between the server and the customer. PKI features a symmetric key methodology - a private key and a public key. Only the proprietor of the DSC can access the personal key and they have the liberty to select where and to whom the general public key goes.
This document is intended for portals/developers/ websites to integrate the API into their web applications and desktop application.
This helps the user in making their entire signing work easy and secure.
The specification can always change at the last minute. This is intended for selected people and is confidential.
| Request Command | <Command> <ts> <txn> <certificate> <File> <Pdf> <Data> |
| <ts> | This is Time Stamping element, which the server would pass to the signing Tool. (This is an Optional Element) The Signing tool would compare with the client system Date and Time and see the difference, if there is a difference for 30 seconds from Server Date and Time it would not Sign. |
| <txn> | A unique ID could be passed with each signing request, it would help the web application to get responsive and map it to the correct request. (this is an Optional Element) |
| <certificate> | The application could also pass to a prompt signing tool to match for a certificate present in Browser Store and operations could be performed. (This is an Optional Element)
|
| <File> | Type= The Type of Data which needs to be Used by the Commands (This is a Mandatory Element) Allowed variables PDF, TXT, or XML inputFile =Unsigned file path (full), which needs to be signed (This is Optional if you passing <data> element) outputFile =Signed file copied here (optional) |
| <Page> | Only Numeric, Zero is not allowed |
| <cood> | Only Numeric allowed, two numeric values allowed, it would try to sign the pixels mentioned (depending on the resolutions of the file saved), else it would generate an error. Please separate the value by a comma, the first figure is horizontal and the next figure is vertical on the page (eg.79,100) |
| <size> | Only Numeric allowed, two numeric values allowed, and it would print the signature in the box mentioned here. Please separate the value by a comma the first figure is horizontal and the next figure is vertical on the page (eg.79,100) |
| <Invisiablesign> | For invisible signature. Allowed values are "yes" and "No" |
| <enableltv> | To enable the LTV. Allowed values are "yes" and "No" |
| <enabletimestamp> | To enable the embedded timestamp. Allowed values are "yes" and "No" |
| <data> | The actual data is encoded in Base64 format. (This is a Mandatory Element) |
This Element is used when <File> element is PDF (This is an Optional Element)
This is the actual command to help you perform operations using our applications
| S.NO. | COMMAND | DESCRIPTION |
|---|---|---|
| 01 | pkiNetworkSign | This command is used to Sign, XML, TEXT, and PDF, data has to be passed in Base64. |
| 02 | pkiNetworkSignHash | This Command is used to sign Hash instead of sending the Base64 File |
| 03 | pkiNetworkVerSign | This command is used to Verify Signature. |
You could pass any existing document (Text, Pdf, XML), with attributes and it would verify the signature | ||
| 04 | pkiNetworkEnc | This command is used for Encryption of Data. |
| 05 | pkiNetworkDeEnc | This command is used for De Encryption of data. |
| 06 | pkiNetworkCertExt | This command is used to extract details of the certificate. The response would be details of the certificate in XML format, No attributes can be passed |
| 07 | pkiNetworkCertAuth | This command is used to validate data and certificate details Response would be Valid/ Not Valid, and you could pass all attributes. |
| 08 | pkiNetworkFileEnc | This command is used to encrypt files from the client machine, when the command is initiated it would open a File browser window, a file would be selected, and the same file would be converted into Base64, and encrypted. |
| 09 | pkiNetworkFileEncSign | This command is used to encrypt files from the client machine, when the command is initiated it would open a File Browser window, a file would be selected, the same file would be converted into Base64, and encrypted, then the same data would be signed with the selected DSC. |
| 10 | pkiNetworkEncSign | This command is used to encrypt the block of the Text file and then the same data would be signed with the selected DSC. |
| 11 | pkiNetworkEncExt | This command is used to extract the P7B file of the encryption certificate and the same would be converted into Base64 and sent back as a response. |
| 12 | pkiNetworkFileSign | This command is used to Sign files from the client machine, when the command is initiated it would open a File Browser window, a file would be selected, and the same file would be converted into Base64, and encrypted. |
Our Errors are divided into four different categories
| Error Code | Error Message | Action |
|---|---|---|
| ER-01 | Latest version available | Download new version of the application |
| ER-02 | License expired | Renew your Software license |
| ER-03 | Internal error | Send error details by email to the support team. |
| ER-04 | Operation not allowed | An illegal operation was attempted. |
| ER-05 | Invalid command name | The command is not supported in this version of the software. Only allowed for listed commands |
| Error Code | Error Message | Action |
|---|---|---|
| CR-01 | No License Found | There was no certificate license found. |
| CR-02 | Chain certificate missing | Import root chain |
| CR-03 | Certificate not found | Please acquire software license or register DSC with PKI |
| CR-04 | Invalid CRL or OCSP | Please delete the files and sync the software |
| CR-05 | Invalid or corrupted licenses | Please delete all the license |
| Error Code | Error Message | Action |
|---|---|---|
| PE-02 | Missing or invalid data element value | file base64 with URL encoded |
| PE-03 | Invalid file type value | Pass any of the [XML, PDF, TEXT] |
| PE-04 | Page number is out of range | Enter page no according to PDF. and zero is not allowed |
| PE-05 | Invalid page number | Blank or zero is not allowed |
| PE-08 | Invalid type of certificate |
|
| Error Code | Error Message | Action |
|---|---|---|
| OT-02 | The action was cancelled by the user | Resend the request again |
| OT-03 | Private key is not found | Install the token driver / chek the certificate |
| OT-04 | USB device not responding | Reconnect USB device |
| OT-05 | Signing time out | Check date & time |
| OT-10 | Invalid base64 encoded data | file base64 with URL encoded |
