PDF tools

Unlock a password-protected PDF

Returns a copy of a protected PDF with no password and no restrictions, which the merge, split and edit endpoints accept.

A correct password is always required. A PDF with a password to open is unlocked by that password or by its owner password. A PDF that opens without a password but restricts printing, copying or editing needs its owner password.

Send the PDF in the request (up to 4 MB) or by source_key (up to 150 MB and 5000 pages). A wrong password is 422 PDF_PASSWORD_INCORRECT and is not charged.

post/pdf/unlock

Request

  • Base URL: https://api.podpdf.com
  • URL: https://api.podpdf.com/pdf/unlock
  • Auth: API key in header X-API-Key

Request body

source_keystring

Key from /pdf/upload-url. Give this or input.

filenamestring
passwordstring password required

The password to open the PDF, or its owner password.

storeboolean

Example request

{
  "input": {
    "filename": "contract.pdf"
  },
  "source_key": "pdf-uploads/01HZ…/01J8…pdf",
  "filename": "statement.pdf"
}

Response

The unlocked PDF, or JSON when store is true or the PDF was given by source_key

job_idstring
operation'pdf_protect' | 'pdf_unlock'
status'completed'
input_pagesinteger
output_count1
download_urlstring uri

Signed link, valid one hour.

zip_urlstring nullable

Always null, as there is one output.

download_url_expires_atstring date-time
warningsstring[]

SIGNATURE_INVALIDATED, SOURCE_REPAIRED or NON_ASCII_PASSWORD.

Example response

{
  "job_id": "9f0a4b78-2c0c-4d14-9b8b-123456789abc",
  "input_pages": 12,
  "outputs": [
    {
      "name": "scan-001.pdf",
      "pages": 3,
      "page_range": "1-3",
      "size_bytes": 91822
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.