{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"877b0443-6a68-4095-a492-e536673c76e8","name":"PPAD Integration Guide - Complete API Reference","description":"# Complete Integration Guide for PPAD\n\nThis specification provides everything needed to integrate with PPAD (Persistent Protection After Download). It includes:\n\n1. **PPAD Core API** — Endpoints for managing files, recipients, analytics, and API keys\n    \n2. **Webhook Events Reference** — Event notifications sent to your configured endpoints\n    \n\n---\n\n## About PPAD\n\nProtect files without the friction. PPAD enables transformation of any document into a secure, encrypted file with AES-256 bit encryption, maintaining complete control over access even after download. Implement dynamic watermarking, access controls, file expiration, and detailed analytics.\n\nCurrently only the following file MIME types are supported:\n\n- `application/pdf` (.pdf)\n    \n- `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (.xlsx)\n    \n- `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (.docx)\n    \n- `application/vnd.openxmlformats-officedocument.presentationml.presentation` (.pptx)\n    \n- `image/png` (.png)\n    \n- `image/jpeg` (.jpeg / .jpg)\n    \n- `image/gif` (.gif)\n    \n- `image/bmp` (.bmp)\n    \n- `video/mp4` (.mp4)\n    \n- `video/webm` (.webm)\n    \n- `audio/mpeg` (.mp3)\n    \n- `audio/wav` (.wav)\n    \n\nCurrently PPAD editing feature only supports`application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (.xlsx) files.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"21965707","team":3758233,"collectionId":"877b0443-6a68-4095-a492-e536673c76e8","publishedId":"2sBXVZnuNY","public":true,"publicUrl":"https://developer.ppad.io","privateUrl":"https://go.postman.co/documentation/21965707-877b0443-6a68-4095-a492-e536673c76e8","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/9936f1d6-fe1d-4d51-b4d3-806b97459a70/cHBhZC13aGl0ZS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/c81f200f-1aad-4c26-a145-fdef62405cfe/cHBhZC5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2025-12-24T02:05:13.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/c81f200f-1aad-4c26-a145-fdef62405cfe/cHBhZC5wbmc=","logoDark":"https://content.pstmn.io/9936f1d6-fe1d-4d51-b4d3-806b97459a70/cHBhZC13aGl0ZS5wbmc="}},"statusCode":200},"environments":[{"name":"default","id":"3274dba4-495d-4421-bcb0-497f4599bbcd","owner":"50969660","values":[{"key":"baseUrl","value":"https://api.ppad.io","enabled":true,"type":"default","description":"API base URL"},{"key":"exampleBaseUrl","value":"https://api.example.com","enabled":true,"type":"default","description":"Example API base URL (for tenant API and webhook references)"},{"key":"apiKey","value":"832d683f71896dec0d6525173ef58d04c4cff23039424424148a3bcdb7878351","enabled":true,"type":"secret","description":"Your PPAD API authentication key"},{"key":"fileId","value":"a8caebc152d24aeb9090a11112696eb0","enabled":true,"type":"default","description":"Your unique file identifier used to reference file in your system"},{"key":"userId","value":"38db3ea405bb4defa610f44d984be49d","enabled":true,"type":"default","description":"The unique identifier for the user who is associated with this file"},{"key":"fileVersion","value":"eixdtpfcnw","enabled":true,"type":"default","description":"The version of the file. Use version numbers to track different iterations of the same file"},{"key":"fileName","value":"sample.pdf","enabled":true,"type":"default","description":"The filename with extension (e.g., document.pdf, presentation.pptx)"},{"key":"fileUrl","value":"https://example.com/sample.pdf","enabled":true,"type":"default","description":"The publicly accessible URL where the source file can be downloaded. Must be a valid HTTPS URL"},{"key":"ppadFileId","value":"53117bf976c8423f6193ea226dfdeff3e7d0d5b6ad02ac231f95a2cd82bd5ee8","enabled":true,"type":"default","description":"The generated PPAD file identifier. Use this ID to reference the encrypted PPAD file"},{"key":"fileId1","value":"3f68f0f4b30d487f9300eb9a28855cc0","enabled":true,"type":"default","description":"First file identifier for batch operations"},{"key":"fileId2","value":"e802cbd1ce4d42e5ba1dcae954e8d993","enabled":true,"type":"default","description":"Second file identifier for batch operations"},{"key":"userId1","value":"41dd55a1f33a45db97f4e24dac27060a","enabled":true,"type":"default","description":"First user identifier for batch operations"},{"key":"userId2","value":"82511907d3634efb93cac31d0b2db62d","enabled":true,"type":"default","description":"Second user identifier for batch operations"},{"key":"userEmail","value":"sample@ppad.com","enabled":true,"type":"default","description":"User's email address used for authentication"},{"key":"ipAddress","value":"184.147.180.65","enabled":true,"type":"default"},{"key":"browserId","value":"76a8c674f0344153ba0b863f2712f1df","enabled":true,"type":"default","description":"Unique identifier for the user's browser"},{"key":"browserId1","value":"8e969bd98895466f850fb42ce72e585a","enabled":true,"type":"default","description":"First user browser identifier for batch operations"},{"key":"browserId2","value":"d72a365763944f088da7ebd8b62cb70d","enabled":true,"type":"default","description":"Second user browser identifier for batch operations"},{"key":"browserInfo","value":"Google Chrome 140","enabled":true,"type":"default","description":"Browser user agent and device information"},{"key":"browserType","value":"desktop","enabled":true,"type":"default","description":"Type of browser (e.g., desktop, mobile)"},{"key":"lastLoginTime","value":"2025-12-22T10:33:01.283Z","enabled":true,"type":"default","description":"Last login time in ISO 8601 format"},{"key":"accessToken","value":"<token>","enabled":true,"type":"default","description":"Access token for the user"},{"key":"termsType","value":"team","enabled":true,"type":"default","description":"Type of terms (e.g., NDA, TOS)"},{"key":"termsPresignedUrl","value":"https://example.url.com","enabled":true,"type":"default","description":"Presigned URL for the terms of access"},{"key":"userName","value":"Agnes Siew","enabled":true,"type":"default","description":"User's full name"},{"key":"userPhoneNumber","value":"+1 5056486650","enabled":true,"type":"default","description":"User's phone number"},{"key":"userCompany","value":"ACME Corp","enabled":true,"type":"default","description":"User's company name"},{"key":"userJobRole","value":"Product Operations Manager","enabled":true,"type":"default","description":"User's job role or title"},{"key":"intercomHash","value":"<hash>","enabled":true,"type":"default","description":"Intercom hash for user authentication"},{"key":"intercomDate","value":"<date>","enabled":true,"type":"default","description":"Intercom date timestamp"},{"key":"browserName","value":"Google Chrome 140","enabled":true,"type":"default"},{"key":"errorMessage","value":"<error message>","enabled":true,"type":"default"},{"key":"viewId","value":"544155110298459cb40691e0918b6268","enabled":true,"type":"default"},{"key":"pageNumber","value":"1","enabled":true,"type":"default"},{"key":"viewStartTime","value":"2025-12-23T04:36:34.871Z","enabled":true,"type":"default"},{"key":"viewStopTime","value":"2025-12-23T04:36:46.395Z","enabled":true,"type":"default"},{"key":"editingSessionId","value":"fd0c36c510c24c328894b289248be24c","enabled":true,"type":"default"},{"key":"originalFileVersion","value":"eixdtpfcnw--ppad-e-1765277584794","enabled":true,"type":"default"},{"key":"baseFileVersion","value":"eixdtpfcnw","enabled":true,"type":"default"},{"key":"workspaceId","value":"cmmacu76g00033b6s1o863xjp","enabled":true,"type":"default"},{"key":"user-api-key-header","value":"x-ppad-user-api-key","enabled":true,"type":"default"},{"key":"user-api-key-value","value":"12345678908b3de2c58d95d7936672586682aa6d66fb764f0e095d5845148d55","enabled":true,"type":"secret"},{"key":"apiKeyId","value":"cmlp062u20001ii5805mi63lt","enabled":true,"type":"default"},{"key":"ownerUserId","value":"cmmbjzem1000p3b6tjide4fq9","enabled":true,"type":"default"},{"key":"orgId","value":"cmmcz85t600073b6sgronrx3n","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/187ff3622a29d0d287d34d65784deb935aa0730d3c3c77969749433a452cc965","favicon":"https://res.cloudinary.com/postman/image/upload/v1658299711/team/l8gttq7ebgdgxqibmwyr.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"default","value":"50969660-3274dba4-495d-4421-bcb0-497f4599bbcd"}],"canonicalUrl":"https://developer.ppad.io/view/metadata/2sBXVZnuNY"}