{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"fbf0f7fa-6442-4cd1-be65-414e3270be0c","name":"Oodrive sign for developers","description":"Provide your users with a seamless digital signature experience using your own company platform. Leverage your data and reduce your costs with the oodrive_sign API.\n\nAsk our sales representatives to create your free sandbox account to start the Oodrive sign API integration.\n\nHere you will find the full API documentation covering the following topics:\n\n- A basic overview of oodrive_sign features and how to implement your business case\n    \n- Detailed explanations regarding how to integrate our API step by step\n    \n\n# Sandbox versus production environment\n\nWe provide developers with a completely free and unlimited test environment, or sandbox.\n\nDevelopers can integrate our API through the qualification stage without any constraints. This means that it's not necessary to contract and start paying to carry out the full development stage.\n\n**Please note:** Our sandboxes are completely independent from our production environments – meaning there is no connection between them. As a result, you will have a separate username and password and set of API keys for your sandbox and production environments. Please use the relevant API key to perform a test or live API call.\n\nFor more details regarding the transition from a sandbox to production environment, please refer to the Go live section.\n\n# Getting started\n\nThe oodrive_sign API is restful and conforms to the OpenAPI V3 specification.\n\nEach endpoint is identified by an HTTP method (GET, POST, PATCH, DELETE) and a URL.\n\nSee for example, the following API call:\n\ncurl -X 'GET'  \n'[https://api.sign.oodrive.com/api/v4/recipients?size=20&offset=0&get_custom_props=false'](https://api.sign.oodrive.com/api/v4/recipients?size=20&offset=0&get_custom_props=false')  \n\\-H 'accept: application/json'  \n\\-H 'j_token: YOUR-API-TOKEN'\n\nLists the information for the 20 first recipients (signatories) present in your license:\n\n\\[  \n{  \n\"id\": 21721,  \n\"civility\": \"MONSIEUR\",  \n\"firstname\": \"alphonse\",  \n\"lastname\": \"Allais\",  \n\"address_1\": \"Adresse 1a\",  \n\"address_2\": \"\",  \n\"postal_code\": \"75001\",  \n\"city\": \"Paris\",  \n\"phone\": \"\",  \n\"email\": \"[omathieu+789@calindasoftware.com](https://mailto:omathieu+789@calindasoftware.com)\",  \n\"job_title\": \"\",  \n\"company_name\": \"\",  \n\"country\": \"\",  \n\"cell_phone\": \"0662370619\",  \n\"birthdate\": 0,  \n\"birthplace\": \"\"  \n},  \n{  \n\"id\": 20733,  \n\"civility\": \"MONSIEUR\",  \n\"firstname\": \"VINCENT\",  \n\"lastname\": \"APARICI\",  \n\"address_1\": \"11 PLACE DU MONT SEREIN\",  \n\"address_2\": \"-\",  \n…  \n\\]\n\nOur API servers use the following base URL: [https://api.sign.oodrive.com/api/v4](https://api.sign.oodrive.com/api/v4)\n\nif your licence is hosted on OUTSCALE SNC , please use this base URL instead : [https://api.sign.oodrive.eu/api/v4](https://api.ota.sign.oodrive.eu/api/v4)\n\n**Please note:** this base URL is the same for both the sandbox and production environments.\n\nThe GET method and the /recipient URL identify the endpoint.\n\nThe size and offset query string parameters allow you to set the maximum number of recipients that the request can return, as well as the index of the first recipient in the list.\n\nAs this request returns a JSON array, we must set the ‘Accept’ request header to ‘Application/json’.\n\n# Authentication\n\nAll of our API endpoints are protected with an API key.\n\nOur delivery team will provide you with a valid API key when delivering your sandbox or production license.\n\nIn order to authenticate yourself, you must place your API key in the ‘j_token’ header of each request:\n\ncurl -X 'GET'  \n'[https://api.sign.oodrive.com/api/v4/recipients?size=20&offset=0&get_custom_props=false'](https://api.sign.oodrive.com/api/v4/recipients?size=20&offset=0&get_custom_props=false')  \n\\-H 'accept: application/json'  \n\\-H 'j_token: YOUR-API-TOKEN'","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"17614357","collectionId":"fbf0f7fa-6442-4cd1-be65-414e3270be0c","publishedId":"UUxzB7ou","public":true,"publicUrl":"https://developers.oodrive-sign.com","privateUrl":"https://go.postman.co/documentation/17614357-fbf0f7fa-6442-4cd1-be65-414e3270be0c","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EEB186"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/4780554a-8a93-41e1-b908-e1078ad3ccc1/b29kcml2ZV93aGl0ZV9sb2dvLTIucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/02578ada-07e4-44eb-9293-487f7bc7cada/Y3JvcHBlZC1sb2dvX3NpZ25fMjAyMi0yNDBweC5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EEB186"}}]}},"version":"8.10.1","publishDate":"2023-07-27T13:24:31.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/02578ada-07e4-44eb-9293-487f7bc7cada/Y3JvcHBlZC1sb2dvX3NpZ25fMjAyMi0yNDBweC5wbmc=","logoDark":"https://content.pstmn.io/4780554a-8a93-41e1-b908-e1078ad3ccc1/b29kcml2ZV93aGl0ZV9sb2dvLTIucG5n"}},"statusCode":200},"environments":[],"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://oodrive-sign.com/favicon.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"}],"canonicalUrl":"https://developers.oodrive-sign.com/view/metadata/UUxzB7ou"}