{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"6a168fd0-2b99-4f46-8d43-9ac0b1e00d0b","name":"Skribble API v2","description":"<img src=\"https://content.pstmn.io/04cb1166-e3f9-47a1-b18e-b38cdea6808d/YXBpLXYyLmpwZw==\">\n\nThe **Skribble API v2** documentation describes the public available [Skribble](https://www.skribble.com) API version 2.\n\nOur API allows businesses and teams of any size to fully integrate the e-signing solution of Skribble with any internal systems, software or SaaS solution.\n\nOur goal is to provide a simple API that enables integrators to create signature requests programmatically. A signature request is a description of who is going to sign what, and needs to be created in order to perform an electronic signature on a document. Signature request is the primary object of the API.\n\nThe signature request enables the integrator to describe a short document flow between the participants in a signing process.\n\nThe actual signing of a PDF document by a signatory always takes place inside the [Skribble web application.](https://my.skribble.com)\n\nTo get started with the Skribble API, you will need to set up Skribble Business. To learn more, see the chapter [Setting up Skribble Business](https://docs.skribble.com/business-admin/quickstart/upgrade.html) in the _**Skribble Admin Guide**_.\n\nFor feedback and questions, please use our Google Group [public-api-users@skribble.com](https://groups.google.com/a/skribble.com/g/public-api-users)\n\n# Versions\n\n## **API v1**\n\n- If you are looking for Skribble API v1 documentation please visit [https://api-v1-doc.skribble.com](https://api-v1-doc.skribble.com)\n    \n- With the release of **Skribble API v2**, we will continue to support **Skribble API v1** until **30.11.2025**. After this date, Skribble API v1 will remain functional; however, we will no longer guarantee that changes will not break the existing **Skribble API v1**.\n    \n- We recommend upgrading to **Skribble API v2** to take advantage of additional features and to keep up with the latest developments in Skribble. Upgrading will ensure that you can take advantage of new features, enhancements and improvements that are part of our ongoing development work.\n    \n\n## API v2\n\n**Data Hosting Regions:**\n\nThe Skribble web application is available in different hosting regions.\n\nPlease ensure you use the appropriate base URL for your Skribble account’s hosting region:\n\n- **Germany and the EU:**\n    \n    - Web application: [https://my.skribble.de](https://my.skribble.de)\n        \n    - API v2 base URL: [https://api.skribble.de/v2](https://api.skribble.de/v2)\n        \n- **Switzerland and the Rest of the World:**\n    \n    - Web application: [https://my.skribble.com](https://my.skribble.com)\n        \n    - API v2 base URL: [https://api.skribble.com/v2](https://null)\n        \n\n**Make sure to use the correct base URL based on your account's hosting region!**\n\n- The **Skribble API v2** was officially released at **25.06.2024**\n    \n- The **Skribble API v2** is the latest version of our API.\n    \n- **Skribble API v2** maintains backward compatibility with **Skribble API v1**. This ensures that objects such as `SignatureRequests`, created using either version of the API, can be seamlessly read and processed by the other version within their respective contexts. If you encounter any compatibility issues or have specific concerns, please inform us so that we can address them promptly.\n    \n- However, we receommend you to upgrade to **Skribble API v2**. Upgrading to **Skribble API v2** not only preserves compatibility but also offers enhanced functionalities and optimizations, ensuring a smoother experience and access to the latest features.\n    \n\n### Overview: What is new in API v2?\n\n- For **integration**\n    \n    - Initiate the signing process without the need for an API key with `Send-To`\n        \n- For **SignatureRequests**\n    \n    - _Create_\n        \n        - Add and remove single signers from a `SignatureRequest`\n            \n        - Define a specific `SignatureRequest` owner\n            \n        - Define a signing sequence\n            \n        - Define multiple visual signatures per signature\n            \n        - Disable TAN based NAS notifications for SES\n            \n        - Withdraw a `SignatureRequest`\n            \n    - _Find_\n        \n        - Enhanced `search` capabilities with `title` search for `SignatureRequest`\n            \n        - Extended `SignatureRequest` listing with pagination options\n            \n    - _Triggers_\n        \n        - Remind signers with pending signatures\n            \n- For **users**\n    \n    - Extended details on signature qualities\n        \n- For **monitoring**\n    \n    - Get details about the status of `SignatureRequest` _**callbacks**_\n        \n- For **reporting**\n    \n    - Get signature activities for a business\n        \n\n### Migration Tasks from API v1 to API v2\n\nTo successfully migrate from Skribble API v1 to API v2, please follow these steps:\n\n1. **Update Base URL:**\n    \n    - Rename the base URL of the endpoints from `https://api.skribble.com/v1` to `https://api.skribble.com/v2`.\n        \n2. **Field Renaming:**\n    \n    - In SignatureRequest-related requests, rename the field `signer_email_address` to `account_email`.\n        \n    - Expect the field `account_email` instead of `signer_email_address` in the corresponding responses.\n        \n    - For detailed information, refer to the chapter: **Reference > SignatureRequests > ObjectDetails.**\n        \n3. **Visual Signature Positioning:**\n    \n    - Change from using the `visual_signature.position` object to the `visual_signature.positions` array of position objects.\n        \n    - This change accommodates the ability to define multiple visual signatures per signer, with Skribble now utilizing a `positions` array instead of a single `position`.\n        \n    - For more details, see the chapter: **Reference > SignatureRequests > Create > Basic Actions > Define Visual Signatures**.\n        \n\nBy following these migration tasks, you can ensure a smooth transition to API v2 and take full advantage of its new features and improvements.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"6930652","team":310164,"collectionId":"6a168fd0-2b99-4f46-8d43-9ac0b1e00d0b","publishedId":"2sA3XV7K6V","public":true,"publicUrl":"https://api-doc.skribble.com","privateUrl":"https://go.postman.co/documentation/6930652-6a168fd0-2b99-4f46-8d43-9ac0b1e00d0b","customColor":{"top-bar":"263B65","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"The Skribble API v2 documentation describes the public available Skribble API v2.\nOur API allows businesses and teams of any size to fully integrate the e-signing solution of Skribble with any internal systems, software or SaaS solution.\n"},{"name":"title","value":"Skribble API v2 - E-Signing solution"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/9c95bb38-2b8c-481b-b568-c4f9a481837f/U2tyaWJibGUtd2hpdGUtdHJhbnNwYXJlbnQucG5n","colors":{"top-bar":"263b65","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/327d139e-8eeb-48eb-b999-96ea92cb9d21/U2tyaWJibGUtd2hpdGUtdHJhbnNwYXJlbnQucG5n","colors":{"top-bar":"263B65","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-06-25T06:50:59.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Skribble API v2 - E-Signing solution","description":"The Skribble API v2 documentation describes the public available Skribble API v2.\nOur API allows businesses and teams of any size to fully integrate the e-signing solution of Skribble with any internal systems, software or SaaS solution.\n"},"logos":{"logoLight":"https://content.pstmn.io/327d139e-8eeb-48eb-b999-96ea92cb9d21/U2tyaWJibGUtd2hpdGUtdHJhbnNwYXJlbnQucG5n","logoDark":"https://content.pstmn.io/9c95bb38-2b8c-481b-b568-c4f9a481837f/U2tyaWJibGUtd2hpdGUtdHJhbnNwYXJlbnQucG5n"}},"statusCode":200},"environments":[{"name":"Skribble API QuickStart","id":"d388cfac-d2b9-4b02-b8b1-4b54290efd25","owner":"6930652","values":[{"key":"AUTH_ACCESS_TOKEN","value":"By login generated ACCESS_TOKEN","enabled":true},{"key":"SR_ID","value":"SignatureRequestID","enabled":true},{"key":"DOCUMENT_ID","value":"DocumentID","enabled":true},{"key":"BASE64_PDF","value":"Base64 encoded PDF file","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/cd5b47ca0ec0f07c5e8026d77db724c8176c8f8d9457c9db57c948102284afbb","favicon":"https://res.cloudinary.com/postman/image/upload/v1602684540/team/zxcuunervadvul4wi4bb.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Skribble API QuickStart","value":"6930652-d388cfac-d2b9-4b02-b8b1-4b54290efd25"}],"canonicalUrl":"https://api-doc.skribble.com/view/metadata/2sA3XV7K6V"}