DSS and Email
DSS can be used to generate and verify digital signatures, which can be used to authenticate the identity of the signer and ensure the integrity of the signed file. Seamlessly Email the Authenticated Data to Your Users.
API Endpoint
POST
https://api.ovcode.com/ovcode-file/file/authentication/dss/email
Request Headers
Ocp-Apim-Subscription-KeyYour Enterprise Subscription KeyApi-KeyYour Enterprise Project API Key
Request Body multipart/form-data
Payload | |
---|---|
file | Exclusive Support for PDF Files. |
subject | The subject of an email is a brief statement or phrase that summarizes the content or purpose of the message. |
to | Specifies the recipient's email address. |
body | The body of an email is the main content area where you compose your message. |
cc | CC stands for "carbon copy," and it is used to send a copy of the email to additional recipients. |
is_html | true or false value to specify the email body format. |
Optional Payload
OVI Reference | |
---|---|
encrypted_reference (optional) | Generate an OVI Reference to be embedded within the document. Learn more. |
encrypted_ovi (optional) | Generate an Encrypted OVI Reference + JSON Data for Embedding in the Document with your JSON Data. Learn more. |
Template | |
---|---|
template_code (optional) | Create a Template within Your Enterprise Portal Account for Automated Population of Elements such as eSignatures, eSeals, QR Codes, and More. |
API Response
Success{
"success": true,
"data": {
"template_code": "<Template Code>",
"reference": "D-550e8400-e29b-41d4-a716-446655440000",
"hash": "c8f0499x0x5791b56bbex56b9ee5bx199210f9x329eb9e4xc122c8650db229c1",
"pipeline": "<Pipeline>"
},
"error": null
}
Error
{
"success": false,
"data": null,
"error": "<Error Message>"
}
HTTP Status Codes
Code | Description |
---|---|
200 | OK |
201 | Created |
204 | No Content |
400 | Bad Request |
401 | Unauthorized |
404 | Not Found |
415 | Unsupported Media Type |
500 | Internal Server Error |