​
POST /v1/pdf/security/add

​
Attributes

Attributes are case-sensitive and should be inside JSON for POST request. for example: { "url": "https://example.com/file1.pdf" }
AttributeTypeRequiredDefaultDescription
urlstringYes-URL to the source file url attribute
callbackstringNo-The callback URL (or Webhook) used to receive the POST data. see Webhooks & Callbacks. This is only applicable when async is set to true.
asyncbooleanNofalseSet async to true for long processes to run in the background, API will then return a jobId which you can use with the Background Job Check endpoint. Also see Webhooks & Callbacks
namestringNo-File name for the generated output, the input must be in string format.
expirationintegerNo60Set the expiration time for the output link in minutes. After this specified duration, any generated output file(s) will be automatically deleted from PDF.co Temporary Files Storage. The maximum duration for link expiration varies based on your current subscription plan. To store permanent input files (e.g. re-usable images, pdf templates, documents) consider using PDF.co Built-In Files Storage.
ownerPasswordstringNo-The main owner password that is used for document encryption and for setting/removing restrictions.
userPasswordstringNo-The optional user password will be asked for viewing and printing document.
encryptionAlgorithmstringNoAES_128bitEncryption algorithm. AES_128bit or higher is recommended. The available algorithms are: RC4_40bit, RC4_128bit, AES_128bit, AES_256bit.
allowAccessibilitySupportbooleanNofalseAllow or prohibit content extraction for accessibility needs.
allowAssemblyDocumentbooleanNofalseAllow or prohibit assembling the document.
allowPrintDocumentbooleanNofalseAllow or prohibit printing PDF document.
allowFillFormsbooleanNofalseAllow or prohibit the filling of interactive form fields (including signature fields) in the PDF documents.
allowModifyDocumentbooleanNofalseAllow or prohibit modification of PDF document.
allowContentExtractionbooleanNofalseAllow or prohibit copying content from PDF document.
allowModifyAnnotationsbooleanNofalseAllow or prohibit interacting with text annotations and forms in PDF document.
printQualitystringNoHighResolutionAllowed printing quality. The available modes are: LowResolution, HighResolution.
profilesobjectNo-See Profiles for more information.
    outputDataFormatstringNo-If you require your output as base64 format, set this to base64
    DataEncryptionAlgorithmstringNo-Controls the encryption algorithm used for data encryption. See User-Controlled Encryption for more information. The available algorithms are: AES128, AES192, AES256.
    DataEncryptionKeystringNo-Controls the encryption key used for data encryption. See User-Controlled Encryption for more information.
    DataEncryptionIVstringNo-Controls the encryption IV used for data encryption. See User-Controlled Encryption for more information.
    DataDecryptionAlgorithmstringNo-Controls the decryption algorithm used for data decryption. See User-Controlled Encryption for more information. The available algorithms are: AES128, AES192, AES256.
    DataDecryptionKeystringNo-Controls the decryption key used for data decryption. See User-Controlled Encryption for more information.
    DataDecryptionIVstringNo-Controls the decryption IV used for data decryption. See User-Controlled Encryption for more information.
This restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters ownerPassword.

​
Query parameters

No query parameters accepted.

​
Responses

ParameterTypeDescription
urlstringDirect URL to the final PDF file stored in S3.
outputLinkValidTillstringTimestamp indicating when the output link will expire
pageCountintegerNumber of pages in the PDF document.
errorbooleanIndicates whether an error occurred (false means success)
statusstringStatus code of the request (200, 404, 500, etc.). For more information, see Response Codes.
namestringName of the output file
creditsintegerNumber of credits consumed by the request
remainingCreditsintegerNumber of credits remaining in the account
durationintegerTime taken for the operation in milliseconds

​
Example Payload

To see the request size limits, please refer to the Request Size Limits.
{
  "url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-merge/sample1.pdf",
  "ownerPassword": "12345",
  "userPassword": "54321",
  "EncryptionAlgorithm": "AES_128bit",
  "AllowPrintDocument": false,
  "AllowFillForms": false,
  "AllowModifyDocument": false,
  "AllowContentExtraction": false,
  "AllowModifyAnnotations": false,
  "PrintQuality": "LowResolution",
  "name": "output-protected.pdf",
  "async": false
}

​
Example Response

To see the main response codes, please refer to the Response Codes page.
{
  "url": "https://pdf-temp-files.s3.amazonaws.com/eaa441ade38548b8a3a96d8014c4f463/sample1.pdf",
  "pageCount": 1,
  "error": false,
  "status": 200,
  "name": "sample1.pdf",
  "remainingCredits": 616208,
  "credits": 14
}

​
Code Samples

curl --location --request POST 'https://api.pdf.co/v1/pdf/security/add' \
--header 'x-api-key: *******************' \
--header 'Content-Type: application/json' \
--data-raw '{
"url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-merge/sample1.pdf",
"ownerPassword": "12345",
"userPassword": "54321",
"EncryptionAlgorithm": "AES_128bit",
"AllowPrintDocument": false,
"AllowFillForms": false,
"AllowModifyDocument": false,
"AllowContentExtraction": false,
"AllowModifyAnnotations": false,
"PrintQuality": "LowResolution",
"name": "output-protected.pdf",
"async": false
}'