SearchCtrl+K

PDF Unrestrict API Reference

Remove permission restrictions from a PDF file using the owner password.

POST

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

The PDF Unrestrict API removes all permission restrictions from a secured PDF. Provide the owner password to unlock editing, printing, and copying capabilities. The output file will have no restrictions applied.

Getting Started

Authentication

Pass your API key as the apiKey parameter in every request.

API Version

This is version v1.0 of the API.

LANGUAGE

curl --location --request POST 'https://api.apifreaks.com/v1.0/pdf/unrestrict' \
--header 'X-apiKey: API-KEY' \
--form 'file=@"/path/to/file.pdf"'

Response

{
  "taskId": "04a06cd5-158d-4191-a45b-6f58249c599d",
  "inputIds": [
    "7a9e4b12-f3c8-4d56-b7e1-8c2f9d0a3e6f"
  ]
}

API Request Parameters

The following parameters can be used in your API requests. File upload and webhook parameters are passed as multipart form data and query parameters.

file_idoptionalString

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

destroyoptionalBooleandefault: false

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

file_passwordrequiredString

Password to unlock the input file. Either the owner or user password can be provided. The owner password takes precedence.

user_passwordoptionalString

Set new user password for the PDF file. Password must be between 6 and 128 characters. Either user_password or owner_password must be provided.

owner_passwordoptionalString

Set new owner password for the PDF file. Password must be between 6 and 128 characters. If only owner_password is provided, it will be used as both owner and user password.

outputoptionalString

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

webhook_urloptionalString

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_notificationoptionalBooleandefault: false

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.

Request Headers

Optional custom headers for webhook authorization.

X-Webhook-AuthorizationoptionalString

Custom authorization header sent with the webhook request. Format: Key:Value (e.g., Authorization:Bearer token123).

API Response Schema

A successful request returns a 200 OK response with a JSON object containing the task ID and input file IDs.

taskId

Stringmandatory

Unique identifier for the PDF task, used to check status.

inputIds

Array<String>optional

Array of file IDs referencing input files used for the task. Not returned when destroy=true.

Error Status & Codes

The API uses standard HTTP status codes to indicate the success or failure of requests. For common status codes like 429 (Too Many Requests), refer to the general API documentation.

400

Please provide either a file or a file ID.

400

Please provide a valid file ID