PDF Password and IPFS

When using IPFS (InterPlanetary File System) to store and share PDF documents, PDF passwords can be used to provide an additional layer of security to the files. By encrypting a PDF document with a password, the file's content is protected even if it is accessed or downloaded from IPFS.

API Endpoint

POST

https://api.ovcode.com/ovcode-file/file/authentication/pdf-password/ipfs

Request Headers

Ocp-Apim-Subscription-Key
Your Enterprise Subscription Key
Api-Key
Your Enterprise Project API Key

Request Body multipart/form-data

Payload
file	Exclusive Support for PDF Files.
password	Provide PDF Password to secure the Digital Copy.

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