Unlock PDF
Security → Unlock PDF
The Unlock PDF API removes password protection from a PDF. You send the protected PDF as Base64 (docContent), docName, and password; optionally async. The API returns the unlocked PDF. Use the tester below to try it; more details are in the sections that follow.
Try the Unlock PDF API
Endpoint: POST /api/v2/Unlock · Required: api-key, docContent, docName, password
Use the form below to send your API key, password-protected PDF (Base64), docName, password, and optional async. The response is the unlocked PDF (binary or polling URL when async). No code required—fill the fields and click Send request.
Overview, parameters, and use cases
- Overview
- Parameters
- Use cases
What is Unlock PDF?
Many PDFs are protected with a user or owner password. The Unlock PDF endpoint accepts such a file and the correct password, verifies it, and returns a new PDF that opens without a password. Content and layout stay the same; only the security restriction is removed. Use async for large files to avoid timeouts.
Key features
- Password verification – The API checks the password you provide; if it matches, the document is decrypted and returned without protection.
- Single request – Send docContent (Base64), docName, and password; no extra steps.
- Async – async returns a URL to poll for the result when processing is asynchronous.
- Works with other APIs – After unlocking, you can pass the result to Merge Multiple PDF Files, Compress PDF, or other PDF4me endpoints.
Use when you need to remove password protection before merge, compress, or other operations. To add protection use Protect Document.
API parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| api-key | string | Yes | Your PDF4me API key, Base64 encoded. Get it from the dashboard. |
| docContent | base64 | Yes | Password-protected PDF file content (Base64). Tester allows file upload or paste. |
| docName | string | Yes | Output PDF file name (e.g. output.pdf). |
| password | string | Yes | The password that was used to protect the PDF. Must match exactly (case-sensitive). |
| async | boolean | No | Enable asynchronous processing. |
When to use Unlock PDF
- Batch processing – Unlock many password-protected PDFs (e.g. from scans or legacy systems) before merge, compress, or archive workflows.
- Compliance and archival – Store a version of documents without passwords for long-term access.
- Downstream operations – Merge, Split, Extract, and other PDF4me actions expect non–password-protected input; unlock once at the start of the pipeline.
- Testing – Use the API Tester on this page to confirm the correct password and behavior before integrating into your application.
For request/response schemas and code samples, see Unlock PDF in the PDF4me API docs.
Prerequisites
Before using this endpoint, make sure you have:
- A valid PDF4me API key (Get your API Key)
- A password-protected PDF file in Base64 format
- The password for the PDF
Response Format
The API returns an unlocked PDF file without password protection.