PDF Viewer FAQ

URL Scheme of PDF Viewer

PDF Viewer implements the x-callback-url protocol, which allows iOS and Mac developers to expose and document the methods they make available to other apps and return useful data. This feature is available only for users that are subscribed to PDF Viewer Pro.

PDF Viewer URL Scheme actions look like this:

pdfviewer://x-callback-url/[action]?[action parameters]&[x-callback parameters]

Add to PDF Viewer

To send PDF files from Safari to PDF Viewer you can use this HTML snippet:

<a href="pdfviewer://x-callback-url/add-file?url=https://pspdfkit.com/downloads/case-study-box.pdf">Add to PDF Viewer</a>

Action: Add "Case Study" to PDF Viewer

The PDF will be automatically saved in PDF Viewer.

Actions

/open-file

Open the local file from the path.

Parameters:

• path - required path to a file.

Example:

pdfviewer://x-callback-url/open-file?path=/Quick%20Start.pdf

/add-file

Store a file (or download from url) locally as filename.

• url - URL address to a file.

• data - base64 representation of a file. This parameter must be URL encoded.

• filename - file name with extension. Both data and filename are required to successfully add a file.

• open - optional. Open newly added file.

Examples:

pdfviewer://x-callback-url/add-file?open=true&url=https://pspdfkit.com/downloads/case-study-box.pdf

