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.
\nAsk our sales representatives to create your free sandbox account to start the Oodrive sign API integration.
\nHere you will find the full API documentation covering the following topics:
\nA basic overview of oodrive_sign features and how to implement your business case
\nDetailed explanations regarding how to integrate our API step by step
\nWe provide developers with a completely free and unlimited test environment, or sandbox.
\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.
\nPlease 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.
\nFor more details regarding the transition from a sandbox to production environment, please refer to the Go live section.
\nThe oodrive_sign API is restful and conforms to the OpenAPI V3 specification.
\nEach endpoint is identified by an HTTP method (GET, POST, PATCH, DELETE) and a URL.
\nSee for example, the following API call:
\ncurl -X 'GET'
'https://api.sign.oodrive.com/api/v4/recipients?size=20&offset=0&get_custom_props=false'
-H 'accept: application/json'
-H 'j_token: YOUR-API-TOKEN'
Lists the information for the 20 first recipients (signatories) present in your license:
\n[
{
\"id\": 21721,
\"civility\": \"MONSIEUR\",
\"firstname\": \"alphonse\",
\"lastname\": \"Allais\",
\"address_1\": \"Adresse 1a\",
\"address_2\": \"\",
\"postal_code\": \"75001\",
\"city\": \"Paris\",
\"phone\": \"\",
\"email\": \"omathieu+789@calindasoftware.com\",
\"job_title\": \"\",
\"company_name\": \"\",
\"country\": \"\",
\"cell_phone\": \"0662370619\",
\"birthdate\": 0,
\"birthplace\": \"\"
},
{
\"id\": 20733,
\"civility\": \"MONSIEUR\",
\"firstname\": \"VINCENT\",
\"lastname\": \"APARICI\",
\"address_1\": \"11 PLACE DU MONT SEREIN\",
\"address_2\": \"-\",
…
]
Our API servers use the following base URL: https://api.sign.oodrive.com/api/v4
\nif your licence is hosted on OUTSCALE SNC , please use this base URL instead : https://api.sign.oodrive.eu/api/v4
\nPlease note: this base URL is the same for both the sandbox and production environments.
\nThe GET method and the /recipient URL identify the endpoint.
\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.
\nAs this request returns a JSON array, we must set the ‘Accept’ request header to ‘Application/json’.
\nAll of our API endpoints are protected with an API key.
\nOur delivery team will provide you with a valid API key when delivering your sandbox or production license.
\nIn order to authenticate yourself, you must place your API key in the ‘j_token’ header of each request:
\ncurl -X 'GET'
'https://api.sign.oodrive.com/api/v4/recipients?size=20&offset=0&get_custom_props=false'
-H 'accept: application/json'
-H 'j_token: YOUR-API-TOKEN'
signature_mode is mandatoryThis feature allows you to send a contract for signature with a single API call. The POST /constracts/allione endpoint’s body is a multipart/form-data.
\nThe first part is a contract object, similar to the POST /contracts request’s body.
\nPS : If you want to perform sequential signing, you need to include the member \"sequential\" and set it to true .
\nThe second part is the union of a recipient object (similar to the POST /recipients request body) and a ‘recipient for contract’ object (similar to the POST /contracts/{id}/recipients request body). When using this endpoint, you can create new recipients, reference existing recipients or reference and update existing recipients.
\nPS : In order to perform sequential signing, you need to specify the sequential order of your recipients using the \"seq_order\" member, followed by the desired number. For example, for the first recipient, set \"seq_order\" to 1, and for the second recipient, set \"seq_order\" to 2.
\nCaution : though it is acceptable to create recipient objects directly in the allinone API request, it is safer to use existing recipients referenced by their id. Actually firing concurrent allinone requests with same recipient objects could lead to create unexpected recipient doublons, based upon the unicity constraint the license is configured with.
\nNew The Avanced and Qualified Electronic signature modes are now available. These modes imply identity verification for the signatories. Please refer to the Creating a contract step by step/Add recipient to a contract for a description of how to use these signature modes.
\nPlease note: The recipient_id member in the recipients object is only used for upward compatibility. When referencing an existing recipient, you can use both the id member and the recipient_id member. If you set both, the id takes precedence.
\nThe third part is the contract documents (you can attach one or many documents).
\nThe fourth part is the contract attachments (you can attach one or many documents).
\nThe endpoint has a query string parameter (start) that allows you to automatically send the contract for signature (i.e., start the transaction).
\n","auth":{"type":"apikey","apikey":{"key":"If set to true, the contract will be sent for signature
\n","type":"text/plain"},"key":"start","value":"false"}],"variable":[]}},"response":[{"id":"e5b36c07-ca41-41df-a895-1391d112d896","name":"Create a contract all in one","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"j_token","value":"{{apiToken}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"contract","value":"{\n\t \"name\": \"my_first_contract.pdf\",\n\t \"contract_definition_id\": 1,\n\t \"vendor_email\": \"admin@calindasoftware.com\",\n\t \"message_title\": \"Here is your contract\",\n\t \"message_body\": \"We are pleased to sen you your contract ...\",\n\t \"keep_on_move\": false,\n\t \"perimeters\": [\n\t\t\"pilote\"\n\t ],\n\t \"auto_close\": 0\n\t}","type":"text"},{"key":"recipients","value":"{\n\t \"data\": [\n\t\t{\n\t\t \"civility\": \"MONSIEUR\",\n\t\t \"firstname\": \"John\",\n\t\t \"lastname\": \"Doe\",\n\t\t \"address_1\": \"Adresse 1 2 3\",\n\t\t \"address_2\": \"\",\n\t\t \"postal_code\": \"75001\",\n\t\t \"city\": \"Ville 2\",\n\t\t \"cell_phone\": \"0612345678\",\n\t\t \"email\": \"john.doe@calindasoftware.com\",\n\t\t \"signature_mode\": 11,\n \"transport_mode\": 2\n\t\t},\n\t\t{\n\t\t \"recipient_id\": 293,\n\t\t \"signature_mode\": 11\n\t\t}\n\t ]\n\t}","type":"text","description":"- An array of RecipientWithMode objects (please refer to the RecipientWithmode schema at the bottom of this page)\n- The create vs update recipient rules apply (please refer to POST /recipients)\n- `signature_mode` is mandatory\n"},{"key":"pdfparts","type":"file","src":"/C:/Users/olivm/Documents/Source/QA API Swagger/billet.pdf"},{"key":"appendixparts","value":"[\"veniam ad in\",\"amet velit veniam\"]","type":"text","disabled":true}]},"url":{"raw":"{{baseUrl}}/contracts/allinone?start=false","host":["{{baseUrl}}"],"path":["contracts","allinone"],"query":[{"key":"start","value":"false","description":"If set to true, the contract will be sent for signature"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"recipients\": [\r\n {\r\n \"id\": 295,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"John\",\r\n \"lastname\": \"Doe\",\r\n \"address_1\": \"Adresse 1 2 3\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"75001\",\r\n \"city\": \"Ville 2\",\r\n \"phone\": \"\",\r\n \"email\": \"john.doe@calindasoftware.com\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"\",\r\n \"country\": \"\",\r\n \"cell_phone\": \"0612345678\",\r\n \"birthdate\": 0,\r\n \"birthplace\": \"\"\r\n },\r\n {\r\n \"id\": 293,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"Arthur\",\r\n \"lastname\": \"Dent\",\r\n \"address_1\": \"Adresse 1 2\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"75001\",\r\n \"city\": \"Ville 2\",\r\n \"phone\": \"\",\r\n \"email\": \"arthur.dent@calindasoftware.com\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"\",\r\n \"country\": \"\",\r\n \"cell_phone\": \"0612345678\",\r\n \"birthdate\": 0,\r\n \"birthplace\": \"\"\r\n }\r\n ],\r\n \"recipientForcontract\": [\r\n {\r\n \"recipient_for_contract_id\": 587,\r\n \"contract_id\": 492,\r\n \"recipient_id\": 295,\r\n \"signature_mode\": 11,\r\n \"signature_status\": \"NONE\",\r\n \"rank\": 1,\r\n \"message_title\": \"\",\r\n \"message_body\": \"\",\r\n \"signature_id\": \"\",\r\n \"transport_mode\": 2\r\n },\r\n {\r\n \"recipient_for_contract_id\": 588,\r\n \"contract_id\": 492,\r\n \"recipient_id\": 293,\r\n \"signature_mode\": 11,\r\n \"signature_status\": \"NONE\",\r\n \"rank\": 2,\r\n \"message_title\": \"\",\r\n \"message_body\": \"\",\r\n \"signature_id\": \"\",\r\n \"transport_mode\": 1\r\n }\r\n ],\r\n \"contract\": {\r\n \"contract_id\": 492,\r\n \"date\": 1648459381041,\r\n \"document_token\": \"\",\r\n \"vendor_email\": \"admin@calindasoftware.com\",\r\n \"closed\": false,\r\n \"status\": \"OPEN\",\r\n \"contract_definition_id\": 1,\r\n \"message_title\": \"Here is your contract\",\r\n \"message_body\": \"We are pleased to sen you your contract ...\",\r\n \"name\": \"my_first_contract.pdf\",\r\n \"keep_on_move\": false,\r\n \"closed_date\": 0,\r\n \"canceled_reason\": \"\",\r\n \"version_number\": 0,\r\n \"size\": -1,\r\n \"auto_close\": 0,\r\n \"deleted\": 0,\r\n \"perimeters\": [\r\n \"pilote\"\r\n ]\r\n },\r\n \"pdfparts\": [\r\n {\r\n \"id\": 474,\r\n \"rank\": 0,\r\n \"has_smart_field\": false,\r\n \"size\": -1,\r\n \"filename\": \"billet.pdf\"\r\n }\r\n ],\r\n \"appendixparts\": []\r\n}"}],"_postman_id":"20f18ac8-cda0-4a7e-8854-1066760ae9f9"}],"id":"dc80578c-a04e-4f7f-853d-8fef58e5ca5c","auth":{"type":"apikey","apikey":{"key":"To initiate the electronic signature process, you must first create a contract. The contract is a software object that allows you to bring together the following components:
\nThe contract object contains information about the contract issuer and the context of the electronic signature transaction.
\nIn the POST /contracts request body, the only required field is the contract name with a .pdf extension. This is used to name the signed PDF document.
\nYou can provide a contract_definition_id to select a contract type (ad hoc, bundle, etc.). If you do not provide a contract_definition_id, the ad hoc contract type will be selected by default.
\nWhen the chosen signature mode is ‘remote’ (see the Add document to a contract section), the contract signatories receive an email with a link to the contract signature page. When you create a contract, you can customize both the title (message_title) and body (message_body) of the email.
\nBy default, once all signatories have signed the contract, the document must be countersigned by the license owner. Once countersigned, a proof file for the contract is created and sealed, and the contract is archived. We call this process ‘contract validation’.
\nThe auto-close member in the body of the request allows you to toggle between an automatic validation mode and a manual validation mode. If auto_close is set to ‘0’ (manual validation mode), a GET /contracts/{id}/transaction/close request must be sent to validate the contract (see the Contract lifecycle management section) .
\nPS : If you want to perform sequential signing, you need to include the member \"sequential\" and set it to true .
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"The oodrive_sign application maintains a recipient (or signatory) database. Before sending a contract for signature, you must include recipients.
\nEach time you create a new contract, you have the option to select an existing recipient, or create a new one.
\nThe POST /recipient endpoint allows you to create a recipient or update an existing recipient.
\nBy default, the recipient primary key is composed of the firstname, lastname, email and company_name (email and company_name can be empty). If the information provided to this endpoint matches an existing recipient primary key, the recipient is updated. Otherwise, a new recipient is created. You can also update a recipient by providing an existing recipient ID and modifying the other fields accordingly.
\nWhile there are no required fields in the POST /recipient request body (for more information, please refer to the Advanced features section), depending on your license configuration, certain recipient fields may be required (firstname, lastname and email by default). Before sending a contract for signature, you must ensure that you have either completed all required fields for your recipients or that you have configured the fields to be completed by the recipient. Otherwise, you will receive an error when sending the contract for signature.
\n","urlObject":{"path":["recipients"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"a4ac28c0-4f91-45c6-a10b-9d75e2680770","name":"Create or update a recipient Copy","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"j_token","value":"{{apiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"civility\": \"MADAME\",\n \"firstname\": \"Ada\",\n \"lastname\": \"Lovelace\",\n \"address_1\": \"Trafalgar Square\",\n \"postal_code\": \"do\",\n \"city\": \"London\",\n \"cell_phone\": \"+2123456789065\",\n \"email\": \"ada@lovelace.com\",\n \"country\": \"United Kingdom\",\n \"address_2\": \"\",\n \"company_name\": \"\",\n \"phone\": \"\",\n \"job_title\": \"p\",\n \"birthdate\": 0,\n \"birthplace\": \"\",\n \"custom_properties\": [\n {\n \"key\": \"custom\",\n \"value\": \"reprehenderit\"\n }\n ],\n \"perimeters\": [\"pilote\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/recipients"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 25678,\r\n \"civility\": \"MADAME\",\r\n \"firstname\": \"Ada\",\r\n \"lastname\": \"Lovelace\",\r\n \"address_1\": \"Trafalgar Square\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"do\",\r\n \"city\": \"London\",\r\n \"phone\": \"\",\r\n \"email\": \"ada@lovelace.com\",\r\n \"job_title\": \"p\",\r\n \"company_name\": \"\",\r\n \"country\": \"United Kingdom\",\r\n \"cell_phone\": \"+2123456789065\",\r\n \"birthdate\": 0,\r\n \"birthplace\": \"\",\r\n \"custom_properties\": [\r\n {\r\n \"id\": 183,\r\n \"key\": \"custom\",\r\n \"value\": \"reprehenderit\",\r\n \"contractor_id\": 25678,\r\n \"sync_timer\": 1635414049711,\r\n \"last_modification_place\": \"SERVER\"\r\n }\r\n ],\r\n \"perimeters\": [\r\n \"pilote\"\r\n ]\r\n}"}],"_postman_id":"d20fb431-76b7-40b2-b6a7-8b49c093b2b3"},{"name":"Patch recipient informations","id":"f17c95ae-76f3-4174-8c0b-37cd83747ddd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{j_token(OodrivePresales)}}","key":"This endpoint allows you to update recipient information even if he is involve into some transactions.
\nIf email or cell phone number is updated, you can choose to propagate or not the new information to all runing transactions suing the query string \"propagate\".
\n","urlObject":{"path":["recipients"],"host":["{{baseurl}}"],"query":[{"description":{"content":"If set to true and email adress or cell phone number updated on recipient informations, a notification email/SMS will be resend to recipient for all runing transactions. If set to false, only recipient information is updated and new data will be avaiable for future new contracts.
\n","type":"text/plain"},"key":"propagate","value":"true"}],"variable":[]}},"response":[{"id":"540657e9-dba6-4034-bb2b-82bcfd90e20a","name":"Update a recipient and possibly resend a notification email/SMS","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 2107***,\r\n \"firstname\": \"Catherine\",\r\n \"lastname\": \"LAFONT\",\r\n \"email\": \"***.****@oodrive.com\",\r\n \"cell_phone\": \"*******2820\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseurl}}/recipients?propagate=true","host":["{{baseurl}}"],"path":["recipients"],"query":[{"key":"propagate","value":"true","description":"If set to true and email adress or cell phone number updated on recipient informations, a notification email/SMS will be resend to recipient for all runing transactions. If set to false, only recipient information is update ans will be avaiable for next new contracts."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Jul 2023 10:51:28 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"451"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"patch\": {\n \"id\": 2107***,\n \"firstname\": \"Catherine\",\n \"lastname\": \"LAFONT\",\n \"email\": \"***.***@oodrive.com\",\n \"cell_phone\": \"******2820\"\n },\n \"result\": {\n \"id\": 2107***,\n \"civility\": \"MADAME\",\n \"firstname\": \"Catherine\",\n \"lastname\": \"LAFONT\",\n \"phone\": \"*******\",\n \"email\": \"***h@oodrive.com\",\n \"city\": \"Toulouse\",\n \"country\": \"France\",\n \"birthdate\": 1454626800000,\n \"birthplace\": \"Toulouse\",\n \"localisation\": \"fr_FR\",\n \"cell_phone\": \"*******\",\n \"address_1\": \"Rue des bergers\",\n \"address_2\": \"Rue de la fontaine\",\n \"postal_code\": \"25001\",\n \"company_name\": \"OOLAB\",\n \"job_title\": \"Product Owner\"\n },\n \"propertiesUpdated\": [\n {\n \"entity\": \"contractor\",\n \"fieldname\": \"actor_id\",\n \"oldValue\": 1913749,\n \"newValue\": 1218825\n },\n {\n \"entity\": \"contractor\",\n \"fieldname\": \"email\",\n \"oldValue\": \"*****.****@***tonmail.com\",\n \"newValue\": \"****.***@oodrive.com\"\n }\n ],\n \"communicationDoneAgain\": [\n {\n \"contractId\": 5335710,\n \"cfcId\": 6706611\n }\n ]\n}"}],"_postman_id":"f17c95ae-76f3-4174-8c0b-37cd83747ddd"},{"name":"Upload documents to a contract","id":"1b3ec1a2-d435-4dd8-93ef-6318127612ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/C:/Users/olivm/Documents/QA API Swagger/billet.pdf"}]},"url":"{{baseUrl}}/contracts/:id/documents/","description":"You can upload a document to include in a contract by calling the POST /contracts/{id}/documents endpoint. If you call this endpoint multiple times with the same contract ID, all corresponding documents will be combined into a single contract document.
\nPlease note: contract files must be saved in PDF format.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The the contract id
\n","type":"text/plain"},"type":"any","value":"494","key":"id"}]}},"response":[{"id":"06f47722-efe4-418f-b432-d7648bb9aebe","name":"Add documents to a contract","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"j_token","value":"{{apiToken}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","value":"[\"nulla labore ut sed\",\"magna ipsum est pariatur\"]","type":"text"}]},"url":{"raw":"{{baseUrl}}/contracts/:id/documents/","host":["{{baseUrl}}"],"path":["contracts",":id","documents",""],"variable":[{"key":"id","value":"5652925","description":"(Required) The the contract id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 25363,\r\n \"rank\": 0,\r\n \"has_smart_field\": false,\r\n \"size\": -1,\r\n \"filename\": \"billet.pdf\"\r\n }\r\n]"}],"_postman_id":"1b3ec1a2-d435-4dd8-93ef-6318127612ec"},{"name":"Add attachments to a contract","id":"c286b0fc-fb88-418b-a45d-7cb589288808","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"contract_definition_id","value":"1911","type":"text","description":"provided in your \"Définition des variables de votre environnement\" doc.\nif absent will default to pdfadhoc contract definition id
\n"},{"key":"option_definition_name","value":"consecte","type":"text","description":"fill it in with specific option_definition_name if needed
\n","disabled":true},{"key":"file","type":"file","src":"/C:/Users/olivm/Documents/QA API Swagger/splitted-1.pdf"}]},"url":"{{baseUrl}}/contracts/:id/appendices/","description":"You can add attachments to a contract by calling the POST /contracts/{id}/appendices endpoint. Attachments will be included in the proof file for the contract but will not be signed.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The contract Id
\n","type":"text/plain"},"type":"any","value":"494","key":"id"}]}},"response":[{"id":"2aafb355-86db-43b2-b070-bf1764f9641a","name":"Add attachments to a contract","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"j_token","value":"{{apiToken}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"contract_definition_id","value":"1911","type":"text","description":"provided in your \"Définition des variables de votre environnement\" doc.\nif absent will default to pdfadhoc contract definition id\n"},{"key":"option_definition_name","value":"consecte","type":"text","description":"fill it in with specific option_definition_name if needed\n","disabled":true},{"key":"file","type":"file","src":"/C:/Users/olivm/Documents/Source/QA API Swagger/splitted-1.pdf"}]},"url":{"raw":"{{baseUrl}}/contracts/:id/appendices/","host":["{{baseUrl}}"],"path":["contracts",":id","appendices",""],"variable":[{"key":"id","value":"41320","description":"(Required) The contract Id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 11767,\r\n \"option_id\": 182607,\r\n \"filename\": \"splitted-1.pdf\",\r\n \"content_type\": \"application/pdf\"\r\n }\r\n]"}],"_postman_id":"c286b0fc-fb88-418b-a45d-7cb589288808"},{"name":"Add recipients to a contract","id":"674016a8-0311-4ebb-87f4-572dfc211bbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"The POST /contracts/{id}/recipients endpoint attaches recipients (signatories) to the contract. Since the request body is an array, you can attach multiple recipients to one contract with a single API call.
\nThe request body required fields are the recipient_id and the signature_mode. The following table presents the available signature modes and corresponding signature_mode codes.
\nFor all signature modes except SMS modes, the default notification is sent by email.
\nPlease note: For face-to-face signature modes, recipients will only be notified by email at the end of the transaction.
\nPS : In order to perform sequential signing, you need to specify the sequential order of your recipients using the \"seq_order\" member, followed by the desired number. For example, for the first recipient, set \"seq_order\" to 1, and for the second recipient, set \"seq_order\" to 2.
\nNew The Avanced and Qualified Electronic signature modes are now available. These modes imply identity verification for the signatories.
To perform a Advanced Electronic Signature (AES), please choose an AES signature_mode (18, 19 or 20). AES contains 2 types of identity verification. The type of identity verification is defined by the pvid_identity_level request member :
pvid_identity_level = 2 -> video ID (original) verification
\npvid_identity_level = 3 -> video ID (original) verification + face recognition + liveness detection
\nTo perform a Qualified Electronic Signature (QES), choose a QES signature_mode (25, 26 or 27) and set the pvid_identity_level to 4 (video ID (original) verification + face recognition + liveness detection + human control of the identification video).
\nIf you add validators to your contracts, the validators will be invited to validate the contract one after another. The contract will be sent for signature only after validation by each validator.
\nRequests to sign are sent simultaneously, so recipients can sign the contract at the same time.
\nCopied recipients do not sign the contract. They receive an email notification when the contract is sent for signature, and when the contract is validated.
\nWith the message_title and message_body request body members, you can customize the notification email title and body (this will override the custom message title and custom message body defined at the contract level).
\nThe transport_mode request body member defines the signatory notification method (additional notification) :
\nnotification by email
\nnotification by SMS
\nnotification by email and SMS
\nThe transport_mode default value is 1.
\nNB: In order to use the signature modes \" 18,19,20,25,26 and 27\" , you may need to reach out our support team : support-sign@oodrive.com .
\n","urlObject":{"path":["contracts",":id","recipients",""],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"(Required) The contract id
\n","type":"text/plain"},"type":"any","value":"1942","key":"id"}]}},"response":[{"id":"05c29465-9a81-42cd-973a-90d160f23805","name":"Add recipients to a contract","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"j_token","value":"{{apiToken}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"recipient_id\": 41,\n \"signature_mode\": 19,\n \"pvid_identity_level\": 1,\n \"smartrole\": \"roleA\"\n },\n {\n \"recipient_id\": 92,\n \"signature_mode\": 11\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/contracts/:id/recipients/","host":["{{baseUrl}}"],"path":["contracts",":id","recipients",""],"variable":[{"id":"507ff965-4104-4777-bccd-4af51cbc6371","key":"id","value":"3199592","description":"(Required) The contract id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"recipient_for_contract_id\": 1915,\r\n \"contract_id\": 1942,\r\n \"recipient_id\": 41,\r\n \"signature_mode\": 19,\r\n \"signature_status\": \"NONE\",\r\n \"rank\": 1,\r\n \"message_title\": \"\",\r\n \"message_body\": \"\",\r\n \"signature_id\": \"\",\r\n \"transport_mode\": 1,\r\n \"pvid_identity_level\": 1,\r\n \"pvid_last_modification_identification_status\": 1655817290244,\r\n \"smartrole\": \"roleA\"\r\n },\r\n {\r\n \"recipient_for_contract_id\": 1916,\r\n \"contract_id\": 1942,\r\n \"recipient_id\": 92,\r\n \"signature_mode\": 11,\r\n \"signature_status\": \"NONE\",\r\n \"rank\": 1,\r\n \"message_title\": \"\",\r\n \"message_body\": \"\",\r\n \"signature_id\": \"\",\r\n \"transport_mode\": 1\r\n }\r\n]"}],"_postman_id":"674016a8-0311-4ebb-87f4-572dfc211bbd"}],"id":"60ae7991-0bd5-458e-8276-3e7c36a8f4a4","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"To send a contract for signature, you must call the /contracts/{id}/transaction/start endpoint.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The contract id
\n","type":"text/plain"},"type":"any","value":"41482","key":"id"}]}},"response":[{"id":"756ed7bb-636b-498c-b7a3-502193824a25","name":"Send a contract for signature","originalRequest":{"method":"POST","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/contracts/:id/transaction/start","host":["{{baseUrl}}"],"path":["contracts",":id","transaction","start"],"variable":[{"key":"id","value":"41479","description":"(Required) The contract id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"transaction_id\": \"signparty:20835\",\r\n \"is_closed\": false,\r\n \"contract_name\": \"my_first_contract.pdf\",\r\n \"status\": \"OPEN\"\r\n}"}],"_postman_id":"eba76b19-06d6-4bbf-bfa3-fd89a6f3c53b"},{"name":"Resend signature requests","id":"6179ea04-7944-4cc2-92a3-2e80e5271f58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/contracts/:id/transaction/recipients/:cfc_id/relaunch","description":"If your contract’s recipient signature mode is ‘remote’ (i.e. the recipient is sent an email containing a link to the signature page), you can resend the signature request email by calling: GET/contracts/{id}/transaction/recipients/{cfc_id}/relaunch, where cfc_id is the recipient_for_contract_id.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The contract id
\n","type":"text/plain"},"type":"any","value":"41479","key":"id"},{"description":{"content":"(Required) The recipientsForContract id
\n","type":"text/plain"},"type":"any","value":"50991","key":"cfc_id"}]}},"response":[{"id":"5f8def1f-f770-48e6-8a86-0b99ceab4170","name":"Resend signature requests","originalRequest":{"method":"GET","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/contracts/:id/transaction/recipients/:cfc_id/relaunch","host":["{{baseUrl}}"],"path":["contracts",":id","transaction","recipients",":cfc_id","relaunch"],"variable":[{"key":"id","value":"41479","description":"(Required) The contract id"},{"key":"cfc_id","value":"50991","description":"(Required) The *recipientsForContract* id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"succeed\": true\r\n}"}],"_postman_id":"6179ea04-7944-4cc2-92a3-2e80e5271f58"},{"name":"Resend all the signature requests","id":"aeb051b6-3d1f-4272-8804-001466b48528","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/contracts/:id/transaction/recipients/relaunch","description":"If multiple recipients are in remote signature mode, you can resend the request to sign to all recipients by calling GET /contracts/{id}/transaction/recipients/relaunch.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The contract Id
\n","type":"text/plain"},"type":"any","value":"41479","key":"id"}]}},"response":[{"id":"c98e30d6-3085-4c64-ac24-6bdf761653b8","name":"Resend all the signature requests","originalRequest":{"method":"GET","header":[{"key":"j_token","value":"{{api_token}}","type":"text"}],"url":{"raw":"{{baseUrl}}/contracts/:id/transaction/recipients/relaunch","host":["{{baseUrl}}"],"path":["contracts",":id","transaction","recipients","relaunch"],"variable":[{"key":"id","value":"41479","description":"(Required) The contract Id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"succeed\": true\r\n}"}],"_postman_id":"aeb051b6-3d1f-4272-8804-001466b48528"},{"name":"Stop a contract transaction","id":"80cbeb1a-bf8b-43a9-b569-37d2c0a06ded","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/contracts/:id/transaction/stop?force=false","description":"When a contract has been sent for signature, it necessary to stop the contract transaction before being able to modify the contract document and/or signatories.
\nThis API call stops the transaction.
\nPlease note: if signatories have already signed the contract when you stop the transaction, these signatures are withdrawned. When the contract is resent for signature, all signatories receive a new notification and have to sign the new version of the contract. The force query string parameter must be set to true in order to stop the transaction of a contract that have already been signed by a least one signatory.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"Force transaction close even if signatories have already signed
\n","type":"text/plain"},"key":"force","value":"false"}],"variable":[{"description":{"content":"(Required) The contract Id
\n","type":"text/plain"},"type":"any","value":"42475","key":"id"}]}},"response":[{"id":"7cbef99f-c46f-4b0e-a112-bdb6a24ba42a","name":"Stop a contract transaction Copy","originalRequest":{"method":"GET","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/contracts/:id/transaction/stop?force=false","host":["{{baseUrl}}"],"path":["contracts",":id","transaction","stop"],"query":[{"key":"force","value":"false","description":"Force transaction close even if signatories have already signed"}],"variable":[{"key":"id","value":"42475","description":"(Required) The contract Id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"Succeed\": true\r\n}"}],"_postman_id":"80cbeb1a-bf8b-43a9-b569-37d2c0a06ded"},{"name":"Withdraw a contract","id":"7be46006-50b7-4929-ab5b-b76fe5644d55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"no specific reason\"\n}"},"url":"{{baseUrl}}/contracts/:id/transaction/cancel","description":"The /contracts/{id}/transaction/cancel cancels a contract. When canceled, the contract’s status switches to ‘ABANDONED’, the recipients can no longer sign it and no proof file is created. However, the contract and its history remain in our systems.
\nPlease note: once abandoned, a contract cannot be reused.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The contract Id
\n","type":"text/plain"},"type":"any","value":"41479","key":"id"}]}},"response":[{"id":"4163c826-2112-4063-8286-0a1ede36241a","name":"Withdraw a contract","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"j_token","value":"{{apiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"no specific reason\"\n}"},"url":{"raw":"{{baseUrl}}/contracts/:id/transaction/cancel","host":["{{baseUrl}}"],"path":["contracts",":id","transaction","cancel"],"variable":[{"id":"88329cf0-5286-468e-842f-2fe1e60dcd13","key":"id","value":"-56529255","description":"(Required) The contract Id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"Succeed\": true\r\n}"}],"_postman_id":"7be46006-50b7-4929-ab5b-b76fe5644d55"},{"name":"Validate (countersign) a contract","id":"c245883d-0765-4fb7-b160-bef344150ef2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/contracts/:id/transaction/close?force=true","description":"The /contracts/{id}/transaction/close endpoints validate a contract. This means that the contract is countersigned (i.e., signed by the contract issuer) and sealed. The contract status switches to ‘VALIDATED’, then ‘ARCHIVED’ and the proof file for the contract is created.
\nYou can validate a contract even if all signatories have not yet signed. To do so, you must set the force query string parameter to true.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"Force the contract validation if some signatories have not signed yet (or have refused to sign)
\n","type":"text/plain"},"key":"force","value":"true"}],"variable":[{"description":{"content":"(Required) The id
\n","type":"text/plain"},"type":"any","value":"41481","key":"id"}]}},"response":[{"id":"da937bd9-772d-473e-9b85-99a5eeb7b39b","name":"Validate (countersign) a contract Copy","originalRequest":{"method":"GET","header":[{"key":"j_token","value":"{{api_token}}","type":"text"}],"url":{"raw":"{{baseUrl}}/contracts/:id/transaction/close?force=false","host":["{{baseUrl}}"],"path":["contracts",":id","transaction","close"],"query":[{"key":"force","value":"false","description":"Force the contract validation if some signatories have not signed yet (or have refused to sign)"}],"variable":[{"key":"id","value":"-56529255","description":"(Required) The id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"date\": \"2021-09-28T17:25:28.104+0200\",\r\n \"id\": \"signparty:20836\",\r\n \"status\": \"NONE\"\r\n}"}],"_postman_id":"c245883d-0765-4fb7-b160-bef344150ef2"},{"name":"Check the status of a contract","id":"fe092c9a-f80c-40e9-a954-a5a42e796100","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/contracts/:id/transaction/","description":"To check the status of a contract, call GET /contracts/{id}/transaction. The endpoint returns an object containing the status. The possible status values are: OPEN, CLOSED,SIGNED, ARCHIVED and ABANDONED.
\nOPEN = The contract has been prepared but is not yet signed. Either it has not been presented for signature yet, or it is awaiting the signature of one or more remote signers.
\nCLOSED = This is the same status as \"ARCHIVED\", but in the case of legal archiving. You are not concerned with this status.
\nSIGNED = The signers have already signed the document, but the counter-signature from the legal entity has not yet been completed. If the auto-close member is set to 0, the counter-signature will not be executed automatically. If you want to execute the counter-signature automatically, you can set the auto-close member to 1. In this case, the document status will automatically be changed to ARCHIVED.
\nARCHIVED = When the contract is signed by both parties (signer and legal entity), it automatically transitions to the \"ARCHIVED\" status.
\nABANDONED = The contract has been abandoned, either manually by a user with the appropriate rights (when you call this endpoint to abandon a contract: POST/contracts/{id}/transaction/cancel), or because the maximum signing deadline has expired (by default, 60 days).
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The contract id
\n","type":"text/plain"},"type":"any","value":"41481","key":"id"}]}},"response":[{"id":"7df90d59-966e-412d-a027-60c0b5816eb6","name":"Check a contract's status","originalRequest":{"method":"GET","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/contracts/:id/transaction/","host":["{{baseUrl}}"],"path":["contracts",":id","transaction",""],"variable":[{"id":"fe4b33ea-fa83-493e-94a6-043b4877cc16","key":"id","value":"-56529255","description":"(Required) The contract id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"transaction_id\": \"signparty:20836\",\r\n \"is_closed\": false,\r\n \"contract_name\": \"my_first_contract.pdf\",\r\n \"status\": \"ARCHIVED\"\r\n}"}],"_postman_id":"fe092c9a-f80c-40e9-a954-a5a42e796100"},{"name":"Check the status of a signature","id":"7350a954-52df-47a5-b45f-e5f1f76ceac2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/contracts/:id/transaction/recipients","description":"To know whether a contract’s recipients have signed, declined to sign or have not yet signed, you can call GET /contracts/{id}/transaction/recipients. This endpoint returns an array containing the signature status for each recipient (SENT, SIGNED).
\nIf a recipient declined to sign, his signature_status value is 'SENT', has_refusals is set to true and the refusal date and refusal reason (message) appear in the last-refusal_date and last_refusal_message members of the response.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The contract id
\n","type":"text/plain"},"type":"any","value":"42151","key":"id"}]}},"response":[{"id":"1ca07235-9390-4673-b53b-e338b77c1b68","name":"Check signatures statuses","originalRequest":{"method":"GET","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/contracts/:id/transaction/recipients","host":["{{baseUrl}}"],"path":["contracts",":id","transaction","recipients"],"variable":[{"key":"id","value":"42151","description":"(Required) The contract id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"recipient_for_contract_id\": 51873,\r\n \"contract_id\": 42151,\r\n \"recipient_id\": 21721,\r\n \"signature_mode\": 11,\r\n \"signature_status\": \"SIGNED\",\r\n \"signature_date\": 1635269224676,\r\n \"rank\": 1,\r\n \"message_title\": \"\",\r\n \"message_body\": \"\",\r\n \"signature_id\": \"33872\",\r\n \"smartrole\": \"\",\r\n \"has_refusals\": false\r\n },\r\n {\r\n \"recipient_for_contract_id\": 51874,\r\n \"contract_id\": 42151,\r\n \"recipient_id\": 19993,\r\n \"signature_mode\": 11,\r\n \"signature_status\": \"SENT\",\r\n \"signature_date\": 1635269097809,\r\n \"rank\": 2,\r\n \"message_title\": \"\",\r\n \"message_body\": \"\",\r\n \"signature_id\": \"33873\",\r\n \"smartrole\": \"\",\r\n \"has_refusals\": false\r\n },\r\n {\r\n \"recipient_for_contract_id\": 51875,\r\n \"contract_id\": 42151,\r\n \"recipient_id\": 21171,\r\n \"signature_mode\": 11,\r\n \"signature_status\": \"SIGNED\",\r\n \"signature_date\": 1635269290366,\r\n \"rank\": 3,\r\n \"message_title\": \"\",\r\n \"message_body\": \"\",\r\n \"signature_id\": \"33874\",\r\n \"smartrole\": \"\",\r\n \"has_refusals\": true,\r\n \"last_refusal_date\": 1635269159734,\r\n \"last_refusal_message\": \"Le signataire 'john doe' a refusé de signer.\"\r\n }\r\n]"}],"_postman_id":"7350a954-52df-47a5-b45f-e5f1f76ceac2"}],"id":"edb5e9f5-c009-4b6a-a330-9ad7a2e990a3","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"This API call defines a set of automatic chase up rules for a given signatory (actually, for a given recipient for contract).
\nThe API call parameters are the follwing:
\n","urlObject":{"path":["contracts","recipients",":cfc_id","autochaseuprules"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"5821182","key":"cfc_id"}]}},"response":[{"id":"c09799f9-c8f5-452f-8198-a772a7a3fc8d","name":"Define chase up rules","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"j_token","value":"{{apiToken}}","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"content_title\": \"reminder email title\",\r\n \"content_message\": \"reminder email body\",\r\n \"event_trigger\": \"CFC_SENT\",\r\n \"transport_mode\": \"EMAIL\",\r\n \"approximate_hour\": 9,\r\n \"iteration\": 3,\r\n \"cycle\": 5,\r\n \"cycle_unit\": \"DAYS\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/contracts/recipients/:cfc_id/autochaseuprules","host":["{{baseUrl}}"],"path":["contracts","recipients",":cfc_id","autochaseuprules"],"variable":[{"key":"cfc_id","value":"5821182"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"rule_id\": 27911,\r\n \"cfc_id\": 5821182,\r\n \"content_title\": \"reminder email title\",\r\n \"content_message\": \"reminder email body\",\r\n \"event_trigger\": \"CFC_SENT\",\r\n \"transport_mode\": \"EMAIL\",\r\n \"approximate_hour\": 9,\r\n \"cycle\": 5,\r\n \"cycle_unit\": \"DAYS\",\r\n \"iteration\": 3\r\n }\r\n]"}],"_postman_id":"a41849de-b180-4bf1-9dfd-e04c4d922244"},{"name":"List chase up rules","id":"f79e76e8-b807-4d6f-8950-92852581daa7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/contracts/:id/autochaseuprules","urlObject":{"path":["contracts",":id","autochaseuprules"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"4595225","key":"id"}]}},"response":[{"id":"640deaf2-52d6-4efc-abab-cfa8f253b9de","name":"List chase up rules","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","type":"text"},{"key":"j_token","value":"{{api_token}}","type":"text"}],"url":{"raw":"{{baseUrl}}/contracts/:id/autochaseuprules?offset=0&size=20","host":["{{baseUrl}}"],"path":["contracts",":id","autochaseuprules"],"query":[{"key":"cfc_id","value":null,"type":"text","disabled":true},{"key":"offset","value":"0","type":"text"},{"key":"size","value":"20","type":"text"}],"variable":[{"key":"id","value":"4595225"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"recipient_for_contract_id\": 5821182,\r\n \"recipient\": {\r\n \"recipient_id\": 2788758,\r\n \"first_name\": \"Patrick\",\r\n \"last_name\": \"MARCHAND\",\r\n \"email\": \"k.salah@oodrive.com\",\r\n \"company_name\": \"\",\r\n \"phone\": \"0757942820\"\r\n },\r\n \"rules\": [\r\n {\r\n \"rule_id\": 27911,\r\n \"content_title\": \"reminder email title\",\r\n \"content_message\": \"reminder email body\",\r\n \"approximate_hour\": 9,\r\n \"transport_mode\": \"EMAIL\",\r\n \"event_trigger\": \"CFC_SENT\",\r\n \"iteration\": 3,\r\n \"cycle\": 5,\r\n \"cycle_unit\": \"DAYS\",\r\n \"status\": \"SCHEDULED\",\r\n \"policy\": {\r\n \"id\": 7511,\r\n \"name\": \"auto_5821182_1678904047468\"\r\n }\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"f79e76e8-b807-4d6f-8950-92852581daa7"}],"id":"4f0eb20f-9f1b-4943-9535-b5e7bf0b687e","description":"The Oodrive sign solution allows to automatically send signature reminders to signatories. The signatures reminders policies take the form of rules defined for each signatory of a contract. Multiples rules can be active simultenaously for each signatory.
\nPlease note: remider rules must be set up before starting the contract ransaction.
\n","_postman_id":"4f0eb20f-9f1b-4943-9535-b5e7bf0b687e"},{"name":"Arranging recipients information on documents","item":[{"name":"Ranks","item":[],"id":"cecb9e5e-eaa9-4970-a99c-0f9ca1849379","description":"When you send a contract for signature by multiple signatories, they are sent the request to sign simultaneously. However, when collecting contract information, the signatory whose signature mode is set to 6 (or 12) will always be asked to sign first, since they are modifying the content of the contract.
\nSignatories are assigned signature ranks internally. Ranking allows you to link Smartfields® to signatories and also determines the place in which recipient information can be found on the contract. For example, if you want to ensure that the second signatory’s signature displays in a specific area of the document, you must indicate this placement using the [sc_sing2.signature/] smartfield.
\nBy default, ranks are automatically assigned to signatories. A signatory’s rank corresponds to the signatory’s position in the array passed to the POST /contracts/{id}/recipients API call.
\nYou can modify this behavior by setting the signatories ranks in the POST /contracts/{id}/recipients request’s body. If you do so, you must ensure that the ranks have values greater than 0 and that there are no doubles in your set of rank values.
\n","_postman_id":"cecb9e5e-eaa9-4970-a99c-0f9ca1849379"},{"name":"Smart roles","item":[],"id":"0261ff87-a53b-4355-a9d2-cfc6a829831e","description":"Smart roles give you additional control over the position of recipients’ information on the contract document. You can reference a given recipient’s information with the recipient’s role name, provided that you gave your recipient a role when you created it: for example, [sc_sign.role1.signature/].
\nTo assign smart roles to recipients, you put a Smartrole member in the POST /contracts/{id}/recipients API call. You can retrieve recipient roles by sending a GET /contracts/{id}/recipients API call (there will be a smartrole member in each ‘recipient for contract’ object).
\nThis is useful if you do not want to manage the recipient ranks yourself, or if you want to ensure that a given Smartfield will continue to reference the same signatory even if there is a change in rank.
\n","_postman_id":"0261ff87-a53b-4355-a9d2-cfc6a829831e"}],"id":"230cf9c6-7ae9-4c12-b570-42488df743a3","_postman_id":"230cf9c6-7ae9-4c12-b570-42488df743a3","description":""},{"name":"Signing multiple contracts at once","item":[{"name":"Create a bundle","id":"9444955e-2c7f-42c1-a90a-d32b0627e497","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contract_id\": 41463,\n \"same_signatories\": true,\n \"perimeters\": [\n \"one perimeter\"\n ]\n}"},"url":"{{baseUrl}}/bundle","description":"To create a bundle, you must:
\nThe bundle contracts may differ between signatory lists. If this is the case, you must set the request’s body member same_signatories to false.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"You can then create subsequent contracts, without sending them for signature, an add them to the bundle by sending a POST /bundle/{id}/contract API call for each contract.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The bundle Id
\n","type":"text/plain"},"type":"any","value":"8983","key":"id"}]}},"response":[{"id":"b2d00b15-7665-4782-9cff-d42dddc595c1","name":"Add a contract to a bundle","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"j_token","value":"{{apiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"contract_id\": 41484,\n \"perimeters\": [\n \"one perimeter\"\n ]\n}"},"url":{"raw":"{{baseUrl}}/bundle/:id/contracts","host":["{{baseUrl}}"],"path":["bundle",":id","contracts"],"variable":[{"id":"2b3423d0-2a91-4914-bc3a-513b7ce6e3a5","key":"id","value":"-56529255","description":"(Required) The bundle Id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 8994,\r\n \"actor_id\": 12114,\r\n \"contract_id\": 41484,\r\n \"status\": 0,\r\n \"master\": 0\r\n}"}],"_postman_id":"6d0ec50b-17a4-44fc-9f92-9e36ab714e33"},{"name":"List a bundle's contracts information","id":"0ab27762-2349-4624-88bb-d2b1cfe67b3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/bundle/:id/contracts?offset=0&size=100","description":"The /bundle/{id}/contracts API endpoint lists the contracts contained in the bundle.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"The sequence number of the first contract to list
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"The maximum size of the returned array
\n","type":"text/plain"},"key":"size","value":"100"}],"variable":[{"description":{"content":"(Required) The bundle Id
\n","type":"text/plain"},"type":"any","value":"8994","key":"id"}]}},"response":[{"id":"97cc31ee-8354-4724-a986-c44ef73074cc","name":"List a bundle's contracts information","originalRequest":{"method":"GET","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/bundle/:id/contracts?offset=0&size=100","host":["{{baseUrl}}"],"path":["bundle",":id","contracts"],"query":[{"key":"offset","value":"0","description":"The sequence number of the first contract to list"},{"key":"size","value":"100","description":"The maximum size of the returned array"}],"variable":[{"id":"c0d8fd59-f893-4acd-b837-d18bbc84fcf5","key":"id","value":"-56529255","description":"(Required) The bundle Id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"company_name\": \"\",\r\n \"contract_type_name\": \"selling.default_contract.signparty.adhoc.title\",\r\n \"id\": 41483,\r\n \"contract_definition_id\": 1911,\r\n \"name\": \"my_first_contract.pdf\"\r\n },\r\n {\r\n \"company_name\": \"\",\r\n \"contract_type_name\": \"selling.default_contract.signparty.adhoc.title\",\r\n \"id\": 41484,\r\n \"contract_definition_id\": 1911,\r\n \"name\": \"my_first_contract.pdf\"\r\n }\r\n]"}],"_postman_id":"0ab27762-2349-4624-88bb-d2b1cfe67b3d"},{"name":"Remove a contract from a bundle","id":"8fada1c5-6cc8-41e6-b12f-960ba04901cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{baseUrl}}/bundle/:id/contracts?contract_id=82100033","description":"The DELETE /bundle/{id}/contracts API endpoint removes a contract from a bundle.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The contract id
\n","type":"text/plain"},"key":"contract_id","value":"82100033"}],"variable":[{"id":"3205f455-9a43-41f0-9592-4051a1b60cea","description":{"content":"(Required) The bundle Id
\n","type":"text/plain"},"type":"any","value":"82100033","key":"id"}]}},"response":[{"id":"ce7c9a96-3293-4b8e-90ad-21d578645887","name":"Remove a contract from a bundle","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"j_token","value":"The /bundle/{id}/transaction/start endpoint sends a bundle for signature.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The bundle Id
\n","type":"text/plain"},"type":"any","value":"8983","key":"id"}]}},"response":[{"id":"22b93ec5-fe22-4cc6-b02c-d847038324a7","name":"Send a bundle for signature","originalRequest":{"method":"POST","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/bundle/:id/transaction/start","host":["{{baseUrl}}"],"path":["bundle",":id","transaction","start"],"variable":[{"id":"7f469c5a-d6e1-438b-a8eb-2391ba1053cb","key":"id","value":"-56529255","description":"(Required) The bundle Id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"succeed\": true\r\n}"}],"_postman_id":"ea5f38f8-38d3-41c4-9e77-4fb1bc080824"},{"name":"Stop a bundle transaction","id":"98bbf367-2b07-4cff-9f30-6736877aa064","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/bundle/:id/transaction/stop?force=false","description":"If you want to modify bundled contracts documents and/or signatories after having sent the bundle for signature, you must stop the bundle transaction first
\nWhen a contract has been sent for signature, it necessary to stop the contract transaction before being able to modify the contract document and/or signatories.
\nThis API call stops the transactions of all the bundled contracts.
\nPlease note: if signatories have already signed a contract when you stop the transaction, these signatures are withdrawned. When the contract is resent for signature, all signatories receive a new notification and have to sign the new version of the contract. The force query string parameter must be set to true in order to stop transactions of contracts that have already been signed by a least one signatory.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"Force transaction close even if signatories have already signed
\n","type":"text/plain"},"key":"force","value":"false"}],"variable":[{"id":"376a541c-987c-4d53-a1d7-1601a614c311","description":{"content":"(Required) The bundle Id
\n","type":"text/plain"},"type":"any","value":"96474","key":"id"}]}},"response":[{"id":"8d76b479-f67c-4e56-9063-933929cb067a","name":"Stop a bundle transaction","originalRequest":{"method":"GET","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/bundle/:id/transaction/stop?force=false","host":["{{baseUrl}}"],"path":["bundle",":id","transaction","stop"],"query":[{"key":"force","value":"false","description":"Force transaction close even if signatories have already signed"}],"variable":[{"id":"376a541c-987c-4d53-a1d7-1601a614c311","key":"id","value":"96474","description":"(Required) The bundle Id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"Succeed\": true\r\n}"}],"_postman_id":"98bbf367-2b07-4cff-9f30-6736877aa064"},{"name":"Withdraw a bundle","id":"d690b5fd-5790-42e2-b936-94f35895b53d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{baseUrl}}/bundle/:id/transaction/cancel","description":"The /bundle/{id}/transaction/cancel endpoint withdraws a bundle.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The bundle Id
\n","type":"text/plain"},"type":"any","value":"8994","key":"id"}]}},"response":[{"id":"0de50f3c-c1b1-4c4a-bc62-bc3421dfabdf","name":"Withdraw a bundle","originalRequest":{"method":"POST","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/bundle/:id/transaction/cancel","host":["{{baseUrl}}"],"path":["bundle",":id","transaction","cancel"],"variable":[{"key":"id","value":"8994","description":"(Required) The bundle Id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"Succeed\": true\r\n}"}],"_postman_id":"d690b5fd-5790-42e2-b936-94f35895b53d"},{"name":"Validate (countersign) contracts in a bundle","id":"60ab29fb-2c60-4540-a557-818ba97271c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/bundle/:id/transaction/close?force=true","description":"The /bundle/{id}/transaction/close endpoint validates the bundle (countersigns bundled contracts). The endpoint has a force query string parameter that may be set to true if you want to validate the bundle before all signatories have signed.
\nPlease note: This endpoint validates all contracts contained in the bundle. However, you can validate the contracts in the bundle one by one, by calling POST /contracts/{id}/transaction/close for each bundled contract.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"Force the contracts validation if some signatories have not signed yet (or have refused to sign)
\n","type":"text/plain"},"key":"force","value":"true"}],"variable":[{"description":{"content":"(Required) The bundle Id
\n","type":"text/plain"},"type":"any","value":"8983","key":"id"}]}},"response":[{"id":"e45aa52c-0f17-4614-90c2-1e4c5ca94085","name":"Validate (countersign) contracts in a bundle","originalRequest":{"method":"GET","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/bundle/:id/transaction/close?force=false","host":["{{baseUrl}}"],"path":["bundle",":id","transaction","close"],"query":[{"key":"force","value":"false","description":"Force the contracts validation if some signatories have not signed yet (or have refused to sign)"}],"variable":[{"id":"59a6666e-4002-46a7-a7bb-a5ccb3b72782","key":"id","value":"-56529255","description":"(Required) The bundle Id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"date\": \"2021-09-28T18:52:48.803+0200\",\r\n \"id\": \"signparty:20840\",\r\n \"status\": \"NONE\"\r\n },\r\n {\r\n \"date\": \"2021-09-28T18:52:48.581+0200\",\r\n \"id\": \"signparty:20971\",\r\n \"status\": \"NONE\"\r\n }\r\n]"}],"_postman_id":"60ab29fb-2c60-4540-a557-818ba97271c1"}],"id":"9d8a3fd3-8e56-4e14-a27d-f690116e93cc","description":"The bundle feature allows signatories to sign multiple contracts at once.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"Here is the description of this endpoint paramters.
\n","urlObject":{"path":["contracts",":id","transaction","signaturelink"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"e2acdec6-26ba-4f06-8afc-be093203cc97","description":{"content":"Enter here your contract_id
\n","type":"text/plain"},"type":"any","value":"{{cid_AIO}}","key":"id"}]}},"response":[{"id":"cdb4f24d-497a-43f0-a07e-ecfc8fea374f","name":"Get signature link for remote recipients","originalRequest":{"method":"GET","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"recipient_id\": 2788758,\r\n \"webhook_urls\": {\r\n \"success\": \"https://www.google.com/\",\r\n \"failure\": \"https://www.bing.com/\"\r\n },\r\n \"options\": {\r\n \"duration_in_minutes\": 15,\r\n \"hide_header\": true,\r\n \"enable_iframe\": true\r\n }\r\n}","options":{"raw":{"language":"json"}}}},"_postman_previewlanguage":"","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"signature_link\": \"https://c405d.ota.cloud.sellandsign.com/calinda/sellandsign/#/contract/4579427/sign;c_id=4579427;no_ui=true;logo=off;no_cookie=true;remote=false;refback=https%3A%2F%2Fwww.google.com%2F;errorback=https%3A%2F%2Fwww.bing.com%2F;j_token=B45388ZDRna001fHhSbk92WXhLQzZ6clVqY0FwK1J0blVxV0JIOTB3TDZXMnJBak9OaDZtcFBOTUJiVmRFUXBFY0hPUTY3SkZmdHgrcVhrcUNHZzk4a3E3K3Z4cUd6Q3dvTU4rZmJOc2RTdVNDUkJXTVZFVHhXNHRweGxYS3daV3VqeFdUdk8yVy9SVkpEMFE2T2ZjcHlhTWhsUEkyeFE4eTlZa3Qybk9Gc20yTEhEZzVGcGpDbExLMzI2NWRZK1U5KzdVQXNDYkloZjczcnI3aEwxU3dRPQ\"\r\n}"}],"_postman_id":"569cee2d-0016-4ec0-ba48-978d156a39e6"}],"id":"0232c12b-31bc-4e92-8de9-ad27bddb6120","description":"When adding electronic signature to a software package, integrators may want to replace our standard invitation to sign mechanism, which consists of sending an email containing a signature link to signatories, with their own notification system.
\nTo do so, you must:
\n* Ensure you pick a ‘face to face’ signature mode when attaching recipients to the contract (signature modes 9 or 10) if you want to prevent our system to send a notification email to the signatory
* Generate a signature link by calling POST /contracts/{id}/transaction/signaturelink endpoint.
Reminder : this API endpoint can generate signature links for 'face to face' (signature modes 9 or 10).
\nIn order to use this API endpoint you may need to reach out our support team : support-sign@oodrive.com
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"The GET /contracts/{id} endpoints finds contracts by id and returns the contract’s information.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The contract id
\n","type":"text/plain"},"type":"any","value":"41479","key":"id"}]}},"response":[{"id":"c36fa791-bcc3-4dc1-b1b4-f0fa623797d3","name":"Find a contract by Id","originalRequest":{"method":"GET","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/contracts/:id","host":["{{baseUrl}}"],"path":["contracts",":id"],"variable":[{"id":"255455a5-c048-486b-9e57-543736e0c6d6","key":"id","value":"-56529255","description":"(Required) The contract id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"contract_id\": 41479,\r\n \"date\": 1632840720875,\r\n \"document_token\": \"MTYzMjg0MDc4MTAxM180MTQ3OV84NjczMzc=\",\r\n \"vendor_email\": \"admin@calindasoftware.com\",\r\n \"closed\": false,\r\n \"status\": \"ABANDONED\",\r\n \"contract_definition_id\": 1911,\r\n \"message_title\": \"Here is your contract\",\r\n \"message_body\": \"We are pleased to sen you your contract ...\",\r\n \"name\": \"my_first_contract.pdf\",\r\n \"keep_on_move\": false,\r\n \"closed_date\": 1632842263820,\r\n \"canceled_reason\": \"Cancelled by user api user2: no specific reason\",\r\n \"version_number\": 2,\r\n \"size\": 302740,\r\n \"auto_close\": 0,\r\n \"deleted\": 0,\r\n \"perimeters\": [\r\n \"pilote\"\r\n ],\r\n \"contract_properties\": []\r\n}"}],"_postman_id":"1b7895ca-d227-4928-9e9c-65043d8a7544"},{"name":"List contracts","id":"800d7013-9506-497a-8187-e71e11775a90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/contracts?size=10&offset=0&get_properties=false&get_perimeters=false&perimeter=deserunt cupidatat&before=0&after=0","description":"The GET /contracts endpoint lists contracts. The endpoint has several filters:
\nThe endpoint also gives a certain level of control over the returned information:
\nPlease note: If your request targets a significant number of contracts, fetching the contracts’ properties and/or the contract’s perimeters will significantly increase the request response time.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"Optional - the maximum size of the returned array
\n","type":"text/plain"},"key":"size","value":"10"},{"description":{"content":"Optional - the sequence number of the first contract listed
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"if set to true, contract properties are listed in the response - Beware. If get_properties is set to true, the request response time increases a lot with the number of contracts included in the response
\n","type":"text/plain"},"key":"get_properties","value":"false"},{"description":{"content":"Optional - search contracts only in a given perimeter. If this filtering property is activated, the request response time increases a lot with the number of contracts included in the response
\n","type":"text/plain"},"key":"perimeter","value":"deserunt cupidatat"},{"disabled":true,"description":{"content":"Option - the search status of the contracts - multi selection
\n","type":"text/plain"},"key":"status","value":""},{"description":{"content":"Optional - list all contracts created before this date/time
\n","type":"text/plain"},"key":"before","value":"0"},{"description":{"content":"Optional - list all contracts created after this date/time
\n","type":"text/plain"},"key":"after","value":"0"}],"variable":[]}},"response":[{"id":"8fea9ef8-11e7-4353-b9b1-8dd9207fdaff","name":"List contracts","originalRequest":{"method":"GET","header":[{"key":"j_token","value":" {{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/contracts?size=10&offset=0&get_properties=false&get_perimeters=false&perimeter=deserunt cupidatat&status=&before=0&after=0","host":["{{baseUrl}}"],"path":["contracts"],"query":[{"key":"size","value":"10","description":"Optional - the maximum size of the returned array"},{"key":"offset","value":"0","description":"Optional - the sequence number of the first contract listed"},{"key":"get_properties","value":"false","description":"if set to true, contract properties are listed in the response - Beware. If get_properties is set to true, the request response time increases a lot with the number of contracts included in the response"},{"key":"get_perimeters","value":"false","description":"- if set to true, contract perimeters are listed in the response - Beware. If get_perimeters is set to true, the request response time increases a lot with the number of contracts included in the response\n"},{"key":"perimeter","value":"deserunt cupidatat","description":"Optional - search contracts only in a given perimeter. If this filtering property is activated, the request response time increases a lot with the number of contracts included in the response"},{"key":"status","value":"","description":"Option - the search status of the contracts - multi selection"},{"key":"before","value":"0","description":"Optional - list all contracts created before this date/time"},{"key":"after","value":"0","description":"Optional - list all contracts created after this date/time"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"contract_id\": 41464,\r\n \"date\": 1632847806716,\r\n \"document_token\": \"MTYzMjg0Nzk3MDgyMV80MTQ2NF8zOTQ4NDg=\",\r\n \"vendor_email\": \"admin@calindasoftware.com\",\r\n \"closed\": false,\r\n \"status\": \"ARCHIVED\",\r\n \"contract_definition_id\": 1911,\r\n \"message_title\": \"Here is your contract\",\r\n \"message_body\": \"We are pleased to sen you your contract ...\",\r\n \"name\": \"my_first_contract.pdf\",\r\n \"keep_on_move\": false,\r\n \"closed_date\": 1632847970292,\r\n \"canceled_reason\": \"\",\r\n \"version_number\": 0,\r\n \"size\": -1,\r\n \"auto_close\": 0,\r\n \"deleted\": 0,\r\n \"perimeters\": []\r\n },\r\n {\r\n \"contract_id\": 41463,\r\n \"date\": 1632847769779,\r\n \"document_token\": \"MTYzMjg0Nzk3MTA3OF80MTQ2M18xMjM5MzM=\",\r\n \"vendor_email\": \"admin@calindasoftware.com\",\r\n \"closed\": false,\r\n \"status\": \"ARCHIVED\",\r\n \"contract_definition_id\": 1911,\r\n \"message_title\": \"Here is your contract\",\r\n \"message_body\": \"We are pleased to sen you your contract ...\",\r\n \"name\": \"my_first_contract.pdf\",\r\n \"keep_on_move\": false,\r\n \"closed_date\": 1632847970461,\r\n \"canceled_reason\": \"\",\r\n \"version_number\": 0,\r\n \"size\": -1,\r\n \"auto_close\": 0,\r\n \"deleted\": 0,\r\n \"perimeters\": []\r\n },\r\n {\r\n \"contract_id\": 41484,\r\n \"date\": 1632846732497,\r\n \"document_token\": \"MTYzMjg0NzA2MjUzNF80MTQ4NF82ODIyNzc=\",\r\n \"vendor_email\": \"admin@calindasoftware.com\",\r\n \"closed\": false,\r\n \"status\": \"ABANDONED\",\r\n \"contract_definition_id\": 1911,\r\n \"message_title\": \"Here is your contract\",\r\n \"message_body\": \"We are pleased to sen you your contract ...\",\r\n \"name\": \"my_first_contract.pdf\",\r\n \"keep_on_move\": false,\r\n \"closed_date\": 1632847253007,\r\n \"canceled_reason\": \"Cancelled by user api user2: cancel_bundle\",\r\n \"version_number\": 0,\r\n \"size\": -1,\r\n \"auto_close\": 0,\r\n \"deleted\": 0,\r\n \"perimeters\": []\r\n },\r\n {\r\n \"contract_id\": 41483,\r\n \"date\": 1632846514404,\r\n \"document_token\": \"MTYzMjg0NzA2MTg0NV80MTQ4M181MzIyMzQ=\",\r\n \"vendor_email\": \"admin@calindasoftware.com\",\r\n \"closed\": false,\r\n \"status\": \"ABANDONED\",\r\n \"contract_definition_id\": 1911,\r\n \"message_title\": \"Here is your contract\",\r\n \"message_body\": \"We are pleased to sen you your contract ...\",\r\n \"name\": \"my_first_contract.pdf\",\r\n \"keep_on_move\": false,\r\n \"closed_date\": 1632847252928,\r\n \"canceled_reason\": \"Cancelled by user api user2: cancel_bundle\",\r\n \"version_number\": 0,\r\n \"size\": -1,\r\n \"auto_close\": 0,\r\n \"deleted\": 0,\r\n \"perimeters\": []\r\n },\r\n {\r\n \"contract_id\": 41482,\r\n \"date\": 1632843054173,\r\n \"document_token\": \"MTYzMjg0MzA2ODkzNV80MTQ4Ml84NjcxODA=\",\r\n \"vendor_email\": \"admin@calindasoftware.com\",\r\n \"closed\": false,\r\n \"status\": \"OPEN\",\r\n \"contract_definition_id\": 1911,\r\n \"message_title\": \"Here is your contract\",\r\n \"message_body\": \"We are pleased to sen you your contract ...\",\r\n \"name\": \"my_first_contract.pdf\",\r\n \"keep_on_move\": false,\r\n \"closed_date\": 0,\r\n \"canceled_reason\": \"\",\r\n \"version_number\": 0,\r\n \"size\": -1,\r\n \"auto_close\": 0,\r\n \"deleted\": 0,\r\n \"perimeters\": []\r\n },\r\n {\r\n \"contract_id\": 41481,\r\n \"date\": 1632842638498,\r\n \"document_token\": \"MTYzMjg0MjcyOTk2OV80MTQ4MV80NDg3MjE=\",\r\n \"vendor_email\": \"admin@calindasoftware.com\",\r\n \"closed\": false,\r\n \"status\": \"ARCHIVED\",\r\n \"contract_definition_id\": 1911,\r\n \"message_title\": \"Here is your contract\",\r\n \"message_body\": \"We are pleased to sen you your contract ...\",\r\n \"name\": \"my_first_contract.pdf\",\r\n \"keep_on_move\": false,\r\n \"closed_date\": 1632842729636,\r\n \"canceled_reason\": \"\",\r\n \"version_number\": 0,\r\n \"size\": -1,\r\n \"auto_close\": 0,\r\n \"deleted\": 0,\r\n \"perimeters\": []\r\n },\r\n {\r\n \"contract_id\": 41479,\r\n \"date\": 1632840720875,\r\n \"document_token\": \"MTYzMjg0MDc4MTAxM180MTQ3OV84NjczMzc=\",\r\n \"vendor_email\": \"admin@calindasoftware.com\",\r\n \"closed\": false,\r\n \"status\": \"ABANDONED\",\r\n \"contract_definition_id\": 1911,\r\n \"message_title\": \"Here is your contract\",\r\n \"message_body\": \"We are pleased to sen you your contract ...\",\r\n \"name\": \"my_first_contract.pdf\",\r\n \"keep_on_move\": false,\r\n \"closed_date\": 1632842263820,\r\n \"canceled_reason\": \"Cancelled by user api user2: no specific reason\",\r\n \"version_number\": 0,\r\n \"size\": -1,\r\n \"auto_close\": 0,\r\n \"deleted\": 0,\r\n \"perimeters\": []\r\n },\r\n {\r\n \"contract_id\": 41462,\r\n \"date\": 1632840137453,\r\n \"document_token\": \"MTYzMjg0MDQxNDc1M180MTQ2Ml83OTUwMA==\",\r\n \"vendor_email\": \"admin@calindasoftware.com\",\r\n \"closed\": false,\r\n \"status\": \"OPEN\",\r\n \"contract_definition_id\": 1911,\r\n \"message_title\": \"Here is your contract\",\r\n \"message_body\": \"We are pleased to sen you your contract ...\",\r\n \"name\": \"my_first_contract.pdf\",\r\n \"keep_on_move\": false,\r\n \"closed_date\": 0,\r\n \"canceled_reason\": \"\",\r\n \"version_number\": 0,\r\n \"size\": -1,\r\n \"auto_close\": 0,\r\n \"deleted\": 0,\r\n \"perimeters\": []\r\n },\r\n {\r\n \"contract_id\": 41320,\r\n \"date\": 1632821007308,\r\n \"document_token\": \"MTYzMjgyNDM2NjA4N180MTMyMF83NTYzMDE=\",\r\n \"vendor_email\": \"admin@calindasoftware.com\",\r\n \"closed\": false,\r\n \"status\": \"OPEN\",\r\n \"contract_definition_id\": 1911,\r\n \"message_title\": \"Here is your contract\",\r\n \"message_body\": \"We are pleased to send you your contract ...\",\r\n \"name\": \"my_first_contract.pdf\",\r\n \"keep_on_move\": false,\r\n \"closed_date\": 0,\r\n \"canceled_reason\": \"\",\r\n \"version_number\": 0,\r\n \"size\": -1,\r\n \"auto_close\": 0,\r\n \"deleted\": 0,\r\n \"perimeters\": []\r\n },\r\n {\r\n \"contract_id\": 41317,\r\n \"date\": 1632818695994,\r\n \"document_token\": \"\",\r\n \"vendor_email\": \"admin@calindasoftware.com\",\r\n \"closed\": false,\r\n \"status\": \"OPEN\",\r\n \"contract_definition_id\": 1911,\r\n \"message_title\": \"Here is your contract\",\r\n \"message_body\": \"We are pleased to send you your contract ...\",\r\n \"name\": \"my_first_contract.pdf\",\r\n \"keep_on_move\": false,\r\n \"closed_date\": 0,\r\n \"canceled_reason\": \"\",\r\n \"version_number\": 0,\r\n \"size\": -1,\r\n \"auto_close\": 0,\r\n \"deleted\": 0,\r\n \"perimeters\": []\r\n }\r\n]"}],"_postman_id":"800d7013-9506-497a-8187-e71e11775a90"},{"name":"Find a recipient by Id","id":"a3fcad2a-11a6-4100-a0fa-5817dcbb565a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/recipients/:id","description":"The GET /recipients/{id} endpoints finds a recipient by id and returns the recipient’s information.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The recipient id
\n","type":"text/plain"},"type":"any","value":"25678","key":"id"}]}},"response":[{"id":"0331b7c4-ae26-4373-9e8e-f4015dd0d753","name":"Find a recipient by Id","originalRequest":{"method":"GET","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/recipients/:id","host":["{{baseUrl}}"],"path":["recipients",":id"],"query":[{"key":"j","value":"","type":"text","disabled":true}],"variable":[{"id":"e57aa648-82b3-4f2b-b9e8-27f38cdd1476","key":"id","value":"82100033","description":"(Required) The recipient id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 25678,\r\n \"civility\": \"MADAME\",\r\n \"firstname\": \"Ada\",\r\n \"lastname\": \"Lovelace\",\r\n \"address_1\": \"Trafalgar Square\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"do\",\r\n \"city\": \"London\",\r\n \"phone\": \"\",\r\n \"email\": \"ada@lovelace.com\",\r\n \"job_title\": \"p\",\r\n \"company_name\": \"\",\r\n \"country\": \"United Kingdom\",\r\n \"cell_phone\": \"+2123456789065\",\r\n \"birthdate\": 0,\r\n \"birthplace\": \"\",\r\n \"custom_properties\": [\r\n {\r\n \"id\": 183,\r\n \"key\": \"custom\",\r\n \"value\": \"reprehenderit\",\r\n \"contractor_id\": 25678,\r\n \"sync_timer\": 1632821669906,\r\n \"last_modification_place\": \"SERVER\"\r\n }\r\n ],\r\n \"perimeters\": [\r\n \"hub.selling.perimeter.default_perimeter.name\",\r\n \"one_perimeter\",\r\n \"pilote\"\r\n ]\r\n}"}],"_postman_id":"a3fcad2a-11a6-4100-a0fa-5817dcbb565a"},{"name":"List recipients","id":"c95b8c69-34f9-4a28-ba75-2075558ebaa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/recipients?size=20&offset=0&get_custom_props=false&get_perimeters=false","description":"The GET /recipients endpoint lists recipients. The endpoint has several filters:
\nThe endpoint also gives you a certain level of control over the information returned:
\nPlease note: If your request targets a significant number of contracts, fetching the contracts’ properties and/or the contract’s perimeters will significantly increase the request’s response time.\n.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"Optional - maximum size of the returned array
\n","type":"text/plain"},"key":"size","value":"20"},{"description":{"content":"Optional - sequence number of the first recipient listed
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Search only in the given perimeter
\n","type":"text/plain"},"key":"perimeter","value":"eiusmod veniam"},{"description":{"content":"list recipients custom properties - Beware. If custom_props is set to true, the request response time increases a lot with the number of recipients included in the response
\n","type":"text/plain"},"key":"get_custom_props","value":"false"},{"description":{"content":"Lastname contains name
\n","type":"text/plain"},"key":"name","value":"eiusmod veniam"},{"disabled":true,"description":{"content":"Email contains email
\n","type":"text/plain"},"key":"email","value":"eiusmod veniam"}],"variable":[]}},"response":[{"id":"842c76d3-bc10-4197-a802-bf1c5dfa0797","name":"List recipients","originalRequest":{"method":"GET","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/recipients?size=20&offset=0","host":["{{baseUrl}}"],"path":["recipients"],"query":[{"key":"size","value":"20","description":"Optional - maximum size of the returned array"},{"key":"offset","value":"0","description":"Optional - sequence number of the first recipient listed"},{"key":"perimeter","value":"eiusmod veniam","description":"Search only in the given perimeter","disabled":true},{"key":"get_custom_props","value":"false","description":"list recipients custom properties - Beware. If custom_props is set to true, the request response time increases a lot with the number of recipients included in the response","disabled":true},{"key":"get_perimeters","value":"false","description":"- if set to true, recipient's perimeters are listed in the response - Beware. If get_perimeters is set to true, the request response time increases a lot with the number of recipients targeted by the query\n","disabled":true},{"key":"name","value":"eiusmod veniam","description":"Lastname contains name","disabled":true},{"key":"email","value":"eiusmod veniam","description":"Email contains email","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 25126,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"\",\r\n \"lastname\": \"\",\r\n \"address_1\": \"\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"\",\r\n \"city\": \"\",\r\n \"phone\": \"\",\r\n \"email\": \"\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"\",\r\n \"country\": \"\",\r\n \"cell_phone\": \"\",\r\n \"birthdate\": 0,\r\n \"birthplace\": \"\"\r\n },\r\n {\r\n \"id\": 21917,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"alphonse\",\r\n \"lastname\": \"Allais\",\r\n \"address_1\": \"Adresse 1a\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"75001\",\r\n \"city\": \"Paris\",\r\n \"phone\": \"\",\r\n \"email\": \"admin@calindasoftware.com\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"\",\r\n \"country\": \"\",\r\n \"cell_phone\": \"0612345678\",\r\n \"birthdate\": -1,\r\n \"birthplace\": \"\"\r\n },\r\n {\r\n \"id\": 21916,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"alphonse\",\r\n \"lastname\": \"Allais\",\r\n \"address_1\": \"zabzabzab\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"13002\",\r\n \"city\": \"marseille\",\r\n \"phone\": \"\",\r\n \"email\": \"admin@calindasoftware.com\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"\",\r\n \"country\": \"France\",\r\n \"cell_phone\": \"0612345678\",\r\n \"birthdate\": 0,\r\n \"birthplace\": \"\"\r\n },\r\n {\r\n \"id\": 21721,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"alphonse\",\r\n \"lastname\": \"Allais\",\r\n \"address_1\": \"Adresse 1a\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"75001\",\r\n \"city\": \"Paris\",\r\n \"phone\": \"\",\r\n \"email\": \"admin@calindasoftware.com\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"\",\r\n \"country\": \"\",\r\n \"cell_phone\": \"0612345678\",\r\n \"birthdate\": 0,\r\n \"birthplace\": \"\"\r\n },\r\n {\r\n \"id\": 20733,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"VINCENT\",\r\n \"lastname\": \"APARICI\",\r\n \"address_1\": \"11 PLACE DU MONT SEREIN\",\r\n \"address_2\": \"-\",\r\n \"postal_code\": \"30400\",\r\n \"city\": \"VILLENEUVE LES AVIGNON\",\r\n \"phone\": \"\",\r\n \"email\": \"vincent.aparici@orange.fr\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"A V F\",\r\n \"country\": \"FRANCE\",\r\n \"cell_phone\": \"0675790287\",\r\n \"birthdate\": -1,\r\n \"birthplace\": \"\"\r\n },\r\n {\r\n \"id\": 21922,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"aaaa\",\r\n \"lastname\": \"bbb\",\r\n \"address_1\": \"ccc\",\r\n \"address_2\": \"eeee\",\r\n \"postal_code\": \"13002\",\r\n \"city\": \"dddd\",\r\n \"phone\": \"\",\r\n \"email\": \"\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"fff\",\r\n \"country\": \"France\",\r\n \"cell_phone\": \"\",\r\n \"birthdate\": 0,\r\n \"birthplace\": \"ggg\"\r\n },\r\n {\r\n \"id\": 20425,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"CHRISTINE\",\r\n \"lastname\": \"BONJOUR\",\r\n \"address_1\": \"11 RUE LAFONTAINE\",\r\n \"address_2\": \"-\",\r\n \"postal_code\": \"69100\",\r\n \"city\": \"VILLEURBANNE\",\r\n \"phone\": \"\",\r\n \"email\": \"christine.bonjour@gmail.com\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"2A UTA SECTION RANDO & DECOUVERTES\",\r\n \"country\": \"FRANCE\",\r\n \"cell_phone\": \"0609398921\",\r\n \"birthdate\": -1,\r\n \"birthplace\": \"\"\r\n },\r\n {\r\n \"id\": 23027,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"César\",\r\n \"lastname\": \"Cardinale\",\r\n \"address_1\": \"9b Rue de Lorgues\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"\",\r\n \"city\": \"\",\r\n \"phone\": \"\",\r\n \"email\": \"cesar@gmail.com\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"\",\r\n \"country\": \"\",\r\n \"cell_phone\": \"0612345678\",\r\n \"birthdate\": 0,\r\n \"birthplace\": \"\"\r\n },\r\n {\r\n \"id\": 20739,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"REYNARD\",\r\n \"lastname\": \"Chantal\",\r\n \"address_1\": \"1819 Avenue des Amandiers\",\r\n \"address_2\": \"-\",\r\n \"postal_code\": \"84380\",\r\n \"city\": \"MAZAN\",\r\n \"phone\": \"\",\r\n \"email\": \"admin@orange.fr\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"A.F.O.D.A.V\",\r\n \"country\": \"FRANCE\",\r\n \"cell_phone\": \"0612345678\",\r\n \"birthdate\": -1,\r\n \"birthplace\": \"\"\r\n },\r\n {\r\n \"id\": 22174,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"test\",\r\n \"lastname\": \"controles\",\r\n \"address_1\": \"string\",\r\n \"address_2\": \"string\",\r\n \"postal_code\": \"string\",\r\n \"city\": \"string\",\r\n \"phone\": \"string\",\r\n \"email\": \"\",\r\n \"job_title\": \"string\",\r\n \"company_name\": \"string\",\r\n \"country\": \"string\",\r\n \"cell_phone\": \"string\",\r\n \"birthdate\": 0,\r\n \"birthplace\": \"string\"\r\n },\r\n {\r\n \"id\": 21216,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"Isabelle\",\r\n \"lastname\": \"Dassonville\",\r\n \"address_1\": \"47 rue mazenod\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"\",\r\n \"city\": \"marseille\",\r\n \"phone\": \"\",\r\n \"email\": \"admin@gmail.com\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"\",\r\n \"country\": \"France\",\r\n \"cell_phone\": \"0612345678\",\r\n \"birthdate\": -1,\r\n \"birthplace\": \"\"\r\n },\r\n {\r\n \"id\": 21783,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"Olivier\",\r\n \"lastname\": \"Delane\",\r\n \"address_1\": \"1addr\",\r\n \"address_2\": \"1addr2\",\r\n \"postal_code\": \"75001\",\r\n \"city\": \"Paris\",\r\n \"phone\": \"\",\r\n \"email\": \"admin@calindasoftware.com\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"\",\r\n \"country\": \"\",\r\n \"cell_phone\": \"0612345678\",\r\n \"birthdate\": -1,\r\n \"birthplace\": \"\"\r\n },\r\n {\r\n \"id\": 24776,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"Alaind\",\r\n \"lastname\": \"Delors\",\r\n \"address_1\": \"proident\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"13006\",\r\n \"city\": \"Marseille\",\r\n \"phone\": \"\",\r\n \"email\": \"admin@calindasoftware.com\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"\",\r\n \"country\": \"France\",\r\n \"cell_phone\": \"0612345678\",\r\n \"birthdate\": 0,\r\n \"birthplace\": \"\"\r\n },\r\n {\r\n \"id\": 17691,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"Arthur\",\r\n \"lastname\": \"Dent\",\r\n \"address_1\": \"47 rue mazenod\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"13002\",\r\n \"city\": \"marseille\",\r\n \"phone\": \"\",\r\n \"email\": \"admin@gmail.com\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"\",\r\n \"country\": \"France\",\r\n \"cell_phone\": \"0612345678\",\r\n \"birthdate\": -1,\r\n \"birthplace\": \"\"\r\n },\r\n {\r\n \"id\": 19314,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"Arthur\",\r\n \"lastname\": \"Dent\",\r\n \"address_1\": \"Adresse 1 2\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"75001\",\r\n \"city\": \"Ville 2\",\r\n \"phone\": \"\",\r\n \"email\": \"arthur.dent@calindasoftware.com\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"\",\r\n \"country\": \"\",\r\n \"cell_phone\": \"0612345678\",\r\n \"birthdate\": 0,\r\n \"birthplace\": \"\"\r\n },\r\n {\r\n \"id\": 17903,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"Arthur\",\r\n \"lastname\": \"Dent165\",\r\n \"address_1\": \"69 rue du quai\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"69000\",\r\n \"city\": \"Lyon\",\r\n \"phone\": \"\",\r\n \"email\": \"adent+165@calindasoftware.com\",\r\n \"job_title\": \"Product owner\",\r\n \"company_name\": \"Oodrive\",\r\n \"country\": \"France\",\r\n \"cell_phone\": \"0678901234\",\r\n \"birthdate\": 0,\r\n \"birthplace\": \"Paris\"\r\n },\r\n {\r\n \"id\": 17904,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"Arthur\",\r\n \"lastname\": \"Dent209\",\r\n \"address_1\": \"69 rue du quai\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"69000\",\r\n \"city\": \"Lyon\",\r\n \"phone\": \"\",\r\n \"email\": \"adent+209@calindasoftware.com\",\r\n \"job_title\": \"Product owner\",\r\n \"company_name\": \"Oodrive\",\r\n \"country\": \"France\",\r\n \"cell_phone\": \"0678901234\",\r\n \"birthdate\": 0,\r\n \"birthplace\": \"Paris\"\r\n },\r\n {\r\n \"id\": 17905,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"Arthur\",\r\n \"lastname\": \"Dent985\",\r\n \"address_1\": \"69 rue du quai\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"69000\",\r\n \"city\": \"Lyon\",\r\n \"phone\": \"\",\r\n \"email\": \"adent+985@calindasoftware.com\",\r\n \"job_title\": \"Product owner\",\r\n \"company_name\": \"Oodrive\",\r\n \"country\": \"France\",\r\n \"cell_phone\": \"0678901234\",\r\n \"birthdate\": 0,\r\n \"birthplace\": \"Paris\"\r\n },\r\n {\r\n \"id\": 25127,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"raymond\",\r\n \"lastname\": \"Deslane\",\r\n \"address_1\": \"\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"\",\r\n \"city\": \"\",\r\n \"phone\": \"\",\r\n \"email\": \"dschoen@gamial.co\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"\",\r\n \"country\": \"\",\r\n \"cell_phone\": \"06\",\r\n \"birthdate\": -1,\r\n \"birthplace\": \"\"\r\n },\r\n {\r\n \"id\": 19993,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"olivierrr\",\r\n \"lastname\": \"Deslane\",\r\n \"address_1\": \"Adresse 1 2\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"75001\",\r\n \"city\": \"Ville 2\",\r\n \"phone\": \"\",\r\n \"email\": \"admin@calindasoftware.com\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"Doasoft5\",\r\n \"country\": \"\",\r\n \"cell_phone\": \"0612345678\",\r\n \"birthdate\": 0,\r\n \"birthplace\": \"\"\r\n }\r\n]"}],"_postman_id":"c95b8c69-34f9-4a28-ba75-2075558ebaa2"},{"name":"List contract recipients","id":"ba139d29-33d8-447f-87b7-d85b5cbfcaae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/contracts/:id/recipients/","description":"The GET /contracts/{id}/recipients endpoint list the recipients attached to a contract.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The contract Id
\n","type":"text/plain"},"type":"any","value":"494","key":"id"}]}},"response":[{"id":"beb0cd94-f2f4-423f-b3b1-c4c557241ed3","name":"List a contract's recipients","originalRequest":{"method":"GET","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/contracts/:id/recipients/","host":["{{baseUrl}}"],"path":["contracts",":id","recipients",""],"variable":[{"id":"95928db8-97ca-4a41-b2dd-e4e6ded63581","key":"id","value":"-56529255","description":"(Required) The contract Id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"recipient_for_contract_id\": 1915,\r\n \"contract_id\": 1942,\r\n \"recipient_id\": 41,\r\n \"signature_mode\": 19,\r\n \"signature_status\": \"NONE\",\r\n \"signature_date\": 1655817290244,\r\n \"rank\": -1,\r\n \"message_title\": \"\",\r\n \"message_body\": \"\",\r\n \"signature_id\": \"\",\r\n \"smartrole\": \"roleA\",\r\n \"transport_mode\": 1,\r\n \"pvid_identity_level\": 1,\r\n \"pvid_last_modification_identification_status\": 1655817290244\r\n },\r\n {\r\n \"recipient_for_contract_id\": 1916,\r\n \"contract_id\": 1942,\r\n \"recipient_id\": 92,\r\n \"signature_mode\": 11,\r\n \"signature_status\": \"NONE\",\r\n \"signature_date\": 1655817290442,\r\n \"rank\": 1,\r\n \"message_title\": \"\",\r\n \"message_body\": \"\",\r\n \"signature_id\": \"\",\r\n \"transport_mode\": 1\r\n }\r\n]"}],"_postman_id":"ba139d29-33d8-447f-87b7-d85b5cbfcaae"},{"name":"Update contract recipients","id":"d51390bc-1422-4edc-979e-df6e48ee089f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"message_title\": \"New message title\",\n \"message_body\": \"New message body\",\n \"signature_mode\": 10 \n}"},"url":"{{baseUrl}}/contracts/recipients/:cfc_id","description":"The PATCH /contracts/{id}/recipients endpoint updates one recipient attached to a contract (i.e. the relationship between a contract and a recipient).
\nYou can update the recipient for contract’s signature_mode, message_title, message_body, rank and transport_mode and smartrole with this request.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The recipient for contract id
\n","type":"text/plain"},"type":"any","value":"589","key":"cfc_id"}]}},"response":[{"id":"e394b32e-f543-49b3-b9d3-1af9ee5ea06f","name":"Update a contract's recipients","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"j_token","value":"{{apiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"message_title\": \"New message title\",\n \"message_body\": \"New message body\",\n \"signature_mode\": 10 \n}"},"url":{"raw":"{{baseUrl}}/contracts/recipients/:cfc_id","host":["{{baseUrl}}"],"path":["contracts","recipients",":cfc_id"],"variable":[{"key":"cfc_id","value":"50975","description":"(Required) The recipient for contract id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"recipient_for_contract_id\": 589,\r\n \"contract_id\": 494,\r\n \"recipient_id\": 296,\r\n \"signature_mode\": 10,\r\n \"signature_status\": \"NONE\",\r\n \"rank\": 1,\r\n \"message_title\": \"New message title\",\r\n \"message_body\": \"New message body\",\r\n \"signature_id\": \"\",\r\n \"transport_mode\": 1\r\n}"}],"_postman_id":"d51390bc-1422-4edc-979e-df6e48ee089f"},{"name":"Delete contract recipients","id":"fced5a15-0b60-4f7a-b0b8-aab92bf9f5ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{baseUrl}}/contracts/recipients/:cfc_id","description":"The DELETE /contracts/{id}/recipients endpoint deletes one recipient attached to a contract (i.e. deletes the relationship between a contract and a recipient).
\nFor this to work properly, the contract must not have been sent for signature.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The recipient for contract Id
\n","type":"text/plain"},"type":"any","value":"50975","key":"cfc_id"}]}},"response":[{"id":"b5503c72-b9c9-4980-818f-75fb2b0a86aa","name":"Delete a contract's recipients","originalRequest":{"method":"DELETE","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/contracts/recipients/:cfc_id","host":["{{baseUrl}}"],"path":["contracts","recipients",":cfc_id"],"variable":[{"key":"cfc_id","value":"50975","description":"(Required) The *recipient for contract* Id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"succeed\": true\r\n}"}],"_postman_id":"fced5a15-0b60-4f7a-b0b8-aab92bf9f5ae"},{"name":"List contract documents","id":"84498524-ca51-4326-bb26-a31270c0f255","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{baseUrl}}/contracts/:id/documents/","description":"The /contracts/{id}/documents endpoint lists information regarding contract documents (mostly file names and sizes).
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The id of the contract
\n","type":"text/plain"},"type":"any","value":"41479","key":"id"}]}},"response":[{"id":"e2ebc98d-ae5c-461b-a8bf-86c8b4a0f8b7","name":"List a contract's documents","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/contracts/:id/documents/","host":["{{baseUrl}}"],"path":["contracts",":id","documents",""],"variable":[{"key":"id","value":"41479","description":"(Required) The id of the contract"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 25364,\r\n \"rank\": 1,\r\n \"has_smart_field\": false,\r\n \"size\": 281789,\r\n \"filename\": \"billet.pdf\"\r\n }\r\n]"}],"_postman_id":"84498524-ca51-4326-bb26-a31270c0f255"},{"name":"List contract attachments","id":"38009789-a34a-4b59-9c07-57a3f10acebd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/contracts/:id/appendices/","description":"The /contracts/{id}/appendices endpoint lists information regarding contract file attachments (mostly file names and sizes).
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The contract Id
\n","type":"text/plain"},"type":"any","value":"41488","key":"id"}]}},"response":[{"id":"0260ff86-9df9-4af8-ad06-acb1f6b37f17","name":"List a contract's attachments","originalRequest":{"method":"GET","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/contracts/:id/appendices/","host":["{{baseUrl}}"],"path":["contracts",":id","appendices",""],"variable":[{"key":"id","value":"41488","description":"(Required) The contract Id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 11775,\r\n \"option_id\": 185169,\r\n \"filename\": \"splitted-1.pdf\",\r\n \"content_type\": \"application/pdf\"\r\n }\r\n]"}],"_postman_id":"38009789-a34a-4b59-9c07-57a3f10acebd"},{"name":"Download contract document","id":"fe9ee07e-6ec0-4391-ade4-87e4614e5ff1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/pdf","type":"text"}],"url":"{{baseUrl}}/contracts/:id/documentresult/?filename=contract.pdf","description":"The /contracts/{id}/documentresult allows to download the contract document (if you uploaded several documents, this call will return one file containing the combined documents).
\nThe PDF document is included in the response's body.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"the name to give to the downloaded file
\n","type":"text/plain"},"key":"filename","value":"contract.pdf"}],"variable":[{"description":{"content":"(Required) The contract Id
\n","type":"text/plain"},"type":"any","value":"41488","key":"id"}]}},"response":[{"id":"771ac340-0bda-4294-814b-bd6fa627e416","name":"Download a contract's document","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/pdf","type":"text"},{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/contracts/:id/documentresult/?filename=contract.pdf","host":["{{baseUrl}}"],"path":["contracts",":id","documentresult",""],"query":[{"key":"filename","value":"contract.pdf","description":"the name to give to the downloaded file"}],"variable":[{"key":"id","value":"41488","description":"(Required) The contract Id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"fe9ee07e-6ec0-4391-ade4-87e4614e5ff1"},{"name":"Download contract signed document","id":"ee8898e6-b0b6-43e6-ab52-ec6311bb91f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/pdf","type":"text"}],"url":"{{baseUrl}}/contracts/:id/transaction/signedcontract?filename=contract.pdf","description":"The GET /contracts/{id}/transaction/signedcontract returns the signed contract document.
\nThe PDF document is included in the response's body.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"The downloaded file name
\n","type":"text/plain"},"key":"filename","value":"contract.pdf"}],"variable":[{"description":{"content":"(Required) The
\n","type":"text/plain"},"type":"any","value":"41497","key":"id"}]}},"response":[{"id":"f864269e-dbd6-4c4f-af69-a92ceaee03f3","name":"Download a contract's signed document","originalRequest":{"method":"GET","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/contracts/:id/transaction/signedcontract?filename=contract.pdf","host":["{{baseUrl}}"],"path":["contracts",":id","transaction","signedcontract"],"query":[{"key":"filename","value":"contract.pdf","description":"The downloaded file name"}],"variable":[{"key":"id","value":"41497","description":"(Required) The"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ee8898e6-b0b6-43e6-ab52-ec6311bb91f4"},{"name":"Download contract proof file","id":"8da7f6ae-d20c-43a5-8fba-b4ebac94ffc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/contracts/:id/transaction/prooffiles?filename=contractproof.zip","description":"The GET/contracts/{id}/transaction/prooffiles returns the contract proof file.
\nThe ZIP file is included int the response's body.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"The downloaded file name
\n","type":"text/plain"},"key":"filename","value":"contractproof.zip"}],"variable":[{"description":{"content":"(Required) The contract Id
\n","type":"text/plain"},"type":"any","value":"41497","key":"id"}]}},"response":[{"id":"5ef0e901-632a-4b2e-be3e-30cbd0ca22de","name":"Download a contract's proof file","originalRequest":{"method":"GET","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/contracts/:id/transaction/prooffiles?filename=contractproof.zip","host":["{{baseUrl}}"],"path":["contracts",":id","transaction","prooffiles"],"query":[{"key":"filename","value":"contractproof.zip","description":"The downloaded file name"}],"variable":[{"key":"id","value":"41497","description":"(Required) The contract Id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8da7f6ae-d20c-43a5-8fba-b4ebac94ffc8"}],"id":"87f017a9-7927-4c35-81b0-960c63c82ba9","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"Our smartfields feature allows to add information to a contract's document:
\nSmartfields are special tags inserted in the contract's document. These tags are character strings with the following format:
\n[tag_name/] or [tage_name].....[/tag_name] (the second form allows to reserve display space for the smart field's value)
\nSmartfields values, that will replace the tags in the document, can be set at contract creation time by adding a contract_properties array to the POST /contracts request body or to the contract part of the POST /contracts/allione request:
\n\"contract_properties\": [
{
\"key\": \"custom_property\",
\"placeholder\": \"custom_property\",
\"to_fill_by_user\": true,
\"required\": true,
\"value\": \"irure consectetur in\",
\"field_type\": \"TEXT\",
\"used_by_contract\": false
}
],
provided that the values of the key members match smartfields names.
\nSmartfields values can be retrieved in the contract_properties array present in the GET /contracts and GET /contracts/{id} requests' body.
\ncontract_properties can also be useful if you want to exchange technical information between your software package and Oodrive_sign. In this case, just ensure that your contract_properties do not match any smartield's name.
\n","_postman_id":"95f1da49-d831-4a70-a1d1-9866354ee0ee","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"The signatory from whom the smartfields are collected must be the first person to sign the contract in order to ensure that all signatories are presented the same document (because the smartfield value appears on the document).
\nTo collect smartfield value from the first contract’s signatory you must:
\nIn the request’s body object, the member field_type allows you to define the type of the smartfield value (See possible values below).
\nTEXTAREA stands for multiline text. If you set the field_type to SINGLE, the signatory will be presented a list of possible values for the smartfield. The possible choices must be set in the input_filter member of the request’s body with the following format:
\n‘[“choice 1”, “choice 2”,…]’
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The contract id
\n","type":"text/plain"},"type":"any","value":"41523","key":"id"}]}},"response":[{"id":"29ae986b-8183-45df-be99-acfd08ef94be","name":"Collect contract's information","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"j_token","value":"{{apiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"key\": \"RCS\",\n \"to_fill_by_user\": true,\n \"placeholder\": \"RCS\",\n \"field_type\": \"TEXT\",\n \"required\": true\n}"},"url":{"raw":"{{baseUrl}}/contracts/:id/gather/smartfield","host":["{{baseUrl}}"],"path":["contracts",":id","gather","smartfield"],"variable":[{"key":"id","value":"41523","description":"(Required) The contract id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 59137,\r\n \"key\": \"RCS\",\r\n \"contract_id\": \"41523\",\r\n \"required\": true,\r\n \"to_fill_by_user\": true,\r\n \"used_by_contract\": true,\r\n \"placeholder\": \"RCS\",\r\n \"logical_removed\": false,\r\n \"field_type\": \"TEXT\",\r\n \"input_filter\": \"\",\r\n \"value\": \"\"\r\n}"}],"_postman_id":"e0b42d20-3a52-4799-a598-bb516e221476"},{"name":"Collect contract attachments","id":"06a523fb-d953-4483-b7da-f0c525bb0617","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"key\": \"oneAttachment\",\n \"to_fill_by_user\": true,\n \"placeholder\": \"onePlaceholder\",\n \"field_type\": \"IMAGE\",\n \"input_filter\": \"{\\\"filetype\\\":[\\\"*\\\"],\\\"size\\\":\\\"100\\\",\\\"nbfile\\\":1}\",\n \"required\": true\n}"},"url":"{{baseUrl}}/contracts/:id/gather/attachment","description":"You can collect contract attachments from the first signatory by using the following steps:
\nThe request’s body member field_type must be set to ‘IMAGE’. The request’s body member input_filter specifies the accepted file extensions and must have the following format:
\n‘{\"filetype\":[”*”],”size”:”100”,”nbfile”:1}’ or
‘{\"filetype\":”[PDF, JPG,…]”,”size”:”100”,”nbfile”:1}’ or
‘{\"filetype\":”[PDF, DOCX,…], [PNG, JPG,…],…”,”size”:”100”,”nbfile”:1}’
Where size sets the maximal file size in Mb and nbfile sets the maximal number of files to collect.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The contract id
\n","type":"text/plain"},"type":"any","value":"41523","key":"id"}]}},"response":[{"id":"769654c3-c9ca-43ab-9b17-c0a2a0508fbe","name":"Collect a contract's attachments","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"j_token","value":"{{apiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"key\": \"oneAttachment\",\n \"to_fill_by_user\": true,\n \"placeholder\": \"onePlaceholder\",\n \"field_type\": \"IMAGE\",\n \"input_filter\": \"{\\\"filetype\\\":[\\\"*\\\"],\\\"size\\\":\\\"100\\\",\\\"nbfile\\\":1}\",\n \"required\": true\n}"},"url":{"raw":"{{baseUrl}}/contracts/:id/gather/attachment","host":["{{baseUrl}}"],"path":["contracts",":id","gather","attachment"],"variable":[{"key":"id","value":"41523","description":"(Required) The contract id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 59162,\r\n \"key\": \"oneAttachment\",\r\n \"contract_id\": \"41523\",\r\n \"required\": true,\r\n \"to_fill_by_user\": false,\r\n \"used_by_contract\": false,\r\n \"placeholder\": \"onePlaceholder\",\r\n \"logical_removed\": false,\r\n \"field_type\": \"IMAGE\",\r\n \"input_filter\": \"{\\\"filetype\\\":[\\\"*\\\"],\\\"size\\\":\\\"100\\\",\\\"nbfile\\\":1}\",\r\n \"value\": \"\"\r\n}"}],"_postman_id":"06a523fb-d953-4483-b7da-f0c525bb0617"},{"name":"Collect recipient properties","id":"aa1aea5c-ddd3-44e1-9680-90e4c227a628","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contract_id\": 41523,\n \"name\": \"firstname\",\n \"required\": false,\n \"validity_duration\": 1623833527352\n}"},"url":"{{baseUrl}}/recipients/:id/gather/personalinformation","description":"All the recipient standard properties (firstname, lastname, email, cell_phone...) can be collected at signature time. This information will then be added to the recipients in our database. To collect a recipient property, send a POST /recipients/{id}/gather/personalinformation API request.
\nThe name or the property to collect must be set in the name member of the request's body object.
\nPlease note: the request body object contains a validity_duration member, to define the maximum validity duration of the collected information.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The recipient id
\n","type":"text/plain"},"type":"any","value":"17906","key":"id"}]}},"response":[{"id":"d28cace2-67f4-4ed4-bb9f-18fbd09afd6f","name":"Collect a recipient's properties","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"j_token","value":"{{apiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"contract_id\": 12345,\n \"name\": \"firstname\",\n \"required\": false,\n \"validity_duration\": 1623833527352\n}"},"url":{"raw":"{{baseUrl}}/recipients/:id/gather/personalinformation","host":["{{baseUrl}}"],"path":["recipients",":id","gather","personalinformation"],"variable":[{"key":"id","value":"17906","description":"(Required) The recipient id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 8423,\r\n \"contract_id\": 41523,\r\n \"contractor_proof_definition_id\": 7633,\r\n \"last_modification_date\": 1633006508721,\r\n \"last_modification_place\": \"SERVER\"\r\n}"}],"_postman_id":"aa1aea5c-ddd3-44e1-9680-90e4c227a628"},{"name":"Set recipient custom properties","id":"4d63bd82-0b13-4b10-af7e-d60d7b2262de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"civility\": \"MADAME\",\n \"firstname\": \"Ada\",\n \"lastname\": \"Lovelace\",\n \"address_1\": \"Trafalgar Square\",\n \"postal_code\": \"do\",\n \"city\": \"London\",\n \"cell_phone\": \"+2123456789065\",\n \"email\": \"ada@lovelace.com\",\n \"country\": \"United Kingdom\",\n \"address_2\": \"\",\n \"company_name\": \"\",\n \"phone\": \"\",\n \"job_title\": \"p\",\n \"birthdate\": 0,\n \"birthplace\": \"\",\n \"custom_properties\": [\n {\n \"key\": \"custom\",\n \"value\": \"reprehenderit\"\n }\n ]\n}"},"url":"{{baseUrl}}/recipients?=17096","description":"To add custom columns to the recipient database table, please contact your sales representative.
\nIf you have already asked for customization of your recipients database table, customs fields can be collected in the same way as standard fields, by sending a POST /recipients/{id}/gather/personal information. You can set the recipient’s custom property values by adding a custom_properties member to the POST /recipients API call.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"If a recipient has customs properties that contain values, these properties and their values can be retrieved with the GET /recipients and GET /recipient/{id} API calls (the custom_properties member is included in the response’s body).
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The recipient id
\n","type":"text/plain"},"type":"any","value":"19993","key":"id"}]}},"response":[{"id":"de2943c9-15a2-4c67-b978-3bfda5d32ea0","name":"Find a recipient by Id","originalRequest":{"method":"GET","header":[{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/recipients/:id","host":["{{baseUrl}}"],"path":["recipients",":id"],"variable":[{"key":"id","value":"19996","description":"(Required) The recipient id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 19993,\r\n \"civility\": \"MONSIEUR\",\r\n \"firstname\": \"olivierrr\",\r\n \"lastname\": \"Deslane\",\r\n \"address_1\": \"Adresse 1 2\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"75001\",\r\n \"city\": \"Ville 2\",\r\n \"phone\": \"\",\r\n \"email\": \"omathieu+129@calindasoftware.com\",\r\n \"job_title\": \"\",\r\n \"company_name\": \"Doasoft5\",\r\n \"country\": \"\",\r\n \"cell_phone\": \"0662370619\",\r\n \"birthdate\": -1,\r\n \"birthplace\": \"\",\r\n \"custom_properties\": [\r\n {\r\n \"id\": 121,\r\n \"key\": \"custom\",\r\n \"value\": \"use case 9.1\",\r\n \"contractor_id\": 19993,\r\n \"sync_timer\": 1632991028670,\r\n \"last_modification_place\": \"SERVER\"\r\n }\r\n ]\r\n}"}],"_postman_id":"06ad710b-a831-4538-9325-91913ea15aac"},{"name":"Collect supporting documents from recipients","id":"e7c282eb-eeba-48b5-b261-45e32e608963","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contract_id\": 41523,\n \"file_amount\": 1,\n \"file_extension_regex\": \"[\\\"PDF\\\"]\",\n \"file_size_max\": 100,\n \"required\": false,\n \"validity_duration\": 1623833527352\n}"},"url":"{{baseUrl}}/recipients/:id/gather/personaldocuments","description":"You can collect supporting documents from recipients by sending a POST /recipients/{id}/gather/personaldocuments API call. You must specify the number of files to collect as well as the file extensions and maximal file sizes (in Mb) allowed in the request’s body object.
\nPlease note: the request body object contains a validity_duration member, to define the maximum validity duration of the collected documents.
\n","auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"(Required) The recipient id
\n","type":"text/plain"},"type":"any","value":"21172","key":"id"}]}},"response":[{"id":"1140b0fd-5cbb-46b3-81ec-14a6f8e08d1e","name":"Collect a recipient's justifying documents","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"j_token","value":"{{apiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"contract_id\": 41523,\n \"file_amount\": 1,\n \"file_extension_regex\": \"[\\\"PDF\\\"]\",\n \"file_size_max\": 100,\n \"required\": false,\n \"validity_duration\": 1623833527352\n}"},"url":{"raw":"{{baseUrl}}/recipients/:id/gather/personaldocuments","host":["{{baseUrl}}"],"path":["recipients",":id","gather","personaldocuments"],"variable":[{"key":"id","value":"21172","description":"(Required) The recipient id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 8424,\r\n \"contract_id\": 41523,\r\n \"contractor_proof_definition_id\": 7635,\r\n \"last_modification_date\": 1633008798772,\r\n \"last_modification_place\": \"SERVER\"\r\n}"}],"_postman_id":"e7c282eb-eeba-48b5-b261-45e32e608963"},{"name":"Draw smartfields in your document","id":"85077f40-b34c-4c92-b66c-1307bdb7344a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{j_token(Presales 2)}}","key":"Instead of placing smartfields directly in the PDF, you can place them directly using API
\nby drawing their specific location on your document using the coordinates (x,y) and page number.
\nIn order to do so, you have to make these 3 calls:
\n(Required) The perimeter key
\n","type":"text/plain"},"type":"any","value":"deserunt cupidatat","key":"key"}]}},"response":[{"id":"96d2fd12-99bd-4e01-827f-97c733fe3094","name":"Perimeter information","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"j_token","value":"(Required) The perimeter key
\n","type":"text/plain"},"type":"any","value":"deserunt cupidatat","key":"key"}]}},"response":[{"id":"58e420e7-c143-4120-aa55-d297b7e20797","name":"Perimeter information","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"j_token","value":"A keyword to search for in the perimeters description
\n","type":"text/plain"},"key":"keyword","value":""}],"variable":[]}},"response":[{"id":"32621732-ff7a-49c0-884a-ba2e4b9a27a7","name":"Array of perimeter information","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"j_token","value":"(Required) The old perimeter key
\n","type":"text/plain"},"type":"any","value":"deserunt cupidatat","key":"key"},{"id":"dfa3b574-15db-4422-910f-13e12ab6066f","description":{"content":"(Required) The new perimeter key
\n","type":"text/plain"},"type":"any","value":"deserunt cupidatat","key":"newkey"}]}},"response":[{"id":"17252be8-c61c-46a7-b078-6844ebdc3ce1","name":"Perimeter information","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"j_token","value":"The oodrive_sign solution offers a recipient and contract access control mechanism. This mechanism is a license option.
\nYou can include recipients, contracts and application users (for example the API user used for API calls) in one or more “perimeters.” To have access to a recipient or contract, the application user must have a least one perimeter in common with the recipient/contract.
\nYou can include a recipient or contract in one or more perimeters by adding a perimeters member to the corresponding resource creation requests (i.e., POST /recipients and POST /contracts respectively).
\nPlease note: if a perimeter passed to these endpoints does not yet exist, it will be created instantaneously. The endpoints will also add the API user to the perimeters if needed.
\nYou can also manage perimeters directly with the endpoints described below.
\n","_postman_id":"c116622b-1dd9-40fb-a1c3-82fbd3f26b9d"},{"name":"Getting notified of contracts events","item":[{"name":"Register a contract callback for all contracts","id":"6ff8a4f9-d602-444d-8f6b-dda044ae3765","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"Callbacks registered with this endpoint will trigger on all contracts of the licence.
\nHere is the description of the API call paramters:
\nOnce the Webhook for a contract is triggered through the desired URL, you will receive a payload similar to the example below :
\n{
\"type\": \"contract\",
\"webhookId\": webhook_id ,
\"contractId\" : contract_id,
\"contractStatus\" : \"one of the following OPENNED / SIGNED / CLOSED / ARCHIVED / CANCELED\",
\"timestamp\" : EPOCH UTC in milliseconds
}
Callbacks registered with this endpoint will trigger only on a specific contract.
\nOnce triggered, the callback will be automitically deleted.
\nHere is the description of this API call parameters:
\n","urlObject":{"path":["webhook","contract",":cid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"fef9de85-82ca-4f3c-b877-5a479479adeb","description":{"content":"Entrer your contract id here
\n","type":"text/plain"},"type":"any","value":"{{cid_AIO}}","key":"cid"}]}},"response":[{"id":"e0de4033-6330-4727-b049-19b1a961ff94","name":"Register a contract callback for one contract","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"j_token","value":"5699057|TklngrkyKWgol6f7nq1qsLez5vL7fJHqXXeTGKF6wy0=","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"description\": \"MY WEBHOOK\",\r\n \"events\": [\r\n \"ARCHIVED\",\"SIGNED\"\r\n ],\r\n \"endpoint\": {\r\n \"url\": \"https://XXXX.site/80262028e57cf\",\r\n \"headers\": [\r\n {\r\n \"value\": \"string\",\r\n \"name\": \"string\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseurl}}/webhook/contract/:cid","host":["{{baseurl}}"],"path":["webhook","contract",":cid"],"variable":[{"key":"cid","value":"{{cid_AIO}}","description":"Entrer your contract id here"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Mar 2023 14:29:53 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Powered-By","value":"Express"},{"key":"Location","value":"undefined/api/v4/webhook/6744"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"34"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"webhook_id\": 6744\n}"}],"_postman_id":"10cdb924-0a17-4fe7-b3ef-626c4002a094"},{"name":"Register a signature callback for all signatures in all contracts","id":"6c030e46-f5c2-4ed8-a3b3-9edc7625c2e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"This webbhook will trigger on signature events, for all contracts.
\nHere is the description of this API call parameters:
\nSimilar to the contract event, once the webhook signature is triggered through the specified URL, you will receive a payload resembling the following example:
\n{
\"type\": \"signature\",
\"webhookId\": webhook_id,
\"contractId\": contract_id,
\"recipientId\": recipient _id,
\"signatureStatus\": \"one of the following: SENT / SIGNED / REFUSED\",
\"timestamp\": EPOCH UTC in milliseconds
}
This webbhook will trigger on signature events, for one contract.
\nOnce triggered, the callback will be automitically deleted.
\nHere is the description of this API call parameters:
\n","urlObject":{"path":["webhook","signature",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"{{cid_AIO}}","key":"id"}]}},"response":[{"id":"cba1b11c-f9e8-48ce-b5c5-2a1f16775188","name":"Register a signature callback for one contract","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"j_token","value":"5699057|TklngrkyKWgol6f7nq1qsLez5vL7fJHqXXeTGKF6wy0=","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"description\": \"MY SIGNATURE WEBHOOK\",\r\n \"events\": [\r\n \"SIGNED\"\r\n ],\r\n \"endpoint\": {\r\n \"url\": \"https://XXXX.site/80262028e57cf\",\r\n \"headers\": [\r\n {\r\n \"value\": \"string\",\r\n \"name\": \"string\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseurl}}/webhook/signature?id=6789","host":["{{baseurl}}"],"path":["webhook","signature"],"query":[{"key":"id","value":"6789","type":"text"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Mar 2023 14:57:06 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Powered-By","value":"Express"},{"key":"Location","value":"undefined/api/v4/webhook/6747"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"34"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"webhook_id\": 6747\n}"}],"_postman_id":"fe15e032-e65b-4711-9a42-d1d97d44e332"},{"name":"Replay callbacks","id":"d6f511c2-ce48-4e61-b8de-30eb761a0c94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"This API calls allows to 'replay' a callback. It is useful if, for any reason, the previous callback call was lost.
\nIts payload contains the list of callbacks to be relaunched, referenced by callback IDs.
\n","urlObject":{"path":["webhook","replay","contract"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"992d17d8-8322-413a-adf3-75e7d7282cf9","name":"Replay callbacks","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"j_token","value":"5699057|TklngrkyKWgol6f7nq1qsLez5vL7fJHqXXeTGKF6wy0=","type":"text"}],"body":{"mode":"raw","raw":"[\r\n 6796 \r\n]"},"url":"{{baseUrl}}/webhook/replay/contract"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"contract_id\": 6796,\r\n \"replay_status\": \"NO_CONTRACT\"\r\n }\r\n]"}],"_postman_id":"d6f511c2-ce48-4e61-b8de-30eb761a0c94"},{"name":"View callbacks logs","id":"02c278e2-8882-423b-8fc2-658a3ff2afb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"This API call allows to consult the callbacks execution log. It is useful to analyse failures of the callbacks calls. The returned list of callbacks calls can be filtered by offset and size.
\n","urlObject":{"path":["webhook","logs","user"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"key":"email","value":null},{"key":"offset","value":"0"},{"key":"size","value":"20"}],"variable":[]}},"response":[{"id":"46c8c32e-956e-427c-a98c-e4af34b37405","name":"View callbacks logs","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"j_token","value":"5699057|TklngrkyKWgol6f7nq1qsLez5vL7fJHqXXeTGKF6wy0=","type":"text"}],"url":{"raw":"{{baseUrl}}/webhook/logs/user?offset=0&size=20","host":["{{baseUrl}}"],"path":["webhook","logs","user"],"query":[{"key":"offset","value":"0"},{"key":"size","value":"20"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"logs\": [\r\n {\r\n \"timestamp\": 1678790975449,\r\n \"webHookId\": 6784,\r\n \"status\": 404,\r\n \"message\": \"I/O error on POST request for \\\"https://hookb.in/JKdBVwxrZBsg1WBgVkJV\\\": PKIX path validation failed: java.security.cert.CertPathValidatorException: validity check failed; nested exception is javax.net.ssl.SSLHandshakeException: PKIX path validation failed: java.security.cert.CertPathValidatorException: validity check failed\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 6784,\\n \\\"contractId\\\" : 4582360,\\n \\\"timestamp\\\" : 1678787363000,\\n \\\"contractStatus\\\" : \\\"OPENED\\\",\\n \\\"uniqueKey\\\" : \\\"6784_ contract_4582360_OPENED\\\"\\n}\",\r\n \"url\": \"https://hookb.in/JKdBVwxrZBsg1WBgVkJV\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678790975449,\r\n \"webHookId\": 6783,\r\n \"status\": 404,\r\n \"message\": \"I/O error on POST request for \\\"https://hookb.in/JKdBVwxrZBsg1WBgVkJV\\\": PKIX path validation failed: java.security.cert.CertPathValidatorException: validity check failed; nested exception is javax.net.ssl.SSLHandshakeException: PKIX path validation failed: java.security.cert.CertPathValidatorException: validity check failed\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 6783,\\n \\\"contractId\\\" : 4582360,\\n \\\"timestamp\\\" : 1678787363000,\\n \\\"contractStatus\\\" : \\\"OPENED\\\",\\n \\\"uniqueKey\\\" : \\\"6783_ contract_4582360_OPENED\\\"\\n}\",\r\n \"url\": \"https://hookb.in/JKdBVwxrZBsg1WBgVkJV\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678787374359,\r\n \"webHookId\": 6783,\r\n \"status\": 404,\r\n \"message\": \"I/O error on POST request for \\\"https://hookb.in/JKdBVwxrZBsg1WBgVkJV\\\": PKIX path validation failed: java.security.cert.CertPathValidatorException: validity check failed; nested exception is javax.net.ssl.SSLHandshakeException: PKIX path validation failed: java.security.cert.CertPathValidatorException: validity check failed\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 6783,\\n \\\"contractId\\\" : 4582360,\\n \\\"timestamp\\\" : 1678787363000,\\n \\\"contractStatus\\\" : \\\"OPENED\\\",\\n \\\"uniqueKey\\\" : \\\"6783_ contract_4582360_OPENED\\\"\\n}\",\r\n \"url\": \"https://hookb.in/JKdBVwxrZBsg1WBgVkJV\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678787374358,\r\n \"webHookId\": 6784,\r\n \"status\": 404,\r\n \"message\": \"I/O error on POST request for \\\"https://hookb.in/JKdBVwxrZBsg1WBgVkJV\\\": PKIX path validation failed: java.security.cert.CertPathValidatorException: validity check failed; nested exception is javax.net.ssl.SSLHandshakeException: PKIX path validation failed: java.security.cert.CertPathValidatorException: validity check failed\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 6784,\\n \\\"contractId\\\" : 4582360,\\n \\\"timestamp\\\" : 1678787363000,\\n \\\"contractStatus\\\" : \\\"OPENED\\\",\\n \\\"uniqueKey\\\" : \\\"6784_ contract_4582360_OPENED\\\"\\n}\",\r\n \"url\": \"https://hookb.in/JKdBVwxrZBsg1WBgVkJV\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678711491053,\r\n \"webHookId\": 583,\r\n \"status\": 200,\r\n \"message\": \"{\\\"message\\\":\\\"received\\\"}\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 583,\\n \\\"contractId\\\" : 4576592,\\n \\\"timestamp\\\" : 1678711483000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"583_ contract_4576592_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://test.sellandsign.com/webhook\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678711490751,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4576592,\\n \\\"timestamp\\\" : 1678711483000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4576592_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678711446610,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4576592,\\n \\\"timestamp\\\" : 1678711444000,\\n \\\"contractStatus\\\" : \\\"SIGNED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4576592_SIGNED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678461394035,\r\n \"webHookId\": 583,\r\n \"status\": 200,\r\n \"message\": \"{\\\"message\\\":\\\"received\\\"}\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 583,\\n \\\"contractId\\\" : 4569121,\\n \\\"timestamp\\\" : 1678461389000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"583_ contract_4569121_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://test.sellandsign.com/webhook\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678461393653,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4569121,\\n \\\"timestamp\\\" : 1678461389000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4569121_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678461383556,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4569121,\\n \\\"timestamp\\\" : 1678461379000,\\n \\\"contractStatus\\\" : \\\"SIGNED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4569121_SIGNED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678375656982,\r\n \"webHookId\": 583,\r\n \"status\": 200,\r\n \"message\": \"{\\\"message\\\":\\\"received\\\"}\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 583,\\n \\\"contractId\\\" : 4562256,\\n \\\"timestamp\\\" : 1678375653000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"583_ contract_4562256_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://test.sellandsign.com/webhook\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678375656882,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4562256,\\n \\\"timestamp\\\" : 1678375653000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4562256_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678375649732,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4562256,\\n \\\"timestamp\\\" : 1678375641000,\\n \\\"contractStatus\\\" : \\\"SIGNED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4562256_SIGNED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678356948307,\r\n \"webHookId\": 583,\r\n \"status\": 200,\r\n \"message\": \"{\\\"message\\\":\\\"received\\\"}\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 583,\\n \\\"contractId\\\" : 4558833,\\n \\\"timestamp\\\" : 1678356942000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"583_ contract_4558833_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://test.sellandsign.com/webhook\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678356948230,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4558833,\\n \\\"timestamp\\\" : 1678356942000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4558833_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678356935062,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4558833,\\n \\\"timestamp\\\" : 1678356928000,\\n \\\"contractStatus\\\" : \\\"SIGNED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4558833_SIGNED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678282420166,\r\n \"webHookId\": 6626,\r\n \"status\": 200,\r\n \"message\": \"\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"signature\\\",\\n \\\"webhookId\\\" : 6626,\\n \\\"contractId\\\" : 4554209,\\n \\\"recipientId\\\" : 2427803,\\n \\\"signatureStatus\\\" : \\\"SIGNED\\\",\\n \\\"timestamp\\\" : 1678282417000,\\n \\\"uniqueKey\\\" : \\\"6626_ signature_4554209_null_2427803_SIGNED_null\\\"\\n}\",\r\n \"url\": \"https://webhook.site/c5b18af7-109a-472c-9893-799e0c6659a0\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678272088843,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4552968,\\n \\\"timestamp\\\" : 1678272086000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4552968_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678272088818,\r\n \"webHookId\": 583,\r\n \"status\": 200,\r\n \"message\": \"{\\\"message\\\":\\\"received\\\"}\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 583,\\n \\\"contractId\\\" : 4552968,\\n \\\"timestamp\\\" : 1678272086000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"583_ contract_4552968_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://test.sellandsign.com/webhook\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678272082535,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4552968,\\n \\\"timestamp\\\" : 1678272077000,\\n \\\"contractStatus\\\" : \\\"SIGNED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4552968_SIGNED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n }\r\n ]\r\n}"}],"_postman_id":"02c278e2-8882-423b-8fc2-658a3ff2afb2"},{"name":"View logs for one callback","id":"db53db5c-308a-4144-bbbd-a04a4ce4e0eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"This API call allows to consult the callbacks execution log for one given callback. It is useful to analyse failures of the callbacks calls.
\n","urlObject":{"path":["webhook",":id","logs","user"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"key":"email","value":null},{"key":"offset","value":"0"},{"key":"size","value":"20"}],"variable":[{"type":"any","value":"6784","key":"id"}]}},"response":[{"id":"69aac246-516c-4ef5-b507-a8e0e4ee33d3","name":"View logs for one callback","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"j_token","value":"5699057|TklngrkyKWgol6f7nq1qsLez5vL7fJHqXXeTGKF6wy0=","type":"text"}],"url":{"raw":"{{baseUrl}}/webhook/:id/logs/user","host":["{{baseUrl}}"],"path":["webhook",":id","logs","user"],"query":[{"key":"offset","value":"0","disabled":true},{"key":"size","value":"20","disabled":true}],"variable":[{"key":"id","value":"6789"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"logs\": [\r\n {\r\n \"timestamp\": 1678790975449,\r\n \"webHookId\": 6784,\r\n \"status\": 404,\r\n \"message\": \"I/O error on POST request for \\\"https://hookb.in/JKdBVwxrZBsg1WBgVkJV\\\": PKIX path validation failed: java.security.cert.CertPathValidatorException: validity check failed; nested exception is javax.net.ssl.SSLHandshakeException: PKIX path validation failed: java.security.cert.CertPathValidatorException: validity check failed\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 6784,\\n \\\"contractId\\\" : 4582360,\\n \\\"timestamp\\\" : 1678787363000,\\n \\\"contractStatus\\\" : \\\"OPENED\\\",\\n \\\"uniqueKey\\\" : \\\"6784_ contract_4582360_OPENED\\\"\\n}\",\r\n \"url\": \"https://hookb.in/JKdBVwxrZBsg1WBgVkJV\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678790975449,\r\n \"webHookId\": 6783,\r\n \"status\": 404,\r\n \"message\": \"I/O error on POST request for \\\"https://hookb.in/JKdBVwxrZBsg1WBgVkJV\\\": PKIX path validation failed: java.security.cert.CertPathValidatorException: validity check failed; nested exception is javax.net.ssl.SSLHandshakeException: PKIX path validation failed: java.security.cert.CertPathValidatorException: validity check failed\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 6783,\\n \\\"contractId\\\" : 4582360,\\n \\\"timestamp\\\" : 1678787363000,\\n \\\"contractStatus\\\" : \\\"OPENED\\\",\\n \\\"uniqueKey\\\" : \\\"6783_ contract_4582360_OPENED\\\"\\n}\",\r\n \"url\": \"https://hookb.in/JKdBVwxrZBsg1WBgVkJV\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678787374359,\r\n \"webHookId\": 6783,\r\n \"status\": 404,\r\n \"message\": \"I/O error on POST request for \\\"https://hookb.in/JKdBVwxrZBsg1WBgVkJV\\\": PKIX path validation failed: java.security.cert.CertPathValidatorException: validity check failed; nested exception is javax.net.ssl.SSLHandshakeException: PKIX path validation failed: java.security.cert.CertPathValidatorException: validity check failed\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 6783,\\n \\\"contractId\\\" : 4582360,\\n \\\"timestamp\\\" : 1678787363000,\\n \\\"contractStatus\\\" : \\\"OPENED\\\",\\n \\\"uniqueKey\\\" : \\\"6783_ contract_4582360_OPENED\\\"\\n}\",\r\n \"url\": \"https://hookb.in/JKdBVwxrZBsg1WBgVkJV\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678787374358,\r\n \"webHookId\": 6784,\r\n \"status\": 404,\r\n \"message\": \"I/O error on POST request for \\\"https://hookb.in/JKdBVwxrZBsg1WBgVkJV\\\": PKIX path validation failed: java.security.cert.CertPathValidatorException: validity check failed; nested exception is javax.net.ssl.SSLHandshakeException: PKIX path validation failed: java.security.cert.CertPathValidatorException: validity check failed\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 6784,\\n \\\"contractId\\\" : 4582360,\\n \\\"timestamp\\\" : 1678787363000,\\n \\\"contractStatus\\\" : \\\"OPENED\\\",\\n \\\"uniqueKey\\\" : \\\"6784_ contract_4582360_OPENED\\\"\\n}\",\r\n \"url\": \"https://hookb.in/JKdBVwxrZBsg1WBgVkJV\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678711491053,\r\n \"webHookId\": 583,\r\n \"status\": 200,\r\n \"message\": \"{\\\"message\\\":\\\"received\\\"}\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 583,\\n \\\"contractId\\\" : 4576592,\\n \\\"timestamp\\\" : 1678711483000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"583_ contract_4576592_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://test.sellandsign.com/webhook\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678711490751,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4576592,\\n \\\"timestamp\\\" : 1678711483000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4576592_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678711446610,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4576592,\\n \\\"timestamp\\\" : 1678711444000,\\n \\\"contractStatus\\\" : \\\"SIGNED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4576592_SIGNED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678461394035,\r\n \"webHookId\": 583,\r\n \"status\": 200,\r\n \"message\": \"{\\\"message\\\":\\\"received\\\"}\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 583,\\n \\\"contractId\\\" : 4569121,\\n \\\"timestamp\\\" : 1678461389000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"583_ contract_4569121_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://test.sellandsign.com/webhook\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678461393653,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4569121,\\n \\\"timestamp\\\" : 1678461389000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4569121_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678461383556,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4569121,\\n \\\"timestamp\\\" : 1678461379000,\\n \\\"contractStatus\\\" : \\\"SIGNED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4569121_SIGNED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678375656982,\r\n \"webHookId\": 583,\r\n \"status\": 200,\r\n \"message\": \"{\\\"message\\\":\\\"received\\\"}\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 583,\\n \\\"contractId\\\" : 4562256,\\n \\\"timestamp\\\" : 1678375653000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"583_ contract_4562256_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://test.sellandsign.com/webhook\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678375656882,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4562256,\\n \\\"timestamp\\\" : 1678375653000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4562256_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678375649732,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4562256,\\n \\\"timestamp\\\" : 1678375641000,\\n \\\"contractStatus\\\" : \\\"SIGNED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4562256_SIGNED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678356948307,\r\n \"webHookId\": 583,\r\n \"status\": 200,\r\n \"message\": \"{\\\"message\\\":\\\"received\\\"}\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 583,\\n \\\"contractId\\\" : 4558833,\\n \\\"timestamp\\\" : 1678356942000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"583_ contract_4558833_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://test.sellandsign.com/webhook\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678356948230,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4558833,\\n \\\"timestamp\\\" : 1678356942000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4558833_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678356935062,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4558833,\\n \\\"timestamp\\\" : 1678356928000,\\n \\\"contractStatus\\\" : \\\"SIGNED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4558833_SIGNED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678282420166,\r\n \"webHookId\": 6626,\r\n \"status\": 200,\r\n \"message\": \"\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"signature\\\",\\n \\\"webhookId\\\" : 6626,\\n \\\"contractId\\\" : 4554209,\\n \\\"recipientId\\\" : 2427803,\\n \\\"signatureStatus\\\" : \\\"SIGNED\\\",\\n \\\"timestamp\\\" : 1678282417000,\\n \\\"uniqueKey\\\" : \\\"6626_ signature_4554209_null_2427803_SIGNED_null\\\"\\n}\",\r\n \"url\": \"https://webhook.site/c5b18af7-109a-472c-9893-799e0c6659a0\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678272088843,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4552968,\\n \\\"timestamp\\\" : 1678272086000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4552968_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678272088818,\r\n \"webHookId\": 583,\r\n \"status\": 200,\r\n \"message\": \"{\\\"message\\\":\\\"received\\\"}\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 583,\\n \\\"contractId\\\" : 4552968,\\n \\\"timestamp\\\" : 1678272086000,\\n \\\"contractStatus\\\" : \\\"ARCHIVED\\\",\\n \\\"uniqueKey\\\" : \\\"583_ contract_4552968_ARCHIVED\\\"\\n}\",\r\n \"url\": \"https://test.sellandsign.com/webhook\",\r\n \"WebHookFilter\": []\r\n },\r\n {\r\n \"timestamp\": 1678272082535,\r\n \"webHookId\": 545,\r\n \"status\": 200,\r\n \"message\": \"\\nHey ya! Great to see you here. Btw, nothing is configured for this request path. Create a rule and start building a mock API.\\n\",\r\n \"payload\": \"{\\n \\\"type\\\" : \\\"contract\\\",\\n \\\"webhookId\\\" : 545,\\n \\\"contractId\\\" : 4552968,\\n \\\"timestamp\\\" : 1678272077000,\\n \\\"contractStatus\\\" : \\\"SIGNED\\\",\\n \\\"uniqueKey\\\" : \\\"545_ contract_4552968_SIGNED\\\"\\n}\",\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"WebHookFilter\": []\r\n }\r\n ]\r\n}"}],"_postman_id":"db53db5c-308a-4144-bbbd-a04a4ce4e0eb"},{"name":"Delete a callback","id":"1c68b0c8-714f-4384-b803-6394bc73bfea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"This API call deletes (i.e. deregisters) a given callback.
\n","urlObject":{"path":["webhook",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"6784","key":"id"}]}},"response":[{"id":"1d703058-79d6-44de-991d-f471c402e845","name":"Delete a callback","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"Application/json","type":"text"},{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUtl}}/webhook/:id","host":["{{baseUtl}}"],"path":["webhook",":id"],"variable":[{"key":"id","value":"6784"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"succeed\": true\r\n}"}],"_postman_id":"1c68b0c8-714f-4384-b803-6394bc73bfea"},{"name":"List callbacks","id":"ca2c74f2-5a49-4fc0-9066-59a9c61d446e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{apiToken}}","key":"This API call list the callbacks registered in a licence. The resulting list can be filtered by offset and limited in size.
\n","urlObject":{"path":["webhook"],"host":["{{baseUrl}}"],"query":[{"key":"offset","value":"0"},{"key":"size","value":"20"}],"variable":[]}},"response":[{"id":"680dc8c3-e718-49c6-a003-0593b189c22f","name":"List callbacks","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"j_token","value":"{{apiToken}}","type":"text"}],"url":{"raw":"{{baseUrl}}/webhook?offset=0&size=20","host":["{{baseUrl}}"],"path":["webhook"],"query":[{"key":"offset","value":"0"},{"key":"size","value":"20"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"webHookId\": 6796,\r\n \"webHookType\": \"signature\",\r\n \"ownerActorId\": 1536264,\r\n \"contractId\": 4582360,\r\n \"description\": \"MY SIGNATURE WEBHOOK\",\r\n \"endpoint\": {\r\n \"url\": \"https://XXXX.site/80262028e57cf\",\r\n \"headers\": [\r\n {\r\n \"name\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ]\r\n },\r\n \"events\": [\r\n \"SIGNED\"\r\n ],\r\n \"filter\": {}\r\n },\r\n {\r\n \"webHookId\": 6793,\r\n \"webHookType\": \"contract\",\r\n \"ownerActorId\": 1536264,\r\n \"contractId\": 4582360,\r\n \"description\": \"MY WEBHOOK\",\r\n \"endpoint\": {\r\n \"url\": \"https://XXXX.site/80262028e57cf\",\r\n \"headers\": [\r\n {\r\n \"name\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ]\r\n },\r\n \"events\": [\r\n \"ARCHIVED\",\r\n \"SIGNED\"\r\n ],\r\n \"filter\": {}\r\n },\r\n {\r\n \"webHookId\": 6788,\r\n \"webHookType\": \"signature\",\r\n \"ownerActorId\": 1536264,\r\n \"contractId\": -1,\r\n \"description\": \"MY SIGNATURE WEBHOOK\",\r\n \"endpoint\": {\r\n \"url\": \"https://XXXX.site/80262028e57cf\",\r\n \"headers\": [\r\n {\r\n \"name\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ]\r\n },\r\n \"events\": [\r\n \"SIGNED\"\r\n ],\r\n \"filter\": {}\r\n },\r\n {\r\n \"webHookId\": 6783,\r\n \"webHookType\": \"contract\",\r\n \"ownerActorId\": 1536264,\r\n \"contractId\": -1,\r\n \"description\": \"string\",\r\n \"endpoint\": {\r\n \"url\": \"https://hookb.in/JKdBVwxrZBsg1WBgVkJV\",\r\n \"headers\": [\r\n {\r\n \"name\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ]\r\n },\r\n \"events\": [\r\n \"OPENED\"\r\n ],\r\n \"filter\": {}\r\n },\r\n {\r\n \"webHookId\": 6757,\r\n \"webHookType\": \"signature\",\r\n \"ownerActorId\": 1536264,\r\n \"contractId\": 4578981,\r\n \"description\": \"MY SIGNTURE WEBHOOK BY CID\",\r\n \"endpoint\": {\r\n \"url\": \"https://webhook.site/83144065-1f1b-4767-ae06-0262028e57cf\"\r\n },\r\n \"events\": [\r\n \"SIGNED\"\r\n ],\r\n \"filter\": {}\r\n },\r\n {\r\n \"webHookId\": 6754,\r\n \"webHookType\": \"contract\",\r\n \"ownerActorId\": 1536264,\r\n \"contractId\": -1,\r\n \"description\": \"MY WEBHOOK\",\r\n \"endpoint\": {\r\n \"url\": \"https://webhook.site/83144065-1f1b-4767-ae06-0262028e57cf\"\r\n },\r\n \"events\": [\r\n \"ARCHIVED\",\r\n \"SIGNED\"\r\n ],\r\n \"filter\": {}\r\n },\r\n {\r\n \"webHookId\": 6747,\r\n \"webHookType\": \"signature\",\r\n \"ownerActorId\": 1536264,\r\n \"contractId\": -1,\r\n \"description\": \"MY SIGNATURE WEBHOOK\",\r\n \"endpoint\": {\r\n \"url\": \"https://webhook.site/8e3f13dd-2700-48f9-9c15-901500469683\"\r\n },\r\n \"events\": [\r\n \"SIGNED\"\r\n ],\r\n \"filter\": {}\r\n },\r\n {\r\n \"webHookId\": 6744,\r\n \"webHookType\": \"contract\",\r\n \"ownerActorId\": 1536264,\r\n \"contractId\": 4578236,\r\n \"description\": \"MY WEBHOOK\",\r\n \"endpoint\": {\r\n \"url\": \"https://webhook.site/83144065-1f1b-4767-ae06-0262028e57cf\"\r\n },\r\n \"events\": [\r\n \"ARCHIVED\",\r\n \"SIGNED\"\r\n ],\r\n \"filter\": {}\r\n },\r\n {\r\n \"webHookId\": 6626,\r\n \"webHookType\": \"signature\",\r\n \"ownerActorId\": 1536264,\r\n \"contractId\": 4554209,\r\n \"description\": \"string\",\r\n \"endpoint\": {\r\n \"url\": \"https://webhook.site/c5b18af7-109a-472c-9893-799e0c6659a0\",\r\n \"headers\": [\r\n {\r\n \"name\": \"myprettyheader\",\r\n \"value\": \"myheader\"\r\n }\r\n ]\r\n },\r\n \"events\": [\r\n \"SIGNED\"\r\n ],\r\n \"filter\": {}\r\n },\r\n {\r\n \"webHookId\": 647,\r\n \"webHookType\": \"signature\",\r\n \"ownerActorId\": 1536264,\r\n \"contractId\": 4138503,\r\n \"description\": \"un test2\",\r\n \"endpoint\": {\r\n \"url\": \"https://webhook.site/978181ef-68f9-48b6-88aa-1e7b59318884\"\r\n },\r\n \"events\": [\r\n \"SIGNED\",\r\n \"REFUSED\"\r\n ],\r\n \"filter\": {}\r\n },\r\n {\r\n \"webHookId\": 583,\r\n \"webHookType\": \"contract\",\r\n \"ownerActorId\": 1536264,\r\n \"contractId\": -1,\r\n \"description\": \"MY WEBHOOK\",\r\n \"endpoint\": {\r\n \"url\": \"https://test.sellandsign.com/webhook\",\r\n \"headers\": [\r\n {\r\n \"name\": \"my_token\",\r\n \"value\": \"Your contract is archived\"\r\n }\r\n ]\r\n },\r\n \"events\": [\r\n \"ARCHIVED\"\r\n ],\r\n \"filter\": {}\r\n },\r\n {\r\n \"webHookId\": 545,\r\n \"webHookType\": \"contract\",\r\n \"ownerActorId\": 1536264,\r\n \"contractId\": -1,\r\n \"description\": \"Licence webhook\",\r\n \"endpoint\": {\r\n \"url\": \"https://oolab.free.beeceptor.com\",\r\n \"headers\": [\r\n {\r\n \"name\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ]\r\n },\r\n \"events\": [\r\n \"ARCHIVED\",\r\n \"SIGNED\"\r\n ],\r\n \"filter\": {}\r\n }\r\n]"}],"_postman_id":"ca2c74f2-5a49-4fc0-9066-59a9c61d446e"}],"id":"a3efd9ab-8ef4-4890-b6d5-3a7cba987ae1","description":"Third-party software packages that create contracts and signature requests with our API can be notified of contract lifecycle states changes thanks to a callback mechanism.
\nOur callbacks are restful HTTP calls to endpoints provided by the third-party software editor.
\nWe provide a set of API endpoint to register and manage callback in an Oodrive Sign licence, as descirbed below.
\nThese endpoints allows the user to register an URL to return some data when the event triggers on Oodrive sign service.
\nIn order to follow up a contract sent to signature, it is possible to use webhooks endpoints that are used to listen to CONTRACT type events or SIGNATURE type events .
\nThe possible values of events on a CONTRACT type webhook are:
\nOPENED: Contract is sent and doesn't contain any signature
\nSIGNED : Contract is signed
\nCLOSED: Contract signed by signatory and sealed by organization with legal archiving set on licence.
\nARCHIVED: Contract signed by signatory and sealed by organization WITHOUT legal archiving set on licence.
\nCANCELED: Contract abondonned by the organization.
\nThe possible values of events on a SIGNATURE type webhook are:
\nSENT: Contract sent for signature
\nSIGNED: Contract signed by signatory
\nREFUSED: Contract refused by signatory
\nThe output will contain the new webhook id.
\nThere are 2 main types of callbacks:
\ncontract callbacks, that report contract status change (open, signed, closed, archived, abandoned)
\nsignature callbacks, that report signatory status change (signature or refusal)
\nThe contract callback payload has the following structure:
\n{\n \"type\": \"contract\",\n \"webhookId\": webhook_id,\n \"contractId\" : contract id,\n \"contractStatus\" : \"one of the following OPENNED / SIGNED / CLOSED / ARCHIVED / CANCELED\",\n \"timestamp\" : EPOCH UTC in milliseconds\n}\n\nThe signature callback payload has the follwing structure:
\n{\n \"type\": \"signature\",\n \"webhookId\": webhook_id,\n \"contractId\" : contract id,\n \"recipientId\" : recipient id, \n \"signatureStatus\" : \"one of the following SENT / SIGNED / REFUSED\",\n \"timestamp\" EPOCH UTC in milliseconds: \n}\n\nIf a callback request fails, for any reason, our system will send 3 retries (5 minutes after the failure, then 1 hour after the failure, then 24 hours after the failure).
\nAfter 32 failures the webhook is automatically disabled.
\nPlease note: if for any reason your system receives and processes a callback correctly, but the answer does not reach our system, our system will perform retries.
\n","_postman_id":"80022ee1-29d7-470d-9bda-21beb006743c"},{"name":"Sealing","item":[{"name":"Basic sealing","id":"e1ab8360-3bc1-4266-9baa-21826faa84ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"contract","value":"{ \"name\":\"my_contrat.pdf\" }","type":"text"},{"key":"pdfparts","type":"file","src":"okjSJCD8V/CONTRAT.pdf"}]},"url":"{{baseUrl}}/stamp","description":"Only PDF and file name are required.
\nAccording to \"Accept\" HTTP header, the result will be different:
\n* application/json : return the contract ID created\n* application/pdf : return the sealed PDF
\n","urlObject":{"path":["stamp"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"7b1dbcdc-0dcc-48fd-91aa-38524dfd7574","name":"Contract created and stamped","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"j_token","value":"StartFragment
\nThe hide_signature_page option is used to hide the default signature page. It cannot be used to force the automatic signature page.
\nIf the document already contains signature panels, this page is automatically hidden without needing to use this parameter.
If the document has no signature panel and this parameter is set to true, the automatic signature page will be hidden (the document will still be signed).
Default value is false.
\nEndFragment
\nNB: hide_signature_page must be a boolean, not a string: don't enclose value with quotes.
\n","urlObject":{"path":["stamp"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"8b2a6674-a69a-4ab9-b483-89d68e2b6a8c","name":"Contract created and stamped","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"j_token","value":"You can draw signature panel at specifics coordinates.
\nYou can control the drwaing of:
\n* vendor stamp : signature of your company
\n* trust stamp : oodrive signature
\nThe objects themselves can be omitted, but all the properties inside are required.
\nIf atleast one of these objects is passed the hide_signature_page parameter is force to true: the automatic signature page will be hidden.
\nIf only one of these objects is passed, only the corresponding stamp image will be visible in the final document. The other will be hidden.
\nIf the pageNumber value is more than the page count of the document, the last page of the document will be used instead.
\nIf the x and y positions are not fully included into a page, an error will be returned. But, you can ignore this error using the parameter silent_mode (if set to true no error will be returned).
\n{\n...\n \"silent_mode\": false,\n...\n}\n\nIf you just want add a certificate on a document, without any signatory, to certify the authenticty of a document and generate a proof folder, you can use the sealing feature.
\nTo create this kind of contract, just one call is required to add the PDF document, to sign it and to validate it.
\nNB: You need a specific license to use this feature. Please contact our sales team to enable it.
\n","_postman_id":"147b0847-86a2-4513-9238-40e202837fd9"},{"name":"Going live","item":[],"id":"2d4f02c7-a923-4f71-9bb2-a44a3e8a62db","description":"Once you have reached the end of your integration, you can turn your sandbox into a production environment, by updating the following API variables in your code:
\nWhen our delivery team delivers your production license, you will receive a document containing the correct values for each of these variables.
\n","_postman_id":"2d4f02c7-a923-4f71-9bb2-a44a3e8a62db"},{"name":"API reference","item":[],"id":"00a2055e-f67a-43cb-b737-90f058a0b505","description":"If you need our API’s OpenAPI description (JSON format) or if you want to consult our Swagger UI page, please click here.
\nOr here for OUTSCALE SNC
\n","_postman_id":"00a2055e-f67a-43cb-b737-90f058a0b505"}],"event":[{"listen":"prerequest","script":{"id":"98b4cad8-7f85-43eb-ad8f-8834e6849cf5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"276e5638-91df-4dbd-a87d-086288b0f607","type":"text/javascript","exec":[""]}}]}