![\"Adobe](\"https://financesonline.com/uploads/2017/11/Adobe-Sign-Logo-1.jpg\"){kind=logo}
The official docs for Adobe Sign REST V6 can be found Here
\nFor some reason the POSTMAN auto-doc does not show the \"Authorization\" header param but this needs to be used for all calls. The \"token\" can be an oAuth \"access token\" OR during dev, QA, and testing you can use an \"integration key\"
\nThis looks like.
\nAuthorization: Bearer oirfoprmfir*********yourAccess_token_or_integration-key_here*******oiwpqoeimopqwir\nIn some JSON body examples I will include comments by adding an unused key-value pair. These comments will look like this:
\n\"//1\":\"this is a comment about something below.\",\nIf you see any key that starts with \"//...\" you can ignore it in your code as these are just comments I've added to explain what each parameter is.
\nAnywhere you see an item with double \"curly braces\" \"{{something}}\", this is a postman variable which will typically contain data that is specific to your own Adobe Sign account or environment.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14752","collectionId":"dfc37e12-afb6-47d1-8e26-1c5efa32837f","publishedId":"TzkyLzWB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-06-30T01:20:43.000Z"},"item":[{"name":"oAuth tokens and BaseUri","item":[{"name":"getBaseUris","event":[{"listen":"test","script":{"exec":["var getBaseResponse = JSON.parse(responseBody);","","pm.environment.set(\"baseUri\", getBaseResponse.apiAccessPoint);","","","","pm.test(\"gotUris\", function () {"," pm.expect(pm.response.text()).to.include(\"apiAccessPoint\");","});"],"type":"text/javascript","id":"f9d36aca-5edd-4cef-b15f-ae48bddade22"}}],"id":"241c07bb-36f7-4dc9-8a45-42767362021a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.adobesign.com/api/rest/v6/baseUris","auth":{"type":"bearer","bearer":{"token":"Uses oAuth \"code\" from oAuth request process to get Access token.
\nTo learn about setting up oAuth for a partner app see the notes starting here: https://www.evernote.com/l/AgVqJ3PjUXpGcLC_Ht4RfPO6079UxKtxvdQ
\n","urlObject":{"protocol":"https","path":["oauth","token"],"host":["secure","adobesign","com"],"query":[],"variable":[]}},"response":[{"id":"9bd63a4f-49e2-4284-8982-ea42aba93665","name":"test1","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"code","value":"{{oAuthCode1}}","type":"text"},{"key":"client_id","value":"skgj;alskgj;alskfgja;lsfkj***junk data**g;lfkjhgq[eoijt [ejvrfva'lfv'aldkfmva'elkf","type":"text"},{"key":"client_secret","value":"nA0Uz-skgj;alskgj;alskfgja;lsfkj***junk data**g;lfkjhgq[eoijt [ejvrfva'lfv'aldkfmva'elkf","type":"text"},{"key":"redirect_uri","value":"https://yourtestserver/oAuth/myRedirectpage.html","type":"text"},{"key":"grant_type","value":"authorization_code","type":"text"}]},"url":"https://secure.adobesign.com/oauth/token","description":"Uses oAuth \"code\" from oAuth request process to get Access token.\n\nTo learn about setting up oAuth for a partner app see the notes starting here: https://www.evernote.com/l/AgVqJ3PjUXpGcLC_Ht4RfPO6079UxKtxvdQ"},"status":"OK","code":200,"_postman_previewlanguage":"javascript","header":[{"key":"Connection","value":"Keep-Alive","name":"Connection","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 03 Jun 2016 21:33:47 GMT","name":"Date","description":""},{"key":"Keep-Alive","value":"timeout=15, max=200","name":"Keep-Alive","description":""},{"key":"P3P","value":"CP=\"IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT\"","name":"P3P","description":""},{"key":"Server","value":"Apache","name":"Server","description":""},{"key":"Strict-Transport-Security","value":"max-age=31536000;","name":"Strict-Transport-Security","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Robots-Tag","value":"none","name":"X-Robots-Tag","description":""}],"cookie":[{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".echosign.com","path":"/","secure":false,"session":false,"value":"\"6efae3a4-e925-8355-2d96-0c267631e2d5\"","key":"wm-ueug"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".echosign.com","path":"/","secure":false,"session":false,"value":"1","key":"wm-fgug"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":true,"domain":".echosign.com","path":"/","secure":true,"session":true,"value":"4fba4596-c9bf-4645-ba36-b924b5a44a29","key":"ECHOSIGN_ID"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".echosign.com","path":"/","secure":false,"session":false,"value":"1","key":"wm-ueuT"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"secure.na1.echosign.com","path":"/","secure":true,"session":true,"value":"E0357FD1D385166F2B84CDA1BA627123.ord-prod-app3","key":"JSESSIONID"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":true,"domain":".echosign.com","path":"/","secure":true,"session":true,"value":"F0D3DB595A39889B3936DAB174F3A8C6.ord-prod-app3","key":"JSESSIONID"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":true,"domain":".na1.echosign.com","path":"/","secure":true,"session":true,"value":"F0D3DB595A39889B3936DAB174F3A8C6.ord-prod-app3","key":"JSESSIONID"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":true,"domain":".echosign.com","path":"/","secure":true,"session":true,"value":"wSk08zq8fXCJNS5nAkTZCAofJqPYDekvNmhWu3S1cr4*","key":"WEB_CLIENT_TOKEN_COOKIE"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":true,"domain":".na1.echosign.com","path":"/","secure":true,"session":true,"value":"wSk08zq8fXCJNS5nAkTZCAofJqPYDekvNmhWu3S1cr4*","key":"WEB_CLIENT_TOKEN_COOKIE"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".echosign.com","path":"/","secure":false,"session":false,"value":"PC#1463157478981-591606.28_29#1468011665|session#1464984180531-707457#1464989525","key":"mbox"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".echosign.com","path":"/","secure":false,"session":false,"value":"{\"st\":1464987665703%2C\"sc\":6%2C\"v\":0%2C\"et\":1464806291278%2C\"u\":0}","key":"wm-ag-d"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".echosign.com","path":"/","secure":false,"session":true,"value":"%20s_cpc%3D0%3B%20s_cc%3Dtrue%3B%20s_sq%3Dadbadobenonacdcprod%253D%252526pid%25253Dsmuszconsulting.na1.echosign.com%2525253AA-WEB%2525253AECHO-Glob%2525253AacAd%2525253AECHO%2525253AaccountSettingsPage3%2525253AAPI_APPLICATIONS%252526pidt%25253D1%252526oid%25253DCancel%252526oidt%25253D3%252526ot%25253DSUBMIT%3B","key":"s_sess"},{"expires":"Invalid Date","hostOnly":false,"httpOnly":false,"domain":".echosign.com","path":"/","secure":false,"session":false,"value":"%20s_fid%3D11FC411B75AD15BC-1FF240D8FF7DEEFC%7C1528060977791%3B%20s_vs%3D1%7C1464990777793%3B%20s_nr%3D1464988977796-Repeat%7C1496524977796%3B","key":"s_pers"}],"responseTime":null,"body":"{\"access_token\":\"skgj;alskgj;alskfgja;lsfkj***junk data**g;lfkjhgq[eoijt [ejvrfva'lfv'aldkfmva'elkf\",\"refresh_token\":\"skgj;alskgj;alskfgja;lsfkj***junk data**g;lfkjhgq[eoijt [ejvrfva'lfv'aldkfmva'elkf\",\"token_type\":\"Bearer\",\"expires_in\":3600}"}],"_postman_id":"87f6498d-ba61-40e1-9fa4-5903d61befbd"},{"name":"refresh -> Access 2020app","event":[{"listen":"test","script":{"id":"1581056e-3303-4ea4-b8ac-b82d29fc6239","exec":["","","pm.test(\"Got Access Token\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.access_token);"," pm.environment.set(\"aToken\", jsonData.access_token);","});","",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"35a954d2-1e14-46e1-9cff-abe6b0ae04e4","exec":["","pm.environment.set(\"env_refresh_token\", \"skgj;alskgj;alskfgja;lsfkj***junk data**g;lfkjhgq[eoijt [ejvrfva'lfv'aldkfmva'elkf\");"],"type":"text/javascript"}}],"id":"718bab84-a2c4-463a-b7c4-363224739186","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"refresh_token","value":"skgj;alskgj;alskfgja;lsfkj***junk data**g;lfkjhgq[eoijt [ejvrfva'lfv'aldkfmva'elkf*","type":"text"},{"key":"client_id","value":"","type":"text"},{"key":"grant_type","value":"refresh_token","type":"text"},{"key":"client_secret","value":"skgj;alskgj;alskfgja;lsfkj***junk data**g;lfkjhgq[eoijt [ejvrfva'lfv'aldkfmva'elkf","type":"text"}]},"url":"https://api.na2.adobesign.com/oauth/refresh","description":"These are calls to help get the oAuth related \"tokens\" like the refresh and access tokens as well as the call to get the \"BaseUri\" which is critical to determine the \"shard\" info necessary for all other account related calls.
\nAll the example requests on this site use \"na2\" as they were generated using an account on that shard, but the \"shard\" for a specific customer's account will vary. Thus it's important to have this data for all calls realted to a specific account.
\nAccounts will typically NOT be moved from one shard to another without a significant amount of admin/support overhead so getting the \"baseUri\" is not something that typically needs to be done often in your integration process.
\nAdobe Sign lives in many geo \"shards\" around the globe. A customer's account may be on NA1, NA2, NA3, EU1, JP1, AU1, IN1, etc.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"bf2f7ca5-8361-49b4-8135-c8a1b9aec624"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"76fb2c2f-bbc7-492f-ac17-a89af6ac0431"}}],"_postman_id":"1897dfed-96cc-4fcf-891e-72bd04e7151c","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for a single signer and immediately sets to \"PREFILL\".
\nNo \"merge data\".
\nAll emails suppressed.
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for a single signer and immediately sets to \"PREFILL\".
\nNo \"merge data\".
\nAll emails suppressed.
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for a single signer and immediately sets to \"PREFILL\".
\nNo \"merge data\".
\nAll emails suppressed.
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for a single signer and immediately sets to \"PREFILL\".
\nNo \"merge data\".
\nAll emails suppressed.
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for a single signer and immediately sets to \"IN_PROCESS\".
\nNo \"merge data\" and if using email will \"send\" the Please Sign/initialization email right away to the signer.
\nThis one adds a \"CC\" so that a copy of the signed/completed agreement goes to the additional email address.
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for a single signer and immediately sets to \"IN_PROCESS\".
\nNo \"merge data\" and if using email will \"send\" the Please Sign/initialization email right away to the signer.
\nThis one adds a \"CC\" so that a copy of the signed/completed agreement goes to the additional email address.
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for a single signer and immediately sets to \"PREFILL\".
\nNo \"merge data\".
\nAll emails suppressed.
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for a single signer and immediately sets to \"IN_PROCESS\".
\nIt includes a section in the JSON for \"mergeFieldInfo\" with name value pairs to include the data from some other system to pre-populate the fields.
\n \"mergeFieldInfo\": [\n {\n \"defaultValue\": \"Sam's Garage\",\n \"fieldName\": \"AccountName\"\n },\n {\n \"defaultValue\": \"1775247664\",\n \"fieldName\": \"AccountNumber\"\n },\n {\n \"defaultValue\": \"123 South Main\",\n \"fieldName\": \"Street\"\n },\n {\n \"defaultValue\": \"Sammyville\",\n \"fieldName\": \"City\"\n },\nThis creates a new agreement for a single signer and immediately sets to \"IN_PROCESS\".
\nIt includes a section in the JSON for \"mergeFieldInfo\" with name value pairs to include the data from some other system to pre-populate the fields.
\n \"mergeFieldInfo\": [\n {\n \"defaultValue\": \"Sam's Garage\",\n \"fieldName\": \"AccountName\"\n },\n {\n \"defaultValue\": \"1775247664\",\n \"fieldName\": \"AccountNumber\"\n },\n {\n \"defaultValue\": \"123 South Main\",\n \"fieldName\": \"Street\"\n },\n {\n \"defaultValue\": \"Sammyville\",\n \"fieldName\": \"City\"\n },\nThis creates a new agreement for a single signer and immediately sets to \"IN_PROCESS\".
\nIt includes a section in the JSON for \"mergeFieldInfo\" with name value pairs to include the data from some other system to pre-populate the fields.
\n \"mergeFieldInfo\": [\n {\n \"defaultValue\": \"Sam's Garage\",\n \"fieldName\": \"AccountName\"\n },\n {\n \"defaultValue\": \"1775247664\",\n \"fieldName\": \"AccountNumber\"\n },\n {\n \"defaultValue\": \"123 South Main\",\n \"fieldName\": \"Street\"\n },\n {\n \"defaultValue\": \"Sammyville\",\n \"fieldName\": \"City\"\n },\nThis creates a new agreement for a single signer and immediately sets to \"IN_PROCESS\".
\nIt suppresses all email from Adobe Sign except for reminders via the section:
\n \"emailOption\": {\n \"sendOptions\": {\n \"completionEmails\": \"NONE\",\n \"inFlightEmails\": \"NONE\",\n \"initEmails\": \"NONE\"\n }\n },\nIt includes a section in the JSON for \"mergeFieldInfo\" with name value pairs to include the data from some other system to pre-populate the fields.
\n \"mergeFieldInfo\": [\n {\n \"defaultValue\": \"Sam's Garage\",\n \"fieldName\": \"AccountName\"\n },\n {\n \"defaultValue\": \"1775247664\",\n \"fieldName\": \"AccountNumber\"\n },\n {\n \"defaultValue\": \"123 South Main\",\n \"fieldName\": \"Street\"\n },\n {\n \"defaultValue\": \"Sammyville\",\n \"fieldName\": \"City\"\n },\nThis creates a new agreement for a single french speaking signer signer via the \"locale\" option:
\n\"locale\": \"fr_FR\",\nImmediately sends email by setting \"state\" to \"IN_PROCESS\".
\nNo \"merge data\" and if using email will \"send\" the Please Sign/initialization email right away to the signer.
\n","auth":{"type":"bearer","bearer":{"token":"Additional \"emailOptions\" section to suppress some email/s by \"class\"
\nEach can be set to \"ALL\" or \"NONE\".
\nNo \"merge data\".
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for a single signer and immediately sets to \"IN_PROCESS\".
\nNo \"merge data\" and if using email will \"send\" the Please Sign/initialization email right away to the signer.
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for a single signer using \"phone based\" authentication and immediately \"sends\" (sets to \"IN_PROCESS\").
\nPossible authentication methods are: 'NONE' or 'PASSWORD' or 'PHONE' or 'KBA' or 'WEB_IDENTITY' or 'ADOBE_SIGN'.
\nKBA, WEB_IDENTITY, and ADOBE_SIGN require no other params except \"authenticationMethod\".
\nNo \"merge data\" and if using email will \"send\" the Please Sign/initialization email right away to the signer.
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for a single signer and immediately sets to \"IN_PROCESS\".
\nNo \"merge data\" and if using email will \"send\" the Please Sign/initialization email right away to the signer.
\n","urlObject":{"protocol":"https","path":["api","rest","v6","agreements"],"host":["api","{{env_shard}}","adobesign","com"],"query":[],"variable":[]}},"response":[{"id":"06c033a2-ef34-4e4b-8105-2dba7591c79f","name":"Create and Send - basic 1 signer","originalRequest":{"method":"POST","header":[{"key":"x-api-user","value":"email:someemail@domain.com"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fileInfos\": [\n {\n \"libraryDocumentId\": \"{{ldt_msaNoLine}}\"\n }\n ],\n \"name\": \"API Send Library Test Agreement 129\",\n \"participantSetsInfo\": [\n {\n \"memberInfos\": [\n {\n \"email\": \"{{rcp1}}\"\n }\n ],\n \"order\": 1,\n \"role\": \"SIGNER\"\n }\n ],\n \"signatureType\": \"ESIGN\",\n \"externalId\": {\n \"id\": \"NA2Account_1775247664\"\n },\n \"state\": \"IN_PROCESS\"\n}"},"url":"https://api.{{env_shard}}.adobesign.com/api/rest/v6/agreements"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"53","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 09 Jul 2018 21:04:10 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"A0bba41be5ed303811da8add6681e70db08730418","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=15, max=200","name":"Keep-Alive","description":"Custom header"},{"key":"P3P","value":"CP=\"IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT\"","name":"P3P","description":"This header is supposed to set P3P policy, in the form of P3P:CP=\"your_compact_policy\". However, P3P did not take off, most browsers have never fully implemented it, a lot of websites set this header with fake policy text, that was enough to fool browsers the existence of P3P policy and grant permissions for third party cookies."},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=31536000;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Robots-Tag","value":"none","name":"X-Robots-Tag","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"},{"key":"x-request-id","value":"299673e3-3f49-4f52-933d-da669dc3e3bd","name":"x-request-id","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"id\":\"CBJCHBCAABAAMCWmyx5VXu0DSBE7G2I7fZtjilwnmibF\"}"}],"_postman_id":"cb1e850f-905a-41f7-ac60-a74dbf918895"},{"name":"Create and Send - basic 1 signer with KBA Spanish","event":[{"listen":"test","script":{"exec":["pm.test(\"success - got ID\", function () {"," pm.expect(pm.response.text()).to.include('\"id\":');","});","","","var jsonData = pm.response.json();","pm.environment.set(\"na2LastSentAgId\", jsonData.id);","","",""],"type":"text/javascript","id":"f7cefb29-43cb-4708-854d-91fc8c1ab41b"}}],"id":"c3da13f1-442e-4cf4-ad42-a75e36ca8236","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for a single signer and immediately sets to \"IN_PROCESS\".
\nNo \"merge data\" and if using email will \"send\" the Please Sign/initialization email right away to the signer.
\n","urlObject":{"protocol":"https","path":["api","rest","v6","agreements"],"host":["api","{{env_shard}}","adobesign","com"],"query":[],"variable":[]}},"response":[{"id":"02ec5db8-5679-4a2c-a6c4-ca0efd07aa59","name":"Create and Send - basic 1 signer","originalRequest":{"method":"POST","header":[{"key":"x-api-user","value":"email:someemail@domain.com"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fileInfos\": [\n {\n \"libraryDocumentId\": \"{{ldt_msaNoLine}}\"\n }\n ],\n \"name\": \"API Send Library Test Agreement 583\",\n \"participantSetsInfo\": [\n {\n \"memberInfos\": [\n {\n \"email\": \"{{rcp1}}\"\n }\n ],\n \"order\": 1,\n \"role\": \"SIGNER\"\n }\n ],\n \"signatureType\": \"ESIGN\",\n \"externalId\": {\n \"id\": \"NA2Account_1775247664\"\n },\n \"state\": \"IN_PROCESS\"\n}"},"url":"https://api.{{env_shard}}.adobesign.com/api/rest/v6/agreements"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"53","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 09 Jul 2018 21:04:10 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"A0bba41be5ed303811da8add6681e70db08730418","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=15, max=200","name":"Keep-Alive","description":"Custom header"},{"key":"P3P","value":"CP=\"IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT\"","name":"P3P","description":"This header is supposed to set P3P policy, in the form of P3P:CP=\"your_compact_policy\". However, P3P did not take off, most browsers have never fully implemented it, a lot of websites set this header with fake policy text, that was enough to fool browsers the existence of P3P policy and grant permissions for third party cookies."},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=31536000;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Robots-Tag","value":"none","name":"X-Robots-Tag","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"},{"key":"x-request-id","value":"299673e3-3f49-4f52-933d-da669dc3e3bd","name":"x-request-id","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"id\":\"CBJCHBCAABAAMCWmyx5VXu0DSBE7G2I7fZtjilwnmibF\"}"}],"_postman_id":"c3da13f1-442e-4cf4-ad42-a75e36ca8236"},{"name":"IN_PROCESS- basic 3 signers - private messages","event":[{"listen":"test","script":{"id":"ba9b9d91-cda8-4e1d-be9e-01f721654c7a","exec":["pm.test(\"success - got ID\", function () {"," pm.expect(pm.response.text()).to.include('\"id\":');","});","","","var jsonData = pm.response.json();","pm.environment.set(\"na2LastSentAgId\", jsonData.id);","",""],"type":"text/javascript"}}],"id":"bfd3afdf-d84b-4cc5-bc01-ddf841fa3655","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-user","value":"email:someemail@domain.com"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fileInfos\": [\n {\n \"libraryDocumentId\": \"CBJCHBCAABAATIs14j5e0p0mA4MlWQKJy91NpqK-2hA1\"\n }\n ],\n \"name\": \"API Send Library Test Agreement w 3 signers 318\",\n \"participantSetsInfo\": [\n {\n \"memberInfos\": [\n {\n \"email\": \"echosmusz1+signer1@gmail.com\"\n },\n {\n \"email\": \"echosmusz2+signer1_2@gmail.com\"\n }\n ],\n \"order\": 1,\n \"role\": \"SIGNER\"\n },\n {\n \"memberInfos\": [\n {\n \"email\": \"echosmusz3+signer2@gmail.com\"\n },\n {\n \"email\": \"echosmusz1+signer2_2@gmail.com\"\n }\n ],\n \"order\": 1,\n \"role\": \"SIGNER\"\n }\n \n \n ],\n \"signatureType\": \"ESIGN\",\n \"externalId\": {\n \"id\": \"NA2Account_1775247664\"\n },\n \"message\": \"Everyone message here\",\n \"state\": \"IN_PROCESS\"\n}"},"url":"https://api.{{env_shard}}.adobesign.com/api/rest/v6/agreements","description":"This creates a new agreement for three \"sequential\" signers in. \"DRAFT\" state.\nNo \"merge data\". To get the \"COMPOSE\" view which allows sending through the Adobe Sign UI, you would POST to /agreements/{ID} as shown in this call.
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for three \"sequential\" signers in. \"DRAFT\" state.\nNo \"merge data\". To get the \"COMPOSE\" view which allows sending through the Adobe Sign UI, you would POST to /agreements/{ID} as shown in this call.
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for three \"parallel\" signers where all will get the email to drive them to sign at the same time. Alternately, you can use the GET /agreements/{ID}/signingUrls call which will return all 3 with the email address for each as a list object in the JSON response.
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for two \"sequential\" signers and immediately sets to \"IN_PROCESS\".\nNo \"merge data\" (for merge data agreement must be created as \"DRAFT\" first) and if using email will \"send\" the Please Sign/initialization email right away to the signer.
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for two \"sequential\" signers and immediately sets to \"IN_PROCESS\".\nNo \"merge data\" (for merge data agreement must be created as \"DRAFT\" first) and if using email will \"send\" the Please Sign/initialization email right away to the signer.
\n","auth":{"type":"bearer","bearer":{"token":"Creates a DRAFT Agreement with one signer for use with \"merge data\" and to use when authoring or \"sendPage\" view is needed.
\n","auth":{"type":"bearer","bearer":{"token":"Creates a DRAFT Agreement with one signer for use with \"merge data\" and to use when authoring or \"sendPage\" view is needed.
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for a single signer with 2 library docs and immediately sets to \"IN_PROCESS\".
\nNo \"merge data\" and if using email will \"send\" the Please Sign/initialization email right away to the signer.
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for a single signer using \"phone based\" authentication and immediately \"sends\" (sets to \"IN_PROCESS\").
\nPossible authentication methods are: 'NONE' or 'PASSWORD' or 'PHONE' or 'KBA' or 'WEB_IDENTITY' or 'ADOBE_SIGN'.
\nKBA, WEB_IDENTITY, and ADOBE_SIGN require no other params except \"authenticationMethod\".
\nNo \"merge data\" and if using email will \"send\" the Please Sign/initialization email right away to the signer.
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for a single signer and immediately sets to \"IN_PROCESS\".
\nNo \"merge data\" and if using email will \"send\" the Please Sign/initialization email right away to the signer.
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for a single signer and immediately sets to \"IN_PROCESS\".
\nNo \"merge data\" and if using email will \"send\" the Please Sign/initialization email right away to the signer.
\nThis also contains the postSignOption section in the JSON body where you can specifiy a post signing URL to load once the signer completes the agreement.
\n","auth":{"type":"bearer","bearer":{"token":"Sends for different scenarios using the Adobe Sign \"library templates\" as the agreement document.
\nAdobe Sign has the concept of a \"Template Library\" where users can add and edit field content and then save often used documents.
\nTo read about how to create a \"library template\" in the web UI please see our \"helpx\" article here.
\nThe method for Uploading a libray template via API can be found here.
\nTo edit a libaray template you need to get the \"EDIT\" view for a library file as shown [here]
\n[getTempAuthorView]:
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"320be481-baa2-4aec-893e-751f9129ffd5"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"13e160a7-75fd-420f-8006-b6b85bc9d3ac"}}],"_postman_id":"c3f56c3c-7009-4630-aae2-4070c2e8eae0","auth":{"type":"bearer","bearer":{"token":"including:
\nThis \"eTag\" value can be found in the response header returned from thi call.
\n","auth":{"type":"bearer","bearer":{"token":"including:
\nThis \"eTag\" value can be found in the response header returned from thi call.
\n","auth":{"type":"bearer","bearer":{"token":"including:
\nThis \"eTag\" value can be found in the response header returned from thi call.
\n","auth":{"type":"bearer","bearer":{"token":"including:
\nThis \"eTag\" value can be found in the response header returned from thi call.
\n","auth":{"type":"bearer","bearer":{"token":"including:
\nThis \"eTag\" value can be found in the response header returned from thi call.
\n","auth":{"type":"bearer","bearer":{"token":"including:
\nThis \"eTag\" value can be found in the response header returned from thi call.
\n","auth":{"type":"bearer","bearer":{"token":"Use this call to get the signing URL for the \"current\" participant/s on a specific agreement.
\nIf agreement was sent in \"parallel\" it will return all URLs with the email for each participant.
\nIf agreement was sent \"hybrid\" or normal \"sequential\" this will return the URL/s for the current \"participantSet\" which may contain one or more \"members\".
\n","auth":{"type":"bearer","bearer":{"token":"Use this call to get the signing URL for the \"current\" participant/s on a specific agreement.
\nIf agreement was sent in \"parallel\" it will return all URLs with the email for each participant.
\nIf agreement was sent \"hybrid\" or normal \"sequential\" this will return the URL/s for the current \"participantSet\" which may contain one or more \"members\".
\n","auth":{"type":"bearer","bearer":{"token":"Use this call to get the signing URL for the \"current\" participant/s on a specific agreement.
\nIf agreement was sent in \"parallel\" it will return all URLs with the email for each participant.
\nIf agreement was sent \"hybrid\" or normal \"sequential\" this will return the URL/s for the current \"participantSet\" which may contain one or more \"members\".
\n","auth":{"type":"bearer","bearer":{"token":"This call is for API integrated applications where an \"external ID\" was passed when creatign the agreement.
\nExternal ID is used to connect the data between the Adobe Sign \"agreement ID\" and a unique identifier coming from an integrated platform.
\n","auth":{"type":"bearer","bearer":{"token":"This call is for API integrated applications where an \"external ID\" was passed when creatign the agreement.
\nExternal ID is used to connect the data between the Adobe Sign \"agreement ID\" and a unique identifier coming from an integrated platform.
\n","auth":{"type":"bearer","bearer":{"token":"This can be run at any time.
\nWill return \"CSV\" formatted data with the field names as the 1st \"header\" row.
\nThe official REST Doc page for this call from Adobe Sign can be found here:
\nhttps://secure.na1.adobesign.com/public/docs/restapi/v6
\n","auth":{"type":"bearer","bearer":{"token":"The response to this call is the same as the info in the \"Audit trail/report\" that documents the signing process \"metadata\".
\n","auth":{"type":"bearer","bearer":{"token":"The response to this call is the same as the info in the \"Audit trail/report\" that documents the signing process \"metadata\".
\n","auth":{"type":"bearer","bearer":{"token":"Signed agreement URLs as well as thumbnail image URLs are generated unique links and only remain active for 1 hour (default/setting) for security reasons.
\nLinks to these items should be generated \"on-demand\" or files should be transferred/copied to your app/platform and stored \"locally\".
\n","auth":{"type":"bearer","bearer":{"token":"Depending on what state the agreement is in you may need to get a \"view\" for it.
\nRun this call to get a list of ALL available views for an agreement depending on the state.
\nType of views available:
\nThis creates a new agreement for a single signer and immediately sets to \"IN_PROCESS\".
\nNo \"merge data\" and if using email will \"send\" the Please Sign/initialization email right away to the signer.
\n","auth":{"type":"bearer","bearer":{"token":"Creates transient as a multi-part binary upload.
\n","auth":{"type":"bearer","bearer":{"token":"Creates an agreement for signing using a \"transient\" file uploaded in previous call.
\nThis is the call used for process where the document to become the agreement is from the integrated platform or other \"local\" file rather than using a \"library template\" from the Adobe Sign document library.
\n","auth":{"type":"bearer","bearer":{"token":"Creates an agreement for signing using a \"transient\" file uploaded in previous call.
\nThis is the call used for process where the document to become the agreement is from the integrated platform or other \"local\" file rather than using a \"library template\" from the Adobe Sign document library.
\n","auth":{"type":"bearer","bearer":{"token":"Creates an agreement for signing using a \"transient\" file uploaded in previous call.
\nThis is the call used for process where the document to become the agreement is from the integrated platform or other \"local\" file rather than using a \"library template\" from the Adobe Sign document library.
\nThis call adds \"email suppression\". There are 3 classes of emails from Adobe Sign, init (Please Sign/Approve etc), inFlight (\"was sent\", \"was signed\", etc.), and completion (\"signed and filed\", final approval, etc.). Each of these can be set to \"ALL\" or \"NONE\".
\n","auth":{"type":"bearer","bearer":{"token":"Creates an agreement for signing using a \"transient\" file uploaded in previous call.
\nThis is the call used for process where the document to become the agreement is from the integrated platform or other \"local\" file rather than using a \"library template\" from the Adobe Sign document library.
\n","auth":{"type":"bearer","bearer":{"token":"Creates an agreement for signing using a \"transient\" file uploaded in previous call.
\nThis is the call used for process where the document to become the agreement is from the integrated platform or other \"local\" file rather than using a \"library template\" from the Adobe Sign document library.
\n","auth":{"type":"bearer","bearer":{"token":"Creates an agreement for signing using a \"transient\" file uploaded in previous call.
\nThis is the call used for process where the document to become the agreement is from the integrated platform or other \"local\" file rather than using a \"library template\" from the Adobe Sign document library.
\n","auth":{"type":"bearer","bearer":{"token":"Creates an agreement for signing using a \"transient\" file uploaded in previous call.
\nThis is the call used for process where the document to become the agreement is from the integrated platform or other \"local\" file rather than using a \"library template\" from the Adobe Sign document library.
\n","auth":{"type":"bearer","bearer":{"token":"Creates an agreement for signing using a \"transient\" file uploaded in previous call.
\nThis is the call used for process where the document to become the agreement is from the integrated platform or other \"local\" file rather than using a \"library template\" from the Adobe Sign document library.
\n","auth":{"type":"bearer","bearer":{"token":"Creates an agreement for signing using a \"transient\" file uploaded in previous call.
\nThis is the call used for process where the document to become the agreement is from the integrated platform or other \"local\" file rather than using a \"library template\" from the Adobe Sign document library.
\n","auth":{"type":"bearer","bearer":{"token":"Creates an agreement for signing using a \"transient\" file uploaded in previous call.
\nThis is the call used for process where the document to become the agreement is from the integrated platform or other \"local\" file rather than using a \"library template\" from the Adobe Sign document library.
\n","auth":{"type":"bearer","bearer":{"token":"A few example calls for using a \"transient document\" to create a new agreement.
\n\"Transient docs\" are basically \"temp\" files you upload using the POST UploadTransient call.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"4b568963-d46a-48b2-9ae0-cc67237fdcad"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"dcc77136-98ee-402e-996a-a07ecfb44c55"}}],"_postman_id":"8b7872c0-e029-4ef4-b5db-60b342ecee24","auth":{"type":"bearer","bearer":{"token":"Adds values to form fields on your agreement before authoring or sending.
\nBefore you can use this PUT you will need to get the eTag for the agreemnt from the \nGET /agreements/{agreementId}/formData end point. This eTag is in the response header to the get. Example here. You use this eTag vor the If-Match value in the header of this call.
\n","auth":{"type":"bearer","bearer":{"token":"To be able to add merge data to fields you must 1st create an agreement in DRAFT state.
\nNext you will need to get the eTag for the agreemnt from the \nGET /agreements/{agreementId}/formData end point. This eTag is in the response header to the get. Example here.
\nOnce you add the merge data for the fields on the agreement, you'll need to change the state of the agreement from DRAFT to AUTHORING or IN_PROCESS. Before you can run that call you will need the latest eTag for the agreement from the GET /agreements/{agreementId} endpoint. Add the eTag as the value for a header parameter called If-Match in the PUT to /agreements/{id}/state .
\nThe process is:
\nTo run this call you will need to run the GET Agreement_Info call first to get the latest \"eTag\" in the response header.
\nThis value needs to populate the \"If-Match\" param in the header forthis call.
\n","auth":{"type":"bearer","bearer":{"token":"To run this call you will need to run the GET Agreement_Info call first to get the latest \"eTag\" in the response header.
\nThis value needs to populate the \"If-Match\" param in the header forthis call.
\n","auth":{"type":"bearer","bearer":{"token":"To run this call you will need to run the GET Agreement_Info call first to get the latest \"eTag\" in the response header.
\nThis value needs to populate the \"If-Match\" param in the header forthis call.
\n","auth":{"type":"bearer","bearer":{"token":"This call will return a list of the users in the group if run by a group admin, or in the entire account if run by an account admin.
\nIt returns:
\nThis call will return a list of the users in the group if run by a group admin, or in the entire account if run by an account admin.
\nIt returns:
\nPossible view names can be:
\nPossible view names can be:
\nPossible view names can be:
\nPossible view names can be:
\nPossible view names can be:
\nThis allows embedding the Adobe Sign template \"authoring\" UI for a spceific library template for interaction in your platform UI.
\n","auth":{"type":"bearer","bearer":{"token":"This allows embedding the Adobe Sign template \"authoring\" UI for a spceific library template for interaction in your platform UI.
\n","auth":{"type":"bearer","bearer":{"token":"Gets list of webhooks created by/for the current token owner or the user specied in the x-api-user param.
\nIf the token is account wide and the user is an admin, this list will return all webhooks at the account level as well.
\n","urlObject":{"protocol":"https","path":["api","rest","v6","webhooks"],"host":["api","{{env_shard}}","adobesign","com"],"query":[],"variable":[]}},"response":[{"id":"5e86d6d6-5d1e-4194-95cd-c4f64078483c","name":"WebhooksList","originalRequest":{"method":"GET","header":[{"key":"x-api-user","value":"email:someemail@domain.com"}],"url":"https://api.{{env_shard}}.adobesign.com/api/rest/v6/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 05:29:54 GMT"},{"key":"Server","value":"Apache"},{"key":"x-request-id","value":"88b4f2a3-842a-49df-8de9-92bea81d332a"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Length","value":"1376"},{"key":"Strict-Transport-Security","value":"max-age=31536000;"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Robots-Tag","value":"none"},{"key":"P3P","value":"CP=\"IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT\""},{"key":"Keep-Alive","value":"timeout=15, max=200"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json;charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"userWebhookList\": [\n {\n \"applicationName\": \"EchoSignWebClient\",\n \"applicationDisplayName\": \"EchoSignWebClient\",\n \"id\": \"CBJCHBCAABAAlQZlm4Igi-R6nXpPlZweIymzw181_OU0\",\n \"lastModified\": \"2018-10-31T01:55:17Z\",\n \"name\": \"from NA2 dupe\",\n \"scope\": \"ACCOUNT\",\n \"webhookSubscriptionEvents\": [\n \"AGREEMENT_ALL\"\n ],\n \"webhookUrlInfo\": {\n \"url\": \"https://aaronsmusz.com/webhook/***********2.aspx?testapp=fromNa2Account\"\n },\n \"status\": \"ACTIVE\"\n },\n {\n \"applicationName\": \"Microsoft Flow and PowerApps\",\n \"applicationDisplayName\": \"Microsoft Flow and PowerApps\",\n \"id\": \"CBJCHBCAABAAxKWJygOnR-0UqAn1gQZoqLhXHD5vtrvO\",\n \"lastModified\": \"2018-09-25T21:29:38Z\",\n \"name\": \"Flow 45\",\n \"scope\": \"ACCOUNT\",\n \"webhookSubscriptionEvents\": [\n \"AGREEMENT_CREATED\"\n ],\n \"webhookUrlInfo\": {\n \"url\": \"https://flow-apim-msmanaged-na-northcentralus-01.azure-apim.net/apim/AdobeSign/whr?uri=aHR0cHM6Ly********************dpYy5henVyZS5jb20vd29ya2Zsb3dzLzkxOGQ3ZWJlYzc5NzRmYzdhNDkyYzAzNzhlZTE3NjY1L3RyaWdnZXJzL1doZW5fYV9uZXdfYWdyZWVtZW50X2lzX2NyZWF0ZWQvdmVyc2lvbnMvMDg1ODY2MzY5NTkwODE3NTg5ODMvcnVuP2FwaS12ZXJzaW9uPTIwMTYtMDYtMDEmc3A9JTJGdHJpZ2dlcnMlMkZXaGVuX2FfbmV3X2FncmVlbWVudF9pc19jcmVhdGVkJTJGdmVyc2lvbnMlMkYwODU4NjYzNjk1OTA4MTc1ODk4MyUyRnJ1biUyQyUyRnRyaWdnZXJzJTJGV2hlbl9hX25ld19hZ3JlZW1lbnRfaXNfY3JlYXRlZCUyRnZlcnNpb25zJTJGMDg1ODY2MzY5NTkwODE3NTg5ODMlMkZyZWFkJnN2PTEuMCZzaWc9WjZVd09YYWE0Sy1HaHY2OWxiUGpoSTZMWGtnaGhTUU5aaHBmdlEtcUdZYw==\"\n },\n \"status\": \"ACTIVE\"\n }\n ],\n \"page\": {}\n}"}],"_postman_id":"f3b318c6-b463-4454-a889-3b63208cf18c"},{"name":"Create Webhook - Account - AGREEMENT_ALL","id":"9628caa2-2b7d-4ed9-92a1-2b54ada894fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"The list of \"possible\" webhook EVENT values is:
\n\"webhookSubscriptionEvents\": [\n \"AGREEMENT_ALL\",\n \"AGREEMENT_CREATED\",\n \"AGREEMENT_ACTION_REQUESTED\",\n \"AGREEMENT_ACTION_COMPLETED\",\n \"AGREEMENT_WORKFLOW_COMPLETED\",\n \"AGREEMENT_EXPIRED\",\n \"AGREEMENT_DOCUMENTS_DELETED\",\n \"AGREEMENT_RECALLED\",\n \"AGREEMENT_REJECTED\",\n \"AGREEMENT_SHARED\",\n \"AGREEMENT_ACTION_DELEGATED\",\n \"AGREEMENT_ACTION_REPLACED_SIGNER\",\n \"AGREEMENT_MODIFIED\",\n \"AGREEMENT_USER_ACK_AGREEMENT_MODIFIED\",\n \"AGREEMENT_EMAIL_VIEWED\",\n \"AGREEMENT_EMAIL_BOUNCED\",\n \"AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM\",\n \"AGREEMENT_OFFLINE_SYNC\",\n \"AGREEMENT_UPLOADED_BY_SENDER\",\n \"AGREEMENT_VAULTED\",\n \"AGREEMENT_WEB_IDENTITY_AUTHENTICATED\",\n \"AGREEMENT_KBA_AUTHENTICATED\"\n ],\nThe list of \"possible\" webhook EVENT values is:
\n\"webhookSubscriptionEvents\": [\n \"AGREEMENT_ALL\",\n \"AGREEMENT_CREATED\",\n \"AGREEMENT_ACTION_REQUESTED\",\n \"AGREEMENT_ACTION_COMPLETED\",\n \"AGREEMENT_WORKFLOW_COMPLETED\",\n \"AGREEMENT_EXPIRED\",\n \"AGREEMENT_DOCUMENTS_DELETED\",\n \"AGREEMENT_RECALLED\",\n \"AGREEMENT_REJECTED\",\n \"AGREEMENT_SHARED\",\n \"AGREEMENT_ACTION_DELEGATED\",\n \"AGREEMENT_ACTION_REPLACED_SIGNER\",\n \"AGREEMENT_MODIFIED\",\n \"AGREEMENT_USER_ACK_AGREEMENT_MODIFIED\",\n \"AGREEMENT_EMAIL_VIEWED\",\n \"AGREEMENT_EMAIL_BOUNCED\",\n \"AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM\",\n \"AGREEMENT_OFFLINE_SYNC\",\n \"AGREEMENT_UPLOADED_BY_SENDER\",\n \"AGREEMENT_VAULTED\",\n \"AGREEMENT_WEB_IDENTITY_AUTHENTICATED\",\n \"AGREEMENT_KBA_AUTHENTICATED\"\n ],\nPossible \"events\" for webhooks are:
\n\"webhookSubscriptionEvents\": [\n \"AGREEMENT_ALL\",\n \"AGREEMENT_CREATED\",\n \"AGREEMENT_ACTION_REQUESTED\",\n \"AGREEMENT_ACTION_COMPLETED\",\n \"AGREEMENT_WORKFLOW_COMPLETED\",\n \"AGREEMENT_EXPIRED\",\n \"AGREEMENT_DOCUMENTS_DELETED\",\n \"AGREEMENT_RECALLED\",\n \"AGREEMENT_REJECTED\",\n \"AGREEMENT_SHARED\",\n \"AGREEMENT_ACTION_DELEGATED\",\n \"AGREEMENT_ACTION_REPLACED_SIGNER\",\n \"AGREEMENT_MODIFIED\",\n \"AGREEMENT_USER_ACK_AGREEMENT_MODIFIED\",\n \"AGREEMENT_EMAIL_VIEWED\",\n \"AGREEMENT_EMAIL_BOUNCED\",\n \"AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM\",\n \"AGREEMENT_OFFLINE_SYNC\",\n \"AGREEMENT_UPLOADED_BY_SENDER\",\n \"AGREEMENT_VAULTED\",\n \"AGREEMENT_WEB_IDENTITY_AUTHENTICATED\",\n \"AGREEMENT_KBA_AUTHENTICATED\"\n ],\nPossible \"events\" for webhooks are:
\n\"webhookSubscriptionEvents\": [\n \"AGREEMENT_ALL\",\n \"AGREEMENT_CREATED\",\n \"AGREEMENT_ACTION_REQUESTED\",\n \"AGREEMENT_ACTION_COMPLETED\",\n \"AGREEMENT_WORKFLOW_COMPLETED\",\n \"AGREEMENT_EXPIRED\",\n \"AGREEMENT_DOCUMENTS_DELETED\",\n \"AGREEMENT_RECALLED\",\n \"AGREEMENT_REJECTED\",\n \"AGREEMENT_SHARED\",\n \"AGREEMENT_ACTION_DELEGATED\",\n \"AGREEMENT_ACTION_REPLACED_SIGNER\",\n \"AGREEMENT_MODIFIED\",\n \"AGREEMENT_USER_ACK_AGREEMENT_MODIFIED\",\n \"AGREEMENT_EMAIL_VIEWED\",\n \"AGREEMENT_EMAIL_BOUNCED\",\n \"AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM\",\n \"AGREEMENT_OFFLINE_SYNC\",\n \"AGREEMENT_UPLOADED_BY_SENDER\",\n \"AGREEMENT_VAULTED\",\n \"AGREEMENT_WEB_IDENTITY_AUTHENTICATED\",\n \"AGREEMENT_KBA_AUTHENTICATED\"\n ],\nSee to official webhooks documentation on our helpx here:
\nhttps://helpx.adobe.com/sign/help/adobesign_api_webhooks.html
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"285232b4-599d-4835-a883-9b17d4f986eb"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"f98849f9-8571-4894-b0a1-910ad5d29d58"}}],"_postman_id":"9c2e78cd-6840-4319-8c0c-3cdcd786d840","auth":{"type":"bearer","bearer":{"token":"Run this call to see all widgets created by the \"x-api-user\" from your account.
\n","auth":{"type":"bearer","bearer":{"token":"Run this call against your Parent/Widget ID to see a list of all agreements created by signing that widget.
\n","auth":{"type":"bearer","bearer":{"token":"Run this call against your Parent/Widget ID to see a list of all agreements created by signing that widget.
\n","auth":{"type":"bearer","bearer":{"token":"To run this call you will need to run the GET Agreement_Info call first to get the latest \"eTag\" in the response header.
\nThis value needs to populate the \"If-Match\" param in the header forthis call.
\n","auth":{"type":"bearer","bearer":{"token":"To run this call you will need to run the GET Agreement_Info call first to get the latest \"eTag\" in the response header.
\nThis value needs to populate the \"If-Match\" param in the header forthis call.
\n","auth":{"type":"bearer","bearer":{"token":"Creates transient as a multi-part binary upload.
\n","auth":{"type":"bearer","bearer":{"token":"Creates a library template from a transient doc previously uploaded. You can also create Template from URL with same params as when sending agreement with document in agreement from URL.
Sets Template name, type, and state. If state set to \"AUTHORING\" template will not be available till the URL is opened and Template is saved. If set to \"ACTIVE\", Template will be available to send immediately.\n
\nSets \"sharingMode\" as well. This does not allow others to edit (except for account admins with that role) but shares for \"sending\" as self, group, or account-wide.
Creates as either Document Template (\"content\" plus fields) or Form Field Template (fields only) or both.
\n","auth":{"type":"bearer","bearer":{"token":"Gets the \"EDIT\" View for a specific library Template by it's ID.
\n","auth":{"type":"bearer","bearer":{"token":"Creates a library template from a URL.
\nSets Template name, type, and state. If state set to \"AUTHORING\" template will not be available till the URL is opened and Template is saved. If set to \"ACTIVE\", Template will be available to send immediately.\n
\nSets \"sharingMode\" as well. This does not allow others to edit (except for account admins with that role) but shares for \"sending\" as self, group, or account-wide.
Creates as either Document Template (\"content\" plus fields) or Form Field Template (fields only) or both.
\n","auth":{"type":"bearer","bearer":{"token":"Gets the \"EDIT\" View for a specific library Template by it's ID.
\n","auth":{"type":"bearer","bearer":{"token":"Creates a DRAFT Agreement with one signer for use with \"merge data\" and to use when authoring or \"sendPage\" view is needed.
\n","auth":{"type":"bearer","bearer":{"token":"including:
\nThis \"eTag\" value can be found in the response header returned from thi call.
\n","auth":{"type":"bearer","bearer":{"token":"Adds values to form fields on your agreement before authoring or sending.
\nBefore you can use this PUT you will need to get the eTag for the agreemnt from the \nGET /agreements/{agreementId}/formData end point. This eTag is in the response header to the get. Example here. You use this eTag vor the If-Match value in the header of this call.
\n","auth":{"type":"bearer","bearer":{"token":"including:
\nThis \"eTag\" value can be found in the response header returned from thi call.
\n","auth":{"type":"bearer","bearer":{"token":"To run this call you will need to run the GET Agreement_Info call first to get the latest \"eTag\" in the response header.
\nThis value needs to populate the \"If-Match\" param in the header forthis call.
\n","auth":{"type":"bearer","bearer":{"token":"To run this call you will need to run the GET Agreement_Info call first to get the latest \"eTag\" in the response header.
\nThis value needs to populate the \"If-Match\" param in the header forthis call.
\n","auth":{"type":"bearer","bearer":{"token":"including:
\nThis \"eTag\" value can be found in the response header returned from thi call.
\n","auth":{"type":"bearer","bearer":{"token":"Use this call to get the signing URL for the \"current\" participant/s on a specific agreement.
\nIf agreement was sent in \"parallel\" it will return all URLs with the email for each participant.
\nIf agreement was sent \"hybrid\" or normal \"sequential\" this will return the URL/s for the current \"participantSet\" which may contain one or more \"members\".
\n","auth":{"type":"bearer","bearer":{"token":"Setps to send from lb-doc/transient/URL and then allow authoring
\n","_postman_id":"546c037d-fce1-4d89-bbfc-39078c6632ba","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement using 3 documents. In this case its: 1 - 3 page word doc, 1 - 2 page word doc, and 1 - 1 page pdf.
\nIt sets the \"stage\" of the agreement to \"AUTHORING\" so there's no need to move from Draft to Authoring.
\n","auth":{"type":"bearer","bearer":{"token":"including:
\nThis \"eTag\" value can be found in the response header returned from this call.
\n","auth":{"type":"bearer","bearer":{"token":"This call returns the doc IDs and page counts for all the documents in the agreement and can only return info if agreement is in \"AUTHORING\" or later stage EI \"OUT_FOR_SIGNATURE\" or \"SIGNED\" etc.
\n","auth":{"type":"bearer","bearer":{"token":"This call gets the \"members\" for an agreement and must be run if the agreement was created in \"DRAFT\" with no recipients before adding or replacing recipients so as to obtain the \"eTag\" value from the response header as this is needed for the \"IF-Match\" when using the corresponding \"PUT\" for this endpoint.
\n","auth":{"type":"bearer","bearer":{"token":"This call must be run BEFORE using the corresponding PUT for this endpoint to add fields to an agreement in an \"AUTHORING\" stage.\nIf there are no fields on the agreement it will return an empty array but it must be run to obtain the \"eTag\" header for use in the PUT call so as to have that eTag for the \"IF-Match\" param on the PUT.
\n","auth":{"type":"bearer","bearer":{"token":"Creates a DRAFT Agreement with one signer for use with \"merge data\" and to use when authoring or \"sendPage\" view is needed.
\n","auth":{"type":"bearer","bearer":{"token":"To run this call you will need to run the GET Agreement_Info call first to get the latest \"eTag\" in the response header.
\nThis value needs to populate the \"If-Match\" param in the header for this call.
\n","auth":{"type":"bearer","bearer":{"token":"To run this call you will need to run the GET Agreement_Info call first to get the latest \"eTag\" in the response header.
\nThis value needs to populate the \"If-Match\" param in the header for this call.
\n","auth":{"type":"bearer","bearer":{"token":"including:
\nThis \"eTag\" value can be found in the response header returned from thi call.
\n","auth":{"type":"bearer","bearer":{"token":"Use this call to get the signing URL for the \"current\" participant/s on a specific agreement.
\nIf agreement was sent in \"parallel\" it will return all URLs with the email for each participant.
\nIf agreement was sent \"hybrid\" or normal \"sequential\" this will return the URL/s for the current \"participantSet\" which may contain one or more \"members\".
\n","auth":{"type":"bearer","bearer":{"token":"including:
\nThis \"eTag\" value can be found in the response header returned from thi call.
\n","auth":{"type":"bearer","bearer":{"token":"Creates transient as a multi-part binary upload.
\nReturns ~300 char long \"transient ID\" for use in creating agreement using this file (like a \"temp\" file)
\n","auth":{"type":"bearer","bearer":{"token":"Creates an agreement for signing using a \"transient\" file uploaded in previous call.
\nThis is the call used for process where the document to become the agreement is from the integrated platform or other \"local\" file rather than using a \"library template\" from the Adobe Sign document library.
\nThe initial state of the agreement will be \"CREATED\" but will change quickly to \"DRAFT\" and it's not until this state that you can move on to get a \"view\" or use the possible call to \"merge data\"
\n","auth":{"type":"bearer","bearer":{"token":"including:
\nThis \"eTag\" parameter and value can be found in the response header returned from thi call.
\n","auth":{"type":"bearer","bearer":{"token":"including:
\nThis \"eTag\" value can be found in the response header returned from thi call.
\n","auth":{"type":"bearer","bearer":{"token":"Use this call to get the signing URL for the \"current\" participant/s on a specific agreement.
\nIf agreement was sent in \"parallel\" it will return all URLs with the email for each participant.
\nIf agreement was sent \"hybrid\" or normal \"sequential\" this will return the URL/s for the current \"participantSet\" which may contain one or more \"members\".
\n","auth":{"type":"bearer","bearer":{"token":"including:
\nThis \"eTag\" value can be found in the response header returned from thi call.
\n","auth":{"type":"bearer","bearer":{"token":"This folder contains the calls needed for the following workflow:
\nCreates a DRAFT Agreement with one signer for use with \"merge data\" and to use when authoring or \"sendPage\" view is needed.
\n","auth":{"type":"bearer","bearer":{"token":"including:
\nThis \"eTag\" value can be found in the response header returned from thi call.
\n","auth":{"type":"bearer","bearer":{"token":"To run this call you will need to run the GET Agreement_Info call first to get the latest \"eTag\" in the response header.
\nThis value needs to populate the \"If-Match\" param in the header forthis call.
\n","auth":{"type":"bearer","bearer":{"token":"Use this call to get the signing URL for the \"current\" participant/s on a specific agreement.
\nIf agreement was sent in \"parallel\" it will return all URLs with the email for each participant.
\nIf agreement was sent \"hybrid\" or normal \"sequential\" this will return the URL/s for the current \"participantSet\" which may contain one or more \"members\".
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for a single signer and immediately sets to \"IN_PROCESS\".
\nNo \"merge data\" and if using email will \"send\" the Please Sign/initialization email right away to the signer.
\n","urlObject":{"protocol":"https","path":["api","rest","v6","agreements"],"host":["api","{{env_shard}}","adobesign","com"],"query":[],"variable":[]}},"response":[{"id":"8c2a2630-ae68-4b47-9be2-47ab88a411fa","name":"Create and Send - basic 1 signer","originalRequest":{"method":"POST","header":[{"key":"x-api-user","value":"email:someemail@domain.com"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fileInfos\": [\n {\n \"libraryDocumentId\": \"{{ldt_msaNoLine}}\"\n }\n ],\n \"name\": \"API Send Library Test Agreement 184\",\n \"participantSetsInfo\": [\n {\n \"memberInfos\": [\n {\n \"email\": \"{{rcp1}}\"\n }\n ],\n \"order\": 1,\n \"role\": \"SIGNER\"\n }\n ],\n \"signatureType\": \"ESIGN\",\n \"externalId\": {\n \"id\": \"NA2Account_1775247664\"\n },\n \"state\": \"IN_PROCESS\"\n}"},"url":"https://api.{{env_shard}}.adobesign.com/api/rest/v6/agreements"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"53","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 09 Jul 2018 21:04:10 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"A0bba41be5ed303811da8add6681e70db08730418","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=15, max=200","name":"Keep-Alive","description":"Custom header"},{"key":"P3P","value":"CP=\"IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT\"","name":"P3P","description":"This header is supposed to set P3P policy, in the form of P3P:CP=\"your_compact_policy\". However, P3P did not take off, most browsers have never fully implemented it, a lot of websites set this header with fake policy text, that was enough to fool browsers the existence of P3P policy and grant permissions for third party cookies."},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=31536000;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Robots-Tag","value":"none","name":"X-Robots-Tag","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"},{"key":"x-request-id","value":"299673e3-3f49-4f52-933d-da669dc3e3bd","name":"x-request-id","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"id\":\"CBJCHBCAABAAMCWmyx5VXu0DSBE7G2I7fZtjilwnmibF\"}"}],"_postman_id":"b4344765-4cb1-4006-ac9b-8d71a152cebf"},{"name":"participant sets and Members","event":[{"listen":"test","script":{"exec":["","pm.environment.set(\"partSet1_Id\", pm.response.json()[\"participantSets\"][0].id);","pm.environment.set(\"participantMemberID\", pm.response.json()[\"participantSets\"][0][\"memberInfos\"][0].id);","","",""],"type":"text/javascript","id":"8153846a-3733-4b08-bf64-1d476722ebd0"}},{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"6f036fbb-e2e3-4206-8827-20df41afc576"}}],"id":"2d0335a0-ce73-4434-9423-4abcd6b50d8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-user","value":"email:someemail@domain.com"}],"url":"https://api.{{env_shard}}.adobesign.com/api/rest/v6/agreements/{{na2LastSentAgId}}/members","description":"In this call I'm getting the ID for the 1st participant and the 1st member of that participant since I need those to query what auth method is used for them and to make the PUT call to change it.
\n","auth":{"type":"bearer","bearer":{"token":"Here I'm getting the auth method for a specific signer so I know what it is (if any) before changing it AND I'm getting the current \"eTag\" from this \"endpoint\" which I need to have before calling the PUT to change that auth method.
\n","auth":{"type":"bearer","bearer":{"token":"This is the actual PUT that changes the auth method for a specific participantSet-member.
\nIn this case I'm changing to \"KBA\" but I can use any of the methods available on my account by passing in the necessary JSON in the body of this call.
\n","auth":{"type":"bearer","bearer":{"token":"This creates a new agreement for a single signer and immediately sets to \"IN_PROCESS\".
\nNo \"merge data\" and if using email will \"send\" the Please Sign/initialization email right away to the signer.
\n","urlObject":{"protocol":"https","path":["api","rest","v6","agreements"],"host":["api","{{env_shard}}","adobesign","com"],"query":[],"variable":[]}},"response":[{"id":"c7d969cf-d41a-4eac-9961-1f86df3a97a4","name":"Create and Send - basic 1 signer","originalRequest":{"method":"POST","header":[{"key":"x-api-user","value":"email:someemail@domain.com"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fileInfos\": [\n {\n \"libraryDocumentId\": \"{{ldt_msaNoLine}}\"\n }\n ],\n \"name\": \"API Send Library Test Agreement 210\",\n \"participantSetsInfo\": [\n {\n \"memberInfos\": [\n {\n \"email\": \"{{rcp1}}\"\n }\n ],\n \"order\": 1,\n \"role\": \"SIGNER\"\n }\n ],\n \"signatureType\": \"ESIGN\",\n \"externalId\": {\n \"id\": \"NA2Account_1775247664\"\n },\n \"state\": \"IN_PROCESS\"\n}"},"url":"https://api.{{env_shard}}.adobesign.com/api/rest/v6/agreements"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"53","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 09 Jul 2018 21:04:10 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"A0bba41be5ed303811da8add6681e70db08730418","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Keep-Alive","value":"timeout=15, max=200","name":"Keep-Alive","description":"Custom header"},{"key":"P3P","value":"CP=\"IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT\"","name":"P3P","description":"This header is supposed to set P3P policy, in the form of P3P:CP=\"your_compact_policy\". However, P3P did not take off, most browsers have never fully implemented it, a lot of websites set this header with fake policy text, that was enough to fool browsers the existence of P3P policy and grant permissions for third party cookies."},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=31536000;","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Robots-Tag","value":"none","name":"X-Robots-Tag","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"},{"key":"x-request-id","value":"299673e3-3f49-4f52-933d-da669dc3e3bd","name":"x-request-id","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"id\":\"CBJCHBCAABAAMCWmyx5VXu0DSBE7G2I7fZtjilwnmibF\"}"}],"_postman_id":"5b76690c-d95c-4de3-aef3-a90d97c4619d"},{"name":"participant sets and Members","event":[{"listen":"test","script":{"exec":["//pm.environment.set(\"memberID_0\", pm.response[0].id)","","pm.environment.set(\"partSet1_Id\", pm.response.json(\"participantSets\"[0]).id);","","","",""],"type":"text/javascript","id":"d610c4ab-d79a-4191-8a6e-0f4bdd350d56"}}],"id":"db49e731-bcd0-42fb-b1e3-45ebaf548e66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-user","value":"email:someemail@domain.com"}],"url":"https://api.{{env_shard}}.adobesign.com/api/rest/v6/agreements/{{na2LastSentAgId}}/members","auth":{"type":"bearer","bearer":{"token":"Creates transient as a multi-part binary upload.
\n","auth":{"type":"bearer","bearer":{"token":"