pdfviewer://x-callback-url/add-file?open=false&filename=Document.pdf&data=JVBERi0xLjMKJcTl8uXrp/Og0MTGCjQgMCBvYmoKPDwgL0xlbmd0aCA1IDAgUiAvRmlsdGVyIC9GbGF0ZURlY29kZSA+PgpzdHJlYW0KeAGNjkEKAjEMRfdzir/UhZ2mtrZdqniAgYAHKA4i7UCd+4PpKLrQhWSRT/7PSyoGVGgpFx2CNbhfcMaE/jgT0gzCnMRtTnln8qI08rKZccXY/ZGRtMCqMNvBTWuNmwoODLL2NRZholcOFH3HBT0zKS1bPGKFNfiGEy9//wSZEJ6gJsiQ2u68gSP9xdrTBzY8ANE8OGsKZW5kc3RyZWFtCmVuZG9iago1IDAgb2JqCjE0OQplbmRvYmoKMiAwIG9iago8PCAvVHlwZSAvUGFnZSAvUGFyZW50IDMgMCBSIC9SZXNvdXJjZXMgNiAwIFIgL0NvbnRlbnRzIDQgMCBSIC9NZWRpYUJveCBbMCAwIDU5NSA4NDJdCj4+CmVuZG9iago2IDAgb2JqCjw8IC9Qcm9jU2V0IFsgL1BERiAvVGV4dCBdIC9Db2xvclNwYWNlIDw8IC9DczEgNyAwIFIgPj4gL0ZvbnQgPDwgL1RUMS4wIDggMCBSCj4+ID4+CmVuZG9iago5IDAgb2JqCjw8IC9MZW5ndGggMTAgMCBSIC9OIDEgL0FsdGVybmF0ZSAvRGV2aWNlR3JheSAvRmlsdGVyIC9GbGF0ZURlY29kZSA+PgpzdHJlYW0KeAGFVU1sG1UQHmfXDqrCigO0VSuVJ/5aRWm0CRQSKqCunTppItfND5BSFW3Xz/HWm91ld+02UU+5kBNUAiGuIIR6A4GoWn7U5tJeiqhUBVTIBalIrQAJAao4AOKb9dpZh0PWevb35s3Mm/lmxkvUfdHwPLtLEM07oV+YzM6+PHtMdN+gLtKoh/AYZuBlS6UJxo7rSP7tfO59SymW3NzLvjrPNt2lyzIwoXUFyy0H5jxRSifK9JmeHxJ1H4d86HToMX4b+MHa9GQO+DywFtsC0kMF6UjfMkXBNxZEyXcrlp2MdbNz9rHpM2/XOVZ+dmH1BLWpcfz2IuYzVX90EvhZ4PdNY2QKuA94zQsPshw6XffVazPZprxrsOIfmonlJxar0y8BPwCdZSscmwbuB37XOVk8Eutfrbnj7Gc75L+bQe4Y8GNEypaqHOPaCOD+ssyPACMGpVitj7J/+FGWg8YUyxlfWKzmisC4S7l9yjhcAt4K/KfvTvJdjxCpW6Rd4LvgX+3zwhLLh4BLjl3ku5CLuiyDKMc9wJ+E1enRWP/70J9mW/bzb8U6NAYMHtLCs6Meehp4wq9PcmxPAC8Z/kgBGH7S56Uzw7wxvlE28sztU8B/0YspgyS5dBLfJjn0D/INyKJGhDzycVbB3qYCNBwsn6zU/VSDTFDyvGVnURUnIewcrAYZVIqsml4ElbETNMd+cBMj9nsn2psbdHPQcWgRPkR8/91Yz1W3qbr6JNZ+dUJ9Th1Sh0moL6gH1OfVPKTD6v7IxoftAryu58E33oXXpqfXqJ6M59yO+h7Pe+eNJf9Vy/zmzd86LN123HOIq7lrcwL23CRHyK0W6/8UsyGTfF07++X2RIRiVb14/GbPtbN0JFmLqDrljbVI307fSa/i+1Z6Lekj/UN6DZ9blEW97IjZeWTHHMqI6wJ4MJBxgIjqqCtHv7cjxxXYhdCx6UecuZFVgAr8DctaxFSy5ome6MiXc2cfHRlXnHM7PO/Eh8yrfL14r0hLffrH+i/6B/p3+q/6qv4e0M8d0bT6pNUlUfcpbymfKV8pl5TPlesklCvKinJZuap8pHyB3aeQriiX4IV1Wz3X7LF274CzZheacX8xD9yxQcQcazNvLG1FcApn65lL5Lbxhs5+bt+lHdR2ao9qee1h7XFtQuvV9mkHtG3aINaANqrtxsnOdt/YcTV5tpI9a9FsxGazkhxVFfz6iNLAZz0unlOLZhC3RacjBoKoDg5m4P/TynOFuUi9gt611F3qgDoWz1FW3YdJGu+YqSGetMxIJp/Jksj0ZoYzA5nDjBF9c8pEZjdOh/E90s6IWTGTOh15yYQec9pke31e+F+Je4m9NIBt7GQoz+CdRZRzvQXfmquGYlDXnxFZvCKlGHPM/j5h2LaIjgLhy0D6DVnuJ37/sh3RH0ej92pq63Wz7jeaMkqlvib6DyJqiOoKZW5kc3RyZWFtCmVuZG9iagoxMCAwIG9iagoxMDg4CmVuZG9iago3IDAgb2JqClsgL0lDQ0Jhc2VkIDkgMCBSIF0KZW5kb2JqCjEyIDAgb2JqCjw8IC9MZW5ndGggMTMgMCBSIC9GaWx0ZXIgL0ZsYXRlRGVjb2RlID4+CnN0cmVhbQp4AY2OMQ7CMAxF957ijzCQxqahzQiIA1SyxAEiKoSaSiH3l3ACggEG5MFf/t/PThiRYLWcdxg6xv2CMxa0x0wIGYQc1C1OfGfmqizmujnjiqn5I6NphSVlloOb0go3RBwE1HWvsQr2vXEg3zcS0YqQsbolE1ZYQ244Sf37J4iH4QkqgpjMdtczHNkv1p4/sPEB0Ug4bAplbmRzdHJlYW0KZW5kb2JqCjEzIDAgb2JqCjE0OQplbmRvYmoKMTEgMCBvYmoKPDwgL1R5cGUgL1BhZ2UgL1BhcmVudCAzIDAgUiAvUmVzb3VyY2VzIDE0IDAgUiAvQ29udGVudHMgMTIgMCBSIC9NZWRpYUJveApbMCAwIDU5NSA4NDJdID4+CmVuZG9iagoxNCAwIG9iago8PCAvUHJvY1NldCBbIC9QREYgL1RleHQgXSAvQ29sb3JTcGFjZSA8PCAvQ3MxIDcgMCBSID4+IC9Gb250IDw8IC9UVDEuMCA4IDAgUgo+PiA+PgplbmRvYmoKMyAwIG9iago8PCAvVHlwZSAvUGFnZXMgL01lZGlhQm94IFswIDAgNTk1IDg0Ml0gL0NvdW50IDIgL0tpZHMgWyAyIDAgUiAxMSAwIFIgXSA+PgplbmRvYmoKMTUgMCBvYmoKPDwgL1R5cGUgL0NhdGFsb2cgL1BhZ2VzIDMgMCBSID4+CmVuZG9iago4IDAgb2JqCjw8IC9UeXBlIC9Gb250IC9TdWJ0eXBlIC9UcnVlVHlwZSAvQmFzZUZvbnQgL1VTTUlYUStIZWx2ZXRpY2EgL0ZvbnREZXNjcmlwdG9yCjE2IDAgUiAvRW5jb2RpbmcgL01hY1JvbWFuRW5jb2RpbmcgL0ZpcnN0Q2hhciAzMiAvTGFzdENoYXIgNjUgL1dpZHRocyBbIDI3OAowIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDU1NiA1NTYgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDY2NyBdCj4+CmVuZG9iagoxNiAwIG9iago8PCAvVHlwZSAvRm9udERlc2NyaXB0b3IgL0ZvbnROYW1lIC9VU01JWFErSGVsdmV0aWNhIC9GbGFncyAzMiAvRm9udEJCb3ggWy05NTEgLTQ4MSAxNDQ1IDExMjJdCi9JdGFsaWNBbmdsZSAwIC9Bc2NlbnQgNzcwIC9EZXNjZW50IC0yMzAgL0NhcEhlaWdodCA3MTcgL1N0ZW1WIDk4IC9YSGVpZ2h0CjUyMyAvU3RlbUggODUgL0F2Z1dpZHRoIC00NDEgL01heFdpZHRoIDE1MDAgL0ZvbnRGaWxlMiAxNyAwIFIgPj4KZW5kb2JqCjE3IDAgb2JqCjw8IC9MZW5ndGggMTggMCBSIC9MZW5ndGgxIDU4MzYgL0ZpbHRlciAvRmxhdGVEZWNvZGUgPj4Kc3RyZWFtCngBvVh7UFTXGf+++9hdFtRlQdkFlnvXy/ImgA8CSuWKuwiiBEXNrpFkF1gCKJExSKOJlqRa40psEqtJTWtqHzZqrVe06UUnlqR0kkyS1iRN2qSZSWwe7XTKpA910iRw+927sBUnsf7h5Jz57vc853znd859nZ6Nm8IwBfqAhYY1oe42MMqMVmLtLV2h7qhuf4H42pbeHjGq8zkA7Pq27ju7orrlOwBW153rN4+3TyoGYD5oD4f0fvTyOVFpOxkMDXAO8cz2rp57orr9NPHk9Rtaxv1JmaQndIXuGR8f3iFdvCvUFY7Gz5CJZ3ZvuLtnXE8mXtC9MTwej37K73eAZOXhUYiDdWAGBmxUmwDMf7W6gCOv7qdyzzeLXr5jWsUlSLQY+h3Lvm3wlx67+OQn4c+z4x+x/IcMcRPxOjfljuVSikj+kfhHYh6jHV14FRrzVaglqiSaS5Sfv9ABfXgYHib6ARELHbgbNhPtIvouEReTjpA2iLsHOIt8BjdDKi6R4zlhZbJTcFjjhddUNJ0+KLzleP8sOmn1LqBzYArELbTiD/BJaAUBfwIe3AI1kIMHTuWuF4LkOgLdRH1ErHFFPDKQMUs4hwXg4ZDaZEEGh08LfykpFD4sURkcEJ7LVjliz2aQJk8ThlwHhV+57hTOER2Luo7mUsTTwhHXemFvhooHBoRHXSpSm0eibJOLmj4tdOXuF1pLDP/S/SpzbEAoJ/9qOV4oLXMLc10fCEXZqgVJL3QtFfJKXhEyqSGFidSpR04U0l17hXnkynD5sucRncWj+ATk4RMDniXCGRJpuqdqc8v2q3jvqZqcEo+KW+TSmpz9uTXZntylgie3Ojub5NUvmLebbzMvNM8y55tzzFlmtznNnGyxW2yWqZYEi9VisZhV/NlApWA6i8egkmA5dspisvAq/pyM3Fk8bhiP/9LCWRgLWJJV7T3avAjJKh47bdMlEp42GZJJxeOnoqbjssDpEmc4bIwu04WuwKCFgSWg4EOqCXbM6K10VNoXJJZXe7/sEjQ8E9f8Ly8OdCn76xr9ylFXQJmlC5orMBHumBC+lPdsIle4Kj+/bsXmU73dnW2+sOQLSr4wUVDZ3dvuUPqaRfFkZ7fuEBU2K9jc0q7zUFjplsJepVPyiid7jXZXudt0d6/kPQltvpX+k21y2DvQK/f6pJA3cKq5amPTpLF2xcbaWPUFY1XpnW3Ux2o22l01VpPubtbHatLHatLHapabjbH0yfs6Gqvu7qHdKfo66kQlp1GpXb7Gr4ihgFfFw2T0bgJ+CGz8M5DD90EqVwQCgPYW0ds6H1ulfcQ/D7axLu2f7Hxa1EGdmLHKChiCh+AJOAEmeIrkHLgdHocXsZPu7bVwGt7EDLgJ+ui+V2EpvIya9iq0wY8pvgeeg31wEhKoTRdMJ+8e9GhbSJdJbobt2g8hE8rgW/AMlFOve2BEO6KdIu8KWAVH4Ri1fwkl5iSXpP1c+wAssJz63E6eV7Wl2gmwQwFUQQNZt8M59LBva+3ggPmU3ffgSTgEz8Lf8QE8rbVrvdp57QJtVQekQyPVrXgaL7AnuG9p39P+po0REjmQR6MGYS/8iPo/QXWIHq0+XIc9uBf3MTLzAHOa28GnjI0SDrmwmGoNbIAHCYFBGIZ/wX/wY8bB2tge9jfaXO3fEA91NEt9JmHopbqT6h6a01k0YTEuwgbcit/Bffg6k8esYvzM15l7mI/YenYtu5l9nbubG+D7+cdN8WOXtLPa89obkAIuuA02wjaa3XNwHi7Cp8hSX+nowflYhbdT7cMnmEE8hINMAw7heeYovovv48f4GcMzCcx0Jp/pYfYyx5jnmN+yHew+9rvsu+wlbgHP8If4D00e85/Gmsd2jf1Wm69d0D6hR6wF3LQyVVAPd0CIZtsNc+AbNIvjVE/Qqg3Db+BFo76P6TACnxAKgHZMxVm4jGo93oJt2IEH8QzVc0YulxlaCCaOSWRSmHSmkWlmupg+5g2mj01j89gl7Br2BNUX2DfZz9jPOJ5L4qZzi7la6Oe6uANUD3NPcQPc7/hyfgFfz6/m+/hdfD/bwr/Kv2naZtpjGjB9bPoHPRaXmjeY+2l1XqQ9+yzt5f8VDjMp+1lwF7SgF5thP63GIQxBhHZXKz5IeHVDjtbEbmMXM8W0G87BvbRbD8BW2MWuhUPaH9mj8AfaKeupyz74KVcFLv4xWp0HoJh20XiVc/Nyc7KzPJnSTLdIj/z0tFSnI2XG9OQke6JtSkK8Nc5iNvEcyyAU+KTqoKhkBRUuS6qpKdR1KUSG0BWGIN3KolI9OUYR9XYhck2KlCmy7apIORopxyLRJlZARWGB6JNE5RWvJKq4Zrmf5Ie8UkBURgx5mSE/bMhTSHa7qYHoc7R7RQWDok+p7m2P+ILewgIclAkOa2GB/uCQIV7vWIFFoa30gIVFeoRPSZW8PsUpkUw+1uMLtSoNy/0+b5rbHSAbmVb4aYzCgg6F8oTdCa1S625VhuagLoXW+hU2FFCYoN5XYr6SInmVlC0fOv6nTki+/iucCuOpDoUj1Yoc3E3g6mpQ10L9pNU1itQtsyPgV3DHeBJ6jp2UqZ5u9J3gCXaKSpxUJbVHOoMELqzwD6TKqcbDV4EG/4BTdhpKYcGgY9t8N81+sHBh4UKdz3c7tkX5X74Ztb82pHPHtuH3iNetiAGAOgJSLeWpiC3GIBIlW6ZfwmUQaSkjnKgEkKbZQfksUhjaM6xH4T21IaWvcSKNdm80uWCndyDOmWq8hKoCFB+M2ObRSlG8TRIjl+htHZRG/j7ZEhq3mDy2S6A79YWO7RUFQxNyr/6y9NCs2x1Su76+vcaaki45fFcYSNeh0XNWkukF3uB3K2KADPQ1WVCnQlyD/yTinoCK2g4VvK5B+kZl77id3AX6Vuvw0vikFBaQIc9N0k0FYjWNXK3vFTEiRmpbI2K12E6bifMYnBzhSKCIEGz0E06wkkaUA2kxMRwIzKN+ivR+qAmFRwLUQ+d4D8QNU9EoBRUX0MuUzWrwL/crfd40RfYGaBVo+w41+JUh2rmBAEWVxDKljLd2OMZznkU5l+SRf3a0F/p26aMuApGI3mejX3IrQ5FIWkS/36K6inC1QR43qKCH6JCr2NdAbYlJ7jRjDdySm9IK6JjOoS09saPom/3aCJfG8qaWN1O2pQbCZTcI4fLrQXjedSE8P5bpJIQrKOf5OsJf++oQXjAJ4cprIyzH8qYkF1K2soFw1Q1CeNH1IOy9LoR9sUwnIVxNOft0hBd/dQjXTEK49toIL4nlTUnWUbZLDISX3iCEl10PwvXXhfAtsUwnIdxAOd+iI7z8q0N4xSSEG6+N8MpY3pTkKsp2pYHw6huE8K3Xg7D/uhAOxDKdhPAayjmgI3xbDGE5TYErn8N9Vz124YY/mNdeATl9KfF2qGLKAbi7YZhI5ldDBpknznMS6C+jnnQRZuq/1/+nMPStfq1Cf+1U5lBdAx/hRvoAr6KRz9O/IEtnSpXRcx5LEb2MiSw2FeA8ka6TzL6jAkcEJJvfgTPUAmB1/hnqhSdeXDI70Z2YTVTF7VE//zP/zKeLVG7ZZ3RmQJkP09HAG/yj9CchnbSgirPlBI4zJ3Dm/TxYF8fZeocdw2+MlkNl5cVXSoqT5i7Am2cnSonDvz6QtWeIvRxJChz+9C72stGXTDln8N8nRA7L9aVcNXcrv851V8aWjO24k7HkWdY41znvc96X/gsnDzNxGpc+1ek2pzvpXIgXpk2bmWSdm8SLwib3zAT3N8xlMzbMnJo97X6hbGbmYknP4/cjF0dsl0Y+gMqK0YrKkUR7eZE9pRyJ28vLE+kCTSXFizbL6ZwzwZOYFW+fmgNxyeYcdHJTbNYctEynC52Q2Wyo/5DfD02l9kosvbl07pwsaabZZJZIds+yT082m6ahiQzu6e4lO54dun/Oiv1bBxdncb9kqzZhzuX3N1f/YldzWWsqO/Xz3EG0d2+om9u4buve/rodZ3vPj13+0c+2LA4vLS25tfMo4cLq+4b/Gq0lA1b663xbbqhBP7Yj+yD7GPe49YhVjVOtphwrgtlkQsYSF0cXK5h57EeWE5OtVo+dbMk877FTQHw8z8ZZOROP8QyywGSYLSoG5Dj6VTHFWVmetKdk+5QpKSmp/EE8aHUmTDnk7r+dTmKc9Rcdy0ZHnfW+sPejaq8DKlMqKiuWjRKcieWVOpBRJIt23pS/1VZHX1TcUJrCDQd23uQYN7BkYIcD+eOxO20VFWaikmJsaoImjMek2SixblZCds+7IzsuMNPf3jd69smXmYeZNcyu0a+zLZ8uQnWsxkCDwKGTjTD9f39R4cnIQjKdS2SShHSaEL3PTHS+Cqsal9X6l+fXhNf3hns6WkJGxEQv6STQ2TGdXACdAQD4tfFCMsRkpHt3sl5ylT7rKn2hrv8Xi+0V9gplbmRzdHJlYW0KZW5kb2JqCjE4IDAgb2JqCjMzMjcKZW5kb2JqCjE5IDAgb2JqCihVbnRpdGxlZCkKZW5kb2JqCjIwIDAgb2JqCihNYWMgT1MgWCAxMC44IFF1YXJ0eiBQREZDb250ZXh0KQplbmRvYmoKMjEgMCBvYmoKKFBldGVyIFN0ZWluYmVyZ2VyKQplbmRvYmoKMjIgMCBvYmoKKFBhZ2VzKQplbmRvYmoKMjMgMCBvYmoKKEQ6MjAxMjA4MTQyMDI3MjVaMDAnMDAnKQplbmRvYmoKMjQgMCBvYmoKKCkKZW5kb2JqCjI1IDAgb2JqClsgXQplbmRvYmoKMSAwIG9iago8PCAvVGl0bGUgMTkgMCBSIC9BdXRob3IgMjEgMCBSIC9Qcm9kdWNlciAyMCAwIFIgL0NyZWF0b3IgMjIgMCBSIC9DcmVhdGlvbkRhdGUKMjMgMCBSIC9Nb2REYXRlIDIzIDAgUiAvS2V5d29yZHMgMjQgMCBSIC9BQVBMOktleXdvcmRzIDI1IDAgUiA+PgplbmRvYmoKeHJlZgowIDI2CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwNjQ1OSAwMDAwMCBuIAowMDAwMDAwMjY0IDAwMDAwIG4gCjAwMDAwMDIxNjYgMDAwMDAgbiAKMDAwMDAwMDAyMiAwMDAwMCBuIAowMDAwMDAwMjQ1IDAwMDAwIG4gCjAwMDAwMDAzNjggMDAwMDAgbiAKMDAwMDAwMTY3OSAwMDAwMCBuIAowMDAwMDAyMzA2IDAwMDAwIG4gCjAwMDAwMDA0NjcgMDAwMDAgbiAKMDAwMDAwMTY1OCAwMDAwMCBuIAowMDAwMDAxOTU5IDAwMDAwIG4gCjAwMDAwMDE3MTQgMDAwMDAgbiAKMDAwMDAwMTkzOSAwMDAwMCBuIAowMDAwMDAyMDY2IDAwMDAwIG4gCjAwMDAwMDIyNTYgMDAwMDAgbiAKMDAwMDAwMjU1MiAwMDAwMCBuIAowMDAwMDAyODAzIDAwMDAwIG4gCjAwMDAwMDYyMjAgMDAwMDAgbiAKMDAwMDAwNjI0MSAwMDAwMCBuIAowMDAwMDA2MjY4IDAwMDAwIG4gCjAwMDAwMDYzMTggMDAwMDAgbiAKMDAwMDAwNjM1NCAwMDAwMCBuIAowMDAwMDA2Mzc4IDAwMDAwIG4gCjAwMDAwMDY0MjAgMDAwMDAgbiAKMDAwMDAwNjQzOSAwMDAwMCBuIAp0cmFpbGVyCjw8IC9TaXplIDI2IC9Sb290IDE1IDAgUiAvSW5mbyAxIDAgUiAvSUQgWyA8N2NjZTk3NWE3Y2M3ZTc2NWNhOTY3MDlkZDRlZTAzMGU+Cjw3Y2NlOTc1YTdjYzdlNzY1Y2E5NjcwOWRkNGVlMDMwZT4gXSA+PgpzdGFydHhyZWYKNjYxOAolJUVPRgo=