swagger: '2.0' info: title: Signnow API Reference version: '1.0' license: name: MIT host: api-eval.signnow.com paths: '/document/{document_id}': get: responses: '200': description: '' schema: type: object properties: {} examples: application/json: id: a09b26feeba7ce70228afe6290f4445700b6f349 user_id: 890d13607d89a7b3f6e67a14757d02ec00cf5eae document_name: pdf-test page_count: '1' created: '1565787561' updated: '1565858757' original_filename: pdf-test.pdf origin_document_id: null owner: api@signnow.com template: false thumbnail: small: 'https://api.signnow.com/document/a09b26feeba7ce70228afe6290f4445700b6f349/thumbnail?size=small' medium: 'https://api.signnow.com/document/a09b26feeba7ce70228afe6290f4445700b6f349/thumbnail?size=medium' large: 'https://api.signnow.com/document/a09b26feeba7ce70228afe6290f4445700b6f349/thumbnail?size=large' signatures: - id: 2600e6cfbe65cfeb5624749fbe75b432c392c128 user_id: e9f673c1bc43f95d611295a7aa3ec425e433715f email: guest_signer_585873482916@no.reply page_number: '0' width: '56' height: '21' x: '70' 'y': '362' created: '1565858757' data: iVBORw0KGgoAAAANSUhEUgAAApoAAAD8CAYAAADXPgSRAAAgAElEQVR4Xu2dB9QsRZmG3zVHQETFHGANYM7ZVRcVc0YFw5pzjgiKETFn1hzWnBVzdk2romJERVCCoII5Yd7z7K1Z5vbt7qme6equ7nq/c/5zw99dXfVUzcw7VV/4F9lMwARMwARMwARMwARMIAGBf0nQpps0ARMwARMwARMwARMwAVloehGYgAmYgAmYgAmYgAkkIWChmQSrGzUBEzABEzABEzABE7DQ9BowARMwARMwARMwARNIQsBCMwlWN2oCJmACJmACJmACJmCh6TVgAiZgAiZgAiZgAiaQhICFZhKsbtQETMAETMAETMAETMBC02vABEzABEzABEzABEwgCQELzSRY3agJmIAJmIAJmIAJmICFpteACZiACZiACZiACZhAEgIWmkmwulETMAETMAETMAETMAELTa8BEzABEzABEzABEzCBJAQsNJNgdaMmYAImYAImYAImYAIWml4DJmACJmACJmACJmACSQhYaCbB6kZNwARMwARMwARMwAQsNL0GTMAETMAETMAETMAEkhCw0EyC1Y2agAmYgAmYgAmYgAlYaHoNmIAJmIAJmIAJmIAJJCFgoZkEqxs1ARMwARMwARMwAROw0PQaMAETMAETMAETMAETSELAQjMJVjdqAiZgAiZgAiZgAiZgoek1YAImYAImYAImYAImkISAhWYSrG7UBEzABEzABEzABEzAQtNrwARMwARMwARMwARMIAkBC80kWN2oCZiACZiACZiACZiAhabXgAmYgAmYgAmYgAmYQBICFppJsLpREzABEzABEzABEzABC02vARMwARMwARMwARMwgSQELDSTYHWjJmACJmACJmACJmACFppeAyZgAiZgAiZgAiZgAkkIWGgmwepGTcAETMAETMAETMAELDS9BkzABEzABEzABEzABJIQsNBMgtWNmoAJmIAJmIAJmIAJWGh6DZiACZiACZiACZiACSQhYKGZBKsbNQETMAETMAETMAETsND0GjABEzABEzABEzABE0hCwEIzCVY3agImYAImYAImYAImYKHpNWACJmACJmACJmACJpCEgIVmEqxu1ARMwARMwARMwARMwELTa8AETMAETMAETMAETCAJAQvNJFjdqAmYgAmYgAmYgAmYgIWm14AJmIAJmIAJmIAJmEASAhaaSbC6URMwARMwARMwARMwAQtNrwETMAETMAETMAETMIEkBCw0k2B1oyZgAiZgAiZgAiZgAhaaXgMmYAImYAImYAImYAJJCFhoJsHqRk3ABEzABEzABEzABCw0vQZMwARMwARMwARMwASSELDQTILVjZqACZiACZiACZiACVhoeg2YgAmYgAmYgAmYgAkkIWChmQSrGzUBEzABEzABEzABE7DQ9BowARMwARMwARMwARNIQsBCMwlWN2oCJmACJmACJmACJmCh6TVgAtMnwOv4QpIuJemS4U/+fjFJp5n+8BpHcLSkj0h6iKSTZzxOD80ETMAEJkvAQnOyU+eOF0rgnDWCEnF5pkJ5MOwDJD2p4PF76CZgAiaQLQELzWynxh0rnMBZJO1eEZWXlbRj4Vzqhv8HSdtJ+ofZmIAJmIAJ5EXAQjOv+XBvyiNw2nDEXT325ijcFk/gSpIOjb/cV5qACZiACQxBwEJzCMrTf8bOkp4p6QaSzjX94fQ+gr9I+pmkny79nFD5N78/g6RdC/Oj7B12Q4MPkvTioR7m55iACZiACcQRsNCM41T6VW+RtFfpEDz+rAm8SdLeWffQnTMBEzCBAglYaBY46WsM+XeS8Bm05Uvgn5KIwv6WpG8v/fk9SX/Nt9ude3YrSe+quetHki7SuTXfYAImYAImkJSAhWZSvLNp/CRJZ5/NaOY5EI7tj5RUPbLn/xf/93NJf5v48HeSdGLDGM4hibVqMwETMAETyISAhWYmE5F5N3x0nvkERXaPXU+EWJsYXfiZ/jqyzTEuY/eyLliK3c73jNEhP9METMAETKCegIWmV0YMAQcDxVCa1zV/DsFMMaKUYKghDX/MO9Y8kIC1xwzZET/LBEzABEygnYCFpldIqQTwOb2epBtKuqmkC5QKoodx/7ISYb98XL8cif8LSeyqbmoPlvSCmkY+K+namzbu+03ABEzABPojYKHZH0u3lDcB1joJz28UxOU1EpdnxI9wOSiHIJ3vh6Aqdoj5OXf4c/Hv5f8jFdLcjJ3Pn0g6LvwcW/MnfqRtYpR53COUnqzj87yQ1J7E9ss/+BjPuRznJmsF3n8P/rvVP/Hpbfrd4v9jrulybUx7Mdf09UwXAthkdfne4glYaBa/BGYNgHKN5P5k13LPRAFNVKX5Tk20N3kzN7HtVwjRhTglAMav401I+14TaCdA1gZcSPg5Pvws/r78fw5E80oygRoC/oDyspgTAarssFOJsOSHHcw+13idoCQwpY/j4HXngV06BHXdrmh15/TM6z7E95mACawkYEG6EpEvKJFAnx/CJfLzmMcnsMuSsLy+pD7FFMe4Hw3HtB+ShI/hlA2/1Loje47wLyxptyBapzxG990EcidgQZr7DLl/vRKw0OwVpxsbgEDKIB4+AL4QhOWHJR028m7lOjjhU/VPrPs3PouL/+fvp1/nYb7HBEwgGQEL0mRo3fCQBCw0h6TtZ61DYBHEszgOv2bPQR1HSUJUfkTSJyThc5m7sSt50fBzsaW/U0fdAS+5z577ZwL9ErAg7ZenW+uZgIVmz0DdXC8EUgbx/F7Sp5bEJdV0cjR2Jhdikj8XgvISPbsH5Dj2qfWpj2j6McfM58Cpw5eU6p98cWn63eL/53wNft9zMQTpcrqxRY7c5Vy5i7+TR9dmAr0QsNDsBaMb6YnAJSUdKOkmPQbxEKjDETg7lvx8LqMyjHxAU5+7bnfyPD0xzbkZRD85OBc/vwpiBz/bMwVBzZ/Lfz9dzgNq6dvUxehEsW/cbT4jcS3Bj5nXJD+Lv1f/b06ilNdiNR9unTCdut/6xgvEDawmYKG5mpGvSE+AcoJPlrRPTwIztyAePpyWdyUXwpJAJnaFpmwI+d9UBOOyeGz6Ox9Q69Rdf46khzcAI2H7+cLPFD/04fFdSYcu/XxD0tCVl6a8Hsfqe6mCFN64G5080s867yFjrZFin2uhWezUZzFwckDuJ+l+kjYRBstBPOxafn2EIJ7tGnYmOeo+Yxa02ztBUmp2MWJEYvWaIRNaf1LSdWuGcgdJbw3/z/sa7heIzvM3/MnvNllzQ00pa5tk/8vik3/7A3aoGej3OSUL0n5JbmmN1wd+9j+UdETlzx9LGvK9KcX4ZtGmheYspnFygzirpEdIeuQG/oZjBPEgTNiFXA7AWexUniujWSBZfFfByK7kmPlAY/H9sUG4/2v4kIltZ8piFP+5b1bEJzleqYRjmwcBC9LN59EidHOGvbRgodkLRjcSSQD/OnYv91+jSs8iiGfha8k32BTGa+K8FTG5EJbkmjxViod2bBNBSCnHH4Sylvy5+CGB/FwFB2KScVYNkbxDR4Yxl09ZjLK7w1rgNUfqKkqa8lP9e595Z2OY+hoTyI0AX8zJl/zo4JeaW/8m3x8LzclP4SQGgDjD//Kp4SizS6efkSiIB2FStzPJ/+VSZ/zXSwKSOukLMcnf/9QF4kyu5Xj8zTVj4TidZP1djECsOuHV9H9N/49bxAUkkVqKHwKXbCZgAtMjgOsN7zG2nglYaPYM1M1tQ+Bmkg6ShK9irH0pHK1/PvaGhuvYveHDvy6qG//QHIxjUFIsLQvJxU7liTl0MKM+PCu4W1S7xP+zG1FnBFvtLunKSz9kN5h6EFZG0+KumMAsCBCguNMsRpLZICw0M5uQGXWHmuNECF+lw5i+LWlfSYd0uIc1zI5SnZgkmj2HNc5R97ENYvJoO6xHz3ZMIBDuDcui8goTCcaKhuALTcAEkhCw0EyCNY8P4URDc7MjEbiUpKdLummH5yO2niDpDS2ii1x2dWKSo+5ccisSgFP1m1zsVDoBcocF0XBpUyAQ6+Zskq4Wympu/iS3YAImUBoBH50nmvEcdnsSDc3NDkxgnVyYJwW/zYNDrkD83RZH3cv+k7tJ2n7g8TQ9jnxxBFosB+AsxKSTF6ebpMuExPvpnuCWTcAESiTgYKDEs26hmRhwAc2vmwsTP0yOyKmusUgRRM7DHNYkudfYZV0Ovln8/ZiJpAGa8tKr86tEaM7RSMbOlxd2vBdJr7v8nWsJVMIPldMEvvANacdV0ix9JaTWGrIPuTyLAMNrS/q38HPZBO9nvDe9U9K9QqGEXMbufphAI4EcPtQ9PdMk0EcuzLFHTrBNnZhkx9LVWIabnbH8KjmKXyXqVv2+SSTG3Me9qQxXE/xTr7j0wxe5IYwvacsJ5r8s6bdDPHikZ+CyQbQy4q/v4gwIS6pDfTr8/LckslHYTGAyBCw0JzNV2XR0k1yYYwwCMbE46l6O7D585h9+Y7COeSZRnVcKATv8OZRfJTklETyLH4RQSqEXw2Loa6iWtCw8CdTj/4YwMissi0/+Tm7cqRq7lXeUtJekC/Y4CAvLHmG6qTwIWGjmMQ8594JjTHacLi7pKZJ4g83NSFBOubG6BOYc7U2h4k1uTPvoD7s7l69EgV+kj4ZXtIHvL0e4C1H5xVBec4BHT+4RFCdYiE92QBGfOw4wCl6TvF6XxefXJPHFMFfDbxxxyQ/uPn2YhWUfFN1G1gQsNLOenlE7R4qYu0naWxJ1vHMwnLbr8k2yW0K5MVseBBAsHCPeJcFRYnWEJK7/amW3kt1L2/oESBe2vPPJe8EQwXiIru/ViM8xMzawW8mxOD99fMm2sFx/XfrOiRKYu9Ck/vR/SSKnI0LkfZIebB+XxtVKIAEVfO4aor/HWNYcp3HUXRWUHHVP+ahtDJZDPpP0QqwdBCZBKUMYUf4c/fLhbUtLgJ3oZfHJ3/HTTm2UF32tpHdIooDDEKcTO0u6fRCXuHZsYhaWm9DzvbMgMHeh+WFJN6zMFMKTnRbbFgLsVPCmemdJ10wQJVnH+W+hDnO1rCJHacd7YiZDgPcPSj/eQ9KtE+QzXfhV3q6hxnxbRaDJQJxoR5l7as8vH7uzk52ydvoJkt4VRCdBMX1+wcBd4DZBXBI1Ttncde3rDt5ZF53vmyOBuQvNP9TUHsZ/K5fyg2OtqdNK2jOIS0pEUqoxhSEa6/JNHiUJsWmbJgGil3GrYPeyr0jmNr/Kpl0sjjNJsmzLgwDiDD/G5Z1PfHRJv9S3/VzSu4Po/JQk/LS7Gjuytwg+l3tI4n1xHaNQAymH3hIEZp8CeJ3++B4TyIrA3IXm7ySdpYY4x3wlpojA14qdyzv16PCPCMBHrpomCF+rnB37s3ohTqAzZBu4edi9vMGGOz6sCwI/lqPAm/wq2WXi2LTO2FH74QTYldxFggkpuLAsPvF17LOaFy4U7wnr5OMrvsQieqlaxpeUm2wggvlseW8Qlx+1j3jJS9xjX0Vg7kITscM37KrhQ0Zd7RIshd8lARi4H3xO0k9LgFjwGEkEztE4frvrRiN/S9L/BGFJNDj/jtn1Ybf0Ow2+gORAHSo1T8HTn2To7BxeMojPRa7PS2+wo7jcSTYQEIB8OUEAkg+X5/HlCHF5y4bNh5iBkg7rA0Fcvr/A9FgxjHyNCWxDYO5Ck2+3+JBVjWNj/Dfnain8LhEGbww1yUklZJsvAY4UyQ94z5DuputI2eXGh+5Vkt4WkqJ3beM04YsM6Xbq7EBJ+3Zt1NdnS4AdTsTm8s5nDtWgCCL9mKQ3h11TByRmu4TcsVwJzF1oEq3ITkzV8C17Za6Tsma/+vC7RCCwS4k44Iido3ZSi3xI0v4F7QKvOQWTv43sDIhLgsPOtMZoCNbgNcdrCz/cTexpLUISNw1ESGkJ1zfhOcV7+Xzii8Ztwxef8w00CL5UfyaIS3ZGfzXQc/0YE5glgbkLzadKenzNzD1J0gEzmVEc8PlQvvcGR5t8cBON/zpJxy5x2VXSTyRxVG6bJwFSgOEGwfphvrsaQV0cI7J7yReSdYIyqs+kXjQl9+renzgK5bi1FNeXrvMx5+vZ7VyIzhQ13XHvYOeSL9p2CZrzSvLYBiUwd6F5X0kH1xDlQ5Gdm6kbIvNN4dt+17EQ5UuUJAKToAxbOQQI0MB9BN9Lsg7w765GaipeR6+RxFrqywjU+64kchnWGXlwX9TXw9zOZAngb4ko7Mv2C+tqzjXZ+2LldkygE4G5C02iCw+pIfIRSTfqRCrPi18fjrhje8cxOEnrEZfsPjnFUCy5eVy3i6S7h58mIdc2UtKFvT0ITFwsUhi7o0QD1xmBGLymbWUS6LtKT5Uiu+X4Y3JcTuokksXbTMAENiQwd6FJGg2S51aNSFaiHqds7Oo8MGIAC79LxCU7mKTlsJVDgHrjpAhi95JE1OvYl4K4ZAcpZTDEgyS9sKGDHGWSJsf+cuvM4HTv6bNKTxcKBAF9MohOksSTK9NmAiawBoG5C82dJJEGpWp8U91hDV653EJFlEeu6EyT32UuY3A/0hIgfyy+yAS+rVMqkONwvpy8LJQDTdvbLV/8yMdal1+RL0uIZCLZbfMn0GeVnj5o4XeMzzA7nfz06SrSR//chglkTWDuQhP4fDMlVUrVKJU2xYTipHQh+KfNri7pi1mvPHcuJQG+RJHai6CZLka0LUeHRI2Ti5DXzhBGEu1vSLpow8NY7/jQ2eZLoM8qPexAsvuOOFzkayV4iEAifppSZsXQpb3PLolOBw3FUPM1RRMoQWhSOQTftKpxDHf4xGafo/K2QIgPhpJq9r2c2MT22F2SmFOSj/Uda+RFJaiH4B6yDAxtCFuO9uuMY3u+OMUkeB+6337eZgTGqtJDIQDcSRCdrK11PwfZaf9CEJ1EqlNy12YCJlAhsO4LbEog+dCt802jUgS7N1MxjkBf3tJZjhWp14tDu61MAhcIuzgXjhg+gWEEPCAuPyGpqZ54RFMbXdJWYhJ/YioTLafc2uhhvnl0ArlV6TmPpFsH0XmtDUqr8vohewdH64jOY0Yn7Q6YQCYEShCa+JntU8Ob6Ft2caZgVGnhKKhpvsj/RgWkKboCTIH/FPpI3W+OCvngbLNvhqNxXheU6xvT2kpM0i92nN45Zgf97F4IkIaNL/ukJGJOSWG1jqWu0kNO2VuFPtLfddJ+LcaFvzGikwBMV1JbZ7Z9z2wIlCA0KVX32JoZe4Kkp0xgJqnNyxtW05seb2i8KaaMBp4ApqK7SOk+ImTPvoLClSQdmgmpVSUmOU5nF982XQJXC+ISgbluXfqxqvQQSMp7L8KYL/F1fv6xM4P/Me/hb5V0ROxNvs4E5kKgBKH5AEkvrpkwjqHvk/lE3jgEZTS9yeFjypu5871lPpEJu3dVSeSF3a7lGeRMZaeG4/JczCUmc5mJfvtBSrk7hiIS5L1c13Kq0sMO7C2C6MTliuP/dY3UeovodVe3Wpei75sUgRKEJm8Q76mZFQJnmhJD5zCJlOHDh7Qu3Qv945sxtanr0jfl0H/3IT0BdlooSECuzCYjwfqdMkvO7xKT6dfGkE+4WBCXCMymzAEx/TksHDVz3Hx0zA0jXLN9qKbFTidFP06/QR+orrUQnYzdZgKzJFCC0CTFS91xIb5ql8l0VtmlIkDjTA39w+eHaMkTMu2/u5WeAF+gEJFtuyuvDqVWxwr0qaPgEpPp18YQT+irSg9iC2FJKV1y/07JyFVLpSpEJ5sWRNGva0cuic5c3FvWHYvvM4GtCJQgNHHwrst1RqWHVT5tYywXhDFBHbyJ1RnikjxwjsQdY3byeObekig/SpBFkz1f0sPy6O5WvXCJyQwnJbJLfVXpYbcSf0UCHOeyk8emAK5OiE7EJ3ma1zX4LHY6cSGwmcCkCZQgNBkjKX/q/BzZDcop5+QlQqJ1jmfqjGNyjsvtUD7pl91Gnb+fpJesyP33eElP3+gpaW52ick0XFO22leVHr7sswOPuJx7MQl2NjlWR3Ry8tC0aRAzb8eFXJ1U+fpuzA2+xgRyI1CC0IT5jyRRGaJq+BPlItpIT/N5SedoWCTswF5zgknmc1vzU+4PAvKpLQPgiJzgt4MzHKRLTGY4KQ1dSl2lZzokNu8pPvYEECE6iWJv2kRY9SRe27gY8B7A55nNBCZDoBShSckwRFrVrheqqIw9YSTYRmSeu6EjpC5iJxO/UluZBJ4n6aEtQycNzF0kvTFDPC4xmeGkVLo0VpWe/Mn010NO0AjgQ3SSJH6dfKKcwL1O0hNHquLVHw23VAyBUoQmxzXkcqvaXYOv25gTjrikzB7Jq+uMJOy8OdlXZ8xZGu/ZvEbJKUmBgSYjkfXtQiqs8Xra/GSXmMxxVrYEkrHbxnsju23rHvGeLOkDYccNH1z+bWsngCsX+Y8RnVTHIm9nFyNV2cskkSbs511u9LUmMDSBUoTmMyU9qgbu2L5sHJOzk8mxeZ3xhn1DSZSXtJVHgA8jonERkU32p5BuhSwFOZpLTOY1K1Op0pMXtbS9YU5I+YXo5LXeJbk9GxEvlHRQBpW+0lJy65MlUIrQfLCkF9TMEr5s9x9p9nCy/5wkAoDqjCOSPSV9fKT++bHjEiA/H7XIWQNN9tvwRSTX3W6XmBx3DS0/fTdJj5P075KIHl/HxqrSs05fp3oPopPUdVStY8cz1ija8RxJuNi4SlwsNV83CIFShCb+MHU1k0l2ffNBSG/9EI6o2MmkdGCd/T18u61LND9Cd/3IgQkQjMFR5LVanvsLSfgY5+q36xKTAy+ahsdROQyBebMNupNTlZ4NhjG5W68cgv/26NDzkyQ9I1TDy6kSWIch+NK5EShFaPKCxQ+yal+XdPmBJ5V8axxzkpS9ztg1oJILeeZsZRJ41QqfzOPDbkcuGRPqZsklJsddu7jcIDCvs2Y3plClZ82hTe42Almf1fKZUTcg3iPIUIF/ND7cNhMYjUApQvM8DRF65KXs4g+z6UQR2UldavxxmozI4f/a9EG+f7IEOOKkBnLTa5PUJhypHZPxCF1icpzJ4diV05t9JV1ujS5MuUrPGsOd3C0khGe38lIdes77xQGS3iCJTQybCQxOoBShyTg5jq4b71BJ2zlK/FDwkWqaaBJav3jwVeAH5kSAqlBNu1AkbL5u5lGmLjE5/GriPWyfIDB37fj4OVbp6YhgUpfzGUaAHbuV1JiPtcMlPSG4kOVUkja2/75uwgRKEZpMETtAdSmEdpF0VOI5PHUoKUYKkSYjKv7Zifvh5vMmcCtJ72rpIiLu13kPQS4xOdwE4YZzL0mPlHS+jo8l+TfRynOv0tMRy2QuZ/eaLxcEDV2gQ69xF9tP0gc73ONLTWAjAiUJzS9IwjG+auwepU4fRHJdji+aDH82Xvy2cgmwK4XP5QVrEJDChMo6uVcEcYnJYdYvXzioAEUte7JXxBrBIa8NqXByX0uxYyr9Ot437hl2K7tkEyDAi80NMp/YTCApgZKE5tsa8hHuHXIVpgT9E0n4idYZR+V8QNvKJvDoIADqKPA7ggFyNpeYTD87CImHh5RsZ+7wuN+F5N6cmPysw32+dDoE8P/nywf+uV2+fHxM0mMksdNpM4EkBEoSms8NOwBVkLzISOie0siJyfF51XDQvnPKB7vtSRAgcf+RkkhrVDV86Ejon3PkKEe4uJ+cq4G2d+w3W4YXCbtP/yGJ/KqxRgos8ge/aAIuF7Fj8nXtBEidx0437hTbdYD13iBS8QO3mUCvBEoSmrz4EJtVG2JHEb+67WuezQezy4f1uqQn2dhLWgoH4LeZcz7Vs4fdkKYSqqQVIwG1I167L012ifHBI9cvPnmxdlxI3k2JQipH2cojgHsFJyEPlcRuZ4wRJITvLhXz7FoRQ8zXRBEoSWhS2ovj86rxIc6HeUo7tsFZf4hApJTjctubE+AIlOPMuqPQz3SsDrJ5b7q1cIUggpsCUTiy3V0S698WT+BCkp4cgj26vEf/ILhfvF4Spyg2E2AzA+F4H0mni8TB2nmdJGILcPuymcBGBLq8iW30oAxuJhCIgKCqHSrpSon7x3FEXanJy2Rc2SUxEjcfCNwjJFWuA4JIy/UoiwAEdmLbPryo3VxXkcuTX08AFwqCAu8niSCPWPtayK8Ia+8cx1Ir6zpOHEhvhPtFnRtXHQ2Cx9gVx/XFJ29lrZdeR1uS0OSFVpfk+qeSzt0r1W0b4/iQ6kRVo+IDpSht5RJoWhscXeGbl5vhI/iKCN9iPqDum1vnM+0PvrmPCH51XYJ8yJbx9FAEItOhuVuZEcDf+0mS7tBSFKLaZbJekArrIPv6ZjabE+lOSUKzKWk7finsyqQ8avq4pOvXrIk9JX14ImvF3eyfABU+mmqVX1rSt/p/5EYtknqJoAF24tuMHZD9JTkxdDsn3nfYvYQVvq4xBtMPhF0mUtTYTGAdArz34P97iw43/yb4/j5P0u873OdLCydQktBkqpvSDOETRXRvKsMPtO4FfXtJb0/1ULebPYGXBqFR7eiXJV0ls95TO5tAgR1a+vVbSaQLI2m7rZnAItk21V2agqjq7kZY4mqRqzuF53x6BDhpYx3u0aHrJwVXDQJpOV63mUArgdKE5lhH2NQup4pD1fjQeLXXaJEE2oKAcloXvEfgN8hxW9v7xXfClynSNNmaCdwsHEHW+Ww33cX7FkfrdrPxykpFADcucvVetcMDjg8i9ZWZp1/rMCRfmoJAaUITZ/lb14DEX+WtKQCHNpt2rh4SfF8SPtpNZ0qgKQjoD+EYNYedAnYv2cVkN7PNeO0QZOBUOs2UrhGOHbvsVH875DY8JNM17G7Nj8CNw24lR+uxhj85le/IC+1gtFhqBV1XmtAkefGDa+aX5LbPSTjvOFGT06xq7BThz2Yrj0DT7jpfSqjwMbbhh4k/Zl1JzEXfSCLPThsJwW31BPjAJmDnph0A4cZDhLA/uDtA86W9EUAX3CbsVl6sQ+tSOu4AACAASURBVKuHh3XLho79szuAm/ulpQlNarvWVQF6fkPVoL7mH0GJ43XVEKCP7eshbmcyBHIPAtor5NFrq0JDtgbyzzogpX7ZrZMLE983/OUOlvSXyaxmd3SuBBa+xHx2XaDDIClnyWfeBzvc40tnTKA0oXnHhrrmfAMj518qozoDkXpVy2X3KtW43W49gVyDgIiCZp3ef8XEfTbseJzoCd6GwDq5MIng5USFH5Lc20wgJwLkdCVvLrvsO3foGF9C2dz5XId7fOkMCZQmNHF45kOyahxjdnGC7roUmvzxCBK6S9fGfP3kCfyqIXp7zCAgcsm+K+J1QBlX3ED+PvlZ6HcA6+TCZNfyP8MupkV7v/Ph1vonQClL3Hr2lbRjh+Y/JukxoVRth9t86VwIlCY0Oc6qq+FK2qOmMnp9zDVpjOqCjd7dEJzUxzPdRp4ESJhMqcA64418jCCga4UKPuzGNRlBSnwpQox2NcbFBxO5Ihd/Nv198fudJJ2m64Mmdj21zInWt5nAlAicJbiaEduwXYeOvzGclpAGzVYQgdKEJh9c7CJUx43jMmW5Ujkwk5i9zl+FRO5d8pcVtDRnO1QyHLy5ZnSfbEjqnxoER1sHrihL9/2l1EUIwTqx2CYgz5R6EBNt/7hQPYkE7DYTmBqBs4XTDVzD+DIZY2zq3EkSVa1shRAoTWgyrQQxnKtmfkmczBt/ChvryD7FWNzmZgTIVcdOQNX4/7rMBJs9rf5uXvfs4CNwYtKYcKxLYFCX3YsU/Z5rm+8IR5KuJz3XGZ73uPg8fbyk+4Qqe6tGy4YOmSo4Tj951cX+/fQJlCg0D5V0hZqpu1rCCNrLNvinUOFj9+kvI4+gAwF2Lq9bc/26uVzxDey6wxhb7rDDsHzphgQo70cGCmrEpzpZ2bCLvt0EWgmwWUPAEDl1OSFcZUdIIsMFUeq2GRMoUWg2lYO8nSR2FlLYLpJ+WNPwsR3TRqTom9sclsCvJW1f80h8N+vWyPKlRIWT+PsGIYk6X2BKfA0PO2PDPo1I3btLIiehzQSmSID3MiqJ8eV51fvT3yQ9OeSadYDhFGc7os+rFkFEE5O7hPqsdQmxHyaJfJop7JySftbQcIlzkILxVNps2q1qWgcXDaKS6jzshNrfcSozvX4/8SMn3y/5C51Pc32OvnNcAruFU0JOXVbZV4IwPWrVhf799AiUKHI4niL4oWrksKvznetjVs8o6Y8NDaXcSe2j726jXwKrhCa7ndcP4pJycCmzIfQ7subWKEvHTu4vws8va/5e939j55SEPQF7MdVRYnNhXlHSayQRcb7KOFok5VVdSrZV9/r3JpALAco+v6ohpdtyH/mM5DOYggW2GREoUWjuI4n8lVUj/RBb/amMD03SQlSNFxfl/lYdm6bql9sdlgDVX+p8JJ8YxCW1sGP8m4bt9SlPIzUJgnEhDGNEI3lDp+Z3iO80InNVgup1cmGS/YITFI4X+RK6yhCmlPqEo80EpkiA1xElVfkSvco+IYnPaQJ3bTMgUKLQ/DdJn6qZu89LIjo8lb2kpeLK90KAUtOuZ6o+ud3hCbwlOMAP/+TmJxLtTLqRVQKS35fgR3UdSYdIajvyY5eWvIAEP/x4zcmkjjwisi44rNokkf+kkXnTms/ybSaQA4H7SXp2hAsQJyDs5q+TtzeHcboPSwRKFJq7SuJIqmrHSOKNP5VRxuuLDRHvPJNAJI7RbfMjgF8l4gU/y7tGHCF1JYD/77JI/FPk7vz7Je0tyQmUTyHOaxAByeu1zUgL9e2uE9VwPXkFX9iw01295aOS7i3p6J6e7WZMYGgCF5HEF+4rRTyYL1aIU79HRcDK9ZIShSbHVn+tmRCi34jqTXnEd97w4bRDw4K4b0hvkut6cb/iCPC6unQQlkSIU3mHtdWXISwRHPx8KIjMRdtkOHjvirRZ7MYdEIJN+urTHNrhA4069G326lD3ue/3CVJUsdNDaphVxskH80c50BJ2mFfx8O+nRwD3IEpZciKwqgKYk7xPb3636nGJQhMAHENR4q5q55F0QuI5RXh8uCHtAwKYYIFvJu6Dm++fAJkFqPLE/FIJqq2cY9enU5byc0FYfkTSNxoauGnYjWtLrM6RFL7ItGPbQoD3QUTew1cA2U/S0xJD40vJayWx67PK2FG9s6TDVl3o35tApgQuF8ozkxKpzZzkPdMJjOlWqUKTBLHkIKzalSWRZiG1kTds/4aHcCRG3xAEtvwJUIaNY0+OP0/VY3fx20UM8vNpSRyHNxlpRGJqZiNQb+Fj160wckTOUXmb2wq7hrg8cN0QRhUmRC0ZMlbt9rA7zc4mVaX63mUdYqx+hglQvvIgSQ+OQOEk7xGQcrukVKGJoz+7P1UjDcO7B5gkuFMhhsCkOuNIFH8+W94ECB57m6Rz99BNIoqJtkRYflDS8SvaZA2xc0r08r9HPJ9MC/eSxO6obQsBgn3wU712CxCOqRHnRKAPbZeQxFH9VSMenDI9W8TjfYkJbEyAiPTXScLFrM2c5H1j1MM2UKrQJE8X/pBV4xsVNViHMFLcsMPU9KJ6nKRnDNERP6MzAfyLSEdEfd91dzHZJfvS0nH4lyWxO7XKSIfDcSnHvDH5HRGWD5L0ilUNF/Z70q0gHttKwOJigyvEmEfTvEdTQ5oE7m1R8KmDGQtbHh7uSASIX6CoCkGKq8xJ3lcRyuT3pQpNBMJTa+aAN/PHDDg31Fyn5Fzd8Riigx0zItVt+RCgni+7mDG7TNVe4xbBjuUikKdLQvJzhYpW94+MTubZx0m6paSv5oMvi54g0Nk9bts5OTLk/Msluptdc1w0bttCsNT38ywWlTvRKwEnee8V57iNlfrGhL8VDvdVI5VCzDepPmeN3HjPa2iQ6GKSuTeVr+yzH25rNQFEG+umrlZ53d1/CP6VC1/LH6x+xDZXkEaH43HWZZfIdVwzbl+JSF/j8bO75WohUr9tDtnB5BiPZPS52U3CcX9dv0p9P89tjtyffgg4yXs/HEdvpdQ3Jj5E6nyuSFpNvsOh7X2SbtbwUHY02dmMOVYdut+lPI88mM8PPo4xY8blgV1LIsXrUmmtaqOr/+Vye1SqeVZIG+I1szVpfFrfs0Kw876AT2bOxRNWlTFdtb78exOYEgEneZ/SbNX0tVShydEZUb1VO0oSeQiHNkpTEglPMvk6G/pIf+jx5/w8fPjeGeEPeXIoE7gqD2PbWLv6Xy63RcL2/5T0gpC+K2emY/Tt7sFPtc2nlqhyTjtyz01poTnGCvIzxyTQJcn7myU9MNMTiTEZjvbsUoUmO1Qca1ZtiKTtTZNNhClik9QmdUYUOrtktuEIPEAS0bxNc7Loyfcl3SYyxVBd79fxv1y0wxcmdls50ndEef3awB8bv+w245qmlGPDrbi4J1loxnHyVfMi0DXJO65DX5gXgmmOplShyWzhf0UOxKrxoU/t5zFsH0mkoakz8mqSXzOX4IQx+Az1THwh3xoCaVY98+WSHiKJHc2utq7/Jc8hmIX8iaRCstUT4IOJdCltfte4F5D2iTRCUzELzanMlPuZgkBskndOJvjyiCuTc8ymmInINksWmlTf4YO+akSCfy2SX4rLSENzz4aG6TNJ5b1zlYL8KW22zcHiqt9Iulvw+evSm039LzkWwpXiu10eWuC1nFpQirMtxyhfDohupYznlMxCc0qz5b6mINAlyTt+13v5KD3FNMS1WbLQZCeI4ICqEQhAcM5YxjEtORWplV1niKB7j9W5Qp7bVKJ0MXxSUnEsc2wHHva/7ABrw0sp/4mbSV31r+UvCojQQzd81hi3W2iOQd3PzJFAbJJ36qX7KH2kGSxZaHLkyZFZ1fDL2ySgo4+pvKAk6hgTJFRnJOx+Qx8Pchu1BJo+yDlmpdb1kzoEjNj/cthFxmvnM5L4s8n40OEDCt/aKZqF5hRnzX1ORWC7cHrRVGlv8VwfpaeagRXtliw0nxAEQxXRgZL2HWk+lh9LuqOmnVWOzvFTOTyDfs6xC2P789j/cr1VxQ4mO5nsaDYZNeHZyfzpeo/I4i4LzSymwZ3IiABa5rGSniIJ3+w281H6wBNXstAk3cmrangTjHOXgeeh6XH44j2q4Zc/DGLz95n0dU7dGENokv/S/pfrryLEIz6Z+GY2GXlybyqpS0Wm9XuU7k4LzXRs3fK0CVw9VG5bVS/dR+kDznPJQpMaxlRsqdqnJF1vwDloexSlKflwpJpJnR0i6eaZ9HVO3RhSaDr/5eYrh6hyosvbdjLeHqLP10mgv3kP+23BQrNfnm5tXgR2DFlD2gIBGbGP0gea95KF5m4NeQ+PkHTRgfjHPAYfv29I4s86o4QlSbpt/RE4qUM98XWf6vyX65Lb+j7yY5IDs81IA/WIfh6XRSsWmllMgzuRMQEfpWc0OSULTRyISVFTNZK2nzajOaIr7GhSzrCuqgn9vaqkr2bW5yl35y0hHUaKMdj/sh+qvBbIwIALTJvdX9LB/Twym1YsNLOZCnckcwI+Ss9ggkoWmuCnOlCdT9fZM8y59ThJT29YM/ibXEYSx7C2zQnsHHJV4l7RtJPc5SkEb+F/SQ1y57/sQq7+WnLowfOWLU1xRM6ROkfmczMLzbnNqMeTkoCP0lPSjWi7dKHJhz6lH6tG9CrH1bkZPqWInzr7dPAtHdK/MDc+7s/8CbCT+e4VvskE+5C1gTRHczQLzTnOqseUkoCP0lPSXdF26UKzSbgRmfqBEeel6dE7SDqsJUcg+R0PyLDf7pIJ9EXglZLu0dIYaYsIAiCN0VzNQnOuM+txpSbgo/TUhGvaL11okt6ozsfrvpJeNsJ8xDySikFUM6nzI+UDiIh5djdtJjA3Am3uI4yVBOyIzOPmNvDKeCw0Zz7BHl5SAj5KT4p328ZLF5rsAJK4vWpEse4/8Fx0eRxCuCnAAT9N/DXx27SZwFwI7COJHLdNxpcvRGZdgN9cGCzGYaE5txn1eIYm0OUo/f3BVcduaWvOUulCkxKUlKKs2msl/ceaTIe6jSCH2zY8jPKVHBFMPTH1UCz9nLwJsEtPxZ+mPJmITK4pZb1baOa9Xt276RCIPUp/TXDZsdhcY25LF5p7SvpgDTdKVO2xBs8hbyFanpRGF2946PGSyBVawg7PkNz9rGEJUGr1s5LO3PBYjsuvVJDIBIOF5rBr0E+bN4HYo3SLzTXXQelC81KSvlnDjmTaddHoa2JOdtuuITq+qexeKT5ryQC74VEJ7CLpSy3J8/kyhcjkz5LMQrOk2fZYhyAQe5RusbnGbJQuNM/Wki9zKmw4Pm/LFVhCFO4aS9+3ZE6AXLZfk3SBhn7+OhQq4MtUSUZ6J0rn1dlU3rNKmi+PdVoEOEp/h6Rzt3TbYrPjnPqNSfqtpLPWcLuIpB915DnW5S+S9MCWh+O7dkNJXxyrg36uCXQgwDE5x+Ucm9fZXyRdS9KXO7Q5l0tfL+nOFppzmU6PI0MCOwWXOk5Lmsxis8PEWWhKnw+BM1Vst5L0ng4sx7z0dKGv+Jw2GR/Ot5f03jE76mebwAoCBPwQ+ENwT539QxKvzfcVSLLtCyVZJs5XIBMP2QRSEODkgJy9bUHBFpuR5C00pZdKul8NrydKenIkxxwui6n9jG/XA2ZY+zkH/u5DPwRIYUQqoya7pyTy35Zmj5dE2rUmIx1b2+9L4+XxmsCmBCw2NyUY7rfQlJpyUr5L0m164jxkM3zgrBLI1Nx+9JCd8rNMIILAgZIe23Idv983op25XdKUhm0xTjJn3LzFd3NuPDweExiKgMVmD6QtNKWrSfpCDcsfSvrXHhiP0cTekvDl4kXSZAQQcd1fx+ign2kCFQKUleSoqsne0OKbOGeYe0l6s6Sm9+r/DqnYcI2xmYAJ9E8gRmzmXuSlfyodWrTQlEgN9IcGZgQl/LEDz5wuxV+TXdkztHSKDymum+oYc+LtvqxPgN24d7d8MfqkpBsUuGN3yxAB25Sonjy61/brd/2F5ztNIJLAKrGJW9p2kn4f2V5Rl1lobpludi/J2Vc1djv/Z8Ir4oqSPiKJhLRNdlj4ED9xwuN016dL4JqSPiGJgLY6+3qIMG/6Mjjdkbf3nHKaH5J0mobLDteW0xgXZJjrCvC4ciOwSmxury1ZbGwVAhaaW4Cw80cka9Xw33zZxFcNApoP8gu2jONoSdeXdOTEx+ruT4vAxSR9pSG9GCM5StKVJf1iWsPauLdXlfSpltOIIyRdQ5K/HG6M2g2YQCcCTWLzdZLu1qmlgi620Nwy2USYH1Az70SkE6U9dTtHSBlz2ZaB/DLk2qRutM0EUhM4TxCZ/FlniMvLSzomdUcya//S2pJy7SwN/TpW0lUknZBZv90dEyiFALqJYFoyQWBoh+eWMvh1xmmhuYUau5nsalaNN3yO9uZg+KJyFIdPV5OdLOlmkqj1bjOBVAQokMBOJjuadcYxOQnZOTYvyQg+xFWnydWFHUxE5lQKSZQ0dx5reQSoLEheX7uvrJh7C80tgKgCVHdsTJAMAUFzsdNKeqOk27UMiPJ2dw3XzWXcHkc+BPDFxJWj6Qsc64/AHwKASrLzh7ruTaXv+DDDJxPfTJsJmIAJTIaAheYpU8UuCrt+VZtSKcqYhcecHyTpUSsufoKkp8Q06GtMoAOBVQnZKa9IKqOSDHFJirULNQyaL7ycRBBlbjMBEzCBSRGw0DxluuZQirLL4qMa0kta8vPR1qslkSya4wGbCWxK4NaS3tnSyOMkPWPTh0zsfo7JOS5vytlLfsw9JJGKzGYCJmACkyNgoXnKlM2lFGWXRXgLSSRu50i9yfDrxIf1z10a9rUmUCGAoCJausn/kLKSlJcsyQj44QsuAUB19jdJvEap/GMzARMwgUkSsNA8ZdrmVooydkFeR9IhLSlmaOeLIbG7nZ5jqfq6KoG3tfgG/0DSJQrbOaeQAimMSGVUZ5wiUAL3PV5KJmACJjBlAhaap8zeHEtRxq7N3UOk+c4tN3xfEkmkj4tt1NeZQCDQdmROWi2OjfmzFCMJOycFvJ6a7C6S8Ge1mYAJmMCkCVhonjJ9cy1FGbtAzxfEZlPKGdr5afhw/E5so76ueAKrjszZtatLLTZXcCR8xk+V8pJN9iBJL54rAI/LBEygLAIWmlvP91xLUcauakpokUOT0pVN9ruQ2J3jdJsJrCLQdmTO7/Za1cCMfs/7LRVEiKxvMjI9kPHBZgImYAKzIGChufU0zrkUZeyCxXcMDnu23EAk7O0lvTe2UV9XJAEfmW897S8PWRyaFsMrJN27yJXiQZuACcyWgIXm1lM791KUsQuZ4z0+9O7ecsM/Q3nOg2Mb9XVFEfCR+dbTzU7lfi0rAH9MCiXwurKZgAmYwGwIWGhuPZUllKLssnj3l/TkFTc8K9R97dKur50/AR+ZnzLHD5T0opYpJ7IcX1Xnq53/68IjNIHiCFhobj3lpZSi7LLQ95b0eknscjYZuTi57q9dGva1syXgI/NTphZ/TF4/TYZPNG4q5My0mYAJmMDsCFhobjulpZSi7LKY+SDEbxP/zSajcgnXUS7PVi4BH5mfMvdElhNh3vQljYpA15V0crnLxSM3AROYOwELzW1nuLRSlLFrnEj0j7RUdqGdwyTdQNKJsY36utkRaKqwxUBLijK/cQiWI2dmnX1T0jUk/X52K8ADMgETMIElAhaa2y6HEktRxr4odpH0CUkXbLnhaEnXl3RkbKO+bjYEdpJ0bMPOd0mJ2a8t6WOSTtcws4dLumZhSepns8g9EBMwgW4ELDS35VVqKcrYlXMOSR+VdNmWGxAVN5R0aGyjvm4WBJ4n6aENIyklMfsVJOFGQgGIOvuxpCt7138W692DMAETiCBgobktpJJLUUYsmf+7hA9RSuixc9Nk+J3dLCSAj23X102XQNtuJn67Z57u0KJ7Tr12ChlQ+KDOTpB0lbDrG92oLzQBEzCBKROw0Nx29kovRRm7nk8r6Y2Sbtdyw99DbkCus82bwHMkPbxmiHzhOL+kk+Y9fF1Y0pckseNfZ+zyX1XSETPn4OGZgAmYwFYELDTrF0TppShjXyasn4MkPWrFDZTUI2G1bZ4ETh2Ogs9WMzyO0+sE6JxIIKQJIuTPOiPgh8AfAoBsJmACJlAUAQvN+ul2KcpuL4P7SXqJpLb19OpQfs9JqbuxncLVO0j6VU1HS9jNZAfzy5Iu1DBRMCCFEamMbCZgAiZQHAELzfopdynK7i+FW0gicTtH6m22mySibm3zIvCZGp/dx0h65ryGudVo8MXEJxPfzDr7i6Sb2E95xivAQzMBE1hJwEKzHpFLUa5cOrUXXEfSIZLO2nI7O5rUdd5X0vHrPcZ3ZUhgu1Bm8faSyB35XEkIzbkavtxElxNlXmf4J99c0gfnCsDjMgETMIEYAhaa9ZSaSlFyNTt2LhfXvLp2Dzs4O69YgBwpUv/5qZJ+G7NYfc0kCFA96pySjplEb9frJPkxyZPZlHXhn5LuKOmt6zXvu0zABExgPgQsNJvn8neSzlLz66uH47L5rIL+R3K+IDYvFtE0vn1PC6KTo0abCeRMgPyxX1/RwXtLekXOg3DfTMAETGAoAhaazaRJSr5Hza858j1wqAma8HPwX/u4JEpXxhg7YPtJeoMkdoRsJpATgUtJwnebxPNt9nhJT8+p4+6LCZiACYxJwEKzmT6Ckp22qiFAqXpjW03gjJJeI2mv1Zf+/xXfCL591FW3mcDYBBYC89YrsirQzxdLetDYHfbzTcAETCAnAhaazbPBETm58ar253Ckbj/N+JVMkNDzV5StrLZGFDPlDA+Lf4yvNIHeCHQRmDyUo3KOzG0mYAImYAJLBCw0m5cDkbMkWj59zSX20+z+MmKtsbOJ20FTzsFqqxyhv1kSx5HUiLaZQGoCXQUm/SHoh+Afu3yknh23bwImMDkCFprtU2Y/zf6XNFH7JHinWtDZI5snSOilkp7ckBg8shlfZgKNBNYRmAjLZwdXD4tMLy4TMAETqCFgodm+LOynme5lQ97FR4fyhPhyxthvQslLyhqSHslmApsSWFdgvjMEB3130w74fhMwAROYMwELzfbZtZ9m+tV/HkkHSLq7JGpmx9hPwoc8gUYuaRlDzNdUCVhgek2YgAmYwAAELDTbIdtPc4BFGB5BGb9nhGoqsU/9jqTHSnp/7A2+rngCFpjFLwEDMAETGJKAheZq2vbTXM2ozyuuIukFkvgz1sgOQIT6obE3+LriCFhgFjflHrAJmEAOBCw0V8+C/TRXM0pxBXkLnylplw6NvyPscB7Z4R5fOm8CFpjznl+PzgRMIHMCFpqrJ8h+mqsZpboC14V7hmjzc0Q+hPymL5P0JEknRt7jy+ZHwAJzfnPqEZmACUyQgIXm6kmzn+ZqRqmvOLOkR4Qodf4eY+RAfZak50j6Q8wNvmYWBCwwZzGNHoQJmMBcCFhoxs1kk58mufOuLemLkv4e15Sv2oDAOUP+zftI4gtAjP0sRLVTucVzFENsmtdYYE5z3txrEzCBmROw0Iyb4CY/zcXdv5aEGP1Q+EHc2NIR2DVUGLpth0f8QNLjJL2rwz2+NH8CFpj5z5F7aAImUDABC824yW/y04y7e+urEKGIUpKV/3SdBnzP/xO4Yqihfo0OTL4k6SGS+NM2XQIWmNOdO/fcBEygIAIWmnGTzTEtu5ax/oExrVIf+Q4xF/qalQRuGiLUycUZa+8NYp+dTtt0CFhgTmeu3FMTMAETkIVm/CJ4rqSHxV++8spfSNpp5VW+IJYAVYXuKukpkqg2FGP4bL5a0v6S7O4QQ2y4a04v6aKSdlv6uWUH31x6ig+1S0UON2d+kgmYgAlsQ8BCM35R7CiJGtt3lnoR6Baa8ey7XEnddJK344951sgb/xjm9iBJv4u8x5f1Q4BTgotLYjd6WVSSP/VUaz7CAnNNcL7NBEzABPomYKHZnejOkm4kaU9JN5S0ffcm/u8OH52vCS7ytrNL2k/SAySdNvKek8KO6MGS/hp5jy+LI8DrBDFZFZQX7OmLm3cw4+bBV5mACZjAoAQsNDfDzXHt1YLoRHheLqI5BwNFQOrxkgtLeqqkO3YQNEdJenz4MsDumC2eAAJ/sTO5LCrPG99E5yu9g9kZmW8wARMwgWEIWGgOw9lPGZ/AZUOE+nU6dOWwcAz/mQ73lHLpuYOgrO5QxlZw6oOTBWYfFN2GCZiACSQkYKGZEK6bzpIA7g7PlnTJjr37kaTfLP38tsO/uXaKO6O8P5y/Zody9w1cRjpib7ycuvZPlPTdvhp0OyZgAiZgAv0TsNDsn6lbzJ8A634fSU8LQip1jxGZBBkhVLsI1OXrfynpH4k6StANLgbLwTiLnco+U3p17f7Jkr4fxOTh4U+E5RGSqGlvMwETMAETyJyAhWbmE+TuJSVACp0HhqChHZI+qZ/G/9RhR7VO1BJdT+qnqqBEVMJiLKMW/bKQXPwdX9lU4nqssfq5JmACJlAUAQvNoqbbg20ggMgkHdKDJZ3BlJIRoOhBnaA8OtkT3bAJmIAJmMCoBCw0R8Xvh2dGAH9EEr7fpUOEemZDyKI7Jy4dc3PUvRCXJ2TRO3fCBEzABExgMAIWmoOh9oMmRIBAoQMl3cSCs3XWjq8RlN+WhD+pzQRMwARMwAR6qXBjjCYwZwJUGiLZ+OJnuxX/5rrqNbQxVSOQ6ZiKoGSXkh8Cm2wmYAImYAIm0EjAO5peHCaQnsBpgjhdR6Qu35Oyp9R9J/hm2YdycexNEJHNBEzABEzABDoTsNDsjMw3mMAoBHitUrs9dme1TtTuKAlBSXqgqqAkjdCfRxmZH2oCJmACJjBbAhaas51aD8wETMAETMAETMAExiVgoTkufz/dBEzABEzABEzABGZLwEJztlPrgZmACZiACZiACZjAuAQsNMfl76ebgAmYgAmYgAmYwGwJWGjOdmo9MBMwARMwbjH2owAAAOJJREFUARMwARMYl4CF5rj8/XQTMAETMAETMAETmC0BC83ZTq0HZgImYAImYAImYALjErDQHJe/n24CJmACJmACJmACsyVgoTnbqfXATMAETMAETMAETGBcAhaa4/L3003ABEzABEzABExgtgQsNGc7tR6YCZiACZiACZiACYxLwEJzXP5+ugmYgAmYgAmYgAnMloCF5myn1gMzARMwARMwARMwgXEJWGiOy99PNwETMAETMAETMIHZErDQnO3UemAmYAImYAImYAImMC4BC81x+fvpJmACJmACJmACJjBbAv8LMxaYohVSmfkAAAAASUVORK5CYII= seals: [] texts: [] checks: [] inserts: [] tags: - type: system name: fields fields: - id: d88e08ddbc12ee20f6830750787f8314f38938b4 type: signature role_id: 4882e98672db1bbe55ccdef31cf43d24cf1917ca json_attributes: page_number: 0 x: 70 'y': 362 width: 83 height: 21 required: true name: Signature_1 role: Signer 1 originator: api@signnow.com fulfiller: guest_signer_585873482916@no.reply field_request_id: c23790a9ad6a7cbc586f6b8d8a0c1f360097047c element_id: 2600e6cfbe65cfeb5624749fbe75b432c392c128 field_request_canceled: null template_field_id: null field_id: c23790a9ad6a7cbc586f6b8d8a0c1f360097047c requests: [] notary_invites: [] roles: - unique_id: 4882e98672db1bbe55ccdef31cf43d24cf1917ca signing_order: '1' name: Signer 1 field_invites: - id: 372cf980e486bd977da68f7ea31da0f05dd01139 status: fulfilled is_document_locked: '0' password_protected: '0' password_type: '' password_method: '' reassign: '0' pfrid: null pfrtype: null pfrmerchant_id: null pfrstatus: null pframount: null pfrpayment_transaction_id: null pfrcreated: null pfrmerchant_type: null pfrmerchant_account_name: null pfrcurrency_name: null pfrjson_attributes: null id_verification_required: 'NO' id_verified: UNVERIFIED created: '1565858734' email: guest_signer_585873482916@no.reply role: Signer 1 reminder: '0' updated: '1565858757' expiration_time: '1568450734' role_id: 4882e98672db1bbe55ccdef31cf43d24cf1917ca electronic_consent_id: null stripe_ach_bank_account_verified: '0' stripe_ach_bank_account_present: '0' redirect_uri: null declined: [] prefill_signature_name: null force_new_signature: null signing_instructions: null required_preset_signature_name: null decline_by_signature: null electronic_consent_required: 0 payment_request: null version_time: '1565858757' enumeration_options: [] attachments: [] routing_details: - id: 983f2a230a808d9a7d92fd15ae2902d21441762a data: - default_email: '' inviter_role: false name: Signer 1 role_id: 4882e98672db1bbe55ccdef31cf43d24cf1917ca signing_order: 1 created: '1565858709' updated: null cc: [] cc_step: [] invite_link_instructions: null integrations: [] hyperlinks: [] radiobuttons: [] document_group_template_info: [] originator_organization_settings: - setting: invite_completion_redirect_url value: 'https://facebook.com' - setting: invite_decline_redirect_url value: '' - setting: required_preset_signature_name value: '0' - setting: require_email_subject value: '0' - setting: require_login_for_signing value: '0' - setting: logout_on_signing value: '0' - setting: front_end_session_length value: '0' - setting: add_signature_stamp_with_name value: '0' - setting: cfr_title_21_part_11 value: '0' - setting: require_authentication_for_invites value: '0' - setting: document_guide value: '1' - setting: block_export_options_when_credit_card_validation_is_used value: 'no' document_group_info: document_group_id: null document_group_name: null invite_id: null invite_status: null doc_count_in_group: 0 settings: no_document_attachment: false copy_export: false no_document_file_attachments: false no_user_signature_return: false mobileweb_option: false require_drawn_signatures: false org_allowed_team_admins: false cloud_auto_export: false digitally_sign_dowloaded_docs: false invite_completion_redirect_url: false invite_decline_redirect_url: false add_signature_stamp: false pending_invite_document_view_notification: false signing_link_document_download: false required_preset_signature_name: false cloud_export_with_history: false emailed_docs_include_history: false require_email_subject: false document_completion_retention_days: false enable_hyperlink_protection: false enable_advanced_threat_protection: false require_login_for_signing: false logout_on_signing: false audit_trail_completion_retention_days: false front_end_session_length: false email_admin_on_banned_login: false add_signature_stamp_with_name: false cfr_title_21_part_11: false unsuccessful_logout_attempts_allowed: false require_authentication_for_invites: false electronic_consent_required: false electronic_consent_text: false document_guide: false watermark_downloaded_document: false restrict_download: false disable_email_notifications: false upload_limit: false document_schema_extended: false invite_update_notifications_for_all_invites_at_invite_create: false enable_full_story_tracker: false document_attachment_only_for_signer: false sso-only-login: false block_export_options_when_credit_card_validation_is_used: false only_administrator_is_able_to_invite_to_the_team: false block_login_via_social_networks: false parent_id: c8fdb570bddbefab469a30a8cb4de4d96851cce3 originator_logo: '' pages: - src: 'https://api.signnow.com/document/a09b26feeba7ce70228afe6290f4445700b6f349/thumbnail?size=large&page=0' size: width: 612 height: 792 summary: Get document description: This endpoint returns details of specific document tags: - Document produces: - application/json parameters: - in: path name: document_id type: string required: true - $ref: '#/parameters/auth-bearer' put: responses: '200': description: '' schema: type: object properties: id: type: string examples: application/json: id: 3db38d8c1fdfca762b25d57d82b3cf327a65485e summary: Edit document tags: - Document consumes: - application/json produces: - application/json parameters: - in: path name: document_id type: string required: true - in: body name: body schema: type: object properties: {} x-examples: application/json: "{\n \"document_name\": \"new_name\", //not required field.Changes the name of the document\n \"client_timestamp\": 1566237855, //not required field. Local time of a user\n \"fields\":[\n {\n \"x\":305,\n \"y\":18,\n \"width\":122,\n \"height\":34,\n \"page_number\":0,\n \"role\":\"Signer 1\",\n \"required\":true,\n \"type\":\"signature\"\n },\n {\n \"x\":307,\n \"y\":67,\n \"width\":60,\n \"height\":12,\n \"page_number\":0,\n \"label\":\"a sample label\",\n \"role\":\"Signer 1\",\n \"required\":true,\n \"type\":\"text\"\n },\n {\n \"x\":409,\n \"y\":67,\n \"width\":41,\n \"height\":26,\n \"page_number\":0,\n \"role\":\"Signer 1\",\n \"required\":true,\n \"type\":\"initials\"\n },\n {\n \"x\":481,\n \"y\":69,\n \"width\":12,\n \"height\":12,\n \"page_number\":0,\n \"role\":\"Signer 1\",\n \"required\":true,\n \"type\":\"checkbox\"\n },\n\t {\n \"x\":38,\n \"y\":77,\n \"width\":87,\n \"height\":16,\n \"page_number\":0,\n \"label\":\"Select Year\",\n \"role\":\"Client\",\n \"required\":true,\n \"custom_defined_option\":false,\n \"enumeration_options\":\n [\n \"2014\",\n \"2015\",\n \"2016\"\n ],\n\t \"type\":\"enumeration\"\n },\n {\n \"x\": 395,\n \"y\": 372,\n \"width\": 177,\n \"height\": 50,\n \"page_number\": 0,\n \"role\": \"signer\",\n \"required\": true,\n \"type\": \"radiobutton\",\n \"name\": \"GROUP_NAME\",\n \"radio\":\n [\n { \n \"page_number\": \"0\",\n \"x\": \"10\",\n \"y\": \"20\", \n \"width\": \"25\",\n \"height\": \"25\",\n \"checked\": \"0\",\n \"value\": \"apple\",\n \"created\": \"123456789\"\n },\n { \n \"page_number\": \"0\",\n \"x\": \"40\",\n \"y\": \"20\",\n \"width\": \"25\",\n \"height\": \"25\",\n \"checked\": \"0\",\n \"value\": \"cherry\",\n \"created\": \"123456789\"\n }\n ],\n { \n \"page_number\": 0,\n \"type\": \"text\",\n \"name\": \"FieldName\",\n \"role\": \"Signer 1\",\n \"validator_id\": \"13435fa6c2a17f83177fcbb5c4a9376ce85befeb\",/\n \"lock_to_sign_date\": true, //not required field. Used to set the current date when signing (only for the following \"validator_id :\"13435fa6c2a17f83177fcbb5c4a9376ce85befeb\", \"059b068ef8ee5cc27e09ba79af58f9e805b7c2b3\", \"09d3bb6a5eb6598edb7bfad02b0143d8c68ad788\", \"0f4827a308018f98b11ae3923104685ff0c03070\", \"06448a0d0eb6a71c7c116ec4754bcb04ebf11da5\" )\n \"required\": true, \n \"height\": 40, \n \"width\": 50, \n \"x\": 217, \n \"y\": 32 \n }\n ],\n \"signatures\":\n [\n {\n \"page_number\":0, //required field. The page number of the document\n \"data\":\"iVRFWHRkYAAAABJRU5ErkJggg==\", //required field.Data of field. Сan be obtained using the request GET /user/signature\n \"field_id\":\"08d17bbc28144ee39360383fbeefd9d3aef85dc4\", //required field.Field request id. Сan be obtained using the request GET /document/{{documentUniqueId}}\n \"client_timestamp\":1566237855, //not required field. Local time of a user\n \"width\":122, //required field. Width of the field\n \"height\":34, //required field. Height of the field\n \"x\":88, //required field. X coordinate of the field\n \"y\":15, //required field. X coordinate of the field\n \"size\":11, //required field. Size of the field\n \"line_height\":12 //required field. The lIne height of the field\n }, //initials\n {\n \"page_number\":0, //required field. The page number of the document\n \"data\":\"dFQFQ1vZRU5ErkJggg==\", //required field.Data of field. Сan be obtained using the request GET /user/signature\n \"field_id\":\"1f0471b4913b488c87d7d1b5f6cf209e574c913f\", //required field.Field request id. Сan be obtained using the request GET /document/{{documentUniqueId}}\n \"client_timestamp\":1566237855, //not required field. Local time of a user\n \"width\":122, //required field. Width of the field\n \"height\":34, //required field. Height of the field\n \"x\":88, //required field. X coordinate of the field\n \"y\":15, //required field. X coordinate of the field\n \"size\":10, //required field. Size of the field\n \"line_height\":12 //required field. The lIne height of the field\n }\n ],\n \"attachments\":\n [\n {\n \"page_number\": 0, //required field. The page number of the document\n \"field_id\": \"b9584d8fbb64440dbfb9306543e20169b1b5ebe9\", //required field.Field request id. Сan be obtained using the request GET /document/{{documentUniqueId}}\n \"client_timestamp\": 1566237855, //not required field. Local time of a user\n \"attachment_unique_id\": \"3739a86bfc984e190ff4c43a94dd5cb8490e9608\", //Attachment unique id. Сan be obtained using the request POST {{ts_url}}/document/{{document_id}}/attachment\n \"width\": 131, //required field. Width of the field\n \"height\": 22, //required field. Height of the field\n \"x\": 639, //required field. X coordinate of the field\n \"y\": 388, //required field. X coordinate of the field\n \"size\": 15, //required field. Size of the field\n \"line_height\": 14 //required field. LIne height of the field\n }\n ],\n \"checks\":\n [\n {\n \"page_number\": 0, //required field. The page number of the document\n \"field_id\": \"998eea32eb334d97afe00128030f4103e4dac49e\", //required field.Field request id. Сan be obtained using the request GET /document/{{documentUniqueId}}\n \"client_timestamp\": 1566237855, //not required field. Local time of a user\n \"width\": 17, //required field. Width of the field\n \"height\": 17, //required field. Height of the field\n \"x\": 754, //required field. X coordinate of the field\n \"y\": 417, //required field. X coordinate of the field\n \"size\": 12, //required field. Size of the field\n \"line_height\": 16 //required field. LIne height of the field\n }\n ],\n \"hyperlinks\":\n [\n {\n \"page_number\":0, //required field. The page number of the document\n \"field_id\":\"b9584d8fbb64440dbfb9306543e20169b1b5ebe9\", //required field.Field request id. Сan be obtained using the request GET /document/{{documentUniqueId}}\n \"client_timestamp\":1566237855, //not required field. Local time of a user\n \"x\":234, //required field. X coordinate of the field\n \"y\":15, //required field. X coordinate of the field\n \"font\":\"Arial\", //required field.Font of the field\n \"line_height\":9, //required field. LIne height of the field\n \"size\":8 //required field. Size of the field\n }\n ],\n \"radiobuttons\":\n [ \n {\n \"page_number\":0, //required field. The page number of the document\n \"field_id\":\"4fc5ee7b83ba4b43906d33688555dc854f40d5f0\", //required field.Field request id. Сan be obtained using the request GET /document/{{documentUniqueId}}\n \"name\":\"RadiobuttonName\", //required field. Name of the field\n \"status\":1, //required field. Status of the field\n \"is_printed\":0,\n \"client_timestamp\":1566237855, //not required field. Local time of a user\n \"radio\": \n [ \n {\n \"value\": \"RadioButtonValue1\", //required field. Name of first radion button\n \"checked\": \"1\", //required field. For \"checked\" 0 or 1 \n \"created\": 1527859375, //not required field. Time of created radion button\n \"height\": 30, //required field. Height of the field\n \"width\": 30, //required field. Width of the field\n \"x\": 551, //required field. X coordinate of the field\n \"y\": 203, //required field. X coordinate of the field\n \"page_number\": 0, //required field. The page number of the document\n \"size\":12 //required field. Size of the field\n },\n {\n \"value\": \"RadioButtonValue2\", //required field. Name of second radion button\n \"checked\": \"0\", //required field. For \"checked\" 0 or 1 \n \"created\": 1527859375, //not required field. Time of created radion button\n \"height\": 30, //required field. Height of the field\n \"width\": 30, //required field. Width of the field\n \"x\": 551, //required field. X coordinate of the field\n \"y\": 241, //required field. X coordinate of the field\n \"page_number\": 0, //required field. The page number of the document\n \"size\":12 //required field. Size of the field\n }\n ],\n \"size\":12, //required field. Size of the field\n \"x\":234, //required field. X coordinate of the field\n \"y\":15, //required field. X coordinate of the field\n \"font\":\"Arial\", //required field.Font of the field\n \"line_height\":9 //required field. LIne height of the field\n }\n ],\n \"texts\":\n // input for a date field\n [ \n {\n \"page_number\": 0, //required field. The page number of the document\n \"field_id\": \"fa21fa32eb334d97afe00128030f4103e1f13f1a, //required field.Field request id. Сan be obtained using the request GET /document/{{documentUniqueId}}\n \"data\": \"08/16/2019\", //required field. Data of the field\n \"client_timestamp\": 1566237855, //not required field. Local time of a user\n \"x\": 477, //required field. X coordinate of the field\n \"y\": 53, //required field. X coordinate of the field\n \"font\": \"Arial\", //required field.Font of the field\n \"line_hght\": 12, //required field. LIne height of the field\n \"size\": 10 //required field. Size of the field\n },\n //input for a text field\n {\n \"page_number\": 0, //required field. The page number of the document\n \"field_id\": \"63907b37ffb5465e93572b1714f165d9cf89320d\", //required field.Field request id. Сan be obtained using the request GET /document/{{documentUniqueId}}\n \"data\": \"123\", //required field. Data of the field\n \"client_timestamp\": 1566237855, //not required field. Local time of a user\n \"x\": 477, //required field. X coordinate of the field\n \"y\": 53, //required field. X coordinate of the field\n \"font\": \"Arial\", //required field.Font of the field\n \"line_height\": 12, //required field. LIne height of the field\n \"size\": 10 //required field. Size of the field\n },\n //input for an enum field\n {\n \"page_number\": 0, //required field. The page number of the document\n \"field_id\": \"a463edef687546ada408194a998d24de5800c383\", //required field.Field request id. Сan be obtained using the request GET /document/{{documentUniqueId}}\n \"data\":\"12345\", //required field. Data of the field\n \"client_timestamp\": 1566237855, //not required field. Local time of a user\n \"x\": 298, //required field. X coordinate of the field\n \"y\": 278, //required field. X coordinate of the field\n \"font\": \"Arial\", //required field.Font of the field\n \"line_height\": 12, //required field. LIne height of the field\n \"size\": 10 //required field. Size of the field\n },\n //input for a calculated field\n {\n \"page_number\": 0, //required field. The page number of the document\n \"field_id\": \"4351b617b00a4d958aa2f9375f674f68940c24a6\", //required field.Field request id. Сan be obtained using the request GET /document/{{documentUniqueId}}\n \"data\":\"12468\", //required field. Data of the field\n \"client_timestamp\": 1566237855, //not required field. Local time of a user\n \"x\": 298, //required field. X coordinate of the field\n \"y\": 278, //required field. X coordinate of the field\n \"font\": \"Arial\", //required field.Font of the field\n \"line_height\": 12, //required field. LIne height of the field\n \"size\": 10 //required field. Size of the field\n }\n ]\n}" - $ref: '#/parameters/auth-bearer' description: 'Updates a document by adding/overwriting fields or elements (texts, checks, signatures, hyperlinks, attachments)' delete: responses: '200': description: '' schema: type: object properties: {} examples: application/json: status: success summary: Delete document description: Deletes a document from user's account tags: - Document parameters: - in: path name: document_id type: string required: true - $ref: '#/parameters/auth-bearer' parameters: - name: document_id in: path type: string required: true /oauth2/token: post: responses: '200': description: '' schema: type: object properties: expires_in: type: integer token_type: type: string access_token: type: string refresh_token: type: string scope: type: string last_login: type: integer examples: application/json: expires_in: 2592000 token_type: bearer access_token: 7cfe4b0fecbfaa0b4781c30262f0bf3f68b9b6ca5d11270fd83a091e968042d9 refresh_token: 59889bcbced82d5c2ba1bc7d0f634f30521e3d47b7f96221a2d8618a30175a16 scope: '*' last_login: 1 '400': description: |- * "invalid_client" - incorrect basic auth token * "invalid_request" - request without a required parameter * "invalid_scope" - invalid scope * "Invalid credentials." - either incorrect password or non-existing email provided examples: invalid_client: error: invalid_client invalid_request: error: invalid_request invalid_scope: error: invalid_scope invalid_credentials: error: Invalid credentials. code: 826 description: Returns an access token for a user tags: - OAuth2 produces: - application/json consumes: - multipart/form-data parameters: - $ref: '#/parameters/auth-basic' - in: formData name: username type: string required: true description: |- user's email;
required if `'grant_type: password'` - in: formData name: password type: string required: true description: |- user's password;
required if `'grant_type: password'` - in: formData name: grant_type type: string default: password required: true description: 'can be `''password''`, `''refresh_token''`, `''authorization_code''`' - in: formData name: scope type: string default: '*' - in: formData name: refresh_token type: string description: 'required if `''grant_type: refresh_token''`' default: '{{refresh_token}}' - in: formData name: code type: string default: '{{authorization_code}}' description: 'required if `''grant_type: authorization_code''`' - in: formData name: expiration_time type: string description: the amount of time till the token expires in seconds. summary: Generate access token get: responses: '200': description: 'Returns the access_token itself as well as its'' scope, expiration date, and type.' schema: type: object properties: access_token: type: string scope: type: string expires_in: type: string token_type: type: string examples: application/json: access_token: 8d83aed6d902c396e2a45d73eb0f5e41cfa11caa726e621247dc15c46d5fb112 scope: '*' expires_in: '2517898' token_type: bearer '400': description: '"invalid_token" - either incorrect or expired token provided' examples: invalid_token: error: invalid_token summary: Verify access token description: Verify an access token for a user tags: - OAuth2 produces: - application/json parameters: - $ref: '#/parameters/auth-bearer' /user: post: responses: '200': description: '' schema: type: object properties: id: type: string verified: type: integer email: type: string examples: application/json: id: aad13814e8f369089ee2f12b533545f9534e6cf8 verified: 0 email: user@signnow.com '400': description: |- * "unverified_email" - email has been registered on site before, but not verified * "internal api error" - request without a required field in body * "User with email exists" - email has been registered and verified on site before * "Invalid payload" - request without body examples: unverified email: errors: - code: 66396 message: unverified_email internal api error: errors: - code: 65544 message: internal api error email exists: errors: - code: 66330 message: User with email exists invalid payload: errors: - code: 65536 message: Invalid payload summary: Create user description: Creates an account for a user tags: - User consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/auth-basic' - in: body name: body schema: type: object properties: email: type: string password: type: string first_name: type: string last_name: type: string required: - email - password x-examples: {} get: responses: '200': description: '' schema: type: object properties: id: type: string first_name: type: string last_name: type: string active: type: string type: type: integer pro: type: integer created: type: string emails: type: array items: type: string primary_email: type: string subscriptions: type: array items: type: object properties: id: type: string subscription_id: type: string name: type: string expired: type: integer created: type: integer updated: type: integer plan: type: string mobile_plan_type: type: string credit_card: type: boolean trial: type: boolean term: type: integer credits: type: integer has_atticus_access: type: boolean cloud_export_account_details: type: object is_logged_in: type: boolean billing_period: type: object properties: start_date: type: string end_date: type: string start_timestamp: type: integer end_timestamp: type: integer premium_access: type: object properties: error: type: boolean user: type: object properties: username: type: string email: type: string first_name: type: string last_name: type: string added_date: type: integer status: type: string admin: type: string active: type: boolean subscription: type: object properties: serial_number: type: string name: type: string term: type: integer expired_at: type: integer created_at: type: integer updated_at: type: integer key: type: string plan: type: string business: type: boolean trial: type: boolean credit_card: type: boolean companies: type: array items: type: object properties: name: type: string full_access: type: boolean document_count: type: integer monthly_document_count: type: string teams: type: array items: type: object properties: id: type: string team: type: string type: type: string created_since: type: string role: type: string admins: type: array items: type: object properties: id: type: string is_secondary: type: string email: type: string billing: type: integer document_access: type: integer primary: type: boolean document_count: type: integer lifetime_document_count: type: integer googleapps: type: boolean facebookapps: type: boolean status: type: object properties: bad_copy_token: type: boolean has_copy_token: type: boolean has_cloud_export_token: type: boolean bad_cloud_export_token: type: boolean has_salesforce_token: type: boolean settings: type: object properties: no_document_attachment: type: boolean copy_export: type: boolean no_document_file_attachments: type: boolean no_user_signature_return: type: boolean mobileweb_option: type: boolean require_drawn_signatures: type: boolean org_allowed_team_admins: type: boolean cloud_auto_export: type: boolean digitally_sign_dowloaded_docs: type: boolean invite_completion_redirect_url: type: boolean invite_decline_redirect_url: type: boolean add_signature_stamp: type: boolean pending_invite_document_view_notification: type: boolean signing_link_document_download: type: boolean required_preset_signature_name: type: boolean cloud_export_with_history: type: boolean emailed_docs_include_history: type: boolean document_completion_retention_days: type: boolean enable_hyperlink_protection: type: boolean enable_advanced_threat_protection: type: boolean require_login_for_signing: type: boolean logout_on_signing: type: boolean audit_trail_completion_retention_days: type: boolean front_end_session_length: type: boolean email_admin_on_banned_login: type: boolean add_signature_stamp_with_name: type: boolean cfr_title_21_part_11: type: boolean unsuccessful_logout_attempts_allowed: type: boolean require_authentication_for_invites: type: boolean electronic_consent_required: type: boolean electronic_consent_text: type: boolean document_guide: type: boolean watermark_downloaded_document: type: boolean restrict_download: type: boolean disable_email_notifications: type: boolean upload_limit: type: boolean document_schema_extended: type: boolean invite_update_notifications_for_all_invites_at_invite_create: type: boolean enable_full_story_tracker: type: boolean document_attachment_only_for_signer: type: boolean sso-only-login: type: boolean block_export_options_when_credit_card_validation_is_used: type: boolean only_administrator_is_able_to_invite_to_the_team: type: boolean block_login_via_social_networks: type: boolean organization_settings: type: array items: type: object properties: setting: type: string value: type: string issue_notifications: type: array items: type: object merchant_accounts: type: array items: type: object organization: type: object properties: id: type: string name: type: string deleted: type: string created: type: string updated: type: string domains: type: array items: type: object logos: type: array items: type: object active_logo: type: array items: type: object is_admin: type: boolean is_superadmin: type: boolean teams: type: array items: type: object registration_source: type: string '400': description: Request with incorrect token examples: application/json: error: invalid_token code: 1537 summary: Get user info description: Returns a user resource tags: - User produces: - application/json parameters: - $ref: '#/parameters/auth-bearer' put: responses: '200': description: '' schema: type: object properties: id: type: string first_name: type: string last_name: type: string summary: Change user details description: 'Updates user informaition i.e. first name, last name' tags: - User consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/auth-bearer' - in: header name: Content-Type type: string default: application/json - in: body name: body schema: type: object properties: first_name: type: string last_name: type: string password: type: string old_password: type: string logout_all: type: string description: |- if "true" - all user tokens with "scope =*" expire if "false" - all user tokens except current one are expired Note: parameter must have string format. Default value - "true" x-examples: application/json: first_name: first_name last_name: last_name old_password: verystrongpassword password: evenstongerone logout_all: 'true' /user/verifyemail: post: responses: '200': description: '' schema: type: object properties: status: type: string examples: application/json: status: success '400': description: |- * "Could not send verification email" - request with not existing email address * "User email is already verified" - request with already verified email address examples: non-existing email: errors: - code: 65536 message: Could not send verification email verified email: errors: - code: 65536 message: User email is already verified summary: Send verification email tags: - User description: Sends verification email to a user consumes: - application/json produces: - application/json parameters: - in: body name: body schema: type: object properties: email: type: string format: email x-examples: application/json: email: user@signnow.com - $ref: '#/parameters/auth-basic' /user/email/verify: put: responses: '200': description: '' schema: type: object properties: email: type: string format: email examples: application/json: email: email@signnow.com '400': description: '' examples: invalid code: errors: - code: 65629 message: verification token does not match email address passed in or is invalid expired code: errors: - code: 65629 message: Verification token is expired summary: Verify email description: Verifies user's email address using code from verification email tags: - User consumes: - application/json produces: - application/json parameters: - in: header name: Content-Type type: string default: application/json - in: body name: body schema: type: object properties: email: type: string format: email verification_token: type: string required: - email - verification_token - in: header name: Authorization type: string default: 'Basic {{encoded_client_credentials}}' required: true description: '''Basic'' followed by base64 encoded client credentials.' /user/forgotpassword: post: responses: '200': description: '' schema: type: object properties: {} examples: application/json: status: success '400': description: 'Request with incorrect or mising email ' examples: application/json: errors: - code: 65544 message: Invalid email. summary: Reset password consumes: - application/json produces: - application/json parameters: - in: header name: Authorization type: string required: true description: Basic authorization token - in: body name: body schema: type: object properties: email: type: string format: email required: - email x-examples: application/json: email: email@domain.com description: Sends password reset link via email tags: - User /user/documentsv2: get: responses: '200': description: '' schema: type: array items: type: object properties: id: type: string user_id: type: string document_name: type: string page_count: type: string created: type: string updated: type: string original_filename: type: string origin_document_id: type: string owner: type: string template: type: boolean origin_user_id: type: string thumbnail: type: object properties: small: type: string medium: type: string large: type: string signatures: type: array items: type: object seals: type: array items: type: object texts: type: array items: type: object checks: type: array items: type: object inserts: type: array items: type: object tags: type: array items: type: object properties: type: type: string name: type: string fields: type: array items: type: object properties: id: type: string type: type: string role_id: type: string json_attributes: type: object properties: page_number: type: integer x: type: integer 'y': type: integer width: type: integer height: type: integer required: type: boolean name: type: string bold: type: boolean italic: type: boolean underline: type: boolean align: type: string valign: type: string arrangement: type: string size: type: integer max_chars: type: integer max_lines: type: integer font: type: string role: type: string originator: type: string fulfiller: type: string field_request_id: type: string element_id: type: string field_request_canceled: type: boolean template_field_id: type: string field_id: type: string requests: type: array items: type: object notary_invites: type: array items: type: object roles: type: array items: type: object properties: unique_id: type: string signing_order: type: string name: type: string field_invites: type: array items: type: object version_time: type: string enumeration_options: type: array items: type: object attachments: type: array items: type: object routing_details: type: array items: type: object properties: id: type: string data: type: array items: type: object properties: default_email: type: string inviter_role: type: boolean name: type: string role_id: type: string signing_order: type: integer created: type: string updated: type: integer cc: type: array items: type: object cc_step: type: array items: type: object invite_link_instructions: type: string integrations: type: array items: type: object hyperlinks: type: array items: type: object radiobuttons: type: array items: type: object document_group_template_info: type: array items: type: object originator_organization_settings: type: array items: type: object properties: setting: type: string value: type: string document_group_info: type: object properties: document_group_id: type: string document_group_name: type: string invite_id: type: string invite_status: type: string doc_count_in_group: type: integer settings: type: object properties: no_document_attachment: type: boolean copy_export: type: boolean no_document_file_attachments: type: boolean no_user_signature_return: type: boolean mobileweb_option: type: boolean require_drawn_signatures: type: boolean org_allowed_team_admins: type: boolean cloud_auto_export: type: boolean digitally_sign_dowloaded_docs: type: boolean invite_completion_redirect_url: type: boolean invite_decline_redirect_url: type: boolean add_signature_stamp: type: boolean pending_invite_document_view_notification: type: boolean signing_link_document_download: type: boolean required_preset_signature_name: type: boolean cloud_export_with_history: type: boolean emailed_docs_include_history: type: boolean require_email_subject: type: boolean document_completion_retention_days: type: boolean enable_hyperlink_protection: type: boolean enable_advanced_threat_protection: type: boolean require_login_for_signing: type: boolean logout_on_signing: type: boolean audit_trail_completion_retention_days: type: boolean front_end_session_length: type: boolean email_admin_on_banned_login: type: boolean add_signature_stamp_with_name: type: boolean cfr_title_21_part_11: type: boolean unsuccessful_logout_attempts_allowed: type: boolean require_authentication_for_invites: type: boolean electronic_consent_required: type: boolean electronic_consent_text: type: boolean document_guide: type: boolean watermark_downloaded_document: type: boolean restrict_download: type: boolean disable_email_notifications: type: boolean upload_limit: type: boolean document_schema_extended: type: boolean invite_update_notifications_for_all_invites_at_invite_create: type: boolean enable_full_story_tracker: type: boolean document_attachment_only_for_signer: type: boolean sso-only-login: type: boolean block_export_options_when_credit_card_validation_is_used: type: boolean only_administrator_is_able_to_invite_to_the_team: type: boolean block_login_via_social_networks: type: boolean '': type: string summary: Get modified documents description: 'Returns an array of user''s documents that were modified (added fields, texts, signatures, etc.)' tags: - User produces: - application/json parameters: - $ref: '#/parameters/auth-bearer' /document: post: responses: '200': description: '' schema: type: object properties: id: type: string examples: application/json: id: 9c95ef588b109c988595018543aec8885390a5c8 consumes: - multipart/form-data produces: - application/json description: 'Uploads a file to user''s account and returns unique id of the uploaded document. Accepts .doc, .docx, .pdf, .xls, .xlsx, .ppt, .pptx and .png file types.' parameters: - $ref: '#/parameters/auth-bearer' - in: formData name: file type: string required: true description: '@/path/to/your/file.pdf' tags: - Document summary: Upload document /document/fieldextract: post: responses: '200': description: '' schema: type: object properties: id: type: string examples: application/json: id: 3db38d8c1fdfca762b25d57d82b3cf327a65485e summary: Upload document with tags description: 'Uploads a file that contains [SignNow Text Tags](/docs/text-tags). Only .doc, .docx, and .pdf are supported' tags: - Document consumes: - multipart/form-data produces: - application/json parameters: - $ref: '#/parameters/auth-bearer' - in: formData name: file type: string description: Path to the file '/document/{document_id}/download': get: responses: '200': description: '' schema: type: object properties: {} headers: Content-Type: type: string default: application/pdf summary: Download document description: Downloads a document tags: - Document produces: - application/pdf parameters: - in: path name: document_id type: string required: true - in: query name: type type: string description: Possible values are "collapsed" or "zip". Collapsed returns the raw data of the pdf document that can be written to a blank .pdf file. Zip returns the raw data of a zip file containing the pdf and any attachments on that document that can be written to blank a .zip file. required: true - in: query name: with_history type: string description: downloads collapsed document with a table containing the document's history if with_history=1 - $ref: '#/parameters/auth-bearer' parameters: - name: document_id in: path type: string required: true '/document/{document_id}/move': post: responses: '200': description: '' schema: type: object properties: {} examples: application/json: result: success summary: Move document description: Moves a document into specified folder tags: - Document consumes: - application/json produces: - application/json parameters: - in: path name: document_id type: string required: true - in: body name: body schema: type: object properties: folder_id: type: string x-examples: application/json: folder_id: d3d5e79a4a4bcabd18bcd136547be6851d19ce12 - $ref: '#/parameters/auth-bearer' parameters: - name: document_id in: path type: string required: true '/document/{document_id}/invite': post: responses: '200': description: '' schema: type: object properties: {} examples: application/json: status: success summary: Send an invite to sign tags: - Document consumes: - application/json produces: - application/json description: |- Create and sends an invite to sign a document. There are 2 types of signature invite: * Free form invite - for document without fillable fields * Role-based invite - document has at least one field These 2 types of invite require different payloads parameters: - in: path name: document_id type: string required: true - in: body name: body schema: type: object properties: to: type: array items: type: object properties: email: type: string role_id: type: string role: type: string order: type: integer from: type: string cc: type: array items: type: object subject: type: string message: type: string x-examples: role-based invite: document_id: d9b490bd613e25cc5ec1a3b0b83dfccc164382bd to: - email: signer@signnow.com role_id: 488d73a3efab032511f144af3a2572a8aae20162 role: Signer 1 order: 1 reassign: '0' decline_by_signature: '0' reminder: 0 expiration_days: 30 authentication_type: password password: '123456' subject: personalized subject message: personalized message - email: signer2@signnow.com role_id: '' role: Signer 2 order: 2 reassign: '1' decline_by_signature: '1' reminder: 0 expiration_days: 30 from: sender@email.com cc: - cc_email@gmail.com - abnother_cc@gmail.com subject: generic subject message: generic message free form invite: from: sender@email.com to: signer@email.com - $ref: '#/parameters/auth-bearer' parameters: - name: document_id in: path type: string required: true '/document/{document_id}/fieldinvitecancel': put: responses: '200': description: '' schema: type: object properties: status: type: string examples: application/json: status: success summary: Cancel invite description: Cancels an invite to a document. tags: - Document consumes: - application/json produces: - application/json parameters: - in: path name: document_id type: string required: true - $ref: '#/parameters/auth-bearer' parameters: - name: document_id in: path type: string required: true '/document/{document_id}/download/link': post: responses: '200': description: '' schema: type: object properties: link: type: string format: uri examples: application/json: link: 'https://signnow.com/dispatch?route=onetimedownload&document_download_id=67de624701a70cdfe208b5c537f61fefa48b410a' summary: Get document download link description: Returns a one-time use URL for anyone to download the document as a PDF. tags: - Document consumes: - application/json produces: - application/json parameters: - in: path name: document_id type: string required: true - $ref: '#/parameters/auth-bearer' parameters: - name: document_id in: path type: string required: true '/document/{document_id}/custom_history_event': post: responses: '200': description: '' schema: type: object properties: status: type: string examples: application/json: status: success summary: Add custom event description: 'Allows third party developers to add custom events to the audit log. For example, if you are using a single SignNow account to make API calls but authenticating multiple people, use this call to add a record to the audit log for that specific document that references the authentication method.' tags: - Document consumes: - application/json produces: - application/json parameters: - in: path name: document_id type: string required: true - in: body name: body schema: type: object properties: client_timestamp: type: integer event_type: type: string x-examples: application/json: client_timestamp: 1460739202 event_type: test_event - $ref: '#/parameters/auth-bearer' parameters: - name: document_id in: path type: string required: true /document/merge: post: responses: '200': description: 'Downloads merged PDF. ' schema: type: object properties: {} headers: Content-Type: type: string default: application/pdf Content-Disposition: type: string default: attachment;filename="download.pdf" summary: Merge documents tags: - Document consumes: - application/json produces: - application/pdf description: Merges existing documents into one. parameters: - in: body name: body schema: type: object properties: name: type: string document_ids: type: array items: type: string x-examples: application/json: name: the merged doc document_ids: - 84a18d12bf7473ea3dd0e4dd1cdcded6ba6281aa - a71d963c49f33176e90c5827069c422616b1500c - $ref: '#/parameters/auth-bearer' '/document/{document_id}/historyfull': get: responses: '200': description: '' schema: type: object properties: {} examples: application/json: - email: user@signnow.com created: '1568298674' event: created_document ip_address: 35.153.16.185 client_app_name: SignNow Web Application application_id: 85 origin: original version: '0' client_timestamp: '1568298673' - unique_id: 13cb43cc7dd6512762e8e5993d20dfbb1d88ba78 created: '1568298675' client_timestamp: '1568298673' event: document_signing_session_completed client_app_name: SignNow Web Application ip_address: 35.153.16.185 user_id: 890d13607d89a7b3f6e67a14757d02ec00cf5eae email: user@signnow.com document_id: 20473f1616bed3de1461eea5ccb47d4068a0631b field_id: null element_id: null json_attributes: null - unique_id: 5543027441078487cad1c8aa934754d22c22cf48 created: '1568298762' client_timestamp: '1568298763' event: document_viewed client_app_name: SignNow Web Application ip_address: 217.20.164.1 user_id: 890d13607d89a7b3f6e67a14757d02ec00cf5eae email: user@signnow.com document_id: 20473f1616bed3de1461eea5ccb47d4068a0631b field_id: null element_id: null json_attributes: null summary: Get document history tags: - Document produces: - application/json parameters: - in: path name: document_id type: string required: true - $ref: '#/parameters/auth-bearer' description: Returns the history of a document. parameters: - name: document_id in: path type: string required: true /documentgroup: post: responses: '200': description: '' schema: type: object properties: {} examples: application/json: id: 68a31715f60b8a2e0df3ef1b4bc1a22cece3876c4a9a029dc845e4fa098517a0 summary: Create document group description: |+ Creates a document group from a list of document ids All documents: * Must be owned by the person creating the document group. * Cannot be templates. * Cannot already be a part of another document group (delete document group first to add them). * At least one of the documents must have fields. tags: - Document Group consumes: - application/json produces: - application/json parameters: - in: body name: body schema: type: object properties: document_ids: type: array items: type: string group_name: type: string x-examples: application/json: document_ids: - cddc2f79a3873af02ebc1d1ab0d45b2a1a3a2e7b - dd63da6fbe213863626a61d36b0c13ce61e4a2be group_name: Document Group 1 - $ref: '#/parameters/auth-bearer' '/documentgroup/{document_group_id}': get: responses: '200': description: '' schema: type: object properties: id: type: string group_name: type: string invite_id: type: string documents: type: array items: type: object properties: roles: type: array items: type: string document_name: type: string id: type: string thumbnail: type: object properties: small: type: string format: uri medium: type: string format: uri large: type: string format: uri examples: application/json: id: bc9bdf90883566a9eb2a01c43fede3755f71a4f2 group_name: new doc group invite_id: 474ea9deca354269bd9a66ef5e024f5fb0f145a4 documents: - roles: - Signer 1 document_name: pdf-test id: 19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad thumbnail: small: 'https://api.signnow.com/document/19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad/thumbnail?size=small' medium: 'https://api.signnow.com/document/19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad/thumbnail?size=medium' large: 'https://api.signnow.com/document/19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad/thumbnail?size=large' origin_document_id: 73af77a925534b171fed6ea333f5e785851d69f4 has_unassigned_field: false has_credit_card_number: false - roles: - Employer Representative document_name: marmat 1 id: 6f64ca38e2a0ef3cd775c13d34efc86abddbceba thumbnail: small: 'https://api.signnow.com/document/6f64ca38e2a0ef3cd775c13d34efc86abddbceba/thumbnail?size=small' medium: 'https://api.signnow.com/document/6f64ca38e2a0ef3cd775c13d34efc86abddbceba/thumbnail?size=medium' large: 'https://api.signnow.com/document/6f64ca38e2a0ef3cd775c13d34efc86abddbceba/thumbnail?size=large' origin_document_id: 7627fe37cde590dbe47907355ef05efa4d29df8d has_unassigned_field: false has_credit_card_number: false originator_organization_settings: [] summary: Get document group description: Returns document and roles information for documents in a document group. The invite_id property is null if there is no group invite for the group yet. tags: - Document Group consumes: - application/json produces: - application/json parameters: - in: path name: document_group_id type: string required: true - $ref: '#/parameters/auth-bearer' parameters: - name: document_group_id in: path type: string required: true delete: responses: '200': description: '' schema: type: object properties: {} examples: application/json: status: success summary: Delete document group description: Deletes a document group. Documents within the group are not deleted. Document groups cannot be deleted while they have a group invite tags: - Document Group consumes: - application/json produces: - application/json parameters: - in: path name: document_group_id type: string required: true - $ref: '#/parameters/auth-bearer' /user/documentgroups: get: responses: '200': description: '' schema: type: object properties: document_groups: type: array items: type: object properties: last_updated: type: string group_id: type: string group_name: type: string invite_id: type: string invite_status: type: string documents: type: array items: type: object properties: id: type: string name: type: string thumbnail: type: object properties: small: type: string medium: type: string large: type: string has_credit_card_number: type: boolean roles: type: array items: type: string document_group_total_count: type: integer originator_organization_settings: type: array items: type: object examples: application/json: document_groups: - last_updated: '1563886628' group_id: bc9bdf90883566a9eb2a01c43fede3755f71a4f2 group_name: new doc group invite_id: 474ea9deca354269bd9a66ef5e024f5fb0f145a4 invite_status: pending documents: - id: 19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad name: pdf-test thumbnail: small: 'https://api.signnow.com/document/19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad/thumbnail?size=small' medium: 'https://api.signnow.com/document/19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad/thumbnail?size=medium' large: 'https://api.signnow.com/document/19a61d94ffc0f5a17e41f3d2979ec52fcc6967ad/thumbnail?size=large' has_credit_card_number: false roles: - Signer 1 - id: 6f64ca38e2a0ef3cd775c13d34efc86abddbceba name: marmat 1 thumbnail: small: 'https://api.signnow.com/document/6f64ca38e2a0ef3cd775c13d34efc86abddbceba/thumbnail?size=small' medium: 'https://api.signnow.com/document/6f64ca38e2a0ef3cd775c13d34efc86abddbceba/thumbnail?size=medium' large: 'https://api.signnow.com/document/6f64ca38e2a0ef3cd775c13d34efc86abddbceba/thumbnail?size=large' has_credit_card_number: false roles: - Employer Representative - last_updated: '1549032635' group_id: 304a4bbe9d0ad86ec9793cb43fc5e24731748d0e group_name: doc_group invite_id: 3aacc04b1b5e494b9f2ebaaa10a24b5a791d9896 invite_status: pending documents: - id: f56f504c8d5a27ef0bc595bc20712be791009911 name: pdf-test thumbnail: small: 'https://api.signnow.com/document/f56f504c8d5a27ef0bc595bc20712be791009911/thumbnail?size=small' medium: 'https://api.signnow.com/document/f56f504c8d5a27ef0bc595bc20712be791009911/thumbnail?size=medium' large: 'https://api.signnow.com/document/f56f504c8d5a27ef0bc595bc20712be791009911/thumbnail?size=large' has_credit_card_number: false roles: - Signer 1 - id: 038588bdf8c65eb52cd7f17cc6c2748fbef38ef6 name: marmat 1 thumbnail: small: 'https://api.signnow.com/document/038588bdf8c65eb52cd7f17cc6c2748fbef38ef6/thumbnail?size=small' medium: 'https://api.signnow.com/document/038588bdf8c65eb52cd7f17cc6c2748fbef38ef6/thumbnail?size=medium' large: 'https://api.signnow.com/document/038588bdf8c65eb52cd7f17cc6c2748fbef38ef6/thumbnail?size=large' has_credit_card_number: false roles: - Employer Representative - last_updated: '1540294396' group_id: 60c56c4fde68ac503856dff0866f3649c19e49fe group_name: doc_group invite_id: 62feef84e08c4983aadaca721afa7319a3625584 invite_status: pending documents: - id: 1505d4d6a2ea51b52420a043109aea9f5d080025 name: wcc_07_2018 thumbnail: small: 'https://api.signnow.com/document/1505d4d6a2ea51b52420a043109aea9f5d080025/thumbnail?size=small' medium: 'https://api.signnow.com/document/1505d4d6a2ea51b52420a043109aea9f5d080025/thumbnail?size=medium' large: 'https://api.signnow.com/document/1505d4d6a2ea51b52420a043109aea9f5d080025/thumbnail?size=large' has_credit_card_number: false roles: - Signer 1 - signer 2 - id: c3c6a8eb7f8f632f20b115222035af256018a757 name: marmat 1 thumbnail: small: 'https://api.signnow.com/document/c3c6a8eb7f8f632f20b115222035af256018a757/thumbnail?size=small' medium: 'https://api.signnow.com/document/c3c6a8eb7f8f632f20b115222035af256018a757/thumbnail?size=medium' large: 'https://api.signnow.com/document/c3c6a8eb7f8f632f20b115222035af256018a757/thumbnail?size=large' has_credit_card_number: false roles: - Signer 1 - signer 2 document_group_total_count: 3 originator_organization_settings: - setting: invite_completion_redirect_url value: 'https://my_site.com' - setting: invite_decline_redirect_url value: '' - setting: required_preset_signature_name value: '0' - setting: require_email_subject value: '0' - setting: require_login_for_signing value: '0' - setting: logout_on_signing value: '0' - setting: front_end_session_length value: '0' - setting: add_signature_stamp_with_name value: '0' - setting: cfr_title_21_part_11 value: '0' - setting: require_authentication_for_invites value: '0' - setting: document_guide value: '1' - setting: disable_email_notifications value: '0' summary: Get document groups description: |- Returns back all document groups the user owns. The call is paginated by last_updated, so offset and limit query parameters are required: 1. Limit must be greater than 0 but less than or equal to 50. 2. Offset must be 0 or greater. produces: - application/json parameters: - in: query name: limit type: integer required: true - in: query name: offset type: integer required: true - $ref: '#/parameters/auth-bearer' tags: - Document Group '/documentgroup/{document_group_id}/groupinvite': post: responses: '200': description: '' schema: type: object properties: {} examples: application/json: id: 8755746dea8df75c6856d1fb8c346afe71f2329e summary: Invite to sign document group description: 'Creates a multi-step invite for a document group. Each invite step consists of invite_email objects that set the email message or can disable emails all together for specific user. Invite steps also are made of the invite_action objects that need to be completed before the step is considered complete. Once all the invite_actions are completed, the next step''s invite emails are sent out. When all steps have been completed, completion emails are sent out.' tags: - Document Group consumes: - application/json produces: - application/json parameters: - in: path name: document_group_id type: string required: true - in: body name: body schema: type: object properties: invite_steps: type: array items: type: object properties: order: type: integer invite_emails: type: array items: type: object properties: email: type: string format: email disabled: type: integer subject: type: string message: type: string invite_actions: type: array items: type: object properties: email: type: string format: email role_name: type: string action: type: string document_id: type: string allow_reassign: type: integer authentication: type: object properties: type: type: string value: type: string completion_emails: type: array items: type: object properties: email: type: string format: email disabled: type: integer subject: type: string message: type: string x-examples: application/json: invite_steps: - order: 1 invite_emails: - email: janedoe@signnow.com disabled: 0 subject: The subject step1 message: The message for step1 - email: test@signnow.com subject: subject step 1 message: message step 1 - email: ' bob@SignNow.com ' subject: '@signnow subject step 1' message: '@signnow message step 1' invite_actions: - email: ' janedoe@signnow.com ' role_name: role6 action: sign document_id: dd63da6fbe213863626a61d36b0c13ce61e4a2be allow_reassign: 0 authentication: type: password value: abc123 - email: ' test@signnow.com ' role_name: role2 action: sign document_id: cddc2f79a3873af02ebc1d1ab0d45b2a1a3a2e7b allow_reassign: 0 - order: 2 invite_emails: - email: ' janedoe@signnow.com ' disabled: 0 subject: The subject for step2 message: The message for step2 - email: ' test@signnow.com ' subject: subject step 2 message: ' message step 2' invite_actions: - email: ' janedoe@signnow.com ' role_name: role4 action: view document_id: dd63da6fbe213863626a61d36b0c13ce61e4a2be allow_reassign: 0 - email: ' test@signnow.com' role_name: role5 action: view document_id: dd63da6fbe213863626a61d36b0c13ce61e4a2be allow_reassign: 0 - order: 3 invite_emails: - email: ' janedoe@signnow.com' disabled: 0 subject: The subject for step3 message: The message for step3 - email: ' test@signnow.com' subject: subject step 3 message: message step 3 invite_actions: - email: ' janedoe@signnow.com ' role_name: role1 action: sign document_id: cddc2f79a3873af02ebc1d1ab0d45b2a1a3a2e7b allow_reassign: 0 - email: ' test@signnow.com ' role_name: role3 action: sign document_id: cddc2f79a3873af02ebc1d1ab0d45b2a1a3a2e7b allow_reassign: 0 completion_emails: - email: ' janedoe@signnow.com ' disabled: 0 subject: 'The subject COMPLETE ' message: The COMPLETE message - email: ' test@signnow.com ' subject: 'COMPLETE subject ' message: COMPLETE message - email: bob@signnow.com subject: 'COMPLETED subject ' message: ' message COMPLETED' disabled: 0 - $ref: '#/parameters/auth-bearer' parameters: - name: document_group_id in: path type: string required: true '/documentgroup/{document_group_id}/groupinvite/{invite_id}': get: responses: '200': description: '' schema: type: object properties: invite: type: object properties: id: type: string status: type: string steps: type: array items: type: object properties: id: type: string status: type: string order: type: integer actions: type: array items: type: object properties: action: type: string email: type: string document_id: type: string status: type: string role_name: type: string examples: application/json: invite: id: b1c07f1391f042333cf0ca96af5ac9f5b44ca54b status: pending steps: - id: abc07f1391f042333cf0ca96af5ac9f5b44ca54b status: pending order: 1 actions: - action: sign email: janedoe@signnow.com document_id: dd63da6fbe213863626a61d36b0c13ce61e4a2be status: pending role_name: role6 - action: sign email: test@test.com document_id: cddc2f79a3873af02ebc1d1ab0d45b2a1a3a2e7b status: pending role_name: role2 - id: def07f1391f042333cf0ca96af5ac9f5b44ca54b status: created order: 2 actions: - action: sign email: janedoe@signnow.com document_id: dd63da6fbe213863626a61d36b0c13ce61e4a2be status: created role_name: role4 - action: sign email: test@test.com document_id: dd63da6fbe213863626a61d36b0c13ce61e4a2be status: created role_name: role5 - id: c1207f1391f042333cf0ca96af5ac9f5b44ca54b status: created order: 3 actions: - action: sign email: janedoe@signnow.com document_id: cddc2f79a3873af02ebc1d1ab0d45b2a1a3a2e7b status: created role_name: role1 - action: sign email: test@test.com document_id: cddc2f79a3873af02ebc1d1ab0d45b2a1a3a2e7b status: created role_name: role3 summary: Get document group invite tags: - Document Group consumes: - application/json produces: - application/json description: |- Returns invite action information for a group invite, including the status of each step and action. Here is the list of possible invite action statuses: 1. 'created': invite or action has been created but is not waiting to be signed 2. 'pending': emails have been sent out for this invite action or step and are waiting to be viewed or signed 3. 'fulfilled': actions and steps that have been finished by singing or viewing parameters: - in: path name: document_group_id type: string required: true - in: path name: invite_id type: string required: true - $ref: '#/parameters/auth-bearer' parameters: - name: document_group_id in: path type: string required: true - name: invite_id in: path type: string required: true '/documentgroup/{document_group_id}/groupinvite/{invite_id}/cancelinvite': post: responses: '200': description: '' schema: type: object properties: {} examples: application/json: status: success summary: Cancel document group invite description: Cancels a group invite. All documents will be unshared with invitees. Any signatures that occurred before canceling will remain on the documents. tags: - Document Group consumes: - application/json produces: - application/json parameters: - in: path name: document_group_id type: string required: true - in: path name: invite_id type: string required: true - $ref: '#/parameters/auth-bearer' parameters: - name: document_group_id in: path type: string required: true - name: invite_id in: path type: string required: true '/documentgroup/{document_group_id}/groupinvite/{invite_id}/pendinginvites': get: responses: '200': description: '' schema: type: object properties: invites: type: array items: type: object properties: link: type: string document_name: type: string inviter_email: type: string action: type: string status: type: string document_group_name: type: string examples: application/json: invites: - link: 'https://eval.signnow.com/app/session/cddc2f79a3873af02ebc1d1ab0d45b2a1a3a2e7b?access_token=5ee3f8924ec5f413cf3d7ca5b949946e6e7f3410fcbcaa1a4be631487caac463&mobileweb=mobileweb_only' document_name: Receipt 1 inviter_email: janedoe@SignNow.com action: sign status: fulfilled - link: 'https://eval.signnow.com/app/session/dd63da6fbe213863626a61d36b0c13ce61e4a2be?access_token=9f8282785b859cd35358680d6c1b9c05524a8717e812c279e4e2105a77d93bc0&mobileweb=mobileweb_only' document_name: Contract 2 inviter_email: janedoe@SignNow.com action: sign status: pending document_group_name: Contracts summary: Get pending group invites description: 'Returns all pending invite information as well as invites already signed for a group invite for the user that makes the call. If the user making the call is the document owner, it will return pending invites for that user and ALL actions that have already been fulfilled.' tags: - Document Group consumes: - application/json produces: - application/json parameters: - in: path name: document_group_id type: string required: true - in: path name: invite_id type: string required: true - $ref: '#/parameters/auth-bearer' parameters: - name: document_group_id in: path type: string required: true - name: invite_id in: path type: string required: true '/documentgroup/{document_group_id}/groupinvite/{invite_id}/resendinvites': post: responses: '200': description: '' schema: type: object properties: {} examples: application/json: status: success summary: Resend document group invite tags: - Document Group produces: - application/json consumes: - application/json parameters: - in: path name: document_group_id type: string required: true - in: path name: invite_id type: string required: true - in: body name: body schema: type: object properties: email: type: string format: email description: |+ Email of the user you want to resend email to. If not present, emails will be resent to all pending users. x-examples: application/json: email: test@email.com - $ref: '#/parameters/auth-bearer' description: Resends invite emails to those with pending invites for the group invite. Resend can also be used to resend invites to a single user if the user's email is specified in the POST JSON body. parameters: - name: document_group_id in: path type: string required: true - name: invite_id in: path type: string required: true '/documentgroup/{document_group_id}/groupinvite/{invite_id}/invitestep/{step_id}/update': post: responses: '200': description: '' schema: type: object properties: {} examples: application/json: status: success summary: Update document group invite description: Either replaces invitees for a particular step or updates the invite attributes for a user at a particular step tags: - Document Group consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/auth-bearer' - in: body name: body schema: type: object properties: user_to_update: type: string invite_email: type: object properties: email: type: string reminder: type: integer expiration_days: type: integer update_invite_action_attributes: type: array items: type: object properties: document_id: type: string allow_reassign: type: integer decline_by_signature: type: string replace_with_this_user: type: string x-examples: application/json: user_to_update: initial.signer@gmail.com invite_email: email: updated.signer@gmail.com reminder: 0 expiration_days: 30 update_invite_action_attributes: - document_id: c45825eb5a245b2c9840cf04c9ea6c78b494edd4 allow_reassign: 0 decline_by_signature: '0' replace_with_this_user: updated.signer@gmail.com parameters: - name: document_group_id in: path type: string required: true - name: invite_id in: path type: string required: true - name: step_id in: path type: string required: true /template: post: responses: '200': description: '' schema: type: object properties: id: type: string examples: application/json: id: ce97706ea19b42c19aced4a6ac353153e86c09f1 summary: Create template description: Creates a template by flattening an existing document. tags: - Template consumes: - application/json produces: - application/json parameters: - in: body name: body schema: type: object properties: document_id: type: string document_name: type: string required: - document_id - document_name x-examples: application/json: document_name: test-document document_id: 5ec1fd9e68532e60aaa9169795150b72676c61db - $ref: '#/parameters/auth-bearer' '/template/{template_id}/copy': post: responses: '200': description: '' schema: type: object properties: id: type: string document_name: type: string examples: application/json: id: ce97706ea19b42c19aced4a6ac353153e86c09f1 document_name: new_doc summary: Get document out of template description: Creates a new document copy out of template. If a name is not supplied than it will default to the original template name. tags: - Template consumes: - application/json produces: - application/json parameters: - in: path name: template_id type: string required: true - in: body name: body schema: type: object properties: document_name: type: string - $ref: '#/parameters/auth-bearer' parameters: - name: template_id in: path type: string required: true /link: post: responses: '200': description: '' schema: type: object properties: url: type: string format: uri url_no_signup: type: string format: uri examples: application/json: url: 'http://signnow.com/s/1IFqEIt' url_no_signup: 'http://signnow.com/s/1IFqFvT' summary: Create signing link description: Creates a Signing Link for a specific document. tags: - Signing Link consumes: - application/json produces: - application/json parameters: - in: body name: body schema: type: object properties: document_id: type: string required: - document_id - $ref: '#/parameters/auth-bearer' /user/folder: post: responses: '200': description: '' schema: type: object properties: {} examples: application/json: id: 98186eaa80e98eadb17bc8e5a9257b6095757395 summary: Create folder description: Creates a folder for the user. tags: - Folder consumes: - application/json produces: - application/json parameters: - in: body name: body schema: type: object properties: name: type: string parent_id: type: string required: - name - parent_id x-examples: application/json: name: Folder Name parent_id: f02df1f8bd27f93e902748091047dd8d6b720760 - $ref: '#/parameters/auth-bearer' get: responses: '200': description: '' schema: type: object properties: id: type: string created: type: string name: type: string user_id: type: string parent_id: type: string system_folder: type: boolean shared: type: boolean folders: type: array items: type: object properties: id: type: string user_id: type: string name: type: string created: type: string shared: type: boolean document_count: type: string template_count: type: string folder_count: type: string sub_folders: type: array items: type: object total_documents: type: integer documents: type: array items: type: object examples: application/json: id: 3864f8a9674a72644288549a5f6923e20ba1f4aa created: '1532531633' name: Root user_id: 890d13607d89a7b3f6e67a14757d02ec00cf5eae parent_id: null system_folder: false shared: false folders: - id: 254681a17bd2f13e72af8de3a73170b6641f9d86 user_id: 890d13607d89a7b3f6e67a14757d02ec00cf5eae name: Templates created: '1532531633' shared: false document_count: '0' template_count: '11' folder_count: '0' sub_folders: [] - id: 3b826587963d46b98d5b0b28d154c8732d9c5cfc user_id: 890d13607d89a7b3f6e67a14757d02ec00cf5eae name: Team Templates created: '1557915422' shared: true document_count: '0' template_count: '3' folder_count: '0' sub_folders: [] team_name: Torchmark team_id: c3f5f21ecb1c423193824a946beb43dd408cde32 team_type: VIEWABLE - id: 54128ae8bdb79fb21a970c92e6d780b9b6a973ac user_id: 890d13607d89a7b3f6e67a14757d02ec00cf5eae name: Team Templates created: '1543922139' shared: true document_count: '0' template_count: '1' folder_count: '0' sub_folders: [] team_name: my team team_id: 960396a6d502e03743c7bd5da0e396bb61d582d2 team_type: VIEWABLE - id: 83dd89ffe463b1ac609b593ebf1edf1aa840127a user_id: 890d13607d89a7b3f6e67a14757d02ec00cf5eae name: Archive created: '1532531633' shared: false document_count: '21' template_count: 0 folder_count: '0' sub_folders: [] - id: 9e99b7a6c0b55a586474b67953a3a7cc0f7aed9d user_id: 890d13607d89a7b3f6e67a14757d02ec00cf5eae name: Trash Bin created: '1567466970' shared: false document_count: '0' template_count: 0 folder_count: '0' sub_folders: [] - id: c8fdb570bddbefab469a30a8cb4de4d96851cce3 user_id: 890d13607d89a7b3f6e67a14757d02ec00cf5eae name: Documents created: '1532531633' shared: false document_count: '74' template_count: 0 folder_count: '0' sub_folders: [] total_documents: 0 documents: [] summary: Get all folders description: Returns all folders of a user. tags: - Folder produces: - application/json parameters: - $ref: '#/parameters/auth-bearer' '/folder/{folder_id}': get: responses: '200': description: '' schema: type: object properties: {} examples: application/json: "{\n \"id\": \"1893180697eb9bc2965f5e1b5a502a0942718d04\",\n \"created\": \"1409253077\",\n \"name\": \"Documents\",\n \"user_id\": \"38b7eb73d859cd9f6a8695817635fa14d58d0fe3\",\n \"parent_id\": \"07813645c2052dd0f18ce23a798411fd16e64720\",\n \"system_folder\": true,\n \"shared\": false,\n \"folders\": [],\n \"total_documents\": 1,\n \"documents\": [\n {\n \"id\": \"85fecd9634b6d653f73ee96e7312947c5836834d\",\n \"user_id\": \"38b7eb73d859cd9f6a8695817635fa14d58d0fe3\",\n \"document_name\": \"forfun\",\n \"page_count\": \"1\",\n \"created\": \"1413307342\",\n \"updated\": \"1413485018\",\n \"original_filename\": \"forfun.pdf\",\n \"origin_document_id\": \"4a97327d3c8a45d0d257d24dc6f020ef9208d854\", \n \"owner\": \"sophiahelp@mailinator.com\",\n \"origin_user_id\": \"38b7eb73d859cd9f6a8695817635fa14d58d0fe3\",\n \"thumbnail\": \n {\n \"small\": \"http:\\/\\/api.vm.signnow.com\\/document\\/85fecd9634b6d653f73ee96e7312947c5836834d\\/thumbnail?size=small\",\n \"medium\": \"http:\\/\\/api.vm.signnow.com\\/document\\/85fecd9634b6d653f73ee96e7312947c5836834d\\/thumbnail?size=medium\",\n \"large\": \"http:\\/\\/api.vm.signnow.com\\/document\\/85fecd9634b6d653f73ee96e7312947c5836834d\\/thumbnail?size=large\"\n },\n \"template\": false,\n \"signatures\": [\n {\"id\": \"5cff77fd67f7620e5efa07a335f28f05480e91f5\",\n \"user_id\": \"ab33e0689cd3419f8f6e1200156d4c0105b0b961\",\n \"email\": \"cpelletier@barracuda.com\",\n \"page_number\": \"0\",\n \"width\": \"122\",\n \t \"height\": \"25\",\n \"x\": \"91\",\n \"y\": \"195\",\n \"created\": \"1413485018\"\n }\n ],\n \"seals\": [],\n \"texts\": [\n {\"id\": \"d2c2aaf73875e537db25ad30191dd6fdfa8766c4\",\n \"user_id\": \"ab33e0689cd3419f8f6e1200156d4c0105b0b961\",\n \"page_number\": \"0\",\n \"email\": \"cpelletier@barracuda.com\",\n \"font\": \"Arial\",\n \"size\": \"8\",\n \"data\": \"10\\/16\\/14\",\n \"x\": \"281\",\n \"y\": \"195\",\n \"line_height\": \"9.08\",\n \"created\": \"1413485018\"\n }\n ],<\n \"checks\": [],\n \"inserts\": [],\n \"tags\": [\n {\n \"type\": \"system\",\n \"name\": \"fields\"\n }\n ],\n \"fields\": [\n {\n \"id\": \"ecbd4d8594c3c279ab77dc3d630f0a7865e13ec5\",\n \"type\": \"text\",\n \"role_id\": \"1025e1f678944126d55fa8244adb40dbfbe4eae5\",\n \"json_attributes\": {\n \"page_number\": 0,\n \"x\": 281,\n \"y\": 195,\n \"width\": 102,\n \"height\": 21,\n \"required\": true,\n \"label\": \"Date\",\n \"prefilled_text\": \"\"\n },\n \"role\": \"Client\",\n \"originator\": \"sophiahelp@mailinator.com\",\n \"fulfiller\": \"cpelletier@barracuda.com\",\n \"field_request_id\": \"40df08b6b97e5448795d666d945bac6feb7cfe47\",\n \"element_id\": \"d2c2aaf73875e537db25ad30191dd6fdfa8766c4\",\n \"field_request_canceled\": null,\n \"template_field_id\": \"726f1cd9b3777ffe19e087e509eb1777588bb36b\",\n \"field_id\": \"40df08b6b97e5448795d666d945bac6feb7cfe47\"\n },\n {\n \"id\": \"43a434da73c0127beb49954869c94347a3af496e\",\n \"type\": \"signature\",\n \"role_id\": \"1025e1f678944126d55fa8244adb40dbfbe4eae5\",\n \"json_attributes\": {\n \"page_number\": 0,\n \"x\": 91,\n \"y\": 186,\n \"width\": 122,\n \"height\": 34,\n \"required\": true\n },\n \"role\": \"Client\",\n \"originator\": \"sophiahelp@mailinator.com\",\n \"fulfiller\": \"cpelletier@barracuda.com\",\n \"field_request_id\": \"4d766371aca992ec963dae1704a015cf5e8eb14f\",\n \"element_id\": \"5cff77fd67f7620e5efa07a335f28f05480e91f5\",\n \"field_request_canceled\": null,\n \"template_field_id\": \"e9536f562ec1edc27070ae097b2a40339a172645\",\n \"field_id\": \"4d766371aca992ec963dae1704a015cf5e8eb14f\"\n }\n ],\n \"requests\": [],\n \"notary_invites\": [],\n \"roles\": [\n {\"unique_id\": \"1025e1f678944126d55fa8244adb40dbfbe4eae5\",\n \"signing_order\": \"1\",\n \"name\": \"Client\"\n }\n ],\n \"field_invites\": [\n {\n \"id\": \"73f0a1f97afb21309f0248dbf460f24eea0bd36a\",\n \"status\": \"fulfilled\",\n \"updated\": \"1413485018\",\n \"email\": \"cpelletier@barracuda.com\",\n \"role\": \"Client\"\n }\n ],\n \"version_time\": \"1413485018\",\n \"enumeration_options\": [],\n \"attachments\": [],\n \"exported_to\": [\n {\"export_domain\": \"copy.com\",\n \"is_exported\": false,\n \"exported_user_ids\": []\n } \n ],\n \"parent_id\": \"1893180697eb9bc2965f5e1b5a502a0942718d04\"\n}\n]\n}" summary: Get folder by id tags: - Folder consumes: - application/json produces: - application/json parameters: - in: path name: folder_id type: string required: true - in: query name: filters type: string description: 'allowed values: signing-status, documents-created, documents-updated' - in: query name: filter-values type: string description: |- values depend on the filter type. see the endpoint description for more details - in: query name: sortby type: string description: created or updated - in: query name: order type: string description: desc or asc - in: query name: offset type: integer - in: query name: limit type: integer - $ref: '#/parameters/auth-bearer' description: |- Returns all details of a specific folder including an array of all documents in that folder. You can adjust the response produced by this endpoint using the following query parameters: **filters=signing-status&filter-values** - allows to show documents with specific status
allowed values: signed, pending, waiting-for-me, waiting-for-others **filters=documents-created&filter-values** - shows documents that were created started from specific date (note: this filter is not applicable for Templates)
allowed values: Unix timestamp **filters=documents-updated&filter-values** - shows documents that were updated started from specific date (note: this filter is not applicable for Templates)
allowed values: Unix timestamp **sortby=created&order** - sorts documents by creation date in descending or ascending order
allowed values: desc, asc **sortby=updated&order** - sorts documents by update date
allowed values: desc, asc **limit** - displays specified number of documents; Max limit is 100. It means that if value of "limit" parameter exceeds 100, response is automatically limited to 100 documents.
allowed values: integer **offset** - displays documents from specified position
allowed values: integer **subfolder-data** - defines whether sub-folders of the given folder are displayed in the response.
allowed values: 1, 0 (i.e. subfolder-data=1) **with_team_documents** - allows to display "Team Documents" folders.
allowed values: true, false (i.e. with_team_documents=true) **exclude_documents_relations** - allows to display short list of document info and increases maximum limit from 100 to 500 documents per page.
allowed values: true, false (i.e. exclude_documents_relations=false) The short list of document info is: ``` { "id": " ", "user_id": " ", "document_name": " ", "page_count": " ", "created": " ", "updated": " ", "original_filename": " " } ``` **include_documents_subfolders** - allows to hide sub-folders and display all documents from those sub-folders in the parent folder. Parameter works only for "Documents" and "Template" folder and their children. Default value - true
allowed values: true, false **exclude_documents_relations** - when this param is true, for documents in folder won’t include relations such as fields, signatures, etc, only the main info will be displayed.
allowed values: true, false parameters: - name: folder_id in: path type: string required: true '/user/folder/{folder_id}': delete: responses: '200': description: '' schema: type: object properties: {} examples: application/json: success: true summary: Delete folder description: Deletes a folder. tags: - Folder consumes: - application/json produces: - application/json parameters: - in: path name: folder_id type: string required: true - $ref: '#/parameters/auth-bearer' parameters: - name: folder_id in: path type: string required: true put: responses: '200': description: '' schema: type: object properties: id: type: string examples: application/json: id: 98186eaa80e98eadb17bc8e5a9257b6095757395 summary: Rename folder description: Renames a folder tags: - Folder consumes: - application/json produces: - application/json parameters: - in: path name: folder_id type: string required: true - $ref: '#/parameters/auth-bearer' - in: body name: body schema: type: object properties: name: type: string required: - name x-examples: application/json: name: new folder name /user/documents: get: responses: '200': description: '' schema: type: object summary: Get user documents description: Returns information of user's documents that were not modified yet. tags: - User produces: - application/json parameters: - $ref: '#/parameters/auth-bearer' '/document/{document_id}/integration/object/smartfields': post: responses: '200': description: '' schema: type: object properties: {} examples: application/json: status: success summary: Prefill smart fields description: |- Prefills smart fields. You can add Smart Fields to a template though web UI only.
**Note:** names of Smart Fields are case sensetive. tags: - Smart Fields consumes: - application/json produces: - application/json parameters: - in: path name: document_id type: string required: true - $ref: '#/parameters/auth-bearer' - in: body name: body schema: type: object required: - data - client_timestamp properties: data: type: array items: type: object properties: field_name1: type: string field_name2: type: string client_timestamp: type: string x-examples: application/json: data: - field_name1: value1 - field_name2: value2 client_timestamp: UTC time stamp parameters: - name: document_id in: path type: string required: true /api/v2/events: post: responses: '204': description: '' schema: type: object properties: {} '400': description: |- * "attributes must not be empty" - "attributes" array is missing or empty * "'callback' is missing." - required parameter "callback" is missing * "Action must be equal 'callback'" - required parameter "action" is missing OR value of "action" parameter differs from 'callback' * "event must not be empty" - required parameter "event" is missing or has an empty value * "event must be string" - value of the "event" parameter is not a string * "callback must be string" - value of the "callback" parameter is not a string * "callback must be url" - value of "callback" parameter is not an URL * "Invalid integration id - {integration_id}" - value of "integration_id" parameter doesn't exist in database examples: attributes: code: 400 message: attributes must not be empty callback: code: 400 message: attributes must not be empty action: message: Action must be equal 'callback' empty event: code: 65582 message: event must not be empty event: code: 65582 message: event must be string callback is not a string: code: 65582 message: callback must be string callback is not an url: code: 400 message: callback must be url integration: message: 'Invalid integration id - {integration_id}' '403': description: |- **Authorization = bearer** Request is sent with bearer token which doesn't belong user who is added to "entity_id" parameter OR Request is sent with bearer of user who is not an owner of document, added to "entity_id" parameter **Authorization = basic** Correct request which is sent by application which is not in scope of allowed ones examples: application/json: message: Subscription to event is not allowed summary: Create event subscription tags: - Webhooks 2.0 description: Allows to subscribe an external service(callback_url) to a specific event of user or document consumes: - application/json parameters: - $ref: './apidocs.oas2.yml#/parameters/auth-bearer' - in: body name: body schema: type: object properties: event: type: string entity_id: type: string action: type: string attributes: type: object properties: callback: type: string use_tls_12: type: boolean integration_id: type: string docid_queryparam: type: boolean headers: type: object properties: string_head: type: string int_head: type: integer bool_head: type: boolean float_head: type: number required: - callback required: - event - entity_id x-examples: application/json: "\t\n{\n\"event\":\"document.open\", //mandatory. Take event name from \"events\" database table\n\"entity_id\": \" \", //allowed values:\n\n//- User_unique_id - works only with events, the name of which starts from \"user.\" Ex: \"user.document.update\"\n\n//- Document_unique_id - works only with events, the name of which starts from \"document.\" Ex: \"document.open\"\n\"action\":\"callback\",\n\"attributes\": {\n\n\"callback\":\" \", //mandatory, //url of external callback url\n\"use_tls_12\" : true, //not mandatory, If true - 1.2 tls version will be used. If false - default tls version will be used.\n\"integration_id\":\"Unique ID Integration System\", //not mandatory, unique id of external system. It is stored in \"api_integrations\" database table\n\"docid_queryparam\": true, //if true - Json, which is sent callback will consist document id as query string parameter and as a part of \"callback_url\" parameter\n\n\"headers\":{ //not mandatory parameter. You can add any parameters to \"headers\" array\n\n\"string_head\":\"test\",\n\n\"int_head\":12,\n\n\"bool_head\":false,\n\n\"float_head\":12.24\n\n}\n\n}\n}" get: responses: '200': description: '' schema: type: object properties: data: type: array items: type: object properties: id: type: string event: type: string entity_id: type: integer action: type: string json_attributes: type: object properties: use_tls_12: type: boolean docid_queryparam: type: boolean integration_id: type: string callback_url: type: string headers: type: object properties: string_head: type: string int_head: type: integer bool_head: type: boolean float_head: type: number created: type: integer meta: type: object properties: pagination: type: object properties: total: type: integer count: type: integer per_page: type: integer current_page: type: integer total_pages: type: integer links: type: array items: type: object examples: application/json: data: - id: 391a4c4a267b48c2a8e90ff802d4ae40fa051af6 event: user.document.create entity_id: 18972165 action: callback json_attributes: use_tls_12: true docid_queryparam: true integration_id: b98fc00add6b43a606bc527c81eee741bf16a7d8 callback_url: 'http://callback-url.com' headers: string_head: test int_head: 12 bool_head: false float_head: 12.24 created: 1575381580 meta: pagination: total: 1 count: 1 per_page: 15 current_page: 1 total_pages: 1 links: [] summary: Get event suscriptions description: Gets information about all subscriptions to events made with a specific application tags: - Webhooks 2.0 produces: - application/json parameters: - $ref: '#/parameters/auth-basic' '/api/v2/events/{event_subscription_id}': delete: responses: '204': description: '' schema: type: object properties: {} '403': description: |- **For basic auth:** Application id which is used for request differs from application id created given event subscription. **For bearer auth:** The event subscription was created by another user examples: application/json: message: Unsubscription from event is not allowed '404': description: Value of "uniqueEventId" doesn't exist in database examples: application/json: message: UserEventSubscription `uniqueEventId` not found summary: Delete event subscription description: Unsubscribes an external service (callback_url) from specific events of user or document tags: - Webhooks 2.0 parameters: - in: path name: event_subscription_id type: string required: true - $ref: '#/parameters/auth-basic' parameters: - name: event_subscription_id in: path type: string required: true put: responses: '201': description: '' schema: type: object properties: id: type: string examples: application/json: |- { "id": "" //event subscription unique ID } '400': description: |- * "attributes must not be empty" - "attributes" array is missing or empty * "'callback' is missing." - required parameter "callback" is missing * "Action must be equal 'callback'" - required parameter "action" is missing OR value of "action" parameter differs from 'callback' * "event must not be empty" - required parameter "event" is missing or has an empty value * "event must be string" - value of the "event" parameter is not a string * "callback must be string" - value of the "callback" parameter is not a string * "callback must be url" - value of "callback" parameter is not an URL * "Invalid integration id - {integration_id}" - value of "integration_id" parameter doesn't exist in database examples: attributes: code: 400 message: attributes must not be empty callback: code: 400 message: attributes must not be empty action: message: Action must be equal 'callback' empty event: code: 65582 message: event must not be empty event: |- { "code": 65582, "message": "event must be string" } callback is not a string: code: 65582 message: callback must be string callback is not an url: code: 400 message: callback must be url integration: message: 'Invalid integration id - {integration_id}' summary: Update event subscription description: Allows changing an existing event subscription tags: - Webhooks 2.0 consumes: - application/json produces: - application/json parameters: - in: body name: body schema: type: object properties: event: type: string entity_id: type: string action: type: string attributes: type: object properties: callback: type: string use_tls_12: type: boolean integration_id: type: string docid_queryparam: type: boolean headers: type: object properties: string_head: type: string int_head: type: integer bool_head: type: boolean float_head: type: number x-examples: application/json: event: document.fieldinvite.sent entity_id: 63fde884ad755149ff213563de654f9a61a1884c action: callback attributes: callback: 'https://enlvww20vv7m.x.pipedream.net/' use_tls_12: true integration_id: b98fc00add6b43a606bc527c81eee741bf16a7d8 docid_queryparam: true headers: string_head: test int_head: 12 bool_head: false float_head: 12.24 - in: header name: Authorization type: string description: This endpoint accepts either 'Bearer' or 'Basic' token securityDefinitions: {} schemes: - https consumes: - application/json - multipart/form-data - application/x-www-form-urlencoded produces: - application/json tags: - name: User - name: OAuth2 - name: Document - name: Template - name: Document Group - name: Signing Link - name: Webhooks 2.0 - name: Folder - name: Smart Fields definitions: {} parameters: auth-bearer: in: header type: string name: Authorization default: 'Bearer {{access_token}}' description: Bearer followed by access_token required: true content-json: name: Content-Type in: header type: string default: application/json auth-basic: name: Authorization in: header type: string default: 'Basic {{basic_authorization_token}}' description: The word "Basic" followed by Basic Authorization Token required: true