CTRL+K

PDF Restrict API

POST

https://api.apifreaks.com/v1.0/pdf/restrict

format

Format of the Response

file_idString

The unique ID of a file already present on our server. Use PDF Files API to see your files. Check file metadata using File Status API

destroyBoolean

Set to true if you want to permanently delete the original file after processing.

If false, files are retained on our server for up to 30 days based on user's plan. If true, inputs are deleted immediately after task completion and output files are deleted after downloading.

restrictionsArrayrequired

A list of restrictions to apply. These define what the end user is not allowed to do with the PDF. See available restrictions below table.

user_passwordStringrequired

Sets the password users will use to open the PDF. Password must be between 6 and 128 characters. If not set, only owner password will be set and anyone can open the PDF with the provided restrictions enabled.

owner_passwordString

Sets the password that allows full access (e.g., removing restrictions). If not provided, user_password (if set) is used as the owner password. Password must be between 6 and 128 characters.

file_passwordString

Password to unlock the input file if it is already secured. Provide the owner password if available, otherwise the user password. Owner password takes precedence.

outputString

Name of the output PDF (without extension).

outputString

Optionally specify a custom name for the output file (without extension).

webhook_urlString

Provide a URL to receive a webhook notification when the task is completed. The notification will include the task status and file ID(s) of the output.

webhook_failure_notificationBoolean

If true, we'll send an email notification if the webhook request fails after 3 retries. The email goes to the requesting user or their org admin if user is part of an organization.

Sample Responses

400

415

LANGUAGE

Python

PHP

Java

Node

Ruby


$ pip install requests
import requests 

url = "https://api.apifreaks.com/v1.0/pdf/restrict"

payload = {}
headers = {
	'X-apiKey': ''
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

RESPONSE

Click Test it to start the request and see the response here!

API Response

Field	Type	Requirement	Description
taskId	String	Mandatory	Unique identifier for the PDF task.
inputIds	Array	Optional	Array of unique file IDs referencing PDF files used in the PDF operation.

$ pip install requests

import requests 

url = "https://api.apifreaks.com/v1.0/pdf/restrict"

payload = {}
headers = {
	'X-apiKey': ''
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Field

Type

Requirement

Description

taskId

String

Mandatory

Unique identifier for the PDF task.

inputIds

Array

Optional

Array of unique file IDs referencing PDF files used in the PDF operation.