{ "info": { "_postman_id": "d18e995d-155b-4908-a3b2-d3bcdfc318ab", "name": "CargoX Platform™ API", "description": "API documentation for interacting with CargoX Platform\n\nContact Support:\n Email: info@cargox.io", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "2fa/email", "item": [ { "name": "Generate and send email 2FA security code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"7cdb0c4f-0cdb-7ae5-1f6f-3ae4bae6912b\",\n \"verification_code\": \"commodo\",\n \"verification_hash\": \"Duis\",\n \"remember_me\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/2fa/email/", "host": ["{{baseUrl}}"], "path": ["2fa", "email", ""] }, "description": "Generates an email-based 2FA verification code that is sent to the user's email address." }, "response": [ { "name": "Returned when verification code is generated successfully.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"7cdb0c4f-0cdb-7ae5-1f6f-3ae4bae6912b\",\n \"verification_code\": \"commodo\",\n \"verification_hash\": \"Duis\",\n \"remember_me\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/2fa/email/", "host": ["{{baseUrl}}"], "path": ["2fa", "email", ""] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when user is not logged in.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"7cdb0c4f-0cdb-7ae5-1f6f-3ae4bae6912b\",\n \"verification_code\": \"commodo\",\n \"verification_hash\": \"Duis\",\n \"remember_me\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/2fa/email/", "host": ["{{baseUrl}}"], "path": ["2fa", "email", ""] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Validate email 2FA verification code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"7cdb0c4f-0cdb-7ae5-1f6f-3ae4bae6912b\",\n \"verification_code\": \"commodo\",\n \"verification_hash\": \"Duis\",\n \"remember_me\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/2fa/email/verify-code/", "host": ["{{baseUrl}}"], "path": ["2fa", "email", "verify-code", ""] }, "description": "\nThis method is used to validate verification code user entered on the login 2FA verification page. The code is sent to the \nuser by email.\n\n" }, "response": [ { "name": "Returned when verification code is valid.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"7cdb0c4f-0cdb-7ae5-1f6f-3ae4bae6912b\",\n \"verification_code\": \"commodo\",\n \"verification_hash\": \"Duis\",\n \"remember_me\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/2fa/email/verify-code/", "host": ["{{baseUrl}}"], "path": ["2fa", "email", "verify-code", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"0664aa6e-6c4c-5a52-996a-31cfb3f71976\",\n \"user_id\": \"ex cillum\",\n \"verification_code\": \"ex proident\",\n \"verification_hash\": \"dolor\",\n \"remember_me\": false\n}" }, { "name": "Returned if the authentication credentials were not provided or request is made by a third party system.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"7cdb0c4f-0cdb-7ae5-1f6f-3ae4bae6912b\",\n \"verification_code\": \"commodo\",\n \"verification_hash\": \"Duis\",\n \"remember_me\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/2fa/email/verify-code/", "host": ["{{baseUrl}}"], "path": ["2fa", "email", "verify-code", ""] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when verification code is not valid or has expired.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"7cdb0c4f-0cdb-7ae5-1f6f-3ae4bae6912b\",\n \"verification_code\": \"commodo\",\n \"verification_hash\": \"Duis\",\n \"remember_me\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/2fa/email/verify-code/", "host": ["{{baseUrl}}"], "path": ["2fa", "email", "verify-code", ""] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned if verification code is not provided.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"7cdb0c4f-0cdb-7ae5-1f6f-3ae4bae6912b\",\n \"verification_code\": \"commodo\",\n \"verification_hash\": \"Duis\",\n \"remember_me\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/2fa/email/verify-code/", "host": ["{{baseUrl}}"], "path": ["2fa", "email", "verify-code", ""] } }, "code": 472, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Validate 2FA cookie verification hash", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "verification_hash", "value": "id dolor enim in", "description": "(Required) Verification hash to be validated." } ] }, "url": { "raw": "{{baseUrl}}/2fa/email/verify-hash/", "host": ["{{baseUrl}}"], "path": ["2fa", "email", "verify-hash", ""] }, "description": "\nThis method is used to validate 2FA verification hash stored in a cookie. Verification hash is valid for 30 days.\n\n" }, "response": [ { "name": "Returned when verification hash is valid.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "verification_hash", "value": "id dolor enim in", "description": "(Required) Verification hash to be validated." } ] }, "url": { "raw": "{{baseUrl}}/2fa/email/verify-hash/", "host": ["{{baseUrl}}"], "path": ["2fa", "email", "verify-hash", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"0664aa6e-6c4c-5a52-996a-31cfb3f71976\",\n \"user_id\": \"ex cillum\",\n \"verification_code\": \"ex proident\",\n \"verification_hash\": \"dolor\",\n \"remember_me\": false\n}" }, { "name": "Returned if the authentication credentials were not provided or request is made by a third party system.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "verification_hash", "value": "id dolor enim in", "description": "(Required) Verification hash to be validated." } ] }, "url": { "raw": "{{baseUrl}}/2fa/email/verify-hash/", "host": ["{{baseUrl}}"], "path": ["2fa", "email", "verify-hash", ""] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when verification hash is not valid or has expired.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "verification_hash", "value": "id dolor enim in", "description": "(Required) Verification hash to be validated." } ] }, "url": { "raw": "{{baseUrl}}/2fa/email/verify-hash/", "host": ["{{baseUrl}}"], "path": ["2fa", "email", "verify-hash", ""] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned if verification hash is not provided.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "verification_hash", "value": "id dolor enim in", "description": "(Required) Verification hash to be validated." } ] }, "url": { "raw": "{{baseUrl}}/2fa/email/verify-hash/", "host": ["{{baseUrl}}"], "path": ["2fa", "email", "verify-hash", ""] } }, "code": 472, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "aci-filing/notifications", "item": [ { "name": "Create ACI filing notification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "cargox_id", "value": "labore deserunt laborum", "description": "(Required) \nThe string value of the UUID-4 number assigned by CargoX that uniquely identifies an organization.\n" }, { "key": "acid_number", "value": "aliquip in", "description": "(Required) \nThe ACID number of Advance Cargo Information request that has been approved for shipping.\n" }, { "key": "message", "value": "officia nostrud", "description": "\nThe message for the recipient of the ACI filing notification.\n" }, { "key": "importer_taxation_number", "value": "dolore proident in sint", "description": "\nThe importer taxation number of Advance Cargo Information request that has been approved for shipping.\n" }, { "key": "exporter_taxation_number", "value": "eu", "description": "\nThe exporter taxation number of Advance Cargo Information request that has been approved for shipping.\n" }, { "key": "importer_data", "value": "{\"name\":\"enim incididunt\",\"value\":\"pariatur irure\"}", "description": "\nA list of objects that describe importer. Each object represents importer field.\n\n| Parameter | Description |\n|-------------------------|-----------------------------------------------------------------|\n| `name` | Name (label) of field. |\n| `value` | Value of field. |\n" }, { "key": "importer_data", "value": "{\"name\":\"ad quis eiusmod\",\"value\":\"officia\"}", "description": "\nA list of objects that describe importer. Each object represents importer field.\n\n| Parameter | Description |\n|-------------------------|-----------------------------------------------------------------|\n| `name` | Name (label) of field. |\n| `value` | Value of field. |\n" }, { "key": "exporter_data", "value": "{\"name\":\"i\",\"value\":\"do ea aliqu\"}", "description": "\nA list of objects that describe exporter. Each object represents exporter field.\n\n| Parameter | Description |\n|-------------------------|-----------------------------------------------------------------|\n| `name` | Name (label) of field. |\n| `value` | Value of field. |\n" }, { "key": "exporter_data", "value": "{\"name\":\"ipsum veniam laborum labore\",\"value\":\"i\"}", "description": "\nA list of objects that describe exporter. Each object represents exporter field.\n\n| Parameter | Description |\n|-------------------------|-----------------------------------------------------------------|\n| `name` | Name (label) of field. |\n| `value` | Value of field. |\n" }, { "key": "shipment_data", "value": "{\"name\":\"adipisicing laborum in proident\",\"value\":\"labore culpa laboris veniam\"}", "description": "\nA list of objects that describe shipment. Each object represents shipment field.\n\n| Parameter | Description |\n|-------------------------|-----------------------------------------------------------------|\n| `name` | Name (label) of field. |\n| `value` | Value of field. |\n" }, { "key": "shipment_data", "value": "{\"name\":\"cillum esse mollit aliquip aliqua\",\"value\":\"nisi occaecat\"}", "description": "\nA list of objects that describe shipment. Each object represents shipment field.\n\n| Parameter | Description |\n|-------------------------|-----------------------------------------------------------------|\n| `name` | Name (label) of field. |\n| `value` | Value of field. |\n" }, { "key": "expires", "value": "in", "description": "\nThe datetime string when the ACID number expires. Datetime must be in ISO-8601 format (YYYY-MM-DD HH:MM[:ss[.uuuuuu]][TZ]). Example: 2021-08-21 08:45:55+02:00 (CEST time zone).\n" } ] }, "url": { "raw": "{{baseUrl}}/aci-filing/notifications/", "host": ["{{baseUrl}}"], "path": ["aci-filing", "notifications", ""] }, "description": "Creates a new ACI filing notification for a company." }, "response": [ { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "cargox_id", "value": "adipisici", "description": "(Required) \nThe string value of the UUID-4 number assigned by CargoX that uniquely identifies an organization.\n" }, { "key": "acid_number", "value": "adipisicing ea elit ut est", "description": "(Required) \nThe ACID number of Advance Cargo Information request that has been approved for shipping.\n" }, { "key": "message", "value": "dolore culpa veniam id", "description": "\nThe message for the recipient of the ACI filing notification.\n" }, { "key": "importer_taxation_number", "value": "nisi nulla", "description": "\nThe importer taxation number of Advance Cargo Information request that has been approved for shipping.\n" }, { "key": "exporter_taxation_number", "value": "officia consectetur eiusmod", "description": "\nThe exporter taxation number of Advance Cargo Information request that has been approved for shipping.\n" }, { "key": "importer_data", "value": "{\"name\":\"sed tempor irure\",\"value\":\"sunt ullamco et\"}", "description": "\nA list of objects that describe importer. Each object represents importer field.\n\n| Parameter | Description |\n|-------------------------|-----------------------------------------------------------------|\n| `name` | Name (label) of field. |\n| `value` | Value of field. |\n" }, { "key": "importer_data", "value": "{\"name\":\"enim aliqua deserunt\",\"value\":\"sunt tempor pariatur in\"}", "description": "\nA list of objects that describe importer. Each object represents importer field.\n\n| Parameter | Description |\n|-------------------------|-----------------------------------------------------------------|\n| `name` | Name (label) of field. |\n| `value` | Value of field. |\n" }, { "key": "exporter_data", "value": "{\"name\":\"magna adipisicing ut\",\"value\":\"id ex cupidatat\"}", "description": "\nA list of objects that describe exporter. Each object represents exporter field.\n\n| Parameter | Description |\n|-------------------------|-----------------------------------------------------------------|\n| `name` | Name (label) of field. |\n| `value` | Value of field. |\n" }, { "key": "exporter_data", "value": "{\"name\":\"do\",\"value\":\"consectetur adipisicing\"}", "description": "\nA list of objects that describe exporter. Each object represents exporter field.\n\n| Parameter | Description |\n|-------------------------|-----------------------------------------------------------------|\n| `name` | Name (label) of field. |\n| `value` | Value of field. |\n" }, { "key": "shipment_data", "value": "{\"name\":\"Lorem irure nulla id nisi\",\"value\":\"et enim commodo Duis consequat\"}", "description": "\nA list of objects that describe shipment. Each object represents shipment field.\n\n| Parameter | Description |\n|-------------------------|-----------------------------------------------------------------|\n| `name` | Name (label) of field. |\n| `value` | Value of field. |\n" }, { "key": "shipment_data", "value": "{\"name\":\"ipsum eiusmod nisi\",\"value\":\"eu elit laborum\"}", "description": "\nA list of objects that describe shipment. Each object represents shipment field.\n\n| Parameter | Description |\n|-------------------------|-----------------------------------------------------------------|\n| `name` | Name (label) of field. |\n| `value` | Value of field. |\n" }, { "key": "expires", "value": "laboris non esse", "description": "\nThe datetime string when the ACID number expires. Datetime must be in ISO-8601 format (YYYY-MM-DD HH:MM[:ss[.uuuuuu]][TZ]). Example: 2021-08-21 08:45:55+02:00 (CEST time zone).\n" } ] }, "url": { "raw": "{{baseUrl}}/aci-filing/notifications/", "host": ["{{baseUrl}}"], "path": ["aci-filing", "notifications", ""] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company is not found or ACID number is not valid.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "cargox_id", "value": "adipisici", "description": "(Required) \nThe string value of the UUID-4 number assigned by CargoX that uniquely identifies an organization.\n" }, { "key": "acid_number", "value": "adipisicing ea elit ut est", "description": "(Required) \nThe ACID number of Advance Cargo Information request that has been approved for shipping.\n" }, { "key": "message", "value": "dolore culpa veniam id", "description": "\nThe message for the recipient of the ACI filing notification.\n" }, { "key": "importer_taxation_number", "value": "nisi nulla", "description": "\nThe importer taxation number of Advance Cargo Information request that has been approved for shipping.\n" }, { "key": "exporter_taxation_number", "value": "officia consectetur eiusmod", "description": "\nThe exporter taxation number of Advance Cargo Information request that has been approved for shipping.\n" }, { "key": "importer_data", "value": "{\"name\":\"sed tempor irure\",\"value\":\"sunt ullamco et\"}", "description": "\nA list of objects that describe importer. Each object represents importer field.\n\n| Parameter | Description |\n|-------------------------|-----------------------------------------------------------------|\n| `name` | Name (label) of field. |\n| `value` | Value of field. |\n" }, { "key": "importer_data", "value": "{\"name\":\"enim aliqua deserunt\",\"value\":\"sunt tempor pariatur in\"}", "description": "\nA list of objects that describe importer. Each object represents importer field.\n\n| Parameter | Description |\n|-------------------------|-----------------------------------------------------------------|\n| `name` | Name (label) of field. |\n| `value` | Value of field. |\n" }, { "key": "exporter_data", "value": "{\"name\":\"magna adipisicing ut\",\"value\":\"id ex cupidatat\"}", "description": "\nA list of objects that describe exporter. Each object represents exporter field.\n\n| Parameter | Description |\n|-------------------------|-----------------------------------------------------------------|\n| `name` | Name (label) of field. |\n| `value` | Value of field. |\n" }, { "key": "exporter_data", "value": "{\"name\":\"do\",\"value\":\"consectetur adipisicing\"}", "description": "\nA list of objects that describe exporter. Each object represents exporter field.\n\n| Parameter | Description |\n|-------------------------|-----------------------------------------------------------------|\n| `name` | Name (label) of field. |\n| `value` | Value of field. |\n" }, { "key": "shipment_data", "value": "{\"name\":\"Lorem irure nulla id nisi\",\"value\":\"et enim commodo Duis consequat\"}", "description": "\nA list of objects that describe shipment. Each object represents shipment field.\n\n| Parameter | Description |\n|-------------------------|-----------------------------------------------------------------|\n| `name` | Name (label) of field. |\n| `value` | Value of field. |\n" }, { "key": "shipment_data", "value": "{\"name\":\"ipsum eiusmod nisi\",\"value\":\"eu elit laborum\"}", "description": "\nA list of objects that describe shipment. Each object represents shipment field.\n\n| Parameter | Description |\n|-------------------------|-----------------------------------------------------------------|\n| `name` | Name (label) of field. |\n| `value` | Value of field. |\n" }, { "key": "expires", "value": "laboris non esse", "description": "\nThe datetime string when the ACID number expires. Datetime must be in ISO-8601 format (YYYY-MM-DD HH:MM[:ss[.uuuuuu]][TZ]). Example: 2021-08-21 08:45:55+02:00 (CEST time zone).\n" } ] }, "url": { "raw": "{{baseUrl}}/aci-filing/notifications/", "host": ["{{baseUrl}}"], "path": ["aci-filing", "notifications", ""] } }, "code": 471, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Compose draft from ACI filing notification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cargox_id\": \"eu ad\",\n \"acid_number\": \"Lor\",\n \"message\": \"qui eiusmod sit\",\n \"importer_taxation_number\": \"consequat fugiat\",\n \"exporter_taxation_number\": \"labore volupt\",\n \"importer_data\": {},\n \"exporter_data\": {},\n \"shipment_data\": {},\n \"created\": \"1948-03-30T15:59:07.199Z\",\n \"expires\": \"1954-01-29T20:59:25.711Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/aci-filing/notifications/create-draft/", "host": ["{{baseUrl}}"], "path": ["aci-filing", "notifications", "create-draft", ""] }, "description": "\nThis endpoint creates a new draft from an existing ACI filing notification.\n" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"cargox_id\": \"eu ad\",\n \"acid_number\": \"Lor\",\n \"message\": \"qui eiusmod sit\",\n \"importer_taxation_number\": \"consequat fugiat\",\n \"exporter_taxation_number\": \"labore volupt\",\n \"importer_data\": {},\n \"exporter_data\": {},\n \"shipment_data\": {},\n \"created\": \"1948-03-30T15:59:07.199Z\",\n \"expires\": \"1954-01-29T20:59:25.711Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/aci-filing/notifications/create-draft/", "host": ["{{baseUrl}}"], "path": ["aci-filing", "notifications", "create-draft", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:86e85e14-cecd-ed34-833c-1d90f45fa2b4\",\n \"owner_id\": \"reprehenderit aute laboris\",\n \"recipient_id\": \"cupidatat in ullamco\",\n \"message\": \"sint do nostrud\",\n \"type\": \"non c\",\n \"specialization_type\": \"acid\",\n \"created\": \"cupidatat tempor in id\",\n \"sent\": \"1961-05-03T11:40:37.309Z\",\n \"archived\": \"1965-09-10T09:58:49.044Z\",\n \"delivered\": \"ut in\",\n \"action_performed_by_id\": \"deserunt in nostrud\",\n \"action_performed_by\": {\n \"email\": \"3hypR2GBlXl@AcewmAMIKXLmZqDFKRcS.pcx\",\n \"telephone\": \"qui occaeca\",\n \"name\": \"sed aliqua ut consequat eiusmod\",\n \"first_name\": \"sit occaecat\",\n \"last_name\": \"magna aute culpa anim ut\",\n \"company_id\": \"sint cillum\",\n \"company\": {\n \"name\": \"officia quis\",\n \"address\": \"esse q\",\n \"postal_code\": \"Duis exercitation tempor ullamco\",\n \"city\": \"pariatur commodo est deserunt\",\n \"branch\": \"proident Lorem cupidatat fugiat\",\n \"address2\": \"reprehenderit Duis\",\n \"country\": \"LA\",\n \"country_name\": \"veniam consequat e\",\n \"website\": \"veniam ex laboris dolor incididunt\",\n \"vat_number\": \"in ad anim\",\n \"logo\": \"http://GSzLTWpyjkOCCbgkhzLjsDhQgEs.eqnaxDw617j3yTqNicxSwEKxomPXPxpdsNimIVzuGM.wKXNKrUGUSm+5y6y\",\n \"logo_name\": \"dolor veniam eiusmod\",\n \"created\": \"1954-10-19T05:36:20.122Z\",\n \"id\": \"urn:uuid:a097a975-9e09-fd29-8040-e71e29bfdaf7\",\n \"verified_bank\": \"adipisicing consequat est et\",\n \"verified_dnb\": \"non commodo\"\n },\n \"logo\": \"http://FpFEXRmkkRgsAPooTowlTXBc.oqau63pDzEbqszLcKqIO9ZmXTOlUkHK+TcwNqnJXPQRhHX--JQQbekfFdZMW\",\n \"logo_name\": \"nostrud officia nisi\",\n \"id\": \"urn:uuid:710ef096-e0cf-9944-6266-a597d8194fc0\"\n },\n \"action_performed_by_company_id\": \"id sit\",\n \"action_performed_by_company\": {\n \"name\": \"dolore Lorem non\",\n \"address\": \"eu tempor nostrud\",\n \"postal_code\": \"in\",\n \"city\": \"laboris fugiat\",\n \"branch\": \"veniam qui\",\n \"address2\": \"esse non\",\n \"country\": \"TK\",\n \"country_name\": \"do dolor ex\",\n \"website\": \"aliqua proident id \",\n \"vat_number\": \"Duis\",\n \"logo\": \"https://UlONuzTiWXgdTfKKWbbmMXHWAxHnpv.umfrqnZO.wimPohE3kD9BxeUMjPpCiHD.IZBSZiYoCKzB3J6O2z5jHVAZO\",\n \"logo_name\": \"pariatur labore\",\n \"created\": \"2003-01-18T07:25:36.372Z\",\n \"id\": \"47e4b887-17a6-995f-8cd7-8a4e1bb60863\",\n \"verified_bank\": \"ea nostrud dolor elit\",\n \"verified_dnb\": \"amet ut dolore aute\"\n },\n \"sealed\": false,\n \"can_be_sealed\": \"pariatur exercitation incididunt dolor\",\n \"is_draft\": \"veniam proident\",\n \"sender_inbox_id\": \"proident\",\n \"sender\": {\n \"name\": \"tempor adipisicing aliqua\",\n \"address\": \"ad proident nostrud enim mollit\",\n \"postal_code\": \"fugiat in eu Excepteur\",\n \"city\": \"est nostrud minim\",\n \"branch\": \"in aliquip i\",\n \"address2\": \"et ad fugiat\",\n \"country\": \"TZ\",\n \"country_name\": \"anim amet\",\n \"website\": \"ea\",\n \"vat_number\": \"consectetur consequat\",\n \"logo\": \"https://jfpRSND.bogyfEdv80BxtAE0IcWE6EWsTjkIzHKpAOF+YeHxC2MhmXKIuLUD72UIGRXtE8lsUsBduzwZ51ot\",\n \"logo_name\": \"qui ullamco culpa eu\",\n \"created\": \"1999-07-29T11:23:05.242Z\",\n \"id\": \"3adbe238-7dc0-00ba-f282-af97f7cb60f6\",\n \"verified_bank\": \"dolor amet\",\n \"verified_dnb\": \"laborum esse sunt\"\n },\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"labore quis qui enim\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": false,\n \"read_by_user\": \"consequat\",\n \"documents\": [\n \"culpa aliquip\",\n \"irure anim cillum nulla\"\n ],\n \"existing_attachments\": {},\n \"attachments\": [\n {\n \"document_token_id\": \"in est Duis enim qui\",\n \"id\": \"38d5e889-d301-2329-6381-c31618c0087c\",\n \"envelope_id\": \"dolor aliqua commodo ut incididunt\",\n \"document_token\": {\n \"id\": \"urn:uuid:08149705-036e-42d5-d1ac-3ddddb23fc37\",\n \"storage_type\": \"et in\",\n \"watermark_generated\": false,\n \"ipfs_document_group_id\": \"cupidatat tempor commodo voluptate\",\n \"ipfs_document_group\": \"d8a5bb1e-19f7-0037-74e3-36ae9aac7400\",\n \"document_id\": \"dolore minim\",\n \"document\": {\n \"document_type\": \"dolor exercitation aliqua laboris Ut\",\n \"create_on_blockchain_override\": true,\n \"id\": \"7e418d82-838b-c339-e22f-b83dab3d2ae0\",\n \"current_owner_id\": \"dolor\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"ut commodo nostrud\",\n \"uploaded_by\": {\n \"email\": \"WaS6ls1@BTxKVeXDAHdzmtoLRqzTjQuiA.jfy\",\n \"telephone\": \"ir\",\n \"name\": \"proident laborum mollit anim\",\n \"first_name\": \"mollit nisi in cupidatat\",\n \"last_name\": \"veniam proident esse reprehenderit\",\n \"company_id\": \"anim quis irure dolore nulla\",\n \"company\": {\n \"name\": \"elit mollit\",\n \"address\": \"sint adipisicing\",\n \"postal_code\": \"sunt in\",\n \"city\": \"do eiusmod \",\n \"branch\": \"dolore ad dolor in\",\n \"address2\": \"reprehenderit incididunt sit\",\n \"country\": \"KY\",\n \"country_name\": \"do nulla ea\",\n \"website\": \"ad\",\n \"vat_number\": \"commodo sed aliquip\",\n \"logo\": \"http://r.lyhefduXbGj4bQ\",\n \"logo_name\": \"dolore veniam in anim\",\n \"created\": \"1983-05-09T08:32:25.080Z\",\n \"id\": \"urn:uuid:fc9ad85c-2c96-9cba-d676-90cdd24490cf\",\n \"verified_bank\": \"cupidatat ut elit minim Ut\",\n \"verified_dnb\": \"ipsum cupidatat\"\n },\n \"logo\": \"http://nJGEqwi.aauUxZMy.GO26MNDKyRSNc2v3.T.lpfT58,LkOJE3x\",\n \"logo_name\": \"anim\",\n \"id\": \"urn:uuid:a546a981-8ccb-0544-07da-ec459620cbe6\"\n },\n \"uploaded_by_company_id\": \"commodo Excepteur ut cillum\",\n \"uploaded_by_company\": {\n \"name\": \"consequat id\",\n \"address\": \"ex adipisicing sit in mollit\",\n \"postal_code\": \"officia consequat nulla ut sit\",\n \"city\": \"ullamco adipisicing\",\n \"branch\": \"sed nulla\",\n \"address2\": \"sunt eiusmod minim pariatur\",\n \"country\": \"MX\",\n \"country_name\": \"eiusmod ullamco irure\",\n \"website\": \"d\",\n \"vat_number\": \"sed proident dolore\",\n \"logo\": \"http://ERlCZiglV.xffjRmBKrUpT1dFC+Ed7vxVLmhupbGGl53XYROoqNzG,+JHqvVYgw7sHgmm2XC4AkeWCxV\",\n \"logo_name\": \"ea quis\",\n \"created\": \"1992-11-09T05:13:13.544Z\",\n \"id\": \"urn:uuid:905a34e9-096e-d416-32c2-bc85f49fc56b\",\n \"verified_bank\": \"Ut voluptate inci\",\n \"verified_dnb\": \"est incididunt consectetur in\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"est\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"magna\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"2002-04-26T15:45:55.176Z\",\n \"accomplished_by_id\": \"id cupidatat \",\n \"accomplished_by_company_id\": \"dolor sed nostrud consectetur\",\n \"destroyed\": \"2000-08-18T17:54:12.752Z\",\n \"destroyed_by_company_id\": \"eiusmod\",\n \"notify_parties\": [\n \"RAFioSyeyM8n@eXxhLcWbYjXp.tsu\",\n \"4B7dE3Y@aUEfmuvSmtIaZenSoDlc.eoxa\"\n ],\n \"meta_data\": {},\n \"display_name\": \"ullamco ut in\",\n \"file_name\": \"consequat fugiat\",\n \"file_size\": 37932714,\n \"file_content_type\": \"proident officia mollit do labore\",\n \"watermarkable\": true,\n \"icon\": \"qui culpa in cupidatat quis\",\n \"file_type\": \"non culpa venia\",\n \"created\": \"pariatur esse\",\n \"thumbnail\": \"http://tvIskOGUJEReJaHnse.gwvleIcTqgzZlr4lxsHfwZSPp2Y9TWdYlK5-JpjvA7exCHw2\",\n \"thumbnail_mime_type\": \"cupidatat commodo do velit\"\n },\n \"attachment_count\": -75400975,\n \"is_on_blockchain\": false,\n \"can_be_destroyed\": \"ipsum et\",\n \"can_be_accomplished\": \"pariatur do magna\",\n \"destroy_pending\": \"dolore anim non Lorem\",\n \"accomplish_pending\": \"in\",\n \"created\": \"non minim\"\n },\n \"used_in_envelope_id\": \"consequat sunt pariatur\",\n \"used_in_envelope\": {\n \"id\": \"861f4ad1-ca8e-8c5c-ad04-68bbc3ab16cd\",\n \"owner_id\": \"dolor magna ut labore\",\n \"recipient_id\": \"ut est\",\n \"message\": \"voluptate magna dolore aliquip\",\n \"type\": \"deserunt officia laborum\",\n \"specialization_type\": \"standard\",\n \"created\": \"ea velit\",\n \"sent\": \"1986-08-04T23:01:34.578Z\",\n \"archived\": \"1980-01-13T20:19:32.350Z\",\n \"delivered\": \"aliquip irure deserunt qui ut\",\n \"action_performed_by_id\": \"anim est laborum quis\",\n \"sealed\": false,\n \"can_be_sealed\": \"dolore minim deserunt velit\",\n \"is_draft\": \"commodo ea\",\n \"sender_inbox_id\": \"adipisicing consectetur Duis\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"ut commodo ut\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": false,\n \"delivered_envelope_id\": \"et \",\n \"failed_delivery_envelope_id\": \"incididunt proident mollit nostrud occaecat\",\n \"failed_outgoing_id\": \"sint nisi non in eiusmod\",\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"irure sit ad amet\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": true,\n \"created\": \"1986-06-28T00:29:49.941Z\"\n },\n {\n \"document_token_id\": \"reprehenderit dolore\",\n \"id\": \"a0f88fc7-f2ed-32c4-656c-9adb23564a79\",\n \"envelope_id\": \"aliqua amet\",\n \"document_token\": {\n \"id\": \"urn:uuid:9620dcab-9b01-903d-eeee-7cb497062bfc\",\n \"storage_type\": \"nisi veniam cillum consectetur\",\n \"watermark_generated\": false,\n \"ipfs_document_group_id\": \"consectetur velit magna sint\",\n \"ipfs_document_group\": \"urn:uuid:208f7536-eb42-25f9-2f43-ae4d93c405eb\",\n \"document_id\": \"irure ea eu pariatur\",\n \"document\": {\n \"document_type\": \"cillum ut\",\n \"create_on_blockchain_override\": false,\n \"id\": \"315f29df-6ac2-9756-733e-e32a2a538634\",\n \"current_owner_id\": \"in\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"sunt ea dolore\",\n \"uploaded_by\": {\n \"email\": \"k2k@pe.qs\",\n \"telephone\": \"esse non Ut\",\n \"name\": \"eiusmod consequat quis veniam\",\n \"first_name\": \"velit ipsum\",\n \"last_name\": \"pariatur mollit anim\",\n \"company_id\": \"anim incididunt commodo deserunt\",\n \"company\": {\n \"name\": \"laboris nisi tempor ut deserunt\",\n \"address\": \"sunt laborum dolore\",\n \"postal_code\": \"cupidatat Excepteur\",\n \"city\": \"incididunt ullamco voluptate minim\",\n \"branch\": \"laboris ea exercitation\",\n \"address2\": \"deserunt Ut\",\n \"country\": \"BE\",\n \"country_name\": \"aliqua aute\",\n \"website\": \"sit velit laboris ex quis\",\n \"vat_number\": \"aliqua laboris magna officia\",\n \"logo\": \"http://EBWsviIDCE.tybxR0IegynGbedZSF-UMbJp8Q6ctEZRctHwOTYD05\",\n \"logo_name\": \"cupidatat aute ipsum magna sunt\",\n \"created\": \"1956-10-10T05:24:54.248Z\",\n \"id\": \"1493b7e5-227f-2836-1aae-47f4fbc5aa8a\",\n \"verified_bank\": \"dolore\",\n \"verified_dnb\": \"dolore ad eiusmod fu\"\n },\n \"logo\": \"http://qDJbJBAsUVZxk.vmfDT,PG5Tz,rVbF844JTWB.3Y2KL21YxoLuFKtla\",\n \"logo_name\": \"velit nisi commodo\",\n \"id\": \"urn:uuid:6b1b2ad3-47b3-9aa5-4afa-c2ddaf8d85c6\"\n },\n \"uploaded_by_company_id\": \"minim Ut ea non\",\n \"uploaded_by_company\": {\n \"name\": \"ea quis laborum\",\n \"address\": \"et esse laboris anim\",\n \"postal_code\": \"nulla proident dolor anim\",\n \"city\": \"Lorem Excepteur\",\n \"branch\": \"incidid\",\n \"address2\": \"sed cillum esse in\",\n \"country\": \"GY\",\n \"country_name\": \"sunt incididunt fugiat deserunt\",\n \"website\": \"consequat aliqua \",\n \"vat_number\": \"non mollit\",\n \"logo\": \"http://eyyrGTJGVyCKzBcZApRkHWnEV.hztB66JlYhXQSxqX-hnwVwRoSxiHY3o7HB,lgpqQDUDmz.1g\",\n \"logo_name\": \"consequat mollit nulla anim ullamco\",\n \"created\": \"1976-03-13T05:59:23.727Z\",\n \"id\": \"urn:uuid:1cb12d51-9c25-782a-24b2-a5c25c8796f9\",\n \"verified_bank\": \"eiusmod cillum culpa reprehenderit\",\n \"verified_dnb\": \"deserunt ullamco\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"ad ex ut\",\n \"create_on_blockchain\": false,\n \"accomplisher_id\": \"ut consectetur pariatur veniam\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"1951-02-06T06:52:07.272Z\",\n \"accomplished_by_id\": \"culpa\",\n \"accomplished_by_company_id\": \"do esse et\",\n \"destroyed\": \"1993-12-04T03:31:41.907Z\",\n \"destroyed_by_company_id\": \"ea ut\",\n \"notify_parties\": [\n \"zHt9NzpdriGi@ffhzNtbvmKYeRfX.efpl\",\n \"mZM0BpTa3oMZCo@NiiPIsSHFoZPWgHiwjBjAbMXppPkF.sd\"\n ],\n \"meta_data\": {},\n \"display_name\": \"nisi cupidatat et\",\n \"file_name\": \"dolor qui cupidatat consectetur Ut\",\n \"file_size\": 54138022,\n \"file_content_type\": \"ex deserunt sit ut\",\n \"watermarkable\": false,\n \"icon\": \"non id sint in anim\",\n \"file_type\": \"Lorem est\",\n \"created\": \"consequat labore commodo dolor\",\n \"thumbnail\": \"http://fKwyQ.xtrjpzuGmHUouSkCRtkSRRtAS\",\n \"thumbnail_mime_type\": \"aliqua in magna\"\n },\n \"attachment_count\": -61388604,\n \"is_on_blockchain\": false,\n \"can_be_destroyed\": \"sit pariatur consequat\",\n \"can_be_accomplished\": \"non ex\",\n \"destroy_pending\": \"ut proident\",\n \"accomplish_pending\": \"Lorem Ut fugi\",\n \"created\": \"sit\"\n },\n \"used_in_envelope_id\": \"anim\",\n \"used_in_envelope\": {\n \"id\": \"3ea8e39e-cabc-8598-80b7-dfcf679b7aff\",\n \"owner_id\": \"Duis non eiusmod sed\",\n \"recipient_id\": \"proident fugiat dolore\",\n \"message\": \"dolore aute mollit dolore\",\n \"type\": \"mollit elit\",\n \"specialization_type\": \"acid\",\n \"created\": \"voluptate proident nostrud Lorem\",\n \"sent\": \"1955-09-06T09:36:16.116Z\",\n \"archived\": \"1981-04-15T13:16:04.019Z\",\n \"delivered\": \"elit\",\n \"action_performed_by_id\": \"sunt veniam cul\",\n \"sealed\": false,\n \"can_be_sealed\": \"est ex\",\n \"is_draft\": \"consectetur Excepteur sunt id\",\n \"sender_inbox_id\": \"esse Ut aute est\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"culpa deserunt dolor cupidatat\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": true,\n \"delivered_envelope_id\": \"cupidatat pariatur\",\n \"failed_delivery_envelope_id\": \"irure cupidatat ut\",\n \"failed_outgoing_id\": \"sint Lorem no\",\n \"pay_to_collect\": false,\n \"pay_to_collect_response\": \"commod\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": true,\n \"created\": \"1949-08-20T11:37:52.544Z\"\n }\n ],\n \"delivered_envelope_id\": \"aute ad cillum dolore\",\n \"failed_delivery_envelope_id\": \"magna amet veniam in\",\n \"failed_outgoing_id\": \"cupidatat eiusmod non\",\n \"document_token_transactions\": [\n {\n \"tx_hash\": \"labore nulla commodo Lorem ullamco\",\n \"status\": 1,\n \"created\": \"2005-01-10T15:11:48.755Z\",\n \"mined\": \"1974-02-28T01:10:32.412Z\",\n \"etherscan_link\": \"pariatur irure deserunt Excepteur\"\n },\n {\n \"tx_hash\": \"in ut in\",\n \"status\": 2,\n \"created\": \"1987-10-02T05:18:08.929Z\",\n \"mined\": \"1951-08-23T04:16:13.305Z\",\n \"etherscan_link\": \"ut amet sunt\"\n }\n ],\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"ut\",\n \"meta_data\": {},\n \"credits_spent_amount\": -2570741,\n \"credits_spent_for_documents\": 88091036,\n \"acid_number\": \"Ut qu\",\n \"acid_verification_timeout\": \"aliquip laboris\",\n \"aci_filing_notification\": \"minim ullamco\",\n \"is_first_acid_filing\": false\n}" }, { "name": "Returned when the authenticated user is not a 3rd-party company.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"cargox_id\": \"eu ad\",\n \"acid_number\": \"Lor\",\n \"message\": \"qui eiusmod sit\",\n \"importer_taxation_number\": \"consequat fugiat\",\n \"exporter_taxation_number\": \"labore volupt\",\n \"importer_data\": {},\n \"exporter_data\": {},\n \"shipment_data\": {},\n \"created\": \"1948-03-30T15:59:07.199Z\",\n \"expires\": \"1954-01-29T20:59:25.711Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/aci-filing/notifications/create-draft/", "host": ["{{baseUrl}}"], "path": ["aci-filing", "notifications", "create-draft", ""] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Retrieve ACI filing notification", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/aci-filing/notifications/:aci_filing_notification/", "host": ["{{baseUrl}}"], "path": [ "aci-filing", "notifications", ":aci_filing_notification", "" ], "variable": [ { "key": "aci_filing_notification", "value": "cons", "description": "(Required) \nThe ACI filing notification identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine ACI filing notification by its ID. Replace `{id}` with internal notification id. |\n" } ] }, "description": "Retrieves a single ACI filing notification." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/aci-filing/notifications/:aci_filing_notification/", "host": ["{{baseUrl}}"], "path": [ "aci-filing", "notifications", ":aci_filing_notification", "" ], "variable": [ { "key": "aci_filing_notification", "value": "cons", "description": "(Required) \nThe ACI filing notification identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine ACI filing notification by its ID. Replace `{id}` with internal notification id. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"cargox_id\": \"mollit et id\",\n \"acid_number\": \"aliquip esse\",\n \"id\": \"urn:uuid:37462adf-e150-f17a-1e2c-5af953837915\",\n \"incoming_envelope_id\": \"laborum in aute occaecat incididunt\",\n \"aci_envelope_id\": \"ut eiusmod\",\n \"message\": \"nisi\",\n \"importer_taxation_number\": \"qui Duis\",\n \"exporter_taxation_number\": \"voluptate dolore\",\n \"importer_data\": {},\n \"exporter_data\": {},\n \"shipment_data\": {},\n \"is_expired\": false,\n \"created\": \"1966-09-24T06:31:35.690Z\",\n \"expires\": \"1973-08-09T02:16:25.270Z\"\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/aci-filing/notifications/:aci_filing_notification/", "host": ["{{baseUrl}}"], "path": [ "aci-filing", "notifications", ":aci_filing_notification", "" ], "variable": [ { "key": "aci_filing_notification", "value": "cons", "description": "(Required) \nThe ACI filing notification identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine ACI filing notification by its ID. Replace `{id}` with internal notification id. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company is not found or ACID number is not valid.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/aci-filing/notifications/:aci_filing_notification/", "host": ["{{baseUrl}}"], "path": [ "aci-filing", "notifications", ":aci_filing_notification", "" ], "variable": [ { "key": "aci_filing_notification", "value": "cons", "description": "(Required) \nThe ACI filing notification identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine ACI filing notification by its ID. Replace `{id}` with internal notification id. |\n" } ] } }, "code": 471, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "apps", "item": [ { "name": "Create 3rd party client app", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "app_id", "value": "Lorem in laborum id tempor", "description": "(Required) \nThis parameter identifies 3rd party client application. \n" }, { "key": "supplier_id", "value": "sed Lorem minim laborum", "description": "(Required) \nThe supplier ID. This parameter is obtained via CargoX support when your supplier instance is created. \n" }, { "key": "email", "value": "a", "description": "(Required) \nEach 3rd party application needs an email associated with it. Email must be unique for each application. \n" }, { "key": "hash", "value": "officia est culpa", "description": "(Required) \nThis parameter is used for request authentication. \n" } ] }, "url": { "raw": "{{baseUrl}}/apps/", "host": ["{{baseUrl}}"], "path": ["apps", ""] }, "description": "The endpoint for creating 3rd party client application." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "app_id", "value": "Lorem in laborum id tempor", "description": "(Required) \nThis parameter identifies 3rd party client application. \n" }, { "key": "supplier_id", "value": "sed Lorem minim laborum", "description": "(Required) \nThe supplier ID. This parameter is obtained via CargoX support when your supplier instance is created. \n" }, { "key": "email", "value": "a", "description": "(Required) \nEach 3rd party application needs an email associated with it. Email must be unique for each application. \n" }, { "key": "hash", "value": "officia est culpa", "description": "(Required) \nThis parameter is used for request authentication. \n" } ] }, "url": { "raw": "{{baseUrl}}/apps/", "host": ["{{baseUrl}}"], "path": ["apps", ""] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"client_id\": \"aute ullamco ea occaecat\",\n \"client_secret\": \"sunt nostrud\",\n \"allowed_ip_ranges\": \"consectetur i\",\n \"status\": \"nulla Excepteur\"\n}" }, { "name": "Returned when the supplier is not authorized to create new 3rd party client application or the hash is not valid.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "app_id", "value": "Lorem in laborum id tempor", "description": "(Required) \nThis parameter identifies 3rd party client application. \n" }, { "key": "supplier_id", "value": "sed Lorem minim laborum", "description": "(Required) \nThe supplier ID. This parameter is obtained via CargoX support when your supplier instance is created. \n" }, { "key": "email", "value": "a", "description": "(Required) \nEach 3rd party application needs an email associated with it. Email must be unique for each application. \n" }, { "key": "hash", "value": "officia est culpa", "description": "(Required) \nThis parameter is used for request authentication. \n" } ] }, "url": { "raw": "{{baseUrl}}/apps/", "host": ["{{baseUrl}}"], "path": ["apps", ""] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when the supplier ID is invalid.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "app_id", "value": "Lorem in laborum id tempor", "description": "(Required) \nThis parameter identifies 3rd party client application. \n" }, { "key": "supplier_id", "value": "sed Lorem minim laborum", "description": "(Required) \nThe supplier ID. This parameter is obtained via CargoX support when your supplier instance is created. \n" }, { "key": "email", "value": "a", "description": "(Required) \nEach 3rd party application needs an email associated with it. Email must be unique for each application. \n" }, { "key": "hash", "value": "officia est culpa", "description": "(Required) \nThis parameter is used for request authentication. \n" } ] }, "url": { "raw": "{{baseUrl}}/apps/", "host": ["{{baseUrl}}"], "path": ["apps", ""] } }, "code": 471, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when one or more attributes are missing.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "app_id", "value": "Lorem in laborum id tempor", "description": "(Required) \nThis parameter identifies 3rd party client application. \n" }, { "key": "supplier_id", "value": "sed Lorem minim laborum", "description": "(Required) \nThe supplier ID. This parameter is obtained via CargoX support when your supplier instance is created. \n" }, { "key": "email", "value": "a", "description": "(Required) \nEach 3rd party application needs an email associated with it. Email must be unique for each application. \n" }, { "key": "hash", "value": "officia est culpa", "description": "(Required) \nThis parameter is used for request authentication. \n" } ] }, "url": { "raw": "{{baseUrl}}/apps/", "host": ["{{baseUrl}}"], "path": ["apps", ""] } }, "code": 472, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Retrieve credentials for 3rd party client app", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/apps/:app_id/?supplier_id=cons&hash=cons", "host": ["{{baseUrl}}"], "path": ["apps", ":app_id", ""], "query": [ { "key": "supplier_id", "value": "cons", "description": "(Required) \nThe supplier ID. This parameter is obtained via CargoX support when your supplier instance is created. \n" }, { "key": "hash", "value": "cons", "description": "(Required) \nThis parameter is used for request authentication. \n" } ], "variable": [ { "key": "app_id", "value": "cons", "description": "(Required) \nThis parameter identifies 3rd party client application. \n" } ] }, "description": "Retrieves 3rd client application credentials for a specific client." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/apps/:app_id/?supplier_id=cons&hash=cons", "host": ["{{baseUrl}}"], "path": ["apps", ":app_id", ""], "query": [ { "key": "supplier_id", "value": "cons" }, { "key": "hash", "value": "cons" } ], "variable": [ { "key": "app_id", "value": "cons", "description": "(Required) \nThis parameter identifies 3rd party client application. \n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"client_id\": \"aute ullamco ea occaecat\",\n \"client_secret\": \"sunt nostrud\",\n \"allowed_ip_ranges\": \"consectetur i\",\n \"status\": \"nulla Excepteur\"\n}" }, { "name": "Returned when 3rd party client application is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/apps/:app_id/?supplier_id=cons&hash=cons", "host": ["{{baseUrl}}"], "path": ["apps", ":app_id", ""], "query": [ { "key": "supplier_id", "value": "cons" }, { "key": "hash", "value": "cons" } ], "variable": [ { "key": "app_id", "value": "cons", "description": "(Required) \nThis parameter identifies 3rd party client application. \n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when the supplier ID is invalid.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/apps/:app_id/?supplier_id=cons&hash=cons", "host": ["{{baseUrl}}"], "path": ["apps", ":app_id", ""], "query": [ { "key": "supplier_id", "value": "cons" }, { "key": "hash", "value": "cons" } ], "variable": [ { "key": "app_id", "value": "cons", "description": "(Required) \nThis parameter identifies 3rd party client application. \n" } ] } }, "code": 471, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when one or more attributes are missing.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/apps/:app_id/?supplier_id=cons&hash=cons", "host": ["{{baseUrl}}"], "path": ["apps", ":app_id", ""], "query": [ { "key": "supplier_id", "value": "cons" }, { "key": "hash", "value": "cons" } ], "variable": [ { "key": "app_id", "value": "cons", "description": "(Required) \nThis parameter identifies 3rd party client application. \n" } ] } }, "code": 472, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "blockchain", "item": [ { "name": "Retrieve Ethereum address registration status", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/blockchain/addresses/:blockchain_address/", "host": ["{{baseUrl}}"], "path": ["blockchain", "addresses", ":blockchain_address", ""], "variable": [ { "key": "blockchain_address", "value": "cons", "description": "(Required) " } ] }, "description": "Retrieves the blockchain registration status of a single ethereum address." }, "response": [ { "name": "Returned when ethereum address is not valid", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/blockchain/addresses/:blockchain_address/", "host": ["{{baseUrl}}"], "path": [ "blockchain", "addresses", ":blockchain_address", "" ], "variable": [ { "key": "blockchain_address", "value": "cons", "description": "(Required) " } ] } }, "code": 471, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Generate challenge string", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/blockchain/login-challenge/", "host": ["{{baseUrl}}"], "path": ["blockchain", "login-challenge", ""] }, "description": "Generates a challenge string that needs to be signed with your Ethereum private key." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/blockchain/login-challenge/", "host": ["{{baseUrl}}"], "path": ["blockchain", "login-challenge", ""] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"challenge\": \"ipsum ullamco dolor esse\"\n}" } ] } ] }, { "name": "collections", "item": [ { "name": "Get login key types", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/collections/blockchain-key-types/list/", "host": ["{{baseUrl}}"], "path": ["collections", "blockchain-key-types", "list", ""] }, "description": "Returns a list of all supported login key types." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/collections/blockchain-key-types/list/", "host": ["{{baseUrl}}"], "path": ["collections", "blockchain-key-types", "list", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"unknown\",\n \"verification_code\": \"elit id dolor\",\n \"id\": \"urn:uuid:dbd2702c-3a2e-7eb3-3c5c-bc4536d235f4\",\n \"user_id\": \"occaecat\",\n \"ethereum_address\": \"0x2d6bbB6CaaEbAdF4aBAffbC8459746CEC578fCBA\",\n \"created\": \"2019-08-20T15:59:46.312Z\",\n \"transaction_pending\": \"velit est reprehenderit adipisicing\",\n \"transaction_confirmed\": \"velit quis\",\n \"transactions\": [\n {\n \"tx_hash\": \"proident nulla in\",\n \"status\": 3,\n \"created\": \"2012-08-29T13:21:09.741Z\",\n \"mined\": \"2015-10-31T12:30:42.777Z\",\n \"etherscan_link\": \"fugiat labore irure\"\n },\n {\n \"tx_hash\": \"ut ea esse\",\n \"status\": 2,\n \"created\": \"1972-02-18T11:00:16.499Z\",\n \"mined\": \"2011-06-04T02:35:51.946Z\",\n \"etherscan_link\": \"cillum aute culpa nisi\"\n }\n ],\n \"removable\": \"irure\"\n}" } ] }, { "name": "Get countries list", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/collections/countries/list/", "host": ["{{baseUrl}}"], "path": ["collections", "countries", "list", ""] }, "description": "Returns a list of all supported countries." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/collections/countries/list/", "host": ["{{baseUrl}}"], "path": ["collections", "countries", "list", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"anim veniam c\",\n \"name\": \"dolore ad dolor ut aliquip\"\n}" } ] }, { "name": "Get credit package list", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/collections/credit-packages/list/", "host": ["{{baseUrl}}"], "path": ["collections", "credit-packages", "list", ""] }, "description": "Returns a list of all credit packages available for purchase." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/collections/credit-packages/list/", "host": ["{{baseUrl}}"], "path": ["collections", "credit-packages", "list", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"ea irure\",\n \"name\": \"ut mollit\",\n \"amount\": \"velit fugiat ut\",\n \"amount_milicents\": 16461377,\n \"promotional_amount\": \"esse adipisicing\",\n \"promotional_amount_milicents\": -70579835,\n \"total_amount\": \"consectetur nisi\",\n \"total_amount_milicents\": -71230685,\n \"promotional_credits_percent\": \"amet cupidatat in\",\n \"price\": \"do ullamco\",\n \"currency\": \"elit adipisicing esse\"\n}" } ] }, { "name": "Get document type list", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/collections/document-types/list/", "host": ["{{baseUrl}}"], "path": ["collections", "document-types", "list", ""] }, "description": "Returns a list of all supported document types." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/collections/document-types/list/", "host": ["{{baseUrl}}"], "path": ["collections", "document-types", "list", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"adip\",\n \"name\": \"non sed ipsum\",\n \"short_name\": \"id aute\",\n \"color\": 77389558,\n \"is_smart_bl\": true,\n \"blockchain_support\": \"velit minim est aliqua\",\n \"create_on_blockchain\": true,\n \"transfer_on_blockchain\": false,\n \"document_id_required\": false,\n \"document_id_title\": \"ut qui\",\n \"document_id_description\": \"\",\n \"accomplisher_required\": false,\n \"accomplisher_selectable\": false,\n \"accomplisher_title\": \"id reprehenderit anim nostrud\",\n \"accomplisher_description\": \"\",\n \"accomplish_action_string\": \"consequat nulla\",\n \"accomplish_review_step_title\": \"\",\n \"accomplish_review_step_text\": \"\",\n \"accomplish_sign_step_title\": \"\",\n \"accomplish_sign_step_text\": \"\",\n \"accomplish_sign_step_button\": \"\",\n \"accomplish_sign_in_progress_title\": \"\",\n \"accomplish_sign_in_progress_content\": \"\",\n \"accomplish_sign_success_message_title\": \"\",\n \"accomplish_sign_success_message_text\": \"\",\n \"accomplish_sign_error_message_title\": \"\",\n \"accomplish_sign_error_message_text\": \"\",\n \"accomplish_notify_email_document_state\": \"\",\n \"accomplish_notify_email_subject_action\": \"\",\n \"issue_price_millicents\": -23621118,\n \"blockchain_transfer_limit\": -66887756,\n \"retention_period\": \"Excepteur magna amet\"\n}" } ] }, { "name": "collections forex list list", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/collections/forex/list/", "host": ["{{baseUrl}}"], "path": ["collections", "forex", "list", ""] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/collections/forex/list/", "host": ["{{baseUrl}}"], "path": ["collections", "forex", "list", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Get collections", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/collections/list/", "host": ["{{baseUrl}}"], "path": ["collections", "list", ""] }, "description": "Returns a dictionary of collections." }, "response": [ { "name": "Returns collections", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/collections/list/", "host": ["{{baseUrl}}"], "path": ["collections", "list", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Get payment type list", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/collections/payment-types/list/", "host": ["{{baseUrl}}"], "path": ["collections", "payment-types", "list", ""] }, "description": "Returns a list of all available payment types." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/collections/payment-types/list/", "host": ["{{baseUrl}}"], "path": ["collections", "payment-types", "list", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:625334cb-bc3a-ab2c-7123-48f4772e0557\",\n \"enabled\": false,\n \"name\": \"Lorem commodo sunt dolor\",\n \"bank_address\": \"eu ea consectetur incididunt Ut\",\n \"description\": \"Duis ut\",\n \"service_fee_percent\": \"pariatur exercitation ullamco in\",\n \"type\": \"exercitation sunt nulla voluptate\",\n \"payment_instructions\": \"veniam anim consectetur aute\",\n \"bank_name\": \"exercitation consequat non in incididunt\",\n \"swift_code\": \"laboris dolore labore\",\n \"account_number\": \"Duis occaecat cupidatat\",\n \"beneficiary\": \"Ut aute ut voluptate\"\n}" } ] }, { "name": "Get active promotions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/collections/promotions/list/", "host": ["{{baseUrl}}"], "path": ["collections", "promotions", "list", ""] }, "description": "Returns a list of all active promotions." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/collections/promotions/list/", "host": ["{{baseUrl}}"], "path": ["collections", "promotions", "list", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"nulla id eiusmod\",\n \"description\": \"anim ullamco Duis esse non\",\n \"start\": \"1967-10-24T19:36:12.697Z\",\n \"end\": \"1949-06-19T20:02:38.642Z\",\n \"active\": true,\n \"referrer_credits_amount\": 34481537,\n \"referrer_credits_type\": -76309585,\n \"referrer_credits_valid_for\": -44156948,\n \"referral_credits_amount\": -13080199,\n \"referral_credits_type\": -31670837,\n \"referral_credits_valid_for\": 51430857,\n \"created\": \"1983-08-11T00:34:59.481Z\"\n}" } ] }, { "name": "Get subscription tier list", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/collections/subscription-tiers/list/", "host": ["{{baseUrl}}"], "path": ["collections", "subscription-tiers", "list", ""] }, "description": "Returns a list of all available subscription tiers." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/collections/subscription-tiers/list/", "host": ["{{baseUrl}}"], "path": ["collections", "subscription-tiers", "list", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"nostrud adipisicing qui ad\",\n \"monthly_price\": \"est eiusmod Lorem\",\n \"yearly_price\": \"enim veniam Duis eu\",\n \"additional_credits_per_month\": 9115083879239979000,\n \"non_blockchain_transfer_limit\": 461231109,\n \"contacts_limit\": -991236042,\n \"users_limit\": -1963308400,\n \"rules_limit\": 1994800372,\n \"connected_apps_limit\": 1126628642,\n \"attachments_per_envelope_limit\": -1873510381,\n \"attachments_size_per_envelope_limit\": -692079361,\n \"relayer_speed\": \"slow\",\n \"pdf_audit_log_enabled\": false,\n \"id\": \"e352b624-6134-1dc6-fe89-6677cdd1e0a2\"\n}" } ] } ] }, { "name": "companies", "item": [ { "name": "{company}", "item": [ { "name": "additional-vat", "item": [ { "name": "{additional vat}", "item": [ { "name": "Retrieve additional VAT number", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/additional-vat/:additional_vat/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "additional-vat", ":additional_vat", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "additional_vat", "value": "cons", "description": "(Required) \nThe additional VAT number identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine additional VAT number by its ID. Replace `{id}` with internal additional VAT number id. |\n" } ] }, "description": "Retrieves a single additional VAT number entry of user that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/additional-vat/:additional_vat/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "additional-vat", ":additional_vat", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "additional_vat", "value": "cons", "description": "(Required) \nThe additional VAT number identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine additional VAT number by its ID. Replace `{id}` with internal additional VAT number id. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"country\": \"NU\",\n \"id\": \"urn:uuid:b44b24bc-602d-7cdf-4c7b-89c7d19d94f9\",\n \"company_id\": \"Duis non Ut culpa\",\n \"vat_number\": \"tempor ipsum id magna\",\n \"country_name\": \"eu qui\",\n \"vies_verification\": {\n \"type\": \"bank\",\n \"status\": \"not_verified\",\n \"verified\": \"1943-06-22T12:26:20.424Z\",\n \"failure_reason\": \"Lorem\",\n \"processed\": \"2004-06-24T19:43:16.439Z\"\n },\n \"verified_vies\": \"voluptate elit\"\n}" } ] }, { "name": "Update additional VAT number", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"country\": \"MS\",\n \"vat_number\": \"ad dolor\",\n \"vies_verification\": {\n \"type\": \"dnb\",\n \"status\": \"pending_review\",\n \"verified\": \"2012-11-15T10:58:54.436Z\",\n \"failure_reason\": \"et sit magna consectetur\",\n \"processed\": \"1945-03-29T04:34:00.329Z\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/additional-vat/:additional_vat/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "additional-vat", ":additional_vat", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "additional_vat", "value": "cons", "description": "(Required) \nThe additional VAT number identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine additional VAT number by its ID. Replace `{id}` with internal additional VAT number id. |\n" } ] }, "description": "Updates the additional VAT number. All data needs to be present to perform an update. If data is incomplete,\n please use a `PATCH` call." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/additional-vat/:additional_vat/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "additional-vat", ":additional_vat", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "additional_vat", "value": "cons", "description": "(Required) \nThe additional VAT number identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine additional VAT number by its ID. Replace `{id}` with internal additional VAT number id. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"country\": \"NU\",\n \"id\": \"urn:uuid:b44b24bc-602d-7cdf-4c7b-89c7d19d94f9\",\n \"company_id\": \"Duis non Ut culpa\",\n \"vat_number\": \"tempor ipsum id magna\",\n \"country_name\": \"eu qui\",\n \"vies_verification\": {\n \"type\": \"bank\",\n \"status\": \"not_verified\",\n \"verified\": \"1943-06-22T12:26:20.424Z\",\n \"failure_reason\": \"Lorem\",\n \"processed\": \"2004-06-24T19:43:16.439Z\"\n },\n \"verified_vies\": \"voluptate elit\"\n}" } ] }, { "name": "Partially update additional VAT number", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"country\": \"MS\",\n \"vat_number\": \"ad dolor\",\n \"vies_verification\": {\n \"type\": \"dnb\",\n \"status\": \"pending_review\",\n \"verified\": \"2012-11-15T10:58:54.436Z\",\n \"failure_reason\": \"et sit magna consectetur\",\n \"processed\": \"1945-03-29T04:34:00.329Z\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/additional-vat/:additional_vat/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "additional-vat", ":additional_vat", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "additional_vat", "value": "cons", "description": "(Required) \nThe additional VAT number identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine additional VAT number by its ID. Replace `{id}` with internal additional VAT number id. |\n" } ] }, "description": "Partially updates the additional VAT number. Only the data that needs to be changed is required." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/additional-vat/:additional_vat/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "additional-vat", ":additional_vat", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "additional_vat", "value": "cons", "description": "(Required) \nThe additional VAT number identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine additional VAT number by its ID. Replace `{id}` with internal additional VAT number id. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"country\": \"NU\",\n \"id\": \"urn:uuid:b44b24bc-602d-7cdf-4c7b-89c7d19d94f9\",\n \"company_id\": \"Duis non Ut culpa\",\n \"vat_number\": \"tempor ipsum id magna\",\n \"country_name\": \"eu qui\",\n \"vies_verification\": {\n \"type\": \"bank\",\n \"status\": \"not_verified\",\n \"verified\": \"1943-06-22T12:26:20.424Z\",\n \"failure_reason\": \"Lorem\",\n \"processed\": \"2004-06-24T19:43:16.439Z\"\n },\n \"verified_vies\": \"voluptate elit\"\n}" } ] }, { "name": "Delete additional VAT number", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/additional-vat/:additional_vat/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "additional-vat", ":additional_vat", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "additional_vat", "value": "cons", "description": "(Required) \nThe additional VAT number identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine additional VAT number by its ID. Replace `{id}` with internal additional VAT number id. |\n" } ] }, "description": "Deletes a single additional VAT number entry of a user that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/additional-vat/:additional_vat/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "additional-vat", ":additional_vat", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "additional_vat", "value": "cons", "description": "(Required) \nThe additional VAT number identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine additional VAT number by its ID. Replace `{id}` with internal additional VAT number id. |\n" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Verify additional VAT number", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"country\": \"MS\",\n \"vat_number\": \"ad dolor\",\n \"vies_verification\": {\n \"type\": \"dnb\",\n \"status\": \"pending_review\",\n \"verified\": \"2012-11-15T10:58:54.436Z\",\n \"failure_reason\": \"et sit magna consectetur\",\n \"processed\": \"1945-03-29T04:34:00.329Z\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/additional-vat/:additional_vat/verify/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "additional-vat", ":additional_vat", "verify", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "additional_vat", "value": "cons", "description": "(Required) \nThe additional VAT number identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine additional VAT number by its ID. Replace `{id}` with internal additional VAT number id. |\n" } ] }, "description": "This endpoint is used to initiate VIES verification for additional VAT numbers." }, "response": [ { "name": "Returns status `ok` if verification has been successfully initiated.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/additional-vat/:additional_vat/verify/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "additional-vat", ":additional_vat", "verify", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "additional_vat", "value": "cons", "description": "(Required) \nThe additional VAT number identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine additional VAT number by its ID. Replace `{id}` with internal additional VAT number id. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when the user is not authenticated.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/additional-vat/:additional_vat/verify/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "additional-vat", ":additional_vat", "verify", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "additional_vat", "value": "cons", "description": "(Required) \nThe additional VAT number identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine additional VAT number by its ID. Replace `{id}` with internal additional VAT number id. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when the company or additional VAT object is not found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/additional-vat/:additional_vat/verify/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "additional-vat", ":additional_vat", "verify", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "additional_vat", "value": "cons", "description": "(Required) \nThe additional VAT number identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine additional VAT number by its ID. Replace `{id}` with internal additional VAT number id. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Create additional VAT number", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"country\": \"MS\",\n \"vat_number\": \"ad dolor\",\n \"vies_verification\": {\n \"type\": \"dnb\",\n \"status\": \"pending_review\",\n \"verified\": \"2012-11-15T10:58:54.436Z\",\n \"failure_reason\": \"et sit magna consectetur\",\n \"processed\": \"1945-03-29T04:34:00.329Z\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/additional-vat/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "additional-vat", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "Creates a new additional VAT number entry for a user that the logged in 3rd-party system is\n allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/additional-vat/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "additional-vat", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"country\": \"NU\",\n \"id\": \"urn:uuid:b44b24bc-602d-7cdf-4c7b-89c7d19d94f9\",\n \"company_id\": \"Duis non Ut culpa\",\n \"vat_number\": \"tempor ipsum id magna\",\n \"country_name\": \"eu qui\",\n \"vies_verification\": {\n \"type\": \"bank\",\n \"status\": \"not_verified\",\n \"verified\": \"1943-06-22T12:26:20.424Z\",\n \"failure_reason\": \"Lorem\",\n \"processed\": \"2004-06-24T19:43:16.439Z\"\n },\n \"verified_vies\": \"voluptate elit\"\n}" } ] }, { "name": "List additional VAT numbers", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/additional-vat/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "additional-vat", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "Lists all additional VAT numbers of company that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/additional-vat/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "additional-vat", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"country\": \"WS\",\n \"id\": \"urn:uuid:f70b075b-747a-5629-027e-6b0f0c63af94\",\n \"company_id\": \"Duis id ullamco tempor\",\n \"vat_number\": \"exercitation ea veniam\",\n \"country_name\": \"adipisicing nisi\",\n \"vies_verification\": {\n \"type\": \"vies\",\n \"status\": \"verified\",\n \"verified\": \"1981-01-17T05:51:28.773Z\",\n \"failure_reason\": \"officia quis cillum sed\",\n \"processed\": \"1982-02-16T20:12:41.890Z\"\n },\n \"verified_vies\": \"exercitation enim cillum dolor\"\n },\n {\n \"country\": \"MC\",\n \"id\": \"urn:uuid:6b4dabe3-38d2-6b90-50d8-4013170cabff\",\n \"company_id\": \"consectetur\",\n \"vat_number\": \"voluptate\",\n \"country_name\": \"nulla Ut mollit enim Lorem\",\n \"vies_verification\": {\n \"type\": \"vies\",\n \"status\": \"pending_review\",\n \"verified\": \"1961-12-04T22:45:47.190Z\",\n \"failure_reason\": \"aliqua\",\n \"processed\": \"1989-10-31T07:25:27.697Z\"\n },\n \"verified_vies\": \"magna labore\"\n }\n]" } ] } ] }, { "name": "apps", "item": [ { "name": "{app}", "item": [ { "name": "Retrieve authorized 3rd-party system", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/apps/:app/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "apps", ":app", ""], "variable": [ { "key": "app", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " } ] }, "description": "Retrieves a specific 3rd-party systems that manages a specific company." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/apps/:app/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "apps", ":app", "" ], "variable": [ { "key": "app", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:f658f7cb-6e4a-4681-ec55-780664928ead\",\n \"name\": \"mollit deserunt dolor dolore\",\n \"third_party_system_id\": \"in eiusmod Ut\",\n \"can_view_company_details\": false,\n \"can_edit_company_details\": false,\n \"can_list_users\": true,\n \"can_add_users\": true,\n \"can_edit_users\": false,\n \"can_delete_users\": true,\n \"can_authenticate_as_users\": false\n}" } ] }, { "name": "Update authorized 3rd-party system", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"can_view_company_details\": false,\n \"can_edit_company_details\": true,\n \"can_list_users\": false,\n \"can_add_users\": false,\n \"can_edit_users\": true,\n \"can_delete_users\": true,\n \"can_authenticate_as_users\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/apps/:app/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "apps", ":app", ""], "variable": [ { "key": "app", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " } ] }, "description": "Updates permissions of authorized 3rd-party system. All data needs to be present to\n perform an update. If data is incomplete, please use a `PATCH` call." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/apps/:app/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "apps", ":app", "" ], "variable": [ { "key": "app", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:f658f7cb-6e4a-4681-ec55-780664928ead\",\n \"name\": \"mollit deserunt dolor dolore\",\n \"third_party_system_id\": \"in eiusmod Ut\",\n \"can_view_company_details\": false,\n \"can_edit_company_details\": false,\n \"can_list_users\": true,\n \"can_add_users\": true,\n \"can_edit_users\": false,\n \"can_delete_users\": true,\n \"can_authenticate_as_users\": false\n}" } ] }, { "name": "Partially update authorized 3rd-party system", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"can_view_company_details\": false,\n \"can_edit_company_details\": true,\n \"can_list_users\": false,\n \"can_add_users\": false,\n \"can_edit_users\": true,\n \"can_delete_users\": true,\n \"can_authenticate_as_users\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/apps/:app/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "apps", ":app", ""], "variable": [ { "key": "app", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " } ] }, "description": "Partially updates permissions of authorized 3rd-party system. Only the data that needs\n to be changed is required." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/apps/:app/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "apps", ":app", "" ], "variable": [ { "key": "app", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:f658f7cb-6e4a-4681-ec55-780664928ead\",\n \"name\": \"mollit deserunt dolor dolore\",\n \"third_party_system_id\": \"in eiusmod Ut\",\n \"can_view_company_details\": false,\n \"can_edit_company_details\": false,\n \"can_list_users\": true,\n \"can_add_users\": true,\n \"can_edit_users\": false,\n \"can_delete_users\": true,\n \"can_authenticate_as_users\": false\n}" } ] }, { "name": "Delete 3rd-party system authorization", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/apps/:app/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "apps", ":app", ""], "variable": [ { "key": "app", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " } ] }, "description": "Deletes 3rd-party system authorization to manage a specific company." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/apps/:app/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "apps", ":app", "" ], "variable": [ { "key": "app", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "{per company permission}", "item": [ { "name": "companies apps read", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/apps/:per_company_permission/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "apps", ":per_company_permission", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "per_company_permission", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/apps/:per_company_permission/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "apps", ":per_company_permission", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "per_company_permission", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:097370e1-0045-b396-77f3-2832283ba45c\",\n \"third_party_system\": {\n \"name\": \"elit pariatur ad ipsum\",\n \"id\": \"urn:uuid:4775a898-c842-4378-dea4-4d05c66483dd\"\n },\n \"name\": \"in dolor ullamco\",\n \"can_view_company_details\": true,\n \"can_edit_company_details\": true,\n \"can_list_users\": true,\n \"can_add_users\": true,\n \"can_edit_users\": true,\n \"can_delete_users\": false,\n \"can_authenticate_as_users\": true\n}" } ] }, { "name": "companies apps delete", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/apps/:per_company_permission/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "apps", ":per_company_permission", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "per_company_permission", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/apps/:per_company_permission/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "apps", ":per_company_permission", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "per_company_permission", "value": "cons", "description": "(Required) " } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "List of authorized 3rd-party systems", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/apps/list/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "apps", "list", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] }, "description": "Lists all authorized 3rd-party systems that manage a specific company\n and their permissions." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/apps/list/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "apps", "list", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": \"urn:uuid:830bfbf3-8a88-b87e-0271-023279fa89c5\",\n \"name\": \"Lorem est\",\n \"third_party_system_id\": \"al\",\n \"can_view_company_details\": false,\n \"can_edit_company_details\": true,\n \"can_list_users\": false,\n \"can_add_users\": true,\n \"can_edit_users\": true,\n \"can_delete_users\": false,\n \"can_authenticate_as_users\": true\n },\n {\n \"id\": \"d2f63931-918c-7d3a-6279-fd3eaabd7557\",\n \"name\": \"adipisicing ex sed qui\",\n \"third_party_system_id\": \"quis enim consequat tempor\",\n \"can_view_company_details\": false,\n \"can_edit_company_details\": true,\n \"can_list_users\": true,\n \"can_add_users\": true,\n \"can_edit_users\": false,\n \"can_delete_users\": false,\n \"can_authenticate_as_users\": true\n }\n]" } ] } ] }, { "name": "authorization-code-apps", "item": [ { "name": "{app}", "item": [ { "name": "Retrieve authorized 3rd-party system", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/authorization-code-apps/:app/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "authorization-code-apps", ":app", "" ], "variable": [ { "key": "app", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " } ] }, "description": "Retrieves a specific 3rd-party systems that manages a specific company." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/authorization-code-apps/:app/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "authorization-code-apps", ":app", "" ], "variable": [ { "key": "app", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:b88ab880-c679-4aa8-271b-f56903a5fd5d\",\n \"name\": \"laborum proident reprehenderit dolore nisi\",\n \"client_id\": \"deserunt ex\",\n \"user_id\": \"nostrud ipsum irure\",\n \"can_view_company_details\": true,\n \"can_view_personal_details\": false,\n \"created\": \"1960-12-24T08:17:42.456Z\"\n}" } ] }, { "name": "Update authorized 3rd-party system", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"can_view_company_details\": true,\n \"can_view_personal_details\": false,\n \"created\": \"1989-01-23T15:57:08.638Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/authorization-code-apps/:app/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "authorization-code-apps", ":app", "" ], "variable": [ { "key": "app", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " } ] }, "description": "Updates permissions of authorized 3rd-party system. All data needs to be present to\n perform an update. If data is incomplete, please use a `PATCH` call." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/authorization-code-apps/:app/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "authorization-code-apps", ":app", "" ], "variable": [ { "key": "app", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:b88ab880-c679-4aa8-271b-f56903a5fd5d\",\n \"name\": \"laborum proident reprehenderit dolore nisi\",\n \"client_id\": \"deserunt ex\",\n \"user_id\": \"nostrud ipsum irure\",\n \"can_view_company_details\": true,\n \"can_view_personal_details\": false,\n \"created\": \"1960-12-24T08:17:42.456Z\"\n}" } ] }, { "name": "Partially update authorized 3rd-party system", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"can_view_company_details\": true,\n \"can_view_personal_details\": false,\n \"created\": \"1989-01-23T15:57:08.638Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/authorization-code-apps/:app/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "authorization-code-apps", ":app", "" ], "variable": [ { "key": "app", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " } ] }, "description": "Partially updates permissions of authorized 3rd-party system. Only the data that needs\n to be changed is required." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/authorization-code-apps/:app/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "authorization-code-apps", ":app", "" ], "variable": [ { "key": "app", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:b88ab880-c679-4aa8-271b-f56903a5fd5d\",\n \"name\": \"laborum proident reprehenderit dolore nisi\",\n \"client_id\": \"deserunt ex\",\n \"user_id\": \"nostrud ipsum irure\",\n \"can_view_company_details\": true,\n \"can_view_personal_details\": false,\n \"created\": \"1960-12-24T08:17:42.456Z\"\n}" } ] }, { "name": "Delete 3rd-party system user authorization", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/authorization-code-apps/:app/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "authorization-code-apps", ":app", "" ], "variable": [ { "key": "app", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " } ] }, "description": "Deletes 3rd-party system user authorization to manage a specific company." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/authorization-code-apps/:app/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "authorization-code-apps", ":app", "" ], "variable": [ { "key": "app", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "List of authorized 3rd-party systems", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/authorization-code-apps/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "authorization-code-apps", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] }, "description": "Lists all authorized 3rd-party systems that manage a specific company\n and their permissions." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/authorization-code-apps/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "authorization-code-apps", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": \"urn:uuid:cd50e1af-55f0-778a-58d1-63fe03cf8efc\",\n \"name\": \"commodo id in amet\",\n \"client_id\": \"voluptate Duis eu sed\",\n \"user_id\": \"proident ea esse\",\n \"can_view_company_details\": false,\n \"can_view_personal_details\": true,\n \"created\": \"1974-05-31T11:12:51.741Z\"\n },\n {\n \"id\": \"68eeed65-e517-59b5-607e-a788cf4a9bbe\",\n \"name\": \"sit non nostrud Excepteur\",\n \"client_id\": \"fugiat ad\",\n \"user_id\": \"culpa\",\n \"can_view_company_details\": true,\n \"can_view_personal_details\": true,\n \"created\": \"1969-01-26T12:17:21.200Z\"\n }\n]" } ] } ] }, { "name": "contacts", "item": [ { "name": "{contact}", "item": [ { "name": "Retrieve contact", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/:contact/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", ":contact", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "contact", "value": "cons", "description": "(Required) \nThe contact identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the contact by their ID. Replace `{id}` with internal user id. |\n| `by-invitation-code/{invitation_code}` | Determine the contact by their invitation code. Replace `{invitation_code}` with contact's invitation code. |\n" } ] }, "description": "Retrieves a single contact of a company that the logged in 3rd-party system is\n allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/:contact/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", ":contact", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "contact", "value": "cons", "description": "(Required) \nThe contact identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the contact by their ID. Replace `{id}` with internal user id. |\n| `by-invitation-code/{invitation_code}` | Determine the contact by their invitation code. Replace `{invitation_code}` with contact's invitation code. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"d3EfNCJ7Zaz8Xg@KiOVqxXlaixxrxEnQyq.jeu\",\n \"company_id\": \"pariatur ex ut dolore\",\n \"company\": {\n \"name\": \"aute sint non commodo\",\n \"address\": \"nisi\",\n \"postal_code\": \"laborum et ipsum\",\n \"city\": \"cillum Duis\",\n \"branch\": \"magna culpa Lorem\",\n \"address2\": \"tempor nostrud\",\n \"country\": \"CH\",\n \"country_name\": \"veniam occaecat dolore cillum\",\n \"website\": \"in incididunt cupidatat dolor esse\",\n \"vat_number\": \"minim dolor\",\n \"logo\": \"https://sjPZoTJKhTqd.ocacuIbwf0xdyTwbqSpHkiZyesYJMzPowWCMoCn4UbEXX\",\n \"logo_name\": \"minim\",\n \"created\": \"1992-11-24T00:04:43.475Z\",\n \"id\": \"urn:uuid:812edadc-0df5-db53-5db3-86c687937af6\",\n \"verified_bank\": \"sed\",\n \"verified_dnb\": \"occaecat aute\"\n },\n \"my_inbox_id\": \"Duis\",\n \"their_inbox_id\": \"a\",\n \"their_inbox\": {\n \"company\": {\n \"name\": \"ad pariatur\",\n \"address\": \"dolore id\",\n \"postal_code\": \"eu\",\n \"city\": \"Lorem ullamco\",\n \"branch\": \"mollit in ipsum pariatur\",\n \"address2\": \"consectetur ad\",\n \"country\": \"DO\",\n \"country_name\": \"ex\",\n \"website\": \"laboris labore\",\n \"vat_number\": \"adipisicing cupidatat ullamco sit\",\n \"logo\": \"http://OhnLOsuKMMsgPDWbg.eaxJAErqxW2hUR9ikN0CkQ\",\n \"logo_name\": \"non\",\n \"created\": \"1997-04-08T07:57:45.039Z\",\n \"id\": \"4f12e38b-0532-de09-5e14-08738557dbda\",\n \"verified_bank\": \"culpa magna ullamco nisi cillum\",\n \"verified_dnb\": \"irure dolor\"\n },\n \"name\": \"laboris tempor\",\n \"ethereum_address\": \"0x425070A934ED190A15fdeBCA36edF0Ea8Fe481F9\"\n },\n \"message\": \"et eu deserunt laboris\",\n \"note\": \"dolore aliquip\",\n \"invitation_code\": \"proident non do\",\n \"status\": \"accepted\",\n \"created\": \"1988-07-06T20:53:38.131Z\",\n \"created_by_id\": \"elit esse laboris in\",\n \"created_by\": {\n \"email\": \"e1qaeCZwvD0fOz@RkNyN.oibh\",\n \"telephone\": \"velit ut et incididunt laborum\",\n \"name\": \"sed tempor Ut ad\",\n \"first_name\": \"occaecat ut dolore\",\n \"last_name\": \"nulla esse incid\",\n \"company_id\": \"est\",\n \"company\": {\n \"name\": \"deserunt aliqua adipisicing magna commodo\",\n \"address\": \"ad\",\n \"postal_code\": \"reprehenderit Lorem elit\",\n \"city\": \"tempor consectetur ut\",\n \"branch\": \"incididunt\",\n \"address2\": \"nulla dolor pariatur\",\n \"country\": \"PF\",\n \"country_name\": \"voluptate\",\n \"website\": \"consectetur cillum\",\n \"vat_number\": \"do mollit amet eiusmod\",\n \"logo\": \"http://BrpkcNxlbcqaijqgVamSLkZ.bgopvZ3-K5QL7BHD6CLoC3BpNzlpuVwrTm0CF3SV\",\n \"logo_name\": \"eu pariatur\",\n \"created\": \"1973-12-27T00:07:55.441Z\",\n \"id\": \"urn:uuid:e095db6d-79dc-7c28-af28-6e4e34825b3d\",\n \"verified_bank\": \"nisi\",\n \"verified_dnb\": \"labore est deserunt veniam\"\n },\n \"logo\": \"http://Y.qoY+m6u8C0E\",\n \"logo_name\": \"commodo eu minim fugiat\",\n \"id\": \"d50b7796-168b-3941-c9f6-3caa90c7459f\"\n },\n \"resolved\": \"1978-09-14T10:22:49.851Z\",\n \"resolved_by_id\": \"enim ad\",\n \"resolved_by\": {\n \"email\": \"OchlOHMO5@ILgychgOqlizKCmfDAXura.wodc\",\n \"telephone\": \"id aliqua\",\n \"name\": \"ex aliquip ea sit\",\n \"first_name\": \"est\",\n \"last_name\": \"est sit exercitation\",\n \"company_id\": \"incididunt\",\n \"company\": {\n \"name\": \"labore\",\n \"address\": \"dolor ut cupidatat non nostru\",\n \"postal_code\": \"dolore commodo nulla\",\n \"city\": \"velit veniam\",\n \"branch\": \"quis reprehenderit esse\",\n \"address2\": \"veniam sit\",\n \"country\": \"LT\",\n \"country_name\": \"consectetur nisi\",\n \"website\": \"exercitation amet tempor\",\n \"vat_number\": \"reprehenderit elit nulla\",\n \"logo\": \"http://uhGMBZDiIeDHzC.oeezv32eNhxPwBI5cDq3..V4+tGPqcV5bNX2DsBVyxU5bUjqvIWr\",\n \"logo_name\": \"aliqua officia pariatur nulla\",\n \"created\": \"1945-05-07T13:44:10.465Z\",\n \"id\": \"urn:uuid:f3088fcc-e87f-df11-b2a7-06546d7eaa44\",\n \"verified_bank\": \"ut pariatur\",\n \"verified_dnb\": \"fugiat tempor dolor veniam\"\n },\n \"logo\": \"http://RnTYyCercdzWSlqikCEdoTz.xfm+PNfIVLi6pw\",\n \"logo_name\": \"et\",\n \"id\": \"urn:uuid:fe6be31a-93d2-27e1-f61c-2e28a7a6e254\"\n },\n \"resolved_by_company_id\": \"aliqua consequat ut\",\n \"resolved_by_company\": {\n \"name\": \"ut nulla\",\n \"address\": \"incididunt\",\n \"postal_code\": \"sint et sunt\",\n \"city\": \"laborum\",\n \"branch\": \"esse enim qui proident\",\n \"address2\": \"Excepteur nisi mollit\",\n \"country\": \"PH\",\n \"country_name\": \"do ex\",\n \"website\": \"qui adipisicing sunt\",\n \"vat_number\": \"aliquip enim nulla eiusmod\",\n \"logo\": \"https://KoNTCcHmsMrTGrChxxuYhZJngDLwGo.mqlCx+BIL9wBB+Zp+ioT,KQ9ZwY1ftCRLMzngDiq5YvGVOSDQyWzghhK7Oc.5W.XTRU2QHE\",\n \"logo_name\": \"Lorem ullamco ex consequat cupidatat\",\n \"created\": \"2020-07-01T16:57:52.188Z\",\n \"id\": \"389dafae-53dd-0bed-8e5b-a780d4df4db1\",\n \"verified_bank\": \"nostrud\",\n \"verified_dnb\": \"tempor non deserunt nisi do\"\n },\n \"contact_person\": {\n \"email\": \"GW6cW17t@rP.cd\",\n \"telephone\": \"nulla veniam est consequat et\",\n \"name\": \"ea cillum\",\n \"first_name\": \"tempor qui\",\n \"last_name\": \"aliquip amet\",\n \"company_id\": \"consequat officia aliquip fugiat\",\n \"company\": {\n \"name\": \"labore magna officia nulla amet\",\n \"address\": \"Duis dolore veniam est\",\n \"postal_code\": \"enim id\",\n \"city\": \"culpa amet ad et\",\n \"branch\": \"quis Lorem\",\n \"address2\": \"voluptate quis sunt elit\",\n \"country\": \"BS\",\n \"country_name\": \"aliquip aliqua quis qui mollit\",\n \"website\": \"laborum in nulla\",\n \"vat_number\": \"commodo a\",\n \"logo\": \"https://AHGXHDMGYVvOAwlejBNVLTvFHmqIJKG.izVYWUiZauiKlBb\",\n \"logo_name\": \"commodo nostrud sunt ea cillum\",\n \"created\": \"2007-11-05T07:17:28.301Z\",\n \"id\": \"d45a6f64-70e2-4f2a-3835-2696e5a42bf8\",\n \"verified_bank\": \"do proident irure\",\n \"verified_dnb\": \"qui\"\n },\n \"logo\": \"https://DpWoWJmarJZAsvAcMSgnhZ.tuk4352feDYABJYY.xKniMvt.kZ-.ncVi4TncaIyGBSLeiwp3mYqRfGOVy-rJEreKWqB9J+FqqpktHd1s\",\n \"logo_name\": \"Ut do deserunt\",\n \"id\": \"urn:uuid:34f614f0-366c-7a04-742c-4f6a04caafa5\"\n },\n \"id\": \"34c10045-1da5-89c9-424a-3fc501718725\"\n}" }, { "name": "Returned when contact is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/:contact/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", ":contact", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "contact", "value": "cons", "description": "(Required) \nThe contact identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the contact by their ID. Replace `{id}` with internal user id. |\n| `by-invitation-code/{invitation_code}` | Determine the contact by their invitation code. Replace `{invitation_code}` with contact's invitation code. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Update contact", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"BEB@kT.rz\",\n \"company\": {\n \"name\": \"ad nisi\",\n \"address\": \"ipsum\",\n \"postal_code\": \"est\",\n \"city\": \"ex minim\",\n \"branch\": \"deserunt nisi ut\",\n \"address2\": \"qui enim occaecat\",\n \"country\": \"BY\",\n \"country_name\": \"magna qui sed Lorem eiusmod\",\n \"website\": \"minim in dolor enim\",\n \"vat_number\": \"pariatur\",\n \"logo\": \"http://B.xgfiJePEKQXiQSaJnP8wrYc-PIfr+WIFDx3mHJYm5aLRWpEwSqQqLKz0+4YCNtP\",\n \"logo_name\": \"qui su\",\n \"created\": \"1976-04-19T20:44:45.009Z\",\n \"id\": \"54a62722-8d8e-4df5-8efc-59920fcba3b5\",\n \"verified_bank\": \"in ea\",\n \"verified_dnb\": \"ipsum\"\n },\n \"their_inbox\": {\n \"company\": {\n \"name\": \"sunt et reprehenderit ad\",\n \"address\": \"et ut Duis\",\n \"postal_code\": \"culpa deserunt\",\n \"city\": \"in ex veniam\",\n \"branch\": \"esse quis\",\n \"address2\": \"quis Duis\",\n \"country\": \"SR\",\n \"country_name\": \"ut minim\",\n \"website\": \"con\",\n \"vat_number\": \"Lorem eu ex velit\",\n \"logo\": \"https://mCwuDDLPlXTAIxKAg.ngfrlfF04,e5OpO2SVh+SlPdvayhE1cKT4vslXmedmqThEK8YrAEM6fDHC+phtNsCI.1ySMG-lKSSl\",\n \"logo_name\": \"in ma\",\n \"created\": \"1990-09-30T15:19:00.103Z\",\n \"id\": \"urn:uuid:38c36a5f-ad22-b600-5e33-58dcc4098c37\",\n \"verified_bank\": \"si\",\n \"verified_dnb\": \"consectetur fugiat aliquip\"\n },\n \"name\": \"eiusmod in proident\",\n \"ethereum_address\": \"0x8cC0eAA4b8dfdAA6BeCE21aFdEFB6AF306CF62BB\"\n },\n \"message\": \"sed ullamco\",\n \"note\": \"incididunt ut id reprehenderit\",\n \"invitation_code\": \"magna non cillum exercitation\",\n \"status\": \"accepted-via-another-user\",\n \"created\": \"1942-02-09T00:37:52.710Z\",\n \"created_by\": {\n \"email\": \"AU2@mtCbdctaVtSrTqnYrwWJqFLgR.ce\",\n \"telephone\": \"Ut aute\",\n \"name\": \"deserunt dol\",\n \"first_name\": \"sed eu esse\",\n \"last_name\": \"Excepteur ullamco\",\n \"company_id\": \"et pariatur dolore est sint\",\n \"company\": {\n \"name\": \"dolor\",\n \"address\": \"ullamco eiusmod ut\",\n \"postal_code\": \"do cillum minim dolor voluptate\",\n \"city\": \"cillum deserunt quis voluptate\",\n \"branch\": \"consequat dolor proident dolore irure\",\n \"address2\": \"Excepteur consectetur adipisicing in\",\n \"country\": \"PT\",\n \"country_name\": \"cupidatat sunt non labore\",\n \"website\": \"Lorem veniam do\",\n \"vat_number\": \"ex sint\",\n \"logo\": \"http://OYUXncsAGjRYi.lhkrWNYCjPk,.oGZ-Q7lww3hTw05\",\n \"logo_name\": \"Excepteur anim exercitation\",\n \"created\": \"2011-07-21T17:06:35.638Z\",\n \"id\": \"a95c33f7-8ddd-0e4b-6b2b-090525f3941d\",\n \"verified_bank\": \"comm\",\n \"verified_dnb\": \"laborum ut\"\n },\n \"logo\": \"https://dyBEeZcgAa.cjJPeMLnPUhLSzQpxep\",\n \"logo_name\": \"fugiat nisi ut laborum sint\",\n \"id\": \"f8b6b79f-8473-4276-3248-10911b33c2e0\"\n },\n \"resolved\": \"1970-06-26T17:30:38.903Z\",\n \"resolved_by\": {\n \"email\": \"T7K2QqsuaFYQ@mpOWrZiuBJBYo.uavx\",\n \"telephone\": \"consectetur eiusmod\",\n \"name\": \"ea\",\n \"first_name\": \"aliqua\",\n \"last_name\": \"ipsum\",\n \"company_id\": \"culpa\",\n \"company\": {\n \"name\": \"ad laborum mollit anim id\",\n \"address\": \"quis proident reprehenderit aute labo\",\n \"postal_code\": \"eiusmod magna ex elit\",\n \"city\": \"laboris irure\",\n \"branch\": \"anim Excepteur nostrud ex\",\n \"address2\": \"dolor consequat elit minim\",\n \"country\": \"BW\",\n \"country_name\": \"dolor Excepteur reprehenderit\",\n \"website\": \"Ut elit proident sit\",\n \"vat_number\": \"mollit incididunt\",\n \"logo\": \"https://rcjpWcMQZvVzFjPMZZrGL.mpnf60.3v3wCNAYV+LcfR6iDN\",\n \"logo_name\": \"anim\",\n \"created\": \"1968-06-05T15:19:32.595Z\",\n \"id\": \"940c987d-f48c-4e4a-2f5c-14d49bf3c1a3\",\n \"verified_bank\": \"in magna id eu\",\n \"verified_dnb\": \"eu tempor in elit\"\n },\n \"logo\": \"http://WYMylXjvqNAfS.kqopYtw2fzn-tZhIKC8JxJQIkcJ7q\",\n \"logo_name\": \"eu cillum voluptate Duis ipsum\",\n \"id\": \"8e078752-4284-3bb4-f6f9-7b8e4b376935\"\n },\n \"resolved_by_company\": {\n \"name\": \"sunt irure\",\n \"address\": \"proident voluptate\",\n \"postal_code\": \"enim eiusmod deserunt cupidatat\",\n \"city\": \"ex ut amet\",\n \"branch\": \"quis anim sint deserunt\",\n \"address2\": \"eiusmod dolore sint\",\n \"country\": \"CC\",\n \"country_name\": \"est veniam cupidatat\",\n \"website\": \"consequat in quis ex\",\n \"vat_number\": \"sunt ea\",\n \"logo\": \"https://dpfhhDTWQbSHTRKoyZ.zaviMw8koC0etsBeECE9fOOGjtbsiTL8oGDZLstKj26\",\n \"logo_name\": \"commodo velit\",\n \"created\": \"1957-04-24T11:49:56.620Z\",\n \"id\": \"ccdff91a-8586-5f55-7a73-e24679dd59b2\",\n \"verified_bank\": \"aliquip deserunt ex nisi\",\n \"verified_dnb\": \"Duis ea laborum pariatur reprehenderit\"\n },\n \"contact_person\": {\n \"email\": \"FH9mMYYWYwWZ8E@CIpLDnfdpxwQwRvdFgiTbQvB.sakf\",\n \"telephone\": \"ut velit do\",\n \"name\": \"velit pariatur voluptate\",\n \"first_name\": \"Excepteur sunt\",\n \"last_name\": \"deserunt laboris\",\n \"company_id\": \"minim\",\n \"company\": {\n \"name\": \"eu tempor elit\",\n \"address\": \"pariatur velit consectetur Excepteur\",\n \"postal_code\": \"nulla\",\n \"city\": \"ex ut nostrud\",\n \"branch\": \"sunt\",\n \"address2\": \"voluptate consectetur esse\",\n \"country\": \"AF\",\n \"country_name\": \"reprehenderit in\",\n \"website\": \"nisi sed labore Duis\",\n \"vat_number\": \"reprehenderit elit\",\n \"logo\": \"https://l.ghFLfZb-Oh1kvTe6flSmedkN-5K\",\n \"logo_name\": \"dolor sunt ut\",\n \"created\": \"1964-09-29T04:35:09.383Z\",\n \"id\": \"urn:uuid:ae6c7931-a2c3-4dfa-5843-2e32bf5768cb\",\n \"verified_bank\": \"culpa eu magna\",\n \"verified_dnb\": \"est esse ipsum in in\"\n },\n \"logo\": \"https://LcYRkVoXvalZnMRfzPnTKcDjy.pulzN1LUVqzWxX0VMn5U7Oo\",\n \"logo_name\": \"consequat reprehenderit aute laborum\",\n \"id\": \"90269cda-8fdc-bd7d-225c-21775d10d1ec\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/contacts/:contact/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", ":contact", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "contact", "value": "cons", "description": "(Required) \nThe contact identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the contact by their ID. Replace `{id}` with internal user id. |\n| `by-invitation-code/{invitation_code}` | Determine the contact by their invitation code. Replace `{invitation_code}` with contact's invitation code. |\n" } ] }, "description": "Updates the contact. All data needs to be present to perform an update. If data is incomplete,\n please use a `PATCH` call. Contacts cannot be moved between inboxes." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/:contact/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", ":contact", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "contact", "value": "cons", "description": "(Required) \nThe contact identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the contact by their ID. Replace `{id}` with internal user id. |\n| `by-invitation-code/{invitation_code}` | Determine the contact by their invitation code. Replace `{invitation_code}` with contact's invitation code. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"d3EfNCJ7Zaz8Xg@KiOVqxXlaixxrxEnQyq.jeu\",\n \"company_id\": \"pariatur ex ut dolore\",\n \"company\": {\n \"name\": \"aute sint non commodo\",\n \"address\": \"nisi\",\n \"postal_code\": \"laborum et ipsum\",\n \"city\": \"cillum Duis\",\n \"branch\": \"magna culpa Lorem\",\n \"address2\": \"tempor nostrud\",\n \"country\": \"CH\",\n \"country_name\": \"veniam occaecat dolore cillum\",\n \"website\": \"in incididunt cupidatat dolor esse\",\n \"vat_number\": \"minim dolor\",\n \"logo\": \"https://sjPZoTJKhTqd.ocacuIbwf0xdyTwbqSpHkiZyesYJMzPowWCMoCn4UbEXX\",\n \"logo_name\": \"minim\",\n \"created\": \"1992-11-24T00:04:43.475Z\",\n \"id\": \"urn:uuid:812edadc-0df5-db53-5db3-86c687937af6\",\n \"verified_bank\": \"sed\",\n \"verified_dnb\": \"occaecat aute\"\n },\n \"my_inbox_id\": \"Duis\",\n \"their_inbox_id\": \"a\",\n \"their_inbox\": {\n \"company\": {\n \"name\": \"ad pariatur\",\n \"address\": \"dolore id\",\n \"postal_code\": \"eu\",\n \"city\": \"Lorem ullamco\",\n \"branch\": \"mollit in ipsum pariatur\",\n \"address2\": \"consectetur ad\",\n \"country\": \"DO\",\n \"country_name\": \"ex\",\n \"website\": \"laboris labore\",\n \"vat_number\": \"adipisicing cupidatat ullamco sit\",\n \"logo\": \"http://OhnLOsuKMMsgPDWbg.eaxJAErqxW2hUR9ikN0CkQ\",\n \"logo_name\": \"non\",\n \"created\": \"1997-04-08T07:57:45.039Z\",\n \"id\": \"4f12e38b-0532-de09-5e14-08738557dbda\",\n \"verified_bank\": \"culpa magna ullamco nisi cillum\",\n \"verified_dnb\": \"irure dolor\"\n },\n \"name\": \"laboris tempor\",\n \"ethereum_address\": \"0x425070A934ED190A15fdeBCA36edF0Ea8Fe481F9\"\n },\n \"message\": \"et eu deserunt laboris\",\n \"note\": \"dolore aliquip\",\n \"invitation_code\": \"proident non do\",\n \"status\": \"accepted\",\n \"created\": \"1988-07-06T20:53:38.131Z\",\n \"created_by_id\": \"elit esse laboris in\",\n \"created_by\": {\n \"email\": \"e1qaeCZwvD0fOz@RkNyN.oibh\",\n \"telephone\": \"velit ut et incididunt laborum\",\n \"name\": \"sed tempor Ut ad\",\n \"first_name\": \"occaecat ut dolore\",\n \"last_name\": \"nulla esse incid\",\n \"company_id\": \"est\",\n \"company\": {\n \"name\": \"deserunt aliqua adipisicing magna commodo\",\n \"address\": \"ad\",\n \"postal_code\": \"reprehenderit Lorem elit\",\n \"city\": \"tempor consectetur ut\",\n \"branch\": \"incididunt\",\n \"address2\": \"nulla dolor pariatur\",\n \"country\": \"PF\",\n \"country_name\": \"voluptate\",\n \"website\": \"consectetur cillum\",\n \"vat_number\": \"do mollit amet eiusmod\",\n \"logo\": \"http://BrpkcNxlbcqaijqgVamSLkZ.bgopvZ3-K5QL7BHD6CLoC3BpNzlpuVwrTm0CF3SV\",\n \"logo_name\": \"eu pariatur\",\n \"created\": \"1973-12-27T00:07:55.441Z\",\n \"id\": \"urn:uuid:e095db6d-79dc-7c28-af28-6e4e34825b3d\",\n \"verified_bank\": \"nisi\",\n \"verified_dnb\": \"labore est deserunt veniam\"\n },\n \"logo\": \"http://Y.qoY+m6u8C0E\",\n \"logo_name\": \"commodo eu minim fugiat\",\n \"id\": \"d50b7796-168b-3941-c9f6-3caa90c7459f\"\n },\n \"resolved\": \"1978-09-14T10:22:49.851Z\",\n \"resolved_by_id\": \"enim ad\",\n \"resolved_by\": {\n \"email\": \"OchlOHMO5@ILgychgOqlizKCmfDAXura.wodc\",\n \"telephone\": \"id aliqua\",\n \"name\": \"ex aliquip ea sit\",\n \"first_name\": \"est\",\n \"last_name\": \"est sit exercitation\",\n \"company_id\": \"incididunt\",\n \"company\": {\n \"name\": \"labore\",\n \"address\": \"dolor ut cupidatat non nostru\",\n \"postal_code\": \"dolore commodo nulla\",\n \"city\": \"velit veniam\",\n \"branch\": \"quis reprehenderit esse\",\n \"address2\": \"veniam sit\",\n \"country\": \"LT\",\n \"country_name\": \"consectetur nisi\",\n \"website\": \"exercitation amet tempor\",\n \"vat_number\": \"reprehenderit elit nulla\",\n \"logo\": \"http://uhGMBZDiIeDHzC.oeezv32eNhxPwBI5cDq3..V4+tGPqcV5bNX2DsBVyxU5bUjqvIWr\",\n \"logo_name\": \"aliqua officia pariatur nulla\",\n \"created\": \"1945-05-07T13:44:10.465Z\",\n \"id\": \"urn:uuid:f3088fcc-e87f-df11-b2a7-06546d7eaa44\",\n \"verified_bank\": \"ut pariatur\",\n \"verified_dnb\": \"fugiat tempor dolor veniam\"\n },\n \"logo\": \"http://RnTYyCercdzWSlqikCEdoTz.xfm+PNfIVLi6pw\",\n \"logo_name\": \"et\",\n \"id\": \"urn:uuid:fe6be31a-93d2-27e1-f61c-2e28a7a6e254\"\n },\n \"resolved_by_company_id\": \"aliqua consequat ut\",\n \"resolved_by_company\": {\n \"name\": \"ut nulla\",\n \"address\": \"incididunt\",\n \"postal_code\": \"sint et sunt\",\n \"city\": \"laborum\",\n \"branch\": \"esse enim qui proident\",\n \"address2\": \"Excepteur nisi mollit\",\n \"country\": \"PH\",\n \"country_name\": \"do ex\",\n \"website\": \"qui adipisicing sunt\",\n \"vat_number\": \"aliquip enim nulla eiusmod\",\n \"logo\": \"https://KoNTCcHmsMrTGrChxxuYhZJngDLwGo.mqlCx+BIL9wBB+Zp+ioT,KQ9ZwY1ftCRLMzngDiq5YvGVOSDQyWzghhK7Oc.5W.XTRU2QHE\",\n \"logo_name\": \"Lorem ullamco ex consequat cupidatat\",\n \"created\": \"2020-07-01T16:57:52.188Z\",\n \"id\": \"389dafae-53dd-0bed-8e5b-a780d4df4db1\",\n \"verified_bank\": \"nostrud\",\n \"verified_dnb\": \"tempor non deserunt nisi do\"\n },\n \"contact_person\": {\n \"email\": \"GW6cW17t@rP.cd\",\n \"telephone\": \"nulla veniam est consequat et\",\n \"name\": \"ea cillum\",\n \"first_name\": \"tempor qui\",\n \"last_name\": \"aliquip amet\",\n \"company_id\": \"consequat officia aliquip fugiat\",\n \"company\": {\n \"name\": \"labore magna officia nulla amet\",\n \"address\": \"Duis dolore veniam est\",\n \"postal_code\": \"enim id\",\n \"city\": \"culpa amet ad et\",\n \"branch\": \"quis Lorem\",\n \"address2\": \"voluptate quis sunt elit\",\n \"country\": \"BS\",\n \"country_name\": \"aliquip aliqua quis qui mollit\",\n \"website\": \"laborum in nulla\",\n \"vat_number\": \"commodo a\",\n \"logo\": \"https://AHGXHDMGYVvOAwlejBNVLTvFHmqIJKG.izVYWUiZauiKlBb\",\n \"logo_name\": \"commodo nostrud sunt ea cillum\",\n \"created\": \"2007-11-05T07:17:28.301Z\",\n \"id\": \"d45a6f64-70e2-4f2a-3835-2696e5a42bf8\",\n \"verified_bank\": \"do proident irure\",\n \"verified_dnb\": \"qui\"\n },\n \"logo\": \"https://DpWoWJmarJZAsvAcMSgnhZ.tuk4352feDYABJYY.xKniMvt.kZ-.ncVi4TncaIyGBSLeiwp3mYqRfGOVy-rJEreKWqB9J+FqqpktHd1s\",\n \"logo_name\": \"Ut do deserunt\",\n \"id\": \"urn:uuid:34f614f0-366c-7a04-742c-4f6a04caafa5\"\n },\n \"id\": \"34c10045-1da5-89c9-424a-3fc501718725\"\n}" }, { "name": "Returned when user does not have permission to update a contact.", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/:contact/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", ":contact", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "contact", "value": "cons", "description": "(Required) \nThe contact identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the contact by their ID. Replace `{id}` with internal user id. |\n| `by-invitation-code/{invitation_code}` | Determine the contact by their invitation code. Replace `{invitation_code}` with contact's invitation code. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when contact is not found.", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/:contact/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", ":contact", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "contact", "value": "cons", "description": "(Required) \nThe contact identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the contact by their ID. Replace `{id}` with internal user id. |\n| `by-invitation-code/{invitation_code}` | Determine the contact by their invitation code. Replace `{invitation_code}` with contact's invitation code. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Partially update contact", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"BEB@kT.rz\",\n \"company\": {\n \"name\": \"ad nisi\",\n \"address\": \"ipsum\",\n \"postal_code\": \"est\",\n \"city\": \"ex minim\",\n \"branch\": \"deserunt nisi ut\",\n \"address2\": \"qui enim occaecat\",\n \"country\": \"BY\",\n \"country_name\": \"magna qui sed Lorem eiusmod\",\n \"website\": \"minim in dolor enim\",\n \"vat_number\": \"pariatur\",\n \"logo\": \"http://B.xgfiJePEKQXiQSaJnP8wrYc-PIfr+WIFDx3mHJYm5aLRWpEwSqQqLKz0+4YCNtP\",\n \"logo_name\": \"qui su\",\n \"created\": \"1976-04-19T20:44:45.009Z\",\n \"id\": \"54a62722-8d8e-4df5-8efc-59920fcba3b5\",\n \"verified_bank\": \"in ea\",\n \"verified_dnb\": \"ipsum\"\n },\n \"their_inbox\": {\n \"company\": {\n \"name\": \"sunt et reprehenderit ad\",\n \"address\": \"et ut Duis\",\n \"postal_code\": \"culpa deserunt\",\n \"city\": \"in ex veniam\",\n \"branch\": \"esse quis\",\n \"address2\": \"quis Duis\",\n \"country\": \"SR\",\n \"country_name\": \"ut minim\",\n \"website\": \"con\",\n \"vat_number\": \"Lorem eu ex velit\",\n \"logo\": \"https://mCwuDDLPlXTAIxKAg.ngfrlfF04,e5OpO2SVh+SlPdvayhE1cKT4vslXmedmqThEK8YrAEM6fDHC+phtNsCI.1ySMG-lKSSl\",\n \"logo_name\": \"in ma\",\n \"created\": \"1990-09-30T15:19:00.103Z\",\n \"id\": \"urn:uuid:38c36a5f-ad22-b600-5e33-58dcc4098c37\",\n \"verified_bank\": \"si\",\n \"verified_dnb\": \"consectetur fugiat aliquip\"\n },\n \"name\": \"eiusmod in proident\",\n \"ethereum_address\": \"0x8cC0eAA4b8dfdAA6BeCE21aFdEFB6AF306CF62BB\"\n },\n \"message\": \"sed ullamco\",\n \"note\": \"incididunt ut id reprehenderit\",\n \"invitation_code\": \"magna non cillum exercitation\",\n \"status\": \"accepted-via-another-user\",\n \"created\": \"1942-02-09T00:37:52.710Z\",\n \"created_by\": {\n \"email\": \"AU2@mtCbdctaVtSrTqnYrwWJqFLgR.ce\",\n \"telephone\": \"Ut aute\",\n \"name\": \"deserunt dol\",\n \"first_name\": \"sed eu esse\",\n \"last_name\": \"Excepteur ullamco\",\n \"company_id\": \"et pariatur dolore est sint\",\n \"company\": {\n \"name\": \"dolor\",\n \"address\": \"ullamco eiusmod ut\",\n \"postal_code\": \"do cillum minim dolor voluptate\",\n \"city\": \"cillum deserunt quis voluptate\",\n \"branch\": \"consequat dolor proident dolore irure\",\n \"address2\": \"Excepteur consectetur adipisicing in\",\n \"country\": \"PT\",\n \"country_name\": \"cupidatat sunt non labore\",\n \"website\": \"Lorem veniam do\",\n \"vat_number\": \"ex sint\",\n \"logo\": \"http://OYUXncsAGjRYi.lhkrWNYCjPk,.oGZ-Q7lww3hTw05\",\n \"logo_name\": \"Excepteur anim exercitation\",\n \"created\": \"2011-07-21T17:06:35.638Z\",\n \"id\": \"a95c33f7-8ddd-0e4b-6b2b-090525f3941d\",\n \"verified_bank\": \"comm\",\n \"verified_dnb\": \"laborum ut\"\n },\n \"logo\": \"https://dyBEeZcgAa.cjJPeMLnPUhLSzQpxep\",\n \"logo_name\": \"fugiat nisi ut laborum sint\",\n \"id\": \"f8b6b79f-8473-4276-3248-10911b33c2e0\"\n },\n \"resolved\": \"1970-06-26T17:30:38.903Z\",\n \"resolved_by\": {\n \"email\": \"T7K2QqsuaFYQ@mpOWrZiuBJBYo.uavx\",\n \"telephone\": \"consectetur eiusmod\",\n \"name\": \"ea\",\n \"first_name\": \"aliqua\",\n \"last_name\": \"ipsum\",\n \"company_id\": \"culpa\",\n \"company\": {\n \"name\": \"ad laborum mollit anim id\",\n \"address\": \"quis proident reprehenderit aute labo\",\n \"postal_code\": \"eiusmod magna ex elit\",\n \"city\": \"laboris irure\",\n \"branch\": \"anim Excepteur nostrud ex\",\n \"address2\": \"dolor consequat elit minim\",\n \"country\": \"BW\",\n \"country_name\": \"dolor Excepteur reprehenderit\",\n \"website\": \"Ut elit proident sit\",\n \"vat_number\": \"mollit incididunt\",\n \"logo\": \"https://rcjpWcMQZvVzFjPMZZrGL.mpnf60.3v3wCNAYV+LcfR6iDN\",\n \"logo_name\": \"anim\",\n \"created\": \"1968-06-05T15:19:32.595Z\",\n \"id\": \"940c987d-f48c-4e4a-2f5c-14d49bf3c1a3\",\n \"verified_bank\": \"in magna id eu\",\n \"verified_dnb\": \"eu tempor in elit\"\n },\n \"logo\": \"http://WYMylXjvqNAfS.kqopYtw2fzn-tZhIKC8JxJQIkcJ7q\",\n \"logo_name\": \"eu cillum voluptate Duis ipsum\",\n \"id\": \"8e078752-4284-3bb4-f6f9-7b8e4b376935\"\n },\n \"resolved_by_company\": {\n \"name\": \"sunt irure\",\n \"address\": \"proident voluptate\",\n \"postal_code\": \"enim eiusmod deserunt cupidatat\",\n \"city\": \"ex ut amet\",\n \"branch\": \"quis anim sint deserunt\",\n \"address2\": \"eiusmod dolore sint\",\n \"country\": \"CC\",\n \"country_name\": \"est veniam cupidatat\",\n \"website\": \"consequat in quis ex\",\n \"vat_number\": \"sunt ea\",\n \"logo\": \"https://dpfhhDTWQbSHTRKoyZ.zaviMw8koC0etsBeECE9fOOGjtbsiTL8oGDZLstKj26\",\n \"logo_name\": \"commodo velit\",\n \"created\": \"1957-04-24T11:49:56.620Z\",\n \"id\": \"ccdff91a-8586-5f55-7a73-e24679dd59b2\",\n \"verified_bank\": \"aliquip deserunt ex nisi\",\n \"verified_dnb\": \"Duis ea laborum pariatur reprehenderit\"\n },\n \"contact_person\": {\n \"email\": \"FH9mMYYWYwWZ8E@CIpLDnfdpxwQwRvdFgiTbQvB.sakf\",\n \"telephone\": \"ut velit do\",\n \"name\": \"velit pariatur voluptate\",\n \"first_name\": \"Excepteur sunt\",\n \"last_name\": \"deserunt laboris\",\n \"company_id\": \"minim\",\n \"company\": {\n \"name\": \"eu tempor elit\",\n \"address\": \"pariatur velit consectetur Excepteur\",\n \"postal_code\": \"nulla\",\n \"city\": \"ex ut nostrud\",\n \"branch\": \"sunt\",\n \"address2\": \"voluptate consectetur esse\",\n \"country\": \"AF\",\n \"country_name\": \"reprehenderit in\",\n \"website\": \"nisi sed labore Duis\",\n \"vat_number\": \"reprehenderit elit\",\n \"logo\": \"https://l.ghFLfZb-Oh1kvTe6flSmedkN-5K\",\n \"logo_name\": \"dolor sunt ut\",\n \"created\": \"1964-09-29T04:35:09.383Z\",\n \"id\": \"urn:uuid:ae6c7931-a2c3-4dfa-5843-2e32bf5768cb\",\n \"verified_bank\": \"culpa eu magna\",\n \"verified_dnb\": \"est esse ipsum in in\"\n },\n \"logo\": \"https://LcYRkVoXvalZnMRfzPnTKcDjy.pulzN1LUVqzWxX0VMn5U7Oo\",\n \"logo_name\": \"consequat reprehenderit aute laborum\",\n \"id\": \"90269cda-8fdc-bd7d-225c-21775d10d1ec\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/contacts/:contact/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", ":contact", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "contact", "value": "cons", "description": "(Required) \nThe contact identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the contact by their ID. Replace `{id}` with internal user id. |\n| `by-invitation-code/{invitation_code}` | Determine the contact by their invitation code. Replace `{invitation_code}` with contact's invitation code. |\n" } ] }, "description": "Partially updates the contact. Only the data that needs to be changed is required.\n Contacts cannot be moved between inboxes." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/:contact/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", ":contact", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "contact", "value": "cons", "description": "(Required) \nThe contact identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the contact by their ID. Replace `{id}` with internal user id. |\n| `by-invitation-code/{invitation_code}` | Determine the contact by their invitation code. Replace `{invitation_code}` with contact's invitation code. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"d3EfNCJ7Zaz8Xg@KiOVqxXlaixxrxEnQyq.jeu\",\n \"company_id\": \"pariatur ex ut dolore\",\n \"company\": {\n \"name\": \"aute sint non commodo\",\n \"address\": \"nisi\",\n \"postal_code\": \"laborum et ipsum\",\n \"city\": \"cillum Duis\",\n \"branch\": \"magna culpa Lorem\",\n \"address2\": \"tempor nostrud\",\n \"country\": \"CH\",\n \"country_name\": \"veniam occaecat dolore cillum\",\n \"website\": \"in incididunt cupidatat dolor esse\",\n \"vat_number\": \"minim dolor\",\n \"logo\": \"https://sjPZoTJKhTqd.ocacuIbwf0xdyTwbqSpHkiZyesYJMzPowWCMoCn4UbEXX\",\n \"logo_name\": \"minim\",\n \"created\": \"1992-11-24T00:04:43.475Z\",\n \"id\": \"urn:uuid:812edadc-0df5-db53-5db3-86c687937af6\",\n \"verified_bank\": \"sed\",\n \"verified_dnb\": \"occaecat aute\"\n },\n \"my_inbox_id\": \"Duis\",\n \"their_inbox_id\": \"a\",\n \"their_inbox\": {\n \"company\": {\n \"name\": \"ad pariatur\",\n \"address\": \"dolore id\",\n \"postal_code\": \"eu\",\n \"city\": \"Lorem ullamco\",\n \"branch\": \"mollit in ipsum pariatur\",\n \"address2\": \"consectetur ad\",\n \"country\": \"DO\",\n \"country_name\": \"ex\",\n \"website\": \"laboris labore\",\n \"vat_number\": \"adipisicing cupidatat ullamco sit\",\n \"logo\": \"http://OhnLOsuKMMsgPDWbg.eaxJAErqxW2hUR9ikN0CkQ\",\n \"logo_name\": \"non\",\n \"created\": \"1997-04-08T07:57:45.039Z\",\n \"id\": \"4f12e38b-0532-de09-5e14-08738557dbda\",\n \"verified_bank\": \"culpa magna ullamco nisi cillum\",\n \"verified_dnb\": \"irure dolor\"\n },\n \"name\": \"laboris tempor\",\n \"ethereum_address\": \"0x425070A934ED190A15fdeBCA36edF0Ea8Fe481F9\"\n },\n \"message\": \"et eu deserunt laboris\",\n \"note\": \"dolore aliquip\",\n \"invitation_code\": \"proident non do\",\n \"status\": \"accepted\",\n \"created\": \"1988-07-06T20:53:38.131Z\",\n \"created_by_id\": \"elit esse laboris in\",\n \"created_by\": {\n \"email\": \"e1qaeCZwvD0fOz@RkNyN.oibh\",\n \"telephone\": \"velit ut et incididunt laborum\",\n \"name\": \"sed tempor Ut ad\",\n \"first_name\": \"occaecat ut dolore\",\n \"last_name\": \"nulla esse incid\",\n \"company_id\": \"est\",\n \"company\": {\n \"name\": \"deserunt aliqua adipisicing magna commodo\",\n \"address\": \"ad\",\n \"postal_code\": \"reprehenderit Lorem elit\",\n \"city\": \"tempor consectetur ut\",\n \"branch\": \"incididunt\",\n \"address2\": \"nulla dolor pariatur\",\n \"country\": \"PF\",\n \"country_name\": \"voluptate\",\n \"website\": \"consectetur cillum\",\n \"vat_number\": \"do mollit amet eiusmod\",\n \"logo\": \"http://BrpkcNxlbcqaijqgVamSLkZ.bgopvZ3-K5QL7BHD6CLoC3BpNzlpuVwrTm0CF3SV\",\n \"logo_name\": \"eu pariatur\",\n \"created\": \"1973-12-27T00:07:55.441Z\",\n \"id\": \"urn:uuid:e095db6d-79dc-7c28-af28-6e4e34825b3d\",\n \"verified_bank\": \"nisi\",\n \"verified_dnb\": \"labore est deserunt veniam\"\n },\n \"logo\": \"http://Y.qoY+m6u8C0E\",\n \"logo_name\": \"commodo eu minim fugiat\",\n \"id\": \"d50b7796-168b-3941-c9f6-3caa90c7459f\"\n },\n \"resolved\": \"1978-09-14T10:22:49.851Z\",\n \"resolved_by_id\": \"enim ad\",\n \"resolved_by\": {\n \"email\": \"OchlOHMO5@ILgychgOqlizKCmfDAXura.wodc\",\n \"telephone\": \"id aliqua\",\n \"name\": \"ex aliquip ea sit\",\n \"first_name\": \"est\",\n \"last_name\": \"est sit exercitation\",\n \"company_id\": \"incididunt\",\n \"company\": {\n \"name\": \"labore\",\n \"address\": \"dolor ut cupidatat non nostru\",\n \"postal_code\": \"dolore commodo nulla\",\n \"city\": \"velit veniam\",\n \"branch\": \"quis reprehenderit esse\",\n \"address2\": \"veniam sit\",\n \"country\": \"LT\",\n \"country_name\": \"consectetur nisi\",\n \"website\": \"exercitation amet tempor\",\n \"vat_number\": \"reprehenderit elit nulla\",\n \"logo\": \"http://uhGMBZDiIeDHzC.oeezv32eNhxPwBI5cDq3..V4+tGPqcV5bNX2DsBVyxU5bUjqvIWr\",\n \"logo_name\": \"aliqua officia pariatur nulla\",\n \"created\": \"1945-05-07T13:44:10.465Z\",\n \"id\": \"urn:uuid:f3088fcc-e87f-df11-b2a7-06546d7eaa44\",\n \"verified_bank\": \"ut pariatur\",\n \"verified_dnb\": \"fugiat tempor dolor veniam\"\n },\n \"logo\": \"http://RnTYyCercdzWSlqikCEdoTz.xfm+PNfIVLi6pw\",\n \"logo_name\": \"et\",\n \"id\": \"urn:uuid:fe6be31a-93d2-27e1-f61c-2e28a7a6e254\"\n },\n \"resolved_by_company_id\": \"aliqua consequat ut\",\n \"resolved_by_company\": {\n \"name\": \"ut nulla\",\n \"address\": \"incididunt\",\n \"postal_code\": \"sint et sunt\",\n \"city\": \"laborum\",\n \"branch\": \"esse enim qui proident\",\n \"address2\": \"Excepteur nisi mollit\",\n \"country\": \"PH\",\n \"country_name\": \"do ex\",\n \"website\": \"qui adipisicing sunt\",\n \"vat_number\": \"aliquip enim nulla eiusmod\",\n \"logo\": \"https://KoNTCcHmsMrTGrChxxuYhZJngDLwGo.mqlCx+BIL9wBB+Zp+ioT,KQ9ZwY1ftCRLMzngDiq5YvGVOSDQyWzghhK7Oc.5W.XTRU2QHE\",\n \"logo_name\": \"Lorem ullamco ex consequat cupidatat\",\n \"created\": \"2020-07-01T16:57:52.188Z\",\n \"id\": \"389dafae-53dd-0bed-8e5b-a780d4df4db1\",\n \"verified_bank\": \"nostrud\",\n \"verified_dnb\": \"tempor non deserunt nisi do\"\n },\n \"contact_person\": {\n \"email\": \"GW6cW17t@rP.cd\",\n \"telephone\": \"nulla veniam est consequat et\",\n \"name\": \"ea cillum\",\n \"first_name\": \"tempor qui\",\n \"last_name\": \"aliquip amet\",\n \"company_id\": \"consequat officia aliquip fugiat\",\n \"company\": {\n \"name\": \"labore magna officia nulla amet\",\n \"address\": \"Duis dolore veniam est\",\n \"postal_code\": \"enim id\",\n \"city\": \"culpa amet ad et\",\n \"branch\": \"quis Lorem\",\n \"address2\": \"voluptate quis sunt elit\",\n \"country\": \"BS\",\n \"country_name\": \"aliquip aliqua quis qui mollit\",\n \"website\": \"laborum in nulla\",\n \"vat_number\": \"commodo a\",\n \"logo\": \"https://AHGXHDMGYVvOAwlejBNVLTvFHmqIJKG.izVYWUiZauiKlBb\",\n \"logo_name\": \"commodo nostrud sunt ea cillum\",\n \"created\": \"2007-11-05T07:17:28.301Z\",\n \"id\": \"d45a6f64-70e2-4f2a-3835-2696e5a42bf8\",\n \"verified_bank\": \"do proident irure\",\n \"verified_dnb\": \"qui\"\n },\n \"logo\": \"https://DpWoWJmarJZAsvAcMSgnhZ.tuk4352feDYABJYY.xKniMvt.kZ-.ncVi4TncaIyGBSLeiwp3mYqRfGOVy-rJEreKWqB9J+FqqpktHd1s\",\n \"logo_name\": \"Ut do deserunt\",\n \"id\": \"urn:uuid:34f614f0-366c-7a04-742c-4f6a04caafa5\"\n },\n \"id\": \"34c10045-1da5-89c9-424a-3fc501718725\"\n}" }, { "name": "Returned when user does not have permission to update a contact.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/:contact/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", ":contact", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "contact", "value": "cons", "description": "(Required) \nThe contact identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the contact by their ID. Replace `{id}` with internal user id. |\n| `by-invitation-code/{invitation_code}` | Determine the contact by their invitation code. Replace `{invitation_code}` with contact's invitation code. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when contact is not found.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/:contact/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", ":contact", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "contact", "value": "cons", "description": "(Required) \nThe contact identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the contact by their ID. Replace `{id}` with internal user id. |\n| `by-invitation-code/{invitation_code}` | Determine the contact by their invitation code. Replace `{invitation_code}` with contact's invitation code. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Delete contact", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/:contact/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", ":contact", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "contact", "value": "cons", "description": "(Required) \nThe contact identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the contact by their ID. Replace `{id}` with internal user id. |\n| `by-invitation-code/{invitation_code}` | Determine the contact by their invitation code. Replace `{invitation_code}` with contact's invitation code. |\n" } ] }, "description": "Deletes a single contact entry of a company that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Returned when the contact is successfully deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/:contact/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", ":contact", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "contact", "value": "cons", "description": "(Required) \nThe contact identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the contact by their ID. Replace `{id}` with internal user id. |\n| `by-invitation-code/{invitation_code}` | Determine the contact by their invitation code. Replace `{invitation_code}` with contact's invitation code. |\n" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when user does not have permission to delete a contact.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/:contact/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", ":contact", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "contact", "value": "cons", "description": "(Required) \nThe contact identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the contact by their ID. Replace `{id}` with internal user id. |\n| `by-invitation-code/{invitation_code}` | Determine the contact by their invitation code. Replace `{invitation_code}` with contact's invitation code. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when the contact is not found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/:contact/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", ":contact", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "contact", "value": "cons", "description": "(Required) \nThe contact identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the contact by their ID. Replace `{id}` with internal user id. |\n| `by-invitation-code/{invitation_code}` | Determine the contact by their invitation code. Replace `{invitation_code}` with contact's invitation code. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Create contact", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"BEB@kT.rz\",\n \"company\": {\n \"name\": \"ad nisi\",\n \"address\": \"ipsum\",\n \"postal_code\": \"est\",\n \"city\": \"ex minim\",\n \"branch\": \"deserunt nisi ut\",\n \"address2\": \"qui enim occaecat\",\n \"country\": \"BY\",\n \"country_name\": \"magna qui sed Lorem eiusmod\",\n \"website\": \"minim in dolor enim\",\n \"vat_number\": \"pariatur\",\n \"logo\": \"http://B.xgfiJePEKQXiQSaJnP8wrYc-PIfr+WIFDx3mHJYm5aLRWpEwSqQqLKz0+4YCNtP\",\n \"logo_name\": \"qui su\",\n \"created\": \"1976-04-19T20:44:45.009Z\",\n \"id\": \"54a62722-8d8e-4df5-8efc-59920fcba3b5\",\n \"verified_bank\": \"in ea\",\n \"verified_dnb\": \"ipsum\"\n },\n \"their_inbox\": {\n \"company\": {\n \"name\": \"sunt et reprehenderit ad\",\n \"address\": \"et ut Duis\",\n \"postal_code\": \"culpa deserunt\",\n \"city\": \"in ex veniam\",\n \"branch\": \"esse quis\",\n \"address2\": \"quis Duis\",\n \"country\": \"SR\",\n \"country_name\": \"ut minim\",\n \"website\": \"con\",\n \"vat_number\": \"Lorem eu ex velit\",\n \"logo\": \"https://mCwuDDLPlXTAIxKAg.ngfrlfF04,e5OpO2SVh+SlPdvayhE1cKT4vslXmedmqThEK8YrAEM6fDHC+phtNsCI.1ySMG-lKSSl\",\n \"logo_name\": \"in ma\",\n \"created\": \"1990-09-30T15:19:00.103Z\",\n \"id\": \"urn:uuid:38c36a5f-ad22-b600-5e33-58dcc4098c37\",\n \"verified_bank\": \"si\",\n \"verified_dnb\": \"consectetur fugiat aliquip\"\n },\n \"name\": \"eiusmod in proident\",\n \"ethereum_address\": \"0x8cC0eAA4b8dfdAA6BeCE21aFdEFB6AF306CF62BB\"\n },\n \"message\": \"sed ullamco\",\n \"note\": \"incididunt ut id reprehenderit\",\n \"invitation_code\": \"magna non cillum exercitation\",\n \"status\": \"accepted-via-another-user\",\n \"created\": \"1942-02-09T00:37:52.710Z\",\n \"created_by\": {\n \"email\": \"AU2@mtCbdctaVtSrTqnYrwWJqFLgR.ce\",\n \"telephone\": \"Ut aute\",\n \"name\": \"deserunt dol\",\n \"first_name\": \"sed eu esse\",\n \"last_name\": \"Excepteur ullamco\",\n \"company_id\": \"et pariatur dolore est sint\",\n \"company\": {\n \"name\": \"dolor\",\n \"address\": \"ullamco eiusmod ut\",\n \"postal_code\": \"do cillum minim dolor voluptate\",\n \"city\": \"cillum deserunt quis voluptate\",\n \"branch\": \"consequat dolor proident dolore irure\",\n \"address2\": \"Excepteur consectetur adipisicing in\",\n \"country\": \"PT\",\n \"country_name\": \"cupidatat sunt non labore\",\n \"website\": \"Lorem veniam do\",\n \"vat_number\": \"ex sint\",\n \"logo\": \"http://OYUXncsAGjRYi.lhkrWNYCjPk,.oGZ-Q7lww3hTw05\",\n \"logo_name\": \"Excepteur anim exercitation\",\n \"created\": \"2011-07-21T17:06:35.638Z\",\n \"id\": \"a95c33f7-8ddd-0e4b-6b2b-090525f3941d\",\n \"verified_bank\": \"comm\",\n \"verified_dnb\": \"laborum ut\"\n },\n \"logo\": \"https://dyBEeZcgAa.cjJPeMLnPUhLSzQpxep\",\n \"logo_name\": \"fugiat nisi ut laborum sint\",\n \"id\": \"f8b6b79f-8473-4276-3248-10911b33c2e0\"\n },\n \"resolved\": \"1970-06-26T17:30:38.903Z\",\n \"resolved_by\": {\n \"email\": \"T7K2QqsuaFYQ@mpOWrZiuBJBYo.uavx\",\n \"telephone\": \"consectetur eiusmod\",\n \"name\": \"ea\",\n \"first_name\": \"aliqua\",\n \"last_name\": \"ipsum\",\n \"company_id\": \"culpa\",\n \"company\": {\n \"name\": \"ad laborum mollit anim id\",\n \"address\": \"quis proident reprehenderit aute labo\",\n \"postal_code\": \"eiusmod magna ex elit\",\n \"city\": \"laboris irure\",\n \"branch\": \"anim Excepteur nostrud ex\",\n \"address2\": \"dolor consequat elit minim\",\n \"country\": \"BW\",\n \"country_name\": \"dolor Excepteur reprehenderit\",\n \"website\": \"Ut elit proident sit\",\n \"vat_number\": \"mollit incididunt\",\n \"logo\": \"https://rcjpWcMQZvVzFjPMZZrGL.mpnf60.3v3wCNAYV+LcfR6iDN\",\n \"logo_name\": \"anim\",\n \"created\": \"1968-06-05T15:19:32.595Z\",\n \"id\": \"940c987d-f48c-4e4a-2f5c-14d49bf3c1a3\",\n \"verified_bank\": \"in magna id eu\",\n \"verified_dnb\": \"eu tempor in elit\"\n },\n \"logo\": \"http://WYMylXjvqNAfS.kqopYtw2fzn-tZhIKC8JxJQIkcJ7q\",\n \"logo_name\": \"eu cillum voluptate Duis ipsum\",\n \"id\": \"8e078752-4284-3bb4-f6f9-7b8e4b376935\"\n },\n \"resolved_by_company\": {\n \"name\": \"sunt irure\",\n \"address\": \"proident voluptate\",\n \"postal_code\": \"enim eiusmod deserunt cupidatat\",\n \"city\": \"ex ut amet\",\n \"branch\": \"quis anim sint deserunt\",\n \"address2\": \"eiusmod dolore sint\",\n \"country\": \"CC\",\n \"country_name\": \"est veniam cupidatat\",\n \"website\": \"consequat in quis ex\",\n \"vat_number\": \"sunt ea\",\n \"logo\": \"https://dpfhhDTWQbSHTRKoyZ.zaviMw8koC0etsBeECE9fOOGjtbsiTL8oGDZLstKj26\",\n \"logo_name\": \"commodo velit\",\n \"created\": \"1957-04-24T11:49:56.620Z\",\n \"id\": \"ccdff91a-8586-5f55-7a73-e24679dd59b2\",\n \"verified_bank\": \"aliquip deserunt ex nisi\",\n \"verified_dnb\": \"Duis ea laborum pariatur reprehenderit\"\n },\n \"contact_person\": {\n \"email\": \"FH9mMYYWYwWZ8E@CIpLDnfdpxwQwRvdFgiTbQvB.sakf\",\n \"telephone\": \"ut velit do\",\n \"name\": \"velit pariatur voluptate\",\n \"first_name\": \"Excepteur sunt\",\n \"last_name\": \"deserunt laboris\",\n \"company_id\": \"minim\",\n \"company\": {\n \"name\": \"eu tempor elit\",\n \"address\": \"pariatur velit consectetur Excepteur\",\n \"postal_code\": \"nulla\",\n \"city\": \"ex ut nostrud\",\n \"branch\": \"sunt\",\n \"address2\": \"voluptate consectetur esse\",\n \"country\": \"AF\",\n \"country_name\": \"reprehenderit in\",\n \"website\": \"nisi sed labore Duis\",\n \"vat_number\": \"reprehenderit elit\",\n \"logo\": \"https://l.ghFLfZb-Oh1kvTe6flSmedkN-5K\",\n \"logo_name\": \"dolor sunt ut\",\n \"created\": \"1964-09-29T04:35:09.383Z\",\n \"id\": \"urn:uuid:ae6c7931-a2c3-4dfa-5843-2e32bf5768cb\",\n \"verified_bank\": \"culpa eu magna\",\n \"verified_dnb\": \"est esse ipsum in in\"\n },\n \"logo\": \"https://LcYRkVoXvalZnMRfzPnTKcDjy.pulzN1LUVqzWxX0VMn5U7Oo\",\n \"logo_name\": \"consequat reprehenderit aute laborum\",\n \"id\": \"90269cda-8fdc-bd7d-225c-21775d10d1ec\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/contacts/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "contacts", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "Creates a new contact for a company that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "contacts", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"d3EfNCJ7Zaz8Xg@KiOVqxXlaixxrxEnQyq.jeu\",\n \"company_id\": \"pariatur ex ut dolore\",\n \"company\": {\n \"name\": \"aute sint non commodo\",\n \"address\": \"nisi\",\n \"postal_code\": \"laborum et ipsum\",\n \"city\": \"cillum Duis\",\n \"branch\": \"magna culpa Lorem\",\n \"address2\": \"tempor nostrud\",\n \"country\": \"CH\",\n \"country_name\": \"veniam occaecat dolore cillum\",\n \"website\": \"in incididunt cupidatat dolor esse\",\n \"vat_number\": \"minim dolor\",\n \"logo\": \"https://sjPZoTJKhTqd.ocacuIbwf0xdyTwbqSpHkiZyesYJMzPowWCMoCn4UbEXX\",\n \"logo_name\": \"minim\",\n \"created\": \"1992-11-24T00:04:43.475Z\",\n \"id\": \"urn:uuid:812edadc-0df5-db53-5db3-86c687937af6\",\n \"verified_bank\": \"sed\",\n \"verified_dnb\": \"occaecat aute\"\n },\n \"my_inbox_id\": \"Duis\",\n \"their_inbox_id\": \"a\",\n \"their_inbox\": {\n \"company\": {\n \"name\": \"ad pariatur\",\n \"address\": \"dolore id\",\n \"postal_code\": \"eu\",\n \"city\": \"Lorem ullamco\",\n \"branch\": \"mollit in ipsum pariatur\",\n \"address2\": \"consectetur ad\",\n \"country\": \"DO\",\n \"country_name\": \"ex\",\n \"website\": \"laboris labore\",\n \"vat_number\": \"adipisicing cupidatat ullamco sit\",\n \"logo\": \"http://OhnLOsuKMMsgPDWbg.eaxJAErqxW2hUR9ikN0CkQ\",\n \"logo_name\": \"non\",\n \"created\": \"1997-04-08T07:57:45.039Z\",\n \"id\": \"4f12e38b-0532-de09-5e14-08738557dbda\",\n \"verified_bank\": \"culpa magna ullamco nisi cillum\",\n \"verified_dnb\": \"irure dolor\"\n },\n \"name\": \"laboris tempor\",\n \"ethereum_address\": \"0x425070A934ED190A15fdeBCA36edF0Ea8Fe481F9\"\n },\n \"message\": \"et eu deserunt laboris\",\n \"note\": \"dolore aliquip\",\n \"invitation_code\": \"proident non do\",\n \"status\": \"accepted\",\n \"created\": \"1988-07-06T20:53:38.131Z\",\n \"created_by_id\": \"elit esse laboris in\",\n \"created_by\": {\n \"email\": \"e1qaeCZwvD0fOz@RkNyN.oibh\",\n \"telephone\": \"velit ut et incididunt laborum\",\n \"name\": \"sed tempor Ut ad\",\n \"first_name\": \"occaecat ut dolore\",\n \"last_name\": \"nulla esse incid\",\n \"company_id\": \"est\",\n \"company\": {\n \"name\": \"deserunt aliqua adipisicing magna commodo\",\n \"address\": \"ad\",\n \"postal_code\": \"reprehenderit Lorem elit\",\n \"city\": \"tempor consectetur ut\",\n \"branch\": \"incididunt\",\n \"address2\": \"nulla dolor pariatur\",\n \"country\": \"PF\",\n \"country_name\": \"voluptate\",\n \"website\": \"consectetur cillum\",\n \"vat_number\": \"do mollit amet eiusmod\",\n \"logo\": \"http://BrpkcNxlbcqaijqgVamSLkZ.bgopvZ3-K5QL7BHD6CLoC3BpNzlpuVwrTm0CF3SV\",\n \"logo_name\": \"eu pariatur\",\n \"created\": \"1973-12-27T00:07:55.441Z\",\n \"id\": \"urn:uuid:e095db6d-79dc-7c28-af28-6e4e34825b3d\",\n \"verified_bank\": \"nisi\",\n \"verified_dnb\": \"labore est deserunt veniam\"\n },\n \"logo\": \"http://Y.qoY+m6u8C0E\",\n \"logo_name\": \"commodo eu minim fugiat\",\n \"id\": \"d50b7796-168b-3941-c9f6-3caa90c7459f\"\n },\n \"resolved\": \"1978-09-14T10:22:49.851Z\",\n \"resolved_by_id\": \"enim ad\",\n \"resolved_by\": {\n \"email\": \"OchlOHMO5@ILgychgOqlizKCmfDAXura.wodc\",\n \"telephone\": \"id aliqua\",\n \"name\": \"ex aliquip ea sit\",\n \"first_name\": \"est\",\n \"last_name\": \"est sit exercitation\",\n \"company_id\": \"incididunt\",\n \"company\": {\n \"name\": \"labore\",\n \"address\": \"dolor ut cupidatat non nostru\",\n \"postal_code\": \"dolore commodo nulla\",\n \"city\": \"velit veniam\",\n \"branch\": \"quis reprehenderit esse\",\n \"address2\": \"veniam sit\",\n \"country\": \"LT\",\n \"country_name\": \"consectetur nisi\",\n \"website\": \"exercitation amet tempor\",\n \"vat_number\": \"reprehenderit elit nulla\",\n \"logo\": \"http://uhGMBZDiIeDHzC.oeezv32eNhxPwBI5cDq3..V4+tGPqcV5bNX2DsBVyxU5bUjqvIWr\",\n \"logo_name\": \"aliqua officia pariatur nulla\",\n \"created\": \"1945-05-07T13:44:10.465Z\",\n \"id\": \"urn:uuid:f3088fcc-e87f-df11-b2a7-06546d7eaa44\",\n \"verified_bank\": \"ut pariatur\",\n \"verified_dnb\": \"fugiat tempor dolor veniam\"\n },\n \"logo\": \"http://RnTYyCercdzWSlqikCEdoTz.xfm+PNfIVLi6pw\",\n \"logo_name\": \"et\",\n \"id\": \"urn:uuid:fe6be31a-93d2-27e1-f61c-2e28a7a6e254\"\n },\n \"resolved_by_company_id\": \"aliqua consequat ut\",\n \"resolved_by_company\": {\n \"name\": \"ut nulla\",\n \"address\": \"incididunt\",\n \"postal_code\": \"sint et sunt\",\n \"city\": \"laborum\",\n \"branch\": \"esse enim qui proident\",\n \"address2\": \"Excepteur nisi mollit\",\n \"country\": \"PH\",\n \"country_name\": \"do ex\",\n \"website\": \"qui adipisicing sunt\",\n \"vat_number\": \"aliquip enim nulla eiusmod\",\n \"logo\": \"https://KoNTCcHmsMrTGrChxxuYhZJngDLwGo.mqlCx+BIL9wBB+Zp+ioT,KQ9ZwY1ftCRLMzngDiq5YvGVOSDQyWzghhK7Oc.5W.XTRU2QHE\",\n \"logo_name\": \"Lorem ullamco ex consequat cupidatat\",\n \"created\": \"2020-07-01T16:57:52.188Z\",\n \"id\": \"389dafae-53dd-0bed-8e5b-a780d4df4db1\",\n \"verified_bank\": \"nostrud\",\n \"verified_dnb\": \"tempor non deserunt nisi do\"\n },\n \"contact_person\": {\n \"email\": \"GW6cW17t@rP.cd\",\n \"telephone\": \"nulla veniam est consequat et\",\n \"name\": \"ea cillum\",\n \"first_name\": \"tempor qui\",\n \"last_name\": \"aliquip amet\",\n \"company_id\": \"consequat officia aliquip fugiat\",\n \"company\": {\n \"name\": \"labore magna officia nulla amet\",\n \"address\": \"Duis dolore veniam est\",\n \"postal_code\": \"enim id\",\n \"city\": \"culpa amet ad et\",\n \"branch\": \"quis Lorem\",\n \"address2\": \"voluptate quis sunt elit\",\n \"country\": \"BS\",\n \"country_name\": \"aliquip aliqua quis qui mollit\",\n \"website\": \"laborum in nulla\",\n \"vat_number\": \"commodo a\",\n \"logo\": \"https://AHGXHDMGYVvOAwlejBNVLTvFHmqIJKG.izVYWUiZauiKlBb\",\n \"logo_name\": \"commodo nostrud sunt ea cillum\",\n \"created\": \"2007-11-05T07:17:28.301Z\",\n \"id\": \"d45a6f64-70e2-4f2a-3835-2696e5a42bf8\",\n \"verified_bank\": \"do proident irure\",\n \"verified_dnb\": \"qui\"\n },\n \"logo\": \"https://DpWoWJmarJZAsvAcMSgnhZ.tuk4352feDYABJYY.xKniMvt.kZ-.ncVi4TncaIyGBSLeiwp3mYqRfGOVy-rJEreKWqB9J+FqqpktHd1s\",\n \"logo_name\": \"Ut do deserunt\",\n \"id\": \"urn:uuid:34f614f0-366c-7a04-742c-4f6a04caafa5\"\n },\n \"id\": \"34c10045-1da5-89c9-424a-3fc501718725\"\n}" }, { "name": "Returned when user does not have permission to create a new contact.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "contacts", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company is not found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "contacts", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "List contacts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/list/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "contacts", "list", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "Lists all contacts of companies that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"d3EfNCJ7Zaz8Xg@KiOVqxXlaixxrxEnQyq.jeu\",\n \"company_id\": \"pariatur ex ut dolore\",\n \"company\": {\n \"name\": \"aute sint non commodo\",\n \"address\": \"nisi\",\n \"postal_code\": \"laborum et ipsum\",\n \"city\": \"cillum Duis\",\n \"branch\": \"magna culpa Lorem\",\n \"address2\": \"tempor nostrud\",\n \"country\": \"CH\",\n \"country_name\": \"veniam occaecat dolore cillum\",\n \"website\": \"in incididunt cupidatat dolor esse\",\n \"vat_number\": \"minim dolor\",\n \"logo\": \"https://sjPZoTJKhTqd.ocacuIbwf0xdyTwbqSpHkiZyesYJMzPowWCMoCn4UbEXX\",\n \"logo_name\": \"minim\",\n \"created\": \"1992-11-24T00:04:43.475Z\",\n \"id\": \"urn:uuid:812edadc-0df5-db53-5db3-86c687937af6\",\n \"verified_bank\": \"sed\",\n \"verified_dnb\": \"occaecat aute\"\n },\n \"my_inbox_id\": \"Duis\",\n \"their_inbox_id\": \"a\",\n \"their_inbox\": {\n \"company\": {\n \"name\": \"ad pariatur\",\n \"address\": \"dolore id\",\n \"postal_code\": \"eu\",\n \"city\": \"Lorem ullamco\",\n \"branch\": \"mollit in ipsum pariatur\",\n \"address2\": \"consectetur ad\",\n \"country\": \"DO\",\n \"country_name\": \"ex\",\n \"website\": \"laboris labore\",\n \"vat_number\": \"adipisicing cupidatat ullamco sit\",\n \"logo\": \"http://OhnLOsuKMMsgPDWbg.eaxJAErqxW2hUR9ikN0CkQ\",\n \"logo_name\": \"non\",\n \"created\": \"1997-04-08T07:57:45.039Z\",\n \"id\": \"4f12e38b-0532-de09-5e14-08738557dbda\",\n \"verified_bank\": \"culpa magna ullamco nisi cillum\",\n \"verified_dnb\": \"irure dolor\"\n },\n \"name\": \"laboris tempor\",\n \"ethereum_address\": \"0x425070A934ED190A15fdeBCA36edF0Ea8Fe481F9\"\n },\n \"message\": \"et eu deserunt laboris\",\n \"note\": \"dolore aliquip\",\n \"invitation_code\": \"proident non do\",\n \"status\": \"accepted\",\n \"created\": \"1988-07-06T20:53:38.131Z\",\n \"created_by_id\": \"elit esse laboris in\",\n \"created_by\": {\n \"email\": \"e1qaeCZwvD0fOz@RkNyN.oibh\",\n \"telephone\": \"velit ut et incididunt laborum\",\n \"name\": \"sed tempor Ut ad\",\n \"first_name\": \"occaecat ut dolore\",\n \"last_name\": \"nulla esse incid\",\n \"company_id\": \"est\",\n \"company\": {\n \"name\": \"deserunt aliqua adipisicing magna commodo\",\n \"address\": \"ad\",\n \"postal_code\": \"reprehenderit Lorem elit\",\n \"city\": \"tempor consectetur ut\",\n \"branch\": \"incididunt\",\n \"address2\": \"nulla dolor pariatur\",\n \"country\": \"PF\",\n \"country_name\": \"voluptate\",\n \"website\": \"consectetur cillum\",\n \"vat_number\": \"do mollit amet eiusmod\",\n \"logo\": \"http://BrpkcNxlbcqaijqgVamSLkZ.bgopvZ3-K5QL7BHD6CLoC3BpNzlpuVwrTm0CF3SV\",\n \"logo_name\": \"eu pariatur\",\n \"created\": \"1973-12-27T00:07:55.441Z\",\n \"id\": \"urn:uuid:e095db6d-79dc-7c28-af28-6e4e34825b3d\",\n \"verified_bank\": \"nisi\",\n \"verified_dnb\": \"labore est deserunt veniam\"\n },\n \"logo\": \"http://Y.qoY+m6u8C0E\",\n \"logo_name\": \"commodo eu minim fugiat\",\n \"id\": \"d50b7796-168b-3941-c9f6-3caa90c7459f\"\n },\n \"resolved\": \"1978-09-14T10:22:49.851Z\",\n \"resolved_by_id\": \"enim ad\",\n \"resolved_by\": {\n \"email\": \"OchlOHMO5@ILgychgOqlizKCmfDAXura.wodc\",\n \"telephone\": \"id aliqua\",\n \"name\": \"ex aliquip ea sit\",\n \"first_name\": \"est\",\n \"last_name\": \"est sit exercitation\",\n \"company_id\": \"incididunt\",\n \"company\": {\n \"name\": \"labore\",\n \"address\": \"dolor ut cupidatat non nostru\",\n \"postal_code\": \"dolore commodo nulla\",\n \"city\": \"velit veniam\",\n \"branch\": \"quis reprehenderit esse\",\n \"address2\": \"veniam sit\",\n \"country\": \"LT\",\n \"country_name\": \"consectetur nisi\",\n \"website\": \"exercitation amet tempor\",\n \"vat_number\": \"reprehenderit elit nulla\",\n \"logo\": \"http://uhGMBZDiIeDHzC.oeezv32eNhxPwBI5cDq3..V4+tGPqcV5bNX2DsBVyxU5bUjqvIWr\",\n \"logo_name\": \"aliqua officia pariatur nulla\",\n \"created\": \"1945-05-07T13:44:10.465Z\",\n \"id\": \"urn:uuid:f3088fcc-e87f-df11-b2a7-06546d7eaa44\",\n \"verified_bank\": \"ut pariatur\",\n \"verified_dnb\": \"fugiat tempor dolor veniam\"\n },\n \"logo\": \"http://RnTYyCercdzWSlqikCEdoTz.xfm+PNfIVLi6pw\",\n \"logo_name\": \"et\",\n \"id\": \"urn:uuid:fe6be31a-93d2-27e1-f61c-2e28a7a6e254\"\n },\n \"resolved_by_company_id\": \"aliqua consequat ut\",\n \"resolved_by_company\": {\n \"name\": \"ut nulla\",\n \"address\": \"incididunt\",\n \"postal_code\": \"sint et sunt\",\n \"city\": \"laborum\",\n \"branch\": \"esse enim qui proident\",\n \"address2\": \"Excepteur nisi mollit\",\n \"country\": \"PH\",\n \"country_name\": \"do ex\",\n \"website\": \"qui adipisicing sunt\",\n \"vat_number\": \"aliquip enim nulla eiusmod\",\n \"logo\": \"https://KoNTCcHmsMrTGrChxxuYhZJngDLwGo.mqlCx+BIL9wBB+Zp+ioT,KQ9ZwY1ftCRLMzngDiq5YvGVOSDQyWzghhK7Oc.5W.XTRU2QHE\",\n \"logo_name\": \"Lorem ullamco ex consequat cupidatat\",\n \"created\": \"2020-07-01T16:57:52.188Z\",\n \"id\": \"389dafae-53dd-0bed-8e5b-a780d4df4db1\",\n \"verified_bank\": \"nostrud\",\n \"verified_dnb\": \"tempor non deserunt nisi do\"\n },\n \"contact_person\": {\n \"email\": \"GW6cW17t@rP.cd\",\n \"telephone\": \"nulla veniam est consequat et\",\n \"name\": \"ea cillum\",\n \"first_name\": \"tempor qui\",\n \"last_name\": \"aliquip amet\",\n \"company_id\": \"consequat officia aliquip fugiat\",\n \"company\": {\n \"name\": \"labore magna officia nulla amet\",\n \"address\": \"Duis dolore veniam est\",\n \"postal_code\": \"enim id\",\n \"city\": \"culpa amet ad et\",\n \"branch\": \"quis Lorem\",\n \"address2\": \"voluptate quis sunt elit\",\n \"country\": \"BS\",\n \"country_name\": \"aliquip aliqua quis qui mollit\",\n \"website\": \"laborum in nulla\",\n \"vat_number\": \"commodo a\",\n \"logo\": \"https://AHGXHDMGYVvOAwlejBNVLTvFHmqIJKG.izVYWUiZauiKlBb\",\n \"logo_name\": \"commodo nostrud sunt ea cillum\",\n \"created\": \"2007-11-05T07:17:28.301Z\",\n \"id\": \"d45a6f64-70e2-4f2a-3835-2696e5a42bf8\",\n \"verified_bank\": \"do proident irure\",\n \"verified_dnb\": \"qui\"\n },\n \"logo\": \"https://DpWoWJmarJZAsvAcMSgnhZ.tuk4352feDYABJYY.xKniMvt.kZ-.ncVi4TncaIyGBSLeiwp3mYqRfGOVy-rJEreKWqB9J+FqqpktHd1s\",\n \"logo_name\": \"Ut do deserunt\",\n \"id\": \"urn:uuid:34f614f0-366c-7a04-742c-4f6a04caafa5\"\n },\n \"id\": \"34c10045-1da5-89c9-424a-3fc501718725\"\n}" }, { "name": "Returned when company is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Re-establish connection", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"BEB@kT.rz\",\n \"company\": {\n \"name\": \"ad nisi\",\n \"address\": \"ipsum\",\n \"postal_code\": \"est\",\n \"city\": \"ex minim\",\n \"branch\": \"deserunt nisi ut\",\n \"address2\": \"qui enim occaecat\",\n \"country\": \"BY\",\n \"country_name\": \"magna qui sed Lorem eiusmod\",\n \"website\": \"minim in dolor enim\",\n \"vat_number\": \"pariatur\",\n \"logo\": \"http://B.xgfiJePEKQXiQSaJnP8wrYc-PIfr+WIFDx3mHJYm5aLRWpEwSqQqLKz0+4YCNtP\",\n \"logo_name\": \"qui su\",\n \"created\": \"1976-04-19T20:44:45.009Z\",\n \"id\": \"54a62722-8d8e-4df5-8efc-59920fcba3b5\",\n \"verified_bank\": \"in ea\",\n \"verified_dnb\": \"ipsum\"\n },\n \"their_inbox\": {\n \"company\": {\n \"name\": \"sunt et reprehenderit ad\",\n \"address\": \"et ut Duis\",\n \"postal_code\": \"culpa deserunt\",\n \"city\": \"in ex veniam\",\n \"branch\": \"esse quis\",\n \"address2\": \"quis Duis\",\n \"country\": \"SR\",\n \"country_name\": \"ut minim\",\n \"website\": \"con\",\n \"vat_number\": \"Lorem eu ex velit\",\n \"logo\": \"https://mCwuDDLPlXTAIxKAg.ngfrlfF04,e5OpO2SVh+SlPdvayhE1cKT4vslXmedmqThEK8YrAEM6fDHC+phtNsCI.1ySMG-lKSSl\",\n \"logo_name\": \"in ma\",\n \"created\": \"1990-09-30T15:19:00.103Z\",\n \"id\": \"urn:uuid:38c36a5f-ad22-b600-5e33-58dcc4098c37\",\n \"verified_bank\": \"si\",\n \"verified_dnb\": \"consectetur fugiat aliquip\"\n },\n \"name\": \"eiusmod in proident\",\n \"ethereum_address\": \"0x8cC0eAA4b8dfdAA6BeCE21aFdEFB6AF306CF62BB\"\n },\n \"message\": \"sed ullamco\",\n \"note\": \"incididunt ut id reprehenderit\",\n \"invitation_code\": \"magna non cillum exercitation\",\n \"status\": \"accepted-via-another-user\",\n \"created\": \"1942-02-09T00:37:52.710Z\",\n \"created_by\": {\n \"email\": \"AU2@mtCbdctaVtSrTqnYrwWJqFLgR.ce\",\n \"telephone\": \"Ut aute\",\n \"name\": \"deserunt dol\",\n \"first_name\": \"sed eu esse\",\n \"last_name\": \"Excepteur ullamco\",\n \"company_id\": \"et pariatur dolore est sint\",\n \"company\": {\n \"name\": \"dolor\",\n \"address\": \"ullamco eiusmod ut\",\n \"postal_code\": \"do cillum minim dolor voluptate\",\n \"city\": \"cillum deserunt quis voluptate\",\n \"branch\": \"consequat dolor proident dolore irure\",\n \"address2\": \"Excepteur consectetur adipisicing in\",\n \"country\": \"PT\",\n \"country_name\": \"cupidatat sunt non labore\",\n \"website\": \"Lorem veniam do\",\n \"vat_number\": \"ex sint\",\n \"logo\": \"http://OYUXncsAGjRYi.lhkrWNYCjPk,.oGZ-Q7lww3hTw05\",\n \"logo_name\": \"Excepteur anim exercitation\",\n \"created\": \"2011-07-21T17:06:35.638Z\",\n \"id\": \"a95c33f7-8ddd-0e4b-6b2b-090525f3941d\",\n \"verified_bank\": \"comm\",\n \"verified_dnb\": \"laborum ut\"\n },\n \"logo\": \"https://dyBEeZcgAa.cjJPeMLnPUhLSzQpxep\",\n \"logo_name\": \"fugiat nisi ut laborum sint\",\n \"id\": \"f8b6b79f-8473-4276-3248-10911b33c2e0\"\n },\n \"resolved\": \"1970-06-26T17:30:38.903Z\",\n \"resolved_by\": {\n \"email\": \"T7K2QqsuaFYQ@mpOWrZiuBJBYo.uavx\",\n \"telephone\": \"consectetur eiusmod\",\n \"name\": \"ea\",\n \"first_name\": \"aliqua\",\n \"last_name\": \"ipsum\",\n \"company_id\": \"culpa\",\n \"company\": {\n \"name\": \"ad laborum mollit anim id\",\n \"address\": \"quis proident reprehenderit aute labo\",\n \"postal_code\": \"eiusmod magna ex elit\",\n \"city\": \"laboris irure\",\n \"branch\": \"anim Excepteur nostrud ex\",\n \"address2\": \"dolor consequat elit minim\",\n \"country\": \"BW\",\n \"country_name\": \"dolor Excepteur reprehenderit\",\n \"website\": \"Ut elit proident sit\",\n \"vat_number\": \"mollit incididunt\",\n \"logo\": \"https://rcjpWcMQZvVzFjPMZZrGL.mpnf60.3v3wCNAYV+LcfR6iDN\",\n \"logo_name\": \"anim\",\n \"created\": \"1968-06-05T15:19:32.595Z\",\n \"id\": \"940c987d-f48c-4e4a-2f5c-14d49bf3c1a3\",\n \"verified_bank\": \"in magna id eu\",\n \"verified_dnb\": \"eu tempor in elit\"\n },\n \"logo\": \"http://WYMylXjvqNAfS.kqopYtw2fzn-tZhIKC8JxJQIkcJ7q\",\n \"logo_name\": \"eu cillum voluptate Duis ipsum\",\n \"id\": \"8e078752-4284-3bb4-f6f9-7b8e4b376935\"\n },\n \"resolved_by_company\": {\n \"name\": \"sunt irure\",\n \"address\": \"proident voluptate\",\n \"postal_code\": \"enim eiusmod deserunt cupidatat\",\n \"city\": \"ex ut amet\",\n \"branch\": \"quis anim sint deserunt\",\n \"address2\": \"eiusmod dolore sint\",\n \"country\": \"CC\",\n \"country_name\": \"est veniam cupidatat\",\n \"website\": \"consequat in quis ex\",\n \"vat_number\": \"sunt ea\",\n \"logo\": \"https://dpfhhDTWQbSHTRKoyZ.zaviMw8koC0etsBeECE9fOOGjtbsiTL8oGDZLstKj26\",\n \"logo_name\": \"commodo velit\",\n \"created\": \"1957-04-24T11:49:56.620Z\",\n \"id\": \"ccdff91a-8586-5f55-7a73-e24679dd59b2\",\n \"verified_bank\": \"aliquip deserunt ex nisi\",\n \"verified_dnb\": \"Duis ea laborum pariatur reprehenderit\"\n },\n \"contact_person\": {\n \"email\": \"FH9mMYYWYwWZ8E@CIpLDnfdpxwQwRvdFgiTbQvB.sakf\",\n \"telephone\": \"ut velit do\",\n \"name\": \"velit pariatur voluptate\",\n \"first_name\": \"Excepteur sunt\",\n \"last_name\": \"deserunt laboris\",\n \"company_id\": \"minim\",\n \"company\": {\n \"name\": \"eu tempor elit\",\n \"address\": \"pariatur velit consectetur Excepteur\",\n \"postal_code\": \"nulla\",\n \"city\": \"ex ut nostrud\",\n \"branch\": \"sunt\",\n \"address2\": \"voluptate consectetur esse\",\n \"country\": \"AF\",\n \"country_name\": \"reprehenderit in\",\n \"website\": \"nisi sed labore Duis\",\n \"vat_number\": \"reprehenderit elit\",\n \"logo\": \"https://l.ghFLfZb-Oh1kvTe6flSmedkN-5K\",\n \"logo_name\": \"dolor sunt ut\",\n \"created\": \"1964-09-29T04:35:09.383Z\",\n \"id\": \"urn:uuid:ae6c7931-a2c3-4dfa-5843-2e32bf5768cb\",\n \"verified_bank\": \"culpa eu magna\",\n \"verified_dnb\": \"est esse ipsum in in\"\n },\n \"logo\": \"https://LcYRkVoXvalZnMRfzPnTKcDjy.pulzN1LUVqzWxX0VMn5U7Oo\",\n \"logo_name\": \"consequat reprehenderit aute laborum\",\n \"id\": \"90269cda-8fdc-bd7d-225c-21775d10d1ec\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/contacts/reestablish/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", "reestablish", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "This endpoint re-establishes a deleted connection between two companies.\nThis request is possible only if a reverse connection already exists.\n" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/reestablish/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", "reestablish", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"d3EfNCJ7Zaz8Xg@KiOVqxXlaixxrxEnQyq.jeu\",\n \"company_id\": \"pariatur ex ut dolore\",\n \"company\": {\n \"name\": \"aute sint non commodo\",\n \"address\": \"nisi\",\n \"postal_code\": \"laborum et ipsum\",\n \"city\": \"cillum Duis\",\n \"branch\": \"magna culpa Lorem\",\n \"address2\": \"tempor nostrud\",\n \"country\": \"CH\",\n \"country_name\": \"veniam occaecat dolore cillum\",\n \"website\": \"in incididunt cupidatat dolor esse\",\n \"vat_number\": \"minim dolor\",\n \"logo\": \"https://sjPZoTJKhTqd.ocacuIbwf0xdyTwbqSpHkiZyesYJMzPowWCMoCn4UbEXX\",\n \"logo_name\": \"minim\",\n \"created\": \"1992-11-24T00:04:43.475Z\",\n \"id\": \"urn:uuid:812edadc-0df5-db53-5db3-86c687937af6\",\n \"verified_bank\": \"sed\",\n \"verified_dnb\": \"occaecat aute\"\n },\n \"my_inbox_id\": \"Duis\",\n \"their_inbox_id\": \"a\",\n \"their_inbox\": {\n \"company\": {\n \"name\": \"ad pariatur\",\n \"address\": \"dolore id\",\n \"postal_code\": \"eu\",\n \"city\": \"Lorem ullamco\",\n \"branch\": \"mollit in ipsum pariatur\",\n \"address2\": \"consectetur ad\",\n \"country\": \"DO\",\n \"country_name\": \"ex\",\n \"website\": \"laboris labore\",\n \"vat_number\": \"adipisicing cupidatat ullamco sit\",\n \"logo\": \"http://OhnLOsuKMMsgPDWbg.eaxJAErqxW2hUR9ikN0CkQ\",\n \"logo_name\": \"non\",\n \"created\": \"1997-04-08T07:57:45.039Z\",\n \"id\": \"4f12e38b-0532-de09-5e14-08738557dbda\",\n \"verified_bank\": \"culpa magna ullamco nisi cillum\",\n \"verified_dnb\": \"irure dolor\"\n },\n \"name\": \"laboris tempor\",\n \"ethereum_address\": \"0x425070A934ED190A15fdeBCA36edF0Ea8Fe481F9\"\n },\n \"message\": \"et eu deserunt laboris\",\n \"note\": \"dolore aliquip\",\n \"invitation_code\": \"proident non do\",\n \"status\": \"accepted\",\n \"created\": \"1988-07-06T20:53:38.131Z\",\n \"created_by_id\": \"elit esse laboris in\",\n \"created_by\": {\n \"email\": \"e1qaeCZwvD0fOz@RkNyN.oibh\",\n \"telephone\": \"velit ut et incididunt laborum\",\n \"name\": \"sed tempor Ut ad\",\n \"first_name\": \"occaecat ut dolore\",\n \"last_name\": \"nulla esse incid\",\n \"company_id\": \"est\",\n \"company\": {\n \"name\": \"deserunt aliqua adipisicing magna commodo\",\n \"address\": \"ad\",\n \"postal_code\": \"reprehenderit Lorem elit\",\n \"city\": \"tempor consectetur ut\",\n \"branch\": \"incididunt\",\n \"address2\": \"nulla dolor pariatur\",\n \"country\": \"PF\",\n \"country_name\": \"voluptate\",\n \"website\": \"consectetur cillum\",\n \"vat_number\": \"do mollit amet eiusmod\",\n \"logo\": \"http://BrpkcNxlbcqaijqgVamSLkZ.bgopvZ3-K5QL7BHD6CLoC3BpNzlpuVwrTm0CF3SV\",\n \"logo_name\": \"eu pariatur\",\n \"created\": \"1973-12-27T00:07:55.441Z\",\n \"id\": \"urn:uuid:e095db6d-79dc-7c28-af28-6e4e34825b3d\",\n \"verified_bank\": \"nisi\",\n \"verified_dnb\": \"labore est deserunt veniam\"\n },\n \"logo\": \"http://Y.qoY+m6u8C0E\",\n \"logo_name\": \"commodo eu minim fugiat\",\n \"id\": \"d50b7796-168b-3941-c9f6-3caa90c7459f\"\n },\n \"resolved\": \"1978-09-14T10:22:49.851Z\",\n \"resolved_by_id\": \"enim ad\",\n \"resolved_by\": {\n \"email\": \"OchlOHMO5@ILgychgOqlizKCmfDAXura.wodc\",\n \"telephone\": \"id aliqua\",\n \"name\": \"ex aliquip ea sit\",\n \"first_name\": \"est\",\n \"last_name\": \"est sit exercitation\",\n \"company_id\": \"incididunt\",\n \"company\": {\n \"name\": \"labore\",\n \"address\": \"dolor ut cupidatat non nostru\",\n \"postal_code\": \"dolore commodo nulla\",\n \"city\": \"velit veniam\",\n \"branch\": \"quis reprehenderit esse\",\n \"address2\": \"veniam sit\",\n \"country\": \"LT\",\n \"country_name\": \"consectetur nisi\",\n \"website\": \"exercitation amet tempor\",\n \"vat_number\": \"reprehenderit elit nulla\",\n \"logo\": \"http://uhGMBZDiIeDHzC.oeezv32eNhxPwBI5cDq3..V4+tGPqcV5bNX2DsBVyxU5bUjqvIWr\",\n \"logo_name\": \"aliqua officia pariatur nulla\",\n \"created\": \"1945-05-07T13:44:10.465Z\",\n \"id\": \"urn:uuid:f3088fcc-e87f-df11-b2a7-06546d7eaa44\",\n \"verified_bank\": \"ut pariatur\",\n \"verified_dnb\": \"fugiat tempor dolor veniam\"\n },\n \"logo\": \"http://RnTYyCercdzWSlqikCEdoTz.xfm+PNfIVLi6pw\",\n \"logo_name\": \"et\",\n \"id\": \"urn:uuid:fe6be31a-93d2-27e1-f61c-2e28a7a6e254\"\n },\n \"resolved_by_company_id\": \"aliqua consequat ut\",\n \"resolved_by_company\": {\n \"name\": \"ut nulla\",\n \"address\": \"incididunt\",\n \"postal_code\": \"sint et sunt\",\n \"city\": \"laborum\",\n \"branch\": \"esse enim qui proident\",\n \"address2\": \"Excepteur nisi mollit\",\n \"country\": \"PH\",\n \"country_name\": \"do ex\",\n \"website\": \"qui adipisicing sunt\",\n \"vat_number\": \"aliquip enim nulla eiusmod\",\n \"logo\": \"https://KoNTCcHmsMrTGrChxxuYhZJngDLwGo.mqlCx+BIL9wBB+Zp+ioT,KQ9ZwY1ftCRLMzngDiq5YvGVOSDQyWzghhK7Oc.5W.XTRU2QHE\",\n \"logo_name\": \"Lorem ullamco ex consequat cupidatat\",\n \"created\": \"2020-07-01T16:57:52.188Z\",\n \"id\": \"389dafae-53dd-0bed-8e5b-a780d4df4db1\",\n \"verified_bank\": \"nostrud\",\n \"verified_dnb\": \"tempor non deserunt nisi do\"\n },\n \"contact_person\": {\n \"email\": \"GW6cW17t@rP.cd\",\n \"telephone\": \"nulla veniam est consequat et\",\n \"name\": \"ea cillum\",\n \"first_name\": \"tempor qui\",\n \"last_name\": \"aliquip amet\",\n \"company_id\": \"consequat officia aliquip fugiat\",\n \"company\": {\n \"name\": \"labore magna officia nulla amet\",\n \"address\": \"Duis dolore veniam est\",\n \"postal_code\": \"enim id\",\n \"city\": \"culpa amet ad et\",\n \"branch\": \"quis Lorem\",\n \"address2\": \"voluptate quis sunt elit\",\n \"country\": \"BS\",\n \"country_name\": \"aliquip aliqua quis qui mollit\",\n \"website\": \"laborum in nulla\",\n \"vat_number\": \"commodo a\",\n \"logo\": \"https://AHGXHDMGYVvOAwlejBNVLTvFHmqIJKG.izVYWUiZauiKlBb\",\n \"logo_name\": \"commodo nostrud sunt ea cillum\",\n \"created\": \"2007-11-05T07:17:28.301Z\",\n \"id\": \"d45a6f64-70e2-4f2a-3835-2696e5a42bf8\",\n \"verified_bank\": \"do proident irure\",\n \"verified_dnb\": \"qui\"\n },\n \"logo\": \"https://DpWoWJmarJZAsvAcMSgnhZ.tuk4352feDYABJYY.xKniMvt.kZ-.ncVi4TncaIyGBSLeiwp3mYqRfGOVy-rJEreKWqB9J+FqqpktHd1s\",\n \"logo_name\": \"Ut do deserunt\",\n \"id\": \"urn:uuid:34f614f0-366c-7a04-742c-4f6a04caafa5\"\n },\n \"id\": \"34c10045-1da5-89c9-424a-3fc501718725\"\n}" }, { "name": "Returned when the authenticated user is not a 3rd-party company.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/contacts/reestablish/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "contacts", "reestablish", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "credits", "item": [ { "name": "Get credits balance", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/credits/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "credits", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "\nReturns the current balance of credits for a particular company. Pending credits are credits that have been issued but haven't yet registered on the blockchain.\n" }, "response": [ { "name": "The amount of credits a particular company has.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/credits/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "credits", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"credits\": 47091196,\n \"pending_credits\": -28353746,\n \"reserved_credits\": 35207335,\n \"promotional_credits\": 56018231\n}" } ] }, { "name": "Issue credits", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"credits\": 26588660,\n \"request_id\": \"irure consequat\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/credits/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "credits", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "\nThis endpoint is used by 3rd-parties to top-up the credit balance of companies.\n\nTopping up credits is subject to limitations. Please contact support if you encounter that you hit the limit often.\n" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"credits\": 26588660,\n \"request_id\": \"irure consequat\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/credits/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "credits", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"credits\": 47091196,\n \"pending_credits\": -28353746,\n \"reserved_credits\": 35207335,\n \"promotional_credits\": 56018231\n}" }, { "name": "Returned if company not found or client has no access to this company", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"credits\": 26588660,\n \"request_id\": \"irure consequat\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/credits/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "credits", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when the `request_id` is not unique for this client. This prevents duplicate requests from topping up credits twice.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"credits\": 26588660,\n \"request_id\": \"irure consequat\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/credits/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "credits", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when number of credits requested is too high.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"credits\": 26588660,\n \"request_id\": \"irure consequat\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/credits/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "credits", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Bandwidth Limit Exceeded (Apache bw/limited extension)", "code": 509, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "inboxes", "item": [ { "name": "{inbox}", "item": [ { "name": "envelopes", "item": [ { "name": "{envelope}", "item": [ { "name": "attachments", "item": [ { "name": "{attachment}", "item": [ { "name": "document-tokens/{documenttoken}", "item": [ { "name": "documents/{document}", "item": [ { "name": "Retrieve attachment document", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/document-tokens/:documenttoken/documents/:document/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "document-tokens", ":documenttoken", "documents", ":document", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" }, { "key": "document", "value": "cons", "description": "(Required) \nThe attachment document identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine document by its ID. Replace `{id}` with internal document id. |\n" }, { "key": "documenttoken", "value": "cons", "description": "(Required) " } ] }, "description": "Retrieves the document of the attachment that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/document-tokens/:documenttoken/documents/:document/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "document-tokens", ":documenttoken", "documents", ":document", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" }, { "key": "document", "value": "cons", "description": "(Required) \nThe attachment document identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine document by its ID. Replace `{id}` with internal document id. |\n" }, { "key": "documenttoken", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Update attachment document", "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/document-tokens/:documenttoken/documents/:document/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "document-tokens", ":documenttoken", "documents", ":document", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" }, { "key": "document", "value": "cons", "description": "(Required) \nThe attachment document identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine document by its ID. Replace `{id}` with internal document id. |\n" }, { "key": "documenttoken", "value": "cons", "description": "(Required) " } ] }, "description": "Updates the document of the attachment. Only the data that needs to be changed is required." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/document-tokens/:documenttoken/documents/:document/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "document-tokens", ":documenttoken", "documents", ":document", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" }, { "key": "document", "value": "cons", "description": "(Required) \nThe attachment document identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine document by its ID. Replace `{id}` with internal document id. |\n" }, { "key": "documenttoken", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Partially update attachment document", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/document-tokens/:documenttoken/documents/:document/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "document-tokens", ":documenttoken", "documents", ":document", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" }, { "key": "document", "value": "cons", "description": "(Required) \nThe attachment document identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine document by its ID. Replace `{id}` with internal document id. |\n" }, { "key": "documenttoken", "value": "cons", "description": "(Required) " } ] }, "description": "Partially updates the document of the attachment. Only the data that needs to be changed is required." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/document-tokens/:documenttoken/documents/:document/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "document-tokens", ":documenttoken", "documents", ":document", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" }, { "key": "document", "value": "cons", "description": "(Required) \nThe attachment document identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine document by its ID. Replace `{id}` with internal document id. |\n" }, { "key": "documenttoken", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve attachment document token", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/document-tokens/:documenttoken/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "document-tokens", ":documenttoken", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" }, { "key": "document-token", "value": "cons", "description": "(Required) \nThe attachment document token identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine document token by its ID. Replace `{id}` with internal document token id. |\n" }, { "key": "documenttoken", "value": "cons", "description": "(Required) " } ] }, "description": "Retrieves the document token of the attachment that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/document-tokens/:documenttoken/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "document-tokens", ":documenttoken", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" }, { "key": "document-token", "value": "cons", "description": "(Required) \nThe attachment document token identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine document token by its ID. Replace `{id}` with internal document token id. |\n" }, { "key": "documenttoken", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:a27e0859-8b94-5b53-b005-5810562a96b9\",\n \"storage_type\": \"exercitation anim sint est\",\n \"watermark_generated\": true,\n \"ipfs_document_group_id\": \"voluptate id fugiat consequat\",\n \"ipfs_document_group\": \"urn:uuid:9326723f-04b4-523a-fb75-279e73dbb6f5\",\n \"document_id\": \"ex reprehenderit deserunt dolor\",\n \"document\": {\n \"document_type\": \"nulla\",\n \"create_on_blockchain_override\": false,\n \"id\": \"4bc3b32a-1030-5ac2-f307-6c6446c2106c\",\n \"current_owner_id\": \"ea aliquip adipisicing nostrud\",\n \"current_owner\": {\n \"company\": {\n \"name\": \"aliqua\",\n \"address\": \"Lorem qui exercitation minim\",\n \"postal_code\": \"nisi aliqua ea\",\n \"city\": \"consectetur dolor in anim in\",\n \"branch\": \"ut dolore in\",\n \"address2\": \"sunt deserunt\",\n \"country\": \"GB\",\n \"country_name\": \"commodo\",\n \"website\": \"irure\",\n \"vat_number\": \"Excepteur incididunt in exercitation\",\n \"logo\": \"http://arkfuKboIhEJT.fovGWWIa7AKDXHqu3Gt-6vjw1tcGmyPKME3M83d5BeDNWemPjg9\",\n \"logo_name\": \"sed id aliquip exercitation\",\n \"created\": \"1991-02-10T06:34:52.983Z\",\n \"id\": \"urn:uuid:ae1a4ea4-3262-64b6-6d74-de8842ad81ae\",\n \"verified_bank\": \"aliquip fugiat consectetur\",\n \"verified_dnb\": \"voluptate consequat ad in\"\n },\n \"name\": \"elit ullamco i\",\n \"ethereum_address\": \"0xbABcA14a2cbc5efEEfCa397d150738eACCD0d0dB\"\n },\n \"uploaded_by_id\": \"no\",\n \"uploaded_by\": {\n \"email\": \"Fc5L6SnE7TADup@KJqectLaTQQDPvtOwNqBxvtsHdgSypL.vza\",\n \"telephone\": \"ad anim aute\",\n \"name\": \"sint ut esse\",\n \"first_name\": \"est\",\n \"last_name\": \"cupidatat non\",\n \"company_id\": \"proident do amet minim mollit\",\n \"company\": {\n \"name\": \"deserunt quis in consectetur nulla\",\n \"address\": \"aliquip\",\n \"postal_code\": \"Lorem ut\",\n \"city\": \"non\",\n \"branch\": \"minim dolore eu\",\n \"address2\": \"officia elit\",\n \"country\": \"OM\",\n \"country_name\": \"in ut\",\n \"website\": \"ut pr\",\n \"vat_number\": \"aliquip mollit\",\n \"logo\": \"https://wSRLOLJyXqLhXdbs.hrauHRtMefF\",\n \"logo_name\": \"sunt laboris\",\n \"created\": \"1942-12-31T02:10:41.603Z\",\n \"id\": \"527a802e-6a42-4a5c-164e-b4f19a743166\",\n \"verified_bank\": \"tempor deserunt\",\n \"verified_dnb\": \"sunt tempor aute Excepteur Ut\"\n },\n \"logo\": \"https://RdnQhFXBpMnLMhEvUbg.pzaGoWrCtZURIEtvOHPx3T9CF8YrtgkEADpXrbZ9unScjGFNNkG5aczAqKNS\",\n \"logo_name\": \"sed reprehenderit irure\",\n \"id\": \"938ffa04-fa13-77ae-0134-53fbd8fa6e74\"\n },\n \"uploaded_by_company_id\": \"nulla dolor\",\n \"uploaded_by_company\": {\n \"name\": \"fugiat quis\",\n \"address\": \"est esse adipisicing dolor\",\n \"postal_code\": \"magna\",\n \"city\": \"ut veniam dolor non\",\n \"branch\": \"in ad minim\",\n \"address2\": \"non exercitation deserunt ea\",\n \"country\": \"KG\",\n \"country_name\": \"ad culp\",\n \"website\": \"et nisi voluptate irure\",\n \"vat_number\": \"sint veniam labore\",\n \"logo\": \"https://brhZaJrdFcDXqolq.qmByWjHY2.Afxtypf42KKVSvSXR8H34QMQpX.TeJTj.P\",\n \"logo_name\": \"anim ea\",\n \"created\": \"1967-11-06T01:58:21.244Z\",\n \"id\": \"urn:uuid:b733f753-2332-453c-2960-43e2cbfaf4cc\",\n \"verified_bank\": \"consequat adipisicing velit\",\n \"verified_dnb\": \"eu non aliquip\"\n },\n \"type\": {\n \"id\": \"voluptate sed et elit incidid\",\n \"name\": \"enim do\",\n \"short_name\": \"cup\",\n \"color\": 63441156,\n \"is_smart_bl\": false,\n \"blockchain_support\": \"laboris enim dolore ut\",\n \"create_on_blockchain\": true,\n \"transfer_on_blockchain\": true,\n \"document_id_required\": false,\n \"document_id_title\": \"sit ipsum cupidatat\",\n \"document_id_description\": \"\",\n \"accomplisher_required\": false,\n \"accomplisher_selectable\": false,\n \"accomplisher_title\": \"Duis dolor aliquip veniam\",\n \"accomplisher_description\": \"\",\n \"accomplish_action_string\": \"ad incididunt eiusmod\",\n \"accomplish_review_step_title\": \"\",\n \"accomplish_review_step_text\": \"\",\n \"accomplish_sign_step_title\": \"\",\n \"accomplish_sign_step_text\": \"\",\n \"accomplish_sign_step_button\": \"\",\n \"accomplish_sign_in_progress_title\": \"\",\n \"accomplish_sign_in_progress_content\": \"\",\n \"accomplish_sign_success_message_title\": \"\",\n \"accomplish_sign_success_message_text\": \"\",\n \"accomplish_sign_error_message_title\": \"\",\n \"accomplish_sign_error_message_text\": \"\",\n \"accomplish_notify_email_document_state\": \"\",\n \"accomplish_notify_email_subject_action\": \"\",\n \"issue_price_millicents\": -68963141,\n \"blockchain_transfer_limit\": 90808790,\n \"retention_period\": \"laboris deserunt dolor elit\"\n },\n \"document_id\": \"sint ex Excepteur sed occaecat\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"veniam cillum\",\n \"accomplisher\": {\n \"company\": {\n \"name\": \"dolore sunt ut\",\n \"address\": \"amet mollit adipisicing laborum sunt\",\n \"postal_code\": \"ut dolor\",\n \"city\": \"in eiusmod aute nostrud\",\n \"branch\": \"quis dolore\",\n \"address2\": \"anim velit\",\n \"country\": \"NZ\",\n \"country_name\": \"est in ullamco\",\n \"website\": \"est\",\n \"vat_number\": \"pariatur nulla\",\n \"logo\": \"https://wwAvQ.avkapWcMdlS17ehcdOUlY.sUTsfo0iaTDlQ7WwhJj6,EzzluAiPegU5DnhOJi1mb.s+\",\n \"logo_name\": \"ullamco Duis non nulla\",\n \"created\": \"1979-04-12T08:43:28.543Z\",\n \"id\": \"urn:uuid:29d02e36-6289-6eae-6f49-4f0f88604874\",\n \"verified_bank\": \"enim \",\n \"verified_dnb\": \"ut nostrud deserunt\"\n },\n \"name\": \"dolor consequat\",\n \"ethereum_address\": \"0x534db0945E3ebF36F65DAAACeBf262B7DeaCab7d\"\n },\n \"accomplished\": \"1996-10-04T00:18:12.208Z\",\n \"accomplished_by_id\": \"\",\n \"accomplished_by_company_id\": \"exercitation Excepteur ut\",\n \"destroyed\": \"1994-09-02T23:34:44.318Z\",\n \"destroyed_by_company_id\": \"cupidatat dolor Ut Excepteur\",\n \"notify_parties\": [\n \"mhElA77rGvO@RwdttlrTOi.xq\",\n \"U1y-PTMB6C0J-w@VYVhTZOHWDQmtcLWKQbLulpwsNo.cx\"\n ],\n \"meta_data\": {},\n \"display_name\": \"officia commodo eu\",\n \"file_name\": \"tempor eiusmod\",\n \"file_size\": -1126759506,\n \"file_content_type\": \"cillum adipisicing officia laborum proident\",\n \"watermarkable\": true,\n \"icon\": \"tempor ipsum\",\n \"file_type\": \"non\",\n \"created\": \"adipisicing do eu consequat\",\n \"thumbnail\": \"http://SxbRAQk.azkM7zj+Qw+5weeyYf5UmdULcc\",\n \"thumbnail_mime_type\": \"enim proident aute dolore\"\n },\n \"attachment_count\": 91791065,\n \"is_on_blockchain\": true,\n \"can_be_destroyed\": \"reprehender\",\n \"can_be_accomplished\": \"dolore quis laboris\",\n \"destroy_pending\": \"sunt \",\n \"accomplish_pending\": \"voluptate et ad dolor\",\n \"created\": \"ut officia Duis\"\n}" } ] }, { "name": "Document token access", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ipfs_document_group\": \"urn:uuid:c7a483a0-645f-cf60-eefd-f82f6aed8ddb\",\n \"document\": {\n \"document_type\": \"sit voluptate Lorem\",\n \"create_on_blockchain_override\": false,\n \"id\": \"81a62aec-6054-e58b-86b8-9296aa6ca506\",\n \"current_owner_id\": \"dolor\",\n \"current_owner\": {\n \"company\": {\n \"name\": \"amet dolore\",\n \"address\": \"aute ad\",\n \"postal_code\": \"qui pariatur\",\n \"city\": \"eiusmod sunt consequat deserunt aliquip\",\n \"branch\": \"eiusmod pariatur elit tempor\",\n \"address2\": \"in incididunt\",\n \"country\": \"TZ\",\n \"country_name\": \"eu\",\n \"website\": \"cupidatat id dolore\",\n \"vat_number\": \"tempor dolor\",\n \"logo\": \"http://agUUSpwKCMFqphDuDxaInPxQs.tvdpMinn3qTb-6llk7zCACYcTENQ-LKNfx9n7faNLii.RTy\",\n \"logo_name\": \"ut non adipisicing laboris consequat\",\n \"created\": \"1993-02-09T21:57:42.606Z\",\n \"id\": \"urn:uuid:ff296c91-8e51-e5ad-ec28-29e0deb710f2\",\n \"verified_bank\": \"et fugiat\",\n \"verified_dnb\": \"fugiat sed do irure\"\n },\n \"name\": \"sint proident Lorem minim\",\n \"ethereum_address\": \"0xe617705f7f9b3EFF0e59308D6bbd7685eA5b01fe\"\n },\n \"uploaded_by_id\": \"Ut aute\",\n \"uploaded_by\": {\n \"email\": \"sMGDLRe@DvxyGywzgGFxRlWdyULomXOkoXnlyak.mflg\",\n \"telephone\": \"culpa\",\n \"name\": \"eu consectet\",\n \"first_name\": \"Excepteur cupidatat labore veniam\",\n \"last_name\": \"voluptat\",\n \"company_id\": \"laboris eu\",\n \"company\": {\n \"name\": \"fugiat minim tempor\",\n \"address\": \"voluptate reprehenderit nostrud dolore\",\n \"postal_code\": \"elit reprehenderit\",\n \"city\": \"aliqua occaecat consectetur in\",\n \"branch\": \"consectetur in\",\n \"address2\": \"dolore\",\n \"country\": \"ML\",\n \"country_name\": \"ad nostrud\",\n \"website\": \"in velit ut consequat laboris\",\n \"vat_number\": \"incididunt ut in\",\n \"logo\": \"http://EcURsJe.jcqg8hZ,vDHExu9SyJcGDO73XXh+CPMgRRFOtx9btP4O3,THt9d6KztskxwM+VGZ\",\n \"logo_name\": \"et enim dolor Ut\",\n \"created\": \"1996-09-18T10:43:26.991Z\",\n \"id\": \"urn:uuid:d13fa2d4-b659-06b5-a4a0-613f7ff5eed3\",\n \"verified_bank\": \"eiusmod nostrud\",\n \"verified_dnb\": \"do \"\n },\n \"logo\": \"http://tezGauO.iuwo0uiDvWuQoAvZOHZk60mMvJviw\",\n \"logo_name\": \"qui ut Except\",\n \"id\": \"urn:uuid:00325c48-0874-3c15-ead4-f6c5cdc4bd8d\"\n },\n \"uploaded_by_company_id\": \"sit sint laborum elit Excepteur\",\n \"uploaded_by_company\": {\n \"name\": \"ad eiusmod\",\n \"address\": \"adipisicing dolor\",\n \"postal_code\": \"tempor minim\",\n \"city\": \"magna\",\n \"branch\": \"aliqua ut nostrud\",\n \"address2\": \"in incididunt aute sit labore\",\n \"country\": \"RO\",\n \"country_name\": \"sed in \",\n \"website\": \"occaecat aliqua quis\",\n \"vat_number\": \"pariatur fugiat reprehenderit Lorem sed\",\n \"logo\": \"http://yehQ.eqr6Jj0gADYCIXSzi60pKt+NJ\",\n \"logo_name\": \"occaecat pariatur\",\n \"created\": \"2018-03-03T12:35:10.071Z\",\n \"id\": \"urn:uuid:a7e91185-2994-4087-d986-d9219a689c10\",\n \"verified_bank\": \"proident ut fugiat dolore ea\",\n \"verified_dnb\": \"dolore Excepteur la\"\n },\n \"type\": {\n \"id\": \"fugiat aliqua in eiusmod\",\n \"name\": \"laboris amet dolore elit ut\",\n \"short_name\": \"Duis mollit eu\",\n \"color\": -68892346,\n \"is_smart_bl\": false,\n \"blockchain_support\": \"dolore enim nisi culpa\",\n \"create_on_blockchain\": false,\n \"transfer_on_blockchain\": true,\n \"document_id_required\": false,\n \"document_id_title\": \"proident non officia in\",\n \"document_id_description\": \"\",\n \"accomplisher_required\": false,\n \"accomplisher_selectable\": false,\n \"accomplisher_title\": \"cillum culpa proident occaecat\",\n \"accomplisher_description\": \"\",\n \"accomplish_action_string\": \"dolor ullamco minim consectetur est\",\n \"accomplish_review_step_title\": \"\",\n \"accomplish_review_step_text\": \"\",\n \"accomplish_sign_step_title\": \"\",\n \"accomplish_sign_step_text\": \"\",\n \"accomplish_sign_step_button\": \"\",\n \"accomplish_sign_in_progress_title\": \"\",\n \"accomplish_sign_in_progress_content\": \"\",\n \"accomplish_sign_success_message_title\": \"\",\n \"accomplish_sign_success_message_text\": \"\",\n \"accomplish_sign_error_message_title\": \"\",\n \"accomplish_sign_error_message_text\": \"\",\n \"accomplish_notify_email_document_state\": \"\",\n \"accomplish_notify_email_subject_action\": \"\",\n \"issue_price_millicents\": 75824353,\n \"blockchain_transfer_limit\": -23025135,\n \"retention_period\": \"occaecat veniam mol\"\n },\n \"document_id\": \"laboris elit adipisicing\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"ad cupidatat labore\",\n \"accomplisher\": {\n \"company\": {\n \"name\": \"Duis incididunt\",\n \"address\": \"qui sunt in cillum officia\",\n \"postal_code\": \"in ut\",\n \"city\": \"sint \",\n \"branch\": \"pariatur eiusmod officia ex\",\n \"address2\": \"incididunt quis ea\",\n \"country\": \"NC\",\n \"country_name\": \"adipisicing ut reprehenderit exercitation\",\n \"website\": \"esse Excepteur laboris incididunt sit\",\n \"vat_number\": \"deserunt laborum\",\n \"logo\": \"https://xQdwQ.lmeYqq.A85W40Le,tPlyhzmNEyELekcfmjCnSFIbPk48j6crVELMdC7zw6DDrF\",\n \"logo_name\": \"dolor quis tempor\",\n \"created\": \"2009-04-13T01:19:18.797Z\",\n \"id\": \"urn:uuid:afe2e737-5a3e-e671-8476-679b04d5f0ae\",\n \"verified_bank\": \"eiusmod dolore id dolore in\",\n \"verified_dnb\": \"in esse\"\n },\n \"name\": \"Duis irure ex\",\n \"ethereum_address\": \"0xcFb3146fFEA2DbFbc267Cca8Ec7a0Bb0d57ec97b\"\n },\n \"accomplished\": \"1998-03-20T07:32:18.805Z\",\n \"accomplished_by_id\": \"in in\",\n \"accomplished_by_company_id\": \"dolore sunt\",\n \"destroyed\": \"1955-11-03T17:23:40.454Z\",\n \"destroyed_by_company_id\": \"labore\",\n \"notify_parties\": [\n \"VxrdQyiandeFI@qlSAlYHIcTvcqfQquRxVmb.kaz\",\n \"RsCT7KNzhK@dUFBXdRtzzxxOmZKBupHyYAGu.esbd\"\n ],\n \"meta_data\": {},\n \"display_name\": \"qui voluptate\",\n \"file_name\": \"irure reprehenderit laborum\",\n \"file_size\": -213108562,\n \"file_content_type\": \"sit Duis magna esse\",\n \"watermarkable\": false,\n \"icon\": \"nostrud culpa labore\",\n \"file_type\": \"Ut mollit culpa\",\n \"created\": \"sint aliqua\",\n \"thumbnail\": \"http://sPyJztzBtaZRoNkapTIsUFWyyUQGd.kpvloi,lxXDg,MnJqnqKu9fLJ4G,Ogu5Eivh8lEgZaXQM,VbcGahifx-KKl94lrSz7OKhrmS\",\n \"thumbnail_mime_type\": \"id\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/document-tokens/:documenttoken/access/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "document-tokens", ":documenttoken", "access", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" }, { "key": "document-token", "value": "cons", "description": "(Required) \nThe attachment document token identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine document token by its ID. Replace `{id}` with internal document token id. |\n" }, { "key": "documenttoken", "value": "cons", "description": "(Required) " } ] }, "description": "\nThis endpoint tracks access to a document token.\n" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ipfs_document_group\": \"urn:uuid:c7a483a0-645f-cf60-eefd-f82f6aed8ddb\",\n \"document\": {\n \"document_type\": \"sit voluptate Lorem\",\n \"create_on_blockchain_override\": false,\n \"id\": \"81a62aec-6054-e58b-86b8-9296aa6ca506\",\n \"current_owner_id\": \"dolor\",\n \"current_owner\": {\n \"company\": {\n \"name\": \"amet dolore\",\n \"address\": \"aute ad\",\n \"postal_code\": \"qui pariatur\",\n \"city\": \"eiusmod sunt consequat deserunt aliquip\",\n \"branch\": \"eiusmod pariatur elit tempor\",\n \"address2\": \"in incididunt\",\n \"country\": \"TZ\",\n \"country_name\": \"eu\",\n \"website\": \"cupidatat id dolore\",\n \"vat_number\": \"tempor dolor\",\n \"logo\": \"http://agUUSpwKCMFqphDuDxaInPxQs.tvdpMinn3qTb-6llk7zCACYcTENQ-LKNfx9n7faNLii.RTy\",\n \"logo_name\": \"ut non adipisicing laboris consequat\",\n \"created\": \"1993-02-09T21:57:42.606Z\",\n \"id\": \"urn:uuid:ff296c91-8e51-e5ad-ec28-29e0deb710f2\",\n \"verified_bank\": \"et fugiat\",\n \"verified_dnb\": \"fugiat sed do irure\"\n },\n \"name\": \"sint proident Lorem minim\",\n \"ethereum_address\": \"0xe617705f7f9b3EFF0e59308D6bbd7685eA5b01fe\"\n },\n \"uploaded_by_id\": \"Ut aute\",\n \"uploaded_by\": {\n \"email\": \"sMGDLRe@DvxyGywzgGFxRlWdyULomXOkoXnlyak.mflg\",\n \"telephone\": \"culpa\",\n \"name\": \"eu consectet\",\n \"first_name\": \"Excepteur cupidatat labore veniam\",\n \"last_name\": \"voluptat\",\n \"company_id\": \"laboris eu\",\n \"company\": {\n \"name\": \"fugiat minim tempor\",\n \"address\": \"voluptate reprehenderit nostrud dolore\",\n \"postal_code\": \"elit reprehenderit\",\n \"city\": \"aliqua occaecat consectetur in\",\n \"branch\": \"consectetur in\",\n \"address2\": \"dolore\",\n \"country\": \"ML\",\n \"country_name\": \"ad nostrud\",\n \"website\": \"in velit ut consequat laboris\",\n \"vat_number\": \"incididunt ut in\",\n \"logo\": \"http://EcURsJe.jcqg8hZ,vDHExu9SyJcGDO73XXh+CPMgRRFOtx9btP4O3,THt9d6KztskxwM+VGZ\",\n \"logo_name\": \"et enim dolor Ut\",\n \"created\": \"1996-09-18T10:43:26.991Z\",\n \"id\": \"urn:uuid:d13fa2d4-b659-06b5-a4a0-613f7ff5eed3\",\n \"verified_bank\": \"eiusmod nostrud\",\n \"verified_dnb\": \"do \"\n },\n \"logo\": \"http://tezGauO.iuwo0uiDvWuQoAvZOHZk60mMvJviw\",\n \"logo_name\": \"qui ut Except\",\n \"id\": \"urn:uuid:00325c48-0874-3c15-ead4-f6c5cdc4bd8d\"\n },\n \"uploaded_by_company_id\": \"sit sint laborum elit Excepteur\",\n \"uploaded_by_company\": {\n \"name\": \"ad eiusmod\",\n \"address\": \"adipisicing dolor\",\n \"postal_code\": \"tempor minim\",\n \"city\": \"magna\",\n \"branch\": \"aliqua ut nostrud\",\n \"address2\": \"in incididunt aute sit labore\",\n \"country\": \"RO\",\n \"country_name\": \"sed in \",\n \"website\": \"occaecat aliqua quis\",\n \"vat_number\": \"pariatur fugiat reprehenderit Lorem sed\",\n \"logo\": \"http://yehQ.eqr6Jj0gADYCIXSzi60pKt+NJ\",\n \"logo_name\": \"occaecat pariatur\",\n \"created\": \"2018-03-03T12:35:10.071Z\",\n \"id\": \"urn:uuid:a7e91185-2994-4087-d986-d9219a689c10\",\n \"verified_bank\": \"proident ut fugiat dolore ea\",\n \"verified_dnb\": \"dolore Excepteur la\"\n },\n \"type\": {\n \"id\": \"fugiat aliqua in eiusmod\",\n \"name\": \"laboris amet dolore elit ut\",\n \"short_name\": \"Duis mollit eu\",\n \"color\": -68892346,\n \"is_smart_bl\": false,\n \"blockchain_support\": \"dolore enim nisi culpa\",\n \"create_on_blockchain\": false,\n \"transfer_on_blockchain\": true,\n \"document_id_required\": false,\n \"document_id_title\": \"proident non officia in\",\n \"document_id_description\": \"\",\n \"accomplisher_required\": false,\n \"accomplisher_selectable\": false,\n \"accomplisher_title\": \"cillum culpa proident occaecat\",\n \"accomplisher_description\": \"\",\n \"accomplish_action_string\": \"dolor ullamco minim consectetur est\",\n \"accomplish_review_step_title\": \"\",\n \"accomplish_review_step_text\": \"\",\n \"accomplish_sign_step_title\": \"\",\n \"accomplish_sign_step_text\": \"\",\n \"accomplish_sign_step_button\": \"\",\n \"accomplish_sign_in_progress_title\": \"\",\n \"accomplish_sign_in_progress_content\": \"\",\n \"accomplish_sign_success_message_title\": \"\",\n \"accomplish_sign_success_message_text\": \"\",\n \"accomplish_sign_error_message_title\": \"\",\n \"accomplish_sign_error_message_text\": \"\",\n \"accomplish_notify_email_document_state\": \"\",\n \"accomplish_notify_email_subject_action\": \"\",\n \"issue_price_millicents\": 75824353,\n \"blockchain_transfer_limit\": -23025135,\n \"retention_period\": \"occaecat veniam mol\"\n },\n \"document_id\": \"laboris elit adipisicing\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"ad cupidatat labore\",\n \"accomplisher\": {\n \"company\": {\n \"name\": \"Duis incididunt\",\n \"address\": \"qui sunt in cillum officia\",\n \"postal_code\": \"in ut\",\n \"city\": \"sint \",\n \"branch\": \"pariatur eiusmod officia ex\",\n \"address2\": \"incididunt quis ea\",\n \"country\": \"NC\",\n \"country_name\": \"adipisicing ut reprehenderit exercitation\",\n \"website\": \"esse Excepteur laboris incididunt sit\",\n \"vat_number\": \"deserunt laborum\",\n \"logo\": \"https://xQdwQ.lmeYqq.A85W40Le,tPlyhzmNEyELekcfmjCnSFIbPk48j6crVELMdC7zw6DDrF\",\n \"logo_name\": \"dolor quis tempor\",\n \"created\": \"2009-04-13T01:19:18.797Z\",\n \"id\": \"urn:uuid:afe2e737-5a3e-e671-8476-679b04d5f0ae\",\n \"verified_bank\": \"eiusmod dolore id dolore in\",\n \"verified_dnb\": \"in esse\"\n },\n \"name\": \"Duis irure ex\",\n \"ethereum_address\": \"0xcFb3146fFEA2DbFbc267Cca8Ec7a0Bb0d57ec97b\"\n },\n \"accomplished\": \"1998-03-20T07:32:18.805Z\",\n \"accomplished_by_id\": \"in in\",\n \"accomplished_by_company_id\": \"dolore sunt\",\n \"destroyed\": \"1955-11-03T17:23:40.454Z\",\n \"destroyed_by_company_id\": \"labore\",\n \"notify_parties\": [\n \"VxrdQyiandeFI@qlSAlYHIcTvcqfQquRxVmb.kaz\",\n \"RsCT7KNzhK@dUFBXdRtzzxxOmZKBupHyYAGu.esbd\"\n ],\n \"meta_data\": {},\n \"display_name\": \"qui voluptate\",\n \"file_name\": \"irure reprehenderit laborum\",\n \"file_size\": -213108562,\n \"file_content_type\": \"sit Duis magna esse\",\n \"watermarkable\": false,\n \"icon\": \"nostrud culpa labore\",\n \"file_type\": \"Ut mollit culpa\",\n \"created\": \"sint aliqua\",\n \"thumbnail\": \"http://sPyJztzBtaZRoNkapTIsUFWyyUQGd.kpvloi,lxXDg,MnJqnqKu9fLJ4G,Ogu5Eivh8lEgZaXQM,VbcGahifx-KKl94lrSz7OKhrmS\",\n \"thumbnail_mime_type\": \"id\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/document-tokens/:documenttoken/access/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "document-tokens", ":documenttoken", "access", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" }, { "key": "document-token", "value": "cons", "description": "(Required) \nThe attachment document token identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine document token by its ID. Replace `{id}` with internal document token id. |\n" }, { "key": "documenttoken", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:a27e0859-8b94-5b53-b005-5810562a96b9\",\n \"storage_type\": \"exercitation anim sint est\",\n \"watermark_generated\": true,\n \"ipfs_document_group_id\": \"voluptate id fugiat consequat\",\n \"ipfs_document_group\": \"urn:uuid:9326723f-04b4-523a-fb75-279e73dbb6f5\",\n \"document_id\": \"ex reprehenderit deserunt dolor\",\n \"document\": {\n \"document_type\": \"nulla\",\n \"create_on_blockchain_override\": false,\n \"id\": \"4bc3b32a-1030-5ac2-f307-6c6446c2106c\",\n \"current_owner_id\": \"ea aliquip adipisicing nostrud\",\n \"current_owner\": {\n \"company\": {\n \"name\": \"aliqua\",\n \"address\": \"Lorem qui exercitation minim\",\n \"postal_code\": \"nisi aliqua ea\",\n \"city\": \"consectetur dolor in anim in\",\n \"branch\": \"ut dolore in\",\n \"address2\": \"sunt deserunt\",\n \"country\": \"GB\",\n \"country_name\": \"commodo\",\n \"website\": \"irure\",\n \"vat_number\": \"Excepteur incididunt in exercitation\",\n \"logo\": \"http://arkfuKboIhEJT.fovGWWIa7AKDXHqu3Gt-6vjw1tcGmyPKME3M83d5BeDNWemPjg9\",\n \"logo_name\": \"sed id aliquip exercitation\",\n \"created\": \"1991-02-10T06:34:52.983Z\",\n \"id\": \"urn:uuid:ae1a4ea4-3262-64b6-6d74-de8842ad81ae\",\n \"verified_bank\": \"aliquip fugiat consectetur\",\n \"verified_dnb\": \"voluptate consequat ad in\"\n },\n \"name\": \"elit ullamco i\",\n \"ethereum_address\": \"0xbABcA14a2cbc5efEEfCa397d150738eACCD0d0dB\"\n },\n \"uploaded_by_id\": \"no\",\n \"uploaded_by\": {\n \"email\": \"Fc5L6SnE7TADup@KJqectLaTQQDPvtOwNqBxvtsHdgSypL.vza\",\n \"telephone\": \"ad anim aute\",\n \"name\": \"sint ut esse\",\n \"first_name\": \"est\",\n \"last_name\": \"cupidatat non\",\n \"company_id\": \"proident do amet minim mollit\",\n \"company\": {\n \"name\": \"deserunt quis in consectetur nulla\",\n \"address\": \"aliquip\",\n \"postal_code\": \"Lorem ut\",\n \"city\": \"non\",\n \"branch\": \"minim dolore eu\",\n \"address2\": \"officia elit\",\n \"country\": \"OM\",\n \"country_name\": \"in ut\",\n \"website\": \"ut pr\",\n \"vat_number\": \"aliquip mollit\",\n \"logo\": \"https://wSRLOLJyXqLhXdbs.hrauHRtMefF\",\n \"logo_name\": \"sunt laboris\",\n \"created\": \"1942-12-31T02:10:41.603Z\",\n \"id\": \"527a802e-6a42-4a5c-164e-b4f19a743166\",\n \"verified_bank\": \"tempor deserunt\",\n \"verified_dnb\": \"sunt tempor aute Excepteur Ut\"\n },\n \"logo\": \"https://RdnQhFXBpMnLMhEvUbg.pzaGoWrCtZURIEtvOHPx3T9CF8YrtgkEADpXrbZ9unScjGFNNkG5aczAqKNS\",\n \"logo_name\": \"sed reprehenderit irure\",\n \"id\": \"938ffa04-fa13-77ae-0134-53fbd8fa6e74\"\n },\n \"uploaded_by_company_id\": \"nulla dolor\",\n \"uploaded_by_company\": {\n \"name\": \"fugiat quis\",\n \"address\": \"est esse adipisicing dolor\",\n \"postal_code\": \"magna\",\n \"city\": \"ut veniam dolor non\",\n \"branch\": \"in ad minim\",\n \"address2\": \"non exercitation deserunt ea\",\n \"country\": \"KG\",\n \"country_name\": \"ad culp\",\n \"website\": \"et nisi voluptate irure\",\n \"vat_number\": \"sint veniam labore\",\n \"logo\": \"https://brhZaJrdFcDXqolq.qmByWjHY2.Afxtypf42KKVSvSXR8H34QMQpX.TeJTj.P\",\n \"logo_name\": \"anim ea\",\n \"created\": \"1967-11-06T01:58:21.244Z\",\n \"id\": \"urn:uuid:b733f753-2332-453c-2960-43e2cbfaf4cc\",\n \"verified_bank\": \"consequat adipisicing velit\",\n \"verified_dnb\": \"eu non aliquip\"\n },\n \"type\": {\n \"id\": \"voluptate sed et elit incidid\",\n \"name\": \"enim do\",\n \"short_name\": \"cup\",\n \"color\": 63441156,\n \"is_smart_bl\": false,\n \"blockchain_support\": \"laboris enim dolore ut\",\n \"create_on_blockchain\": true,\n \"transfer_on_blockchain\": true,\n \"document_id_required\": false,\n \"document_id_title\": \"sit ipsum cupidatat\",\n \"document_id_description\": \"\",\n \"accomplisher_required\": false,\n \"accomplisher_selectable\": false,\n \"accomplisher_title\": \"Duis dolor aliquip veniam\",\n \"accomplisher_description\": \"\",\n \"accomplish_action_string\": \"ad incididunt eiusmod\",\n \"accomplish_review_step_title\": \"\",\n \"accomplish_review_step_text\": \"\",\n \"accomplish_sign_step_title\": \"\",\n \"accomplish_sign_step_text\": \"\",\n \"accomplish_sign_step_button\": \"\",\n \"accomplish_sign_in_progress_title\": \"\",\n \"accomplish_sign_in_progress_content\": \"\",\n \"accomplish_sign_success_message_title\": \"\",\n \"accomplish_sign_success_message_text\": \"\",\n \"accomplish_sign_error_message_title\": \"\",\n \"accomplish_sign_error_message_text\": \"\",\n \"accomplish_notify_email_document_state\": \"\",\n \"accomplish_notify_email_subject_action\": \"\",\n \"issue_price_millicents\": -68963141,\n \"blockchain_transfer_limit\": 90808790,\n \"retention_period\": \"laboris deserunt dolor elit\"\n },\n \"document_id\": \"sint ex Excepteur sed occaecat\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"veniam cillum\",\n \"accomplisher\": {\n \"company\": {\n \"name\": \"dolore sunt ut\",\n \"address\": \"amet mollit adipisicing laborum sunt\",\n \"postal_code\": \"ut dolor\",\n \"city\": \"in eiusmod aute nostrud\",\n \"branch\": \"quis dolore\",\n \"address2\": \"anim velit\",\n \"country\": \"NZ\",\n \"country_name\": \"est in ullamco\",\n \"website\": \"est\",\n \"vat_number\": \"pariatur nulla\",\n \"logo\": \"https://wwAvQ.avkapWcMdlS17ehcdOUlY.sUTsfo0iaTDlQ7WwhJj6,EzzluAiPegU5DnhOJi1mb.s+\",\n \"logo_name\": \"ullamco Duis non nulla\",\n \"created\": \"1979-04-12T08:43:28.543Z\",\n \"id\": \"urn:uuid:29d02e36-6289-6eae-6f49-4f0f88604874\",\n \"verified_bank\": \"enim \",\n \"verified_dnb\": \"ut nostrud deserunt\"\n },\n \"name\": \"dolor consequat\",\n \"ethereum_address\": \"0x534db0945E3ebF36F65DAAACeBf262B7DeaCab7d\"\n },\n \"accomplished\": \"1996-10-04T00:18:12.208Z\",\n \"accomplished_by_id\": \"\",\n \"accomplished_by_company_id\": \"exercitation Excepteur ut\",\n \"destroyed\": \"1994-09-02T23:34:44.318Z\",\n \"destroyed_by_company_id\": \"cupidatat dolor Ut Excepteur\",\n \"notify_parties\": [\n \"mhElA77rGvO@RwdttlrTOi.xq\",\n \"U1y-PTMB6C0J-w@VYVhTZOHWDQmtcLWKQbLulpwsNo.cx\"\n ],\n \"meta_data\": {},\n \"display_name\": \"officia commodo eu\",\n \"file_name\": \"tempor eiusmod\",\n \"file_size\": -1126759506,\n \"file_content_type\": \"cillum adipisicing officia laborum proident\",\n \"watermarkable\": true,\n \"icon\": \"tempor ipsum\",\n \"file_type\": \"non\",\n \"created\": \"adipisicing do eu consequat\",\n \"thumbnail\": \"http://SxbRAQk.azkM7zj+Qw+5weeyYf5UmdULcc\",\n \"thumbnail_mime_type\": \"enim proident aute dolore\"\n },\n \"attachment_count\": 91791065,\n \"is_on_blockchain\": true,\n \"can_be_destroyed\": \"reprehender\",\n \"can_be_accomplished\": \"dolore quis laboris\",\n \"destroy_pending\": \"sunt \",\n \"accomplish_pending\": \"voluptate et ad dolor\",\n \"created\": \"ut officia Duis\"\n}" }, { "name": "Returned when the authenticated user is not a 3rd-party company.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ipfs_document_group\": \"urn:uuid:c7a483a0-645f-cf60-eefd-f82f6aed8ddb\",\n \"document\": {\n \"document_type\": \"sit voluptate Lorem\",\n \"create_on_blockchain_override\": false,\n \"id\": \"81a62aec-6054-e58b-86b8-9296aa6ca506\",\n \"current_owner_id\": \"dolor\",\n \"current_owner\": {\n \"company\": {\n \"name\": \"amet dolore\",\n \"address\": \"aute ad\",\n \"postal_code\": \"qui pariatur\",\n \"city\": \"eiusmod sunt consequat deserunt aliquip\",\n \"branch\": \"eiusmod pariatur elit tempor\",\n \"address2\": \"in incididunt\",\n \"country\": \"TZ\",\n \"country_name\": \"eu\",\n \"website\": \"cupidatat id dolore\",\n \"vat_number\": \"tempor dolor\",\n \"logo\": \"http://agUUSpwKCMFqphDuDxaInPxQs.tvdpMinn3qTb-6llk7zCACYcTENQ-LKNfx9n7faNLii.RTy\",\n \"logo_name\": \"ut non adipisicing laboris consequat\",\n \"created\": \"1993-02-09T21:57:42.606Z\",\n \"id\": \"urn:uuid:ff296c91-8e51-e5ad-ec28-29e0deb710f2\",\n \"verified_bank\": \"et fugiat\",\n \"verified_dnb\": \"fugiat sed do irure\"\n },\n \"name\": \"sint proident Lorem minim\",\n \"ethereum_address\": \"0xe617705f7f9b3EFF0e59308D6bbd7685eA5b01fe\"\n },\n \"uploaded_by_id\": \"Ut aute\",\n \"uploaded_by\": {\n \"email\": \"sMGDLRe@DvxyGywzgGFxRlWdyULomXOkoXnlyak.mflg\",\n \"telephone\": \"culpa\",\n \"name\": \"eu consectet\",\n \"first_name\": \"Excepteur cupidatat labore veniam\",\n \"last_name\": \"voluptat\",\n \"company_id\": \"laboris eu\",\n \"company\": {\n \"name\": \"fugiat minim tempor\",\n \"address\": \"voluptate reprehenderit nostrud dolore\",\n \"postal_code\": \"elit reprehenderit\",\n \"city\": \"aliqua occaecat consectetur in\",\n \"branch\": \"consectetur in\",\n \"address2\": \"dolore\",\n \"country\": \"ML\",\n \"country_name\": \"ad nostrud\",\n \"website\": \"in velit ut consequat laboris\",\n \"vat_number\": \"incididunt ut in\",\n \"logo\": \"http://EcURsJe.jcqg8hZ,vDHExu9SyJcGDO73XXh+CPMgRRFOtx9btP4O3,THt9d6KztskxwM+VGZ\",\n \"logo_name\": \"et enim dolor Ut\",\n \"created\": \"1996-09-18T10:43:26.991Z\",\n \"id\": \"urn:uuid:d13fa2d4-b659-06b5-a4a0-613f7ff5eed3\",\n \"verified_bank\": \"eiusmod nostrud\",\n \"verified_dnb\": \"do \"\n },\n \"logo\": \"http://tezGauO.iuwo0uiDvWuQoAvZOHZk60mMvJviw\",\n \"logo_name\": \"qui ut Except\",\n \"id\": \"urn:uuid:00325c48-0874-3c15-ead4-f6c5cdc4bd8d\"\n },\n \"uploaded_by_company_id\": \"sit sint laborum elit Excepteur\",\n \"uploaded_by_company\": {\n \"name\": \"ad eiusmod\",\n \"address\": \"adipisicing dolor\",\n \"postal_code\": \"tempor minim\",\n \"city\": \"magna\",\n \"branch\": \"aliqua ut nostrud\",\n \"address2\": \"in incididunt aute sit labore\",\n \"country\": \"RO\",\n \"country_name\": \"sed in \",\n \"website\": \"occaecat aliqua quis\",\n \"vat_number\": \"pariatur fugiat reprehenderit Lorem sed\",\n \"logo\": \"http://yehQ.eqr6Jj0gADYCIXSzi60pKt+NJ\",\n \"logo_name\": \"occaecat pariatur\",\n \"created\": \"2018-03-03T12:35:10.071Z\",\n \"id\": \"urn:uuid:a7e91185-2994-4087-d986-d9219a689c10\",\n \"verified_bank\": \"proident ut fugiat dolore ea\",\n \"verified_dnb\": \"dolore Excepteur la\"\n },\n \"type\": {\n \"id\": \"fugiat aliqua in eiusmod\",\n \"name\": \"laboris amet dolore elit ut\",\n \"short_name\": \"Duis mollit eu\",\n \"color\": -68892346,\n \"is_smart_bl\": false,\n \"blockchain_support\": \"dolore enim nisi culpa\",\n \"create_on_blockchain\": false,\n \"transfer_on_blockchain\": true,\n \"document_id_required\": false,\n \"document_id_title\": \"proident non officia in\",\n \"document_id_description\": \"\",\n \"accomplisher_required\": false,\n \"accomplisher_selectable\": false,\n \"accomplisher_title\": \"cillum culpa proident occaecat\",\n \"accomplisher_description\": \"\",\n \"accomplish_action_string\": \"dolor ullamco minim consectetur est\",\n \"accomplish_review_step_title\": \"\",\n \"accomplish_review_step_text\": \"\",\n \"accomplish_sign_step_title\": \"\",\n \"accomplish_sign_step_text\": \"\",\n \"accomplish_sign_step_button\": \"\",\n \"accomplish_sign_in_progress_title\": \"\",\n \"accomplish_sign_in_progress_content\": \"\",\n \"accomplish_sign_success_message_title\": \"\",\n \"accomplish_sign_success_message_text\": \"\",\n \"accomplish_sign_error_message_title\": \"\",\n \"accomplish_sign_error_message_text\": \"\",\n \"accomplish_notify_email_document_state\": \"\",\n \"accomplish_notify_email_subject_action\": \"\",\n \"issue_price_millicents\": 75824353,\n \"blockchain_transfer_limit\": -23025135,\n \"retention_period\": \"occaecat veniam mol\"\n },\n \"document_id\": \"laboris elit adipisicing\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"ad cupidatat labore\",\n \"accomplisher\": {\n \"company\": {\n \"name\": \"Duis incididunt\",\n \"address\": \"qui sunt in cillum officia\",\n \"postal_code\": \"in ut\",\n \"city\": \"sint \",\n \"branch\": \"pariatur eiusmod officia ex\",\n \"address2\": \"incididunt quis ea\",\n \"country\": \"NC\",\n \"country_name\": \"adipisicing ut reprehenderit exercitation\",\n \"website\": \"esse Excepteur laboris incididunt sit\",\n \"vat_number\": \"deserunt laborum\",\n \"logo\": \"https://xQdwQ.lmeYqq.A85W40Le,tPlyhzmNEyELekcfmjCnSFIbPk48j6crVELMdC7zw6DDrF\",\n \"logo_name\": \"dolor quis tempor\",\n \"created\": \"2009-04-13T01:19:18.797Z\",\n \"id\": \"urn:uuid:afe2e737-5a3e-e671-8476-679b04d5f0ae\",\n \"verified_bank\": \"eiusmod dolore id dolore in\",\n \"verified_dnb\": \"in esse\"\n },\n \"name\": \"Duis irure ex\",\n \"ethereum_address\": \"0xcFb3146fFEA2DbFbc267Cca8Ec7a0Bb0d57ec97b\"\n },\n \"accomplished\": \"1998-03-20T07:32:18.805Z\",\n \"accomplished_by_id\": \"in in\",\n \"accomplished_by_company_id\": \"dolore sunt\",\n \"destroyed\": \"1955-11-03T17:23:40.454Z\",\n \"destroyed_by_company_id\": \"labore\",\n \"notify_parties\": [\n \"VxrdQyiandeFI@qlSAlYHIcTvcqfQquRxVmb.kaz\",\n \"RsCT7KNzhK@dUFBXdRtzzxxOmZKBupHyYAGu.esbd\"\n ],\n \"meta_data\": {},\n \"display_name\": \"qui voluptate\",\n \"file_name\": \"irure reprehenderit laborum\",\n \"file_size\": -213108562,\n \"file_content_type\": \"sit Duis magna esse\",\n \"watermarkable\": false,\n \"icon\": \"nostrud culpa labore\",\n \"file_type\": \"Ut mollit culpa\",\n \"created\": \"sint aliqua\",\n \"thumbnail\": \"http://sPyJztzBtaZRoNkapTIsUFWyyUQGd.kpvloi,lxXDg,MnJqnqKu9fLJ4G,Ogu5Eivh8lEgZaXQM,VbcGahifx-KKl94lrSz7OKhrmS\",\n \"thumbnail_mime_type\": \"id\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/document-tokens/:documenttoken/access/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "document-tokens", ":documenttoken", "access", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" }, { "key": "document-token", "value": "cons", "description": "(Required) \nThe attachment document token identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine document token by its ID. Replace `{id}` with internal document token id. |\n" }, { "key": "documenttoken", "value": "cons", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Document token audit log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/document-tokens/:documenttoken/audit-log/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "document-tokens", ":documenttoken", "audit-log", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" }, { "key": "document-token", "value": "cons", "description": "(Required) \nThe attachment document token identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine document token by its ID. Replace `{id}` with internal document token id. |\n" }, { "key": "documenttoken", "value": "cons", "description": "(Required) " } ] }, "description": "\nThis endpoint fetches audit log history for a given document token.\n" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/document-tokens/:documenttoken/audit-log/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "document-tokens", ":documenttoken", "audit-log", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" }, { "key": "document-token", "value": "cons", "description": "(Required) \nThe attachment document token identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine document token by its ID. Replace `{id}` with internal document token id. |\n" }, { "key": "documenttoken", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"aliqua magna ad Lorem\",\n \"document_id\": \"f064cf98-2afa-0cfa-7aa3-dbfc69ac77e1\",\n \"document\": {\n \"document_type\": \"dolor eiusmod nulla ipsum\",\n \"create_on_blockchain_override\": true,\n \"id\": \"urn:uuid:d081373b-c763-9b40-6d52-6597f99049e1\",\n \"current_owner_id\": \"officia in cupidatat\",\n \"current_owner\": {\n \"company\": {\n \"name\": \"veniam sint est exercitation nisi\",\n \"address\": \"laboris\",\n \"postal_code\": \"qui cupidatat anim ullamco ut\",\n \"city\": \"do sed voluptate\",\n \"branch\": \"sunt reprehe\",\n \"address2\": \"do quis ut\",\n \"country\": \"ZM\",\n \"country_name\": \"incididunt est ad irure in\",\n \"website\": \"aliquip qui in aute\",\n \"vat_number\": \"nulla minim\",\n \"logo\": \"http://vhXqamRbw.ncHTA68ApldJ9X91.9VcdwooEIj+jO-UD0jXzDVb7bGuk.6E4jFZoO+vxFZeV.u,b+G2kIKZzpZ\",\n \"logo_name\": \"aute\",\n \"created\": \"1967-06-22T14:55:41.911Z\",\n \"id\": \"urn:uuid:5428b523-e7a8-8f4d-f567-231547e7d38f\",\n \"verified_bank\": \"do\",\n \"verified_dnb\": \"sed sunt\"\n },\n \"name\": \"laborum aliquip cupidatat\",\n \"ethereum_address\": \"0xB014F7dd3be1E44Bfdab8D3FfEdbF4a7C63BE40F\"\n },\n \"uploaded_by_id\": \"labore\",\n \"uploaded_by\": {\n \"email\": \"hlY5l@gcTWXGyWQIrPP.nzl\",\n \"telephone\": \"non sit amet sunt fugiat\",\n \"name\": \"qui culpa elit amet\",\n \"first_name\": \"do esse sint Lorem\",\n \"last_name\": \"qui\",\n \"company_id\": \"dolor ad dolor\",\n \"company\": {\n \"name\": \"enim officia et\",\n \"address\": \"magna velit\",\n \"postal_code\": \"tempor sunt aute\",\n \"city\": \"non minim offi\",\n \"branch\": \"enim aliqua non\",\n \"address2\": \"irure\",\n \"country\": \"TF\",\n \"country_name\": \"qui anim\",\n \"website\": \"voluptate Lorem culpa\",\n \"vat_number\": \"in laboris dolor\",\n \"logo\": \"https://dHM.ozpczHVQGwIBgaNNhkOwdthg6CrlyFEAqlJ8c6+RADoqFTXtdMlOUUHQA\",\n \"logo_name\": \"sint nostrud Ut Lorem consequat\",\n \"created\": \"2011-12-19T21:51:44.746Z\",\n \"id\": \"urn:uuid:ac5fb204-afb5-0130-52d4-52f2b01b9c62\",\n \"verified_bank\": \"magna ex sint eiusmod\",\n \"verified_dnb\": \"amet \"\n },\n \"logo\": \"https://DBAziLfpfvfwQRTlJIsqqITx.raEe-e5O8Aj7\",\n \"logo_name\": \"dolore \",\n \"id\": \"urn:uuid:ad04ed72-14fb-0fa1-358a-944b8d12b6f0\"\n },\n \"uploaded_by_company_id\": \"cupidatat in est nostrud dolor\",\n \"uploaded_by_company\": {\n \"name\": \"sunt mollit\",\n \"address\": \"in irure\",\n \"postal_code\": \"aute tempor\",\n \"city\": \"aliquip anim Excepteur elit\",\n \"branch\": \"non irure ea tempor\",\n \"address2\": \"ut pariatur tempor eu\",\n \"country\": \"ZM\",\n \"country_name\": \"aliqua sed cupidatat mollit\",\n \"website\": \"aliquip et tempor reprehenderi\",\n \"vat_number\": \"in Lorem nulla et\",\n \"logo\": \"https://OzuZctsRHZCqCLRfqXLwJMni.kzDWUFUCo5OIhcZdFM5d8huWMKw0L9vsyOeCRKVRV3g.p7m2r-sS2JknUsu-\",\n \"logo_name\": \"aute mollit\",\n \"created\": \"1943-06-18T08:03:31.316Z\",\n \"id\": \"d0738567-a706-e174-b1e4-a6d79b8f590b\",\n \"verified_bank\": \"dolore culpa non proident\",\n \"verified_dnb\": \"elit ex occaecat irure esse\"\n },\n \"type\": {\n \"id\": \"cupidatat nostrud sint\",\n \"name\": \"reprehenderi\",\n \"short_name\": \"eiusmod sed\",\n \"color\": -30571843,\n \"is_smart_bl\": true,\n \"blockchain_support\": \"in tempor aliquip\",\n \"create_on_blockchain\": true,\n \"transfer_on_blockchain\": false,\n \"document_id_required\": false,\n \"document_id_title\": \"Excepteur culpa laboris\",\n \"document_id_description\": \"\",\n \"accomplisher_required\": false,\n \"accomplisher_selectable\": false,\n \"accomplisher_title\": \"ut paria\",\n \"accomplisher_description\": \"\",\n \"accomplish_action_string\": \"vol\",\n \"accomplish_review_step_title\": \"\",\n \"accomplish_review_step_text\": \"\",\n \"accomplish_sign_step_title\": \"\",\n \"accomplish_sign_step_text\": \"\",\n \"accomplish_sign_step_button\": \"\",\n \"accomplish_sign_in_progress_title\": \"\",\n \"accomplish_sign_in_progress_content\": \"\",\n \"accomplish_sign_success_message_title\": \"\",\n \"accomplish_sign_success_message_text\": \"\",\n \"accomplish_sign_error_message_title\": \"\",\n \"accomplish_sign_error_message_text\": \"\",\n \"accomplish_notify_email_document_state\": \"\",\n \"accomplish_notify_email_subject_action\": \"\",\n \"issue_price_millicents\": 45652263,\n \"blockchain_transfer_limit\": -22778531,\n \"retention_period\": \"dolor quis\"\n },\n \"document_id\": \"laboris fugiat\",\n \"create_on_blockchain\": false,\n \"accomplisher_id\": \"do\",\n \"accomplisher\": {\n \"company\": {\n \"name\": \"dolor sed voluptate\",\n \"address\": \"dolore ad magna deserunt pariatur\",\n \"postal_code\": \"consectetur sed\",\n \"city\": \"enim do occaecat\",\n \"branch\": \"aliquip cillum adipisicing reprehenderit in\",\n \"address2\": \"do veniam ul\",\n \"country\": \"RS\",\n \"country_name\": \"dolore\",\n \"website\": \"aliquip ullamco\",\n \"vat_number\": \"culpa reprehenderit dolore\",\n \"logo\": \"http://MeMnTHfUotLZiybEOlDyVdp.ccfr,vS2o4qmLUDQTB.3b\",\n \"logo_name\": \"voluptate irure exercitation\",\n \"created\": \"2010-01-14T23:27:49.098Z\",\n \"id\": \"f0dc16f5-8e00-7486-2a79-b2f523519099\",\n \"verified_bank\": \"aute\",\n \"verified_dnb\": \"veniam aute\"\n },\n \"name\": \"aliqua laborum\",\n \"ethereum_address\": \"0xE6AaebcdebbcB89fcAfe110899AB8fbBAA11A8fF\"\n },\n \"accomplished\": \"1978-10-03T22:39:45.621Z\",\n \"accomplished_by_id\": \"aliquip\",\n \"accomplished_by_company_id\": \"ex\",\n \"destroyed\": \"2000-04-03T16:23:11.905Z\",\n \"destroyed_by_company_id\": \"mollit veniam\",\n \"notify_parties\": [\n \"SFI8UGaUcCGiY9@iChEZGxXwRxrIARAF.es\",\n \"3m4@sjvzxWUehRmvTCOrqPfrTztwKPx.iae\"\n ],\n \"meta_data\": {},\n \"display_name\": \"ut irure aliquip\",\n \"file_name\": \"consequat proident\",\n \"file_size\": -1608794180,\n \"file_content_type\": \"in id ea velit deserunt\",\n \"watermarkable\": true,\n \"icon\": \"ve\",\n \"file_type\": \"sint aute culpa\",\n \"created\": \"proident officia\",\n \"thumbnail\": \"https://kCEBbObFlQAxNyROgALu.nsyceqMwDJvpbPIgNZYZl0E,1Ia\",\n \"thumbnail_mime_type\": \"officia ut veniam consequat\"\n },\n \"action\": \"elit laborum quis eu\",\n \"action_performed_by_id\": \"urn:uuid:682e2cd2-d33a-451e-95d7-7c76d2228e88\",\n \"action_performed_by\": {\n \"email\": \"W6QuLDyFNrku@eAXGDlvrrXcfSavveNhY.rxn\",\n \"telephone\": \"Excepteur laborum aliqua ut\",\n \"name\": \"velit in quis dolore\",\n \"first_name\": \"anim do ipsum sit\",\n \"last_name\": \"labore cupidatat\",\n \"company_id\": \"tempor adipisicing consequat\",\n \"company\": {\n \"name\": \"anim nisi magna proident velit\",\n \"address\": \"dolor officia consequat ex\",\n \"postal_code\": \"cillum Lorem elit\",\n \"city\": \"adipisicing veniam\",\n \"branch\": \"deserunt voluptate exercitation\",\n \"address2\": \"nisi minim\",\n \"country\": \"NR\",\n \"country_name\": \"magna deserunt laborum\",\n \"website\": \"proident esse dolor\",\n \"vat_number\": \"do voluptate consequat et\",\n \"logo\": \"http://UmTGJQAlfVJkmSPnif.wefwYfatK9mHEWpn-fp+Z+ClRaDH4.rdFyiW0Kp1uKaPtGWn.URC7bmEx-3QidU1W9kO\",\n \"logo_name\": \"nulla in irure\",\n \"created\": \"1990-09-17T20:12:12.721Z\",\n \"id\": \"urn:uuid:25cf0817-a514-8e73-12e6-2d2ce92e4123\",\n \"verified_bank\": \"occaecat nisi\",\n \"verified_dnb\": \"labore do enim Ut\"\n },\n \"logo\": \"http://YIsqbCiIXcoIHOXrSyQlEFbohV.ysjnYQAlp1GcFBbikOPS.,bu\",\n \"logo_name\": \"officia Lorem Excepteur anim\",\n \"id\": \"4e11b594-ee97-0800-5438-407492056ff5\"\n },\n \"action_performed_by_company_id\": \"urn:uuid:42222a6d-dea9-135d-33d1-3f008fa396cb\",\n \"action_performed_by_company\": {\n \"name\": \"id nostrud irure dolor\",\n \"address\": \"irure nostrud commodo\",\n \"postal_code\": \"anim qui dolor\",\n \"city\": \"veniam deserunt\",\n \"branch\": \"in minim elit cupidatat\",\n \"address2\": \"ex in\",\n \"country\": \"HU\",\n \"country_name\": \"qui ipsum fugiat\",\n \"website\": \"irure dolore adipisicing fugiat anim\",\n \"vat_number\": \"ullamco laboris\",\n \"logo\": \"http://aRymYCnvnJyNcEQIoT.akjzoiFTUzxfWp+grvAy13dOVctgkvL7LMJVx-AM9CDas\",\n \"logo_name\": \"culpa in\",\n \"created\": \"1948-04-20T03:44:38.665Z\",\n \"id\": \"d735c359-e9fb-49dc-147b-8119dcd5f691\",\n \"verified_bank\": \"esse ullamco\",\n \"verified_dnb\": \"dolore eu \"\n },\n \"recipient_id\": \"c0d23273-2778-a8aa-cb4a-c8bf6a8ec732\",\n \"recipient\": {\n \"name\": \"eiusmod dolore quis\",\n \"address\": \"occaecat aliqua\",\n \"postal_code\": \"nostrud Excepteur reprehenderit\",\n \"city\": \"do\",\n \"branch\": \"Duis aliqua\",\n \"address2\": \"nisi quis qui ea\",\n \"country\": \"AF\",\n \"country_name\": \"magna laborum\",\n \"website\": \"mollit reprehenderit qui nisi\",\n \"vat_number\": \"consequat anim dolore in\",\n \"logo\": \"https://ljPcSkeYNwkyVNrfPLAWQ.zstqCiRtv,xbARMDTFkb5i\",\n \"logo_name\": \"velit ipsum exercitation\",\n \"created\": \"1946-04-16T16:51:45.748Z\",\n \"id\": \"urn:uuid:b80db94f-8377-0e91-18a1-4b77ea4a5cfb\",\n \"verified_bank\": \"velit ipsum aliqua\",\n \"verified_dnb\": \"elit\"\n },\n \"timestamp_start\": \"1970-10-06T01:26:48.317Z\",\n \"timestamp_end\": \"1996-07-11T18:21:45.128Z\",\n \"blockchain_record_url\": \"ad consectetur\"\n}" }, { "name": "Returned when the authenticated user is not a 3rd-party company.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/document-tokens/:documenttoken/audit-log/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "document-tokens", ":documenttoken", "audit-log", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" }, { "key": "document-token", "value": "cons", "description": "(Required) \nThe attachment document token identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine document token by its ID. Replace `{id}` with internal document token id. |\n" }, { "key": "documenttoken", "value": "cons", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve attachment", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] }, "description": "Retrieves a single attachment of envelope that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Update attachment", "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] }, "description": "Updates the attachment. Only the data that needs to be changed is required." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Partially update attachment", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] }, "description": "Partially updates the attachment. Only the data that needs to be changed is required." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Delete attachment", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] }, "description": "Deletes a single attachment entry of a user that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "companies inboxes envelopes attachments accomplish hash", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/accomplish-hash/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "accomplish-hash", "" ], "variable": [ { "key": "attachment", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "envelope", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/accomplish-hash/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "accomplish-hash", "" ], "variable": [ { "key": "attachment", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "envelope", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "companies inboxes envelopes attachments accomplish", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/accomplish/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "accomplish", "" ], "variable": [ { "key": "attachment", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "envelope", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/accomplish/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "accomplish", "" ], "variable": [ { "key": "attachment", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "envelope", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "companies inboxes envelopes attachments destroy hash", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/destroy-hash/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "destroy-hash", "" ], "variable": [ { "key": "attachment", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "envelope", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/destroy-hash/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "destroy-hash", "" ], "variable": [ { "key": "attachment", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "envelope", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "companies inboxes envelopes attachments rescind", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/destroy/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "destroy", "" ], "variable": [ { "key": "attachment", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "envelope", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/destroy/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "destroy", "" ], "variable": [ { "key": "attachment", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "envelope", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Get FIATA eFBL draft JSON", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/get-fiata-json/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "get-fiata-json", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] }, "description": "\nThis endpoint fetches JSON that is stored in FIATA eFBL draft.\n" }, "response": [ { "name": "Returned when JSON can be successfully parsed from document.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/get-fiata-json/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "get-fiata-json", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when the authenticated user is not a 3rd-party company.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/get-fiata-json/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "get-fiata-json", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "companies inboxes envelopes attachments get thumbnail", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/get-thumbnail/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "get-thumbnail", "" ], "variable": [ { "key": "attachment", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "envelope", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/get-thumbnail/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "get-thumbnail", "" ], "variable": [ { "key": "attachment", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "envelope", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "companies inboxes envelopes attachments view audit log", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/view-audit-log/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "view-audit-log", "" ], "variable": [ { "key": "attachment", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "envelope", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/view-audit-log/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "view-audit-log", "" ], "variable": [ { "key": "attachment", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "envelope", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "View FIATA eFBL preview file", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/view-fiata-preview-file/?watermark=false", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "view-fiata-preview-file", "" ], "query": [ { "key": "watermark", "value": "false", "description": "\nThis parameter determines if the endpoint will return a watermarked file or not. Watermarked file is returned only if \nthe file is watermarkable (is a PDF or an image). Otherwise the original file is returned. \n" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] }, "description": "\nThis endpoint outputs attachment file contents with the correct content type headers. Its intended purpose is displaying \nor downloading the document in the browser.\n" }, "response": [ { "name": "Returns attachment file contents with the correct content type headers.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/view-fiata-preview-file/?watermark=false", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "view-fiata-preview-file", "" ], "query": [ { "key": "watermark", "value": "false" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when the authenticated user does not have access to this resource.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/view-fiata-preview-file/?watermark=false", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "view-fiata-preview-file", "" ], "query": [ { "key": "watermark", "value": "false" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned if the resource is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/view-fiata-preview-file/?watermark=false", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "view-fiata-preview-file", "" ], "query": [ { "key": "watermark", "value": "false" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "View attachment file", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/view-file/?watermark=false", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "view-file", "" ], "query": [ { "key": "watermark", "value": "false", "description": "\nThis parameter determines if the endpoint will return a watermarked file or not. Watermarked file is returned only if \nthe file is watermarkable (is a PDF or an image). Otherwise the original file is returned. \n" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] }, "description": "\nThis endpoint outputs attachment file contents with the correct content type headers. Its intended purpose is displaying \nor downloading the document in the browser.\n" }, "response": [ { "name": "Returns attachment file contents with the correct content type headers.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/view-file/?watermark=false", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "view-file", "" ], "query": [ { "key": "watermark", "value": "false" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when the authenticated user does not have access to this resource.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/view-file/?watermark=false", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "view-file", "" ], "query": [ { "key": "watermark", "value": "false" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned if the resource is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/view-file/?watermark=false", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "view-file", "" ], "query": [ { "key": "watermark", "value": "false" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "View watermarked attachment file", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/view-watermarked-file/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "view-watermarked-file", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] }, "description": "\nThis endpoint outputs watermarked attachment file contents with the correct content type headers. Its intended purpose is displaying \nor downloading the document in the browser.\n" }, "response": [ { "name": "Returns watermarked attachment file contents with the correct content type headers.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/view-watermarked-file/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "view-watermarked-file", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when the authenticated user does not have access to this resource.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/view-watermarked-file/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "view-watermarked-file", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned if the resource is not found or if the document can't be watermarked.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/:attachment/view-watermarked-file/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", ":attachment", "view-watermarked-file", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "attachment", "value": "cons", "description": "(Required) \nThe attachment identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine attachment by its ID. Replace `{id}` with internal attachment id. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Create attachment", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" } ] }, "description": "Creates a new attachment of envelope that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "List attachments", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" } ] }, "description": "Lists all envelope attachments that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/attachments/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "attachments", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve company bundle", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] }, "description": "Retrieves a single envelope of a company that the logged in 3rd-party system is\n allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:168e861d-d56a-2546-87ab-2a0d91d7b389\",\n \"owner_id\": \"voluptate sunt consequat ad ipsum\",\n \"recipient_id\": \"aliquip dolore laboris eiusmod\",\n \"message\": \"quis pariatur\",\n \"type\": \"irure cupidatat ad minim\",\n \"specialization_type\": \"standard\",\n \"created\": \"sit qui\",\n \"sent\": \"1998-04-24T04:50:20.680Z\",\n \"archived\": \"1987-02-09T04:14:10.914Z\",\n \"delivered\": \"in cupidatat anim\",\n \"action_performed_by_id\": \"labor\",\n \"action_performed_by\": {\n \"email\": \"X83k0beD9PAnv@qKqLUNuUIIBHztMkwOwMlclQ.rcm\",\n \"telephone\": \"est ex\",\n \"name\": \"laboris\",\n \"first_name\": \"sunt culpa\",\n \"last_name\": \"Lorem\",\n \"company_id\": \"fugiat\",\n \"company\": {\n \"name\": \"elit in reprehenderit sit anim\",\n \"address\": \"de\",\n \"postal_code\": \"nostrud exercitation irure commodo\",\n \"city\": \"laboris est nisi\",\n \"branch\": \"elit laboris irure\",\n \"address2\": \"aliqua non velit nulla esse\",\n \"country\": \"AZ\",\n \"country_name\": \"pariatur deserunt non\",\n \"website\": \"sint velit minim Excepteur fugiat\",\n \"vat_number\": \"quis eiusmod dol\",\n \"logo\": \"http://ByyCfnjAboaBQdUInoAesMRucA.sjoSB.E17yYl2Tp7l4uTnwoqAG3mG7vshOL\",\n \"logo_name\": \"cillum ipsum id anim\",\n \"created\": \"2002-04-27T22:22:49.781Z\",\n \"id\": \"urn:uuid:7bf94c3e-3467-6f54-bad1-3cc2262a4737\",\n \"verified_bank\": \"est ea qui\",\n \"verified_dnb\": \"nostrud velit\"\n },\n \"logo\": \"https://YMkDPLGSIYi.sbhqMoWzfcBz8WMKoRrkZJGYGE1icf8+Ev-Yu+sgu,OP4hWPITtI7wy.XShQuRy+jiYfJPwSzYRBS\",\n \"logo_name\": \"pariatur nisi\",\n \"id\": \"1fb0d2d6-5979-b24d-8094-f2a2bdc2e0dd\"\n },\n \"action_performed_by_company_id\": \"ullamco do\",\n \"action_performed_by_company\": {\n \"name\": \"eu qui\",\n \"address\": \"aliqua ipsum\",\n \"postal_code\": \"mollit sint qui sed\",\n \"city\": \"nulla cupidatat aliqua dolore\",\n \"branch\": \"consectetur Ut\",\n \"address2\": \"in ut\",\n \"country\": \"BE\",\n \"country_name\": \"voluptate anim enim nulla\",\n \"website\": \"in\",\n \"vat_number\": \"eiusmod\",\n \"logo\": \"https://r.frOBgvaabcEjDjIAhNjyivSPsHxloEg.\",\n \"logo_name\": \"irure cillum officia est\",\n \"created\": \"1974-05-12T17:22:23.041Z\",\n \"id\": \"f5947ce2-8722-e638-f9d8-83a24bba8b23\",\n \"verified_bank\": \"exercitation aliqua cupi\",\n \"verified_dnb\": \"dolore ad dolore\"\n },\n \"sealed\": false,\n \"can_be_sealed\": \"in irure non elit Lorem\",\n \"is_draft\": \"est nostrud reprehenderit consequ\",\n \"sender_inbox_id\": \"in elit sit fugiat\",\n \"sender\": {\n \"name\": \"adipisicing ad nostrud et\",\n \"address\": \"sit voluptate\",\n \"postal_code\": \"incididunt enim quis Duis ad\",\n \"city\": \"ad c\",\n \"branch\": \"nisi labore officia\",\n \"address2\": \"pariatur\",\n \"country\": \"YT\",\n \"country_name\": \"ullamco\",\n \"website\": \"ut mollit minim consectetur\",\n \"vat_number\": \"ullamco fugiat exercitation commodo non\",\n \"logo\": \"https://DUSPgY.etyp8fmjoiNkY3k.X4g24o.7EXnZnRVsqmENc+CApMlwy1nAQESHo\",\n \"logo_name\": \"ut velit v\",\n \"created\": \"2016-05-05T14:44:36.026Z\",\n \"id\": \"urn:uuid:ff2328b2-f1de-a199-b7d4-00125ce5928e\",\n \"verified_bank\": \"do proident\",\n \"verified_dnb\": \"eu cillum mollit\"\n },\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"irure culpa incididunt consectetur\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": true,\n \"read_by_user\": \"eiusmod tempor velit\",\n \"documents\": [\n \"incididunt irure enim fugiat reprehenderit\",\n \"laborum nisi esse sunt in\"\n ],\n \"existing_attachments\": {},\n \"attachments\": [\n {\n \"document_token_id\": \"quis deserunt esse irure\",\n \"id\": \"f44f76e5-5b80-f6f8-1240-6a229b426586\",\n \"envelope_id\": \"Duis sit\",\n \"document_token\": {\n \"id\": \"urn:uuid:99f6a1da-897e-f593-cbb8-062d8984342d\",\n \"storage_type\": \"veniam id velit\",\n \"watermark_generated\": true,\n \"ipfs_document_group_id\": \"sed dolore nostrud proident\",\n \"ipfs_document_group\": \"urn:uuid:deb979a4-8b4d-d2a1-db98-dbc264b3c53e\",\n \"document_id\": \"ut irure ex ullamco\",\n \"document\": {\n \"document_type\": \"ut magna proident officia\",\n \"create_on_blockchain_override\": false,\n \"id\": \"bfc5c81b-0ec4-dbd7-2019-24524033f0e2\",\n \"current_owner_id\": \"et occaecat deserunt commodo\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"cupidatat tempor ut\",\n \"uploaded_by\": {\n \"email\": \"KF0IU-dtNh-A@ryHdrBOLLQJmBFIFsMNi.wey\",\n \"telephone\": \"et in\",\n \"name\": \"consectetur sint\",\n \"first_name\": \"amet sed cillum nisi\",\n \"last_name\": \"Ut aliquip\",\n \"company_id\": \"\",\n \"company\": {\n \"name\": \"ullamco\",\n \"address\": \"officia\",\n \"postal_code\": \"dolore labore enim adipisicing\",\n \"city\": \"nisi incididunt\",\n \"branch\": \"sint\",\n \"address2\": \"incididunt\",\n \"country\": \"JE\",\n \"country_name\": \"in in\",\n \"website\": \"fugiat irure ut\",\n \"vat_number\": \"nisi quis\",\n \"logo\": \"http://HCCXvuGJCQrwveJnATVZFbvDEBAzTaUZ.ygISt\",\n \"logo_name\": \"qui\",\n \"created\": \"2006-07-08T09:50:01.259Z\",\n \"id\": \"urn:uuid:0e291c97-350a-509d-3f39-3b2bf689a234\",\n \"verified_bank\": \"non\",\n \"verified_dnb\": \"dolore cillum\"\n },\n \"logo\": \"https://xYzuxnBeIiwxAWzVhiU.qnqiTptCa5PeolHQIB3phfRLwnKKLM\",\n \"logo_name\": \"dolor officia dolo\",\n \"id\": \"6de3c248-8a84-2640-cb1c-7651b0ea0fea\"\n },\n \"uploaded_by_company_id\": \"Excepteur\",\n \"uploaded_by_company\": {\n \"name\": \"sit reprehenderit\",\n \"address\": \"pariatur irure commodo cillum\",\n \"postal_code\": \"proident exercita\",\n \"city\": \"qu\",\n \"branch\": \"ullamco aute laboris\",\n \"address2\": \"voluptate ut cupidatat\",\n \"country\": \"GT\",\n \"country_name\": \"sunt consequat proident\",\n \"website\": \"nostrud voluptate\",\n \"vat_number\": \"irure Ut deserunt\",\n \"logo\": \"http://DzlsBacyOdCdATdtDSKnxHWiOmT.qfoLE.8XnE.\",\n \"logo_name\": \"enim elit nisi minim do\",\n \"created\": \"2007-11-25T07:51:41.300Z\",\n \"id\": \"urn:uuid:e3c12e78-12fd-d400-c345-e426c07b6ffc\",\n \"verified_bank\": \"sunt elit\",\n \"verified_dnb\": \"nostrud aliquip\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"Duis anim do\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"velit anim\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"2021-02-17T03:27:43.628Z\",\n \"accomplished_by_id\": \"in exercitation\",\n \"accomplished_by_company_id\": \"irure fugiat Duis\",\n \"destroyed\": \"1952-12-31T02:09:39.808Z\",\n \"destroyed_by_company_id\": \"deserunt pariatur culpa\",\n \"notify_parties\": [\n \"eneyn@YdvVoFMVfZMctwByqcMtYgRQOoMPnkajh.jz\",\n \"AFYsemFV0hKm3@WURDItzsxhgagEekHUXeUOzkV.nd\"\n ],\n \"meta_data\": {},\n \"display_name\": \"cillum sunt aute\",\n \"file_name\": \"ipsum est\",\n \"file_size\": 1990310908,\n \"file_content_type\": \"Ut occaecat voluptate ut\",\n \"watermarkable\": false,\n \"icon\": \"incididunt tempor\",\n \"file_type\": \"quis reprehenderit dolor ullamco\",\n \"created\": \"culpa nulla sit sunt\",\n \"thumbnail\": \"http://hVooSPJxVuyTDMTWvoIDOvcoFmvvOxW.hslNrivwkR2PGZrudSYUiR2uvZfTUUdlRwEWDgZ+jUk1eZZ4bx5fRfHxCGHRTmU3zcHz82ajW9j38WgGIW\",\n \"thumbnail_mime_type\": \"amet in laborum sunt\"\n },\n \"attachment_count\": 87150649,\n \"is_on_blockchain\": true,\n \"can_be_destroyed\": \"laborum commodo Excepteur\",\n \"can_be_accomplished\": \"commodo\",\n \"destroy_pending\": \"ipsum\",\n \"accomplish_pending\": \"nostrud Excepteur sit ea officia\",\n \"created\": \"in dolo\"\n },\n \"used_in_envelope_id\": \"qui enim\",\n \"used_in_envelope\": {\n \"id\": \"urn:uuid:a52c3083-22a9-207e-5b30-72a897bca9b1\",\n \"owner_id\": \"nostrud cillum velit\",\n \"recipient_id\": \"ea \",\n \"message\": \"pariatur ad proident eiusmod\",\n \"type\": \"ad\",\n \"specialization_type\": \"acid\",\n \"created\": \"dolore nulla esse officia commodo\",\n \"sent\": \"2016-08-28T10:38:27.038Z\",\n \"archived\": \"1975-11-22T10:49:51.316Z\",\n \"delivered\": \"anim Duis officia\",\n \"action_performed_by_id\": \"minim ut n\",\n \"sealed\": false,\n \"can_be_sealed\": \"qui est ea fugiat in\",\n \"is_draft\": \"ullamco aute\",\n \"sender_inbox_id\": \"voluptate consequat eu cillum\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"Excepteur exercitation eu\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": false,\n \"delivered_envelope_id\": \"dolor\",\n \"failed_delivery_envelope_id\": \"ullamco\",\n \"failed_outgoing_id\": \"incididunt aliquip aute sint\",\n \"pay_to_collect\": false,\n \"pay_to_collect_response\": \"proident deserunt culpa laboris\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": false,\n \"created\": \"2017-10-24T06:34:16.689Z\"\n },\n {\n \"document_token_id\": \"mollit occaecat dolore\",\n \"id\": \"f4f75a40-3318-6d03-5218-f872bf07f0a6\",\n \"envelope_id\": \"amet commodo fugiat\",\n \"document_token\": {\n \"id\": \"urn:uuid:3c1a8eb8-c842-79d1-f811-61fb6f103779\",\n \"storage_type\": \"mollit ex\",\n \"watermark_generated\": false,\n \"ipfs_document_group_id\": \"dolore dolor ut ut\",\n \"ipfs_document_group\": \"9663bee0-ebbb-dc1d-c125-7108f519a27b\",\n \"document_id\": \"commodo deserunt magna sed\",\n \"document\": {\n \"document_type\": \"officia laboris cupidatat\",\n \"create_on_blockchain_override\": false,\n \"id\": \"urn:uuid:a348548b-ac11-247c-36a6-9aa30063d050\",\n \"current_owner_id\": \"deserunt dolore\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"irure\",\n \"uploaded_by\": {\n \"email\": \"ClEvMO43cc@BCeUlTGDVUc.gr\",\n \"telephone\": \"ea ullamco\",\n \"name\": \"nulla fugia\",\n \"first_name\": \"elit enim\",\n \"last_name\": \"amet reprehenderit\",\n \"company_id\": \"ad deserunt consequat sit\",\n \"company\": {\n \"name\": \"dolor officia exercitation\",\n \"address\": \"incididunt Excepteur\",\n \"postal_code\": \"ut id enim anim\",\n \"city\": \"proident sunt\",\n \"branch\": \"qui dolore in\",\n \"address2\": \"veniam\",\n \"country\": \"GT\",\n \"country_name\": \"ex ea dolor occaecat\",\n \"website\": \"occaecat ut labore\",\n \"vat_number\": \"in proident\",\n \"logo\": \"http://fwETkMNWGM.ehoTc3v7ct\",\n \"logo_name\": \"fugiat Duis nisi\",\n \"created\": \"2002-11-12T09:30:07.309Z\",\n \"id\": \"urn:uuid:4002afe6-9a37-1afe-90b3-6469ae3b23f7\",\n \"verified_bank\": \"volupta\",\n \"verified_dnb\": \"ex sed\"\n },\n \"logo\": \"http://ZAjIK.fqsYXQdoG+wZ5QQCfanqf\",\n \"logo_name\": \"ut Excepteur\",\n \"id\": \"98016d9a-79af-3563-dfad-0798b9b8f266\"\n },\n \"uploaded_by_company_id\": \"c\",\n \"uploaded_by_company\": {\n \"name\": \"sunt reprehenderit nulla fugiat\",\n \"address\": \"sunt velit pariatur sint\",\n \"postal_code\": \"eu est\",\n \"city\": \"u\",\n \"branch\": \"ex labore occaecat pariatur\",\n \"address2\": \"elit\",\n \"country\": \"BZ\",\n \"country_name\": \"ess\",\n \"website\": \"sed nisi\",\n \"vat_number\": \"dolore\",\n \"logo\": \"http://dEvEyGdPRZH.moFfa8y5oFFEJPpSYgZfJqiYKY-EYYlfMtf0u--QBAk1zQY6J0B78d.2a7nE.Jzo3tE8Axjk5IN\",\n \"logo_name\": \"adipisici\",\n \"created\": \"2021-05-24T18:08:25.369Z\",\n \"id\": \"urn:uuid:e03908aa-0b17-9b00-2d25-75979850778f\",\n \"verified_bank\": \"Duis do nulla deserunt voluptate\",\n \"verified_dnb\": \"incididunt cupidatat nulla qui\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"dolore in\",\n \"create_on_blockchain\": false,\n \"accomplisher_id\": \"cillum velit aute occaecat\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"1998-04-29T16:24:41.608Z\",\n \"accomplished_by_id\": \"laborum aute dolore sunt\",\n \"accomplished_by_company_id\": \"velit sint pariatur nisi\",\n \"destroyed\": \"2006-10-01T06:37:51.953Z\",\n \"destroyed_by_company_id\": \"irure Ut eiusmod aute\",\n \"notify_parties\": [\n \"zD3dDANyjb@U.xb\",\n \"6jSQ6rP@sZALzfCgCLwOUX.tu\"\n ],\n \"meta_data\": {},\n \"display_name\": \"deserunt commodo eiusmod occaecat\",\n \"file_name\": \"deserunt anim veniam\",\n \"file_size\": 942397605,\n \"file_content_type\": \"do voluptate nostrud in\",\n \"watermarkable\": true,\n \"icon\": \"ullamco incididunt\",\n \"file_type\": \"occaecat aliquip\",\n \"created\": \"cillum enim laboris incididunt\",\n \"thumbnail\": \"https://VOwhldAlg.nbxPep,3ddvKoQLizWyx1NHHabjlausCxTw3py6q7G9,GGmnoi\",\n \"thumbnail_mime_type\": \"dolor aliquip proident aliqua incididunt\"\n },\n \"attachment_count\": -52712857,\n \"is_on_blockchain\": false,\n \"can_be_destroyed\": \"laboris qui tempor do\",\n \"can_be_accomplished\": \"amet pariatu\",\n \"destroy_pending\": \"nostrud ex\",\n \"accomplish_pending\": \"et do ut cillum Lorem\",\n \"created\": \"magna non nost\"\n },\n \"used_in_envelope_id\": \"sunt culpa voluptate\",\n \"used_in_envelope\": {\n \"id\": \"3b6db492-9574-711a-72f3-114128c452ce\",\n \"owner_id\": \"sed in pariatur\",\n \"recipient_id\": \"in cillum\",\n \"message\": \"quis ullamco\",\n \"type\": \"eu nisi commodo minim quis\",\n \"specialization_type\": \"standard\",\n \"created\": \"tempor ipsum\",\n \"sent\": \"1995-07-26T17:02:30.778Z\",\n \"archived\": \"1975-12-16T22:45:04.149Z\",\n \"delivered\": \"minim\",\n \"action_performed_by_id\": \"est tempor\",\n \"sealed\": false,\n \"can_be_sealed\": \"Ut ex culpa\",\n \"is_draft\": \"nisi in\",\n \"sender_inbox_id\": \"ad aliqua eiusmod\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"eu\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": true,\n \"delivered_envelope_id\": \"ut\",\n \"failed_delivery_envelope_id\": \"id Lorem Ut dolor\",\n \"failed_outgoing_id\": \"laboris nostrud\",\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"aute aliqua irure\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": true,\n \"created\": \"1970-07-20T07:24:45.498Z\"\n }\n ],\n \"delivered_envelope_id\": \"Ut consectetur\",\n \"failed_delivery_envelope_id\": \"Ut cillum ex nisi\",\n \"failed_outgoing_id\": \"do nisi Ut\",\n \"document_token_transactions\": [\n {\n \"tx_hash\": \"sit elit ullamco eu\",\n \"status\": 2,\n \"created\": \"1948-08-01T00:58:41.998Z\",\n \"mined\": \"1966-07-16T04:11:50.365Z\",\n \"etherscan_link\": \"quis ad\"\n },\n {\n \"tx_hash\": \"aute incididunt\",\n \"status\": 2,\n \"created\": \"1993-01-21T21:15:29.807Z\",\n \"mined\": \"1956-11-23T18:52:48.097Z\",\n \"etherscan_link\": \"nisi tempor fugiat\"\n }\n ],\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"tempor\",\n \"meta_data\": {},\n \"credits_spent_amount\": 3899833,\n \"credits_spent_for_documents\": -43248610,\n \"acid_number\": \"cupidatat deserunt dolor\",\n \"acid_verification_timeout\": \"veniam non velit eiusmod\",\n \"aci_filing_notification\": \"irure dolore et veniam\",\n \"is_first_acid_filing\": false\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company or envelope is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Update envelope", "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] }, "description": "Updates the envelope. All data needs to be present to perform an update. If data is incomplete,\n please use a `PATCH` call. Envelopes cannot be moved between inboxes." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:168e861d-d56a-2546-87ab-2a0d91d7b389\",\n \"owner_id\": \"voluptate sunt consequat ad ipsum\",\n \"recipient_id\": \"aliquip dolore laboris eiusmod\",\n \"message\": \"quis pariatur\",\n \"type\": \"irure cupidatat ad minim\",\n \"specialization_type\": \"standard\",\n \"created\": \"sit qui\",\n \"sent\": \"1998-04-24T04:50:20.680Z\",\n \"archived\": \"1987-02-09T04:14:10.914Z\",\n \"delivered\": \"in cupidatat anim\",\n \"action_performed_by_id\": \"labor\",\n \"action_performed_by\": {\n \"email\": \"X83k0beD9PAnv@qKqLUNuUIIBHztMkwOwMlclQ.rcm\",\n \"telephone\": \"est ex\",\n \"name\": \"laboris\",\n \"first_name\": \"sunt culpa\",\n \"last_name\": \"Lorem\",\n \"company_id\": \"fugiat\",\n \"company\": {\n \"name\": \"elit in reprehenderit sit anim\",\n \"address\": \"de\",\n \"postal_code\": \"nostrud exercitation irure commodo\",\n \"city\": \"laboris est nisi\",\n \"branch\": \"elit laboris irure\",\n \"address2\": \"aliqua non velit nulla esse\",\n \"country\": \"AZ\",\n \"country_name\": \"pariatur deserunt non\",\n \"website\": \"sint velit minim Excepteur fugiat\",\n \"vat_number\": \"quis eiusmod dol\",\n \"logo\": \"http://ByyCfnjAboaBQdUInoAesMRucA.sjoSB.E17yYl2Tp7l4uTnwoqAG3mG7vshOL\",\n \"logo_name\": \"cillum ipsum id anim\",\n \"created\": \"2002-04-27T22:22:49.781Z\",\n \"id\": \"urn:uuid:7bf94c3e-3467-6f54-bad1-3cc2262a4737\",\n \"verified_bank\": \"est ea qui\",\n \"verified_dnb\": \"nostrud velit\"\n },\n \"logo\": \"https://YMkDPLGSIYi.sbhqMoWzfcBz8WMKoRrkZJGYGE1icf8+Ev-Yu+sgu,OP4hWPITtI7wy.XShQuRy+jiYfJPwSzYRBS\",\n \"logo_name\": \"pariatur nisi\",\n \"id\": \"1fb0d2d6-5979-b24d-8094-f2a2bdc2e0dd\"\n },\n \"action_performed_by_company_id\": \"ullamco do\",\n \"action_performed_by_company\": {\n \"name\": \"eu qui\",\n \"address\": \"aliqua ipsum\",\n \"postal_code\": \"mollit sint qui sed\",\n \"city\": \"nulla cupidatat aliqua dolore\",\n \"branch\": \"consectetur Ut\",\n \"address2\": \"in ut\",\n \"country\": \"BE\",\n \"country_name\": \"voluptate anim enim nulla\",\n \"website\": \"in\",\n \"vat_number\": \"eiusmod\",\n \"logo\": \"https://r.frOBgvaabcEjDjIAhNjyivSPsHxloEg.\",\n \"logo_name\": \"irure cillum officia est\",\n \"created\": \"1974-05-12T17:22:23.041Z\",\n \"id\": \"f5947ce2-8722-e638-f9d8-83a24bba8b23\",\n \"verified_bank\": \"exercitation aliqua cupi\",\n \"verified_dnb\": \"dolore ad dolore\"\n },\n \"sealed\": false,\n \"can_be_sealed\": \"in irure non elit Lorem\",\n \"is_draft\": \"est nostrud reprehenderit consequ\",\n \"sender_inbox_id\": \"in elit sit fugiat\",\n \"sender\": {\n \"name\": \"adipisicing ad nostrud et\",\n \"address\": \"sit voluptate\",\n \"postal_code\": \"incididunt enim quis Duis ad\",\n \"city\": \"ad c\",\n \"branch\": \"nisi labore officia\",\n \"address2\": \"pariatur\",\n \"country\": \"YT\",\n \"country_name\": \"ullamco\",\n \"website\": \"ut mollit minim consectetur\",\n \"vat_number\": \"ullamco fugiat exercitation commodo non\",\n \"logo\": \"https://DUSPgY.etyp8fmjoiNkY3k.X4g24o.7EXnZnRVsqmENc+CApMlwy1nAQESHo\",\n \"logo_name\": \"ut velit v\",\n \"created\": \"2016-05-05T14:44:36.026Z\",\n \"id\": \"urn:uuid:ff2328b2-f1de-a199-b7d4-00125ce5928e\",\n \"verified_bank\": \"do proident\",\n \"verified_dnb\": \"eu cillum mollit\"\n },\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"irure culpa incididunt consectetur\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": true,\n \"read_by_user\": \"eiusmod tempor velit\",\n \"documents\": [\n \"incididunt irure enim fugiat reprehenderit\",\n \"laborum nisi esse sunt in\"\n ],\n \"existing_attachments\": {},\n \"attachments\": [\n {\n \"document_token_id\": \"quis deserunt esse irure\",\n \"id\": \"f44f76e5-5b80-f6f8-1240-6a229b426586\",\n \"envelope_id\": \"Duis sit\",\n \"document_token\": {\n \"id\": \"urn:uuid:99f6a1da-897e-f593-cbb8-062d8984342d\",\n \"storage_type\": \"veniam id velit\",\n \"watermark_generated\": true,\n \"ipfs_document_group_id\": \"sed dolore nostrud proident\",\n \"ipfs_document_group\": \"urn:uuid:deb979a4-8b4d-d2a1-db98-dbc264b3c53e\",\n \"document_id\": \"ut irure ex ullamco\",\n \"document\": {\n \"document_type\": \"ut magna proident officia\",\n \"create_on_blockchain_override\": false,\n \"id\": \"bfc5c81b-0ec4-dbd7-2019-24524033f0e2\",\n \"current_owner_id\": \"et occaecat deserunt commodo\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"cupidatat tempor ut\",\n \"uploaded_by\": {\n \"email\": \"KF0IU-dtNh-A@ryHdrBOLLQJmBFIFsMNi.wey\",\n \"telephone\": \"et in\",\n \"name\": \"consectetur sint\",\n \"first_name\": \"amet sed cillum nisi\",\n \"last_name\": \"Ut aliquip\",\n \"company_id\": \"\",\n \"company\": {\n \"name\": \"ullamco\",\n \"address\": \"officia\",\n \"postal_code\": \"dolore labore enim adipisicing\",\n \"city\": \"nisi incididunt\",\n \"branch\": \"sint\",\n \"address2\": \"incididunt\",\n \"country\": \"JE\",\n \"country_name\": \"in in\",\n \"website\": \"fugiat irure ut\",\n \"vat_number\": \"nisi quis\",\n \"logo\": \"http://HCCXvuGJCQrwveJnATVZFbvDEBAzTaUZ.ygISt\",\n \"logo_name\": \"qui\",\n \"created\": \"2006-07-08T09:50:01.259Z\",\n \"id\": \"urn:uuid:0e291c97-350a-509d-3f39-3b2bf689a234\",\n \"verified_bank\": \"non\",\n \"verified_dnb\": \"dolore cillum\"\n },\n \"logo\": \"https://xYzuxnBeIiwxAWzVhiU.qnqiTptCa5PeolHQIB3phfRLwnKKLM\",\n \"logo_name\": \"dolor officia dolo\",\n \"id\": \"6de3c248-8a84-2640-cb1c-7651b0ea0fea\"\n },\n \"uploaded_by_company_id\": \"Excepteur\",\n \"uploaded_by_company\": {\n \"name\": \"sit reprehenderit\",\n \"address\": \"pariatur irure commodo cillum\",\n \"postal_code\": \"proident exercita\",\n \"city\": \"qu\",\n \"branch\": \"ullamco aute laboris\",\n \"address2\": \"voluptate ut cupidatat\",\n \"country\": \"GT\",\n \"country_name\": \"sunt consequat proident\",\n \"website\": \"nostrud voluptate\",\n \"vat_number\": \"irure Ut deserunt\",\n \"logo\": \"http://DzlsBacyOdCdATdtDSKnxHWiOmT.qfoLE.8XnE.\",\n \"logo_name\": \"enim elit nisi minim do\",\n \"created\": \"2007-11-25T07:51:41.300Z\",\n \"id\": \"urn:uuid:e3c12e78-12fd-d400-c345-e426c07b6ffc\",\n \"verified_bank\": \"sunt elit\",\n \"verified_dnb\": \"nostrud aliquip\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"Duis anim do\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"velit anim\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"2021-02-17T03:27:43.628Z\",\n \"accomplished_by_id\": \"in exercitation\",\n \"accomplished_by_company_id\": \"irure fugiat Duis\",\n \"destroyed\": \"1952-12-31T02:09:39.808Z\",\n \"destroyed_by_company_id\": \"deserunt pariatur culpa\",\n \"notify_parties\": [\n \"eneyn@YdvVoFMVfZMctwByqcMtYgRQOoMPnkajh.jz\",\n \"AFYsemFV0hKm3@WURDItzsxhgagEekHUXeUOzkV.nd\"\n ],\n \"meta_data\": {},\n \"display_name\": \"cillum sunt aute\",\n \"file_name\": \"ipsum est\",\n \"file_size\": 1990310908,\n \"file_content_type\": \"Ut occaecat voluptate ut\",\n \"watermarkable\": false,\n \"icon\": \"incididunt tempor\",\n \"file_type\": \"quis reprehenderit dolor ullamco\",\n \"created\": \"culpa nulla sit sunt\",\n \"thumbnail\": \"http://hVooSPJxVuyTDMTWvoIDOvcoFmvvOxW.hslNrivwkR2PGZrudSYUiR2uvZfTUUdlRwEWDgZ+jUk1eZZ4bx5fRfHxCGHRTmU3zcHz82ajW9j38WgGIW\",\n \"thumbnail_mime_type\": \"amet in laborum sunt\"\n },\n \"attachment_count\": 87150649,\n \"is_on_blockchain\": true,\n \"can_be_destroyed\": \"laborum commodo Excepteur\",\n \"can_be_accomplished\": \"commodo\",\n \"destroy_pending\": \"ipsum\",\n \"accomplish_pending\": \"nostrud Excepteur sit ea officia\",\n \"created\": \"in dolo\"\n },\n \"used_in_envelope_id\": \"qui enim\",\n \"used_in_envelope\": {\n \"id\": \"urn:uuid:a52c3083-22a9-207e-5b30-72a897bca9b1\",\n \"owner_id\": \"nostrud cillum velit\",\n \"recipient_id\": \"ea \",\n \"message\": \"pariatur ad proident eiusmod\",\n \"type\": \"ad\",\n \"specialization_type\": \"acid\",\n \"created\": \"dolore nulla esse officia commodo\",\n \"sent\": \"2016-08-28T10:38:27.038Z\",\n \"archived\": \"1975-11-22T10:49:51.316Z\",\n \"delivered\": \"anim Duis officia\",\n \"action_performed_by_id\": \"minim ut n\",\n \"sealed\": false,\n \"can_be_sealed\": \"qui est ea fugiat in\",\n \"is_draft\": \"ullamco aute\",\n \"sender_inbox_id\": \"voluptate consequat eu cillum\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"Excepteur exercitation eu\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": false,\n \"delivered_envelope_id\": \"dolor\",\n \"failed_delivery_envelope_id\": \"ullamco\",\n \"failed_outgoing_id\": \"incididunt aliquip aute sint\",\n \"pay_to_collect\": false,\n \"pay_to_collect_response\": \"proident deserunt culpa laboris\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": false,\n \"created\": \"2017-10-24T06:34:16.689Z\"\n },\n {\n \"document_token_id\": \"mollit occaecat dolore\",\n \"id\": \"f4f75a40-3318-6d03-5218-f872bf07f0a6\",\n \"envelope_id\": \"amet commodo fugiat\",\n \"document_token\": {\n \"id\": \"urn:uuid:3c1a8eb8-c842-79d1-f811-61fb6f103779\",\n \"storage_type\": \"mollit ex\",\n \"watermark_generated\": false,\n \"ipfs_document_group_id\": \"dolore dolor ut ut\",\n \"ipfs_document_group\": \"9663bee0-ebbb-dc1d-c125-7108f519a27b\",\n \"document_id\": \"commodo deserunt magna sed\",\n \"document\": {\n \"document_type\": \"officia laboris cupidatat\",\n \"create_on_blockchain_override\": false,\n \"id\": \"urn:uuid:a348548b-ac11-247c-36a6-9aa30063d050\",\n \"current_owner_id\": \"deserunt dolore\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"irure\",\n \"uploaded_by\": {\n \"email\": \"ClEvMO43cc@BCeUlTGDVUc.gr\",\n \"telephone\": \"ea ullamco\",\n \"name\": \"nulla fugia\",\n \"first_name\": \"elit enim\",\n \"last_name\": \"amet reprehenderit\",\n \"company_id\": \"ad deserunt consequat sit\",\n \"company\": {\n \"name\": \"dolor officia exercitation\",\n \"address\": \"incididunt Excepteur\",\n \"postal_code\": \"ut id enim anim\",\n \"city\": \"proident sunt\",\n \"branch\": \"qui dolore in\",\n \"address2\": \"veniam\",\n \"country\": \"GT\",\n \"country_name\": \"ex ea dolor occaecat\",\n \"website\": \"occaecat ut labore\",\n \"vat_number\": \"in proident\",\n \"logo\": \"http://fwETkMNWGM.ehoTc3v7ct\",\n \"logo_name\": \"fugiat Duis nisi\",\n \"created\": \"2002-11-12T09:30:07.309Z\",\n \"id\": \"urn:uuid:4002afe6-9a37-1afe-90b3-6469ae3b23f7\",\n \"verified_bank\": \"volupta\",\n \"verified_dnb\": \"ex sed\"\n },\n \"logo\": \"http://ZAjIK.fqsYXQdoG+wZ5QQCfanqf\",\n \"logo_name\": \"ut Excepteur\",\n \"id\": \"98016d9a-79af-3563-dfad-0798b9b8f266\"\n },\n \"uploaded_by_company_id\": \"c\",\n \"uploaded_by_company\": {\n \"name\": \"sunt reprehenderit nulla fugiat\",\n \"address\": \"sunt velit pariatur sint\",\n \"postal_code\": \"eu est\",\n \"city\": \"u\",\n \"branch\": \"ex labore occaecat pariatur\",\n \"address2\": \"elit\",\n \"country\": \"BZ\",\n \"country_name\": \"ess\",\n \"website\": \"sed nisi\",\n \"vat_number\": \"dolore\",\n \"logo\": \"http://dEvEyGdPRZH.moFfa8y5oFFEJPpSYgZfJqiYKY-EYYlfMtf0u--QBAk1zQY6J0B78d.2a7nE.Jzo3tE8Axjk5IN\",\n \"logo_name\": \"adipisici\",\n \"created\": \"2021-05-24T18:08:25.369Z\",\n \"id\": \"urn:uuid:e03908aa-0b17-9b00-2d25-75979850778f\",\n \"verified_bank\": \"Duis do nulla deserunt voluptate\",\n \"verified_dnb\": \"incididunt cupidatat nulla qui\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"dolore in\",\n \"create_on_blockchain\": false,\n \"accomplisher_id\": \"cillum velit aute occaecat\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"1998-04-29T16:24:41.608Z\",\n \"accomplished_by_id\": \"laborum aute dolore sunt\",\n \"accomplished_by_company_id\": \"velit sint pariatur nisi\",\n \"destroyed\": \"2006-10-01T06:37:51.953Z\",\n \"destroyed_by_company_id\": \"irure Ut eiusmod aute\",\n \"notify_parties\": [\n \"zD3dDANyjb@U.xb\",\n \"6jSQ6rP@sZALzfCgCLwOUX.tu\"\n ],\n \"meta_data\": {},\n \"display_name\": \"deserunt commodo eiusmod occaecat\",\n \"file_name\": \"deserunt anim veniam\",\n \"file_size\": 942397605,\n \"file_content_type\": \"do voluptate nostrud in\",\n \"watermarkable\": true,\n \"icon\": \"ullamco incididunt\",\n \"file_type\": \"occaecat aliquip\",\n \"created\": \"cillum enim laboris incididunt\",\n \"thumbnail\": \"https://VOwhldAlg.nbxPep,3ddvKoQLizWyx1NHHabjlausCxTw3py6q7G9,GGmnoi\",\n \"thumbnail_mime_type\": \"dolor aliquip proident aliqua incididunt\"\n },\n \"attachment_count\": -52712857,\n \"is_on_blockchain\": false,\n \"can_be_destroyed\": \"laboris qui tempor do\",\n \"can_be_accomplished\": \"amet pariatu\",\n \"destroy_pending\": \"nostrud ex\",\n \"accomplish_pending\": \"et do ut cillum Lorem\",\n \"created\": \"magna non nost\"\n },\n \"used_in_envelope_id\": \"sunt culpa voluptate\",\n \"used_in_envelope\": {\n \"id\": \"3b6db492-9574-711a-72f3-114128c452ce\",\n \"owner_id\": \"sed in pariatur\",\n \"recipient_id\": \"in cillum\",\n \"message\": \"quis ullamco\",\n \"type\": \"eu nisi commodo minim quis\",\n \"specialization_type\": \"standard\",\n \"created\": \"tempor ipsum\",\n \"sent\": \"1995-07-26T17:02:30.778Z\",\n \"archived\": \"1975-12-16T22:45:04.149Z\",\n \"delivered\": \"minim\",\n \"action_performed_by_id\": \"est tempor\",\n \"sealed\": false,\n \"can_be_sealed\": \"Ut ex culpa\",\n \"is_draft\": \"nisi in\",\n \"sender_inbox_id\": \"ad aliqua eiusmod\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"eu\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": true,\n \"delivered_envelope_id\": \"ut\",\n \"failed_delivery_envelope_id\": \"id Lorem Ut dolor\",\n \"failed_outgoing_id\": \"laboris nostrud\",\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"aute aliqua irure\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": true,\n \"created\": \"1970-07-20T07:24:45.498Z\"\n }\n ],\n \"delivered_envelope_id\": \"Ut consectetur\",\n \"failed_delivery_envelope_id\": \"Ut cillum ex nisi\",\n \"failed_outgoing_id\": \"do nisi Ut\",\n \"document_token_transactions\": [\n {\n \"tx_hash\": \"sit elit ullamco eu\",\n \"status\": 2,\n \"created\": \"1948-08-01T00:58:41.998Z\",\n \"mined\": \"1966-07-16T04:11:50.365Z\",\n \"etherscan_link\": \"quis ad\"\n },\n {\n \"tx_hash\": \"aute incididunt\",\n \"status\": 2,\n \"created\": \"1993-01-21T21:15:29.807Z\",\n \"mined\": \"1956-11-23T18:52:48.097Z\",\n \"etherscan_link\": \"nisi tempor fugiat\"\n }\n ],\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"tempor\",\n \"meta_data\": {},\n \"credits_spent_amount\": 3899833,\n \"credits_spent_for_documents\": -43248610,\n \"acid_number\": \"cupidatat deserunt dolor\",\n \"acid_verification_timeout\": \"veniam non velit eiusmod\",\n \"aci_filing_notification\": \"irure dolore et veniam\",\n \"is_first_acid_filing\": false\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company or envelope is not found.", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Partially update envelope", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] }, "description": "Partially updates the envelope. Only the data that needs to be changed is required.\n Envelopes cannot be moved between inboxes." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:168e861d-d56a-2546-87ab-2a0d91d7b389\",\n \"owner_id\": \"voluptate sunt consequat ad ipsum\",\n \"recipient_id\": \"aliquip dolore laboris eiusmod\",\n \"message\": \"quis pariatur\",\n \"type\": \"irure cupidatat ad minim\",\n \"specialization_type\": \"standard\",\n \"created\": \"sit qui\",\n \"sent\": \"1998-04-24T04:50:20.680Z\",\n \"archived\": \"1987-02-09T04:14:10.914Z\",\n \"delivered\": \"in cupidatat anim\",\n \"action_performed_by_id\": \"labor\",\n \"action_performed_by\": {\n \"email\": \"X83k0beD9PAnv@qKqLUNuUIIBHztMkwOwMlclQ.rcm\",\n \"telephone\": \"est ex\",\n \"name\": \"laboris\",\n \"first_name\": \"sunt culpa\",\n \"last_name\": \"Lorem\",\n \"company_id\": \"fugiat\",\n \"company\": {\n \"name\": \"elit in reprehenderit sit anim\",\n \"address\": \"de\",\n \"postal_code\": \"nostrud exercitation irure commodo\",\n \"city\": \"laboris est nisi\",\n \"branch\": \"elit laboris irure\",\n \"address2\": \"aliqua non velit nulla esse\",\n \"country\": \"AZ\",\n \"country_name\": \"pariatur deserunt non\",\n \"website\": \"sint velit minim Excepteur fugiat\",\n \"vat_number\": \"quis eiusmod dol\",\n \"logo\": \"http://ByyCfnjAboaBQdUInoAesMRucA.sjoSB.E17yYl2Tp7l4uTnwoqAG3mG7vshOL\",\n \"logo_name\": \"cillum ipsum id anim\",\n \"created\": \"2002-04-27T22:22:49.781Z\",\n \"id\": \"urn:uuid:7bf94c3e-3467-6f54-bad1-3cc2262a4737\",\n \"verified_bank\": \"est ea qui\",\n \"verified_dnb\": \"nostrud velit\"\n },\n \"logo\": \"https://YMkDPLGSIYi.sbhqMoWzfcBz8WMKoRrkZJGYGE1icf8+Ev-Yu+sgu,OP4hWPITtI7wy.XShQuRy+jiYfJPwSzYRBS\",\n \"logo_name\": \"pariatur nisi\",\n \"id\": \"1fb0d2d6-5979-b24d-8094-f2a2bdc2e0dd\"\n },\n \"action_performed_by_company_id\": \"ullamco do\",\n \"action_performed_by_company\": {\n \"name\": \"eu qui\",\n \"address\": \"aliqua ipsum\",\n \"postal_code\": \"mollit sint qui sed\",\n \"city\": \"nulla cupidatat aliqua dolore\",\n \"branch\": \"consectetur Ut\",\n \"address2\": \"in ut\",\n \"country\": \"BE\",\n \"country_name\": \"voluptate anim enim nulla\",\n \"website\": \"in\",\n \"vat_number\": \"eiusmod\",\n \"logo\": \"https://r.frOBgvaabcEjDjIAhNjyivSPsHxloEg.\",\n \"logo_name\": \"irure cillum officia est\",\n \"created\": \"1974-05-12T17:22:23.041Z\",\n \"id\": \"f5947ce2-8722-e638-f9d8-83a24bba8b23\",\n \"verified_bank\": \"exercitation aliqua cupi\",\n \"verified_dnb\": \"dolore ad dolore\"\n },\n \"sealed\": false,\n \"can_be_sealed\": \"in irure non elit Lorem\",\n \"is_draft\": \"est nostrud reprehenderit consequ\",\n \"sender_inbox_id\": \"in elit sit fugiat\",\n \"sender\": {\n \"name\": \"adipisicing ad nostrud et\",\n \"address\": \"sit voluptate\",\n \"postal_code\": \"incididunt enim quis Duis ad\",\n \"city\": \"ad c\",\n \"branch\": \"nisi labore officia\",\n \"address2\": \"pariatur\",\n \"country\": \"YT\",\n \"country_name\": \"ullamco\",\n \"website\": \"ut mollit minim consectetur\",\n \"vat_number\": \"ullamco fugiat exercitation commodo non\",\n \"logo\": \"https://DUSPgY.etyp8fmjoiNkY3k.X4g24o.7EXnZnRVsqmENc+CApMlwy1nAQESHo\",\n \"logo_name\": \"ut velit v\",\n \"created\": \"2016-05-05T14:44:36.026Z\",\n \"id\": \"urn:uuid:ff2328b2-f1de-a199-b7d4-00125ce5928e\",\n \"verified_bank\": \"do proident\",\n \"verified_dnb\": \"eu cillum mollit\"\n },\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"irure culpa incididunt consectetur\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": true,\n \"read_by_user\": \"eiusmod tempor velit\",\n \"documents\": [\n \"incididunt irure enim fugiat reprehenderit\",\n \"laborum nisi esse sunt in\"\n ],\n \"existing_attachments\": {},\n \"attachments\": [\n {\n \"document_token_id\": \"quis deserunt esse irure\",\n \"id\": \"f44f76e5-5b80-f6f8-1240-6a229b426586\",\n \"envelope_id\": \"Duis sit\",\n \"document_token\": {\n \"id\": \"urn:uuid:99f6a1da-897e-f593-cbb8-062d8984342d\",\n \"storage_type\": \"veniam id velit\",\n \"watermark_generated\": true,\n \"ipfs_document_group_id\": \"sed dolore nostrud proident\",\n \"ipfs_document_group\": \"urn:uuid:deb979a4-8b4d-d2a1-db98-dbc264b3c53e\",\n \"document_id\": \"ut irure ex ullamco\",\n \"document\": {\n \"document_type\": \"ut magna proident officia\",\n \"create_on_blockchain_override\": false,\n \"id\": \"bfc5c81b-0ec4-dbd7-2019-24524033f0e2\",\n \"current_owner_id\": \"et occaecat deserunt commodo\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"cupidatat tempor ut\",\n \"uploaded_by\": {\n \"email\": \"KF0IU-dtNh-A@ryHdrBOLLQJmBFIFsMNi.wey\",\n \"telephone\": \"et in\",\n \"name\": \"consectetur sint\",\n \"first_name\": \"amet sed cillum nisi\",\n \"last_name\": \"Ut aliquip\",\n \"company_id\": \"\",\n \"company\": {\n \"name\": \"ullamco\",\n \"address\": \"officia\",\n \"postal_code\": \"dolore labore enim adipisicing\",\n \"city\": \"nisi incididunt\",\n \"branch\": \"sint\",\n \"address2\": \"incididunt\",\n \"country\": \"JE\",\n \"country_name\": \"in in\",\n \"website\": \"fugiat irure ut\",\n \"vat_number\": \"nisi quis\",\n \"logo\": \"http://HCCXvuGJCQrwveJnATVZFbvDEBAzTaUZ.ygISt\",\n \"logo_name\": \"qui\",\n \"created\": \"2006-07-08T09:50:01.259Z\",\n \"id\": \"urn:uuid:0e291c97-350a-509d-3f39-3b2bf689a234\",\n \"verified_bank\": \"non\",\n \"verified_dnb\": \"dolore cillum\"\n },\n \"logo\": \"https://xYzuxnBeIiwxAWzVhiU.qnqiTptCa5PeolHQIB3phfRLwnKKLM\",\n \"logo_name\": \"dolor officia dolo\",\n \"id\": \"6de3c248-8a84-2640-cb1c-7651b0ea0fea\"\n },\n \"uploaded_by_company_id\": \"Excepteur\",\n \"uploaded_by_company\": {\n \"name\": \"sit reprehenderit\",\n \"address\": \"pariatur irure commodo cillum\",\n \"postal_code\": \"proident exercita\",\n \"city\": \"qu\",\n \"branch\": \"ullamco aute laboris\",\n \"address2\": \"voluptate ut cupidatat\",\n \"country\": \"GT\",\n \"country_name\": \"sunt consequat proident\",\n \"website\": \"nostrud voluptate\",\n \"vat_number\": \"irure Ut deserunt\",\n \"logo\": \"http://DzlsBacyOdCdATdtDSKnxHWiOmT.qfoLE.8XnE.\",\n \"logo_name\": \"enim elit nisi minim do\",\n \"created\": \"2007-11-25T07:51:41.300Z\",\n \"id\": \"urn:uuid:e3c12e78-12fd-d400-c345-e426c07b6ffc\",\n \"verified_bank\": \"sunt elit\",\n \"verified_dnb\": \"nostrud aliquip\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"Duis anim do\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"velit anim\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"2021-02-17T03:27:43.628Z\",\n \"accomplished_by_id\": \"in exercitation\",\n \"accomplished_by_company_id\": \"irure fugiat Duis\",\n \"destroyed\": \"1952-12-31T02:09:39.808Z\",\n \"destroyed_by_company_id\": \"deserunt pariatur culpa\",\n \"notify_parties\": [\n \"eneyn@YdvVoFMVfZMctwByqcMtYgRQOoMPnkajh.jz\",\n \"AFYsemFV0hKm3@WURDItzsxhgagEekHUXeUOzkV.nd\"\n ],\n \"meta_data\": {},\n \"display_name\": \"cillum sunt aute\",\n \"file_name\": \"ipsum est\",\n \"file_size\": 1990310908,\n \"file_content_type\": \"Ut occaecat voluptate ut\",\n \"watermarkable\": false,\n \"icon\": \"incididunt tempor\",\n \"file_type\": \"quis reprehenderit dolor ullamco\",\n \"created\": \"culpa nulla sit sunt\",\n \"thumbnail\": \"http://hVooSPJxVuyTDMTWvoIDOvcoFmvvOxW.hslNrivwkR2PGZrudSYUiR2uvZfTUUdlRwEWDgZ+jUk1eZZ4bx5fRfHxCGHRTmU3zcHz82ajW9j38WgGIW\",\n \"thumbnail_mime_type\": \"amet in laborum sunt\"\n },\n \"attachment_count\": 87150649,\n \"is_on_blockchain\": true,\n \"can_be_destroyed\": \"laborum commodo Excepteur\",\n \"can_be_accomplished\": \"commodo\",\n \"destroy_pending\": \"ipsum\",\n \"accomplish_pending\": \"nostrud Excepteur sit ea officia\",\n \"created\": \"in dolo\"\n },\n \"used_in_envelope_id\": \"qui enim\",\n \"used_in_envelope\": {\n \"id\": \"urn:uuid:a52c3083-22a9-207e-5b30-72a897bca9b1\",\n \"owner_id\": \"nostrud cillum velit\",\n \"recipient_id\": \"ea \",\n \"message\": \"pariatur ad proident eiusmod\",\n \"type\": \"ad\",\n \"specialization_type\": \"acid\",\n \"created\": \"dolore nulla esse officia commodo\",\n \"sent\": \"2016-08-28T10:38:27.038Z\",\n \"archived\": \"1975-11-22T10:49:51.316Z\",\n \"delivered\": \"anim Duis officia\",\n \"action_performed_by_id\": \"minim ut n\",\n \"sealed\": false,\n \"can_be_sealed\": \"qui est ea fugiat in\",\n \"is_draft\": \"ullamco aute\",\n \"sender_inbox_id\": \"voluptate consequat eu cillum\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"Excepteur exercitation eu\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": false,\n \"delivered_envelope_id\": \"dolor\",\n \"failed_delivery_envelope_id\": \"ullamco\",\n \"failed_outgoing_id\": \"incididunt aliquip aute sint\",\n \"pay_to_collect\": false,\n \"pay_to_collect_response\": \"proident deserunt culpa laboris\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": false,\n \"created\": \"2017-10-24T06:34:16.689Z\"\n },\n {\n \"document_token_id\": \"mollit occaecat dolore\",\n \"id\": \"f4f75a40-3318-6d03-5218-f872bf07f0a6\",\n \"envelope_id\": \"amet commodo fugiat\",\n \"document_token\": {\n \"id\": \"urn:uuid:3c1a8eb8-c842-79d1-f811-61fb6f103779\",\n \"storage_type\": \"mollit ex\",\n \"watermark_generated\": false,\n \"ipfs_document_group_id\": \"dolore dolor ut ut\",\n \"ipfs_document_group\": \"9663bee0-ebbb-dc1d-c125-7108f519a27b\",\n \"document_id\": \"commodo deserunt magna sed\",\n \"document\": {\n \"document_type\": \"officia laboris cupidatat\",\n \"create_on_blockchain_override\": false,\n \"id\": \"urn:uuid:a348548b-ac11-247c-36a6-9aa30063d050\",\n \"current_owner_id\": \"deserunt dolore\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"irure\",\n \"uploaded_by\": {\n \"email\": \"ClEvMO43cc@BCeUlTGDVUc.gr\",\n \"telephone\": \"ea ullamco\",\n \"name\": \"nulla fugia\",\n \"first_name\": \"elit enim\",\n \"last_name\": \"amet reprehenderit\",\n \"company_id\": \"ad deserunt consequat sit\",\n \"company\": {\n \"name\": \"dolor officia exercitation\",\n \"address\": \"incididunt Excepteur\",\n \"postal_code\": \"ut id enim anim\",\n \"city\": \"proident sunt\",\n \"branch\": \"qui dolore in\",\n \"address2\": \"veniam\",\n \"country\": \"GT\",\n \"country_name\": \"ex ea dolor occaecat\",\n \"website\": \"occaecat ut labore\",\n \"vat_number\": \"in proident\",\n \"logo\": \"http://fwETkMNWGM.ehoTc3v7ct\",\n \"logo_name\": \"fugiat Duis nisi\",\n \"created\": \"2002-11-12T09:30:07.309Z\",\n \"id\": \"urn:uuid:4002afe6-9a37-1afe-90b3-6469ae3b23f7\",\n \"verified_bank\": \"volupta\",\n \"verified_dnb\": \"ex sed\"\n },\n \"logo\": \"http://ZAjIK.fqsYXQdoG+wZ5QQCfanqf\",\n \"logo_name\": \"ut Excepteur\",\n \"id\": \"98016d9a-79af-3563-dfad-0798b9b8f266\"\n },\n \"uploaded_by_company_id\": \"c\",\n \"uploaded_by_company\": {\n \"name\": \"sunt reprehenderit nulla fugiat\",\n \"address\": \"sunt velit pariatur sint\",\n \"postal_code\": \"eu est\",\n \"city\": \"u\",\n \"branch\": \"ex labore occaecat pariatur\",\n \"address2\": \"elit\",\n \"country\": \"BZ\",\n \"country_name\": \"ess\",\n \"website\": \"sed nisi\",\n \"vat_number\": \"dolore\",\n \"logo\": \"http://dEvEyGdPRZH.moFfa8y5oFFEJPpSYgZfJqiYKY-EYYlfMtf0u--QBAk1zQY6J0B78d.2a7nE.Jzo3tE8Axjk5IN\",\n \"logo_name\": \"adipisici\",\n \"created\": \"2021-05-24T18:08:25.369Z\",\n \"id\": \"urn:uuid:e03908aa-0b17-9b00-2d25-75979850778f\",\n \"verified_bank\": \"Duis do nulla deserunt voluptate\",\n \"verified_dnb\": \"incididunt cupidatat nulla qui\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"dolore in\",\n \"create_on_blockchain\": false,\n \"accomplisher_id\": \"cillum velit aute occaecat\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"1998-04-29T16:24:41.608Z\",\n \"accomplished_by_id\": \"laborum aute dolore sunt\",\n \"accomplished_by_company_id\": \"velit sint pariatur nisi\",\n \"destroyed\": \"2006-10-01T06:37:51.953Z\",\n \"destroyed_by_company_id\": \"irure Ut eiusmod aute\",\n \"notify_parties\": [\n \"zD3dDANyjb@U.xb\",\n \"6jSQ6rP@sZALzfCgCLwOUX.tu\"\n ],\n \"meta_data\": {},\n \"display_name\": \"deserunt commodo eiusmod occaecat\",\n \"file_name\": \"deserunt anim veniam\",\n \"file_size\": 942397605,\n \"file_content_type\": \"do voluptate nostrud in\",\n \"watermarkable\": true,\n \"icon\": \"ullamco incididunt\",\n \"file_type\": \"occaecat aliquip\",\n \"created\": \"cillum enim laboris incididunt\",\n \"thumbnail\": \"https://VOwhldAlg.nbxPep,3ddvKoQLizWyx1NHHabjlausCxTw3py6q7G9,GGmnoi\",\n \"thumbnail_mime_type\": \"dolor aliquip proident aliqua incididunt\"\n },\n \"attachment_count\": -52712857,\n \"is_on_blockchain\": false,\n \"can_be_destroyed\": \"laboris qui tempor do\",\n \"can_be_accomplished\": \"amet pariatu\",\n \"destroy_pending\": \"nostrud ex\",\n \"accomplish_pending\": \"et do ut cillum Lorem\",\n \"created\": \"magna non nost\"\n },\n \"used_in_envelope_id\": \"sunt culpa voluptate\",\n \"used_in_envelope\": {\n \"id\": \"3b6db492-9574-711a-72f3-114128c452ce\",\n \"owner_id\": \"sed in pariatur\",\n \"recipient_id\": \"in cillum\",\n \"message\": \"quis ullamco\",\n \"type\": \"eu nisi commodo minim quis\",\n \"specialization_type\": \"standard\",\n \"created\": \"tempor ipsum\",\n \"sent\": \"1995-07-26T17:02:30.778Z\",\n \"archived\": \"1975-12-16T22:45:04.149Z\",\n \"delivered\": \"minim\",\n \"action_performed_by_id\": \"est tempor\",\n \"sealed\": false,\n \"can_be_sealed\": \"Ut ex culpa\",\n \"is_draft\": \"nisi in\",\n \"sender_inbox_id\": \"ad aliqua eiusmod\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"eu\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": true,\n \"delivered_envelope_id\": \"ut\",\n \"failed_delivery_envelope_id\": \"id Lorem Ut dolor\",\n \"failed_outgoing_id\": \"laboris nostrud\",\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"aute aliqua irure\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": true,\n \"created\": \"1970-07-20T07:24:45.498Z\"\n }\n ],\n \"delivered_envelope_id\": \"Ut consectetur\",\n \"failed_delivery_envelope_id\": \"Ut cillum ex nisi\",\n \"failed_outgoing_id\": \"do nisi Ut\",\n \"document_token_transactions\": [\n {\n \"tx_hash\": \"sit elit ullamco eu\",\n \"status\": 2,\n \"created\": \"1948-08-01T00:58:41.998Z\",\n \"mined\": \"1966-07-16T04:11:50.365Z\",\n \"etherscan_link\": \"quis ad\"\n },\n {\n \"tx_hash\": \"aute incididunt\",\n \"status\": 2,\n \"created\": \"1993-01-21T21:15:29.807Z\",\n \"mined\": \"1956-11-23T18:52:48.097Z\",\n \"etherscan_link\": \"nisi tempor fugiat\"\n }\n ],\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"tempor\",\n \"meta_data\": {},\n \"credits_spent_amount\": 3899833,\n \"credits_spent_for_documents\": -43248610,\n \"acid_number\": \"cupidatat deserunt dolor\",\n \"acid_verification_timeout\": \"veniam non velit eiusmod\",\n \"aci_filing_notification\": \"irure dolore et veniam\",\n \"is_first_acid_filing\": false\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company or envelope is not found.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Delete envelope", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] }, "description": "Deletes a single envelope entry of a user that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Returned when envelope is successfully deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company or envelope is not found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Envelope access", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/access/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "access", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" } ] }, "description": "\nThis endpoint tracks access to an envelope.\n" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/access/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "access", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:168e861d-d56a-2546-87ab-2a0d91d7b389\",\n \"owner_id\": \"voluptate sunt consequat ad ipsum\",\n \"recipient_id\": \"aliquip dolore laboris eiusmod\",\n \"message\": \"quis pariatur\",\n \"type\": \"irure cupidatat ad minim\",\n \"specialization_type\": \"standard\",\n \"created\": \"sit qui\",\n \"sent\": \"1998-04-24T04:50:20.680Z\",\n \"archived\": \"1987-02-09T04:14:10.914Z\",\n \"delivered\": \"in cupidatat anim\",\n \"action_performed_by_id\": \"labor\",\n \"action_performed_by\": {\n \"email\": \"X83k0beD9PAnv@qKqLUNuUIIBHztMkwOwMlclQ.rcm\",\n \"telephone\": \"est ex\",\n \"name\": \"laboris\",\n \"first_name\": \"sunt culpa\",\n \"last_name\": \"Lorem\",\n \"company_id\": \"fugiat\",\n \"company\": {\n \"name\": \"elit in reprehenderit sit anim\",\n \"address\": \"de\",\n \"postal_code\": \"nostrud exercitation irure commodo\",\n \"city\": \"laboris est nisi\",\n \"branch\": \"elit laboris irure\",\n \"address2\": \"aliqua non velit nulla esse\",\n \"country\": \"AZ\",\n \"country_name\": \"pariatur deserunt non\",\n \"website\": \"sint velit minim Excepteur fugiat\",\n \"vat_number\": \"quis eiusmod dol\",\n \"logo\": \"http://ByyCfnjAboaBQdUInoAesMRucA.sjoSB.E17yYl2Tp7l4uTnwoqAG3mG7vshOL\",\n \"logo_name\": \"cillum ipsum id anim\",\n \"created\": \"2002-04-27T22:22:49.781Z\",\n \"id\": \"urn:uuid:7bf94c3e-3467-6f54-bad1-3cc2262a4737\",\n \"verified_bank\": \"est ea qui\",\n \"verified_dnb\": \"nostrud velit\"\n },\n \"logo\": \"https://YMkDPLGSIYi.sbhqMoWzfcBz8WMKoRrkZJGYGE1icf8+Ev-Yu+sgu,OP4hWPITtI7wy.XShQuRy+jiYfJPwSzYRBS\",\n \"logo_name\": \"pariatur nisi\",\n \"id\": \"1fb0d2d6-5979-b24d-8094-f2a2bdc2e0dd\"\n },\n \"action_performed_by_company_id\": \"ullamco do\",\n \"action_performed_by_company\": {\n \"name\": \"eu qui\",\n \"address\": \"aliqua ipsum\",\n \"postal_code\": \"mollit sint qui sed\",\n \"city\": \"nulla cupidatat aliqua dolore\",\n \"branch\": \"consectetur Ut\",\n \"address2\": \"in ut\",\n \"country\": \"BE\",\n \"country_name\": \"voluptate anim enim nulla\",\n \"website\": \"in\",\n \"vat_number\": \"eiusmod\",\n \"logo\": \"https://r.frOBgvaabcEjDjIAhNjyivSPsHxloEg.\",\n \"logo_name\": \"irure cillum officia est\",\n \"created\": \"1974-05-12T17:22:23.041Z\",\n \"id\": \"f5947ce2-8722-e638-f9d8-83a24bba8b23\",\n \"verified_bank\": \"exercitation aliqua cupi\",\n \"verified_dnb\": \"dolore ad dolore\"\n },\n \"sealed\": false,\n \"can_be_sealed\": \"in irure non elit Lorem\",\n \"is_draft\": \"est nostrud reprehenderit consequ\",\n \"sender_inbox_id\": \"in elit sit fugiat\",\n \"sender\": {\n \"name\": \"adipisicing ad nostrud et\",\n \"address\": \"sit voluptate\",\n \"postal_code\": \"incididunt enim quis Duis ad\",\n \"city\": \"ad c\",\n \"branch\": \"nisi labore officia\",\n \"address2\": \"pariatur\",\n \"country\": \"YT\",\n \"country_name\": \"ullamco\",\n \"website\": \"ut mollit minim consectetur\",\n \"vat_number\": \"ullamco fugiat exercitation commodo non\",\n \"logo\": \"https://DUSPgY.etyp8fmjoiNkY3k.X4g24o.7EXnZnRVsqmENc+CApMlwy1nAQESHo\",\n \"logo_name\": \"ut velit v\",\n \"created\": \"2016-05-05T14:44:36.026Z\",\n \"id\": \"urn:uuid:ff2328b2-f1de-a199-b7d4-00125ce5928e\",\n \"verified_bank\": \"do proident\",\n \"verified_dnb\": \"eu cillum mollit\"\n },\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"irure culpa incididunt consectetur\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": true,\n \"read_by_user\": \"eiusmod tempor velit\",\n \"documents\": [\n \"incididunt irure enim fugiat reprehenderit\",\n \"laborum nisi esse sunt in\"\n ],\n \"existing_attachments\": {},\n \"attachments\": [\n {\n \"document_token_id\": \"quis deserunt esse irure\",\n \"id\": \"f44f76e5-5b80-f6f8-1240-6a229b426586\",\n \"envelope_id\": \"Duis sit\",\n \"document_token\": {\n \"id\": \"urn:uuid:99f6a1da-897e-f593-cbb8-062d8984342d\",\n \"storage_type\": \"veniam id velit\",\n \"watermark_generated\": true,\n \"ipfs_document_group_id\": \"sed dolore nostrud proident\",\n \"ipfs_document_group\": \"urn:uuid:deb979a4-8b4d-d2a1-db98-dbc264b3c53e\",\n \"document_id\": \"ut irure ex ullamco\",\n \"document\": {\n \"document_type\": \"ut magna proident officia\",\n \"create_on_blockchain_override\": false,\n \"id\": \"bfc5c81b-0ec4-dbd7-2019-24524033f0e2\",\n \"current_owner_id\": \"et occaecat deserunt commodo\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"cupidatat tempor ut\",\n \"uploaded_by\": {\n \"email\": \"KF0IU-dtNh-A@ryHdrBOLLQJmBFIFsMNi.wey\",\n \"telephone\": \"et in\",\n \"name\": \"consectetur sint\",\n \"first_name\": \"amet sed cillum nisi\",\n \"last_name\": \"Ut aliquip\",\n \"company_id\": \"\",\n \"company\": {\n \"name\": \"ullamco\",\n \"address\": \"officia\",\n \"postal_code\": \"dolore labore enim adipisicing\",\n \"city\": \"nisi incididunt\",\n \"branch\": \"sint\",\n \"address2\": \"incididunt\",\n \"country\": \"JE\",\n \"country_name\": \"in in\",\n \"website\": \"fugiat irure ut\",\n \"vat_number\": \"nisi quis\",\n \"logo\": \"http://HCCXvuGJCQrwveJnATVZFbvDEBAzTaUZ.ygISt\",\n \"logo_name\": \"qui\",\n \"created\": \"2006-07-08T09:50:01.259Z\",\n \"id\": \"urn:uuid:0e291c97-350a-509d-3f39-3b2bf689a234\",\n \"verified_bank\": \"non\",\n \"verified_dnb\": \"dolore cillum\"\n },\n \"logo\": \"https://xYzuxnBeIiwxAWzVhiU.qnqiTptCa5PeolHQIB3phfRLwnKKLM\",\n \"logo_name\": \"dolor officia dolo\",\n \"id\": \"6de3c248-8a84-2640-cb1c-7651b0ea0fea\"\n },\n \"uploaded_by_company_id\": \"Excepteur\",\n \"uploaded_by_company\": {\n \"name\": \"sit reprehenderit\",\n \"address\": \"pariatur irure commodo cillum\",\n \"postal_code\": \"proident exercita\",\n \"city\": \"qu\",\n \"branch\": \"ullamco aute laboris\",\n \"address2\": \"voluptate ut cupidatat\",\n \"country\": \"GT\",\n \"country_name\": \"sunt consequat proident\",\n \"website\": \"nostrud voluptate\",\n \"vat_number\": \"irure Ut deserunt\",\n \"logo\": \"http://DzlsBacyOdCdATdtDSKnxHWiOmT.qfoLE.8XnE.\",\n \"logo_name\": \"enim elit nisi minim do\",\n \"created\": \"2007-11-25T07:51:41.300Z\",\n \"id\": \"urn:uuid:e3c12e78-12fd-d400-c345-e426c07b6ffc\",\n \"verified_bank\": \"sunt elit\",\n \"verified_dnb\": \"nostrud aliquip\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"Duis anim do\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"velit anim\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"2021-02-17T03:27:43.628Z\",\n \"accomplished_by_id\": \"in exercitation\",\n \"accomplished_by_company_id\": \"irure fugiat Duis\",\n \"destroyed\": \"1952-12-31T02:09:39.808Z\",\n \"destroyed_by_company_id\": \"deserunt pariatur culpa\",\n \"notify_parties\": [\n \"eneyn@YdvVoFMVfZMctwByqcMtYgRQOoMPnkajh.jz\",\n \"AFYsemFV0hKm3@WURDItzsxhgagEekHUXeUOzkV.nd\"\n ],\n \"meta_data\": {},\n \"display_name\": \"cillum sunt aute\",\n \"file_name\": \"ipsum est\",\n \"file_size\": 1990310908,\n \"file_content_type\": \"Ut occaecat voluptate ut\",\n \"watermarkable\": false,\n \"icon\": \"incididunt tempor\",\n \"file_type\": \"quis reprehenderit dolor ullamco\",\n \"created\": \"culpa nulla sit sunt\",\n \"thumbnail\": \"http://hVooSPJxVuyTDMTWvoIDOvcoFmvvOxW.hslNrivwkR2PGZrudSYUiR2uvZfTUUdlRwEWDgZ+jUk1eZZ4bx5fRfHxCGHRTmU3zcHz82ajW9j38WgGIW\",\n \"thumbnail_mime_type\": \"amet in laborum sunt\"\n },\n \"attachment_count\": 87150649,\n \"is_on_blockchain\": true,\n \"can_be_destroyed\": \"laborum commodo Excepteur\",\n \"can_be_accomplished\": \"commodo\",\n \"destroy_pending\": \"ipsum\",\n \"accomplish_pending\": \"nostrud Excepteur sit ea officia\",\n \"created\": \"in dolo\"\n },\n \"used_in_envelope_id\": \"qui enim\",\n \"used_in_envelope\": {\n \"id\": \"urn:uuid:a52c3083-22a9-207e-5b30-72a897bca9b1\",\n \"owner_id\": \"nostrud cillum velit\",\n \"recipient_id\": \"ea \",\n \"message\": \"pariatur ad proident eiusmod\",\n \"type\": \"ad\",\n \"specialization_type\": \"acid\",\n \"created\": \"dolore nulla esse officia commodo\",\n \"sent\": \"2016-08-28T10:38:27.038Z\",\n \"archived\": \"1975-11-22T10:49:51.316Z\",\n \"delivered\": \"anim Duis officia\",\n \"action_performed_by_id\": \"minim ut n\",\n \"sealed\": false,\n \"can_be_sealed\": \"qui est ea fugiat in\",\n \"is_draft\": \"ullamco aute\",\n \"sender_inbox_id\": \"voluptate consequat eu cillum\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"Excepteur exercitation eu\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": false,\n \"delivered_envelope_id\": \"dolor\",\n \"failed_delivery_envelope_id\": \"ullamco\",\n \"failed_outgoing_id\": \"incididunt aliquip aute sint\",\n \"pay_to_collect\": false,\n \"pay_to_collect_response\": \"proident deserunt culpa laboris\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": false,\n \"created\": \"2017-10-24T06:34:16.689Z\"\n },\n {\n \"document_token_id\": \"mollit occaecat dolore\",\n \"id\": \"f4f75a40-3318-6d03-5218-f872bf07f0a6\",\n \"envelope_id\": \"amet commodo fugiat\",\n \"document_token\": {\n \"id\": \"urn:uuid:3c1a8eb8-c842-79d1-f811-61fb6f103779\",\n \"storage_type\": \"mollit ex\",\n \"watermark_generated\": false,\n \"ipfs_document_group_id\": \"dolore dolor ut ut\",\n \"ipfs_document_group\": \"9663bee0-ebbb-dc1d-c125-7108f519a27b\",\n \"document_id\": \"commodo deserunt magna sed\",\n \"document\": {\n \"document_type\": \"officia laboris cupidatat\",\n \"create_on_blockchain_override\": false,\n \"id\": \"urn:uuid:a348548b-ac11-247c-36a6-9aa30063d050\",\n \"current_owner_id\": \"deserunt dolore\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"irure\",\n \"uploaded_by\": {\n \"email\": \"ClEvMO43cc@BCeUlTGDVUc.gr\",\n \"telephone\": \"ea ullamco\",\n \"name\": \"nulla fugia\",\n \"first_name\": \"elit enim\",\n \"last_name\": \"amet reprehenderit\",\n \"company_id\": \"ad deserunt consequat sit\",\n \"company\": {\n \"name\": \"dolor officia exercitation\",\n \"address\": \"incididunt Excepteur\",\n \"postal_code\": \"ut id enim anim\",\n \"city\": \"proident sunt\",\n \"branch\": \"qui dolore in\",\n \"address2\": \"veniam\",\n \"country\": \"GT\",\n \"country_name\": \"ex ea dolor occaecat\",\n \"website\": \"occaecat ut labore\",\n \"vat_number\": \"in proident\",\n \"logo\": \"http://fwETkMNWGM.ehoTc3v7ct\",\n \"logo_name\": \"fugiat Duis nisi\",\n \"created\": \"2002-11-12T09:30:07.309Z\",\n \"id\": \"urn:uuid:4002afe6-9a37-1afe-90b3-6469ae3b23f7\",\n \"verified_bank\": \"volupta\",\n \"verified_dnb\": \"ex sed\"\n },\n \"logo\": \"http://ZAjIK.fqsYXQdoG+wZ5QQCfanqf\",\n \"logo_name\": \"ut Excepteur\",\n \"id\": \"98016d9a-79af-3563-dfad-0798b9b8f266\"\n },\n \"uploaded_by_company_id\": \"c\",\n \"uploaded_by_company\": {\n \"name\": \"sunt reprehenderit nulla fugiat\",\n \"address\": \"sunt velit pariatur sint\",\n \"postal_code\": \"eu est\",\n \"city\": \"u\",\n \"branch\": \"ex labore occaecat pariatur\",\n \"address2\": \"elit\",\n \"country\": \"BZ\",\n \"country_name\": \"ess\",\n \"website\": \"sed nisi\",\n \"vat_number\": \"dolore\",\n \"logo\": \"http://dEvEyGdPRZH.moFfa8y5oFFEJPpSYgZfJqiYKY-EYYlfMtf0u--QBAk1zQY6J0B78d.2a7nE.Jzo3tE8Axjk5IN\",\n \"logo_name\": \"adipisici\",\n \"created\": \"2021-05-24T18:08:25.369Z\",\n \"id\": \"urn:uuid:e03908aa-0b17-9b00-2d25-75979850778f\",\n \"verified_bank\": \"Duis do nulla deserunt voluptate\",\n \"verified_dnb\": \"incididunt cupidatat nulla qui\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"dolore in\",\n \"create_on_blockchain\": false,\n \"accomplisher_id\": \"cillum velit aute occaecat\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"1998-04-29T16:24:41.608Z\",\n \"accomplished_by_id\": \"laborum aute dolore sunt\",\n \"accomplished_by_company_id\": \"velit sint pariatur nisi\",\n \"destroyed\": \"2006-10-01T06:37:51.953Z\",\n \"destroyed_by_company_id\": \"irure Ut eiusmod aute\",\n \"notify_parties\": [\n \"zD3dDANyjb@U.xb\",\n \"6jSQ6rP@sZALzfCgCLwOUX.tu\"\n ],\n \"meta_data\": {},\n \"display_name\": \"deserunt commodo eiusmod occaecat\",\n \"file_name\": \"deserunt anim veniam\",\n \"file_size\": 942397605,\n \"file_content_type\": \"do voluptate nostrud in\",\n \"watermarkable\": true,\n \"icon\": \"ullamco incididunt\",\n \"file_type\": \"occaecat aliquip\",\n \"created\": \"cillum enim laboris incididunt\",\n \"thumbnail\": \"https://VOwhldAlg.nbxPep,3ddvKoQLizWyx1NHHabjlausCxTw3py6q7G9,GGmnoi\",\n \"thumbnail_mime_type\": \"dolor aliquip proident aliqua incididunt\"\n },\n \"attachment_count\": -52712857,\n \"is_on_blockchain\": false,\n \"can_be_destroyed\": \"laboris qui tempor do\",\n \"can_be_accomplished\": \"amet pariatu\",\n \"destroy_pending\": \"nostrud ex\",\n \"accomplish_pending\": \"et do ut cillum Lorem\",\n \"created\": \"magna non nost\"\n },\n \"used_in_envelope_id\": \"sunt culpa voluptate\",\n \"used_in_envelope\": {\n \"id\": \"3b6db492-9574-711a-72f3-114128c452ce\",\n \"owner_id\": \"sed in pariatur\",\n \"recipient_id\": \"in cillum\",\n \"message\": \"quis ullamco\",\n \"type\": \"eu nisi commodo minim quis\",\n \"specialization_type\": \"standard\",\n \"created\": \"tempor ipsum\",\n \"sent\": \"1995-07-26T17:02:30.778Z\",\n \"archived\": \"1975-12-16T22:45:04.149Z\",\n \"delivered\": \"minim\",\n \"action_performed_by_id\": \"est tempor\",\n \"sealed\": false,\n \"can_be_sealed\": \"Ut ex culpa\",\n \"is_draft\": \"nisi in\",\n \"sender_inbox_id\": \"ad aliqua eiusmod\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"eu\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": true,\n \"delivered_envelope_id\": \"ut\",\n \"failed_delivery_envelope_id\": \"id Lorem Ut dolor\",\n \"failed_outgoing_id\": \"laboris nostrud\",\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"aute aliqua irure\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": true,\n \"created\": \"1970-07-20T07:24:45.498Z\"\n }\n ],\n \"delivered_envelope_id\": \"Ut consectetur\",\n \"failed_delivery_envelope_id\": \"Ut cillum ex nisi\",\n \"failed_outgoing_id\": \"do nisi Ut\",\n \"document_token_transactions\": [\n {\n \"tx_hash\": \"sit elit ullamco eu\",\n \"status\": 2,\n \"created\": \"1948-08-01T00:58:41.998Z\",\n \"mined\": \"1966-07-16T04:11:50.365Z\",\n \"etherscan_link\": \"quis ad\"\n },\n {\n \"tx_hash\": \"aute incididunt\",\n \"status\": 2,\n \"created\": \"1993-01-21T21:15:29.807Z\",\n \"mined\": \"1956-11-23T18:52:48.097Z\",\n \"etherscan_link\": \"nisi tempor fugiat\"\n }\n ],\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"tempor\",\n \"meta_data\": {},\n \"credits_spent_amount\": 3899833,\n \"credits_spent_for_documents\": -43248610,\n \"acid_number\": \"cupidatat deserunt dolor\",\n \"acid_verification_timeout\": \"veniam non velit eiusmod\",\n \"aci_filing_notification\": \"irure dolore et veniam\",\n \"is_first_acid_filing\": false\n}" }, { "name": "Returned when the authenticated user is not a 3rd-party company.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/access/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "access", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Download envelope attachments", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/download-documents/?packageFormat=ZIP&attachmentIds[]=", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "download-documents", "" ], "query": [ { "key": "packageFormat", "value": "ZIP", "description": "\nThe packageFormat parameter determines the merged document format. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------|\n| `PDF` | Documents will me merged into a single PDF file if possible. |\n| `ZIP` | Documents will be packaged into a ZIP archive. |\n" }, { "key": "attachmentIds[]", "value": "", "description": "\nA list of Attachment object IDs that determines which attachments will be included in the file download. \n" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" } ] }, "description": "\nThis endpoint returns all (or a given subset of) envelope attachments packaged in a ZIP file or merged in a single PDF file.\nPDF file can only be generated if all (or a given subset of) attachments are either a PDF or an image.\n" }, "response": [ { "name": "Returns all (or a given subset of) envelope attachments packaged into a ZIP file or merged into a single PDF file.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/download-documents/?packageFormat=ZIP&attachmentIds[]=", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "download-documents", "" ], "query": [ { "key": "packageFormat", "value": "ZIP" }, { "key": "attachmentIds[]", "value": "" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when the authenticated user does not have access to this resource.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/download-documents/?packageFormat=ZIP&attachmentIds[]=", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "download-documents", "" ], "query": [ { "key": "packageFormat", "value": "ZIP" }, { "key": "attachmentIds[]", "value": "" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned if the resource is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/download-documents/?packageFormat=ZIP&attachmentIds[]=", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "download-documents", "" ], "query": [ { "key": "packageFormat", "value": "ZIP" }, { "key": "attachmentIds[]", "value": "" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned if all (or a given subset of) envelope attachments can't be merged into a PDF file.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/download-documents/?packageFormat=ZIP&attachmentIds[]=", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "download-documents", "" ], "query": [ { "key": "packageFormat", "value": "ZIP" }, { "key": "attachmentIds[]", "value": "" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" } ] } }, "code": 470, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Envelope workflow", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "action", "value": "issue", "description": "(Required) \nThis is the action identifier parameter. Below is the description of all possible actions:\n\n**Generate issue hash** \n*Parameter name:* `\"generate_issue_hash\"` \nGenerates an issue hash to be signed by the issuing party. The endpoint\n will return an error if the envelope is not sealed or user has insufficient permissions.\n\n---\n\n**Generate transfer hash** \n*Parameter name:* `\"generate_transfer_hash\"` \nGenerates a transfer hash to be signed by the transferring party. The endpoint\n will return an error if the envelope is signed or user has insufficient permissions.\n\n---\n\n**Generate release hash** \n*Parameter name:* `\"generate_release_hash\"` \nGenerates a transfer hash to be signed by the release agent. The endpoint\n will return an error if the envelope cannot be released.\n\n---\n\n**Generate destroy hash** \n*Parameter name:* `\"generate_destroy_hash\"` \nGenerates a transfer hash to be signed by the party that wishes to destroy the envelope.\n\n---\n\n**Issue** \n*Parameter name:* `\"issue\"` \nIssue description\n\n---\n\n**Transfer** \n*Parameter name:* `\"transfer\"` \nTransfer description\n\n---\n\n**Release** \n*Parameter name:* `\"release\"` \nRelease description\n\n---\n\n**Destroy** \n*Parameter name:* `\"destroy\"` \nDestroy description\n\n---\n\n**Archive** \n*Parameter name:* `\"archive\"` \nArchive description\n\n---\n\n**Unarchive** \n*Parameter name:* `\"unarchive\"` \nUnarchive description\n" } ] }, "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/workflow/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "workflow", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] }, "description": "This endpoint executes workflows or actions on a specific envelope." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "action", "value": "issue", "description": "(Required) \nThis is the action identifier parameter. Below is the description of all possible actions:\n\n**Generate issue hash** \n*Parameter name:* `\"generate_issue_hash\"` \nGenerates an issue hash to be signed by the issuing party. The endpoint\n will return an error if the envelope is not sealed or user has insufficient permissions.\n\n---\n\n**Generate transfer hash** \n*Parameter name:* `\"generate_transfer_hash\"` \nGenerates a transfer hash to be signed by the transferring party. The endpoint\n will return an error if the envelope is signed or user has insufficient permissions.\n\n---\n\n**Generate release hash** \n*Parameter name:* `\"generate_release_hash\"` \nGenerates a transfer hash to be signed by the release agent. The endpoint\n will return an error if the envelope cannot be released.\n\n---\n\n**Generate destroy hash** \n*Parameter name:* `\"generate_destroy_hash\"` \nGenerates a transfer hash to be signed by the party that wishes to destroy the envelope.\n\n---\n\n**Issue** \n*Parameter name:* `\"issue\"` \nIssue description\n\n---\n\n**Transfer** \n*Parameter name:* `\"transfer\"` \nTransfer description\n\n---\n\n**Release** \n*Parameter name:* `\"release\"` \nRelease description\n\n---\n\n**Destroy** \n*Parameter name:* `\"destroy\"` \nDestroy description\n\n---\n\n**Archive** \n*Parameter name:* `\"archive\"` \nArchive description\n\n---\n\n**Unarchive** \n*Parameter name:* `\"unarchive\"` \nUnarchive description\n" } ] }, "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/workflow/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "workflow", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Returned when the authenticated user is not a 3rd-party company.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "action", "value": "issue", "description": "(Required) \nThis is the action identifier parameter. Below is the description of all possible actions:\n\n**Generate issue hash** \n*Parameter name:* `\"generate_issue_hash\"` \nGenerates an issue hash to be signed by the issuing party. The endpoint\n will return an error if the envelope is not sealed or user has insufficient permissions.\n\n---\n\n**Generate transfer hash** \n*Parameter name:* `\"generate_transfer_hash\"` \nGenerates a transfer hash to be signed by the transferring party. The endpoint\n will return an error if the envelope is signed or user has insufficient permissions.\n\n---\n\n**Generate release hash** \n*Parameter name:* `\"generate_release_hash\"` \nGenerates a transfer hash to be signed by the release agent. The endpoint\n will return an error if the envelope cannot be released.\n\n---\n\n**Generate destroy hash** \n*Parameter name:* `\"generate_destroy_hash\"` \nGenerates a transfer hash to be signed by the party that wishes to destroy the envelope.\n\n---\n\n**Issue** \n*Parameter name:* `\"issue\"` \nIssue description\n\n---\n\n**Transfer** \n*Parameter name:* `\"transfer\"` \nTransfer description\n\n---\n\n**Release** \n*Parameter name:* `\"release\"` \nRelease description\n\n---\n\n**Destroy** \n*Parameter name:* `\"destroy\"` \nDestroy description\n\n---\n\n**Archive** \n*Parameter name:* `\"archive\"` \nArchive description\n\n---\n\n**Unarchive** \n*Parameter name:* `\"unarchive\"` \nUnarchive description\n" } ] }, "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/:envelope/workflow/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", ":envelope", "workflow", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Create envelope", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] }, "description": "Creates a new envelope draft for a company that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:168e861d-d56a-2546-87ab-2a0d91d7b389\",\n \"owner_id\": \"voluptate sunt consequat ad ipsum\",\n \"recipient_id\": \"aliquip dolore laboris eiusmod\",\n \"message\": \"quis pariatur\",\n \"type\": \"irure cupidatat ad minim\",\n \"specialization_type\": \"standard\",\n \"created\": \"sit qui\",\n \"sent\": \"1998-04-24T04:50:20.680Z\",\n \"archived\": \"1987-02-09T04:14:10.914Z\",\n \"delivered\": \"in cupidatat anim\",\n \"action_performed_by_id\": \"labor\",\n \"action_performed_by\": {\n \"email\": \"X83k0beD9PAnv@qKqLUNuUIIBHztMkwOwMlclQ.rcm\",\n \"telephone\": \"est ex\",\n \"name\": \"laboris\",\n \"first_name\": \"sunt culpa\",\n \"last_name\": \"Lorem\",\n \"company_id\": \"fugiat\",\n \"company\": {\n \"name\": \"elit in reprehenderit sit anim\",\n \"address\": \"de\",\n \"postal_code\": \"nostrud exercitation irure commodo\",\n \"city\": \"laboris est nisi\",\n \"branch\": \"elit laboris irure\",\n \"address2\": \"aliqua non velit nulla esse\",\n \"country\": \"AZ\",\n \"country_name\": \"pariatur deserunt non\",\n \"website\": \"sint velit minim Excepteur fugiat\",\n \"vat_number\": \"quis eiusmod dol\",\n \"logo\": \"http://ByyCfnjAboaBQdUInoAesMRucA.sjoSB.E17yYl2Tp7l4uTnwoqAG3mG7vshOL\",\n \"logo_name\": \"cillum ipsum id anim\",\n \"created\": \"2002-04-27T22:22:49.781Z\",\n \"id\": \"urn:uuid:7bf94c3e-3467-6f54-bad1-3cc2262a4737\",\n \"verified_bank\": \"est ea qui\",\n \"verified_dnb\": \"nostrud velit\"\n },\n \"logo\": \"https://YMkDPLGSIYi.sbhqMoWzfcBz8WMKoRrkZJGYGE1icf8+Ev-Yu+sgu,OP4hWPITtI7wy.XShQuRy+jiYfJPwSzYRBS\",\n \"logo_name\": \"pariatur nisi\",\n \"id\": \"1fb0d2d6-5979-b24d-8094-f2a2bdc2e0dd\"\n },\n \"action_performed_by_company_id\": \"ullamco do\",\n \"action_performed_by_company\": {\n \"name\": \"eu qui\",\n \"address\": \"aliqua ipsum\",\n \"postal_code\": \"mollit sint qui sed\",\n \"city\": \"nulla cupidatat aliqua dolore\",\n \"branch\": \"consectetur Ut\",\n \"address2\": \"in ut\",\n \"country\": \"BE\",\n \"country_name\": \"voluptate anim enim nulla\",\n \"website\": \"in\",\n \"vat_number\": \"eiusmod\",\n \"logo\": \"https://r.frOBgvaabcEjDjIAhNjyivSPsHxloEg.\",\n \"logo_name\": \"irure cillum officia est\",\n \"created\": \"1974-05-12T17:22:23.041Z\",\n \"id\": \"f5947ce2-8722-e638-f9d8-83a24bba8b23\",\n \"verified_bank\": \"exercitation aliqua cupi\",\n \"verified_dnb\": \"dolore ad dolore\"\n },\n \"sealed\": false,\n \"can_be_sealed\": \"in irure non elit Lorem\",\n \"is_draft\": \"est nostrud reprehenderit consequ\",\n \"sender_inbox_id\": \"in elit sit fugiat\",\n \"sender\": {\n \"name\": \"adipisicing ad nostrud et\",\n \"address\": \"sit voluptate\",\n \"postal_code\": \"incididunt enim quis Duis ad\",\n \"city\": \"ad c\",\n \"branch\": \"nisi labore officia\",\n \"address2\": \"pariatur\",\n \"country\": \"YT\",\n \"country_name\": \"ullamco\",\n \"website\": \"ut mollit minim consectetur\",\n \"vat_number\": \"ullamco fugiat exercitation commodo non\",\n \"logo\": \"https://DUSPgY.etyp8fmjoiNkY3k.X4g24o.7EXnZnRVsqmENc+CApMlwy1nAQESHo\",\n \"logo_name\": \"ut velit v\",\n \"created\": \"2016-05-05T14:44:36.026Z\",\n \"id\": \"urn:uuid:ff2328b2-f1de-a199-b7d4-00125ce5928e\",\n \"verified_bank\": \"do proident\",\n \"verified_dnb\": \"eu cillum mollit\"\n },\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"irure culpa incididunt consectetur\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": true,\n \"read_by_user\": \"eiusmod tempor velit\",\n \"documents\": [\n \"incididunt irure enim fugiat reprehenderit\",\n \"laborum nisi esse sunt in\"\n ],\n \"existing_attachments\": {},\n \"attachments\": [\n {\n \"document_token_id\": \"quis deserunt esse irure\",\n \"id\": \"f44f76e5-5b80-f6f8-1240-6a229b426586\",\n \"envelope_id\": \"Duis sit\",\n \"document_token\": {\n \"id\": \"urn:uuid:99f6a1da-897e-f593-cbb8-062d8984342d\",\n \"storage_type\": \"veniam id velit\",\n \"watermark_generated\": true,\n \"ipfs_document_group_id\": \"sed dolore nostrud proident\",\n \"ipfs_document_group\": \"urn:uuid:deb979a4-8b4d-d2a1-db98-dbc264b3c53e\",\n \"document_id\": \"ut irure ex ullamco\",\n \"document\": {\n \"document_type\": \"ut magna proident officia\",\n \"create_on_blockchain_override\": false,\n \"id\": \"bfc5c81b-0ec4-dbd7-2019-24524033f0e2\",\n \"current_owner_id\": \"et occaecat deserunt commodo\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"cupidatat tempor ut\",\n \"uploaded_by\": {\n \"email\": \"KF0IU-dtNh-A@ryHdrBOLLQJmBFIFsMNi.wey\",\n \"telephone\": \"et in\",\n \"name\": \"consectetur sint\",\n \"first_name\": \"amet sed cillum nisi\",\n \"last_name\": \"Ut aliquip\",\n \"company_id\": \"\",\n \"company\": {\n \"name\": \"ullamco\",\n \"address\": \"officia\",\n \"postal_code\": \"dolore labore enim adipisicing\",\n \"city\": \"nisi incididunt\",\n \"branch\": \"sint\",\n \"address2\": \"incididunt\",\n \"country\": \"JE\",\n \"country_name\": \"in in\",\n \"website\": \"fugiat irure ut\",\n \"vat_number\": \"nisi quis\",\n \"logo\": \"http://HCCXvuGJCQrwveJnATVZFbvDEBAzTaUZ.ygISt\",\n \"logo_name\": \"qui\",\n \"created\": \"2006-07-08T09:50:01.259Z\",\n \"id\": \"urn:uuid:0e291c97-350a-509d-3f39-3b2bf689a234\",\n \"verified_bank\": \"non\",\n \"verified_dnb\": \"dolore cillum\"\n },\n \"logo\": \"https://xYzuxnBeIiwxAWzVhiU.qnqiTptCa5PeolHQIB3phfRLwnKKLM\",\n \"logo_name\": \"dolor officia dolo\",\n \"id\": \"6de3c248-8a84-2640-cb1c-7651b0ea0fea\"\n },\n \"uploaded_by_company_id\": \"Excepteur\",\n \"uploaded_by_company\": {\n \"name\": \"sit reprehenderit\",\n \"address\": \"pariatur irure commodo cillum\",\n \"postal_code\": \"proident exercita\",\n \"city\": \"qu\",\n \"branch\": \"ullamco aute laboris\",\n \"address2\": \"voluptate ut cupidatat\",\n \"country\": \"GT\",\n \"country_name\": \"sunt consequat proident\",\n \"website\": \"nostrud voluptate\",\n \"vat_number\": \"irure Ut deserunt\",\n \"logo\": \"http://DzlsBacyOdCdATdtDSKnxHWiOmT.qfoLE.8XnE.\",\n \"logo_name\": \"enim elit nisi minim do\",\n \"created\": \"2007-11-25T07:51:41.300Z\",\n \"id\": \"urn:uuid:e3c12e78-12fd-d400-c345-e426c07b6ffc\",\n \"verified_bank\": \"sunt elit\",\n \"verified_dnb\": \"nostrud aliquip\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"Duis anim do\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"velit anim\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"2021-02-17T03:27:43.628Z\",\n \"accomplished_by_id\": \"in exercitation\",\n \"accomplished_by_company_id\": \"irure fugiat Duis\",\n \"destroyed\": \"1952-12-31T02:09:39.808Z\",\n \"destroyed_by_company_id\": \"deserunt pariatur culpa\",\n \"notify_parties\": [\n \"eneyn@YdvVoFMVfZMctwByqcMtYgRQOoMPnkajh.jz\",\n \"AFYsemFV0hKm3@WURDItzsxhgagEekHUXeUOzkV.nd\"\n ],\n \"meta_data\": {},\n \"display_name\": \"cillum sunt aute\",\n \"file_name\": \"ipsum est\",\n \"file_size\": 1990310908,\n \"file_content_type\": \"Ut occaecat voluptate ut\",\n \"watermarkable\": false,\n \"icon\": \"incididunt tempor\",\n \"file_type\": \"quis reprehenderit dolor ullamco\",\n \"created\": \"culpa nulla sit sunt\",\n \"thumbnail\": \"http://hVooSPJxVuyTDMTWvoIDOvcoFmvvOxW.hslNrivwkR2PGZrudSYUiR2uvZfTUUdlRwEWDgZ+jUk1eZZ4bx5fRfHxCGHRTmU3zcHz82ajW9j38WgGIW\",\n \"thumbnail_mime_type\": \"amet in laborum sunt\"\n },\n \"attachment_count\": 87150649,\n \"is_on_blockchain\": true,\n \"can_be_destroyed\": \"laborum commodo Excepteur\",\n \"can_be_accomplished\": \"commodo\",\n \"destroy_pending\": \"ipsum\",\n \"accomplish_pending\": \"nostrud Excepteur sit ea officia\",\n \"created\": \"in dolo\"\n },\n \"used_in_envelope_id\": \"qui enim\",\n \"used_in_envelope\": {\n \"id\": \"urn:uuid:a52c3083-22a9-207e-5b30-72a897bca9b1\",\n \"owner_id\": \"nostrud cillum velit\",\n \"recipient_id\": \"ea \",\n \"message\": \"pariatur ad proident eiusmod\",\n \"type\": \"ad\",\n \"specialization_type\": \"acid\",\n \"created\": \"dolore nulla esse officia commodo\",\n \"sent\": \"2016-08-28T10:38:27.038Z\",\n \"archived\": \"1975-11-22T10:49:51.316Z\",\n \"delivered\": \"anim Duis officia\",\n \"action_performed_by_id\": \"minim ut n\",\n \"sealed\": false,\n \"can_be_sealed\": \"qui est ea fugiat in\",\n \"is_draft\": \"ullamco aute\",\n \"sender_inbox_id\": \"voluptate consequat eu cillum\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"Excepteur exercitation eu\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": false,\n \"delivered_envelope_id\": \"dolor\",\n \"failed_delivery_envelope_id\": \"ullamco\",\n \"failed_outgoing_id\": \"incididunt aliquip aute sint\",\n \"pay_to_collect\": false,\n \"pay_to_collect_response\": \"proident deserunt culpa laboris\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": false,\n \"created\": \"2017-10-24T06:34:16.689Z\"\n },\n {\n \"document_token_id\": \"mollit occaecat dolore\",\n \"id\": \"f4f75a40-3318-6d03-5218-f872bf07f0a6\",\n \"envelope_id\": \"amet commodo fugiat\",\n \"document_token\": {\n \"id\": \"urn:uuid:3c1a8eb8-c842-79d1-f811-61fb6f103779\",\n \"storage_type\": \"mollit ex\",\n \"watermark_generated\": false,\n \"ipfs_document_group_id\": \"dolore dolor ut ut\",\n \"ipfs_document_group\": \"9663bee0-ebbb-dc1d-c125-7108f519a27b\",\n \"document_id\": \"commodo deserunt magna sed\",\n \"document\": {\n \"document_type\": \"officia laboris cupidatat\",\n \"create_on_blockchain_override\": false,\n \"id\": \"urn:uuid:a348548b-ac11-247c-36a6-9aa30063d050\",\n \"current_owner_id\": \"deserunt dolore\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"irure\",\n \"uploaded_by\": {\n \"email\": \"ClEvMO43cc@BCeUlTGDVUc.gr\",\n \"telephone\": \"ea ullamco\",\n \"name\": \"nulla fugia\",\n \"first_name\": \"elit enim\",\n \"last_name\": \"amet reprehenderit\",\n \"company_id\": \"ad deserunt consequat sit\",\n \"company\": {\n \"name\": \"dolor officia exercitation\",\n \"address\": \"incididunt Excepteur\",\n \"postal_code\": \"ut id enim anim\",\n \"city\": \"proident sunt\",\n \"branch\": \"qui dolore in\",\n \"address2\": \"veniam\",\n \"country\": \"GT\",\n \"country_name\": \"ex ea dolor occaecat\",\n \"website\": \"occaecat ut labore\",\n \"vat_number\": \"in proident\",\n \"logo\": \"http://fwETkMNWGM.ehoTc3v7ct\",\n \"logo_name\": \"fugiat Duis nisi\",\n \"created\": \"2002-11-12T09:30:07.309Z\",\n \"id\": \"urn:uuid:4002afe6-9a37-1afe-90b3-6469ae3b23f7\",\n \"verified_bank\": \"volupta\",\n \"verified_dnb\": \"ex sed\"\n },\n \"logo\": \"http://ZAjIK.fqsYXQdoG+wZ5QQCfanqf\",\n \"logo_name\": \"ut Excepteur\",\n \"id\": \"98016d9a-79af-3563-dfad-0798b9b8f266\"\n },\n \"uploaded_by_company_id\": \"c\",\n \"uploaded_by_company\": {\n \"name\": \"sunt reprehenderit nulla fugiat\",\n \"address\": \"sunt velit pariatur sint\",\n \"postal_code\": \"eu est\",\n \"city\": \"u\",\n \"branch\": \"ex labore occaecat pariatur\",\n \"address2\": \"elit\",\n \"country\": \"BZ\",\n \"country_name\": \"ess\",\n \"website\": \"sed nisi\",\n \"vat_number\": \"dolore\",\n \"logo\": \"http://dEvEyGdPRZH.moFfa8y5oFFEJPpSYgZfJqiYKY-EYYlfMtf0u--QBAk1zQY6J0B78d.2a7nE.Jzo3tE8Axjk5IN\",\n \"logo_name\": \"adipisici\",\n \"created\": \"2021-05-24T18:08:25.369Z\",\n \"id\": \"urn:uuid:e03908aa-0b17-9b00-2d25-75979850778f\",\n \"verified_bank\": \"Duis do nulla deserunt voluptate\",\n \"verified_dnb\": \"incididunt cupidatat nulla qui\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"dolore in\",\n \"create_on_blockchain\": false,\n \"accomplisher_id\": \"cillum velit aute occaecat\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"1998-04-29T16:24:41.608Z\",\n \"accomplished_by_id\": \"laborum aute dolore sunt\",\n \"accomplished_by_company_id\": \"velit sint pariatur nisi\",\n \"destroyed\": \"2006-10-01T06:37:51.953Z\",\n \"destroyed_by_company_id\": \"irure Ut eiusmod aute\",\n \"notify_parties\": [\n \"zD3dDANyjb@U.xb\",\n \"6jSQ6rP@sZALzfCgCLwOUX.tu\"\n ],\n \"meta_data\": {},\n \"display_name\": \"deserunt commodo eiusmod occaecat\",\n \"file_name\": \"deserunt anim veniam\",\n \"file_size\": 942397605,\n \"file_content_type\": \"do voluptate nostrud in\",\n \"watermarkable\": true,\n \"icon\": \"ullamco incididunt\",\n \"file_type\": \"occaecat aliquip\",\n \"created\": \"cillum enim laboris incididunt\",\n \"thumbnail\": \"https://VOwhldAlg.nbxPep,3ddvKoQLizWyx1NHHabjlausCxTw3py6q7G9,GGmnoi\",\n \"thumbnail_mime_type\": \"dolor aliquip proident aliqua incididunt\"\n },\n \"attachment_count\": -52712857,\n \"is_on_blockchain\": false,\n \"can_be_destroyed\": \"laboris qui tempor do\",\n \"can_be_accomplished\": \"amet pariatu\",\n \"destroy_pending\": \"nostrud ex\",\n \"accomplish_pending\": \"et do ut cillum Lorem\",\n \"created\": \"magna non nost\"\n },\n \"used_in_envelope_id\": \"sunt culpa voluptate\",\n \"used_in_envelope\": {\n \"id\": \"3b6db492-9574-711a-72f3-114128c452ce\",\n \"owner_id\": \"sed in pariatur\",\n \"recipient_id\": \"in cillum\",\n \"message\": \"quis ullamco\",\n \"type\": \"eu nisi commodo minim quis\",\n \"specialization_type\": \"standard\",\n \"created\": \"tempor ipsum\",\n \"sent\": \"1995-07-26T17:02:30.778Z\",\n \"archived\": \"1975-12-16T22:45:04.149Z\",\n \"delivered\": \"minim\",\n \"action_performed_by_id\": \"est tempor\",\n \"sealed\": false,\n \"can_be_sealed\": \"Ut ex culpa\",\n \"is_draft\": \"nisi in\",\n \"sender_inbox_id\": \"ad aliqua eiusmod\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"eu\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": true,\n \"delivered_envelope_id\": \"ut\",\n \"failed_delivery_envelope_id\": \"id Lorem Ut dolor\",\n \"failed_outgoing_id\": \"laboris nostrud\",\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"aute aliqua irure\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": true,\n \"created\": \"1970-07-20T07:24:45.498Z\"\n }\n ],\n \"delivered_envelope_id\": \"Ut consectetur\",\n \"failed_delivery_envelope_id\": \"Ut cillum ex nisi\",\n \"failed_outgoing_id\": \"do nisi Ut\",\n \"document_token_transactions\": [\n {\n \"tx_hash\": \"sit elit ullamco eu\",\n \"status\": 2,\n \"created\": \"1948-08-01T00:58:41.998Z\",\n \"mined\": \"1966-07-16T04:11:50.365Z\",\n \"etherscan_link\": \"quis ad\"\n },\n {\n \"tx_hash\": \"aute incididunt\",\n \"status\": 2,\n \"created\": \"1993-01-21T21:15:29.807Z\",\n \"mined\": \"1956-11-23T18:52:48.097Z\",\n \"etherscan_link\": \"nisi tempor fugiat\"\n }\n ],\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"tempor\",\n \"meta_data\": {},\n \"credits_spent_amount\": 3899833,\n \"credits_spent_for_documents\": -43248610,\n \"acid_number\": \"cupidatat deserunt dolor\",\n \"acid_verification_timeout\": \"veniam non velit eiusmod\",\n \"aci_filing_notification\": \"irure dolore et veniam\",\n \"is_first_acid_filing\": false\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Envelope count endpoint", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/counts/?ordering=cons&search=cons&limit=35678520&offset=35678520", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "counts", "" ], "query": [ { "key": "ordering", "value": "cons" }, { "key": "search", "value": "cons", "description": "A search term." }, { "key": "limit", "value": "35678520", "description": "Number of results to return per page." }, { "key": "offset", "value": "35678520", "description": "The initial index from which to return the results." } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] }, "description": "\nThis endpoint returns a envelope counts for all lists.\n" }, "response": [ { "name": "Returns a JSON object with count result", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/counts/?ordering=cons&search=cons&limit=35678520&offset=35678520", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "counts", "" ], "query": [ { "key": "ordering", "value": "cons" }, { "key": "search", "value": "cons" }, { "key": "limit", "value": "35678520" }, { "key": "offset", "value": "35678520" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when the authenticated user is not a 3rd-party company.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/counts/?ordering=cons&search=cons&limit=35678520&offset=35678520", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "counts", "" ], "query": [ { "key": "ordering", "value": "cons" }, { "key": "search", "value": "cons" }, { "key": "limit", "value": "35678520" }, { "key": "offset", "value": "35678520" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Envelope custom list", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/custom-list/?ordering=cons&search=cons&limit=35678520&offset=35678520", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "custom-list", "" ], "query": [ { "key": "ordering", "value": "cons" }, { "key": "search", "value": "cons", "description": "A search term." }, { "key": "limit", "value": "35678520", "description": "Number of results to return per page." }, { "key": "offset", "value": "35678520", "description": "The initial index from which to return the results." } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" } ] }, "description": "\nThis endpoint returns a custom list of envelopes.\n" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/custom-list/?ordering=cons&search=cons&limit=35678520&offset=35678520", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "custom-list", "" ], "query": [ { "key": "ordering", "value": "cons" }, { "key": "search", "value": "cons" }, { "key": "limit", "value": "35678520" }, { "key": "offset", "value": "35678520" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:168e861d-d56a-2546-87ab-2a0d91d7b389\",\n \"owner_id\": \"voluptate sunt consequat ad ipsum\",\n \"recipient_id\": \"aliquip dolore laboris eiusmod\",\n \"message\": \"quis pariatur\",\n \"type\": \"irure cupidatat ad minim\",\n \"specialization_type\": \"standard\",\n \"created\": \"sit qui\",\n \"sent\": \"1998-04-24T04:50:20.680Z\",\n \"archived\": \"1987-02-09T04:14:10.914Z\",\n \"delivered\": \"in cupidatat anim\",\n \"action_performed_by_id\": \"labor\",\n \"action_performed_by\": {\n \"email\": \"X83k0beD9PAnv@qKqLUNuUIIBHztMkwOwMlclQ.rcm\",\n \"telephone\": \"est ex\",\n \"name\": \"laboris\",\n \"first_name\": \"sunt culpa\",\n \"last_name\": \"Lorem\",\n \"company_id\": \"fugiat\",\n \"company\": {\n \"name\": \"elit in reprehenderit sit anim\",\n \"address\": \"de\",\n \"postal_code\": \"nostrud exercitation irure commodo\",\n \"city\": \"laboris est nisi\",\n \"branch\": \"elit laboris irure\",\n \"address2\": \"aliqua non velit nulla esse\",\n \"country\": \"AZ\",\n \"country_name\": \"pariatur deserunt non\",\n \"website\": \"sint velit minim Excepteur fugiat\",\n \"vat_number\": \"quis eiusmod dol\",\n \"logo\": \"http://ByyCfnjAboaBQdUInoAesMRucA.sjoSB.E17yYl2Tp7l4uTnwoqAG3mG7vshOL\",\n \"logo_name\": \"cillum ipsum id anim\",\n \"created\": \"2002-04-27T22:22:49.781Z\",\n \"id\": \"urn:uuid:7bf94c3e-3467-6f54-bad1-3cc2262a4737\",\n \"verified_bank\": \"est ea qui\",\n \"verified_dnb\": \"nostrud velit\"\n },\n \"logo\": \"https://YMkDPLGSIYi.sbhqMoWzfcBz8WMKoRrkZJGYGE1icf8+Ev-Yu+sgu,OP4hWPITtI7wy.XShQuRy+jiYfJPwSzYRBS\",\n \"logo_name\": \"pariatur nisi\",\n \"id\": \"1fb0d2d6-5979-b24d-8094-f2a2bdc2e0dd\"\n },\n \"action_performed_by_company_id\": \"ullamco do\",\n \"action_performed_by_company\": {\n \"name\": \"eu qui\",\n \"address\": \"aliqua ipsum\",\n \"postal_code\": \"mollit sint qui sed\",\n \"city\": \"nulla cupidatat aliqua dolore\",\n \"branch\": \"consectetur Ut\",\n \"address2\": \"in ut\",\n \"country\": \"BE\",\n \"country_name\": \"voluptate anim enim nulla\",\n \"website\": \"in\",\n \"vat_number\": \"eiusmod\",\n \"logo\": \"https://r.frOBgvaabcEjDjIAhNjyivSPsHxloEg.\",\n \"logo_name\": \"irure cillum officia est\",\n \"created\": \"1974-05-12T17:22:23.041Z\",\n \"id\": \"f5947ce2-8722-e638-f9d8-83a24bba8b23\",\n \"verified_bank\": \"exercitation aliqua cupi\",\n \"verified_dnb\": \"dolore ad dolore\"\n },\n \"sealed\": false,\n \"can_be_sealed\": \"in irure non elit Lorem\",\n \"is_draft\": \"est nostrud reprehenderit consequ\",\n \"sender_inbox_id\": \"in elit sit fugiat\",\n \"sender\": {\n \"name\": \"adipisicing ad nostrud et\",\n \"address\": \"sit voluptate\",\n \"postal_code\": \"incididunt enim quis Duis ad\",\n \"city\": \"ad c\",\n \"branch\": \"nisi labore officia\",\n \"address2\": \"pariatur\",\n \"country\": \"YT\",\n \"country_name\": \"ullamco\",\n \"website\": \"ut mollit minim consectetur\",\n \"vat_number\": \"ullamco fugiat exercitation commodo non\",\n \"logo\": \"https://DUSPgY.etyp8fmjoiNkY3k.X4g24o.7EXnZnRVsqmENc+CApMlwy1nAQESHo\",\n \"logo_name\": \"ut velit v\",\n \"created\": \"2016-05-05T14:44:36.026Z\",\n \"id\": \"urn:uuid:ff2328b2-f1de-a199-b7d4-00125ce5928e\",\n \"verified_bank\": \"do proident\",\n \"verified_dnb\": \"eu cillum mollit\"\n },\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"irure culpa incididunt consectetur\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": true,\n \"read_by_user\": \"eiusmod tempor velit\",\n \"documents\": [\n \"incididunt irure enim fugiat reprehenderit\",\n \"laborum nisi esse sunt in\"\n ],\n \"existing_attachments\": {},\n \"attachments\": [\n {\n \"document_token_id\": \"quis deserunt esse irure\",\n \"id\": \"f44f76e5-5b80-f6f8-1240-6a229b426586\",\n \"envelope_id\": \"Duis sit\",\n \"document_token\": {\n \"id\": \"urn:uuid:99f6a1da-897e-f593-cbb8-062d8984342d\",\n \"storage_type\": \"veniam id velit\",\n \"watermark_generated\": true,\n \"ipfs_document_group_id\": \"sed dolore nostrud proident\",\n \"ipfs_document_group\": \"urn:uuid:deb979a4-8b4d-d2a1-db98-dbc264b3c53e\",\n \"document_id\": \"ut irure ex ullamco\",\n \"document\": {\n \"document_type\": \"ut magna proident officia\",\n \"create_on_blockchain_override\": false,\n \"id\": \"bfc5c81b-0ec4-dbd7-2019-24524033f0e2\",\n \"current_owner_id\": \"et occaecat deserunt commodo\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"cupidatat tempor ut\",\n \"uploaded_by\": {\n \"email\": \"KF0IU-dtNh-A@ryHdrBOLLQJmBFIFsMNi.wey\",\n \"telephone\": \"et in\",\n \"name\": \"consectetur sint\",\n \"first_name\": \"amet sed cillum nisi\",\n \"last_name\": \"Ut aliquip\",\n \"company_id\": \"\",\n \"company\": {\n \"name\": \"ullamco\",\n \"address\": \"officia\",\n \"postal_code\": \"dolore labore enim adipisicing\",\n \"city\": \"nisi incididunt\",\n \"branch\": \"sint\",\n \"address2\": \"incididunt\",\n \"country\": \"JE\",\n \"country_name\": \"in in\",\n \"website\": \"fugiat irure ut\",\n \"vat_number\": \"nisi quis\",\n \"logo\": \"http://HCCXvuGJCQrwveJnATVZFbvDEBAzTaUZ.ygISt\",\n \"logo_name\": \"qui\",\n \"created\": \"2006-07-08T09:50:01.259Z\",\n \"id\": \"urn:uuid:0e291c97-350a-509d-3f39-3b2bf689a234\",\n \"verified_bank\": \"non\",\n \"verified_dnb\": \"dolore cillum\"\n },\n \"logo\": \"https://xYzuxnBeIiwxAWzVhiU.qnqiTptCa5PeolHQIB3phfRLwnKKLM\",\n \"logo_name\": \"dolor officia dolo\",\n \"id\": \"6de3c248-8a84-2640-cb1c-7651b0ea0fea\"\n },\n \"uploaded_by_company_id\": \"Excepteur\",\n \"uploaded_by_company\": {\n \"name\": \"sit reprehenderit\",\n \"address\": \"pariatur irure commodo cillum\",\n \"postal_code\": \"proident exercita\",\n \"city\": \"qu\",\n \"branch\": \"ullamco aute laboris\",\n \"address2\": \"voluptate ut cupidatat\",\n \"country\": \"GT\",\n \"country_name\": \"sunt consequat proident\",\n \"website\": \"nostrud voluptate\",\n \"vat_number\": \"irure Ut deserunt\",\n \"logo\": \"http://DzlsBacyOdCdATdtDSKnxHWiOmT.qfoLE.8XnE.\",\n \"logo_name\": \"enim elit nisi minim do\",\n \"created\": \"2007-11-25T07:51:41.300Z\",\n \"id\": \"urn:uuid:e3c12e78-12fd-d400-c345-e426c07b6ffc\",\n \"verified_bank\": \"sunt elit\",\n \"verified_dnb\": \"nostrud aliquip\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"Duis anim do\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"velit anim\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"2021-02-17T03:27:43.628Z\",\n \"accomplished_by_id\": \"in exercitation\",\n \"accomplished_by_company_id\": \"irure fugiat Duis\",\n \"destroyed\": \"1952-12-31T02:09:39.808Z\",\n \"destroyed_by_company_id\": \"deserunt pariatur culpa\",\n \"notify_parties\": [\n \"eneyn@YdvVoFMVfZMctwByqcMtYgRQOoMPnkajh.jz\",\n \"AFYsemFV0hKm3@WURDItzsxhgagEekHUXeUOzkV.nd\"\n ],\n \"meta_data\": {},\n \"display_name\": \"cillum sunt aute\",\n \"file_name\": \"ipsum est\",\n \"file_size\": 1990310908,\n \"file_content_type\": \"Ut occaecat voluptate ut\",\n \"watermarkable\": false,\n \"icon\": \"incididunt tempor\",\n \"file_type\": \"quis reprehenderit dolor ullamco\",\n \"created\": \"culpa nulla sit sunt\",\n \"thumbnail\": \"http://hVooSPJxVuyTDMTWvoIDOvcoFmvvOxW.hslNrivwkR2PGZrudSYUiR2uvZfTUUdlRwEWDgZ+jUk1eZZ4bx5fRfHxCGHRTmU3zcHz82ajW9j38WgGIW\",\n \"thumbnail_mime_type\": \"amet in laborum sunt\"\n },\n \"attachment_count\": 87150649,\n \"is_on_blockchain\": true,\n \"can_be_destroyed\": \"laborum commodo Excepteur\",\n \"can_be_accomplished\": \"commodo\",\n \"destroy_pending\": \"ipsum\",\n \"accomplish_pending\": \"nostrud Excepteur sit ea officia\",\n \"created\": \"in dolo\"\n },\n \"used_in_envelope_id\": \"qui enim\",\n \"used_in_envelope\": {\n \"id\": \"urn:uuid:a52c3083-22a9-207e-5b30-72a897bca9b1\",\n \"owner_id\": \"nostrud cillum velit\",\n \"recipient_id\": \"ea \",\n \"message\": \"pariatur ad proident eiusmod\",\n \"type\": \"ad\",\n \"specialization_type\": \"acid\",\n \"created\": \"dolore nulla esse officia commodo\",\n \"sent\": \"2016-08-28T10:38:27.038Z\",\n \"archived\": \"1975-11-22T10:49:51.316Z\",\n \"delivered\": \"anim Duis officia\",\n \"action_performed_by_id\": \"minim ut n\",\n \"sealed\": false,\n \"can_be_sealed\": \"qui est ea fugiat in\",\n \"is_draft\": \"ullamco aute\",\n \"sender_inbox_id\": \"voluptate consequat eu cillum\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"Excepteur exercitation eu\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": false,\n \"delivered_envelope_id\": \"dolor\",\n \"failed_delivery_envelope_id\": \"ullamco\",\n \"failed_outgoing_id\": \"incididunt aliquip aute sint\",\n \"pay_to_collect\": false,\n \"pay_to_collect_response\": \"proident deserunt culpa laboris\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": false,\n \"created\": \"2017-10-24T06:34:16.689Z\"\n },\n {\n \"document_token_id\": \"mollit occaecat dolore\",\n \"id\": \"f4f75a40-3318-6d03-5218-f872bf07f0a6\",\n \"envelope_id\": \"amet commodo fugiat\",\n \"document_token\": {\n \"id\": \"urn:uuid:3c1a8eb8-c842-79d1-f811-61fb6f103779\",\n \"storage_type\": \"mollit ex\",\n \"watermark_generated\": false,\n \"ipfs_document_group_id\": \"dolore dolor ut ut\",\n \"ipfs_document_group\": \"9663bee0-ebbb-dc1d-c125-7108f519a27b\",\n \"document_id\": \"commodo deserunt magna sed\",\n \"document\": {\n \"document_type\": \"officia laboris cupidatat\",\n \"create_on_blockchain_override\": false,\n \"id\": \"urn:uuid:a348548b-ac11-247c-36a6-9aa30063d050\",\n \"current_owner_id\": \"deserunt dolore\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"irure\",\n \"uploaded_by\": {\n \"email\": \"ClEvMO43cc@BCeUlTGDVUc.gr\",\n \"telephone\": \"ea ullamco\",\n \"name\": \"nulla fugia\",\n \"first_name\": \"elit enim\",\n \"last_name\": \"amet reprehenderit\",\n \"company_id\": \"ad deserunt consequat sit\",\n \"company\": {\n \"name\": \"dolor officia exercitation\",\n \"address\": \"incididunt Excepteur\",\n \"postal_code\": \"ut id enim anim\",\n \"city\": \"proident sunt\",\n \"branch\": \"qui dolore in\",\n \"address2\": \"veniam\",\n \"country\": \"GT\",\n \"country_name\": \"ex ea dolor occaecat\",\n \"website\": \"occaecat ut labore\",\n \"vat_number\": \"in proident\",\n \"logo\": \"http://fwETkMNWGM.ehoTc3v7ct\",\n \"logo_name\": \"fugiat Duis nisi\",\n \"created\": \"2002-11-12T09:30:07.309Z\",\n \"id\": \"urn:uuid:4002afe6-9a37-1afe-90b3-6469ae3b23f7\",\n \"verified_bank\": \"volupta\",\n \"verified_dnb\": \"ex sed\"\n },\n \"logo\": \"http://ZAjIK.fqsYXQdoG+wZ5QQCfanqf\",\n \"logo_name\": \"ut Excepteur\",\n \"id\": \"98016d9a-79af-3563-dfad-0798b9b8f266\"\n },\n \"uploaded_by_company_id\": \"c\",\n \"uploaded_by_company\": {\n \"name\": \"sunt reprehenderit nulla fugiat\",\n \"address\": \"sunt velit pariatur sint\",\n \"postal_code\": \"eu est\",\n \"city\": \"u\",\n \"branch\": \"ex labore occaecat pariatur\",\n \"address2\": \"elit\",\n \"country\": \"BZ\",\n \"country_name\": \"ess\",\n \"website\": \"sed nisi\",\n \"vat_number\": \"dolore\",\n \"logo\": \"http://dEvEyGdPRZH.moFfa8y5oFFEJPpSYgZfJqiYKY-EYYlfMtf0u--QBAk1zQY6J0B78d.2a7nE.Jzo3tE8Axjk5IN\",\n \"logo_name\": \"adipisici\",\n \"created\": \"2021-05-24T18:08:25.369Z\",\n \"id\": \"urn:uuid:e03908aa-0b17-9b00-2d25-75979850778f\",\n \"verified_bank\": \"Duis do nulla deserunt voluptate\",\n \"verified_dnb\": \"incididunt cupidatat nulla qui\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"dolore in\",\n \"create_on_blockchain\": false,\n \"accomplisher_id\": \"cillum velit aute occaecat\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"1998-04-29T16:24:41.608Z\",\n \"accomplished_by_id\": \"laborum aute dolore sunt\",\n \"accomplished_by_company_id\": \"velit sint pariatur nisi\",\n \"destroyed\": \"2006-10-01T06:37:51.953Z\",\n \"destroyed_by_company_id\": \"irure Ut eiusmod aute\",\n \"notify_parties\": [\n \"zD3dDANyjb@U.xb\",\n \"6jSQ6rP@sZALzfCgCLwOUX.tu\"\n ],\n \"meta_data\": {},\n \"display_name\": \"deserunt commodo eiusmod occaecat\",\n \"file_name\": \"deserunt anim veniam\",\n \"file_size\": 942397605,\n \"file_content_type\": \"do voluptate nostrud in\",\n \"watermarkable\": true,\n \"icon\": \"ullamco incididunt\",\n \"file_type\": \"occaecat aliquip\",\n \"created\": \"cillum enim laboris incididunt\",\n \"thumbnail\": \"https://VOwhldAlg.nbxPep,3ddvKoQLizWyx1NHHabjlausCxTw3py6q7G9,GGmnoi\",\n \"thumbnail_mime_type\": \"dolor aliquip proident aliqua incididunt\"\n },\n \"attachment_count\": -52712857,\n \"is_on_blockchain\": false,\n \"can_be_destroyed\": \"laboris qui tempor do\",\n \"can_be_accomplished\": \"amet pariatu\",\n \"destroy_pending\": \"nostrud ex\",\n \"accomplish_pending\": \"et do ut cillum Lorem\",\n \"created\": \"magna non nost\"\n },\n \"used_in_envelope_id\": \"sunt culpa voluptate\",\n \"used_in_envelope\": {\n \"id\": \"3b6db492-9574-711a-72f3-114128c452ce\",\n \"owner_id\": \"sed in pariatur\",\n \"recipient_id\": \"in cillum\",\n \"message\": \"quis ullamco\",\n \"type\": \"eu nisi commodo minim quis\",\n \"specialization_type\": \"standard\",\n \"created\": \"tempor ipsum\",\n \"sent\": \"1995-07-26T17:02:30.778Z\",\n \"archived\": \"1975-12-16T22:45:04.149Z\",\n \"delivered\": \"minim\",\n \"action_performed_by_id\": \"est tempor\",\n \"sealed\": false,\n \"can_be_sealed\": \"Ut ex culpa\",\n \"is_draft\": \"nisi in\",\n \"sender_inbox_id\": \"ad aliqua eiusmod\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"eu\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": true,\n \"delivered_envelope_id\": \"ut\",\n \"failed_delivery_envelope_id\": \"id Lorem Ut dolor\",\n \"failed_outgoing_id\": \"laboris nostrud\",\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"aute aliqua irure\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": true,\n \"created\": \"1970-07-20T07:24:45.498Z\"\n }\n ],\n \"delivered_envelope_id\": \"Ut consectetur\",\n \"failed_delivery_envelope_id\": \"Ut cillum ex nisi\",\n \"failed_outgoing_id\": \"do nisi Ut\",\n \"document_token_transactions\": [\n {\n \"tx_hash\": \"sit elit ullamco eu\",\n \"status\": 2,\n \"created\": \"1948-08-01T00:58:41.998Z\",\n \"mined\": \"1966-07-16T04:11:50.365Z\",\n \"etherscan_link\": \"quis ad\"\n },\n {\n \"tx_hash\": \"aute incididunt\",\n \"status\": 2,\n \"created\": \"1993-01-21T21:15:29.807Z\",\n \"mined\": \"1956-11-23T18:52:48.097Z\",\n \"etherscan_link\": \"nisi tempor fugiat\"\n }\n ],\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"tempor\",\n \"meta_data\": {},\n \"credits_spent_amount\": 3899833,\n \"credits_spent_for_documents\": -43248610,\n \"acid_number\": \"cupidatat deserunt dolor\",\n \"acid_verification_timeout\": \"veniam non velit eiusmod\",\n \"aci_filing_notification\": \"irure dolore et veniam\",\n \"is_first_acid_filing\": false\n}" }, { "name": "Returned when the authenticated user is not a 3rd-party company.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/custom-list/?ordering=cons&search=cons&limit=35678520&offset=35678520", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "custom-list", "" ], "query": [ { "key": "ordering", "value": "cons" }, { "key": "search", "value": "cons" }, { "key": "limit", "value": "35678520" }, { "key": "offset", "value": "35678520" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Envelope latest list", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/latest/?ordering=cons&search=cons&limit=35678520&offset=35678520", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "latest", "" ], "query": [ { "key": "ordering", "value": "cons" }, { "key": "search", "value": "cons", "description": "A search term." }, { "key": "limit", "value": "35678520", "description": "Number of results to return per page." }, { "key": "offset", "value": "35678520", "description": "The initial index from which to return the results." } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" } ] }, "description": "\nThis endpoint returns 50 latest envelopes.\n" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/latest/?ordering=cons&search=cons&limit=35678520&offset=35678520", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "latest", "" ], "query": [ { "key": "ordering", "value": "cons" }, { "key": "search", "value": "cons" }, { "key": "limit", "value": "35678520" }, { "key": "offset", "value": "35678520" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:168e861d-d56a-2546-87ab-2a0d91d7b389\",\n \"owner_id\": \"voluptate sunt consequat ad ipsum\",\n \"recipient_id\": \"aliquip dolore laboris eiusmod\",\n \"message\": \"quis pariatur\",\n \"type\": \"irure cupidatat ad minim\",\n \"specialization_type\": \"standard\",\n \"created\": \"sit qui\",\n \"sent\": \"1998-04-24T04:50:20.680Z\",\n \"archived\": \"1987-02-09T04:14:10.914Z\",\n \"delivered\": \"in cupidatat anim\",\n \"action_performed_by_id\": \"labor\",\n \"action_performed_by\": {\n \"email\": \"X83k0beD9PAnv@qKqLUNuUIIBHztMkwOwMlclQ.rcm\",\n \"telephone\": \"est ex\",\n \"name\": \"laboris\",\n \"first_name\": \"sunt culpa\",\n \"last_name\": \"Lorem\",\n \"company_id\": \"fugiat\",\n \"company\": {\n \"name\": \"elit in reprehenderit sit anim\",\n \"address\": \"de\",\n \"postal_code\": \"nostrud exercitation irure commodo\",\n \"city\": \"laboris est nisi\",\n \"branch\": \"elit laboris irure\",\n \"address2\": \"aliqua non velit nulla esse\",\n \"country\": \"AZ\",\n \"country_name\": \"pariatur deserunt non\",\n \"website\": \"sint velit minim Excepteur fugiat\",\n \"vat_number\": \"quis eiusmod dol\",\n \"logo\": \"http://ByyCfnjAboaBQdUInoAesMRucA.sjoSB.E17yYl2Tp7l4uTnwoqAG3mG7vshOL\",\n \"logo_name\": \"cillum ipsum id anim\",\n \"created\": \"2002-04-27T22:22:49.781Z\",\n \"id\": \"urn:uuid:7bf94c3e-3467-6f54-bad1-3cc2262a4737\",\n \"verified_bank\": \"est ea qui\",\n \"verified_dnb\": \"nostrud velit\"\n },\n \"logo\": \"https://YMkDPLGSIYi.sbhqMoWzfcBz8WMKoRrkZJGYGE1icf8+Ev-Yu+sgu,OP4hWPITtI7wy.XShQuRy+jiYfJPwSzYRBS\",\n \"logo_name\": \"pariatur nisi\",\n \"id\": \"1fb0d2d6-5979-b24d-8094-f2a2bdc2e0dd\"\n },\n \"action_performed_by_company_id\": \"ullamco do\",\n \"action_performed_by_company\": {\n \"name\": \"eu qui\",\n \"address\": \"aliqua ipsum\",\n \"postal_code\": \"mollit sint qui sed\",\n \"city\": \"nulla cupidatat aliqua dolore\",\n \"branch\": \"consectetur Ut\",\n \"address2\": \"in ut\",\n \"country\": \"BE\",\n \"country_name\": \"voluptate anim enim nulla\",\n \"website\": \"in\",\n \"vat_number\": \"eiusmod\",\n \"logo\": \"https://r.frOBgvaabcEjDjIAhNjyivSPsHxloEg.\",\n \"logo_name\": \"irure cillum officia est\",\n \"created\": \"1974-05-12T17:22:23.041Z\",\n \"id\": \"f5947ce2-8722-e638-f9d8-83a24bba8b23\",\n \"verified_bank\": \"exercitation aliqua cupi\",\n \"verified_dnb\": \"dolore ad dolore\"\n },\n \"sealed\": false,\n \"can_be_sealed\": \"in irure non elit Lorem\",\n \"is_draft\": \"est nostrud reprehenderit consequ\",\n \"sender_inbox_id\": \"in elit sit fugiat\",\n \"sender\": {\n \"name\": \"adipisicing ad nostrud et\",\n \"address\": \"sit voluptate\",\n \"postal_code\": \"incididunt enim quis Duis ad\",\n \"city\": \"ad c\",\n \"branch\": \"nisi labore officia\",\n \"address2\": \"pariatur\",\n \"country\": \"YT\",\n \"country_name\": \"ullamco\",\n \"website\": \"ut mollit minim consectetur\",\n \"vat_number\": \"ullamco fugiat exercitation commodo non\",\n \"logo\": \"https://DUSPgY.etyp8fmjoiNkY3k.X4g24o.7EXnZnRVsqmENc+CApMlwy1nAQESHo\",\n \"logo_name\": \"ut velit v\",\n \"created\": \"2016-05-05T14:44:36.026Z\",\n \"id\": \"urn:uuid:ff2328b2-f1de-a199-b7d4-00125ce5928e\",\n \"verified_bank\": \"do proident\",\n \"verified_dnb\": \"eu cillum mollit\"\n },\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"irure culpa incididunt consectetur\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": true,\n \"read_by_user\": \"eiusmod tempor velit\",\n \"documents\": [\n \"incididunt irure enim fugiat reprehenderit\",\n \"laborum nisi esse sunt in\"\n ],\n \"existing_attachments\": {},\n \"attachments\": [\n {\n \"document_token_id\": \"quis deserunt esse irure\",\n \"id\": \"f44f76e5-5b80-f6f8-1240-6a229b426586\",\n \"envelope_id\": \"Duis sit\",\n \"document_token\": {\n \"id\": \"urn:uuid:99f6a1da-897e-f593-cbb8-062d8984342d\",\n \"storage_type\": \"veniam id velit\",\n \"watermark_generated\": true,\n \"ipfs_document_group_id\": \"sed dolore nostrud proident\",\n \"ipfs_document_group\": \"urn:uuid:deb979a4-8b4d-d2a1-db98-dbc264b3c53e\",\n \"document_id\": \"ut irure ex ullamco\",\n \"document\": {\n \"document_type\": \"ut magna proident officia\",\n \"create_on_blockchain_override\": false,\n \"id\": \"bfc5c81b-0ec4-dbd7-2019-24524033f0e2\",\n \"current_owner_id\": \"et occaecat deserunt commodo\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"cupidatat tempor ut\",\n \"uploaded_by\": {\n \"email\": \"KF0IU-dtNh-A@ryHdrBOLLQJmBFIFsMNi.wey\",\n \"telephone\": \"et in\",\n \"name\": \"consectetur sint\",\n \"first_name\": \"amet sed cillum nisi\",\n \"last_name\": \"Ut aliquip\",\n \"company_id\": \"\",\n \"company\": {\n \"name\": \"ullamco\",\n \"address\": \"officia\",\n \"postal_code\": \"dolore labore enim adipisicing\",\n \"city\": \"nisi incididunt\",\n \"branch\": \"sint\",\n \"address2\": \"incididunt\",\n \"country\": \"JE\",\n \"country_name\": \"in in\",\n \"website\": \"fugiat irure ut\",\n \"vat_number\": \"nisi quis\",\n \"logo\": \"http://HCCXvuGJCQrwveJnATVZFbvDEBAzTaUZ.ygISt\",\n \"logo_name\": \"qui\",\n \"created\": \"2006-07-08T09:50:01.259Z\",\n \"id\": \"urn:uuid:0e291c97-350a-509d-3f39-3b2bf689a234\",\n \"verified_bank\": \"non\",\n \"verified_dnb\": \"dolore cillum\"\n },\n \"logo\": \"https://xYzuxnBeIiwxAWzVhiU.qnqiTptCa5PeolHQIB3phfRLwnKKLM\",\n \"logo_name\": \"dolor officia dolo\",\n \"id\": \"6de3c248-8a84-2640-cb1c-7651b0ea0fea\"\n },\n \"uploaded_by_company_id\": \"Excepteur\",\n \"uploaded_by_company\": {\n \"name\": \"sit reprehenderit\",\n \"address\": \"pariatur irure commodo cillum\",\n \"postal_code\": \"proident exercita\",\n \"city\": \"qu\",\n \"branch\": \"ullamco aute laboris\",\n \"address2\": \"voluptate ut cupidatat\",\n \"country\": \"GT\",\n \"country_name\": \"sunt consequat proident\",\n \"website\": \"nostrud voluptate\",\n \"vat_number\": \"irure Ut deserunt\",\n \"logo\": \"http://DzlsBacyOdCdATdtDSKnxHWiOmT.qfoLE.8XnE.\",\n \"logo_name\": \"enim elit nisi minim do\",\n \"created\": \"2007-11-25T07:51:41.300Z\",\n \"id\": \"urn:uuid:e3c12e78-12fd-d400-c345-e426c07b6ffc\",\n \"verified_bank\": \"sunt elit\",\n \"verified_dnb\": \"nostrud aliquip\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"Duis anim do\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"velit anim\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"2021-02-17T03:27:43.628Z\",\n \"accomplished_by_id\": \"in exercitation\",\n \"accomplished_by_company_id\": \"irure fugiat Duis\",\n \"destroyed\": \"1952-12-31T02:09:39.808Z\",\n \"destroyed_by_company_id\": \"deserunt pariatur culpa\",\n \"notify_parties\": [\n \"eneyn@YdvVoFMVfZMctwByqcMtYgRQOoMPnkajh.jz\",\n \"AFYsemFV0hKm3@WURDItzsxhgagEekHUXeUOzkV.nd\"\n ],\n \"meta_data\": {},\n \"display_name\": \"cillum sunt aute\",\n \"file_name\": \"ipsum est\",\n \"file_size\": 1990310908,\n \"file_content_type\": \"Ut occaecat voluptate ut\",\n \"watermarkable\": false,\n \"icon\": \"incididunt tempor\",\n \"file_type\": \"quis reprehenderit dolor ullamco\",\n \"created\": \"culpa nulla sit sunt\",\n \"thumbnail\": \"http://hVooSPJxVuyTDMTWvoIDOvcoFmvvOxW.hslNrivwkR2PGZrudSYUiR2uvZfTUUdlRwEWDgZ+jUk1eZZ4bx5fRfHxCGHRTmU3zcHz82ajW9j38WgGIW\",\n \"thumbnail_mime_type\": \"amet in laborum sunt\"\n },\n \"attachment_count\": 87150649,\n \"is_on_blockchain\": true,\n \"can_be_destroyed\": \"laborum commodo Excepteur\",\n \"can_be_accomplished\": \"commodo\",\n \"destroy_pending\": \"ipsum\",\n \"accomplish_pending\": \"nostrud Excepteur sit ea officia\",\n \"created\": \"in dolo\"\n },\n \"used_in_envelope_id\": \"qui enim\",\n \"used_in_envelope\": {\n \"id\": \"urn:uuid:a52c3083-22a9-207e-5b30-72a897bca9b1\",\n \"owner_id\": \"nostrud cillum velit\",\n \"recipient_id\": \"ea \",\n \"message\": \"pariatur ad proident eiusmod\",\n \"type\": \"ad\",\n \"specialization_type\": \"acid\",\n \"created\": \"dolore nulla esse officia commodo\",\n \"sent\": \"2016-08-28T10:38:27.038Z\",\n \"archived\": \"1975-11-22T10:49:51.316Z\",\n \"delivered\": \"anim Duis officia\",\n \"action_performed_by_id\": \"minim ut n\",\n \"sealed\": false,\n \"can_be_sealed\": \"qui est ea fugiat in\",\n \"is_draft\": \"ullamco aute\",\n \"sender_inbox_id\": \"voluptate consequat eu cillum\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"Excepteur exercitation eu\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": false,\n \"delivered_envelope_id\": \"dolor\",\n \"failed_delivery_envelope_id\": \"ullamco\",\n \"failed_outgoing_id\": \"incididunt aliquip aute sint\",\n \"pay_to_collect\": false,\n \"pay_to_collect_response\": \"proident deserunt culpa laboris\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": false,\n \"created\": \"2017-10-24T06:34:16.689Z\"\n },\n {\n \"document_token_id\": \"mollit occaecat dolore\",\n \"id\": \"f4f75a40-3318-6d03-5218-f872bf07f0a6\",\n \"envelope_id\": \"amet commodo fugiat\",\n \"document_token\": {\n \"id\": \"urn:uuid:3c1a8eb8-c842-79d1-f811-61fb6f103779\",\n \"storage_type\": \"mollit ex\",\n \"watermark_generated\": false,\n \"ipfs_document_group_id\": \"dolore dolor ut ut\",\n \"ipfs_document_group\": \"9663bee0-ebbb-dc1d-c125-7108f519a27b\",\n \"document_id\": \"commodo deserunt magna sed\",\n \"document\": {\n \"document_type\": \"officia laboris cupidatat\",\n \"create_on_blockchain_override\": false,\n \"id\": \"urn:uuid:a348548b-ac11-247c-36a6-9aa30063d050\",\n \"current_owner_id\": \"deserunt dolore\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"irure\",\n \"uploaded_by\": {\n \"email\": \"ClEvMO43cc@BCeUlTGDVUc.gr\",\n \"telephone\": \"ea ullamco\",\n \"name\": \"nulla fugia\",\n \"first_name\": \"elit enim\",\n \"last_name\": \"amet reprehenderit\",\n \"company_id\": \"ad deserunt consequat sit\",\n \"company\": {\n \"name\": \"dolor officia exercitation\",\n \"address\": \"incididunt Excepteur\",\n \"postal_code\": \"ut id enim anim\",\n \"city\": \"proident sunt\",\n \"branch\": \"qui dolore in\",\n \"address2\": \"veniam\",\n \"country\": \"GT\",\n \"country_name\": \"ex ea dolor occaecat\",\n \"website\": \"occaecat ut labore\",\n \"vat_number\": \"in proident\",\n \"logo\": \"http://fwETkMNWGM.ehoTc3v7ct\",\n \"logo_name\": \"fugiat Duis nisi\",\n \"created\": \"2002-11-12T09:30:07.309Z\",\n \"id\": \"urn:uuid:4002afe6-9a37-1afe-90b3-6469ae3b23f7\",\n \"verified_bank\": \"volupta\",\n \"verified_dnb\": \"ex sed\"\n },\n \"logo\": \"http://ZAjIK.fqsYXQdoG+wZ5QQCfanqf\",\n \"logo_name\": \"ut Excepteur\",\n \"id\": \"98016d9a-79af-3563-dfad-0798b9b8f266\"\n },\n \"uploaded_by_company_id\": \"c\",\n \"uploaded_by_company\": {\n \"name\": \"sunt reprehenderit nulla fugiat\",\n \"address\": \"sunt velit pariatur sint\",\n \"postal_code\": \"eu est\",\n \"city\": \"u\",\n \"branch\": \"ex labore occaecat pariatur\",\n \"address2\": \"elit\",\n \"country\": \"BZ\",\n \"country_name\": \"ess\",\n \"website\": \"sed nisi\",\n \"vat_number\": \"dolore\",\n \"logo\": \"http://dEvEyGdPRZH.moFfa8y5oFFEJPpSYgZfJqiYKY-EYYlfMtf0u--QBAk1zQY6J0B78d.2a7nE.Jzo3tE8Axjk5IN\",\n \"logo_name\": \"adipisici\",\n \"created\": \"2021-05-24T18:08:25.369Z\",\n \"id\": \"urn:uuid:e03908aa-0b17-9b00-2d25-75979850778f\",\n \"verified_bank\": \"Duis do nulla deserunt voluptate\",\n \"verified_dnb\": \"incididunt cupidatat nulla qui\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"dolore in\",\n \"create_on_blockchain\": false,\n \"accomplisher_id\": \"cillum velit aute occaecat\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"1998-04-29T16:24:41.608Z\",\n \"accomplished_by_id\": \"laborum aute dolore sunt\",\n \"accomplished_by_company_id\": \"velit sint pariatur nisi\",\n \"destroyed\": \"2006-10-01T06:37:51.953Z\",\n \"destroyed_by_company_id\": \"irure Ut eiusmod aute\",\n \"notify_parties\": [\n \"zD3dDANyjb@U.xb\",\n \"6jSQ6rP@sZALzfCgCLwOUX.tu\"\n ],\n \"meta_data\": {},\n \"display_name\": \"deserunt commodo eiusmod occaecat\",\n \"file_name\": \"deserunt anim veniam\",\n \"file_size\": 942397605,\n \"file_content_type\": \"do voluptate nostrud in\",\n \"watermarkable\": true,\n \"icon\": \"ullamco incididunt\",\n \"file_type\": \"occaecat aliquip\",\n \"created\": \"cillum enim laboris incididunt\",\n \"thumbnail\": \"https://VOwhldAlg.nbxPep,3ddvKoQLizWyx1NHHabjlausCxTw3py6q7G9,GGmnoi\",\n \"thumbnail_mime_type\": \"dolor aliquip proident aliqua incididunt\"\n },\n \"attachment_count\": -52712857,\n \"is_on_blockchain\": false,\n \"can_be_destroyed\": \"laboris qui tempor do\",\n \"can_be_accomplished\": \"amet pariatu\",\n \"destroy_pending\": \"nostrud ex\",\n \"accomplish_pending\": \"et do ut cillum Lorem\",\n \"created\": \"magna non nost\"\n },\n \"used_in_envelope_id\": \"sunt culpa voluptate\",\n \"used_in_envelope\": {\n \"id\": \"3b6db492-9574-711a-72f3-114128c452ce\",\n \"owner_id\": \"sed in pariatur\",\n \"recipient_id\": \"in cillum\",\n \"message\": \"quis ullamco\",\n \"type\": \"eu nisi commodo minim quis\",\n \"specialization_type\": \"standard\",\n \"created\": \"tempor ipsum\",\n \"sent\": \"1995-07-26T17:02:30.778Z\",\n \"archived\": \"1975-12-16T22:45:04.149Z\",\n \"delivered\": \"minim\",\n \"action_performed_by_id\": \"est tempor\",\n \"sealed\": false,\n \"can_be_sealed\": \"Ut ex culpa\",\n \"is_draft\": \"nisi in\",\n \"sender_inbox_id\": \"ad aliqua eiusmod\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"eu\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": true,\n \"delivered_envelope_id\": \"ut\",\n \"failed_delivery_envelope_id\": \"id Lorem Ut dolor\",\n \"failed_outgoing_id\": \"laboris nostrud\",\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"aute aliqua irure\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": true,\n \"created\": \"1970-07-20T07:24:45.498Z\"\n }\n ],\n \"delivered_envelope_id\": \"Ut consectetur\",\n \"failed_delivery_envelope_id\": \"Ut cillum ex nisi\",\n \"failed_outgoing_id\": \"do nisi Ut\",\n \"document_token_transactions\": [\n {\n \"tx_hash\": \"sit elit ullamco eu\",\n \"status\": 2,\n \"created\": \"1948-08-01T00:58:41.998Z\",\n \"mined\": \"1966-07-16T04:11:50.365Z\",\n \"etherscan_link\": \"quis ad\"\n },\n {\n \"tx_hash\": \"aute incididunt\",\n \"status\": 2,\n \"created\": \"1993-01-21T21:15:29.807Z\",\n \"mined\": \"1956-11-23T18:52:48.097Z\",\n \"etherscan_link\": \"nisi tempor fugiat\"\n }\n ],\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"tempor\",\n \"meta_data\": {},\n \"credits_spent_amount\": 3899833,\n \"credits_spent_for_documents\": -43248610,\n \"acid_number\": \"cupidatat deserunt dolor\",\n \"acid_verification_timeout\": \"veniam non velit eiusmod\",\n \"aci_filing_notification\": \"irure dolore et veniam\",\n \"is_first_acid_filing\": false\n}" }, { "name": "Returned when the authenticated user is not a 3rd-party company.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/latest/?ordering=cons&search=cons&limit=35678520&offset=35678520", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "latest", "" ], "query": [ { "key": "ordering", "value": "cons" }, { "key": "search", "value": "cons" }, { "key": "limit", "value": "35678520" }, { "key": "offset", "value": "35678520" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" }, { "key": "envelope", "value": "cons", "description": "(Required) \nThe envelope identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine envelope by its ID. Replace `{id}` with internal envelope uuid. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "List envelopes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/list/?ordering=cons&search=cons&limit=35678520&offset=35678520", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "list", "" ], "query": [ { "key": "ordering", "value": "cons" }, { "key": "search", "value": "cons", "description": "A search term." }, { "key": "limit", "value": "35678520", "description": "Number of results to return per page." }, { "key": "offset", "value": "35678520", "description": "The initial index from which to return the results." } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] }, "description": "Lists all envelopes of companies that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/list/?ordering=cons&search=cons&limit=35678520&offset=35678520", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "list", "" ], "query": [ { "key": "ordering", "value": "cons" }, { "key": "search", "value": "cons" }, { "key": "limit", "value": "35678520" }, { "key": "offset", "value": "35678520" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:168e861d-d56a-2546-87ab-2a0d91d7b389\",\n \"owner_id\": \"voluptate sunt consequat ad ipsum\",\n \"recipient_id\": \"aliquip dolore laboris eiusmod\",\n \"message\": \"quis pariatur\",\n \"type\": \"irure cupidatat ad minim\",\n \"specialization_type\": \"standard\",\n \"created\": \"sit qui\",\n \"sent\": \"1998-04-24T04:50:20.680Z\",\n \"archived\": \"1987-02-09T04:14:10.914Z\",\n \"delivered\": \"in cupidatat anim\",\n \"action_performed_by_id\": \"labor\",\n \"action_performed_by\": {\n \"email\": \"X83k0beD9PAnv@qKqLUNuUIIBHztMkwOwMlclQ.rcm\",\n \"telephone\": \"est ex\",\n \"name\": \"laboris\",\n \"first_name\": \"sunt culpa\",\n \"last_name\": \"Lorem\",\n \"company_id\": \"fugiat\",\n \"company\": {\n \"name\": \"elit in reprehenderit sit anim\",\n \"address\": \"de\",\n \"postal_code\": \"nostrud exercitation irure commodo\",\n \"city\": \"laboris est nisi\",\n \"branch\": \"elit laboris irure\",\n \"address2\": \"aliqua non velit nulla esse\",\n \"country\": \"AZ\",\n \"country_name\": \"pariatur deserunt non\",\n \"website\": \"sint velit minim Excepteur fugiat\",\n \"vat_number\": \"quis eiusmod dol\",\n \"logo\": \"http://ByyCfnjAboaBQdUInoAesMRucA.sjoSB.E17yYl2Tp7l4uTnwoqAG3mG7vshOL\",\n \"logo_name\": \"cillum ipsum id anim\",\n \"created\": \"2002-04-27T22:22:49.781Z\",\n \"id\": \"urn:uuid:7bf94c3e-3467-6f54-bad1-3cc2262a4737\",\n \"verified_bank\": \"est ea qui\",\n \"verified_dnb\": \"nostrud velit\"\n },\n \"logo\": \"https://YMkDPLGSIYi.sbhqMoWzfcBz8WMKoRrkZJGYGE1icf8+Ev-Yu+sgu,OP4hWPITtI7wy.XShQuRy+jiYfJPwSzYRBS\",\n \"logo_name\": \"pariatur nisi\",\n \"id\": \"1fb0d2d6-5979-b24d-8094-f2a2bdc2e0dd\"\n },\n \"action_performed_by_company_id\": \"ullamco do\",\n \"action_performed_by_company\": {\n \"name\": \"eu qui\",\n \"address\": \"aliqua ipsum\",\n \"postal_code\": \"mollit sint qui sed\",\n \"city\": \"nulla cupidatat aliqua dolore\",\n \"branch\": \"consectetur Ut\",\n \"address2\": \"in ut\",\n \"country\": \"BE\",\n \"country_name\": \"voluptate anim enim nulla\",\n \"website\": \"in\",\n \"vat_number\": \"eiusmod\",\n \"logo\": \"https://r.frOBgvaabcEjDjIAhNjyivSPsHxloEg.\",\n \"logo_name\": \"irure cillum officia est\",\n \"created\": \"1974-05-12T17:22:23.041Z\",\n \"id\": \"f5947ce2-8722-e638-f9d8-83a24bba8b23\",\n \"verified_bank\": \"exercitation aliqua cupi\",\n \"verified_dnb\": \"dolore ad dolore\"\n },\n \"sealed\": false,\n \"can_be_sealed\": \"in irure non elit Lorem\",\n \"is_draft\": \"est nostrud reprehenderit consequ\",\n \"sender_inbox_id\": \"in elit sit fugiat\",\n \"sender\": {\n \"name\": \"adipisicing ad nostrud et\",\n \"address\": \"sit voluptate\",\n \"postal_code\": \"incididunt enim quis Duis ad\",\n \"city\": \"ad c\",\n \"branch\": \"nisi labore officia\",\n \"address2\": \"pariatur\",\n \"country\": \"YT\",\n \"country_name\": \"ullamco\",\n \"website\": \"ut mollit minim consectetur\",\n \"vat_number\": \"ullamco fugiat exercitation commodo non\",\n \"logo\": \"https://DUSPgY.etyp8fmjoiNkY3k.X4g24o.7EXnZnRVsqmENc+CApMlwy1nAQESHo\",\n \"logo_name\": \"ut velit v\",\n \"created\": \"2016-05-05T14:44:36.026Z\",\n \"id\": \"urn:uuid:ff2328b2-f1de-a199-b7d4-00125ce5928e\",\n \"verified_bank\": \"do proident\",\n \"verified_dnb\": \"eu cillum mollit\"\n },\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"irure culpa incididunt consectetur\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": true,\n \"read_by_user\": \"eiusmod tempor velit\",\n \"documents\": [\n \"incididunt irure enim fugiat reprehenderit\",\n \"laborum nisi esse sunt in\"\n ],\n \"existing_attachments\": {},\n \"attachments\": [\n {\n \"document_token_id\": \"quis deserunt esse irure\",\n \"id\": \"f44f76e5-5b80-f6f8-1240-6a229b426586\",\n \"envelope_id\": \"Duis sit\",\n \"document_token\": {\n \"id\": \"urn:uuid:99f6a1da-897e-f593-cbb8-062d8984342d\",\n \"storage_type\": \"veniam id velit\",\n \"watermark_generated\": true,\n \"ipfs_document_group_id\": \"sed dolore nostrud proident\",\n \"ipfs_document_group\": \"urn:uuid:deb979a4-8b4d-d2a1-db98-dbc264b3c53e\",\n \"document_id\": \"ut irure ex ullamco\",\n \"document\": {\n \"document_type\": \"ut magna proident officia\",\n \"create_on_blockchain_override\": false,\n \"id\": \"bfc5c81b-0ec4-dbd7-2019-24524033f0e2\",\n \"current_owner_id\": \"et occaecat deserunt commodo\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"cupidatat tempor ut\",\n \"uploaded_by\": {\n \"email\": \"KF0IU-dtNh-A@ryHdrBOLLQJmBFIFsMNi.wey\",\n \"telephone\": \"et in\",\n \"name\": \"consectetur sint\",\n \"first_name\": \"amet sed cillum nisi\",\n \"last_name\": \"Ut aliquip\",\n \"company_id\": \"\",\n \"company\": {\n \"name\": \"ullamco\",\n \"address\": \"officia\",\n \"postal_code\": \"dolore labore enim adipisicing\",\n \"city\": \"nisi incididunt\",\n \"branch\": \"sint\",\n \"address2\": \"incididunt\",\n \"country\": \"JE\",\n \"country_name\": \"in in\",\n \"website\": \"fugiat irure ut\",\n \"vat_number\": \"nisi quis\",\n \"logo\": \"http://HCCXvuGJCQrwveJnATVZFbvDEBAzTaUZ.ygISt\",\n \"logo_name\": \"qui\",\n \"created\": \"2006-07-08T09:50:01.259Z\",\n \"id\": \"urn:uuid:0e291c97-350a-509d-3f39-3b2bf689a234\",\n \"verified_bank\": \"non\",\n \"verified_dnb\": \"dolore cillum\"\n },\n \"logo\": \"https://xYzuxnBeIiwxAWzVhiU.qnqiTptCa5PeolHQIB3phfRLwnKKLM\",\n \"logo_name\": \"dolor officia dolo\",\n \"id\": \"6de3c248-8a84-2640-cb1c-7651b0ea0fea\"\n },\n \"uploaded_by_company_id\": \"Excepteur\",\n \"uploaded_by_company\": {\n \"name\": \"sit reprehenderit\",\n \"address\": \"pariatur irure commodo cillum\",\n \"postal_code\": \"proident exercita\",\n \"city\": \"qu\",\n \"branch\": \"ullamco aute laboris\",\n \"address2\": \"voluptate ut cupidatat\",\n \"country\": \"GT\",\n \"country_name\": \"sunt consequat proident\",\n \"website\": \"nostrud voluptate\",\n \"vat_number\": \"irure Ut deserunt\",\n \"logo\": \"http://DzlsBacyOdCdATdtDSKnxHWiOmT.qfoLE.8XnE.\",\n \"logo_name\": \"enim elit nisi minim do\",\n \"created\": \"2007-11-25T07:51:41.300Z\",\n \"id\": \"urn:uuid:e3c12e78-12fd-d400-c345-e426c07b6ffc\",\n \"verified_bank\": \"sunt elit\",\n \"verified_dnb\": \"nostrud aliquip\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"Duis anim do\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"velit anim\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"2021-02-17T03:27:43.628Z\",\n \"accomplished_by_id\": \"in exercitation\",\n \"accomplished_by_company_id\": \"irure fugiat Duis\",\n \"destroyed\": \"1952-12-31T02:09:39.808Z\",\n \"destroyed_by_company_id\": \"deserunt pariatur culpa\",\n \"notify_parties\": [\n \"eneyn@YdvVoFMVfZMctwByqcMtYgRQOoMPnkajh.jz\",\n \"AFYsemFV0hKm3@WURDItzsxhgagEekHUXeUOzkV.nd\"\n ],\n \"meta_data\": {},\n \"display_name\": \"cillum sunt aute\",\n \"file_name\": \"ipsum est\",\n \"file_size\": 1990310908,\n \"file_content_type\": \"Ut occaecat voluptate ut\",\n \"watermarkable\": false,\n \"icon\": \"incididunt tempor\",\n \"file_type\": \"quis reprehenderit dolor ullamco\",\n \"created\": \"culpa nulla sit sunt\",\n \"thumbnail\": \"http://hVooSPJxVuyTDMTWvoIDOvcoFmvvOxW.hslNrivwkR2PGZrudSYUiR2uvZfTUUdlRwEWDgZ+jUk1eZZ4bx5fRfHxCGHRTmU3zcHz82ajW9j38WgGIW\",\n \"thumbnail_mime_type\": \"amet in laborum sunt\"\n },\n \"attachment_count\": 87150649,\n \"is_on_blockchain\": true,\n \"can_be_destroyed\": \"laborum commodo Excepteur\",\n \"can_be_accomplished\": \"commodo\",\n \"destroy_pending\": \"ipsum\",\n \"accomplish_pending\": \"nostrud Excepteur sit ea officia\",\n \"created\": \"in dolo\"\n },\n \"used_in_envelope_id\": \"qui enim\",\n \"used_in_envelope\": {\n \"id\": \"urn:uuid:a52c3083-22a9-207e-5b30-72a897bca9b1\",\n \"owner_id\": \"nostrud cillum velit\",\n \"recipient_id\": \"ea \",\n \"message\": \"pariatur ad proident eiusmod\",\n \"type\": \"ad\",\n \"specialization_type\": \"acid\",\n \"created\": \"dolore nulla esse officia commodo\",\n \"sent\": \"2016-08-28T10:38:27.038Z\",\n \"archived\": \"1975-11-22T10:49:51.316Z\",\n \"delivered\": \"anim Duis officia\",\n \"action_performed_by_id\": \"minim ut n\",\n \"sealed\": false,\n \"can_be_sealed\": \"qui est ea fugiat in\",\n \"is_draft\": \"ullamco aute\",\n \"sender_inbox_id\": \"voluptate consequat eu cillum\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"Excepteur exercitation eu\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": false,\n \"delivered_envelope_id\": \"dolor\",\n \"failed_delivery_envelope_id\": \"ullamco\",\n \"failed_outgoing_id\": \"incididunt aliquip aute sint\",\n \"pay_to_collect\": false,\n \"pay_to_collect_response\": \"proident deserunt culpa laboris\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": false,\n \"created\": \"2017-10-24T06:34:16.689Z\"\n },\n {\n \"document_token_id\": \"mollit occaecat dolore\",\n \"id\": \"f4f75a40-3318-6d03-5218-f872bf07f0a6\",\n \"envelope_id\": \"amet commodo fugiat\",\n \"document_token\": {\n \"id\": \"urn:uuid:3c1a8eb8-c842-79d1-f811-61fb6f103779\",\n \"storage_type\": \"mollit ex\",\n \"watermark_generated\": false,\n \"ipfs_document_group_id\": \"dolore dolor ut ut\",\n \"ipfs_document_group\": \"9663bee0-ebbb-dc1d-c125-7108f519a27b\",\n \"document_id\": \"commodo deserunt magna sed\",\n \"document\": {\n \"document_type\": \"officia laboris cupidatat\",\n \"create_on_blockchain_override\": false,\n \"id\": \"urn:uuid:a348548b-ac11-247c-36a6-9aa30063d050\",\n \"current_owner_id\": \"deserunt dolore\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"irure\",\n \"uploaded_by\": {\n \"email\": \"ClEvMO43cc@BCeUlTGDVUc.gr\",\n \"telephone\": \"ea ullamco\",\n \"name\": \"nulla fugia\",\n \"first_name\": \"elit enim\",\n \"last_name\": \"amet reprehenderit\",\n \"company_id\": \"ad deserunt consequat sit\",\n \"company\": {\n \"name\": \"dolor officia exercitation\",\n \"address\": \"incididunt Excepteur\",\n \"postal_code\": \"ut id enim anim\",\n \"city\": \"proident sunt\",\n \"branch\": \"qui dolore in\",\n \"address2\": \"veniam\",\n \"country\": \"GT\",\n \"country_name\": \"ex ea dolor occaecat\",\n \"website\": \"occaecat ut labore\",\n \"vat_number\": \"in proident\",\n \"logo\": \"http://fwETkMNWGM.ehoTc3v7ct\",\n \"logo_name\": \"fugiat Duis nisi\",\n \"created\": \"2002-11-12T09:30:07.309Z\",\n \"id\": \"urn:uuid:4002afe6-9a37-1afe-90b3-6469ae3b23f7\",\n \"verified_bank\": \"volupta\",\n \"verified_dnb\": \"ex sed\"\n },\n \"logo\": \"http://ZAjIK.fqsYXQdoG+wZ5QQCfanqf\",\n \"logo_name\": \"ut Excepteur\",\n \"id\": \"98016d9a-79af-3563-dfad-0798b9b8f266\"\n },\n \"uploaded_by_company_id\": \"c\",\n \"uploaded_by_company\": {\n \"name\": \"sunt reprehenderit nulla fugiat\",\n \"address\": \"sunt velit pariatur sint\",\n \"postal_code\": \"eu est\",\n \"city\": \"u\",\n \"branch\": \"ex labore occaecat pariatur\",\n \"address2\": \"elit\",\n \"country\": \"BZ\",\n \"country_name\": \"ess\",\n \"website\": \"sed nisi\",\n \"vat_number\": \"dolore\",\n \"logo\": \"http://dEvEyGdPRZH.moFfa8y5oFFEJPpSYgZfJqiYKY-EYYlfMtf0u--QBAk1zQY6J0B78d.2a7nE.Jzo3tE8Axjk5IN\",\n \"logo_name\": \"adipisici\",\n \"created\": \"2021-05-24T18:08:25.369Z\",\n \"id\": \"urn:uuid:e03908aa-0b17-9b00-2d25-75979850778f\",\n \"verified_bank\": \"Duis do nulla deserunt voluptate\",\n \"verified_dnb\": \"incididunt cupidatat nulla qui\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"dolore in\",\n \"create_on_blockchain\": false,\n \"accomplisher_id\": \"cillum velit aute occaecat\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"1998-04-29T16:24:41.608Z\",\n \"accomplished_by_id\": \"laborum aute dolore sunt\",\n \"accomplished_by_company_id\": \"velit sint pariatur nisi\",\n \"destroyed\": \"2006-10-01T06:37:51.953Z\",\n \"destroyed_by_company_id\": \"irure Ut eiusmod aute\",\n \"notify_parties\": [\n \"zD3dDANyjb@U.xb\",\n \"6jSQ6rP@sZALzfCgCLwOUX.tu\"\n ],\n \"meta_data\": {},\n \"display_name\": \"deserunt commodo eiusmod occaecat\",\n \"file_name\": \"deserunt anim veniam\",\n \"file_size\": 942397605,\n \"file_content_type\": \"do voluptate nostrud in\",\n \"watermarkable\": true,\n \"icon\": \"ullamco incididunt\",\n \"file_type\": \"occaecat aliquip\",\n \"created\": \"cillum enim laboris incididunt\",\n \"thumbnail\": \"https://VOwhldAlg.nbxPep,3ddvKoQLizWyx1NHHabjlausCxTw3py6q7G9,GGmnoi\",\n \"thumbnail_mime_type\": \"dolor aliquip proident aliqua incididunt\"\n },\n \"attachment_count\": -52712857,\n \"is_on_blockchain\": false,\n \"can_be_destroyed\": \"laboris qui tempor do\",\n \"can_be_accomplished\": \"amet pariatu\",\n \"destroy_pending\": \"nostrud ex\",\n \"accomplish_pending\": \"et do ut cillum Lorem\",\n \"created\": \"magna non nost\"\n },\n \"used_in_envelope_id\": \"sunt culpa voluptate\",\n \"used_in_envelope\": {\n \"id\": \"3b6db492-9574-711a-72f3-114128c452ce\",\n \"owner_id\": \"sed in pariatur\",\n \"recipient_id\": \"in cillum\",\n \"message\": \"quis ullamco\",\n \"type\": \"eu nisi commodo minim quis\",\n \"specialization_type\": \"standard\",\n \"created\": \"tempor ipsum\",\n \"sent\": \"1995-07-26T17:02:30.778Z\",\n \"archived\": \"1975-12-16T22:45:04.149Z\",\n \"delivered\": \"minim\",\n \"action_performed_by_id\": \"est tempor\",\n \"sealed\": false,\n \"can_be_sealed\": \"Ut ex culpa\",\n \"is_draft\": \"nisi in\",\n \"sender_inbox_id\": \"ad aliqua eiusmod\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"eu\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": true,\n \"delivered_envelope_id\": \"ut\",\n \"failed_delivery_envelope_id\": \"id Lorem Ut dolor\",\n \"failed_outgoing_id\": \"laboris nostrud\",\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"aute aliqua irure\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": true,\n \"created\": \"1970-07-20T07:24:45.498Z\"\n }\n ],\n \"delivered_envelope_id\": \"Ut consectetur\",\n \"failed_delivery_envelope_id\": \"Ut cillum ex nisi\",\n \"failed_outgoing_id\": \"do nisi Ut\",\n \"document_token_transactions\": [\n {\n \"tx_hash\": \"sit elit ullamco eu\",\n \"status\": 2,\n \"created\": \"1948-08-01T00:58:41.998Z\",\n \"mined\": \"1966-07-16T04:11:50.365Z\",\n \"etherscan_link\": \"quis ad\"\n },\n {\n \"tx_hash\": \"aute incididunt\",\n \"status\": 2,\n \"created\": \"1993-01-21T21:15:29.807Z\",\n \"mined\": \"1956-11-23T18:52:48.097Z\",\n \"etherscan_link\": \"nisi tempor fugiat\"\n }\n ],\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"tempor\",\n \"meta_data\": {},\n \"credits_spent_amount\": 3899833,\n \"credits_spent_for_documents\": -43248610,\n \"acid_number\": \"cupidatat deserunt dolor\",\n \"acid_verification_timeout\": \"veniam non velit eiusmod\",\n \"aci_filing_notification\": \"irure dolore et veniam\",\n \"is_first_acid_filing\": false\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/list/?ordering=cons&search=cons&limit=35678520&offset=35678520", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "list", "" ], "query": [ { "key": "ordering", "value": "cons" }, { "key": "search", "value": "cons" }, { "key": "limit", "value": "35678520" }, { "key": "offset", "value": "35678520" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company or envelope is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/list/?ordering=cons&search=cons&limit=35678520&offset=35678520", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "list", "" ], "query": [ { "key": "ordering", "value": "cons" }, { "key": "search", "value": "cons" }, { "key": "limit", "value": "35678520" }, { "key": "offset", "value": "35678520" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Get credits spent per aci number", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/units-spent/?ordering=cons&search=cons&limit=35678520&offset=35678520", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "units-spent", "" ], "query": [ { "key": "ordering", "value": "cons" }, { "key": "search", "value": "cons", "description": "A search term." }, { "key": "limit", "value": "35678520", "description": "Number of results to return per page." }, { "key": "offset", "value": "35678520", "description": "The initial index from which to return the results." } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] }, "description": "Returns a number of credits spent per aci number." }, "response": [ { "name": "Amount of units in milicents that aci number already spent.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/units-spent/?ordering=cons&search=cons&limit=35678520&offset=35678520", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "units-spent", "" ], "query": [ { "key": "ordering", "value": "cons" }, { "key": "search", "value": "cons" }, { "key": "limit", "value": "35678520" }, { "key": "offset", "value": "35678520" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"100000\"" }, { "name": "Returned if company not found or client has no access to this company", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/envelopes/units-spent/?ordering=cons&search=cons&limit=35678520&offset=35678520", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "envelopes", "units-spent", "" ], "query": [ { "key": "ordering", "value": "cons" }, { "key": "search", "value": "cons" }, { "key": "limit", "value": "35678520" }, { "key": "offset", "value": "35678520" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "incoming-envelopes", "item": [ { "name": "{envelope}", "item": [ { "name": "companies inboxes incoming-envelopes read", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/incoming-envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "incoming-envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "envelope", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/incoming-envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "incoming-envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "envelope", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:bba61532-1d30-941a-a575-30d2024037af\",\n \"owner_id\": \"ex esse Duis\",\n \"recipient_id\": \"nostrud voluptate esse\",\n \"attachments\": [\n {\n \"document_token_id\": \"eiusmod ut\",\n \"id\": \"8eb8096a-56d5-593c-19c0-49a421643b4b\",\n \"envelope_id\": \"et voluptate eu Excepteur\",\n \"document_token\": {\n \"id\": \"c1d479d3-2ebc-93e5-73f1-02202d255ebe\",\n \"storage_type\": \"incididunt aliquip anim in\",\n \"watermark_generated\": false,\n \"ipfs_document_group_id\": \"Excepteur labore nostrud\",\n \"ipfs_document_group\": \"be17fcbf-045d-ef75-eee0-a1cacddd4138\",\n \"document_id\": \"incididunt sed cillum ipsum ut\",\n \"document\": {\n \"document_type\": \"in pa\",\n \"create_on_blockchain_override\": true,\n \"id\": \"982dda36-bda5-ab42-ae76-8e8ec56c9b54\",\n \"current_owner_id\": \"in\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"dolore Lorem proident\",\n \"uploaded_by\": {\n \"email\": \"DxoMPGghc@GGgGZoYnoY.vq\",\n \"telephone\": \"ad dolore\",\n \"name\": \"in minim commodo\",\n \"first_name\": \"ex laboris eiusmod\",\n \"last_name\": \"in sint\",\n \"company_id\": \"et deserunt aute\",\n \"company\": {\n \"name\": \"ullamco tempor Ut do\",\n \"address\": \"elit deserunt consequat\",\n \"postal_code\": \"veniam fugiat nostrud Excepteur\",\n \"city\": \"nisi eiusmod velit dolor\",\n \"branch\": \"nulla minim\",\n \"address2\": \"ea\",\n \"country\": \"WF\",\n \"country_name\": \"in\",\n \"website\": \"quis dolore\",\n \"vat_number\": \"in in id\",\n \"logo\": \"http://aomOgOEosyxOlS.ykjm+e9x9liZTldNFRXNsRVh0aFTrmZoPIwXDVSTPRlF\",\n \"logo_name\": \"culpa nisi\",\n \"created\": \"1943-09-08T08:58:16.569Z\",\n \"id\": \"167f5551-654e-9a03-507c-a18d54bc2280\",\n \"verified_bank\": \"aliquip ex esse ut\",\n \"verified_dnb\": \"in enim\"\n },\n \"logo\": \"http://LbfwwrgnvCWVzNLAunrZesOdWYN.beyY,srRGPCblaPKSJ8pCeK1rfANzIuGV1AUS5YKsVk,\",\n \"logo_name\": \"ad do tempor esse\",\n \"id\": \"urn:uuid:2059d9ea-78a7-a48f-bf93-6e585617e0f3\"\n },\n \"uploaded_by_company_id\": \"Ut proident amet\",\n \"uploaded_by_company\": {\n \"name\": \"est aute\",\n \"address\": \"aliqua irure et Lorem\",\n \"postal_code\": \"minim sed laboris adipisicing veniam\",\n \"city\": \"minim incididunt\",\n \"branch\": \"qui reprehenderit ad laborum\",\n \"address2\": \"eu laboris Lorem occaecat\",\n \"country\": \"CI\",\n \"country_name\": \"adipisicing consectetur dolore\",\n \"website\": \"enim officia ad\",\n \"vat_number\": \"officia ea voluptate culpa consectetur\",\n \"logo\": \"https://ktaUajFZQla.lvnko1o+aTxWseuk.jbISgnA\",\n \"logo_name\": \"cillum dolor sit\",\n \"created\": \"1956-03-29T06:30:11.765Z\",\n \"id\": \"urn:uuid:c2b9ef9a-b589-e53d-40fa-1fa48107be52\",\n \"verified_bank\": \"dolore\",\n \"verified_dnb\": \"sit cupidatat aute\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"voluptate sunt exercitation aliqua\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"et laborum non ex\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"2007-10-07T11:48:33.368Z\",\n \"accomplished_by_id\": \"labore non consequat\",\n \"accomplished_by_company_id\": \"et\",\n \"destroyed\": \"1990-05-27T04:53:17.025Z\",\n \"destroyed_by_company_id\": \"pariatur ea adipisicing consectetur\",\n \"notify_parties\": [\n \"KWFDh@wHlCIdPfrAmvxigjhoiIgaLfu.fds\",\n \"9x4p4gRC@mUXQUBWlYoEmHCVYexrbOqpLdKdyxpU.ytv\"\n ],\n \"meta_data\": {},\n \"display_name\": \"fugiat quis\",\n \"file_name\": \"officia commodo\",\n \"file_size\": 2112472992,\n \"file_content_type\": \"laboris in sunt minim ut\",\n \"watermarkable\": false,\n \"icon\": \"ad\",\n \"file_type\": \"ullamco e\",\n \"created\": \"ad reprehenderit sunt\",\n \"thumbnail\": \"https://wBwQoLLhX.duumNuuZjXxdME4JWXYMMWW-QHPsnLt-ypKWFT2dYLxnRrnP7kamU3ZJ-Kf-q\",\n \"thumbnail_mime_type\": \"laborum\"\n },\n \"attachment_count\": -76615139,\n \"is_on_blockchain\": false,\n \"can_be_destroyed\": \"ex Lorem non Ut\",\n \"can_be_accomplished\": \"mollit velit exercitatio\",\n \"destroy_pending\": \"officia dolor id cillum\",\n \"accomplish_pending\": \"Ut dolor\",\n \"created\": \"irure adipisicing qui consequat\"\n },\n \"used_in_envelope_id\": \"proident cillum elit Excepteur sed\",\n \"used_in_envelope\": {\n \"id\": \"urn:uuid:a8018978-daab-549a-e85a-a6965a714dc7\",\n \"owner_id\": \"sunt nostrud\",\n \"recipient_id\": \"labore magna eiusmod\",\n \"message\": \"ullamco mollit dolore commodo\",\n \"type\": \"commodo in\",\n \"specialization_type\": \"standard\",\n \"created\": \"id\",\n \"sent\": \"1966-07-25T21:50:09.253Z\",\n \"archived\": \"1980-11-27T11:51:01.154Z\",\n \"delivered\": \"dolor officia \",\n \"action_performed_by_id\": \"culpa magna aute\",\n \"sealed\": false,\n \"can_be_sealed\": \"dolore nulla\",\n \"is_draft\": \"incididunt culpa aliquip magna\",\n \"sender_inbox_id\": \"incididunt dolor aute\",\n \"delivered_envelope_opened\": false,\n \"delivery_status\": \"reprehenderit Duis ipsum\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": false,\n \"delivered_envelope_id\": \"mollit ea officia\",\n \"failed_delivery_envelope_id\": \"qui cillum of\",\n \"failed_outgoing_id\": \"sed eiusmod ex\",\n \"pay_to_collect\": false,\n \"pay_to_collect_response\": \"enim sed nulla\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": true,\n \"created\": \"2020-12-21T05:50:41.918Z\"\n },\n {\n \"document_token_id\": \"commodo quis rep\",\n \"id\": \"a0c840d3-75cf-a4f9-6924-90f0a296b095\",\n \"envelope_id\": \"id in cupidatat\",\n \"document_token\": {\n \"id\": \"urn:uuid:8a4cd540-3ddf-9a7a-969b-2aba3e19d6f0\",\n \"storage_type\": \"ipsum et elit\",\n \"watermark_generated\": true,\n \"ipfs_document_group_id\": \"amet ad proident\",\n \"ipfs_document_group\": \"49ea46ba-1eaa-c8b1-c34b-ab321a71e388\",\n \"document_id\": \"Lorem ipsum aliquip\",\n \"document\": {\n \"document_type\": \"pariatur sed tempor\",\n \"create_on_blockchain_override\": false,\n \"id\": \"de4449a2-adbc-c0fe-f1f1-bd0c9974e833\",\n \"current_owner_id\": \"laborum esse minim\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"magna irure occaecat i\",\n \"uploaded_by\": {\n \"email\": \"ARJXEe@RMfVvxoWZTrbZbSm.xl\",\n \"telephone\": \"id Duis enim cu\",\n \"name\": \"ut mo\",\n \"first_name\": \"irure officia enim\",\n \"last_name\": \"elit non\",\n \"company_id\": \"sunt Excepteur\",\n \"company\": {\n \"name\": \"dolor ea\",\n \"address\": \"in\",\n \"postal_code\": \"nisi ad consequat\",\n \"city\": \"cillum\",\n \"branch\": \"esse in dolore\",\n \"address2\": \"velit eu quis\",\n \"country\": \"MD\",\n \"country_name\": \"aute elit do fugiat\",\n \"website\": \"irure ea aliqua\",\n \"vat_number\": \"ut sint aliqua\",\n \"logo\": \"http://pXzTXGrnyYmgkXeKTtCGUttpEATw.eeoDi2V1lCHZ3TWTrWNILk0M7G-IE4fI,Jo8\",\n \"logo_name\": \"laboris id\",\n \"created\": \"1993-07-29T13:20:10.928Z\",\n \"id\": \"80f1a2fc-48ff-39d7-bb83-3a11f1e48ff3\",\n \"verified_bank\": \"commodo\",\n \"verified_dnb\": \"veniam in dolor ut\"\n },\n \"logo\": \"https://IhlFoIG.etAnFbhlEHPhoT\",\n \"logo_name\": \"in\",\n \"id\": \"7bb02639-649e-35af-8e3d-f05f444fe1fc\"\n },\n \"uploaded_by_company_id\": \"irure sunt id nostrud\",\n \"uploaded_by_company\": {\n \"name\": \"fugiat deserunt ipsum incididunt\",\n \"address\": \"eiusmod occaecat\",\n \"postal_code\": \"in sint labore quis sed\",\n \"city\": \"mollit ea exercitation Lorem aliquip\",\n \"branch\": \"ut ea eu exercitation\",\n \"address2\": \"culpa anim\",\n \"country\": \"MX\",\n \"country_name\": \"dolor cillum repreh\",\n \"website\": \"eu ad exercitation qui\",\n \"vat_number\": \"culpa consectetur ullamco\",\n \"logo\": \"https://uPtGTbZgxpllTDYOZJdAGNMrjUa.gvkidqwfi,8XMSM,lHJGAqCI4Obg+0DmzLUOuXOBMfzAoZfqXuxA,yAK6sxx9\",\n \"logo_name\": \"amet enim com\",\n \"created\": \"1964-03-09T21:47:23.316Z\",\n \"id\": \"urn:uuid:3fb497ea-d986-10cf-3ab2-52fcc101981a\",\n \"verified_bank\": \"ex proident\",\n \"verified_dnb\": \"ullamco velit Ut\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"enim quis qui\",\n \"create_on_blockchain\": false,\n \"accomplisher_id\": \"Excepteur nulla eiusm\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"1989-05-28T11:12:23.489Z\",\n \"accomplished_by_id\": \"cupidatat ut\",\n \"accomplished_by_company_id\": \"reprehend\",\n \"destroyed\": \"1995-05-09T04:07:39.056Z\",\n \"destroyed_by_company_id\": \"ipsum sint cupidatat\",\n \"notify_parties\": [\n \"I23aU@xaYQuXzJAUWDnjjnclcniuxHa.cfat\",\n \"B0xvdW4oGny@qHBrzLwcbDKoTClxbOIdZgG.js\"\n ],\n \"meta_data\": {},\n \"display_name\": \"id dolore ut sed\",\n \"file_name\": \"consectetur\",\n \"file_size\": 1735132465,\n \"file_content_type\": \"dolor ea dolore nostrud id\",\n \"watermarkable\": false,\n \"icon\": \"do sint dolore amet\",\n \"file_type\": \"Dui\",\n \"created\": \"qui exercitation\",\n \"thumbnail\": \"https://hguXiaxffbdztORn.vwgxZS0U+enlkPwm9Id\",\n \"thumbnail_mime_type\": \"amet ipsum mollit\"\n },\n \"attachment_count\": -56659491,\n \"is_on_blockchain\": false,\n \"can_be_destroyed\": \"esse\",\n \"can_be_accomplished\": \"ea m\",\n \"destroy_pending\": \"ullamco nisi nostrud\",\n \"accomplish_pending\": \"Lorem ut fugiat do\",\n \"created\": \"anim sit\"\n },\n \"used_in_envelope_id\": \"ad enim\",\n \"used_in_envelope\": {\n \"id\": \"urn:uuid:7cdc3e85-9db2-4a3d-ffab-043d995b8e9a\",\n \"owner_id\": \"quis pariatur amet ad\",\n \"recipient_id\": \"fugiat dolore\",\n \"message\": \"occaecat mollit adipisicing non\",\n \"type\": \"et sunt eiusmod\",\n \"specialization_type\": \"acid\",\n \"created\": \"voluptate sunt\",\n \"sent\": \"1973-01-06T10:19:31.922Z\",\n \"archived\": \"1993-09-01T05:48:01.748Z\",\n \"delivered\": \"eu aute aliquip\",\n \"action_performed_by_id\": \"eu\",\n \"sealed\": false,\n \"can_be_sealed\": \"Excep\",\n \"is_draft\": \"mollit tempor\",\n \"sender_inbox_id\": \"sunt in labore\",\n \"delivered_envelope_opened\": false,\n \"delivery_status\": \"ad esse laboru\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": true,\n \"delivered_envelope_id\": \"nostrud amet aliquip\",\n \"failed_delivery_envelope_id\": \"et in magna\",\n \"failed_outgoing_id\": \"id do ipsum Ut incididunt\",\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"fugiat proident\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": true,\n \"created\": \"1993-02-02T06:37:26.946Z\"\n }\n ],\n \"created\": \"veniam ut in ea\",\n \"type\": \"eu enim irure Lorem amet\",\n \"specialization_type\": \"standard\",\n \"sender\": {\n \"name\": \"Duis labore aliquip\",\n \"address\": \"amet veniam laboris dolore\",\n \"postal_code\": \"et in sint\",\n \"city\": \"eu ea et\",\n \"branch\": \"ut officia\",\n \"address2\": \"dolor magna officia ex\",\n \"country\": \"IM\",\n \"country_name\": \"esse\",\n \"website\": \"incididunt eiusmod\",\n \"vat_number\": \"eu ut\",\n \"logo\": \"http://FoPAPMoVsOmEYnuuaL.pwhqFHehV.1ToBxUlW-t2DU+SmODA42iXcJzHV,tHr03,do7bHbZwJgvRgttpMPFNTptQtAXzX+iL2Db.kv\",\n \"logo_name\": \"sed consectetur d\",\n \"created\": \"2004-01-01T05:17:39.919Z\",\n \"id\": \"273d0d9c-7967-8e35-0575-458770b33133\",\n \"verified_bank\": \"in \",\n \"verified_dnb\": \"officia consequat mollit\"\n },\n \"sender_id\": \"sed\",\n \"sender_inbox_id\": \"Excepteur pariatur sunt\",\n \"message\": \"ad\",\n \"pay_to_collect_response\": 2,\n \"meta_data\": {},\n \"sent\": \"deserunt nostrud Duis\"\n}" } ] }, { "name": "companies inboxes incoming-envelopes update", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"specialization_type\": \"standard\",\n \"sender\": {\n \"name\": \"officia cupidatat et nisi\",\n \"address\": \"sint pariatur sunt\",\n \"postal_code\": \"incididu\",\n \"city\": \"aliquip dolore ut\",\n \"branch\": \"fugiat proident\",\n \"address2\": \"cupidatat\",\n \"country\": \"VN\",\n \"country_name\": \"exercitation laborum\",\n \"website\": \"ullamco Excepteur fugiat sit cillum\",\n \"vat_number\": \"ad esse ut voluptate\",\n \"logo\": \"https://JTJUPb.regw0N-8tM,+qmXzhg0A4T\",\n \"logo_name\": \"ipsum cillum\",\n \"created\": \"1982-06-26T11:49:10.521Z\",\n \"id\": \"urn:uuid:8dee7eca-db53-95af-3f13-92e4d12d766c\",\n \"verified_bank\": \"fugiat\",\n \"verified_dnb\": \"laborum ut est\"\n },\n \"message\": \"aute reprehenderit dolore\",\n \"pay_to_collect_response\": 1,\n \"meta_data\": {}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/incoming-envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "incoming-envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "envelope", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/incoming-envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "incoming-envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "envelope", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:bba61532-1d30-941a-a575-30d2024037af\",\n \"owner_id\": \"ex esse Duis\",\n \"recipient_id\": \"nostrud voluptate esse\",\n \"attachments\": [\n {\n \"document_token_id\": \"eiusmod ut\",\n \"id\": \"8eb8096a-56d5-593c-19c0-49a421643b4b\",\n \"envelope_id\": \"et voluptate eu Excepteur\",\n \"document_token\": {\n \"id\": \"c1d479d3-2ebc-93e5-73f1-02202d255ebe\",\n \"storage_type\": \"incididunt aliquip anim in\",\n \"watermark_generated\": false,\n \"ipfs_document_group_id\": \"Excepteur labore nostrud\",\n \"ipfs_document_group\": \"be17fcbf-045d-ef75-eee0-a1cacddd4138\",\n \"document_id\": \"incididunt sed cillum ipsum ut\",\n \"document\": {\n \"document_type\": \"in pa\",\n \"create_on_blockchain_override\": true,\n \"id\": \"982dda36-bda5-ab42-ae76-8e8ec56c9b54\",\n \"current_owner_id\": \"in\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"dolore Lorem proident\",\n \"uploaded_by\": {\n \"email\": \"DxoMPGghc@GGgGZoYnoY.vq\",\n \"telephone\": \"ad dolore\",\n \"name\": \"in minim commodo\",\n \"first_name\": \"ex laboris eiusmod\",\n \"last_name\": \"in sint\",\n \"company_id\": \"et deserunt aute\",\n \"company\": {\n \"name\": \"ullamco tempor Ut do\",\n \"address\": \"elit deserunt consequat\",\n \"postal_code\": \"veniam fugiat nostrud Excepteur\",\n \"city\": \"nisi eiusmod velit dolor\",\n \"branch\": \"nulla minim\",\n \"address2\": \"ea\",\n \"country\": \"WF\",\n \"country_name\": \"in\",\n \"website\": \"quis dolore\",\n \"vat_number\": \"in in id\",\n \"logo\": \"http://aomOgOEosyxOlS.ykjm+e9x9liZTldNFRXNsRVh0aFTrmZoPIwXDVSTPRlF\",\n \"logo_name\": \"culpa nisi\",\n \"created\": \"1943-09-08T08:58:16.569Z\",\n \"id\": \"167f5551-654e-9a03-507c-a18d54bc2280\",\n \"verified_bank\": \"aliquip ex esse ut\",\n \"verified_dnb\": \"in enim\"\n },\n \"logo\": \"http://LbfwwrgnvCWVzNLAunrZesOdWYN.beyY,srRGPCblaPKSJ8pCeK1rfANzIuGV1AUS5YKsVk,\",\n \"logo_name\": \"ad do tempor esse\",\n \"id\": \"urn:uuid:2059d9ea-78a7-a48f-bf93-6e585617e0f3\"\n },\n \"uploaded_by_company_id\": \"Ut proident amet\",\n \"uploaded_by_company\": {\n \"name\": \"est aute\",\n \"address\": \"aliqua irure et Lorem\",\n \"postal_code\": \"minim sed laboris adipisicing veniam\",\n \"city\": \"minim incididunt\",\n \"branch\": \"qui reprehenderit ad laborum\",\n \"address2\": \"eu laboris Lorem occaecat\",\n \"country\": \"CI\",\n \"country_name\": \"adipisicing consectetur dolore\",\n \"website\": \"enim officia ad\",\n \"vat_number\": \"officia ea voluptate culpa consectetur\",\n \"logo\": \"https://ktaUajFZQla.lvnko1o+aTxWseuk.jbISgnA\",\n \"logo_name\": \"cillum dolor sit\",\n \"created\": \"1956-03-29T06:30:11.765Z\",\n \"id\": \"urn:uuid:c2b9ef9a-b589-e53d-40fa-1fa48107be52\",\n \"verified_bank\": \"dolore\",\n \"verified_dnb\": \"sit cupidatat aute\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"voluptate sunt exercitation aliqua\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"et laborum non ex\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"2007-10-07T11:48:33.368Z\",\n \"accomplished_by_id\": \"labore non consequat\",\n \"accomplished_by_company_id\": \"et\",\n \"destroyed\": \"1990-05-27T04:53:17.025Z\",\n \"destroyed_by_company_id\": \"pariatur ea adipisicing consectetur\",\n \"notify_parties\": [\n \"KWFDh@wHlCIdPfrAmvxigjhoiIgaLfu.fds\",\n \"9x4p4gRC@mUXQUBWlYoEmHCVYexrbOqpLdKdyxpU.ytv\"\n ],\n \"meta_data\": {},\n \"display_name\": \"fugiat quis\",\n \"file_name\": \"officia commodo\",\n \"file_size\": 2112472992,\n \"file_content_type\": \"laboris in sunt minim ut\",\n \"watermarkable\": false,\n \"icon\": \"ad\",\n \"file_type\": \"ullamco e\",\n \"created\": \"ad reprehenderit sunt\",\n \"thumbnail\": \"https://wBwQoLLhX.duumNuuZjXxdME4JWXYMMWW-QHPsnLt-ypKWFT2dYLxnRrnP7kamU3ZJ-Kf-q\",\n \"thumbnail_mime_type\": \"laborum\"\n },\n \"attachment_count\": -76615139,\n \"is_on_blockchain\": false,\n \"can_be_destroyed\": \"ex Lorem non Ut\",\n \"can_be_accomplished\": \"mollit velit exercitatio\",\n \"destroy_pending\": \"officia dolor id cillum\",\n \"accomplish_pending\": \"Ut dolor\",\n \"created\": \"irure adipisicing qui consequat\"\n },\n \"used_in_envelope_id\": \"proident cillum elit Excepteur sed\",\n \"used_in_envelope\": {\n \"id\": \"urn:uuid:a8018978-daab-549a-e85a-a6965a714dc7\",\n \"owner_id\": \"sunt nostrud\",\n \"recipient_id\": \"labore magna eiusmod\",\n \"message\": \"ullamco mollit dolore commodo\",\n \"type\": \"commodo in\",\n \"specialization_type\": \"standard\",\n \"created\": \"id\",\n \"sent\": \"1966-07-25T21:50:09.253Z\",\n \"archived\": \"1980-11-27T11:51:01.154Z\",\n \"delivered\": \"dolor officia \",\n \"action_performed_by_id\": \"culpa magna aute\",\n \"sealed\": false,\n \"can_be_sealed\": \"dolore nulla\",\n \"is_draft\": \"incididunt culpa aliquip magna\",\n \"sender_inbox_id\": \"incididunt dolor aute\",\n \"delivered_envelope_opened\": false,\n \"delivery_status\": \"reprehenderit Duis ipsum\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": false,\n \"delivered_envelope_id\": \"mollit ea officia\",\n \"failed_delivery_envelope_id\": \"qui cillum of\",\n \"failed_outgoing_id\": \"sed eiusmod ex\",\n \"pay_to_collect\": false,\n \"pay_to_collect_response\": \"enim sed nulla\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": true,\n \"created\": \"2020-12-21T05:50:41.918Z\"\n },\n {\n \"document_token_id\": \"commodo quis rep\",\n \"id\": \"a0c840d3-75cf-a4f9-6924-90f0a296b095\",\n \"envelope_id\": \"id in cupidatat\",\n \"document_token\": {\n \"id\": \"urn:uuid:8a4cd540-3ddf-9a7a-969b-2aba3e19d6f0\",\n \"storage_type\": \"ipsum et elit\",\n \"watermark_generated\": true,\n \"ipfs_document_group_id\": \"amet ad proident\",\n \"ipfs_document_group\": \"49ea46ba-1eaa-c8b1-c34b-ab321a71e388\",\n \"document_id\": \"Lorem ipsum aliquip\",\n \"document\": {\n \"document_type\": \"pariatur sed tempor\",\n \"create_on_blockchain_override\": false,\n \"id\": \"de4449a2-adbc-c0fe-f1f1-bd0c9974e833\",\n \"current_owner_id\": \"laborum esse minim\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"magna irure occaecat i\",\n \"uploaded_by\": {\n \"email\": \"ARJXEe@RMfVvxoWZTrbZbSm.xl\",\n \"telephone\": \"id Duis enim cu\",\n \"name\": \"ut mo\",\n \"first_name\": \"irure officia enim\",\n \"last_name\": \"elit non\",\n \"company_id\": \"sunt Excepteur\",\n \"company\": {\n \"name\": \"dolor ea\",\n \"address\": \"in\",\n \"postal_code\": \"nisi ad consequat\",\n \"city\": \"cillum\",\n \"branch\": \"esse in dolore\",\n \"address2\": \"velit eu quis\",\n \"country\": \"MD\",\n \"country_name\": \"aute elit do fugiat\",\n \"website\": \"irure ea aliqua\",\n \"vat_number\": \"ut sint aliqua\",\n \"logo\": \"http://pXzTXGrnyYmgkXeKTtCGUttpEATw.eeoDi2V1lCHZ3TWTrWNILk0M7G-IE4fI,Jo8\",\n \"logo_name\": \"laboris id\",\n \"created\": \"1993-07-29T13:20:10.928Z\",\n \"id\": \"80f1a2fc-48ff-39d7-bb83-3a11f1e48ff3\",\n \"verified_bank\": \"commodo\",\n \"verified_dnb\": \"veniam in dolor ut\"\n },\n \"logo\": \"https://IhlFoIG.etAnFbhlEHPhoT\",\n \"logo_name\": \"in\",\n \"id\": \"7bb02639-649e-35af-8e3d-f05f444fe1fc\"\n },\n \"uploaded_by_company_id\": \"irure sunt id nostrud\",\n \"uploaded_by_company\": {\n \"name\": \"fugiat deserunt ipsum incididunt\",\n \"address\": \"eiusmod occaecat\",\n \"postal_code\": \"in sint labore quis sed\",\n \"city\": \"mollit ea exercitation Lorem aliquip\",\n \"branch\": \"ut ea eu exercitation\",\n \"address2\": \"culpa anim\",\n \"country\": \"MX\",\n \"country_name\": \"dolor cillum repreh\",\n \"website\": \"eu ad exercitation qui\",\n \"vat_number\": \"culpa consectetur ullamco\",\n \"logo\": \"https://uPtGTbZgxpllTDYOZJdAGNMrjUa.gvkidqwfi,8XMSM,lHJGAqCI4Obg+0DmzLUOuXOBMfzAoZfqXuxA,yAK6sxx9\",\n \"logo_name\": \"amet enim com\",\n \"created\": \"1964-03-09T21:47:23.316Z\",\n \"id\": \"urn:uuid:3fb497ea-d986-10cf-3ab2-52fcc101981a\",\n \"verified_bank\": \"ex proident\",\n \"verified_dnb\": \"ullamco velit Ut\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"enim quis qui\",\n \"create_on_blockchain\": false,\n \"accomplisher_id\": \"Excepteur nulla eiusm\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"1989-05-28T11:12:23.489Z\",\n \"accomplished_by_id\": \"cupidatat ut\",\n \"accomplished_by_company_id\": \"reprehend\",\n \"destroyed\": \"1995-05-09T04:07:39.056Z\",\n \"destroyed_by_company_id\": \"ipsum sint cupidatat\",\n \"notify_parties\": [\n \"I23aU@xaYQuXzJAUWDnjjnclcniuxHa.cfat\",\n \"B0xvdW4oGny@qHBrzLwcbDKoTClxbOIdZgG.js\"\n ],\n \"meta_data\": {},\n \"display_name\": \"id dolore ut sed\",\n \"file_name\": \"consectetur\",\n \"file_size\": 1735132465,\n \"file_content_type\": \"dolor ea dolore nostrud id\",\n \"watermarkable\": false,\n \"icon\": \"do sint dolore amet\",\n \"file_type\": \"Dui\",\n \"created\": \"qui exercitation\",\n \"thumbnail\": \"https://hguXiaxffbdztORn.vwgxZS0U+enlkPwm9Id\",\n \"thumbnail_mime_type\": \"amet ipsum mollit\"\n },\n \"attachment_count\": -56659491,\n \"is_on_blockchain\": false,\n \"can_be_destroyed\": \"esse\",\n \"can_be_accomplished\": \"ea m\",\n \"destroy_pending\": \"ullamco nisi nostrud\",\n \"accomplish_pending\": \"Lorem ut fugiat do\",\n \"created\": \"anim sit\"\n },\n \"used_in_envelope_id\": \"ad enim\",\n \"used_in_envelope\": {\n \"id\": \"urn:uuid:7cdc3e85-9db2-4a3d-ffab-043d995b8e9a\",\n \"owner_id\": \"quis pariatur amet ad\",\n \"recipient_id\": \"fugiat dolore\",\n \"message\": \"occaecat mollit adipisicing non\",\n \"type\": \"et sunt eiusmod\",\n \"specialization_type\": \"acid\",\n \"created\": \"voluptate sunt\",\n \"sent\": \"1973-01-06T10:19:31.922Z\",\n \"archived\": \"1993-09-01T05:48:01.748Z\",\n \"delivered\": \"eu aute aliquip\",\n \"action_performed_by_id\": \"eu\",\n \"sealed\": false,\n \"can_be_sealed\": \"Excep\",\n \"is_draft\": \"mollit tempor\",\n \"sender_inbox_id\": \"sunt in labore\",\n \"delivered_envelope_opened\": false,\n \"delivery_status\": \"ad esse laboru\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": true,\n \"delivered_envelope_id\": \"nostrud amet aliquip\",\n \"failed_delivery_envelope_id\": \"et in magna\",\n \"failed_outgoing_id\": \"id do ipsum Ut incididunt\",\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"fugiat proident\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": true,\n \"created\": \"1993-02-02T06:37:26.946Z\"\n }\n ],\n \"created\": \"veniam ut in ea\",\n \"type\": \"eu enim irure Lorem amet\",\n \"specialization_type\": \"standard\",\n \"sender\": {\n \"name\": \"Duis labore aliquip\",\n \"address\": \"amet veniam laboris dolore\",\n \"postal_code\": \"et in sint\",\n \"city\": \"eu ea et\",\n \"branch\": \"ut officia\",\n \"address2\": \"dolor magna officia ex\",\n \"country\": \"IM\",\n \"country_name\": \"esse\",\n \"website\": \"incididunt eiusmod\",\n \"vat_number\": \"eu ut\",\n \"logo\": \"http://FoPAPMoVsOmEYnuuaL.pwhqFHehV.1ToBxUlW-t2DU+SmODA42iXcJzHV,tHr03,do7bHbZwJgvRgttpMPFNTptQtAXzX+iL2Db.kv\",\n \"logo_name\": \"sed consectetur d\",\n \"created\": \"2004-01-01T05:17:39.919Z\",\n \"id\": \"273d0d9c-7967-8e35-0575-458770b33133\",\n \"verified_bank\": \"in \",\n \"verified_dnb\": \"officia consequat mollit\"\n },\n \"sender_id\": \"sed\",\n \"sender_inbox_id\": \"Excepteur pariatur sunt\",\n \"message\": \"ad\",\n \"pay_to_collect_response\": 2,\n \"meta_data\": {},\n \"sent\": \"deserunt nostrud Duis\"\n}" } ] }, { "name": "companies inboxes incoming-envelopes partial update", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"specialization_type\": \"standard\",\n \"sender\": {\n \"name\": \"officia cupidatat et nisi\",\n \"address\": \"sint pariatur sunt\",\n \"postal_code\": \"incididu\",\n \"city\": \"aliquip dolore ut\",\n \"branch\": \"fugiat proident\",\n \"address2\": \"cupidatat\",\n \"country\": \"VN\",\n \"country_name\": \"exercitation laborum\",\n \"website\": \"ullamco Excepteur fugiat sit cillum\",\n \"vat_number\": \"ad esse ut voluptate\",\n \"logo\": \"https://JTJUPb.regw0N-8tM,+qmXzhg0A4T\",\n \"logo_name\": \"ipsum cillum\",\n \"created\": \"1982-06-26T11:49:10.521Z\",\n \"id\": \"urn:uuid:8dee7eca-db53-95af-3f13-92e4d12d766c\",\n \"verified_bank\": \"fugiat\",\n \"verified_dnb\": \"laborum ut est\"\n },\n \"message\": \"aute reprehenderit dolore\",\n \"pay_to_collect_response\": 1,\n \"meta_data\": {}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/incoming-envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "incoming-envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "envelope", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/incoming-envelopes/:envelope/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "incoming-envelopes", ":envelope", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "envelope", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"urn:uuid:bba61532-1d30-941a-a575-30d2024037af\",\n \"owner_id\": \"ex esse Duis\",\n \"recipient_id\": \"nostrud voluptate esse\",\n \"attachments\": [\n {\n \"document_token_id\": \"eiusmod ut\",\n \"id\": \"8eb8096a-56d5-593c-19c0-49a421643b4b\",\n \"envelope_id\": \"et voluptate eu Excepteur\",\n \"document_token\": {\n \"id\": \"c1d479d3-2ebc-93e5-73f1-02202d255ebe\",\n \"storage_type\": \"incididunt aliquip anim in\",\n \"watermark_generated\": false,\n \"ipfs_document_group_id\": \"Excepteur labore nostrud\",\n \"ipfs_document_group\": \"be17fcbf-045d-ef75-eee0-a1cacddd4138\",\n \"document_id\": \"incididunt sed cillum ipsum ut\",\n \"document\": {\n \"document_type\": \"in pa\",\n \"create_on_blockchain_override\": true,\n \"id\": \"982dda36-bda5-ab42-ae76-8e8ec56c9b54\",\n \"current_owner_id\": \"in\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"dolore Lorem proident\",\n \"uploaded_by\": {\n \"email\": \"DxoMPGghc@GGgGZoYnoY.vq\",\n \"telephone\": \"ad dolore\",\n \"name\": \"in minim commodo\",\n \"first_name\": \"ex laboris eiusmod\",\n \"last_name\": \"in sint\",\n \"company_id\": \"et deserunt aute\",\n \"company\": {\n \"name\": \"ullamco tempor Ut do\",\n \"address\": \"elit deserunt consequat\",\n \"postal_code\": \"veniam fugiat nostrud Excepteur\",\n \"city\": \"nisi eiusmod velit dolor\",\n \"branch\": \"nulla minim\",\n \"address2\": \"ea\",\n \"country\": \"WF\",\n \"country_name\": \"in\",\n \"website\": \"quis dolore\",\n \"vat_number\": \"in in id\",\n \"logo\": \"http://aomOgOEosyxOlS.ykjm+e9x9liZTldNFRXNsRVh0aFTrmZoPIwXDVSTPRlF\",\n \"logo_name\": \"culpa nisi\",\n \"created\": \"1943-09-08T08:58:16.569Z\",\n \"id\": \"167f5551-654e-9a03-507c-a18d54bc2280\",\n \"verified_bank\": \"aliquip ex esse ut\",\n \"verified_dnb\": \"in enim\"\n },\n \"logo\": \"http://LbfwwrgnvCWVzNLAunrZesOdWYN.beyY,srRGPCblaPKSJ8pCeK1rfANzIuGV1AUS5YKsVk,\",\n \"logo_name\": \"ad do tempor esse\",\n \"id\": \"urn:uuid:2059d9ea-78a7-a48f-bf93-6e585617e0f3\"\n },\n \"uploaded_by_company_id\": \"Ut proident amet\",\n \"uploaded_by_company\": {\n \"name\": \"est aute\",\n \"address\": \"aliqua irure et Lorem\",\n \"postal_code\": \"minim sed laboris adipisicing veniam\",\n \"city\": \"minim incididunt\",\n \"branch\": \"qui reprehenderit ad laborum\",\n \"address2\": \"eu laboris Lorem occaecat\",\n \"country\": \"CI\",\n \"country_name\": \"adipisicing consectetur dolore\",\n \"website\": \"enim officia ad\",\n \"vat_number\": \"officia ea voluptate culpa consectetur\",\n \"logo\": \"https://ktaUajFZQla.lvnko1o+aTxWseuk.jbISgnA\",\n \"logo_name\": \"cillum dolor sit\",\n \"created\": \"1956-03-29T06:30:11.765Z\",\n \"id\": \"urn:uuid:c2b9ef9a-b589-e53d-40fa-1fa48107be52\",\n \"verified_bank\": \"dolore\",\n \"verified_dnb\": \"sit cupidatat aute\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"voluptate sunt exercitation aliqua\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"et laborum non ex\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"2007-10-07T11:48:33.368Z\",\n \"accomplished_by_id\": \"labore non consequat\",\n \"accomplished_by_company_id\": \"et\",\n \"destroyed\": \"1990-05-27T04:53:17.025Z\",\n \"destroyed_by_company_id\": \"pariatur ea adipisicing consectetur\",\n \"notify_parties\": [\n \"KWFDh@wHlCIdPfrAmvxigjhoiIgaLfu.fds\",\n \"9x4p4gRC@mUXQUBWlYoEmHCVYexrbOqpLdKdyxpU.ytv\"\n ],\n \"meta_data\": {},\n \"display_name\": \"fugiat quis\",\n \"file_name\": \"officia commodo\",\n \"file_size\": 2112472992,\n \"file_content_type\": \"laboris in sunt minim ut\",\n \"watermarkable\": false,\n \"icon\": \"ad\",\n \"file_type\": \"ullamco e\",\n \"created\": \"ad reprehenderit sunt\",\n \"thumbnail\": \"https://wBwQoLLhX.duumNuuZjXxdME4JWXYMMWW-QHPsnLt-ypKWFT2dYLxnRrnP7kamU3ZJ-Kf-q\",\n \"thumbnail_mime_type\": \"laborum\"\n },\n \"attachment_count\": -76615139,\n \"is_on_blockchain\": false,\n \"can_be_destroyed\": \"ex Lorem non Ut\",\n \"can_be_accomplished\": \"mollit velit exercitatio\",\n \"destroy_pending\": \"officia dolor id cillum\",\n \"accomplish_pending\": \"Ut dolor\",\n \"created\": \"irure adipisicing qui consequat\"\n },\n \"used_in_envelope_id\": \"proident cillum elit Excepteur sed\",\n \"used_in_envelope\": {\n \"id\": \"urn:uuid:a8018978-daab-549a-e85a-a6965a714dc7\",\n \"owner_id\": \"sunt nostrud\",\n \"recipient_id\": \"labore magna eiusmod\",\n \"message\": \"ullamco mollit dolore commodo\",\n \"type\": \"commodo in\",\n \"specialization_type\": \"standard\",\n \"created\": \"id\",\n \"sent\": \"1966-07-25T21:50:09.253Z\",\n \"archived\": \"1980-11-27T11:51:01.154Z\",\n \"delivered\": \"dolor officia \",\n \"action_performed_by_id\": \"culpa magna aute\",\n \"sealed\": false,\n \"can_be_sealed\": \"dolore nulla\",\n \"is_draft\": \"incididunt culpa aliquip magna\",\n \"sender_inbox_id\": \"incididunt dolor aute\",\n \"delivered_envelope_opened\": false,\n \"delivery_status\": \"reprehenderit Duis ipsum\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": false,\n \"delivered_envelope_id\": \"mollit ea officia\",\n \"failed_delivery_envelope_id\": \"qui cillum of\",\n \"failed_outgoing_id\": \"sed eiusmod ex\",\n \"pay_to_collect\": false,\n \"pay_to_collect_response\": \"enim sed nulla\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": true,\n \"created\": \"2020-12-21T05:50:41.918Z\"\n },\n {\n \"document_token_id\": \"commodo quis rep\",\n \"id\": \"a0c840d3-75cf-a4f9-6924-90f0a296b095\",\n \"envelope_id\": \"id in cupidatat\",\n \"document_token\": {\n \"id\": \"urn:uuid:8a4cd540-3ddf-9a7a-969b-2aba3e19d6f0\",\n \"storage_type\": \"ipsum et elit\",\n \"watermark_generated\": true,\n \"ipfs_document_group_id\": \"amet ad proident\",\n \"ipfs_document_group\": \"49ea46ba-1eaa-c8b1-c34b-ab321a71e388\",\n \"document_id\": \"Lorem ipsum aliquip\",\n \"document\": {\n \"document_type\": \"pariatur sed tempor\",\n \"create_on_blockchain_override\": false,\n \"id\": \"de4449a2-adbc-c0fe-f1f1-bd0c9974e833\",\n \"current_owner_id\": \"laborum esse minim\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"magna irure occaecat i\",\n \"uploaded_by\": {\n \"email\": \"ARJXEe@RMfVvxoWZTrbZbSm.xl\",\n \"telephone\": \"id Duis enim cu\",\n \"name\": \"ut mo\",\n \"first_name\": \"irure officia enim\",\n \"last_name\": \"elit non\",\n \"company_id\": \"sunt Excepteur\",\n \"company\": {\n \"name\": \"dolor ea\",\n \"address\": \"in\",\n \"postal_code\": \"nisi ad consequat\",\n \"city\": \"cillum\",\n \"branch\": \"esse in dolore\",\n \"address2\": \"velit eu quis\",\n \"country\": \"MD\",\n \"country_name\": \"aute elit do fugiat\",\n \"website\": \"irure ea aliqua\",\n \"vat_number\": \"ut sint aliqua\",\n \"logo\": \"http://pXzTXGrnyYmgkXeKTtCGUttpEATw.eeoDi2V1lCHZ3TWTrWNILk0M7G-IE4fI,Jo8\",\n \"logo_name\": \"laboris id\",\n \"created\": \"1993-07-29T13:20:10.928Z\",\n \"id\": \"80f1a2fc-48ff-39d7-bb83-3a11f1e48ff3\",\n \"verified_bank\": \"commodo\",\n \"verified_dnb\": \"veniam in dolor ut\"\n },\n \"logo\": \"https://IhlFoIG.etAnFbhlEHPhoT\",\n \"logo_name\": \"in\",\n \"id\": \"7bb02639-649e-35af-8e3d-f05f444fe1fc\"\n },\n \"uploaded_by_company_id\": \"irure sunt id nostrud\",\n \"uploaded_by_company\": {\n \"name\": \"fugiat deserunt ipsum incididunt\",\n \"address\": \"eiusmod occaecat\",\n \"postal_code\": \"in sint labore quis sed\",\n \"city\": \"mollit ea exercitation Lorem aliquip\",\n \"branch\": \"ut ea eu exercitation\",\n \"address2\": \"culpa anim\",\n \"country\": \"MX\",\n \"country_name\": \"dolor cillum repreh\",\n \"website\": \"eu ad exercitation qui\",\n \"vat_number\": \"culpa consectetur ullamco\",\n \"logo\": \"https://uPtGTbZgxpllTDYOZJdAGNMrjUa.gvkidqwfi,8XMSM,lHJGAqCI4Obg+0DmzLUOuXOBMfzAoZfqXuxA,yAK6sxx9\",\n \"logo_name\": \"amet enim com\",\n \"created\": \"1964-03-09T21:47:23.316Z\",\n \"id\": \"urn:uuid:3fb497ea-d986-10cf-3ab2-52fcc101981a\",\n \"verified_bank\": \"ex proident\",\n \"verified_dnb\": \"ullamco velit Ut\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"enim quis qui\",\n \"create_on_blockchain\": false,\n \"accomplisher_id\": \"Excepteur nulla eiusm\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"1989-05-28T11:12:23.489Z\",\n \"accomplished_by_id\": \"cupidatat ut\",\n \"accomplished_by_company_id\": \"reprehend\",\n \"destroyed\": \"1995-05-09T04:07:39.056Z\",\n \"destroyed_by_company_id\": \"ipsum sint cupidatat\",\n \"notify_parties\": [\n \"I23aU@xaYQuXzJAUWDnjjnclcniuxHa.cfat\",\n \"B0xvdW4oGny@qHBrzLwcbDKoTClxbOIdZgG.js\"\n ],\n \"meta_data\": {},\n \"display_name\": \"id dolore ut sed\",\n \"file_name\": \"consectetur\",\n \"file_size\": 1735132465,\n \"file_content_type\": \"dolor ea dolore nostrud id\",\n \"watermarkable\": false,\n \"icon\": \"do sint dolore amet\",\n \"file_type\": \"Dui\",\n \"created\": \"qui exercitation\",\n \"thumbnail\": \"https://hguXiaxffbdztORn.vwgxZS0U+enlkPwm9Id\",\n \"thumbnail_mime_type\": \"amet ipsum mollit\"\n },\n \"attachment_count\": -56659491,\n \"is_on_blockchain\": false,\n \"can_be_destroyed\": \"esse\",\n \"can_be_accomplished\": \"ea m\",\n \"destroy_pending\": \"ullamco nisi nostrud\",\n \"accomplish_pending\": \"Lorem ut fugiat do\",\n \"created\": \"anim sit\"\n },\n \"used_in_envelope_id\": \"ad enim\",\n \"used_in_envelope\": {\n \"id\": \"urn:uuid:7cdc3e85-9db2-4a3d-ffab-043d995b8e9a\",\n \"owner_id\": \"quis pariatur amet ad\",\n \"recipient_id\": \"fugiat dolore\",\n \"message\": \"occaecat mollit adipisicing non\",\n \"type\": \"et sunt eiusmod\",\n \"specialization_type\": \"acid\",\n \"created\": \"voluptate sunt\",\n \"sent\": \"1973-01-06T10:19:31.922Z\",\n \"archived\": \"1993-09-01T05:48:01.748Z\",\n \"delivered\": \"eu aute aliquip\",\n \"action_performed_by_id\": \"eu\",\n \"sealed\": false,\n \"can_be_sealed\": \"Excep\",\n \"is_draft\": \"mollit tempor\",\n \"sender_inbox_id\": \"sunt in labore\",\n \"delivered_envelope_opened\": false,\n \"delivery_status\": \"ad esse laboru\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": true,\n \"delivered_envelope_id\": \"nostrud amet aliquip\",\n \"failed_delivery_envelope_id\": \"et in magna\",\n \"failed_outgoing_id\": \"id do ipsum Ut incididunt\",\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"fugiat proident\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": true,\n \"created\": \"1993-02-02T06:37:26.946Z\"\n }\n ],\n \"created\": \"veniam ut in ea\",\n \"type\": \"eu enim irure Lorem amet\",\n \"specialization_type\": \"standard\",\n \"sender\": {\n \"name\": \"Duis labore aliquip\",\n \"address\": \"amet veniam laboris dolore\",\n \"postal_code\": \"et in sint\",\n \"city\": \"eu ea et\",\n \"branch\": \"ut officia\",\n \"address2\": \"dolor magna officia ex\",\n \"country\": \"IM\",\n \"country_name\": \"esse\",\n \"website\": \"incididunt eiusmod\",\n \"vat_number\": \"eu ut\",\n \"logo\": \"http://FoPAPMoVsOmEYnuuaL.pwhqFHehV.1ToBxUlW-t2DU+SmODA42iXcJzHV,tHr03,do7bHbZwJgvRgttpMPFNTptQtAXzX+iL2Db.kv\",\n \"logo_name\": \"sed consectetur d\",\n \"created\": \"2004-01-01T05:17:39.919Z\",\n \"id\": \"273d0d9c-7967-8e35-0575-458770b33133\",\n \"verified_bank\": \"in \",\n \"verified_dnb\": \"officia consequat mollit\"\n },\n \"sender_id\": \"sed\",\n \"sender_inbox_id\": \"Excepteur pariatur sunt\",\n \"message\": \"ad\",\n \"pay_to_collect_response\": 2,\n \"meta_data\": {},\n \"sent\": \"deserunt nostrud Duis\"\n}" } ] } ] }, { "name": "companies inboxes incoming-envelopes list list", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/incoming-envelopes/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "incoming-envelopes", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/incoming-envelopes/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "incoming-envelopes", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "inbox", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": \"64d61f60-1a22-6ff6-3fe2-f6a1009e5366\",\n \"owner_id\": \"est elit\",\n \"recipient_id\": \"aliquip occaecat exercitation irure\",\n \"attachments\": [\n {\n \"document_token_id\": \"adipisicing\",\n \"id\": \"7b86d06f-af50-ea7a-1a75-b0d34622da16\",\n \"envelope_id\": \"ullamco laborum irure est adipisicing\",\n \"document_token\": {\n \"id\": \"urn:uuid:62cd989f-e79a-3648-5374-ba6165c37b3b\",\n \"storage_type\": \"dolore reprehenderit irure\",\n \"watermark_generated\": true,\n \"ipfs_document_group_id\": \"anim nisi cillum consectetur\",\n \"ipfs_document_group\": \"803088d2-91e0-27f2-fede-01391f4711ff\",\n \"document_id\": \"elit sunt\",\n \"document\": {\n \"document_type\": \"nulla amet reprehenderit officia\",\n \"create_on_blockchain_override\": false,\n \"id\": \"urn:uuid:abd428d9-2ff9-039c-b321-01f66198ae3e\",\n \"current_owner_id\": \"est Ut nulla velit fugiat\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"aute occaecat culpa sunt anim\",\n \"uploaded_by\": {\n \"email\": \"j5oz6rjuRG69TbI@rdnSg.gcf\",\n \"telephone\": \"adipisicing nulla aliqua\",\n \"name\": \"in deserunt \",\n \"first_name\": \"Excepteur quis occaecat proident\",\n \"last_name\": \"consectetur Excepteur\",\n \"company_id\": \"tempor minim\",\n \"company\": {\n \"name\": \"ad adipisicing in\",\n \"address\": \"mollit sint\",\n \"postal_code\": \"do veniam cillum\",\n \"city\": \"cupidatat non deserunt Duis enim\",\n \"branch\": \"aute aliquip\",\n \"address2\": \"nulla ex velit\",\n \"country\": \"MF\",\n \"country_name\": \"nulla\",\n \"website\": \"nisi in anim\",\n \"vat_number\": \"ullamco Ut deserunt\",\n \"logo\": \"http://NaoheMLbTrswIhiV.xaawPLHYxCIgM2vG63,oRTD\",\n \"logo_name\": \"veniam id\",\n \"created\": \"1983-08-20T20:30:47.378Z\",\n \"id\": \"deaa2fa2-f782-ec53-c33a-0bce44778ba0\",\n \"verified_bank\": \"pariatur minim labori\",\n \"verified_dnb\": \"pariatur in incididunt aliqu\"\n },\n \"logo\": \"https://NkR.zvibfMuSCSJ.sdvbb1qzfKcyntHqGSlhAgmm8+ULiQQC.qcm\",\n \"logo_name\": \"officia ex Duis nostrud\",\n \"id\": \"1cf2cd7b-fbe3-012d-6be1-a303aba7f5b2\"\n },\n \"uploaded_by_company_id\": \"dolore in laboris magna\",\n \"uploaded_by_company\": {\n \"name\": \"consequat laboris est\",\n \"address\": \"minim consequat\",\n \"postal_code\": \"amet Ut\",\n \"city\": \"enim aliqua\",\n \"branch\": \"Duis\",\n \"address2\": \"amet su\",\n \"country\": \"BS\",\n \"country_name\": \"id aliqua mollit velit sint\",\n \"website\": \"qui aliquip nostrud veniam irure\",\n \"vat_number\": \"aute Ut\",\n \"logo\": \"http://QXQUTBwGdvReSMXEyMAMw.wosvv6O1pgTEl4mtNHCjNo219bgU7JaKNy3G43fpv+hSeu8wmkQDiAGtEBZa8w,h-8c.Af4fpAo\",\n \"logo_name\": \"exercitation\",\n \"created\": \"1996-04-22T05:17:47.726Z\",\n \"id\": \"urn:uuid:dbe60eae-72bb-bd63-68ce-0b5ed8253ef7\",\n \"verified_bank\": \"consequat irure\",\n \"verified_dnb\": \"reprehenderit non cupidatat mollit\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"non tempor\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"deserunt ea sit\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"1955-06-04T17:43:51.856Z\",\n \"accomplished_by_id\": \"in consectetur irure magna\",\n \"accomplished_by_company_id\": \"sint laborum\",\n \"destroyed\": \"2002-01-23T07:42:31.720Z\",\n \"destroyed_by_company_id\": \"ullamco ut\",\n \"notify_parties\": [\n \"Frw7KW@sHXhcxAUqMiVpjMpIICjzWjGlnKrxjpYX.rh\",\n \"dgX@eOgqdjBNDbBciIjlypIsIgQvQMPXVGQZN.fvfr\"\n ],\n \"meta_data\": {},\n \"display_name\": \"ad esse Duis\",\n \"file_name\": \"deserunt cupida\",\n \"file_size\": 992108688,\n \"file_content_type\": \"Lorem amet dolor\",\n \"watermarkable\": false,\n \"icon\": \"ullamco\",\n \"file_type\": \"dolore magna est\",\n \"created\": \"Lorem aliquip\",\n \"thumbnail\": \"https://lDEowPHYrpHa.ncFoPQKwW8HW+3twAV,C43yTpoI,\",\n \"thumbnail_mime_type\": \"Lorem ex\"\n },\n \"attachment_count\": 51752124,\n \"is_on_blockchain\": true,\n \"can_be_destroyed\": \"consec\",\n \"can_be_accomplished\": \"nulla dolore quis minim\",\n \"destroy_pending\": \"adipisicing laboris\",\n \"accomplish_pending\": \"fugiat\",\n \"created\": \"nostrud Ut voluptate elit ut\"\n },\n \"used_in_envelope_id\": \"ea s\",\n \"used_in_envelope\": {\n \"id\": \"urn:uuid:e965988d-a8c1-155d-b6cc-ab6b210b7830\",\n \"owner_id\": \"non cillum labore\",\n \"recipient_id\": \"id voluptate reprehenderit minim\",\n \"message\": \"eu laboris\",\n \"type\": \"dolor laboris a\",\n \"specialization_type\": \"standard\",\n \"created\": \"qui\",\n \"sent\": \"1996-09-24T01:40:33.155Z\",\n \"archived\": \"1944-03-12T20:35:19.984Z\",\n \"delivered\": \"aute do in\",\n \"action_performed_by_id\": \"mollit ut\",\n \"sealed\": false,\n \"can_be_sealed\": \"Excepteur sit\",\n \"is_draft\": \"consectetur cillum laborum tempor nulla\",\n \"sender_inbox_id\": \"laboris Lorem eiusmod exercitation\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"magna anim\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": false,\n \"delivered_envelope_id\": \"ipsum\",\n \"failed_delivery_envelope_id\": \"sed Duis sunt\",\n \"failed_outgoing_id\": \"in officia ex\",\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"cupidatat par\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": false,\n \"created\": \"1995-01-25T21:29:26.549Z\"\n },\n {\n \"document_token_id\": \"cillum fugiat amet\",\n \"id\": \"urn:uuid:798fe0d0-1dd1-4ec8-bdb0-f31cd0056182\",\n \"envelope_id\": \"u\",\n \"document_token\": {\n \"id\": \"a6bbf880-0926-74be-fe82-5560de1bcfa2\",\n \"storage_type\": \"est\",\n \"watermark_generated\": false,\n \"ipfs_document_group_id\": \"proident aliquip ipsum occaecat Duis\",\n \"ipfs_document_group\": \"urn:uuid:bed6606d-1979-6cc2-1156-bac1f9bb99e9\",\n \"document_id\": \"aliqua amet\",\n \"document\": {\n \"document_type\": \"dolor\",\n \"create_on_blockchain_override\": true,\n \"id\": \"urn:uuid:dc799404-b50a-c024-b461-13035d4396d5\",\n \"current_owner_id\": \"fugiat officia commodo\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"anim voluptate culpa\",\n \"uploaded_by\": {\n \"email\": \"1j96JKq0@yGtJE.cbns\",\n \"telephone\": \"officia aliqua consectetur eiusmod culpa\",\n \"name\": \"labore anim ut \",\n \"first_name\": \"sint magna pariatur dolor proident\",\n \"last_name\": \"Lorem sit dolor\",\n \"company_id\": \"dolore non consectetur do\",\n \"company\": {\n \"name\": \"et non\",\n \"address\": \"labore id adipisicing\",\n \"postal_code\": \"pariatur aute Duis\",\n \"city\": \"in mollit exercitation dolore\",\n \"branch\": \"aute minim\",\n \"address2\": \"Duis quis magna laboris\",\n \"country\": \"DO\",\n \"country_name\": \"voluptate magna pariatur qui\",\n \"website\": \"sed deserunt aliquip ex mollit\",\n \"vat_number\": \"labore sed ullamco\",\n \"logo\": \"http://AMmCZPydOehLFogFExrnnjSsOUAPZfu.oqthYeGl4pGZgBkP6DmxDKalu1TuVaiBN\",\n \"logo_name\": \"ut proident non Lorem\",\n \"created\": \"1956-11-23T20:37:36.640Z\",\n \"id\": \"urn:uuid:0c4a7fe8-802e-ac69-03a1-0df1388097ee\",\n \"verified_bank\": \"eu\",\n \"verified_dnb\": \"eiusmod ad nisi\"\n },\n \"logo\": \"http://DhtXVlbweJPUoXIZqEHCoSG.xmfoS4HdDLtSaXpVVBBF1Rj6O7w\",\n \"logo_name\": \"qui id magna minim cillum\",\n \"id\": \"30f74c5a-f40c-90a3-c467-700d88f7a911\"\n },\n \"uploaded_by_company_id\": \"incididunt velit ut\",\n \"uploaded_by_company\": {\n \"name\": \"tempor adipisicing deserunt\",\n \"address\": \"et tempor\",\n \"postal_code\": \"culpa reprehenderit Ut\",\n \"city\": \"eiusmod ut\",\n \"branch\": \"sed enim eiusmod\",\n \"address2\": \"labore ut cillum culpa in\",\n \"country\": \"AE\",\n \"country_name\": \"adipisicing officia labore velit et\",\n \"website\": \"occaecat dolor\",\n \"vat_number\": \"sed\",\n \"logo\": \"http://IssSQgmdwvtiAFncRudip.tfiXqwYpfJ.sMuHN\",\n \"logo_name\": \"ex dolor est nulla\",\n \"created\": \"1970-05-03T13:59:25.506Z\",\n \"id\": \"urn:uuid:7ffe3ae1-bf86-558a-4fa0-8b8c90715524\",\n \"verified_bank\": \"est consequat\",\n \"verified_dnb\": \"do pariatur nulla Excepteur ex\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"fugiat ullamco consectetur ea\",\n \"create_on_blockchain\": true,\n \"accomplisher_id\": \"minim\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"2016-03-19T03:50:52.216Z\",\n \"accomplished_by_id\": \"ad culpa Excepteur\",\n \"accomplished_by_company_id\": \"tempor enim\",\n \"destroyed\": \"1971-04-19T07:39:42.886Z\",\n \"destroyed_by_company_id\": \"mollit elit consequat\",\n \"notify_parties\": [\n \"bSWhA5ruz1rXUg@BEGrftuFlFaIxoLWJvHXQ.qag\",\n \"aEW@ePbwFHtkThZVlotrYDwWC.rj\"\n ],\n \"meta_data\": {},\n \"display_name\": \"do dolore veniam fugiat\",\n \"file_name\": \"pariatur magna\",\n \"file_size\": -365579924,\n \"file_content_type\": \"ea velit ad Lorem est\",\n \"watermarkable\": false,\n \"icon\": \"aliquip\",\n \"file_type\": \"occaecat dolor ullamco sunt in\",\n \"created\": \"cupidatat veni\",\n \"thumbnail\": \"https://kTEMwyjyI.hourfTcqK1vGa.M6b-Lfvh0n37QW5iOARTyT+1\",\n \"thumbnail_mime_type\": \"sunt in velit fugiat\"\n },\n \"attachment_count\": -61435393,\n \"is_on_blockchain\": false,\n \"can_be_destroyed\": \"Duis laborum\",\n \"can_be_accomplished\": \"ullamco quis velit\",\n \"destroy_pending\": \"commodo labore qui in amet\",\n \"accomplish_pending\": \"in sint id\",\n \"created\": \"irure ex eiusmod\"\n },\n \"used_in_envelope_id\": \"proident id non officia\",\n \"used_in_envelope\": {\n \"id\": \"urn:uuid:506669df-fd79-af69-529e-b429505db852\",\n \"owner_id\": \"est ut deserunt eu\",\n \"recipient_id\": \"do ex\",\n \"message\": \"id Ut in\",\n \"type\": \"dolor proident commodo\",\n \"specialization_type\": \"acid\",\n \"created\": \"p\",\n \"sent\": \"1984-09-03T04:12:20.146Z\",\n \"archived\": \"1977-05-20T05:19:05.952Z\",\n \"delivered\": \"qui id laborum velit\",\n \"action_performed_by_id\": \"in amet\",\n \"sealed\": false,\n \"can_be_sealed\": \"sunt magna commodo voluptate occaecat\",\n \"is_draft\": \"Ut anim ea irure\",\n \"sender_inbox_id\": \"id dolore Excepteur esse sed\",\n \"delivered_envelope_opened\": false,\n \"delivery_status\": \"sint\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": false,\n \"delivered_envelope_id\": \"est eu anim tempor ut\",\n \"failed_delivery_envelope_id\": \"est velit\",\n \"failed_outgoing_id\": \"proident magna ea do in\",\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": true,\n \"created\": \"1986-08-27T03:30:16.553Z\"\n }\n ],\n \"created\": \"laborum Lorem sunt officia\",\n \"type\": \"consectetur labore\",\n \"specialization_type\": \"standard\",\n \"sender\": {\n \"name\": \"ut ullamco\",\n \"address\": \"tempor\",\n \"postal_code\": \"ad elit\",\n \"city\": \"esse culpa\",\n \"branch\": \"proident reprehenderit deserunt fugiat\",\n \"address2\": \"aliquip proident laboris sed\",\n \"country\": \"AR\",\n \"country_name\": \"dolore nisi mollit\",\n \"website\": \"commodo\",\n \"vat_number\": \"ullamco cupidatat esse\",\n \"logo\": \"https://SSMsEtLsjk.uxnqmDuC8O\",\n \"logo_name\": \"commodo quis\",\n \"created\": \"2003-03-24T23:16:40.488Z\",\n \"id\": \"urn:uuid:b38ebf3d-1517-fdc5-b92d-61db20d8d3aa\",\n \"verified_bank\": \"in eiusmod sit dolor\",\n \"verified_dnb\": \"non anim enim\"\n },\n \"sender_id\": \"et consequat\",\n \"sender_inbox_id\": \"adipisicing sunt\",\n \"message\": \"sed Excepteur in\",\n \"pay_to_collect_response\": 2,\n \"meta_data\": {},\n \"sent\": \"labore incididunt\"\n },\n {\n \"id\": \"d9a3c7e2-38bd-0253-c04a-9a277b7ca285\",\n \"owner_id\": \"culpa deserunt velit cupidatat\",\n \"recipient_id\": \"in Duis et\",\n \"attachments\": [\n {\n \"document_token_id\": \"aliquip a\",\n \"id\": \"c1c0cabd-d85a-becb-be4a-29f4ebdc76f4\",\n \"envelope_id\": \"cupidatat\",\n \"document_token\": {\n \"id\": \"urn:uuid:37960fc0-7814-7fa8-ecaf-e3b3b430c4ab\",\n \"storage_type\": \"dolor quis ut sit\",\n \"watermark_generated\": true,\n \"ipfs_document_group_id\": \"officia sed eu consectetur culpa\",\n \"ipfs_document_group\": \"urn:uuid:ad5f97aa-8d32-0f6f-108d-230b7e0d5b10\",\n \"document_id\": \"non Duis sint\",\n \"document\": {\n \"document_type\": \"consectetur\",\n \"create_on_blockchain_override\": false,\n \"id\": \"urn:uuid:a7e0e469-b195-2a30-0db6-ff787a4e6357\",\n \"current_owner_id\": \"ex magna\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"fugiat\",\n \"uploaded_by\": {\n \"email\": \"glrgzJiCVCWRL@gUYbljUpYoLOPJL.djcf\",\n \"telephone\": \"pariatur proident\",\n \"name\": \"minim ex\",\n \"first_name\": \"incididunt veniam aliqua non\",\n \"last_name\": \"quis Ut aliquip\",\n \"company_id\": \"mollit minim elit\",\n \"company\": {\n \"name\": \"sunt deserunt\",\n \"address\": \"irure dolore magna\",\n \"postal_code\": \"aute aliquip\",\n \"city\": \"cillum cupidatat minim culpa\",\n \"branch\": \"et aliquip\",\n \"address2\": \"velit dolore\",\n \"country\": \"GL\",\n \"country_name\": \"laboris Ut do\",\n \"website\": \"labore amet magna aliquip\",\n \"vat_number\": \"proident\",\n \"logo\": \"http://COSBiHON.wdorUfnZKfLBr\",\n \"logo_name\": \"cillum ut aute nisi\",\n \"created\": \"1996-03-12T10:32:09.900Z\",\n \"id\": \"3e813f32-291a-9ffc-d974-b59a1ebbdf33\",\n \"verified_bank\": \"cillum sed Excepteur nostrud cupidatat\",\n \"verified_dnb\": \"in\"\n },\n \"logo\": \"https://v.lboglQUn.5z.F5LYNvfvp7Ae6gvWmHeahoip\",\n \"logo_name\": \"magna esse ut sed\",\n \"id\": \"urn:uuid:431a1172-8c9a-b59e-eea6-ea35acd9f6c2\"\n },\n \"uploaded_by_company_id\": \"velit\",\n \"uploaded_by_company\": {\n \"name\": \"ut velit do ad sit\",\n \"address\": \"do enim ex exercitation ut\",\n \"postal_code\": \"culpa\",\n \"city\": \"reprehenderit minim\",\n \"branch\": \"aute voluptate Excepteur\",\n \"address2\": \"ad reprehenderit\",\n \"country\": \"KZ\",\n \"country_name\": \"ut\",\n \"website\": \"Excepteur consectetur incididunt\",\n \"vat_number\": \"labore amet minim sed dolor\",\n \"logo\": \"https://wUwmgxWoySdNZauAk.lzumghsJbDjOG3ReOgCGdCFSvtnCdGhgvDs7d6XsnfYi\",\n \"logo_name\": \"do\",\n \"created\": \"1962-06-17T20:31:39.725Z\",\n \"id\": \"af7430fc-acd7-8dad-8fd3-9f001b4f07c6\",\n \"verified_bank\": \"esse \",\n \"verified_dnb\": \"Ut\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"adipisicing dolor nulla sed\",\n \"create_on_blockchain\": false,\n \"accomplisher_id\": \"Duis sunt ad\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"1954-04-05T01:27:18.021Z\",\n \"accomplished_by_id\": \"Lorem irure aute proident\",\n \"accomplished_by_company_id\": \"do occaecat pariatur\",\n \"destroyed\": \"2017-05-06T16:09:41.700Z\",\n \"destroyed_by_company_id\": \"proident do irure\",\n \"notify_parties\": [\n \"4W5QUbPCPDC@ELtSqYovOVVpyxecvPbSslCp.gx\",\n \"zZPzCfk50Q@blJrUNtWAYYKwGypBhPWmD.yno\"\n ],\n \"meta_data\": {},\n \"display_name\": \"culpa\",\n \"file_name\": \"irure vol\",\n \"file_size\": 1860762693,\n \"file_content_type\": \"Lorem co\",\n \"watermarkable\": false,\n \"icon\": \"nisi eiusmod Excepteur esse anim\",\n \"file_type\": \"mollit consequat officia\",\n \"created\": \"commodo pariatur laborum esse\",\n \"thumbnail\": \"http://ht.pogbiVt+LCxJGTgQXakIph1QuWANqMyMJ,W468.lPzNftVRicv4uN\",\n \"thumbnail_mime_type\": \"in cupidatat\"\n },\n \"attachment_count\": 78672481,\n \"is_on_blockchain\": true,\n \"can_be_destroyed\": \"Lorem eiusmod\",\n \"can_be_accomplished\": \"deserunt commodo pariatur\",\n \"destroy_pending\": \"commodo incididunt\",\n \"accomplish_pending\": \"dolor labore Except\",\n \"created\": \"ea enim ut\"\n },\n \"used_in_envelope_id\": \"et anim\",\n \"used_in_envelope\": {\n \"id\": \"urn:uuid:c8b1e017-aa45-5246-2364-30a91efd285a\",\n \"owner_id\": \"enim voluptate tempor consequat\",\n \"recipient_id\": \"et pariatur qui amet ad\",\n \"message\": \"ea nulla sit occaecat\",\n \"type\": \"tempor fugiat in consequat\",\n \"specialization_type\": \"acid\",\n \"created\": \"nulla in\",\n \"sent\": \"1950-10-21T02:47:22.086Z\",\n \"archived\": \"1987-02-26T14:27:22.157Z\",\n \"delivered\": \"esse\",\n \"action_performed_by_id\": \"non consectetur aute\",\n \"sealed\": false,\n \"can_be_sealed\": \"voluptate eiusmod\",\n \"is_draft\": \"id Duis dolor ea\",\n \"sender_inbox_id\": \"amet\",\n \"delivered_envelope_opened\": false,\n \"delivery_status\": \"Duis in dolor\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": false,\n \"delivered_envelope_id\": \"dolore eu aute\",\n \"failed_delivery_envelope_id\": \"tempor aliquip id labore velit\",\n \"failed_outgoing_id\": \"et mollit tempor consequat\",\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"culpa velit Ut e\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": true,\n \"created\": \"1955-03-10T13:19:00.377Z\"\n },\n {\n \"document_token_id\": \"sunt Duis tempor sint\",\n \"id\": \"urn:uuid:34ea3cd2-6755-cd60-e776-9bf6d5bef67f\",\n \"envelope_id\": \"amet sed consequat\",\n \"document_token\": {\n \"id\": \"4f94b6a2-8369-c751-b985-6dce223d203b\",\n \"storage_type\": \"U\",\n \"watermark_generated\": false,\n \"ipfs_document_group_id\": \"eu in est\",\n \"ipfs_document_group\": \"962d750e-e108-449f-0aa2-f4b953e690b6\",\n \"document_id\": \"do ut veniam nulla\",\n \"document\": {\n \"document_type\": \"Ut pariatur commodo aute\",\n \"create_on_blockchain_override\": false,\n \"id\": \"383afeec-8941-f9b1-ec56-cd61072f7e25\",\n \"current_owner_id\": \"non minim ea exercitation\",\n \"current_owner\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"uploaded_by_id\": \"officia ut laboris\",\n \"uploaded_by\": {\n \"email\": \"6zUgBfqV5kMEPG@vjwYGnbMKXvIWCyfXUcPUkvQqkZuvlH.uny\",\n \"telephone\": \"laboris irure commodo\",\n \"name\": \"cillum aliquip\",\n \"first_name\": \"sit ad\",\n \"last_name\": \"sint proident\",\n \"company_id\": \"ullamco magna Lorem\",\n \"company\": {\n \"name\": \"ut consequat ullamco\",\n \"address\": \"amet dolore laboris reprehenderit\",\n \"postal_code\": \"et magna eiusmod dolore\",\n \"city\": \"Lorem eu mollit reprehenderit\",\n \"branch\": \"do adipisicing officia sint\",\n \"address2\": \"mollit ullamco\",\n \"country\": \"YE\",\n \"country_name\": \"cupidatat in amet sunt\",\n \"website\": \"ea\",\n \"vat_number\": \"minim Excepteur\",\n \"logo\": \"https://YdGnxMJKhWlgSMKuZ.fkawGduVAEGXb,G5Ad06P2cHNz6Fk6xshCEeGAP\",\n \"logo_name\": \"irure\",\n \"created\": \"1967-04-09T13:36:16.814Z\",\n \"id\": \"04c624df-0262-0c44-71b6-73977a692dae\",\n \"verified_bank\": \"enim laboris ad adipisicing fugiat\",\n \"verified_dnb\": \"dolore irure\"\n },\n \"logo\": \"https://NIceSjxxDaNegYE.sdmkrjC\",\n \"logo_name\": \"qui adipisicing irure cupidatat\",\n \"id\": \"bb86fe1f-7b45-d3e5-0f44-3281733c7407\"\n },\n \"uploaded_by_company_id\": \"laboris sunt\",\n \"uploaded_by_company\": {\n \"name\": \"magna in culpa eiusmod\",\n \"address\": \"occaecat Ut\",\n \"postal_code\": \"velit eiusmod ad Duis ex\",\n \"city\": \"commodo ullamco qui pariat\",\n \"branch\": \"dolore veniam laborum\",\n \"address2\": \"quis\",\n \"country\": \"SO\",\n \"country_name\": \"eiusmod deserunt\",\n \"website\": \"pariatur nostrud\",\n \"vat_number\": \"ullamco incididunt enim irure\",\n \"logo\": \"http://A.ffmiw+1jh6SF\",\n \"logo_name\": \"ut aliquip dolor\",\n \"created\": \"1971-07-09T05:15:59.153Z\",\n \"id\": \"urn:uuid:d43d7370-1f91-c8a1-ff96-c115fbc5f29e\",\n \"verified_bank\": \"esse ullamco in\",\n \"verified_dnb\": \"minim deserunt Duis\"\n },\n \"type\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"short_name\": {\n \"value\": \"\"\n },\n \"color\": {\n \"value\": \"\"\n },\n \"categories\": {\n \"value\": \"\"\n },\n \"is_smart_bl\": {\n \"value\": \"\"\n },\n \"blockchain_support\": {\n \"value\": \"\"\n },\n \"create_on_blockchain\": {\n \"value\": \"\"\n },\n \"transfer_on_blockchain\": {\n \"value\": \"\"\n },\n \"document_id_required\": {\n \"value\": \"\"\n },\n \"document_id_title\": {\n \"value\": \"\"\n },\n \"document_id_description\": {\n \"value\": \"\"\n },\n \"accomplisher_required\": {\n \"value\": \"\"\n },\n \"accomplisher_selectable\": {\n \"value\": \"\"\n },\n \"accomplisher_title\": {\n \"value\": \"\"\n },\n \"accomplisher_description\": {\n \"value\": \"\"\n },\n \"accomplish_action_string\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_review_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_step_button\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_in_progress_content\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_success_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_title\": {\n \"value\": \"\"\n },\n \"accomplish_sign_error_message_text\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_document_state\": {\n \"value\": \"\"\n },\n \"accomplish_notify_email_subject_action\": {\n \"value\": \"\"\n },\n \"meta_tag_suggestions\": {\n \"value\": \"\"\n },\n \"issue_price_millicents\": {\n \"value\": \"\"\n },\n \"blockchain_transfer_limit\": {\n \"value\": \"\"\n },\n \"retention_period\": {\n \"value\": \"\"\n }\n },\n \"document_id\": \"esse in velit do\",\n \"create_on_blockchain\": false,\n \"accomplisher_id\": \"nulla dolore\",\n \"accomplisher\": {\n \"company\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"company_id\": {\n \"value\": \"\"\n },\n \"ethereum_address\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n },\n \"accomplished\": \"1947-11-15T10:30:02.812Z\",\n \"accomplished_by_id\": \"consequat amet aliqua laborum\",\n \"accomplished_by_company_id\": \"officia in ut commodo\",\n \"destroyed\": \"2006-10-31T03:25:00.929Z\",\n \"destroyed_by_company_id\": \"nisi reprehenderit Excepteur\",\n \"notify_parties\": [\n \"LpAU-DZHT7e@AjlM.pyj\",\n \"92ZsuLbpn6HkM@BbftXbvOCsSEHItgUlDSUhzIz.erw\"\n ],\n \"meta_data\": {},\n \"display_name\": \"dolor occaecat\",\n \"file_name\": \"Duis quis ex in\",\n \"file_size\": 61732688,\n \"file_content_type\": \"amet ex\",\n \"watermarkable\": false,\n \"icon\": \"ea\",\n \"file_type\": \"aliqua veniam sun\",\n \"created\": \"ad officia do\",\n \"thumbnail\": \"http://eoayczWYyyBnSkAoC.dljO8UC4AUoXLmoSQ5gyCNPKvSZhrTcQ64MCMkp-jdPxl2c\",\n \"thumbnail_mime_type\": \"voluptate dolore\"\n },\n \"attachment_count\": 5255686,\n \"is_on_blockchain\": true,\n \"can_be_destroyed\": \"cupidatat ad minim\",\n \"can_be_accomplished\": \"ad ea\",\n \"destroy_pending\": \"amet officia eu commodo\",\n \"accomplish_pending\": \"qui officia\",\n \"created\": \"reprehenderit voluptate\"\n },\n \"used_in_envelope_id\": \"aliqua\",\n \"used_in_envelope\": {\n \"id\": \"urn:uuid:d515c68c-4361-1bf9-02c0-c41bf9a0a755\",\n \"owner_id\": \"in voluptate dolor adipisicing\",\n \"recipient_id\": \"non dolore\",\n \"message\": \"aliqua cillum ea tempor\",\n \"type\": \"occaecat pariatur\",\n \"specialization_type\": \"acid\",\n \"created\": \"id ea laboris\",\n \"sent\": \"1949-08-08T13:48:34.114Z\",\n \"archived\": \"1963-08-12T20:24:45.077Z\",\n \"delivered\": \"nulla ut quis\",\n \"action_performed_by_id\": \"officia\",\n \"sealed\": false,\n \"can_be_sealed\": \"aute mollit velit elit\",\n \"is_draft\": \"\",\n \"sender_inbox_id\": \"sunt dolor incididunt ut Duis\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"labore anim\",\n \"can_be_archived\": false,\n \"can_be_unarchived\": false,\n \"delivered_envelope_id\": \"labore eu ex sunt aliqua\",\n \"failed_delivery_envelope_id\": \"incididunt voluptate dolor\",\n \"failed_outgoing_id\": \"qui dolore enim ullamco\",\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"est dolor nulla do in\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": false,\n \"created\": \"1951-03-05T06:04:00.321Z\"\n }\n ],\n \"created\": \"do sit in\",\n \"type\": \"labore culpa aute anim voluptate\",\n \"specialization_type\": \"standard\",\n \"sender\": {\n \"name\": \"cupidatat sit\",\n \"address\": \"anim in\",\n \"postal_code\": \"anim exercitation in deserunt occaecat\",\n \"city\": \"tempor culpa Duis\",\n \"branch\": \"pariatur laborum non Duis\",\n \"address2\": \"elit dolore\",\n \"country\": \"MS\",\n \"country_name\": \"incididunt officia\",\n \"website\": \"in\",\n \"vat_number\": \"mollit\",\n \"logo\": \"http://DoMaPx.fygldpjgzD46rkOuHG3,\",\n \"logo_name\": \"qui irure nostrud amet\",\n \"created\": \"1968-03-24T09:19:44.605Z\",\n \"id\": \"0002531d-f977-39d0-aa31-0f15068157c1\",\n \"verified_bank\": \"et est quis proident\",\n \"verified_dnb\": \"Lorem voluptate elit\"\n },\n \"sender_id\": \"est occaecat co\",\n \"sender_inbox_id\": \"id\",\n \"message\": \"minim aute adipisicing cupidatat\",\n \"pay_to_collect_response\": 1,\n \"meta_data\": {},\n \"sent\": \"mollit reprehenderit ull\"\n }\n]" } ] } ] }, { "name": "Retrieve inbox", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] }, "description": "Retrieves a single inbox of a company that the logged in 3rd-party system is\n allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"culpa\",\n \"company_id\": \"Ut in in consequat\",\n \"ethereum_address\": \"0xeaC6Dd7ac589aDCD6bAE0bFc22Cd9d4706D73EE3\",\n \"id\": \"urn:uuid:6851cbb5-28d2-4098-9b82-1b77b83a7992\"\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company or inbox is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Update inbox", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"aute\",\n \"ethereum_address\": \"0xa7AE7CbE813ac453189f32c009748b5117C12978\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] }, "description": "Updates the inbox. All data needs to be present to perform an update. If data is incomplete,\n please use a `PATCH` call. Inboxes cannot be moved between companies." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"culpa\",\n \"company_id\": \"Ut in in consequat\",\n \"ethereum_address\": \"0xeaC6Dd7ac589aDCD6bAE0bFc22Cd9d4706D73EE3\",\n \"id\": \"urn:uuid:6851cbb5-28d2-4098-9b82-1b77b83a7992\"\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company or inbox is not found.", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Partially update inbox", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"aute\",\n \"ethereum_address\": \"0xa7AE7CbE813ac453189f32c009748b5117C12978\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] }, "description": "Partially updates the inbox. Only the data that needs to be changed is required.\n Inboxes cannot be moved between companies." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"culpa\",\n \"company_id\": \"Ut in in consequat\",\n \"ethereum_address\": \"0xeaC6Dd7ac589aDCD6bAE0bFc22Cd9d4706D73EE3\",\n \"id\": \"urn:uuid:6851cbb5-28d2-4098-9b82-1b77b83a7992\"\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company or inbox is not found.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Delete inbox", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] }, "description": "Deletes a single inbox entry of a user that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Returned when inbox is successfully deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company or inbox is not found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/:inbox/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", ":inbox", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe inbox identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine inbox by its ID. Replace `{id}` with internal inbox uuid. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Create inbox", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"aute\",\n \"ethereum_address\": \"0xa7AE7CbE813ac453189f32c009748b5117C12978\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "inboxes", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "Creates a new inbox for a company that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "inboxes", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"culpa\",\n \"company_id\": \"Ut in in consequat\",\n \"ethereum_address\": \"0xeaC6Dd7ac589aDCD6bAE0bFc22Cd9d4706D73EE3\",\n \"id\": \"urn:uuid:6851cbb5-28d2-4098-9b82-1b77b83a7992\"\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "inboxes", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "List inboxes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/list/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "inboxes", "list", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "Lists all company inboxes that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"culpa\",\n \"company_id\": \"Ut in in consequat\",\n \"ethereum_address\": \"0xeaC6Dd7ac589aDCD6bAE0bFc22Cd9d4706D73EE3\",\n \"id\": \"urn:uuid:6851cbb5-28d2-4098-9b82-1b77b83a7992\"\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company or inbox is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/inboxes/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "inboxes", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "invoices", "item": [ { "name": "{invoice}", "item": [ { "name": "Retrieve invoice", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/invoices/:invoice/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "invoices", ":invoice", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "invoice", "value": "cons", "description": "(Required) \nThe invoice identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the invoice by its ID. Replace `{id}` with internal invoice id. |\n" } ] }, "description": "Retrieves a single invoice of a company that the logged in 3rd-party system is\n allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/invoices/:invoice/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "invoices", ":invoice", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "invoice", "value": "cons", "description": "(Required) \nThe invoice identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the invoice by its ID. Replace `{id}` with internal invoice id. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"payment_type_id\": \"mollit adipisicing sint quis\",\n \"id\": \"urn:uuid:ed81be2f-2089-e66c-23d0-a136bd585456\",\n \"company_id\": \"volup\",\n \"proforma_invoice_id\": \"proident cillum nostrud quis\",\n \"type\": \"consequat fugiat mollit ex\",\n \"currency\": \"sit\",\n \"amount_of_credits\": \"quis\",\n \"amount_of_promotional_credits\": \"cillum amet\",\n \"subtotal\": \"nulla minim velit fugiat\",\n \"service_fee_amount\": \"dolor qui\",\n \"total_without_vat\": \"est in Ut qui\",\n \"vat_amount\": \"aute nostrud consequat aliquip\",\n \"total\": \"cupidatat aute cillum commodo tempor\",\n \"service_fee_percent\": \"Ut reprehend\",\n \"vat_percent\": \"Ut mollit\",\n \"credit_package_id\": \"nisi elit in Duis\",\n \"subscription_tier_id\": \"consequat Excepteur Ut dolor velit\",\n \"number_of_users\": 58289406,\n \"yearly_billing\": false,\n \"payment_deadline\": \"1969-01-24\",\n \"issue_date\": \"2013-03-10\",\n \"number\": \"consectetur laborum\",\n \"is_overdue\": true,\n \"is_unpaid\": false,\n \"cancelled\": false,\n \"payment_completed\": true,\n \"document\": \"https://tIfIEtvYSKWlJilcqQAoTTgZC.uxk9XWCfNqWeKWNUfx2w,pQmXO9f0B0wjD0zztuPq3JWbHth,vvqaB.uMvIAst1VO0I+\",\n \"created\": \"2014-09-17T03:55:11.450Z\"\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/invoices/:invoice/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "invoices", ":invoice", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "invoice", "value": "cons", "description": "(Required) \nThe invoice identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the invoice by its ID. Replace `{id}` with internal invoice id. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company or invoice is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/invoices/:invoice/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "invoices", ":invoice", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "invoice", "value": "cons", "description": "(Required) \nThe invoice identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the invoice by its ID. Replace `{id}` with internal invoice id. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Invoice document download", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/invoices/:invoice/attachment/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "invoices", ":invoice", "attachment", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "invoice", "value": "cons", "description": "(Required) \nThe invoice identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the invoice by its ID. Replace `{id}` with internal invoice id. |\n" } ] }, "description": "This endpoint enables you to download invoice in PDF format." }, "response": [ { "name": "The login token that can be used to seamlessly login the user without entering the username and password. Particularly useful in solutions where CargoX is loaded via `iframe`.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/invoices/:invoice/attachment/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "invoices", ":invoice", "attachment", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "invoice", "value": "cons", "description": "(Required) \nThe invoice identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the invoice by its ID. Replace `{id}` with internal invoice id. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"login_token\": \"voluptate dolor\",\n \"expires\": \"1964-09-21T19:58:04.791Z\",\n \"login_url\": \"https://IRxAwgkgllcue.gzFIQXGT,HHsNRh0vzgvbNWNQ3bAwgL,SyEGBQsqG6Os2L\"\n}" }, { "name": "Returned when the authenticated user is not a 3rd-party company.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/invoices/:invoice/attachment/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "invoices", ":invoice", "attachment", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "invoice", "value": "cons", "description": "(Required) \nThe invoice identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the invoice by its ID. Replace `{id}` with internal invoice id. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "List invoices", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/invoices/list/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "invoices", "list", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "Lists all invoices of companies that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/invoices/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "invoices", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"payment_type_id\": \"est sed magna eiusmod\",\n \"id\": \"a0ffaf4c-c881-5a49-55da-b1f066c22a56\",\n \"company_id\": \"commodo cupidatat ipsum in elit\",\n \"proforma_invoice_id\": \"minim adipisicing\",\n \"type\": \"id fugiat aliquip nisi pariatur\",\n \"currency\": \"aliquip et voluptate incididunt\",\n \"amount_of_credits\": \"et velit aliqua Excepteur\",\n \"amount_of_promotional_credits\": \"elit\",\n \"subtotal\": \"pariatur proident Ut consectetur\",\n \"service_fee_amount\": \"do dolor\",\n \"total_without_vat\": \"eiusmod esse in\",\n \"vat_amount\": \"non consectetur ex Excepteur\",\n \"total\": \"labore ea\",\n \"service_fee_percent\": \"est\",\n \"vat_percent\": \"non ut\",\n \"credit_package_id\": \"cillum exercitation amet cupidatat\",\n \"subscription_tier_id\": \"sed Lorem sint culpa quis\",\n \"number_of_users\": 2538180,\n \"yearly_billing\": true,\n \"payment_deadline\": \"1950-06-15\",\n \"issue_date\": \"1943-03-05\",\n \"number\": \"velit culpa\",\n \"is_overdue\": true,\n \"is_unpaid\": false,\n \"cancelled\": false,\n \"payment_completed\": false,\n \"document\": \"https://n.hlka.3WuMIXwzNjgf0yaIH990ly9biyeXycbiNLoFj8NfXtES0LFtkvoDUIt.U4obp\",\n \"created\": \"1958-08-26T15:33:37.947Z\"\n },\n {\n \"payment_type_id\": \"incididunt ut labore\",\n \"id\": \"136753c3-e3c4-ba2f-ed92-9b1906139488\",\n \"company_id\": \"id Excepteur sed\",\n \"proforma_invoice_id\": \"amet quis Ex\",\n \"type\": \"proident consequat non\",\n \"currency\": \"irure ut Lorem\",\n \"amount_of_credits\": \"exercitation amet\",\n \"amount_of_promotional_credits\": \"in\",\n \"subtotal\": \"q\",\n \"service_fee_amount\": \"adipisicing\",\n \"total_without_vat\": \"dolore Dui\",\n \"vat_amount\": \"Duis qui\",\n \"total\": \"id commodo dolor\",\n \"service_fee_percent\": \"amet elit in\",\n \"vat_percent\": \"sit non aliqua ad proident\",\n \"credit_package_id\": \"ut in\",\n \"subscription_tier_id\": \"consequat voluptate\",\n \"number_of_users\": -77789771,\n \"yearly_billing\": true,\n \"payment_deadline\": \"1957-10-19\",\n \"issue_date\": \"1967-01-17\",\n \"number\": \"anim ipsum\",\n \"is_overdue\": true,\n \"is_unpaid\": false,\n \"cancelled\": true,\n \"payment_completed\": false,\n \"document\": \"https://TAzqjEesg.hdnrbdTY6Pp22NIFkaATaqNKdSd+TlyskSpiLe3OW1ZvuIiKvAku7prXNIF6A-c5HY5Ivmr4j6UJK\",\n \"created\": \"2015-09-27T02:16:37.008Z\"\n }\n]" } ] } ] }, { "name": "payment-intents", "item": [ { "name": "{payment intent}", "item": [ { "name": "companies payment-intents read", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/payment-intents/:payment_intent/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "payment-intents", ":payment_intent", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "payment_intent", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/payment-intents/:payment_intent/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "payment-intents", ":payment_intent", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "payment_intent", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"payment_type_id\": \"amet ut sint\",\n \"id\": \"urn:uuid:00062644-4a9f-42eb-2139-ba944dbc1572\",\n \"company_id\": \"id dolore occaecat amet\",\n \"type\": \"exercitation\",\n \"currency\": \"do et id ut\",\n \"amount_of_credits\": \"et esse aliqua\",\n \"amount_of_promotional_credits\": \"veniam deserunt enim do\",\n \"subtotal\": \"in aute pariatur magna cupidatat\",\n \"service_fee_amount\": \"laborum labore amet\",\n \"total_without_vat\": \"eu cupidatat\",\n \"vat_amount\": \"Duis consectetur adipisicing\",\n \"total\": \"anim\",\n \"service_fee_percent\": \"veniam\",\n \"vat_percent\": \"consequat dolor ipsum mollit fugiat\",\n \"credit_package_id\": \"esse sit in consequat\",\n \"credit_package_amount_of_credits\": 47466040,\n \"subscription_tier_id\": \"nisi\",\n \"number_of_users\": 79861242,\n \"yearly_billing\": false,\n \"payment_deadline\": \"1955-10-27\",\n \"issue_date\": \"1997-12-11\",\n \"number\": \"dolor id quis\",\n \"is_overdue\": true,\n \"is_unpaid\": false,\n \"cancelled\": true,\n \"payment_completed\": true,\n \"payment_provider_data\": {},\n \"created\": \"2018-10-06T15:54:17.037Z\"\n}" } ] }, { "name": "companies payment-intents get invoice", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"payment_type_id\": \"ut eiusmod eu\",\n \"credit_package_id\": \"consequat dolor\",\n \"credit_package_amount_of_credits\": -55074219,\n \"subscription_tier_id\": \"cupidatat qui id dolor velit\",\n \"number_of_users\": -56853872,\n \"yearly_billing\": false,\n \"cancelled\": true,\n \"payment_provider_data\": {},\n \"created\": \"1952-09-09T02:31:28.521Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/payment-intents/:payment_intent/get-invoice/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "payment-intents", ":payment_intent", "get-invoice", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "payment_intent", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/payment-intents/:payment_intent/get-invoice/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "payment-intents", ":payment_intent", "get-invoice", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "payment_intent", "value": "cons", "description": "(Required) " } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"payment_type_id\": \"amet ut sint\",\n \"id\": \"urn:uuid:00062644-4a9f-42eb-2139-ba944dbc1572\",\n \"company_id\": \"id dolore occaecat amet\",\n \"type\": \"exercitation\",\n \"currency\": \"do et id ut\",\n \"amount_of_credits\": \"et esse aliqua\",\n \"amount_of_promotional_credits\": \"veniam deserunt enim do\",\n \"subtotal\": \"in aute pariatur magna cupidatat\",\n \"service_fee_amount\": \"laborum labore amet\",\n \"total_without_vat\": \"eu cupidatat\",\n \"vat_amount\": \"Duis consectetur adipisicing\",\n \"total\": \"anim\",\n \"service_fee_percent\": \"veniam\",\n \"vat_percent\": \"consequat dolor ipsum mollit fugiat\",\n \"credit_package_id\": \"esse sit in consequat\",\n \"credit_package_amount_of_credits\": 47466040,\n \"subscription_tier_id\": \"nisi\",\n \"number_of_users\": 79861242,\n \"yearly_billing\": false,\n \"payment_deadline\": \"1955-10-27\",\n \"issue_date\": \"1997-12-11\",\n \"number\": \"dolor id quis\",\n \"is_overdue\": true,\n \"is_unpaid\": false,\n \"cancelled\": true,\n \"payment_completed\": true,\n \"payment_provider_data\": {},\n \"created\": \"2018-10-06T15:54:17.037Z\"\n}" } ] } ] }, { "name": "companies payment-intents create", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"payment_type_id\": \"ut eiusmod eu\",\n \"credit_package_id\": \"consequat dolor\",\n \"credit_package_amount_of_credits\": -55074219,\n \"subscription_tier_id\": \"cupidatat qui id dolor velit\",\n \"number_of_users\": -56853872,\n \"yearly_billing\": false,\n \"cancelled\": true,\n \"payment_provider_data\": {},\n \"created\": \"1952-09-09T02:31:28.521Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/payment-intents/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "payment-intents", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/payment-intents/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "payment-intents", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"payment_type_id\": \"amet ut sint\",\n \"id\": \"urn:uuid:00062644-4a9f-42eb-2139-ba944dbc1572\",\n \"company_id\": \"id dolore occaecat amet\",\n \"type\": \"exercitation\",\n \"currency\": \"do et id ut\",\n \"amount_of_credits\": \"et esse aliqua\",\n \"amount_of_promotional_credits\": \"veniam deserunt enim do\",\n \"subtotal\": \"in aute pariatur magna cupidatat\",\n \"service_fee_amount\": \"laborum labore amet\",\n \"total_without_vat\": \"eu cupidatat\",\n \"vat_amount\": \"Duis consectetur adipisicing\",\n \"total\": \"anim\",\n \"service_fee_percent\": \"veniam\",\n \"vat_percent\": \"consequat dolor ipsum mollit fugiat\",\n \"credit_package_id\": \"esse sit in consequat\",\n \"credit_package_amount_of_credits\": 47466040,\n \"subscription_tier_id\": \"nisi\",\n \"number_of_users\": 79861242,\n \"yearly_billing\": false,\n \"payment_deadline\": \"1955-10-27\",\n \"issue_date\": \"1997-12-11\",\n \"number\": \"dolor id quis\",\n \"is_overdue\": true,\n \"is_unpaid\": false,\n \"cancelled\": true,\n \"payment_completed\": true,\n \"payment_provider_data\": {},\n \"created\": \"2018-10-06T15:54:17.037Z\"\n}" } ] }, { "name": "companies payment-intents list list", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/payment-intents/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "payment-intents", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/payment-intents/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "payment-intents", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"payment_type_id\": \"id nulla eiusmod\",\n \"id\": \"a0fc1d04-86bb-b1e3-f4af-e18000daa0b5\",\n \"company_id\": \"ad culpa\",\n \"type\": \"eiusmod consectetur\",\n \"currency\": \"esse amet nisi in\",\n \"amount_of_credits\": \"tempor nostrud\",\n \"amount_of_promotional_credits\": \"Excepteur ea in\",\n \"subtotal\": \"esse consectetur ipsum Ut\",\n \"service_fee_amount\": \"elit veniam nulla\",\n \"total_without_vat\": \"\",\n \"vat_amount\": \"adipisicing\",\n \"total\": \"ex dolore magna consequat cillum\",\n \"service_fee_percent\": \"do magna enim voluptate eiusmod\",\n \"vat_percent\": \"proident sint quis dolore labore\",\n \"credit_package_id\": \"sunt id cupidatat non\",\n \"credit_package_amount_of_credits\": 33561265,\n \"subscription_tier_id\": \"et Excepteur commodo \",\n \"number_of_users\": 95270176,\n \"yearly_billing\": true,\n \"payment_deadline\": \"1963-06-29\",\n \"issue_date\": \"1954-06-02\",\n \"number\": \"deserunt culpa\",\n \"is_overdue\": false,\n \"is_unpaid\": true,\n \"cancelled\": true,\n \"payment_completed\": true,\n \"payment_provider_data\": {},\n \"created\": \"1967-06-12T06:43:05.243Z\"\n },\n {\n \"payment_type_id\": \"labore consectetur esse sit\",\n \"id\": \"urn:uuid:6055ef19-949b-5da2-2d32-67900e4db4cd\",\n \"company_id\": \"ad\",\n \"type\": \"in eiusmod exercitation\",\n \"currency\": \"eu Lorem cillum\",\n \"amount_of_credits\": \"ea laborum\",\n \"amount_of_promotional_credits\": \"nisi tempor in\",\n \"subtotal\": \"culpa non deserunt\",\n \"service_fee_amount\": \"veniam dolore\",\n \"total_without_vat\": \"consequat deserunt\",\n \"vat_amount\": \"incididunt Excepteur cupidatat ullamco\",\n \"total\": \"voluptate amet\",\n \"service_fee_percent\": \"qui ipsum nostrud consectetur do\",\n \"vat_percent\": \"minim ipsum Excepteur ut\",\n \"credit_package_id\": \"sit exercitation laboris\",\n \"credit_package_amount_of_credits\": -25182134,\n \"subscription_tier_id\": \"reprehenderit ea\",\n \"number_of_users\": 95804371,\n \"yearly_billing\": true,\n \"payment_deadline\": \"1949-11-17\",\n \"issue_date\": \"1960-04-04\",\n \"number\": \"tempor non dolore offici\",\n \"is_overdue\": false,\n \"is_unpaid\": false,\n \"cancelled\": false,\n \"payment_completed\": false,\n \"payment_provider_data\": {},\n \"created\": \"1991-05-14T21:04:58.962Z\"\n }\n]" } ] } ] }, { "name": "proforma-invoices", "item": [ { "name": "{proforma invoice}", "item": [ { "name": "Retrieve pro-forma invoice", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/proforma-invoices/:proforma_invoice/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "proforma-invoices", ":proforma_invoice", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "proforma-invoice", "value": "cons", "description": "(Required) \nThe pro-forma invoice identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the pro-forma invoice by its ID. Replace `{id}` with internal pro-forma invoice id. |\n" }, { "key": "proforma_invoice", "value": "cons", "description": "(Required) " } ] }, "description": "Retrieves a single pro-forma invoice of a company that the logged in 3rd-party system is\n allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/proforma-invoices/:proforma_invoice/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "proforma-invoices", ":proforma_invoice", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "proforma-invoice", "value": "cons", "description": "(Required) \nThe pro-forma invoice identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the pro-forma invoice by its ID. Replace `{id}` with internal pro-forma invoice id. |\n" }, { "key": "proforma_invoice", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"payment_type_id\": \"fugiat consectetur\",\n \"id\": \"b1808ec4-1b45-ea8a-f75a-901627315be4\",\n \"company_id\": \"velit\",\n \"type\": \"do ut Exce\",\n \"currency\": \"pariatur\",\n \"amount_of_credits\": \"officia aute sed\",\n \"amount_of_promotional_credits\": \"do labore sint aliqua cillum\",\n \"subtotal\": \"Lorem sint laborum ea\",\n \"service_fee_amount\": \"occaecat in dolor sunt\",\n \"total_without_vat\": \"ex dolore\",\n \"vat_amount\": \"reprehenderit nulla do esse elit\",\n \"total\": \"pa\",\n \"service_fee_percent\": \"fugiat amet aliquip ipsum reprehenderit\",\n \"vat_percent\": \"in in\",\n \"credit_package_id\": \"anim pariatur aute fugiat\",\n \"credit_package_amount_of_credits\": -18002923,\n \"subscription_tier_id\": \"ipsum dolor\",\n \"number_of_users\": -29609467,\n \"yearly_billing\": false,\n \"payment_deadline\": \"1999-10-03\",\n \"issue_date\": \"1984-12-29\",\n \"number\": \"co\",\n \"is_overdue\": false,\n \"is_unpaid\": true,\n \"cancelled\": true,\n \"payment_completed\": true,\n \"document\": \"https://qNZsXPdHlgIUWp.lzZFAOtrPRBK-exwRBfmBsDJq6zt+J86KJdPZCfwZmTKOXFSs5wXECo1tdbBDwN\",\n \"created\": \"1964-06-20T18:32:51.416Z\"\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/proforma-invoices/:proforma_invoice/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "proforma-invoices", ":proforma_invoice", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "proforma-invoice", "value": "cons", "description": "(Required) \nThe pro-forma invoice identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the pro-forma invoice by its ID. Replace `{id}` with internal pro-forma invoice id. |\n" }, { "key": "proforma_invoice", "value": "cons", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company or invoice is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/proforma-invoices/:proforma_invoice/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "proforma-invoices", ":proforma_invoice", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "proforma-invoice", "value": "cons", "description": "(Required) \nThe pro-forma invoice identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the pro-forma invoice by its ID. Replace `{id}` with internal pro-forma invoice id. |\n" }, { "key": "proforma_invoice", "value": "cons", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Pro-forma invoice document download", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/proforma-invoices/:proforma_invoice/attachment/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "proforma-invoices", ":proforma_invoice", "attachment", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "proforma-invoice", "value": "cons", "description": "(Required) \nThe pro-forma invoice identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the pro-forma invoice by its ID. Replace `{id}` with internal pro-forma invoice id. |\n" }, { "key": "proforma_invoice", "value": "cons", "description": "(Required) " } ] }, "description": "This endpoint enables you to download pro-forma invoice in PDF format." }, "response": [ { "name": "The login token that can be used to seamlessly login the user without entering the username and password. Particularly useful in solutions where CargoX is loaded via `iframe`.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/proforma-invoices/:proforma_invoice/attachment/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "proforma-invoices", ":proforma_invoice", "attachment", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "proforma-invoice", "value": "cons", "description": "(Required) \nThe pro-forma invoice identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the pro-forma invoice by its ID. Replace `{id}` with internal pro-forma invoice id. |\n" }, { "key": "proforma_invoice", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"login_token\": \"voluptate dolor\",\n \"expires\": \"1964-09-21T19:58:04.791Z\",\n \"login_url\": \"https://IRxAwgkgllcue.gzFIQXGT,HHsNRh0vzgvbNWNQ3bAwgL,SyEGBQsqG6Os2L\"\n}" }, { "name": "Returned when the authenticated user is not a 3rd-party company.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/proforma-invoices/:proforma_invoice/attachment/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "proforma-invoices", ":proforma_invoice", "attachment", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "proforma-invoice", "value": "cons", "description": "(Required) \nThe pro-forma invoice identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine the pro-forma invoice by its ID. Replace `{id}` with internal pro-forma invoice id. |\n" }, { "key": "proforma_invoice", "value": "cons", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Create pro-forma invoice", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"payment_type_id\": \"dolore exercitation\",\n \"credit_package_id\": \"nulla pariatur\",\n \"credit_package_amount_of_credits\": 89259406,\n \"subscription_tier_id\": \"mollit sint dolor\",\n \"number_of_users\": -86479776,\n \"yearly_billing\": true,\n \"cancelled\": false,\n \"created\": \"1994-09-29T12:31:46.343Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/proforma-invoices/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "proforma-invoices", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "Creates a new pro-forma invoice for a company that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/proforma-invoices/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "proforma-invoices", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"payment_type_id\": \"fugiat consectetur\",\n \"id\": \"b1808ec4-1b45-ea8a-f75a-901627315be4\",\n \"company_id\": \"velit\",\n \"type\": \"do ut Exce\",\n \"currency\": \"pariatur\",\n \"amount_of_credits\": \"officia aute sed\",\n \"amount_of_promotional_credits\": \"do labore sint aliqua cillum\",\n \"subtotal\": \"Lorem sint laborum ea\",\n \"service_fee_amount\": \"occaecat in dolor sunt\",\n \"total_without_vat\": \"ex dolore\",\n \"vat_amount\": \"reprehenderit nulla do esse elit\",\n \"total\": \"pa\",\n \"service_fee_percent\": \"fugiat amet aliquip ipsum reprehenderit\",\n \"vat_percent\": \"in in\",\n \"credit_package_id\": \"anim pariatur aute fugiat\",\n \"credit_package_amount_of_credits\": -18002923,\n \"subscription_tier_id\": \"ipsum dolor\",\n \"number_of_users\": -29609467,\n \"yearly_billing\": false,\n \"payment_deadline\": \"1999-10-03\",\n \"issue_date\": \"1984-12-29\",\n \"number\": \"co\",\n \"is_overdue\": false,\n \"is_unpaid\": true,\n \"cancelled\": true,\n \"payment_completed\": true,\n \"document\": \"https://qNZsXPdHlgIUWp.lzZFAOtrPRBK-exwRBfmBsDJq6zt+J86KJdPZCfwZmTKOXFSs5wXECo1tdbBDwN\",\n \"created\": \"1964-06-20T18:32:51.416Z\"\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/proforma-invoices/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "proforma-invoices", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Custom subscription inquiry", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"payment_type_id\": \"dolore exercitation\",\n \"credit_package_id\": \"nulla pariatur\",\n \"credit_package_amount_of_credits\": 89259406,\n \"subscription_tier_id\": \"mollit sint dolor\",\n \"number_of_users\": -86479776,\n \"yearly_billing\": true,\n \"cancelled\": false,\n \"created\": \"1994-09-29T12:31:46.343Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/proforma-invoices/custom-subscription/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "proforma-invoices", "custom-subscription", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "This endpoint is used by the frontend to send an email to sales@cargox.io when users wish to upgrade to a custom subscription." }, "response": [ { "name": "Returned when email has been successfully sent.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/proforma-invoices/custom-subscription/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "proforma-invoices", "custom-subscription", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when the authenticated user is not a 3rd-party company.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/proforma-invoices/custom-subscription/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "proforma-invoices", "custom-subscription", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "List pro-forma invoices", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/proforma-invoices/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "proforma-invoices", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "Lists all pro-forma invoices of companies that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/proforma-invoices/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "proforma-invoices", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"payment_type_id\": \"deserunt sit commodo fugiat veniam\",\n \"id\": \"urn:uuid:c954f0e1-5477-0baf-3a0d-2e4ac8087240\",\n \"company_id\": \"aliqua\",\n \"type\": \"sed\",\n \"currency\": \"anim qui ullamco\",\n \"amount_of_credits\": \"aute deserunt\",\n \"amount_of_promotional_credits\": \"eiusmod dolor\",\n \"subtotal\": \"et fugiat\",\n \"service_fee_amount\": \"Ut Excepteur\",\n \"total_without_vat\": \"in et\",\n \"vat_amount\": \"aliqua\",\n \"total\": \"et est\",\n \"service_fee_percent\": \"do esse Excepteur minim sit\",\n \"vat_percent\": \"adipisicing eu pa\",\n \"credit_package_id\": \"officia Ut fugiat ex\",\n \"credit_package_amount_of_credits\": -6099324,\n \"subscription_tier_id\": \"ea\",\n \"number_of_users\": 75822745,\n \"yearly_billing\": true,\n \"payment_deadline\": \"2002-09-10\",\n \"issue_date\": \"1986-02-23\",\n \"number\": \"ut sit ullamco i\",\n \"is_overdue\": true,\n \"is_unpaid\": false,\n \"cancelled\": false,\n \"payment_completed\": false,\n \"document\": \"http://yrgkCiahjSuIXGieeBNomnjhb.mqzDQQIvgebixwVatpz1DwijiAuCZAmrT4xNIg5.lcLluiUf9YUHyA2IthCUNZ2Ob1Dox5w13bHmWIlC,-iP\",\n \"created\": \"1950-04-06T17:05:16.040Z\"\n },\n {\n \"payment_type_id\": \"occaecat in nisi eiusmod\",\n \"id\": \"urn:uuid:717196e8-c2a7-fc65-3694-4f0eb73a946d\",\n \"company_id\": \"magna velit id\",\n \"type\": \"ullamco nulla et\",\n \"currency\": \"exercitation ut\",\n \"amount_of_credits\": \"veniam f\",\n \"amount_of_promotional_credits\": \"officia cillum occaecat consequat eiusmod\",\n \"subtotal\": \"mollit ad ut\",\n \"service_fee_amount\": \"nisi nulla in consequat\",\n \"total_without_vat\": \"dolo\",\n \"vat_amount\": \"sit Except\",\n \"total\": \"ut\",\n \"service_fee_percent\": \"laboris\",\n \"vat_percent\": \"deserunt non\",\n \"credit_package_id\": \"dolore sint adipisicing consectetur\",\n \"credit_package_amount_of_credits\": 24443525,\n \"subscription_tier_id\": \"magna tempor dolore\",\n \"number_of_users\": 42929955,\n \"yearly_billing\": true,\n \"payment_deadline\": \"1963-09-26\",\n \"issue_date\": \"1947-07-15\",\n \"number\": \"Ut cillum ea\",\n \"is_overdue\": true,\n \"is_unpaid\": false,\n \"cancelled\": false,\n \"payment_completed\": false,\n \"document\": \"https://ZdNYUAEKBlgMnkiIwr.wlDJJzoGzS8ZOoUAtpdYjUkKyrZZyrwdxRnxzYFYX.P6bvcVJtqHX1tKFB8\",\n \"created\": \"1944-10-29T13:21:44.315Z\"\n }\n]" } ] }, { "name": "Need more credits", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"payment_type_id\": \"dolore exercitation\",\n \"credit_package_id\": \"nulla pariatur\",\n \"credit_package_amount_of_credits\": 89259406,\n \"subscription_tier_id\": \"mollit sint dolor\",\n \"number_of_users\": -86479776,\n \"yearly_billing\": true,\n \"cancelled\": false,\n \"created\": \"1994-09-29T12:31:46.343Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/proforma-invoices/need-more-credits/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "proforma-invoices", "need-more-credits", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "This endpoint is used by the frontend to send an email to sales@cargox.io when users wish to buy bigger amounts of credits." }, "response": [ { "name": "Returned when email has been successfully sent.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/proforma-invoices/need-more-credits/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "proforma-invoices", "need-more-credits", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when the authenticated user is not a 3rd-party company.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/proforma-invoices/need-more-credits/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "proforma-invoices", "need-more-credits", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "rules", "item": [ { "name": "{rule}", "item": [ { "name": "Retrieve rule", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/rules/:rule/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", ":rule", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "rule", "value": "cons", "description": "(Required) \nThe rule identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine rule by its ID. Replace `{id}` with internal rule uuid. |\n" } ] }, "description": "Retrieves a single rule of a company that the logged in 3rd-party system is\n allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/rules/:rule/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", ":rule", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "rule", "value": "cons", "description": "(Required) \nThe rule identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine rule by its ID. Replace `{id}` with internal rule uuid. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"amet cillum\",\n \"event\": \"non nulla anim minim\",\n \"actions\": [\n {\n \"type\": \"send_email_to\",\n \"data\": {}\n },\n {\n \"type\": \"post_webhook\",\n \"data\": {}\n }\n ],\n \"id\": \"urn:uuid:6ec5285b-97b5-2337-61fa-0c0c2d110b3d\",\n \"event_name\": \"Ut in\",\n \"enabled\": false,\n \"actions_description\": \"commodo voluptate laborum\"\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/rules/:rule/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", ":rule", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "rule", "value": "cons", "description": "(Required) \nThe rule identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine rule by its ID. Replace `{id}` with internal rule uuid. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company or rule is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/rules/:rule/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", ":rule", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "rule", "value": "cons", "description": "(Required) \nThe rule identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine rule by its ID. Replace `{id}` with internal rule uuid. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Update rule", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Lorem pariatur\",\n \"event\": \"qui fugiat deserunt irure\",\n \"actions\": [\n {\n \"type\": \"send_email_to_everyone\",\n \"data\": {}\n },\n {\n \"type\": \"send_email_to\",\n \"data\": {}\n }\n ],\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/rules/:rule/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", ":rule", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "rule", "value": "cons", "description": "(Required) \nThe rule identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine rule by its ID. Replace `{id}` with internal rule uuid. |\n" } ] }, "description": "Updates the rule. All data needs to be present to perform an update. If data is incomplete,\n please use a `PATCH` call. Rules cannot be moved between companies." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/rules/:rule/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", ":rule", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "rule", "value": "cons", "description": "(Required) \nThe rule identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine rule by its ID. Replace `{id}` with internal rule uuid. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"amet cillum\",\n \"event\": \"non nulla anim minim\",\n \"actions\": [\n {\n \"type\": \"send_email_to\",\n \"data\": {}\n },\n {\n \"type\": \"post_webhook\",\n \"data\": {}\n }\n ],\n \"id\": \"urn:uuid:6ec5285b-97b5-2337-61fa-0c0c2d110b3d\",\n \"event_name\": \"Ut in\",\n \"enabled\": false,\n \"actions_description\": \"commodo voluptate laborum\"\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/rules/:rule/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", ":rule", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "rule", "value": "cons", "description": "(Required) \nThe rule identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine rule by its ID. Replace `{id}` with internal rule uuid. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company or rule is not found.", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/rules/:rule/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", ":rule", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "rule", "value": "cons", "description": "(Required) \nThe rule identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine rule by its ID. Replace `{id}` with internal rule uuid. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Partially update rule", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Lorem pariatur\",\n \"event\": \"qui fugiat deserunt irure\",\n \"actions\": [\n {\n \"type\": \"send_email_to_everyone\",\n \"data\": {}\n },\n {\n \"type\": \"send_email_to\",\n \"data\": {}\n }\n ],\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/rules/:rule/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", ":rule", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "rule", "value": "cons", "description": "(Required) \nThe rule identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine rule by its ID. Replace `{id}` with internal rule uuid. |\n" } ] }, "description": "Partially updates the rule. Only the data that needs to be changed is required.\n Rules cannot be moved between companies." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/rules/:rule/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", ":rule", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "rule", "value": "cons", "description": "(Required) \nThe rule identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine rule by its ID. Replace `{id}` with internal rule uuid. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"amet cillum\",\n \"event\": \"non nulla anim minim\",\n \"actions\": [\n {\n \"type\": \"send_email_to\",\n \"data\": {}\n },\n {\n \"type\": \"post_webhook\",\n \"data\": {}\n }\n ],\n \"id\": \"urn:uuid:6ec5285b-97b5-2337-61fa-0c0c2d110b3d\",\n \"event_name\": \"Ut in\",\n \"enabled\": false,\n \"actions_description\": \"commodo voluptate laborum\"\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/rules/:rule/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", ":rule", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "rule", "value": "cons", "description": "(Required) \nThe rule identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine rule by its ID. Replace `{id}` with internal rule uuid. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company or rule is not found.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/rules/:rule/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", ":rule", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "rule", "value": "cons", "description": "(Required) \nThe rule identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine rule by its ID. Replace `{id}` with internal rule uuid. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Delete rule", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/rules/:rule/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", ":rule", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "rule", "value": "cons", "description": "(Required) \nThe rule identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine rule by its ID. Replace `{id}` with internal rule uuid. |\n" } ] }, "description": "Deletes a single rule entry of a user that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Returned when rule is successfully deleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/rules/:rule/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", ":rule", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "rule", "value": "cons", "description": "(Required) \nThe rule identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine rule by its ID. Replace `{id}` with internal rule uuid. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/rules/:rule/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", ":rule", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "rule", "value": "cons", "description": "(Required) \nThe rule identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine rule by its ID. Replace `{id}` with internal rule uuid. |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company or rule is not found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/rules/:rule/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", ":rule", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "rule", "value": "cons", "description": "(Required) \nThe rule identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine rule by its ID. Replace `{id}` with internal rule uuid. |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Create rule", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"in do dolore\",\n \"event\": \"ut dolor eu sunt\",\n \"actions\": [\n {\n \"type\": \"send_email_to\",\n \"data\": {}\n },\n {\n \"type\": \"send_email_to_everyone\",\n \"data\": {}\n }\n ],\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/rules/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "rules", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "Creates a new rule for a company that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/rules/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "rules", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"amet cillum\",\n \"event\": \"non nulla anim minim\",\n \"actions\": [\n {\n \"type\": \"send_email_to\",\n \"data\": {}\n },\n {\n \"type\": \"post_webhook\",\n \"data\": {}\n }\n ],\n \"id\": \"urn:uuid:6ec5285b-97b5-2337-61fa-0c0c2d110b3d\",\n \"event_name\": \"Ut in\",\n \"enabled\": false,\n \"actions_description\": \"commodo voluptate laborum\"\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/rules/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "rules", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company is not found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/rules/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "rules", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "List rules", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/rules/list/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "rules", "list", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "Lists all company rules that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/rules/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"amet cillum\",\n \"event\": \"non nulla anim minim\",\n \"actions\": [\n {\n \"type\": \"send_email_to\",\n \"data\": {}\n },\n {\n \"type\": \"post_webhook\",\n \"data\": {}\n }\n ],\n \"id\": \"urn:uuid:6ec5285b-97b5-2337-61fa-0c0c2d110b3d\",\n \"event_name\": \"Ut in\",\n \"enabled\": false,\n \"actions_description\": \"commodo voluptate laborum\"\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/rules/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/rules/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "rules", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "tos", "item": [ { "name": "Create terms and conditions", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/tos/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "tos", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "Creates a new terms and conditions entry for a company that the logged in 3rd-party system is \n allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/tos/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "tos", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" } ] }, { "name": "List terms and conditions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/tos/list/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "tos", "list", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "Lists all terms and conditions of companies that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/tos/list/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "tos", "list", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[]" } ] }, { "name": "Retrieve terms and conditions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/tos/:tos/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "tos", ":tos", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "tos", "value": "cons", "description": "(Required) \nThe terms of service identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine terms of service by its ID. Replace `{id}` with internal terms of service id. |\n" } ] }, "description": "Retrieves a single terms and conditions entry of companies that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/tos/:tos/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "tos", ":tos", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "tos", "value": "cons", "description": "(Required) \nThe terms of service identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine terms of service by its ID. Replace `{id}` with internal terms of service id. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" } ] } ] }, { "name": "users", "item": [ { "name": "{user}", "item": [ { "name": "blockchain-key", "item": [ { "name": "{blockchain key}", "item": [ { "name": "Retrieve login key", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" }, { "key": "blockchain_key", "value": "cons", "description": "(Required) \nThe login key identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine login key by its ID. Replace `{id}` with internal login key id. |\n" } ] }, "description": "Retrieves a single login key entry of user that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" }, { "key": "blockchain_key", "value": "cons", "description": "(Required) \nThe login key identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine login key by its ID. Replace `{id}` with internal login key id. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"ledger\",\n \"verification_code\": \"mollit Excepteur cillum non et\",\n \"id\": \"urn:uuid:47d1cfbd-01d4-aa25-c8d6-4ce24c5e062e\",\n \"user_id\": \"reprehenderit veniam velit magna\",\n \"ethereum_address\": \"0x64CAeAeFeaB9F4ecFfa3ac3C482fbdc3709e5FAa\",\n \"created\": \"2002-07-08T09:13:39.386Z\",\n \"transaction_pending\": \"non elit\",\n \"transaction_confirmed\": \"voluptate aliquip c\",\n \"transactions\": [\n {\n \"tx_hash\": \"occaecat amet in ipsum\",\n \"status\": 2,\n \"created\": \"1972-08-05T22:07:58.827Z\",\n \"mined\": \"1947-01-07T21:15:06.893Z\",\n \"etherscan_link\": \"dolor aliqua officia incididunt\"\n },\n {\n \"tx_hash\": \"officia exercitation\",\n \"status\": 3,\n \"created\": \"1994-06-10T13:12:20.815Z\",\n \"mined\": \"1943-05-11T23:14:33.578Z\",\n \"etherscan_link\": \"consectetur velit cupidatat in\"\n }\n ],\n \"removable\": \"nostrud quis Except\"\n}" } ] }, { "name": "Update login key", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"ledger\",\n \"verification_code\": \"ipsum cupidatat irure eiusmod\",\n \"ethereum_address\": \"0xbE6a1F6EC4E5e7EC7be2958eeaAc3F0FBFEa35aD\",\n \"created\": \"2010-08-19T09:55:53.889Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" }, { "key": "blockchain_key", "value": "cons", "description": "(Required) \nThe login key identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine login key by its ID. Replace `{id}` with internal login key id. |\n" } ] }, "description": "Updates the login key. All data needs to be present to perform an update. If data is incomplete,\n please use a `PATCH` call." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" }, { "key": "blockchain_key", "value": "cons", "description": "(Required) \nThe login key identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine login key by its ID. Replace `{id}` with internal login key id. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"ledger\",\n \"verification_code\": \"mollit Excepteur cillum non et\",\n \"id\": \"urn:uuid:47d1cfbd-01d4-aa25-c8d6-4ce24c5e062e\",\n \"user_id\": \"reprehenderit veniam velit magna\",\n \"ethereum_address\": \"0x64CAeAeFeaB9F4ecFfa3ac3C482fbdc3709e5FAa\",\n \"created\": \"2002-07-08T09:13:39.386Z\",\n \"transaction_pending\": \"non elit\",\n \"transaction_confirmed\": \"voluptate aliquip c\",\n \"transactions\": [\n {\n \"tx_hash\": \"occaecat amet in ipsum\",\n \"status\": 2,\n \"created\": \"1972-08-05T22:07:58.827Z\",\n \"mined\": \"1947-01-07T21:15:06.893Z\",\n \"etherscan_link\": \"dolor aliqua officia incididunt\"\n },\n {\n \"tx_hash\": \"officia exercitation\",\n \"status\": 3,\n \"created\": \"1994-06-10T13:12:20.815Z\",\n \"mined\": \"1943-05-11T23:14:33.578Z\",\n \"etherscan_link\": \"consectetur velit cupidatat in\"\n }\n ],\n \"removable\": \"nostrud quis Except\"\n}" } ] }, { "name": "Partially update login key", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"ledger\",\n \"verification_code\": \"ipsum cupidatat irure eiusmod\",\n \"ethereum_address\": \"0xbE6a1F6EC4E5e7EC7be2958eeaAc3F0FBFEa35aD\",\n \"created\": \"2010-08-19T09:55:53.889Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" }, { "key": "blockchain_key", "value": "cons", "description": "(Required) \nThe login key identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine login key by its ID. Replace `{id}` with internal login key id. |\n" } ] }, "description": "Partially updates the login key. Only the data that needs to be changed is required." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" }, { "key": "blockchain_key", "value": "cons", "description": "(Required) \nThe login key identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine login key by its ID. Replace `{id}` with internal login key id. |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"ledger\",\n \"verification_code\": \"mollit Excepteur cillum non et\",\n \"id\": \"urn:uuid:47d1cfbd-01d4-aa25-c8d6-4ce24c5e062e\",\n \"user_id\": \"reprehenderit veniam velit magna\",\n \"ethereum_address\": \"0x64CAeAeFeaB9F4ecFfa3ac3C482fbdc3709e5FAa\",\n \"created\": \"2002-07-08T09:13:39.386Z\",\n \"transaction_pending\": \"non elit\",\n \"transaction_confirmed\": \"voluptate aliquip c\",\n \"transactions\": [\n {\n \"tx_hash\": \"occaecat amet in ipsum\",\n \"status\": 2,\n \"created\": \"1972-08-05T22:07:58.827Z\",\n \"mined\": \"1947-01-07T21:15:06.893Z\",\n \"etherscan_link\": \"dolor aliqua officia incididunt\"\n },\n {\n \"tx_hash\": \"officia exercitation\",\n \"status\": 3,\n \"created\": \"1994-06-10T13:12:20.815Z\",\n \"mined\": \"1943-05-11T23:14:33.578Z\",\n \"etherscan_link\": \"consectetur velit cupidatat in\"\n }\n ],\n \"removable\": \"nostrud quis Except\"\n}" } ] }, { "name": "Delete login key", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" }, { "key": "blockchain_key", "value": "cons", "description": "(Required) \nThe login key identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine login key by its ID. Replace `{id}` with internal login key id. |\n" } ] }, "description": "Deletes a single login key entry of a user that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" }, { "key": "blockchain_key", "value": "cons", "description": "(Required) \nThe login key identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-----------------------|-----------------------------------------------------------------------------------------------|\n| `by-id/{id}` | Determine login key by its ID. Replace `{id}` with internal login key id. |\n" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "companies users blockchain-key approval hash", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"relayed_for\": \"proident ex non ullam\",\n \"hash\": \"do\",\n \"relay_nonce\": 9434094,\n \"recipient\": \"et\",\n \"transaction_data\": \"amet eiusmod cupidatat Lorem\",\n \"signature\": \"quis laborum\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/approval-hash/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "approval-hash", "" ], "variable": [ { "key": "blockchain_key", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/approval-hash/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "approval-hash", "" ], "variable": [ { "key": "blockchain_key", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"relayed_for\": \"proident ex non ullam\",\n \"hash\": \"do\",\n \"relay_nonce\": 9434094,\n \"recipient\": \"et\",\n \"transaction_data\": \"amet eiusmod cupidatat Lorem\",\n \"signature\": \"quis laborum\"\n}" } ] }, { "name": "companies users blockchain-key approve", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"relayed_for\": \"proident ex non ullam\",\n \"hash\": \"do\",\n \"relay_nonce\": 9434094,\n \"recipient\": \"et\",\n \"transaction_data\": \"amet eiusmod cupidatat Lorem\",\n \"signature\": \"quis laborum\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/approve/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "approve", "" ], "variable": [ { "key": "blockchain_key", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/approve/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "approve", "" ], "variable": [ { "key": "blockchain_key", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"relayed_for\": \"proident ex non ullam\",\n \"hash\": \"do\",\n \"relay_nonce\": 9434094,\n \"recipient\": \"et\",\n \"transaction_data\": \"amet eiusmod cupidatat Lorem\",\n \"signature\": \"quis laborum\"\n}" } ] }, { "name": "companies users blockchain-key disable hash", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"relayed_for\": \"proident ex non ullam\",\n \"hash\": \"do\",\n \"relay_nonce\": 9434094,\n \"recipient\": \"et\",\n \"transaction_data\": \"amet eiusmod cupidatat Lorem\",\n \"signature\": \"quis laborum\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/disable-hash/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "disable-hash", "" ], "variable": [ { "key": "blockchain_key", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/disable-hash/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "disable-hash", "" ], "variable": [ { "key": "blockchain_key", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"relayed_for\": \"proident ex non ullam\",\n \"hash\": \"do\",\n \"relay_nonce\": 9434094,\n \"recipient\": \"et\",\n \"transaction_data\": \"amet eiusmod cupidatat Lorem\",\n \"signature\": \"quis laborum\"\n}" } ] }, { "name": "companies users blockchain-key disable", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"relayed_for\": \"proident ex non ullam\",\n \"hash\": \"do\",\n \"relay_nonce\": 9434094,\n \"recipient\": \"et\",\n \"transaction_data\": \"amet eiusmod cupidatat Lorem\",\n \"signature\": \"quis laborum\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/disable/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "disable", "" ], "variable": [ { "key": "blockchain_key", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/disable/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "disable", "" ], "variable": [ { "key": "blockchain_key", "value": "cons", "description": "(Required) " }, { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"relayed_for\": \"proident ex non ullam\",\n \"hash\": \"do\",\n \"relay_nonce\": 9434094,\n \"recipient\": \"et\",\n \"transaction_data\": \"amet eiusmod cupidatat Lorem\",\n \"signature\": \"quis laborum\"\n}" } ] }, { "name": "Login key verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"ledger\",\n \"verification_code\": \"ipsum cupidatat irure eiusmod\",\n \"ethereum_address\": \"0xbE6a1F6EC4E5e7EC7be2958eeaAc3F0FBFEa35aD\",\n \"created\": \"2010-08-19T09:55:53.889Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/verification/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "verification", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" }, { "key": "blockchain_key", "value": "cons", "description": "(Required) " } ] }, "description": "\nThis endpoint is used for starting blockchain key verification. This endpoint generates a verification\n code and sends it in an email message to the user.\n" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/verification/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "verification", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" }, { "key": "blockchain_key", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"ethereum_address\": \"0x93f76aCd35BBEf102EF57bCFeeD69FF9FbEFE876\",\n \"id\": \"urn:uuid:06b48a52-a3b8-798e-941f-e92fb2bd94d5\",\n \"type\": \"mnemonic\",\n \"is_verified\": false,\n \"valid_until\": \"1976-05-04T00:00:45.225Z\",\n \"created\": \"1964-03-28T12:59:56.247Z\"\n}" }, { "name": "Returned when the user is not authenticated.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/:blockchain_key/verification/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", ":blockchain_key", "verification", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" }, { "key": "blockchain_key", "value": "cons", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Create login key", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"ledger\",\n \"verification_code\": \"ipsum cupidatat irure eiusmod\",\n \"ethereum_address\": \"0xbE6a1F6EC4E5e7EC7be2958eeaAc3F0FBFEa35aD\",\n \"created\": \"2010-08-19T09:55:53.889Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] }, "description": "Creates a new login key entry for a user that the logged in 3rd-party system is\n allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"ledger\",\n \"verification_code\": \"mollit Excepteur cillum non et\",\n \"id\": \"urn:uuid:47d1cfbd-01d4-aa25-c8d6-4ce24c5e062e\",\n \"user_id\": \"reprehenderit veniam velit magna\",\n \"ethereum_address\": \"0x64CAeAeFeaB9F4ecFfa3ac3C482fbdc3709e5FAa\",\n \"created\": \"2002-07-08T09:13:39.386Z\",\n \"transaction_pending\": \"non elit\",\n \"transaction_confirmed\": \"voluptate aliquip c\",\n \"transactions\": [\n {\n \"tx_hash\": \"occaecat amet in ipsum\",\n \"status\": 2,\n \"created\": \"1972-08-05T22:07:58.827Z\",\n \"mined\": \"1947-01-07T21:15:06.893Z\",\n \"etherscan_link\": \"dolor aliqua officia incididunt\"\n },\n {\n \"tx_hash\": \"officia exercitation\",\n \"status\": 3,\n \"created\": \"1994-06-10T13:12:20.815Z\",\n \"mined\": \"1943-05-11T23:14:33.578Z\",\n \"etherscan_link\": \"consectetur velit cupidatat in\"\n }\n ],\n \"removable\": \"nostrud quis Except\"\n}" } ] }, { "name": "List login keys", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] }, "description": "Lists all login keys of user that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/blockchain-key/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "blockchain-key", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"type\": \"trezor\",\n \"verification_code\": \"amet tempor\",\n \"id\": \"urn:uuid:c8f5c7a2-1174-5a83-781f-7586063f2d2c\",\n \"user_id\": \"consectetur\",\n \"ethereum_address\": \"0xe4E3E28EAEB7b7eBbddDC7f2aCAF2ba3cCA19541\",\n \"created\": \"2020-12-15T20:42:38.514Z\",\n \"transaction_pending\": \"veniam adipisicing eu eiusm\",\n \"transaction_confirmed\": \"eiusmod cillum\",\n \"transactions\": [\n {\n \"tx_hash\": \"voluptate minim\",\n \"status\": 1,\n \"created\": \"1998-11-09T08:23:52.538Z\",\n \"mined\": \"1994-04-04T17:04:40.571Z\",\n \"etherscan_link\": \"do laborum est exercitation\"\n },\n {\n \"tx_hash\": \"eiusmod aliquip\",\n \"status\": 1,\n \"created\": \"2005-06-18T02:09:35.556Z\",\n \"mined\": \"2019-09-13T12:04:31.851Z\",\n \"etherscan_link\": \"do magna\"\n }\n ],\n \"removable\": \"Lorem amet\"\n },\n {\n \"type\": \"bcvault\",\n \"verification_code\": \"exercitation sit minim in Ut\",\n \"id\": \"urn:uuid:6a66a1be-75bf-e33d-f7d2-22222783d4d7\",\n \"user_id\": \"qui ullamco eiusmod\",\n \"ethereum_address\": \"0xfFCC8b8504EF51ECD76eb792E66f8A485628EEd1\",\n \"created\": \"2004-10-05T20:17:32.765Z\",\n \"transaction_pending\": \"id\",\n \"transaction_confirmed\": \"elit cupidatat ut ex\",\n \"transactions\": [\n {\n \"tx_hash\": \"pariatur nostrud mollit ullamco tempor\",\n \"status\": 2,\n \"created\": \"2011-12-07T10:44:56.712Z\",\n \"mined\": \"1950-08-25T13:45:31.181Z\",\n \"etherscan_link\": \"qui ut commodo aliqua Lorem\"\n },\n {\n \"tx_hash\": \"ut\",\n \"status\": 1,\n \"created\": \"1950-12-06T18:01:19.947Z\",\n \"mined\": \"2009-09-18T16:05:02.282Z\",\n \"etherscan_link\": \"eiusmod nisi ullamco\"\n }\n ],\n \"removable\": \"d\"\n }\n]" } ] } ] }, { "name": "notifications", "item": [ { "name": "{notification}", "item": [ { "name": "companies users notifications read", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/notifications/:notification/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "notifications", ":notification", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "notification", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] }, "description": "An endpoint for listing and editing Notification objects." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/notifications/:notification/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "notifications", ":notification", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "notification", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"eiusmod\",\n \"title_localized\": \"culpa nulla\",\n \"data\": {},\n \"created\": \"1963-11-17T05:42:56.585Z\",\n \"clicked\": \"1997-05-02T18:34:42.618Z\",\n \"cleared\": true,\n \"seen\": true,\n \"notification_type\": 0,\n \"reference_id\": \"b0e0a29a-2390-3234-8d91-732079fc4075\",\n \"id\": \"bc1c8b2c-7892-875d-ab06-c3779025c871\"\n}" } ] }, { "name": "companies users notifications update", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"in cillum minim fugiat\",\n \"cleared\": true,\n \"seen\": false,\n \"notification_type\": 11,\n \"reference_id\": \"283bdc80-4132-67e9-71ba-82bb9dcb1aeb\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/notifications/:notification/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "notifications", ":notification", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "notification", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] }, "description": "An endpoint for listing and editing Notification objects." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/notifications/:notification/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "notifications", ":notification", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "notification", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"eiusmod\",\n \"title_localized\": \"culpa nulla\",\n \"data\": {},\n \"created\": \"1963-11-17T05:42:56.585Z\",\n \"clicked\": \"1997-05-02T18:34:42.618Z\",\n \"cleared\": true,\n \"seen\": true,\n \"notification_type\": 0,\n \"reference_id\": \"b0e0a29a-2390-3234-8d91-732079fc4075\",\n \"id\": \"bc1c8b2c-7892-875d-ab06-c3779025c871\"\n}" } ] }, { "name": "companies users notifications partial update", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"in cillum minim fugiat\",\n \"cleared\": true,\n \"seen\": false,\n \"notification_type\": 11,\n \"reference_id\": \"283bdc80-4132-67e9-71ba-82bb9dcb1aeb\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/notifications/:notification/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "notifications", ":notification", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "notification", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] }, "description": "An endpoint for listing and editing Notification objects." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/notifications/:notification/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "notifications", ":notification", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "notification", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"eiusmod\",\n \"title_localized\": \"culpa nulla\",\n \"data\": {},\n \"created\": \"1963-11-17T05:42:56.585Z\",\n \"clicked\": \"1997-05-02T18:34:42.618Z\",\n \"cleared\": true,\n \"seen\": true,\n \"notification_type\": 0,\n \"reference_id\": \"b0e0a29a-2390-3234-8d91-732079fc4075\",\n \"id\": \"bc1c8b2c-7892-875d-ab06-c3779025c871\"\n}" } ] }, { "name": "companies users notifications delete", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/notifications/:notification/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "notifications", ":notification", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "notification", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] }, "description": "An endpoint for listing and editing Notification objects." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/notifications/:notification/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "notifications", ":notification", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "notification", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "companies users notifications set seen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"in cillum minim fugiat\",\n \"cleared\": true,\n \"seen\": false,\n \"notification_type\": 11,\n \"reference_id\": \"283bdc80-4132-67e9-71ba-82bb9dcb1aeb\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/notifications/:notification/seen/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "notifications", ":notification", "seen", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "notification", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] }, "description": "An endpoint for listing and editing Notification objects." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/notifications/:notification/seen/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "notifications", ":notification", "seen", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "notification", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"eiusmod\",\n \"title_localized\": \"culpa nulla\",\n \"data\": {},\n \"created\": \"1963-11-17T05:42:56.585Z\",\n \"clicked\": \"1997-05-02T18:34:42.618Z\",\n \"cleared\": true,\n \"seen\": true,\n \"notification_type\": 0,\n \"reference_id\": \"b0e0a29a-2390-3234-8d91-732079fc4075\",\n \"id\": \"bc1c8b2c-7892-875d-ab06-c3779025c871\"\n}" } ] } ] }, { "name": "companies users notifications latest", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/notifications/latest/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "notifications", "latest", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] }, "description": "An endpoint for listing and editing Notification objects." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/notifications/latest/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "notifications", "latest", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"title\": \"Ut\",\n \"cleared\": true,\n \"seen\": false,\n \"notification_type\": 8,\n \"reference_id\": \"ddb8799e-8447-65b5-809b-5a1759ff8216\"\n },\n {\n \"title\": \"reprehenderit consequat velit amet\",\n \"cleared\": false,\n \"seen\": false,\n \"notification_type\": 3,\n \"reference_id\": \"urn:uuid:c816e2ee-2636-da21-65e5-1cd10a490e34\"\n }\n]" } ] }, { "name": "companies users notifications list list", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/notifications/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "notifications", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] }, "description": "An endpoint for listing and editing Notification objects." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/notifications/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "notifications", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"title\": \"Ut\",\n \"cleared\": true,\n \"seen\": false,\n \"notification_type\": 8,\n \"reference_id\": \"ddb8799e-8447-65b5-809b-5a1759ff8216\"\n },\n {\n \"title\": \"reprehenderit consequat velit amet\",\n \"cleared\": false,\n \"seen\": false,\n \"notification_type\": 3,\n \"reference_id\": \"urn:uuid:c816e2ee-2636-da21-65e5-1cd10a490e34\"\n }\n]" } ] } ] }, { "name": "Retrieve user", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] }, "description": "Retrieves a single user of a company that the logged in 3rd-party system is\n allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"KmARsb9NB@XfGjRDmYLYMPxBpFpFVYZ.sf\",\n \"telephone\": \"proident adipisicing dolore ut velit\",\n \"roles\": {},\n \"name\": \"deserunt nulla eu elit amet\",\n \"first_name\": \"deserunt sint\",\n \"last_name\": \"deserunt sit ex\",\n \"email_override\": \"14GJnTbhW6iVkr@pRkpAeocUMKpStaRuMmEPkDywroWu.dgzy\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"laboris in nostru\",\n \"company_department\": {\n \"name\": \"dolor adipisicing ea\"\n },\n \"role_at_company\": \"laborum exercitation ut minim\",\n \"locale\": \"en_GB\",\n \"is_active\": true,\n \"company_id\": \"consequat eu dolore\",\n \"password_set\": true,\n \"reset_password\": true,\n \"show_welcome_screen\": false,\n \"compact_layout\": true,\n \"dark_mode\": true,\n \"left_navigation_opened\": true,\n \"mobile_left_navigation_opened\": false,\n \"envelope_layout\": \"qui enim velit\",\n \"envelope_layout_width_percent\": 26387053,\n \"envelope_layout_height_percent\": -47871652,\n \"envelope_details_view\": \"aliqua elit\",\n \"latest_login\": \"1955-09-05T18:05:16.899Z\",\n \"email_verification_hash\": \"officia ex mollit sed\",\n \"email_verification_code\": \"e\",\n \"logo\": \"http://itZgoXGWjtYKuK.qiavW0Fs53Xw79Pesiq077MT1CmLsJPVu9IUphiqbl\",\n \"logo_name\": \"laborum Excepteur\",\n \"id\": \"urn:uuid:1c852e73-d47e-3eee-c969-5bf8f09ccc31\",\n \"notifications\": {\n \"title\": \"ad cupidatat\",\n \"cleared\": false,\n \"seen\": false,\n \"notification_type\": 11,\n \"reference_id\": \"7cecfea0-ebc5-6f10-7244-f22bb842f220\"\n },\n \"insecure_login_method_reminder\": \"2014-06-11T10:45:06.907Z\",\n \"is_cargox_system_user\": \"anim\",\n \"created\": \"2002-09-28T10:39:50.044Z\",\n \"notified_changelog_version\": \"\",\n \"subscribe_to_platform_news\": false\n}" } ] }, { "name": "Update user", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"YgO3iGEQ2l@sxkYWEmLsptBWJghuGQxxMlp.qpn\",\n \"telephone\": \"sunt anim labo\",\n \"roles\": {},\n \"first_name\": \"eu dolor adipisicing pariatur aliquip\",\n \"last_name\": \"amet ipsum sit nulla\",\n \"email_override\": \"GZ2wq8@QKsBvfsFAawIJcEfYzJDtHlgZapyrMzT.nak\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"quis dolor\",\n \"company_department\": {\n \"name\": \"consequat cillum cupidatat ipsu\"\n },\n \"role_at_company\": \"do deserunt nisi amet\",\n \"locale\": \"ar_EG\",\n \"reset_password\": false,\n \"show_welcome_screen\": true,\n \"compact_layout\": false,\n \"dark_mode\": true,\n \"left_navigation_opened\": false,\n \"mobile_left_navigation_opened\": true,\n \"envelope_layout\": \"dolor dolore\",\n \"envelope_layout_width_percent\": -30068380,\n \"envelope_layout_height_percent\": 46871767,\n \"envelope_details_view\": \"cupidatat in sed est\",\n \"email_verification_hash\": \"consequat reprehenderit anim\",\n \"email_verification_code\": \"Duis anim\",\n \"notifications\": {\n \"title\": \"amet\",\n \"cleared\": false,\n \"seen\": true,\n \"notification_type\": 3,\n \"reference_id\": \"b083d345-43b8-3580-b823-f750ef184381\"\n },\n \"insecure_login_method_reminder\": \"1959-09-17T00:27:53.058Z\",\n \"created\": \"1983-01-24T19:41:28.605Z\",\n \"notified_changelog_version\": \"q\",\n \"subscribe_to_platform_news\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] }, "description": "Updates the user. All data needs to be present to perform an update. If data is incomplete,\n please use a `PATCH` call. Users cannot be moved between companies." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"KmARsb9NB@XfGjRDmYLYMPxBpFpFVYZ.sf\",\n \"telephone\": \"proident adipisicing dolore ut velit\",\n \"roles\": {},\n \"name\": \"deserunt nulla eu elit amet\",\n \"first_name\": \"deserunt sint\",\n \"last_name\": \"deserunt sit ex\",\n \"email_override\": \"14GJnTbhW6iVkr@pRkpAeocUMKpStaRuMmEPkDywroWu.dgzy\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"laboris in nostru\",\n \"company_department\": {\n \"name\": \"dolor adipisicing ea\"\n },\n \"role_at_company\": \"laborum exercitation ut minim\",\n \"locale\": \"en_GB\",\n \"is_active\": true,\n \"company_id\": \"consequat eu dolore\",\n \"password_set\": true,\n \"reset_password\": true,\n \"show_welcome_screen\": false,\n \"compact_layout\": true,\n \"dark_mode\": true,\n \"left_navigation_opened\": true,\n \"mobile_left_navigation_opened\": false,\n \"envelope_layout\": \"qui enim velit\",\n \"envelope_layout_width_percent\": 26387053,\n \"envelope_layout_height_percent\": -47871652,\n \"envelope_details_view\": \"aliqua elit\",\n \"latest_login\": \"1955-09-05T18:05:16.899Z\",\n \"email_verification_hash\": \"officia ex mollit sed\",\n \"email_verification_code\": \"e\",\n \"logo\": \"http://itZgoXGWjtYKuK.qiavW0Fs53Xw79Pesiq077MT1CmLsJPVu9IUphiqbl\",\n \"logo_name\": \"laborum Excepteur\",\n \"id\": \"urn:uuid:1c852e73-d47e-3eee-c969-5bf8f09ccc31\",\n \"notifications\": {\n \"title\": \"ad cupidatat\",\n \"cleared\": false,\n \"seen\": false,\n \"notification_type\": 11,\n \"reference_id\": \"7cecfea0-ebc5-6f10-7244-f22bb842f220\"\n },\n \"insecure_login_method_reminder\": \"2014-06-11T10:45:06.907Z\",\n \"is_cargox_system_user\": \"anim\",\n \"created\": \"2002-09-28T10:39:50.044Z\",\n \"notified_changelog_version\": \"\",\n \"subscribe_to_platform_news\": false\n}" } ] }, { "name": "Partially update user", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"YgO3iGEQ2l@sxkYWEmLsptBWJghuGQxxMlp.qpn\",\n \"telephone\": \"sunt anim labo\",\n \"roles\": {},\n \"first_name\": \"eu dolor adipisicing pariatur aliquip\",\n \"last_name\": \"amet ipsum sit nulla\",\n \"email_override\": \"GZ2wq8@QKsBvfsFAawIJcEfYzJDtHlgZapyrMzT.nak\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"quis dolor\",\n \"company_department\": {\n \"name\": \"consequat cillum cupidatat ipsu\"\n },\n \"role_at_company\": \"do deserunt nisi amet\",\n \"locale\": \"ar_EG\",\n \"reset_password\": false,\n \"show_welcome_screen\": true,\n \"compact_layout\": false,\n \"dark_mode\": true,\n \"left_navigation_opened\": false,\n \"mobile_left_navigation_opened\": true,\n \"envelope_layout\": \"dolor dolore\",\n \"envelope_layout_width_percent\": -30068380,\n \"envelope_layout_height_percent\": 46871767,\n \"envelope_details_view\": \"cupidatat in sed est\",\n \"email_verification_hash\": \"consequat reprehenderit anim\",\n \"email_verification_code\": \"Duis anim\",\n \"notifications\": {\n \"title\": \"amet\",\n \"cleared\": false,\n \"seen\": true,\n \"notification_type\": 3,\n \"reference_id\": \"b083d345-43b8-3580-b823-f750ef184381\"\n },\n \"insecure_login_method_reminder\": \"1959-09-17T00:27:53.058Z\",\n \"created\": \"1983-01-24T19:41:28.605Z\",\n \"notified_changelog_version\": \"q\",\n \"subscribe_to_platform_news\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] }, "description": "Partially updates the user. Only the data that needs to be changed is required.\n Users cannot be moved between companies." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"KmARsb9NB@XfGjRDmYLYMPxBpFpFVYZ.sf\",\n \"telephone\": \"proident adipisicing dolore ut velit\",\n \"roles\": {},\n \"name\": \"deserunt nulla eu elit amet\",\n \"first_name\": \"deserunt sint\",\n \"last_name\": \"deserunt sit ex\",\n \"email_override\": \"14GJnTbhW6iVkr@pRkpAeocUMKpStaRuMmEPkDywroWu.dgzy\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"laboris in nostru\",\n \"company_department\": {\n \"name\": \"dolor adipisicing ea\"\n },\n \"role_at_company\": \"laborum exercitation ut minim\",\n \"locale\": \"en_GB\",\n \"is_active\": true,\n \"company_id\": \"consequat eu dolore\",\n \"password_set\": true,\n \"reset_password\": true,\n \"show_welcome_screen\": false,\n \"compact_layout\": true,\n \"dark_mode\": true,\n \"left_navigation_opened\": true,\n \"mobile_left_navigation_opened\": false,\n \"envelope_layout\": \"qui enim velit\",\n \"envelope_layout_width_percent\": 26387053,\n \"envelope_layout_height_percent\": -47871652,\n \"envelope_details_view\": \"aliqua elit\",\n \"latest_login\": \"1955-09-05T18:05:16.899Z\",\n \"email_verification_hash\": \"officia ex mollit sed\",\n \"email_verification_code\": \"e\",\n \"logo\": \"http://itZgoXGWjtYKuK.qiavW0Fs53Xw79Pesiq077MT1CmLsJPVu9IUphiqbl\",\n \"logo_name\": \"laborum Excepteur\",\n \"id\": \"urn:uuid:1c852e73-d47e-3eee-c969-5bf8f09ccc31\",\n \"notifications\": {\n \"title\": \"ad cupidatat\",\n \"cleared\": false,\n \"seen\": false,\n \"notification_type\": 11,\n \"reference_id\": \"7cecfea0-ebc5-6f10-7244-f22bb842f220\"\n },\n \"insecure_login_method_reminder\": \"2014-06-11T10:45:06.907Z\",\n \"is_cargox_system_user\": \"anim\",\n \"created\": \"2002-09-28T10:39:50.044Z\",\n \"notified_changelog_version\": \"\",\n \"subscribe_to_platform_news\": false\n}" } ] }, { "name": "companies users delete", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "companies users missing fields", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/check-missing-fields/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "check-missing-fields", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/check-missing-fields/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "check-missing-fields", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"KmARsb9NB@XfGjRDmYLYMPxBpFpFVYZ.sf\",\n \"telephone\": \"proident adipisicing dolore ut velit\",\n \"roles\": {},\n \"name\": \"deserunt nulla eu elit amet\",\n \"first_name\": \"deserunt sint\",\n \"last_name\": \"deserunt sit ex\",\n \"email_override\": \"14GJnTbhW6iVkr@pRkpAeocUMKpStaRuMmEPkDywroWu.dgzy\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"laboris in nostru\",\n \"company_department\": {\n \"name\": \"dolor adipisicing ea\"\n },\n \"role_at_company\": \"laborum exercitation ut minim\",\n \"locale\": \"en_GB\",\n \"is_active\": true,\n \"company_id\": \"consequat eu dolore\",\n \"password_set\": true,\n \"reset_password\": true,\n \"show_welcome_screen\": false,\n \"compact_layout\": true,\n \"dark_mode\": true,\n \"left_navigation_opened\": true,\n \"mobile_left_navigation_opened\": false,\n \"envelope_layout\": \"qui enim velit\",\n \"envelope_layout_width_percent\": 26387053,\n \"envelope_layout_height_percent\": -47871652,\n \"envelope_details_view\": \"aliqua elit\",\n \"latest_login\": \"1955-09-05T18:05:16.899Z\",\n \"email_verification_hash\": \"officia ex mollit sed\",\n \"email_verification_code\": \"e\",\n \"logo\": \"http://itZgoXGWjtYKuK.qiavW0Fs53Xw79Pesiq077MT1CmLsJPVu9IUphiqbl\",\n \"logo_name\": \"laborum Excepteur\",\n \"id\": \"urn:uuid:1c852e73-d47e-3eee-c969-5bf8f09ccc31\",\n \"notifications\": {\n \"title\": \"ad cupidatat\",\n \"cleared\": false,\n \"seen\": false,\n \"notification_type\": 11,\n \"reference_id\": \"7cecfea0-ebc5-6f10-7244-f22bb842f220\"\n },\n \"insecure_login_method_reminder\": \"2014-06-11T10:45:06.907Z\",\n \"is_cargox_system_user\": \"anim\",\n \"created\": \"2002-09-28T10:39:50.044Z\",\n \"notified_changelog_version\": \"\",\n \"subscribe_to_platform_news\": false\n}" } ] }, { "name": "companies users clear all notifications", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"YgO3iGEQ2l@sxkYWEmLsptBWJghuGQxxMlp.qpn\",\n \"telephone\": \"sunt anim labo\",\n \"roles\": {},\n \"first_name\": \"eu dolor adipisicing pariatur aliquip\",\n \"last_name\": \"amet ipsum sit nulla\",\n \"email_override\": \"GZ2wq8@QKsBvfsFAawIJcEfYzJDtHlgZapyrMzT.nak\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"quis dolor\",\n \"company_department\": {\n \"name\": \"consequat cillum cupidatat ipsu\"\n },\n \"role_at_company\": \"do deserunt nisi amet\",\n \"locale\": \"ar_EG\",\n \"reset_password\": false,\n \"show_welcome_screen\": true,\n \"compact_layout\": false,\n \"dark_mode\": true,\n \"left_navigation_opened\": false,\n \"mobile_left_navigation_opened\": true,\n \"envelope_layout\": \"dolor dolore\",\n \"envelope_layout_width_percent\": -30068380,\n \"envelope_layout_height_percent\": 46871767,\n \"envelope_details_view\": \"cupidatat in sed est\",\n \"email_verification_hash\": \"consequat reprehenderit anim\",\n \"email_verification_code\": \"Duis anim\",\n \"notifications\": {\n \"title\": \"amet\",\n \"cleared\": false,\n \"seen\": true,\n \"notification_type\": 3,\n \"reference_id\": \"b083d345-43b8-3580-b823-f750ef184381\"\n },\n \"insecure_login_method_reminder\": \"1959-09-17T00:27:53.058Z\",\n \"created\": \"1983-01-24T19:41:28.605Z\",\n \"notified_changelog_version\": \"q\",\n \"subscribe_to_platform_news\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/clear-all-notifications/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "clear-all-notifications", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/clear-all-notifications/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "clear-all-notifications", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"KmARsb9NB@XfGjRDmYLYMPxBpFpFVYZ.sf\",\n \"telephone\": \"proident adipisicing dolore ut velit\",\n \"roles\": {},\n \"name\": \"deserunt nulla eu elit amet\",\n \"first_name\": \"deserunt sint\",\n \"last_name\": \"deserunt sit ex\",\n \"email_override\": \"14GJnTbhW6iVkr@pRkpAeocUMKpStaRuMmEPkDywroWu.dgzy\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"laboris in nostru\",\n \"company_department\": {\n \"name\": \"dolor adipisicing ea\"\n },\n \"role_at_company\": \"laborum exercitation ut minim\",\n \"locale\": \"en_GB\",\n \"is_active\": true,\n \"company_id\": \"consequat eu dolore\",\n \"password_set\": true,\n \"reset_password\": true,\n \"show_welcome_screen\": false,\n \"compact_layout\": true,\n \"dark_mode\": true,\n \"left_navigation_opened\": true,\n \"mobile_left_navigation_opened\": false,\n \"envelope_layout\": \"qui enim velit\",\n \"envelope_layout_width_percent\": 26387053,\n \"envelope_layout_height_percent\": -47871652,\n \"envelope_details_view\": \"aliqua elit\",\n \"latest_login\": \"1955-09-05T18:05:16.899Z\",\n \"email_verification_hash\": \"officia ex mollit sed\",\n \"email_verification_code\": \"e\",\n \"logo\": \"http://itZgoXGWjtYKuK.qiavW0Fs53Xw79Pesiq077MT1CmLsJPVu9IUphiqbl\",\n \"logo_name\": \"laborum Excepteur\",\n \"id\": \"urn:uuid:1c852e73-d47e-3eee-c969-5bf8f09ccc31\",\n \"notifications\": {\n \"title\": \"ad cupidatat\",\n \"cleared\": false,\n \"seen\": false,\n \"notification_type\": 11,\n \"reference_id\": \"7cecfea0-ebc5-6f10-7244-f22bb842f220\"\n },\n \"insecure_login_method_reminder\": \"2014-06-11T10:45:06.907Z\",\n \"is_cargox_system_user\": \"anim\",\n \"created\": \"2002-09-28T10:39:50.044Z\",\n \"notified_changelog_version\": \"\",\n \"subscribe_to_platform_news\": false\n}" } ] }, { "name": "Close top bar notification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"YgO3iGEQ2l@sxkYWEmLsptBWJghuGQxxMlp.qpn\",\n \"telephone\": \"sunt anim labo\",\n \"roles\": {},\n \"first_name\": \"eu dolor adipisicing pariatur aliquip\",\n \"last_name\": \"amet ipsum sit nulla\",\n \"email_override\": \"GZ2wq8@QKsBvfsFAawIJcEfYzJDtHlgZapyrMzT.nak\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"quis dolor\",\n \"company_department\": {\n \"name\": \"consequat cillum cupidatat ipsu\"\n },\n \"role_at_company\": \"do deserunt nisi amet\",\n \"locale\": \"ar_EG\",\n \"reset_password\": false,\n \"show_welcome_screen\": true,\n \"compact_layout\": false,\n \"dark_mode\": true,\n \"left_navigation_opened\": false,\n \"mobile_left_navigation_opened\": true,\n \"envelope_layout\": \"dolor dolore\",\n \"envelope_layout_width_percent\": -30068380,\n \"envelope_layout_height_percent\": 46871767,\n \"envelope_details_view\": \"cupidatat in sed est\",\n \"email_verification_hash\": \"consequat reprehenderit anim\",\n \"email_verification_code\": \"Duis anim\",\n \"notifications\": {\n \"title\": \"amet\",\n \"cleared\": false,\n \"seen\": true,\n \"notification_type\": 3,\n \"reference_id\": \"b083d345-43b8-3580-b823-f750ef184381\"\n },\n \"insecure_login_method_reminder\": \"1959-09-17T00:27:53.058Z\",\n \"created\": \"1983-01-24T19:41:28.605Z\",\n \"notified_changelog_version\": \"q\",\n \"subscribe_to_platform_news\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/close-top-bar-notification/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "close-top-bar-notification", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] }, "description": "This endpoint records that user closed a top bar notification." }, "response": [ { "name": "Returns status `ok` if password is set or changed successfully", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/close-top-bar-notification/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "close-top-bar-notification", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when the user is not authenticated.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/close-top-bar-notification/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "close-top-bar-notification", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when the notification parameter is invalid.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/close-top-bar-notification/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "close-top-bar-notification", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] } }, "code": 471, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Get company data", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/data/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "data", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] }, "description": "\nReturns a dictionary of company data. \n" }, "response": [ { "name": "Returns company data.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/data/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "data", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when user performing request has insufficient permissions or if user has no company.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/data/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "data", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/data/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "data", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "companies users generate temporary token", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/get-temporary-login-token/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "get-temporary-login-token", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/get-temporary-login-token/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "get-temporary-login-token", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"KmARsb9NB@XfGjRDmYLYMPxBpFpFVYZ.sf\",\n \"telephone\": \"proident adipisicing dolore ut velit\",\n \"roles\": {},\n \"name\": \"deserunt nulla eu elit amet\",\n \"first_name\": \"deserunt sint\",\n \"last_name\": \"deserunt sit ex\",\n \"email_override\": \"14GJnTbhW6iVkr@pRkpAeocUMKpStaRuMmEPkDywroWu.dgzy\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"laboris in nostru\",\n \"company_department\": {\n \"name\": \"dolor adipisicing ea\"\n },\n \"role_at_company\": \"laborum exercitation ut minim\",\n \"locale\": \"en_GB\",\n \"is_active\": true,\n \"company_id\": \"consequat eu dolore\",\n \"password_set\": true,\n \"reset_password\": true,\n \"show_welcome_screen\": false,\n \"compact_layout\": true,\n \"dark_mode\": true,\n \"left_navigation_opened\": true,\n \"mobile_left_navigation_opened\": false,\n \"envelope_layout\": \"qui enim velit\",\n \"envelope_layout_width_percent\": 26387053,\n \"envelope_layout_height_percent\": -47871652,\n \"envelope_details_view\": \"aliqua elit\",\n \"latest_login\": \"1955-09-05T18:05:16.899Z\",\n \"email_verification_hash\": \"officia ex mollit sed\",\n \"email_verification_code\": \"e\",\n \"logo\": \"http://itZgoXGWjtYKuK.qiavW0Fs53Xw79Pesiq077MT1CmLsJPVu9IUphiqbl\",\n \"logo_name\": \"laborum Excepteur\",\n \"id\": \"urn:uuid:1c852e73-d47e-3eee-c969-5bf8f09ccc31\",\n \"notifications\": {\n \"title\": \"ad cupidatat\",\n \"cleared\": false,\n \"seen\": false,\n \"notification_type\": 11,\n \"reference_id\": \"7cecfea0-ebc5-6f10-7244-f22bb842f220\"\n },\n \"insecure_login_method_reminder\": \"2014-06-11T10:45:06.907Z\",\n \"is_cargox_system_user\": \"anim\",\n \"created\": \"2002-09-28T10:39:50.044Z\",\n \"notified_changelog_version\": \"\",\n \"subscribe_to_platform_news\": false\n}" } ] }, { "name": "List login attempts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/login-attempts/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "login-attempts", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] }, "description": "This endpoint lists login attempts for the user." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/login-attempts/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "login-attempts", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"298ca726-6f8d-8559-1f4a-88a3c8b2e0be\",\n \"user_id\": \"quis enim ut\",\n \"ip_address\": \"Duis incididunt aute lab\",\n \"type\": \"cargox\",\n \"device\": \"ut consectetur magna eiusmod\",\n \"created\": \"1979-06-03T22:27:42.668Z\",\n \"username\": \"ut consequat\",\n \"success\": false\n}" }, { "name": "Returned when the authenticated user is not a 3rd-party company or the user himself", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/login-attempts/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "login-attempts", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Login URL token", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/login-token/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "login-token", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] }, "description": "\nThis endpoint generates a login token that can be used as a part of a URL to seamlessly login a user. Only authorized 3rd-party companies that can authenticate as users of their companies can use this endpoint.\n\nThis is particularly useful for white-labelled CargoX iframes where users are already logged in a parent system. They are unburdened with authentication on CargoX.\n\nThe tokens are short lived and are considered for single use. The workflow should be the following:\n\n1. Fetch the token from the API\n1. Render the iframe to the user with the appropriate query string (`?login_token={login_token}`) or use the `login_url` as the `src` of the frame.\n\n" }, "response": [ { "name": "The login token that can be used to seamlessly login the user without entering the username and password. Particularly useful in solutions where CargoX is loaded via `iframe`.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/login-token/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "login-token", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"login_token\": \"voluptate dolor\",\n \"expires\": \"1964-09-21T19:58:04.791Z\",\n \"login_url\": \"https://IRxAwgkgllcue.gzFIQXGT,HHsNRh0vzgvbNWNQ3bAwgL,SyEGBQsqG6Os2L\"\n}" }, { "name": "Returned when the authenticated user is not a 3rd-party company.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/login-token/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "login-token", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Manage password", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"YgO3iGEQ2l@sxkYWEmLsptBWJghuGQxxMlp.qpn\",\n \"telephone\": \"sunt anim labo\",\n \"roles\": {},\n \"first_name\": \"eu dolor adipisicing pariatur aliquip\",\n \"last_name\": \"amet ipsum sit nulla\",\n \"email_override\": \"GZ2wq8@QKsBvfsFAawIJcEfYzJDtHlgZapyrMzT.nak\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"quis dolor\",\n \"company_department\": {\n \"name\": \"consequat cillum cupidatat ipsu\"\n },\n \"role_at_company\": \"do deserunt nisi amet\",\n \"locale\": \"ar_EG\",\n \"reset_password\": false,\n \"show_welcome_screen\": true,\n \"compact_layout\": false,\n \"dark_mode\": true,\n \"left_navigation_opened\": false,\n \"mobile_left_navigation_opened\": true,\n \"envelope_layout\": \"dolor dolore\",\n \"envelope_layout_width_percent\": -30068380,\n \"envelope_layout_height_percent\": 46871767,\n \"envelope_details_view\": \"cupidatat in sed est\",\n \"email_verification_hash\": \"consequat reprehenderit anim\",\n \"email_verification_code\": \"Duis anim\",\n \"notifications\": {\n \"title\": \"amet\",\n \"cleared\": false,\n \"seen\": true,\n \"notification_type\": 3,\n \"reference_id\": \"b083d345-43b8-3580-b823-f750ef184381\"\n },\n \"insecure_login_method_reminder\": \"1959-09-17T00:27:53.058Z\",\n \"created\": \"1983-01-24T19:41:28.605Z\",\n \"notified_changelog_version\": \"q\",\n \"subscribe_to_platform_news\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/password/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "password", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] }, "description": "This endpoint sets or changes the password for the user." }, "response": [ { "name": "Returns status `ok` if password is set or changed successfully", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/password/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "password", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when the user is not authenticated.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/password/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "password", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when the password parameter is invalid.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/password/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "password", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" }, { "key": "user", "value": "cons", "description": "(Required) \nThe user identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|---------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in user. |\n| `by-id/{id}` | Determine the user by their ID. Replace `{id}` with internal user id. |\n| `by-eth-addr/{eth_addr}`| Determine the user by their ethereum address. Replace `{eth_addr}` with users' ethereum address |\n" } ] } }, "code": 471, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "companies users update missing fields", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"YgO3iGEQ2l@sxkYWEmLsptBWJghuGQxxMlp.qpn\",\n \"telephone\": \"sunt anim labo\",\n \"roles\": {},\n \"first_name\": \"eu dolor adipisicing pariatur aliquip\",\n \"last_name\": \"amet ipsum sit nulla\",\n \"email_override\": \"GZ2wq8@QKsBvfsFAawIJcEfYzJDtHlgZapyrMzT.nak\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"quis dolor\",\n \"company_department\": {\n \"name\": \"consequat cillum cupidatat ipsu\"\n },\n \"role_at_company\": \"do deserunt nisi amet\",\n \"locale\": \"ar_EG\",\n \"reset_password\": false,\n \"show_welcome_screen\": true,\n \"compact_layout\": false,\n \"dark_mode\": true,\n \"left_navigation_opened\": false,\n \"mobile_left_navigation_opened\": true,\n \"envelope_layout\": \"dolor dolore\",\n \"envelope_layout_width_percent\": -30068380,\n \"envelope_layout_height_percent\": 46871767,\n \"envelope_details_view\": \"cupidatat in sed est\",\n \"email_verification_hash\": \"consequat reprehenderit anim\",\n \"email_verification_code\": \"Duis anim\",\n \"notifications\": {\n \"title\": \"amet\",\n \"cleared\": false,\n \"seen\": true,\n \"notification_type\": 3,\n \"reference_id\": \"b083d345-43b8-3580-b823-f750ef184381\"\n },\n \"insecure_login_method_reminder\": \"1959-09-17T00:27:53.058Z\",\n \"created\": \"1983-01-24T19:41:28.605Z\",\n \"notified_changelog_version\": \"q\",\n \"subscribe_to_platform_news\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/update-missing-fields/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "update-missing-fields", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/:user/update-missing-fields/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", ":user", "update-missing-fields", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " }, { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"KmARsb9NB@XfGjRDmYLYMPxBpFpFVYZ.sf\",\n \"telephone\": \"proident adipisicing dolore ut velit\",\n \"roles\": {},\n \"name\": \"deserunt nulla eu elit amet\",\n \"first_name\": \"deserunt sint\",\n \"last_name\": \"deserunt sit ex\",\n \"email_override\": \"14GJnTbhW6iVkr@pRkpAeocUMKpStaRuMmEPkDywroWu.dgzy\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"laboris in nostru\",\n \"company_department\": {\n \"name\": \"dolor adipisicing ea\"\n },\n \"role_at_company\": \"laborum exercitation ut minim\",\n \"locale\": \"en_GB\",\n \"is_active\": true,\n \"company_id\": \"consequat eu dolore\",\n \"password_set\": true,\n \"reset_password\": true,\n \"show_welcome_screen\": false,\n \"compact_layout\": true,\n \"dark_mode\": true,\n \"left_navigation_opened\": true,\n \"mobile_left_navigation_opened\": false,\n \"envelope_layout\": \"qui enim velit\",\n \"envelope_layout_width_percent\": 26387053,\n \"envelope_layout_height_percent\": -47871652,\n \"envelope_details_view\": \"aliqua elit\",\n \"latest_login\": \"1955-09-05T18:05:16.899Z\",\n \"email_verification_hash\": \"officia ex mollit sed\",\n \"email_verification_code\": \"e\",\n \"logo\": \"http://itZgoXGWjtYKuK.qiavW0Fs53Xw79Pesiq077MT1CmLsJPVu9IUphiqbl\",\n \"logo_name\": \"laborum Excepteur\",\n \"id\": \"urn:uuid:1c852e73-d47e-3eee-c969-5bf8f09ccc31\",\n \"notifications\": {\n \"title\": \"ad cupidatat\",\n \"cleared\": false,\n \"seen\": false,\n \"notification_type\": 11,\n \"reference_id\": \"7cecfea0-ebc5-6f10-7244-f22bb842f220\"\n },\n \"insecure_login_method_reminder\": \"2014-06-11T10:45:06.907Z\",\n \"is_cargox_system_user\": \"anim\",\n \"created\": \"2002-09-28T10:39:50.044Z\",\n \"notified_changelog_version\": \"\",\n \"subscribe_to_platform_news\": false\n}" } ] } ] }, { "name": "Create user", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"YgO3iGEQ2l@sxkYWEmLsptBWJghuGQxxMlp.qpn\",\n \"telephone\": \"sunt anim labo\",\n \"roles\": {},\n \"first_name\": \"eu dolor adipisicing pariatur aliquip\",\n \"last_name\": \"amet ipsum sit nulla\",\n \"email_override\": \"GZ2wq8@QKsBvfsFAawIJcEfYzJDtHlgZapyrMzT.nak\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"quis dolor\",\n \"company_department\": {\n \"name\": \"consequat cillum cupidatat ipsu\"\n },\n \"role_at_company\": \"do deserunt nisi amet\",\n \"locale\": \"ar_EG\",\n \"reset_password\": false,\n \"show_welcome_screen\": true,\n \"compact_layout\": false,\n \"dark_mode\": true,\n \"left_navigation_opened\": false,\n \"mobile_left_navigation_opened\": true,\n \"envelope_layout\": \"dolor dolore\",\n \"envelope_layout_width_percent\": -30068380,\n \"envelope_layout_height_percent\": 46871767,\n \"envelope_details_view\": \"cupidatat in sed est\",\n \"email_verification_hash\": \"consequat reprehenderit anim\",\n \"email_verification_code\": \"Duis anim\",\n \"notifications\": {\n \"title\": \"amet\",\n \"cleared\": false,\n \"seen\": true,\n \"notification_type\": 3,\n \"reference_id\": \"b083d345-43b8-3580-b823-f750ef184381\"\n },\n \"insecure_login_method_reminder\": \"1959-09-17T00:27:53.058Z\",\n \"created\": \"1983-01-24T19:41:28.605Z\",\n \"notified_changelog_version\": \"q\",\n \"subscribe_to_platform_news\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/users/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "users", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] }, "description": "Creates a new user for a company that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "users", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"KmARsb9NB@XfGjRDmYLYMPxBpFpFVYZ.sf\",\n \"telephone\": \"proident adipisicing dolore ut velit\",\n \"roles\": {},\n \"name\": \"deserunt nulla eu elit amet\",\n \"first_name\": \"deserunt sint\",\n \"last_name\": \"deserunt sit ex\",\n \"email_override\": \"14GJnTbhW6iVkr@pRkpAeocUMKpStaRuMmEPkDywroWu.dgzy\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"laboris in nostru\",\n \"company_department\": {\n \"name\": \"dolor adipisicing ea\"\n },\n \"role_at_company\": \"laborum exercitation ut minim\",\n \"locale\": \"en_GB\",\n \"is_active\": true,\n \"company_id\": \"consequat eu dolore\",\n \"password_set\": true,\n \"reset_password\": true,\n \"show_welcome_screen\": false,\n \"compact_layout\": true,\n \"dark_mode\": true,\n \"left_navigation_opened\": true,\n \"mobile_left_navigation_opened\": false,\n \"envelope_layout\": \"qui enim velit\",\n \"envelope_layout_width_percent\": 26387053,\n \"envelope_layout_height_percent\": -47871652,\n \"envelope_details_view\": \"aliqua elit\",\n \"latest_login\": \"1955-09-05T18:05:16.899Z\",\n \"email_verification_hash\": \"officia ex mollit sed\",\n \"email_verification_code\": \"e\",\n \"logo\": \"http://itZgoXGWjtYKuK.qiavW0Fs53Xw79Pesiq077MT1CmLsJPVu9IUphiqbl\",\n \"logo_name\": \"laborum Excepteur\",\n \"id\": \"urn:uuid:1c852e73-d47e-3eee-c969-5bf8f09ccc31\",\n \"notifications\": {\n \"title\": \"ad cupidatat\",\n \"cleared\": false,\n \"seen\": false,\n \"notification_type\": 11,\n \"reference_id\": \"7cecfea0-ebc5-6f10-7244-f22bb842f220\"\n },\n \"insecure_login_method_reminder\": \"2014-06-11T10:45:06.907Z\",\n \"is_cargox_system_user\": \"anim\",\n \"created\": \"2002-09-28T10:39:50.044Z\",\n \"notified_changelog_version\": \"\",\n \"subscribe_to_platform_news\": false\n}" } ] }, { "name": "List users", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/users/list/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "users", "list", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] }, "description": "Lists all users of companies that the logged in 3rd-party system is allowed to manage." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/users/list/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "users", "list", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"email\": \"Fil7@aRTybUyOKRDnnIVdPPAEWmcOfMyM.zq\",\n \"telephone\": \"con\",\n \"roles\": {},\n \"name\": \"qui enim aute ut\",\n \"first_name\": \"sit elit qui sint nostrud\",\n \"last_name\": \"laborum\",\n \"email_override\": \"13B0wshUK@n.cp\",\n \"accept_declaration_of_authorisation\": true,\n \"notes\": \"aliqua nulla\",\n \"company_department\": {\n \"name\": \"sunt\"\n },\n \"role_at_company\": \"labore laboris\",\n \"locale\": \"en_GB\",\n \"is_active\": true,\n \"company_id\": \"occaecat\",\n \"password_set\": true,\n \"reset_password\": true,\n \"show_welcome_screen\": true,\n \"compact_layout\": false,\n \"dark_mode\": true,\n \"left_navigation_opened\": true,\n \"mobile_left_navigation_opened\": true,\n \"envelope_layout\": \"ipsum in sunt\",\n \"envelope_layout_width_percent\": 16694791,\n \"envelope_layout_height_percent\": -96150685,\n \"envelope_details_view\": \"consectetur magna tempor ut\",\n \"latest_login\": \"1988-01-07T22:22:38.216Z\",\n \"email_verification_hash\": \"aliqua ad dolore\",\n \"email_verification_code\": \"adipisicing occaecat ut magna Lorem\",\n \"logo\": \"http://yHRuRVlBI.hkiaXjDGisxfBr2XFrTnZCUCbpwpUujGzVbouEeGxgX\",\n \"logo_name\": \"aute sit \",\n \"id\": \"0dba5906-9c4f-b44a-d630-67bf437764cc\",\n \"notifications\": {\n \"title\": \"exercitation sed\",\n \"cleared\": true,\n \"seen\": false,\n \"notification_type\": 3,\n \"reference_id\": \"386e96a7-1cef-64ac-ddbb-3128e6506188\"\n },\n \"insecure_login_method_reminder\": \"1957-06-26T04:01:30.582Z\",\n \"is_cargox_system_user\": \"veniam\",\n \"created\": \"1998-02-16T10:57:37.084Z\",\n \"notified_changelog_version\": \"la\",\n \"subscribe_to_platform_news\": false\n },\n {\n \"email\": \"GIHL8FLsol@DngkIYMaYqcBVbKDlaUJucyS.ghd\",\n \"telephone\": \"exercitation mollit\",\n \"roles\": {},\n \"name\": \"voluptate \",\n \"first_name\": \"nulla culpa tempor elit\",\n \"last_name\": \"anim\",\n \"email_override\": \"bcyJAy7UYogcB9@hhEmLYnFEZVB.zp\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"nisi\",\n \"company_department\": {\n \"name\": \"esse culpa cillum\"\n },\n \"role_at_company\": \"Duis velit ex U\",\n \"locale\": \"hr_HR\",\n \"is_active\": true,\n \"company_id\": \"Lorem nulla\",\n \"password_set\": false,\n \"reset_password\": false,\n \"show_welcome_screen\": true,\n \"compact_layout\": true,\n \"dark_mode\": true,\n \"left_navigation_opened\": false,\n \"mobile_left_navigation_opened\": false,\n \"envelope_layout\": \"in tempor\",\n \"envelope_layout_width_percent\": 14759592,\n \"envelope_layout_height_percent\": -41932475,\n \"envelope_details_view\": \"adipisicing ullamco elit\",\n \"latest_login\": \"2015-03-19T11:50:48.960Z\",\n \"email_verification_hash\": \"minim\",\n \"email_verification_code\": \"laboris eu ea dolore\",\n \"logo\": \"https://UvwHmLVjCrFfXEHeeZOQ.ovyYgB6zh9O,L+moMqsXK.aofC8oZl\",\n \"logo_name\": \"nulla incididunt eni\",\n \"id\": \"5fd84364-da2d-c3ff-46d0-b6bf1bdfa953\",\n \"notifications\": {\n \"title\": \"Excepteur in commodo\",\n \"cleared\": true,\n \"seen\": true,\n \"notification_type\": 0,\n \"reference_id\": \"fbd80a0b-9911-cd31-f26a-ce0057cde37f\"\n },\n \"insecure_login_method_reminder\": \"1998-06-10T04:17:36.971Z\",\n \"is_cargox_system_user\": \"consectetur sed labore id occaecat\",\n \"created\": \"1944-07-12T19:11:30.593Z\",\n \"notified_changelog_version\": \"e\",\n \"subscribe_to_platform_news\": true\n }\n]" } ] } ] }, { "name": "Retrieve company", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] }, "description": "Retrieves a single company that can be managed by the logged in user." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"dolor deserunt\",\n \"address\": \"ut reprehenderit\",\n \"postal_code\": \"deserunt inci\",\n \"city\": \"dolore culpa incididunt\",\n \"branch\": \"ea ex proident dolor\",\n \"address2\": \"eu incididunt\",\n \"name_latin\": \"qui laborum veniam\",\n \"address_latin\": \"ea enim amet\",\n \"postal_code_latin\": \"non dolor veniam elit incididunt\",\n \"city_latin\": \"Excepteur voluptate\",\n \"country\": \"CV\",\n \"country_name\": \"aliquip mollit pariatur\",\n \"billing_attn_to\": \"do est exercitation eu\",\n \"billing_email\": \"nc7CHPRsB@BZGgsNzCMTvOwpKxLcBh.wf\",\n \"telephone\": \"dolor Excepteur non\",\n \"website\": \"ea quis aliqua\",\n \"email\": \"Pm0FAMjVK@FfQtMce.cyf\",\n \"registration_number\": \"tempor non commodo\",\n \"duns_number\": \"aute adipisicing sed cupidatat\",\n \"eori_number\": \"minim sint cillum\",\n \"lei_number\": \"minim\",\n \"vat_number\": \"enim officia ipsum quis ut\",\n \"vat_rate\": \"enim ipsum in \",\n \"country_vat_rate\": \"velit elit\",\n \"is_eu_company\": \"labore cupidatat commodo\",\n \"is_eu_vat_company\": \"in incididunt voluptate occaecat minim\",\n \"logo\": \"http://kbLaCOOUGo.duPP92uuekDeAkFn\",\n \"logo_name\": \"consequat anim ea minim\",\n \"inboxes\": [\n {\n \"name\": \"voluptate ea\",\n \"company_id\": \"id dolore\",\n \"ethereum_address\": \"0xE1CDfb4afd31Cccc42EC8920b7e60eb7c8D9B49D\",\n \"id\": \"c8553070-48ea-eef2-81b7-319cf8ad3a7a\"\n },\n {\n \"name\": \"est voluptate dolore elit\",\n \"company_id\": \"aute enim eiusmod\",\n \"ethereum_address\": \"0x6ecCa0E0Acb8Ca0EDc8ba1d364eE20B2B52dc53c\",\n \"id\": \"74dccc59-4193-5294-9a96-d5eb48e00e5f\"\n }\n ],\n \"default_inbox_id\": \"incididunt exercitation aliqua\",\n \"latest_terms_accepted\": \"sed dolor\",\n \"ethereum_address\": \"sit\",\n \"is_affiliate_partner\": false,\n \"affiliate_id\": \"reprehenderit irure quis eiusmod\",\n \"subscription\": {\n \"subscription_tier\": {\n \"name\": \"pariatur sit commodo ipsum dolore\",\n \"monthly_price\": \"incididunt aliqua proident\",\n \"yearly_price\": \"consectetur est dolore\",\n \"additional_credits_per_month\": 1539803697840337000,\n \"non_blockchain_transfer_limit\": -963505305,\n \"contacts_limit\": 826134861,\n \"users_limit\": -1640928108,\n \"rules_limit\": -338017958,\n \"connected_apps_limit\": 238852463,\n \"attachments_per_envelope_limit\": 816129983,\n \"attachments_size_per_envelope_limit\": 919115867,\n \"relayer_speed\": \"normal\",\n \"pdf_audit_log_enabled\": true\n },\n \"number_of_licences\": -463614727,\n \"valid_until\": \"2005-02-05T03:03:04.470Z\"\n },\n \"pending_subscription_renewal\": \"ut mollit ullamco\",\n \"number_of_non_blockchain_transactions_last_month\": \"cillum cupidatat est\",\n \"pending_company_details_change_request\": \"Duis occaecat\",\n \"verified_dnb\": \"ex incididunt proident voluptate occaecat\",\n \"verified_vies\": \"deserunt\",\n \"verified_bank\": \"nisi in\",\n \"verification_dnb\": \"labore dolor tempor Ut incididunt\",\n \"verification_vies\": \"consequat laborum\",\n \"verification_bank\": \"quis Ut\",\n \"dnb_verification_paid\": true,\n \"last_approved_details_change_request_date\": \"pariatur adipisicing laborum velit\",\n \"fiata_efbl_enabled\": true,\n \"fiata_carrier_id\": \"dolore\",\n \"additional_vats\": [\n {\n \"country\": \"MX\",\n \"id\": \"6454b14b-eb88-043a-8196-a8052efaca16\",\n \"company_id\": \"non ad consectetur mollit\",\n \"vat_number\": \"proident incididunt ea\",\n \"country_name\": \"adipisicing est aliquip consequat\",\n \"vies_verification\": {\n \"type\": \"vies\",\n \"status\": \"verified\",\n \"verified\": \"1999-04-11T11:14:33.562Z\",\n \"failure_reason\": \"mollit aliquip es\",\n \"processed\": \"2016-04-26T00:29:11.498Z\"\n },\n \"verified_vies\": \"ea pariatur adipisicing Ut tempor\"\n },\n {\n \"country\": \"DO\",\n \"id\": \"38eddfef-cb4f-95cb-7e5e-18356d0dd86e\",\n \"company_id\": \"magna ipsum adipisicing cillum\",\n \"vat_number\": \"tempor Duis\",\n \"country_name\": \"ipsum pariatur occaecat\",\n \"vies_verification\": {\n \"type\": \"bank\",\n \"status\": \"pending_review\",\n \"verified\": \"1996-10-18T09:54:06.242Z\",\n \"failure_reason\": \"quis proident id aliquip ei\",\n \"processed\": \"1979-09-27T18:42:04.371Z\"\n },\n \"verified_vies\": \"laboru\"\n }\n ],\n \"created\": \"1995-06-30T05:08:11.411Z\",\n \"wants_invoices_instead_of_proforma\": false,\n \"id\": \"d81a853d-86be-4744-722c-a04bbdb72e79\"\n}" } ] }, { "name": "Update company", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"adipisicing nostrud\",\n \"address\": \"dolor deserunt labore inci\",\n \"postal_code\": \"occaecat Ut est commodo\",\n \"city\": \"cupidatat do est\",\n \"branch\": \"reprehenderit\",\n \"address2\": \"deserunt\",\n \"name_latin\": \"deserunt ad veniam non\",\n \"address_latin\": \"ullamco\",\n \"postal_code_latin\": \"laboris sunt dolor aute do\",\n \"city_latin\": \"ex minim elit Duis\",\n \"country\": \"AU\",\n \"billing_attn_to\": \"velit labore esse\",\n \"billing_email\": \"ol8a3@aWw.nq\",\n \"telephone\": \"dolor ad irure\",\n \"website\": \"elit occaecat do fugiat\",\n \"email\": \"7bMkUgWwgkk-Nf@nIzXEOECuaAXPCXxozDaLFz.veup\",\n \"registration_number\": \"voluptate dolor in\",\n \"duns_number\": \"eiusmod\",\n \"eori_number\": \"laboris veniam sint consectetur\",\n \"lei_number\": \"occaecat labore est\",\n \"vat_number\": \"non\",\n \"subscription\": {\n \"subscription_tier\": {\n \"name\": \"sed anim ut fugiat\",\n \"monthly_price\": \"aliquip ipsum reprehenderit adipisicing consectetur\",\n \"yearly_price\": \"ea reprehenderit quis aliqua\",\n \"additional_credits_per_month\": -4042505544361328600,\n \"non_blockchain_transfer_limit\": 1404767486,\n \"contacts_limit\": 52027954,\n \"users_limit\": -1342984806,\n \"rules_limit\": -1942772934,\n \"connected_apps_limit\": -671037901,\n \"attachments_per_envelope_limit\": 395578582,\n \"attachments_size_per_envelope_limit\": -1380732928,\n \"relayer_speed\": \"normal\",\n \"pdf_audit_log_enabled\": false\n },\n \"number_of_licences\": -1942100196,\n \"valid_until\": \"1995-01-30T12:12:23.690Z\"\n },\n \"fiata_efbl_enabled\": true,\n \"fiata_carrier_id\": \"Ut aliqua\",\n \"created\": \"2012-08-25T09:36:35.198Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] }, "description": "Updates the company. All data needs to be present to perform an update. If data is\n incomplete, please use a `PATCH` call. Company ethereum address cannot be changed." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"dolor deserunt\",\n \"address\": \"ut reprehenderit\",\n \"postal_code\": \"deserunt inci\",\n \"city\": \"dolore culpa incididunt\",\n \"branch\": \"ea ex proident dolor\",\n \"address2\": \"eu incididunt\",\n \"name_latin\": \"qui laborum veniam\",\n \"address_latin\": \"ea enim amet\",\n \"postal_code_latin\": \"non dolor veniam elit incididunt\",\n \"city_latin\": \"Excepteur voluptate\",\n \"country\": \"CV\",\n \"country_name\": \"aliquip mollit pariatur\",\n \"billing_attn_to\": \"do est exercitation eu\",\n \"billing_email\": \"nc7CHPRsB@BZGgsNzCMTvOwpKxLcBh.wf\",\n \"telephone\": \"dolor Excepteur non\",\n \"website\": \"ea quis aliqua\",\n \"email\": \"Pm0FAMjVK@FfQtMce.cyf\",\n \"registration_number\": \"tempor non commodo\",\n \"duns_number\": \"aute adipisicing sed cupidatat\",\n \"eori_number\": \"minim sint cillum\",\n \"lei_number\": \"minim\",\n \"vat_number\": \"enim officia ipsum quis ut\",\n \"vat_rate\": \"enim ipsum in \",\n \"country_vat_rate\": \"velit elit\",\n \"is_eu_company\": \"labore cupidatat commodo\",\n \"is_eu_vat_company\": \"in incididunt voluptate occaecat minim\",\n \"logo\": \"http://kbLaCOOUGo.duPP92uuekDeAkFn\",\n \"logo_name\": \"consequat anim ea minim\",\n \"inboxes\": [\n {\n \"name\": \"voluptate ea\",\n \"company_id\": \"id dolore\",\n \"ethereum_address\": \"0xE1CDfb4afd31Cccc42EC8920b7e60eb7c8D9B49D\",\n \"id\": \"c8553070-48ea-eef2-81b7-319cf8ad3a7a\"\n },\n {\n \"name\": \"est voluptate dolore elit\",\n \"company_id\": \"aute enim eiusmod\",\n \"ethereum_address\": \"0x6ecCa0E0Acb8Ca0EDc8ba1d364eE20B2B52dc53c\",\n \"id\": \"74dccc59-4193-5294-9a96-d5eb48e00e5f\"\n }\n ],\n \"default_inbox_id\": \"incididunt exercitation aliqua\",\n \"latest_terms_accepted\": \"sed dolor\",\n \"ethereum_address\": \"sit\",\n \"is_affiliate_partner\": false,\n \"affiliate_id\": \"reprehenderit irure quis eiusmod\",\n \"subscription\": {\n \"subscription_tier\": {\n \"name\": \"pariatur sit commodo ipsum dolore\",\n \"monthly_price\": \"incididunt aliqua proident\",\n \"yearly_price\": \"consectetur est dolore\",\n \"additional_credits_per_month\": 1539803697840337000,\n \"non_blockchain_transfer_limit\": -963505305,\n \"contacts_limit\": 826134861,\n \"users_limit\": -1640928108,\n \"rules_limit\": -338017958,\n \"connected_apps_limit\": 238852463,\n \"attachments_per_envelope_limit\": 816129983,\n \"attachments_size_per_envelope_limit\": 919115867,\n \"relayer_speed\": \"normal\",\n \"pdf_audit_log_enabled\": true\n },\n \"number_of_licences\": -463614727,\n \"valid_until\": \"2005-02-05T03:03:04.470Z\"\n },\n \"pending_subscription_renewal\": \"ut mollit ullamco\",\n \"number_of_non_blockchain_transactions_last_month\": \"cillum cupidatat est\",\n \"pending_company_details_change_request\": \"Duis occaecat\",\n \"verified_dnb\": \"ex incididunt proident voluptate occaecat\",\n \"verified_vies\": \"deserunt\",\n \"verified_bank\": \"nisi in\",\n \"verification_dnb\": \"labore dolor tempor Ut incididunt\",\n \"verification_vies\": \"consequat laborum\",\n \"verification_bank\": \"quis Ut\",\n \"dnb_verification_paid\": true,\n \"last_approved_details_change_request_date\": \"pariatur adipisicing laborum velit\",\n \"fiata_efbl_enabled\": true,\n \"fiata_carrier_id\": \"dolore\",\n \"additional_vats\": [\n {\n \"country\": \"MX\",\n \"id\": \"6454b14b-eb88-043a-8196-a8052efaca16\",\n \"company_id\": \"non ad consectetur mollit\",\n \"vat_number\": \"proident incididunt ea\",\n \"country_name\": \"adipisicing est aliquip consequat\",\n \"vies_verification\": {\n \"type\": \"vies\",\n \"status\": \"verified\",\n \"verified\": \"1999-04-11T11:14:33.562Z\",\n \"failure_reason\": \"mollit aliquip es\",\n \"processed\": \"2016-04-26T00:29:11.498Z\"\n },\n \"verified_vies\": \"ea pariatur adipisicing Ut tempor\"\n },\n {\n \"country\": \"DO\",\n \"id\": \"38eddfef-cb4f-95cb-7e5e-18356d0dd86e\",\n \"company_id\": \"magna ipsum adipisicing cillum\",\n \"vat_number\": \"tempor Duis\",\n \"country_name\": \"ipsum pariatur occaecat\",\n \"vies_verification\": {\n \"type\": \"bank\",\n \"status\": \"pending_review\",\n \"verified\": \"1996-10-18T09:54:06.242Z\",\n \"failure_reason\": \"quis proident id aliquip ei\",\n \"processed\": \"1979-09-27T18:42:04.371Z\"\n },\n \"verified_vies\": \"laboru\"\n }\n ],\n \"created\": \"1995-06-30T05:08:11.411Z\",\n \"wants_invoices_instead_of_proforma\": false,\n \"id\": \"d81a853d-86be-4744-722c-a04bbdb72e79\"\n}" } ] }, { "name": "Partially update company", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"adipisicing nostrud\",\n \"address\": \"dolor deserunt labore inci\",\n \"postal_code\": \"occaecat Ut est commodo\",\n \"city\": \"cupidatat do est\",\n \"branch\": \"reprehenderit\",\n \"address2\": \"deserunt\",\n \"name_latin\": \"deserunt ad veniam non\",\n \"address_latin\": \"ullamco\",\n \"postal_code_latin\": \"laboris sunt dolor aute do\",\n \"city_latin\": \"ex minim elit Duis\",\n \"country\": \"AU\",\n \"billing_attn_to\": \"velit labore esse\",\n \"billing_email\": \"ol8a3@aWw.nq\",\n \"telephone\": \"dolor ad irure\",\n \"website\": \"elit occaecat do fugiat\",\n \"email\": \"7bMkUgWwgkk-Nf@nIzXEOECuaAXPCXxozDaLFz.veup\",\n \"registration_number\": \"voluptate dolor in\",\n \"duns_number\": \"eiusmod\",\n \"eori_number\": \"laboris veniam sint consectetur\",\n \"lei_number\": \"occaecat labore est\",\n \"vat_number\": \"non\",\n \"subscription\": {\n \"subscription_tier\": {\n \"name\": \"sed anim ut fugiat\",\n \"monthly_price\": \"aliquip ipsum reprehenderit adipisicing consectetur\",\n \"yearly_price\": \"ea reprehenderit quis aliqua\",\n \"additional_credits_per_month\": -4042505544361328600,\n \"non_blockchain_transfer_limit\": 1404767486,\n \"contacts_limit\": 52027954,\n \"users_limit\": -1342984806,\n \"rules_limit\": -1942772934,\n \"connected_apps_limit\": -671037901,\n \"attachments_per_envelope_limit\": 395578582,\n \"attachments_size_per_envelope_limit\": -1380732928,\n \"relayer_speed\": \"normal\",\n \"pdf_audit_log_enabled\": false\n },\n \"number_of_licences\": -1942100196,\n \"valid_until\": \"1995-01-30T12:12:23.690Z\"\n },\n \"fiata_efbl_enabled\": true,\n \"fiata_carrier_id\": \"Ut aliqua\",\n \"created\": \"2012-08-25T09:36:35.198Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] }, "description": "Partially updates the company. Only the data that needs to be changed is required.\n Company ethereum address cannot be changed." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"dolor deserunt\",\n \"address\": \"ut reprehenderit\",\n \"postal_code\": \"deserunt inci\",\n \"city\": \"dolore culpa incididunt\",\n \"branch\": \"ea ex proident dolor\",\n \"address2\": \"eu incididunt\",\n \"name_latin\": \"qui laborum veniam\",\n \"address_latin\": \"ea enim amet\",\n \"postal_code_latin\": \"non dolor veniam elit incididunt\",\n \"city_latin\": \"Excepteur voluptate\",\n \"country\": \"CV\",\n \"country_name\": \"aliquip mollit pariatur\",\n \"billing_attn_to\": \"do est exercitation eu\",\n \"billing_email\": \"nc7CHPRsB@BZGgsNzCMTvOwpKxLcBh.wf\",\n \"telephone\": \"dolor Excepteur non\",\n \"website\": \"ea quis aliqua\",\n \"email\": \"Pm0FAMjVK@FfQtMce.cyf\",\n \"registration_number\": \"tempor non commodo\",\n \"duns_number\": \"aute adipisicing sed cupidatat\",\n \"eori_number\": \"minim sint cillum\",\n \"lei_number\": \"minim\",\n \"vat_number\": \"enim officia ipsum quis ut\",\n \"vat_rate\": \"enim ipsum in \",\n \"country_vat_rate\": \"velit elit\",\n \"is_eu_company\": \"labore cupidatat commodo\",\n \"is_eu_vat_company\": \"in incididunt voluptate occaecat minim\",\n \"logo\": \"http://kbLaCOOUGo.duPP92uuekDeAkFn\",\n \"logo_name\": \"consequat anim ea minim\",\n \"inboxes\": [\n {\n \"name\": \"voluptate ea\",\n \"company_id\": \"id dolore\",\n \"ethereum_address\": \"0xE1CDfb4afd31Cccc42EC8920b7e60eb7c8D9B49D\",\n \"id\": \"c8553070-48ea-eef2-81b7-319cf8ad3a7a\"\n },\n {\n \"name\": \"est voluptate dolore elit\",\n \"company_id\": \"aute enim eiusmod\",\n \"ethereum_address\": \"0x6ecCa0E0Acb8Ca0EDc8ba1d364eE20B2B52dc53c\",\n \"id\": \"74dccc59-4193-5294-9a96-d5eb48e00e5f\"\n }\n ],\n \"default_inbox_id\": \"incididunt exercitation aliqua\",\n \"latest_terms_accepted\": \"sed dolor\",\n \"ethereum_address\": \"sit\",\n \"is_affiliate_partner\": false,\n \"affiliate_id\": \"reprehenderit irure quis eiusmod\",\n \"subscription\": {\n \"subscription_tier\": {\n \"name\": \"pariatur sit commodo ipsum dolore\",\n \"monthly_price\": \"incididunt aliqua proident\",\n \"yearly_price\": \"consectetur est dolore\",\n \"additional_credits_per_month\": 1539803697840337000,\n \"non_blockchain_transfer_limit\": -963505305,\n \"contacts_limit\": 826134861,\n \"users_limit\": -1640928108,\n \"rules_limit\": -338017958,\n \"connected_apps_limit\": 238852463,\n \"attachments_per_envelope_limit\": 816129983,\n \"attachments_size_per_envelope_limit\": 919115867,\n \"relayer_speed\": \"normal\",\n \"pdf_audit_log_enabled\": true\n },\n \"number_of_licences\": -463614727,\n \"valid_until\": \"2005-02-05T03:03:04.470Z\"\n },\n \"pending_subscription_renewal\": \"ut mollit ullamco\",\n \"number_of_non_blockchain_transactions_last_month\": \"cillum cupidatat est\",\n \"pending_company_details_change_request\": \"Duis occaecat\",\n \"verified_dnb\": \"ex incididunt proident voluptate occaecat\",\n \"verified_vies\": \"deserunt\",\n \"verified_bank\": \"nisi in\",\n \"verification_dnb\": \"labore dolor tempor Ut incididunt\",\n \"verification_vies\": \"consequat laborum\",\n \"verification_bank\": \"quis Ut\",\n \"dnb_verification_paid\": true,\n \"last_approved_details_change_request_date\": \"pariatur adipisicing laborum velit\",\n \"fiata_efbl_enabled\": true,\n \"fiata_carrier_id\": \"dolore\",\n \"additional_vats\": [\n {\n \"country\": \"MX\",\n \"id\": \"6454b14b-eb88-043a-8196-a8052efaca16\",\n \"company_id\": \"non ad consectetur mollit\",\n \"vat_number\": \"proident incididunt ea\",\n \"country_name\": \"adipisicing est aliquip consequat\",\n \"vies_verification\": {\n \"type\": \"vies\",\n \"status\": \"verified\",\n \"verified\": \"1999-04-11T11:14:33.562Z\",\n \"failure_reason\": \"mollit aliquip es\",\n \"processed\": \"2016-04-26T00:29:11.498Z\"\n },\n \"verified_vies\": \"ea pariatur adipisicing Ut tempor\"\n },\n {\n \"country\": \"DO\",\n \"id\": \"38eddfef-cb4f-95cb-7e5e-18356d0dd86e\",\n \"company_id\": \"magna ipsum adipisicing cillum\",\n \"vat_number\": \"tempor Duis\",\n \"country_name\": \"ipsum pariatur occaecat\",\n \"vies_verification\": {\n \"type\": \"bank\",\n \"status\": \"pending_review\",\n \"verified\": \"1996-10-18T09:54:06.242Z\",\n \"failure_reason\": \"quis proident id aliquip ei\",\n \"processed\": \"1979-09-27T18:42:04.371Z\"\n },\n \"verified_vies\": \"laboru\"\n }\n ],\n \"created\": \"1995-06-30T05:08:11.411Z\",\n \"wants_invoices_instead_of_proforma\": false,\n \"id\": \"d81a853d-86be-4744-722c-a04bbdb72e79\"\n}" } ] }, { "name": "Accept dApp terms and conditions", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"adipisicing nostrud\",\n \"address\": \"dolor deserunt labore inci\",\n \"postal_code\": \"occaecat Ut est commodo\",\n \"city\": \"cupidatat do est\",\n \"branch\": \"reprehenderit\",\n \"address2\": \"deserunt\",\n \"name_latin\": \"deserunt ad veniam non\",\n \"address_latin\": \"ullamco\",\n \"postal_code_latin\": \"laboris sunt dolor aute do\",\n \"city_latin\": \"ex minim elit Duis\",\n \"country\": \"AU\",\n \"billing_attn_to\": \"velit labore esse\",\n \"billing_email\": \"ol8a3@aWw.nq\",\n \"telephone\": \"dolor ad irure\",\n \"website\": \"elit occaecat do fugiat\",\n \"email\": \"7bMkUgWwgkk-Nf@nIzXEOECuaAXPCXxozDaLFz.veup\",\n \"registration_number\": \"voluptate dolor in\",\n \"duns_number\": \"eiusmod\",\n \"eori_number\": \"laboris veniam sint consectetur\",\n \"lei_number\": \"occaecat labore est\",\n \"vat_number\": \"non\",\n \"subscription\": {\n \"subscription_tier\": {\n \"name\": \"sed anim ut fugiat\",\n \"monthly_price\": \"aliquip ipsum reprehenderit adipisicing consectetur\",\n \"yearly_price\": \"ea reprehenderit quis aliqua\",\n \"additional_credits_per_month\": -4042505544361328600,\n \"non_blockchain_transfer_limit\": 1404767486,\n \"contacts_limit\": 52027954,\n \"users_limit\": -1342984806,\n \"rules_limit\": -1942772934,\n \"connected_apps_limit\": -671037901,\n \"attachments_per_envelope_limit\": 395578582,\n \"attachments_size_per_envelope_limit\": -1380732928,\n \"relayer_speed\": \"normal\",\n \"pdf_audit_log_enabled\": false\n },\n \"number_of_licences\": -1942100196,\n \"valid_until\": \"1995-01-30T12:12:23.690Z\"\n },\n \"fiata_efbl_enabled\": true,\n \"fiata_carrier_id\": \"Ut aliqua\",\n \"created\": \"2012-08-25T09:36:35.198Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/accept-terms-and-conditions/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "accept-terms-and-conditions", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "\nThis endpoint is used for accepting CargoX terms and conditions.\n" }, "response": [ { "name": "Successful acceptance of CargoX terms and conditions.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/accept-terms-and-conditions/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "accept-terms-and-conditions", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when user performing request has insufficient permissions or if user has no company.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/accept-terms-and-conditions/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "accept-terms-and-conditions", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when CargoX terms and conditions are not found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/accept-terms-and-conditions/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "accept-terms-and-conditions", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "companies generate aci filings history report", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"adipisicing nostrud\",\n \"address\": \"dolor deserunt labore inci\",\n \"postal_code\": \"occaecat Ut est commodo\",\n \"city\": \"cupidatat do est\",\n \"branch\": \"reprehenderit\",\n \"address2\": \"deserunt\",\n \"name_latin\": \"deserunt ad veniam non\",\n \"address_latin\": \"ullamco\",\n \"postal_code_latin\": \"laboris sunt dolor aute do\",\n \"city_latin\": \"ex minim elit Duis\",\n \"country\": \"AU\",\n \"billing_attn_to\": \"velit labore esse\",\n \"billing_email\": \"ol8a3@aWw.nq\",\n \"telephone\": \"dolor ad irure\",\n \"website\": \"elit occaecat do fugiat\",\n \"email\": \"7bMkUgWwgkk-Nf@nIzXEOECuaAXPCXxozDaLFz.veup\",\n \"registration_number\": \"voluptate dolor in\",\n \"duns_number\": \"eiusmod\",\n \"eori_number\": \"laboris veniam sint consectetur\",\n \"lei_number\": \"occaecat labore est\",\n \"vat_number\": \"non\",\n \"subscription\": {\n \"subscription_tier\": {\n \"name\": \"sed anim ut fugiat\",\n \"monthly_price\": \"aliquip ipsum reprehenderit adipisicing consectetur\",\n \"yearly_price\": \"ea reprehenderit quis aliqua\",\n \"additional_credits_per_month\": -4042505544361328600,\n \"non_blockchain_transfer_limit\": 1404767486,\n \"contacts_limit\": 52027954,\n \"users_limit\": -1342984806,\n \"rules_limit\": -1942772934,\n \"connected_apps_limit\": -671037901,\n \"attachments_per_envelope_limit\": 395578582,\n \"attachments_size_per_envelope_limit\": -1380732928,\n \"relayer_speed\": \"normal\",\n \"pdf_audit_log_enabled\": false\n },\n \"number_of_licences\": -1942100196,\n \"valid_until\": \"1995-01-30T12:12:23.690Z\"\n },\n \"fiata_efbl_enabled\": true,\n \"fiata_carrier_id\": \"Ut aliqua\",\n \"created\": \"2012-08-25T09:36:35.198Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/aci-filings-history-generate-report/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "aci-filings-history-generate-report", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/aci-filings-history-generate-report/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "aci-filings-history-generate-report", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"dolor deserunt\",\n \"address\": \"ut reprehenderit\",\n \"postal_code\": \"deserunt inci\",\n \"city\": \"dolore culpa incididunt\",\n \"branch\": \"ea ex proident dolor\",\n \"address2\": \"eu incididunt\",\n \"name_latin\": \"qui laborum veniam\",\n \"address_latin\": \"ea enim amet\",\n \"postal_code_latin\": \"non dolor veniam elit incididunt\",\n \"city_latin\": \"Excepteur voluptate\",\n \"country\": \"CV\",\n \"country_name\": \"aliquip mollit pariatur\",\n \"billing_attn_to\": \"do est exercitation eu\",\n \"billing_email\": \"nc7CHPRsB@BZGgsNzCMTvOwpKxLcBh.wf\",\n \"telephone\": \"dolor Excepteur non\",\n \"website\": \"ea quis aliqua\",\n \"email\": \"Pm0FAMjVK@FfQtMce.cyf\",\n \"registration_number\": \"tempor non commodo\",\n \"duns_number\": \"aute adipisicing sed cupidatat\",\n \"eori_number\": \"minim sint cillum\",\n \"lei_number\": \"minim\",\n \"vat_number\": \"enim officia ipsum quis ut\",\n \"vat_rate\": \"enim ipsum in \",\n \"country_vat_rate\": \"velit elit\",\n \"is_eu_company\": \"labore cupidatat commodo\",\n \"is_eu_vat_company\": \"in incididunt voluptate occaecat minim\",\n \"logo\": \"http://kbLaCOOUGo.duPP92uuekDeAkFn\",\n \"logo_name\": \"consequat anim ea minim\",\n \"inboxes\": [\n {\n \"name\": \"voluptate ea\",\n \"company_id\": \"id dolore\",\n \"ethereum_address\": \"0xE1CDfb4afd31Cccc42EC8920b7e60eb7c8D9B49D\",\n \"id\": \"c8553070-48ea-eef2-81b7-319cf8ad3a7a\"\n },\n {\n \"name\": \"est voluptate dolore elit\",\n \"company_id\": \"aute enim eiusmod\",\n \"ethereum_address\": \"0x6ecCa0E0Acb8Ca0EDc8ba1d364eE20B2B52dc53c\",\n \"id\": \"74dccc59-4193-5294-9a96-d5eb48e00e5f\"\n }\n ],\n \"default_inbox_id\": \"incididunt exercitation aliqua\",\n \"latest_terms_accepted\": \"sed dolor\",\n \"ethereum_address\": \"sit\",\n \"is_affiliate_partner\": false,\n \"affiliate_id\": \"reprehenderit irure quis eiusmod\",\n \"subscription\": {\n \"subscription_tier\": {\n \"name\": \"pariatur sit commodo ipsum dolore\",\n \"monthly_price\": \"incididunt aliqua proident\",\n \"yearly_price\": \"consectetur est dolore\",\n \"additional_credits_per_month\": 1539803697840337000,\n \"non_blockchain_transfer_limit\": -963505305,\n \"contacts_limit\": 826134861,\n \"users_limit\": -1640928108,\n \"rules_limit\": -338017958,\n \"connected_apps_limit\": 238852463,\n \"attachments_per_envelope_limit\": 816129983,\n \"attachments_size_per_envelope_limit\": 919115867,\n \"relayer_speed\": \"normal\",\n \"pdf_audit_log_enabled\": true\n },\n \"number_of_licences\": -463614727,\n \"valid_until\": \"2005-02-05T03:03:04.470Z\"\n },\n \"pending_subscription_renewal\": \"ut mollit ullamco\",\n \"number_of_non_blockchain_transactions_last_month\": \"cillum cupidatat est\",\n \"pending_company_details_change_request\": \"Duis occaecat\",\n \"verified_dnb\": \"ex incididunt proident voluptate occaecat\",\n \"verified_vies\": \"deserunt\",\n \"verified_bank\": \"nisi in\",\n \"verification_dnb\": \"labore dolor tempor Ut incididunt\",\n \"verification_vies\": \"consequat laborum\",\n \"verification_bank\": \"quis Ut\",\n \"dnb_verification_paid\": true,\n \"last_approved_details_change_request_date\": \"pariatur adipisicing laborum velit\",\n \"fiata_efbl_enabled\": true,\n \"fiata_carrier_id\": \"dolore\",\n \"additional_vats\": [\n {\n \"country\": \"MX\",\n \"id\": \"6454b14b-eb88-043a-8196-a8052efaca16\",\n \"company_id\": \"non ad consectetur mollit\",\n \"vat_number\": \"proident incididunt ea\",\n \"country_name\": \"adipisicing est aliquip consequat\",\n \"vies_verification\": {\n \"type\": \"vies\",\n \"status\": \"verified\",\n \"verified\": \"1999-04-11T11:14:33.562Z\",\n \"failure_reason\": \"mollit aliquip es\",\n \"processed\": \"2016-04-26T00:29:11.498Z\"\n },\n \"verified_vies\": \"ea pariatur adipisicing Ut tempor\"\n },\n {\n \"country\": \"DO\",\n \"id\": \"38eddfef-cb4f-95cb-7e5e-18356d0dd86e\",\n \"company_id\": \"magna ipsum adipisicing cillum\",\n \"vat_number\": \"tempor Duis\",\n \"country_name\": \"ipsum pariatur occaecat\",\n \"vies_verification\": {\n \"type\": \"bank\",\n \"status\": \"pending_review\",\n \"verified\": \"1996-10-18T09:54:06.242Z\",\n \"failure_reason\": \"quis proident id aliquip ei\",\n \"processed\": \"1979-09-27T18:42:04.371Z\"\n },\n \"verified_vies\": \"laboru\"\n }\n ],\n \"created\": \"1995-06-30T05:08:11.411Z\",\n \"wants_invoices_instead_of_proforma\": false,\n \"id\": \"d81a853d-86be-4744-722c-a04bbdb72e79\"\n}" } ] }, { "name": "Add user department", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"adipisicing nostrud\",\n \"address\": \"dolor deserunt labore inci\",\n \"postal_code\": \"occaecat Ut est commodo\",\n \"city\": \"cupidatat do est\",\n \"branch\": \"reprehenderit\",\n \"address2\": \"deserunt\",\n \"name_latin\": \"deserunt ad veniam non\",\n \"address_latin\": \"ullamco\",\n \"postal_code_latin\": \"laboris sunt dolor aute do\",\n \"city_latin\": \"ex minim elit Duis\",\n \"country\": \"AU\",\n \"billing_attn_to\": \"velit labore esse\",\n \"billing_email\": \"ol8a3@aWw.nq\",\n \"telephone\": \"dolor ad irure\",\n \"website\": \"elit occaecat do fugiat\",\n \"email\": \"7bMkUgWwgkk-Nf@nIzXEOECuaAXPCXxozDaLFz.veup\",\n \"registration_number\": \"voluptate dolor in\",\n \"duns_number\": \"eiusmod\",\n \"eori_number\": \"laboris veniam sint consectetur\",\n \"lei_number\": \"occaecat labore est\",\n \"vat_number\": \"non\",\n \"subscription\": {\n \"subscription_tier\": {\n \"name\": \"sed anim ut fugiat\",\n \"monthly_price\": \"aliquip ipsum reprehenderit adipisicing consectetur\",\n \"yearly_price\": \"ea reprehenderit quis aliqua\",\n \"additional_credits_per_month\": -4042505544361328600,\n \"non_blockchain_transfer_limit\": 1404767486,\n \"contacts_limit\": 52027954,\n \"users_limit\": -1342984806,\n \"rules_limit\": -1942772934,\n \"connected_apps_limit\": -671037901,\n \"attachments_per_envelope_limit\": 395578582,\n \"attachments_size_per_envelope_limit\": -1380732928,\n \"relayer_speed\": \"normal\",\n \"pdf_audit_log_enabled\": false\n },\n \"number_of_licences\": -1942100196,\n \"valid_until\": \"1995-01-30T12:12:23.690Z\"\n },\n \"fiata_efbl_enabled\": true,\n \"fiata_carrier_id\": \"Ut aliqua\",\n \"created\": \"2012-08-25T09:36:35.198Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/add-department/?field_name=cons", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "add-department", ""], "query": [ { "key": "field_name", "value": "cons", "description": "(Required) \nThe name of the new department. \n" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "\nThis endpoint is used for creating a new user department. \n" }, "response": [ { "name": "Successfully added a new department.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/add-department/?field_name=cons", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "add-department", ""], "query": [ { "key": "field_name", "value": "cons" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when user performing request has insufficient permissions or if user has no company.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/add-department/?field_name=cons", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "add-department", ""], "query": [ { "key": "field_name", "value": "cons" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when a department with the name parameter is already in the database.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/add-department/?field_name=cons", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "add-department", ""], "query": [ { "key": "field_name", "value": "cons" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "code": 470, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Get company details field history", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/company-details-field-history/?field_name=cons", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "company-details-field-history", "" ], "query": [ { "key": "field_name", "value": "cons", "description": "(Required) \nThe field name for which to return history of changes.\n" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "This endpoint returns a list of changes for a specific company details field." }, "response": [ { "name": "Returned when verification is successfully initiated", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/company-details-field-history/?field_name=cons", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "company-details-field-history", "" ], "query": [ { "key": "field_name", "value": "cons" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when user performing request has insufficient permissions.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/company-details-field-history/?field_name=cons", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "company-details-field-history", "" ], "query": [ { "key": "field_name", "value": "cons" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/company-details-field-history/?field_name=cons", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "company-details-field-history", "" ], "query": [ { "key": "field_name", "value": "cons" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when type parameter is invalid.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/company-details-field-history/?field_name=cons", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "company-details-field-history", "" ], "query": [ { "key": "field_name", "value": "cons" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "code": 471, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when type parameter is missing.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/company-details-field-history/?field_name=cons", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "company-details-field-history", "" ], "query": [ { "key": "field_name", "value": "cons" } ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "code": 472, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Add FIATA eFBL attachment", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"adipisicing nostrud\",\n \"address\": \"dolor deserunt labore inci\",\n \"postal_code\": \"occaecat Ut est commodo\",\n \"city\": \"cupidatat do est\",\n \"branch\": \"reprehenderit\",\n \"address2\": \"deserunt\",\n \"name_latin\": \"deserunt ad veniam non\",\n \"address_latin\": \"ullamco\",\n \"postal_code_latin\": \"laboris sunt dolor aute do\",\n \"city_latin\": \"ex minim elit Duis\",\n \"country\": \"AU\",\n \"billing_attn_to\": \"velit labore esse\",\n \"billing_email\": \"ol8a3@aWw.nq\",\n \"telephone\": \"dolor ad irure\",\n \"website\": \"elit occaecat do fugiat\",\n \"email\": \"7bMkUgWwgkk-Nf@nIzXEOECuaAXPCXxozDaLFz.veup\",\n \"registration_number\": \"voluptate dolor in\",\n \"duns_number\": \"eiusmod\",\n \"eori_number\": \"laboris veniam sint consectetur\",\n \"lei_number\": \"occaecat labore est\",\n \"vat_number\": \"non\",\n \"subscription\": {\n \"subscription_tier\": {\n \"name\": \"sed anim ut fugiat\",\n \"monthly_price\": \"aliquip ipsum reprehenderit adipisicing consectetur\",\n \"yearly_price\": \"ea reprehenderit quis aliqua\",\n \"additional_credits_per_month\": -4042505544361328600,\n \"non_blockchain_transfer_limit\": 1404767486,\n \"contacts_limit\": 52027954,\n \"users_limit\": -1342984806,\n \"rules_limit\": -1942772934,\n \"connected_apps_limit\": -671037901,\n \"attachments_per_envelope_limit\": 395578582,\n \"attachments_size_per_envelope_limit\": -1380732928,\n \"relayer_speed\": \"normal\",\n \"pdf_audit_log_enabled\": false\n },\n \"number_of_licences\": -1942100196,\n \"valid_until\": \"1995-01-30T12:12:23.690Z\"\n },\n \"fiata_efbl_enabled\": true,\n \"fiata_carrier_id\": \"Ut aliqua\",\n \"created\": \"2012-08-25T09:36:35.198Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/create-fiata-efbl/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "create-fiata-efbl", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "\nThis endpoint is used to create FIATA eFBL attachments.\n" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/create-fiata-efbl/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "create-fiata-efbl", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"document_token_id\": \"inc\",\n \"id\": \"b6778ea1-fcfc-c831-f91d-31614c62f957\",\n \"envelope_id\": \"dolor laboris in\",\n \"document_token\": {\n \"id\": \"urn:uuid:2677cfde-a100-ec79-cb30-f7598d14887a\",\n \"storage_type\": \"esse in sit\",\n \"watermark_generated\": true,\n \"ipfs_document_group_id\": \"nulla\",\n \"ipfs_document_group\": \"urn:uuid:4c501522-750b-c98d-3289-a3d0bad5295a\",\n \"document_id\": \"amet veniam ea id sit\",\n \"document\": {\n \"document_type\": \"an\",\n \"create_on_blockchain_override\": true,\n \"id\": \"aace0ccc-e44d-772b-8275-c58b6f7de0f4\",\n \"current_owner_id\": \"occa\",\n \"current_owner\": {\n \"company\": {\n \"name\": \"dolore irure veniam quis\",\n \"address\": \"voluptate pariatur\",\n \"postal_code\": \"ea nisi laboris velit\",\n \"city\": \"commodo ut\",\n \"branch\": \"occaecat exercitation ea\",\n \"address2\": \"veniam ut\",\n \"country\": \"GT\",\n \"country_name\": \"ullamco veniam cupidatat\",\n \"website\": \"exercitation non Excepteur\",\n \"vat_number\": \"ut\",\n \"logo\": \"https://GS.kglbgP3Rx\",\n \"logo_name\": \"dolore enim\",\n \"created\": \"1971-12-06T08:07:08.006Z\",\n \"id\": \"98e8b6ba-3574-d3cf-47a5-551695a9603f\",\n \"verified_bank\": \"anim incididunt fugi\",\n \"verified_dnb\": \"adipisicing incididunt\"\n },\n \"name\": \"deserunt officia nulla ullamco occaecat\",\n \"ethereum_address\": \"0x62FB5c9EAACb9FbE65eaAce75Add1ff4cF7DdB91\"\n },\n \"uploaded_by_id\": \"Ut minim\",\n \"uploaded_by\": {\n \"email\": \"bFeqGhw@Dfro.tkp\",\n \"telephone\": \"dolor\",\n \"name\": \"in amet\",\n \"first_name\": \"dolor reprehenderit velit\",\n \"last_name\": \"qui\",\n \"company_id\": \"fugiat Duis aliqua dolore\",\n \"company\": {\n \"name\": \"et officia Lorem proident\",\n \"address\": \"dolor aute proident\",\n \"postal_code\": \"sed anim Lorem pariatur fugiat\",\n \"city\": \"sit ullamco tempor\",\n \"branch\": \"\",\n \"address2\": \"exercitation velit\",\n \"country\": \"CF\",\n \"country_name\": \"reprehen\",\n \"website\": \"tempor dolore\",\n \"vat_number\": \"velit minim laborum quis aliquip\",\n \"logo\": \"http://RcbjMZFV.wjdfZtenua7kfT3VY1SI2kNvkMox7MJRajKXE,CaawTFTKKxm7T2CPygQRmMYffq.zQt3KP7+GQXv\",\n \"logo_name\": \"sint cupidatat pariatur Ut\",\n \"created\": \"1961-09-02T06:23:56.459Z\",\n \"id\": \"urn:uuid:2e132fc6-2782-17de-a755-8c1c0f1e06b6\",\n \"verified_bank\": \"culpa minim deser\",\n \"verified_dnb\": \"deserunt\"\n },\n \"logo\": \"http://MjTIvZQCcqYmcujb.zyXHwMRAYk\",\n \"logo_name\": \"eiusmod minim enim incididunt\",\n \"id\": \"urn:uuid:e953aa6e-3755-e907-d8c6-bee4c956de3a\"\n },\n \"uploaded_by_company_id\": \"Duis magna in\",\n \"uploaded_by_company\": {\n \"name\": \"laboris\",\n \"address\": \"officia e\",\n \"postal_code\": \"Duis elit ut\",\n \"city\": \"do est in cons\",\n \"branch\": \"incididunt labore adipisicing dolore\",\n \"address2\": \"in Lorem non consectetur\",\n \"country\": \"NG\",\n \"country_name\": \"eiusmod sunt reprehenderit culpa\",\n \"website\": \"amet proident\",\n \"vat_number\": \"anim magna\",\n \"logo\": \"http://Vb.paxCZ+KeuVZumFyos0tDtvmNw-rFEuowm7HrHy13XflectyvpE+lQskNKh4w\",\n \"logo_name\": \"sunt mollit\",\n \"created\": \"2011-08-09T16:26:20.557Z\",\n \"id\": \"d39e9a7d-422b-659b-88b4-402ad6349631\",\n \"verified_bank\": \"sint esse\",\n \"verified_dnb\": \"ex sint elit e\"\n },\n \"type\": {\n \"id\": \"consectetur velit nis\",\n \"name\": \"do\",\n \"short_name\": \"culpa sit cupidatat ea consectetur\",\n \"color\": 845267,\n \"is_smart_bl\": false,\n \"blockchain_support\": \"proident labore eu\",\n \"create_on_blockchain\": false,\n \"transfer_on_blockchain\": false,\n \"document_id_required\": false,\n \"document_id_title\": \"sunt dolor in tempor\",\n \"document_id_description\": \"\",\n \"accomplisher_required\": false,\n \"accomplisher_selectable\": false,\n \"accomplisher_title\": \"commodo dolore proident cupidatat magna\",\n \"accomplisher_description\": \"\",\n \"accomplish_action_string\": \"in Excepteur\",\n \"accomplish_review_step_title\": \"\",\n \"accomplish_review_step_text\": \"\",\n \"accomplish_sign_step_title\": \"\",\n \"accomplish_sign_step_text\": \"\",\n \"accomplish_sign_step_button\": \"\",\n \"accomplish_sign_in_progress_title\": \"\",\n \"accomplish_sign_in_progress_content\": \"\",\n \"accomplish_sign_success_message_title\": \"\",\n \"accomplish_sign_success_message_text\": \"\",\n \"accomplish_sign_error_message_title\": \"\",\n \"accomplish_sign_error_message_text\": \"\",\n \"accomplish_notify_email_document_state\": \"\",\n \"accomplish_notify_email_subject_action\": \"\",\n \"issue_price_millicents\": -22471889,\n \"blockchain_transfer_limit\": -52921482,\n \"retention_period\": \"eu dolor\"\n },\n \"document_id\": \"tempor dolor\",\n \"create_on_blockchain\": false,\n \"accomplisher_id\": \"minim\",\n \"accomplisher\": {\n \"company\": {\n \"name\": \"Duis ullamco cillum ut\",\n \"address\": \"dolor Excepteur sunt\",\n \"postal_code\": \"dolor nisi cillum officia\",\n \"city\": \"Excepteur ut in nisi id\",\n \"branch\": \"irure adipisicing\",\n \"address2\": \"esse elit\",\n \"country\": \"LA\",\n \"country_name\": \"cillum\",\n \"website\": \"enim\",\n \"vat_number\": \"elit ea\",\n \"logo\": \"https://CVFFWmhsBBdDvgERwuSLHVSAditgmdEBX.odWLVUM8D7i9gu08Ld\",\n \"logo_name\": \"laboris amet in ut ut\",\n \"created\": \"1999-04-06T14:05:58.229Z\",\n \"id\": \"77066213-765d-d7a1-69de-3b9e0ea116a1\",\n \"verified_bank\": \"ex et\",\n \"verified_dnb\": \"ullamco qui Ut\"\n },\n \"name\": \"commodo Excepteur tempor laborum\",\n \"ethereum_address\": \"0xB235a4DDea74FcfDa9E9fDEe2fF4eAB2CA5Dfadf\"\n },\n \"accomplished\": \"1948-12-14T18:52:23.404Z\",\n \"accomplished_by_id\": \"deserunt dolore non sunt voluptate\",\n \"accomplished_by_company_id\": \"enim do\",\n \"destroyed\": \"1982-04-07T21:58:33.361Z\",\n \"destroyed_by_company_id\": \"enim et dolore commodo Ut\",\n \"notify_parties\": [\n \"tBS@gHZgKnfYQ.zzgj\",\n \"71g7E@SwLimBLNHpANZchksBUafrXZOLKlbolB.lxv\"\n ],\n \"meta_data\": {},\n \"display_name\": \"reprehenderit fugiat est tempor\",\n \"file_name\": \"in amet laborum\",\n \"file_size\": 1490238430,\n \"file_content_type\": \"anim in aute ullamco\",\n \"watermarkable\": true,\n \"icon\": \"anim\",\n \"file_type\": \"commodo Excepteur non culpa\",\n \"created\": \"dolore est reprehen\",\n \"thumbnail\": \"http://SXpphncdX.vkxmqurIZLZL0ZvISH2T4xIiZJGV1-xf9gtdJKR,8+Uxi\",\n \"thumbnail_mime_type\": \"Ut pariatur\"\n },\n \"attachment_count\": -48266375,\n \"is_on_blockchain\": false,\n \"can_be_destroyed\": \"aliquip ut elit\",\n \"can_be_accomplished\": \"dolore occaecat\",\n \"destroy_pending\": \"id in deserunt\",\n \"accomplish_pending\": \"aliquip culpa\",\n \"created\": \"cupidatat est\"\n },\n \"used_in_envelope_id\": \"occaecat velit\",\n \"used_in_envelope\": {\n \"id\": \"05a7f7db-6af4-6d77-eef4-7276c35c88af\",\n \"owner_id\": \"reprehenderit Ut ad irure aute\",\n \"recipient_id\": \"commodo in enim officia\",\n \"message\": \"exercitation nisi ad\",\n \"type\": \"officia consectetur Ut\",\n \"specialization_type\": \"standard\",\n \"created\": \"Ut\",\n \"sent\": \"1976-02-25T17:38:40.501Z\",\n \"archived\": \"1980-12-20T17:44:04.159Z\",\n \"delivered\": \"nisi commodo proident\",\n \"action_performed_by_id\": \"dolore dolor pariatur adipisicing\",\n \"sealed\": false,\n \"can_be_sealed\": \"qui anim magna adipisicing\",\n \"is_draft\": \"elit aute\",\n \"sender_inbox_id\": \"nulla id dolore\",\n \"delivered_envelope_opened\": true,\n \"delivery_status\": \"Lorem occaecat quis\",\n \"can_be_archived\": true,\n \"can_be_unarchived\": true,\n \"delivered_envelope_id\": \"d\",\n \"failed_delivery_envelope_id\": \"sunt mollit\",\n \"failed_outgoing_id\": \"cillum consequat anim nisi aliqua\",\n \"pay_to_collect\": true,\n \"pay_to_collect_response\": \"proident sed\",\n \"meta_data\": {}\n },\n \"can_be_forwarded\": false,\n \"created\": \"1973-02-03T19:42:43.169Z\"\n}" }, { "name": "Returned when the authenticated user is not a 3rd-party company.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/create-fiata-efbl/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "create-fiata-efbl", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "companies generate credits history report", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"adipisicing nostrud\",\n \"address\": \"dolor deserunt labore inci\",\n \"postal_code\": \"occaecat Ut est commodo\",\n \"city\": \"cupidatat do est\",\n \"branch\": \"reprehenderit\",\n \"address2\": \"deserunt\",\n \"name_latin\": \"deserunt ad veniam non\",\n \"address_latin\": \"ullamco\",\n \"postal_code_latin\": \"laboris sunt dolor aute do\",\n \"city_latin\": \"ex minim elit Duis\",\n \"country\": \"AU\",\n \"billing_attn_to\": \"velit labore esse\",\n \"billing_email\": \"ol8a3@aWw.nq\",\n \"telephone\": \"dolor ad irure\",\n \"website\": \"elit occaecat do fugiat\",\n \"email\": \"7bMkUgWwgkk-Nf@nIzXEOECuaAXPCXxozDaLFz.veup\",\n \"registration_number\": \"voluptate dolor in\",\n \"duns_number\": \"eiusmod\",\n \"eori_number\": \"laboris veniam sint consectetur\",\n \"lei_number\": \"occaecat labore est\",\n \"vat_number\": \"non\",\n \"subscription\": {\n \"subscription_tier\": {\n \"name\": \"sed anim ut fugiat\",\n \"monthly_price\": \"aliquip ipsum reprehenderit adipisicing consectetur\",\n \"yearly_price\": \"ea reprehenderit quis aliqua\",\n \"additional_credits_per_month\": -4042505544361328600,\n \"non_blockchain_transfer_limit\": 1404767486,\n \"contacts_limit\": 52027954,\n \"users_limit\": -1342984806,\n \"rules_limit\": -1942772934,\n \"connected_apps_limit\": -671037901,\n \"attachments_per_envelope_limit\": 395578582,\n \"attachments_size_per_envelope_limit\": -1380732928,\n \"relayer_speed\": \"normal\",\n \"pdf_audit_log_enabled\": false\n },\n \"number_of_licences\": -1942100196,\n \"valid_until\": \"1995-01-30T12:12:23.690Z\"\n },\n \"fiata_efbl_enabled\": true,\n \"fiata_carrier_id\": \"Ut aliqua\",\n \"created\": \"2012-08-25T09:36:35.198Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/credits-history-generate-report/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "credits-history-generate-report", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/credits-history-generate-report/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "credits-history-generate-report", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"dolor deserunt\",\n \"address\": \"ut reprehenderit\",\n \"postal_code\": \"deserunt inci\",\n \"city\": \"dolore culpa incididunt\",\n \"branch\": \"ea ex proident dolor\",\n \"address2\": \"eu incididunt\",\n \"name_latin\": \"qui laborum veniam\",\n \"address_latin\": \"ea enim amet\",\n \"postal_code_latin\": \"non dolor veniam elit incididunt\",\n \"city_latin\": \"Excepteur voluptate\",\n \"country\": \"CV\",\n \"country_name\": \"aliquip mollit pariatur\",\n \"billing_attn_to\": \"do est exercitation eu\",\n \"billing_email\": \"nc7CHPRsB@BZGgsNzCMTvOwpKxLcBh.wf\",\n \"telephone\": \"dolor Excepteur non\",\n \"website\": \"ea quis aliqua\",\n \"email\": \"Pm0FAMjVK@FfQtMce.cyf\",\n \"registration_number\": \"tempor non commodo\",\n \"duns_number\": \"aute adipisicing sed cupidatat\",\n \"eori_number\": \"minim sint cillum\",\n \"lei_number\": \"minim\",\n \"vat_number\": \"enim officia ipsum quis ut\",\n \"vat_rate\": \"enim ipsum in \",\n \"country_vat_rate\": \"velit elit\",\n \"is_eu_company\": \"labore cupidatat commodo\",\n \"is_eu_vat_company\": \"in incididunt voluptate occaecat minim\",\n \"logo\": \"http://kbLaCOOUGo.duPP92uuekDeAkFn\",\n \"logo_name\": \"consequat anim ea minim\",\n \"inboxes\": [\n {\n \"name\": \"voluptate ea\",\n \"company_id\": \"id dolore\",\n \"ethereum_address\": \"0xE1CDfb4afd31Cccc42EC8920b7e60eb7c8D9B49D\",\n \"id\": \"c8553070-48ea-eef2-81b7-319cf8ad3a7a\"\n },\n {\n \"name\": \"est voluptate dolore elit\",\n \"company_id\": \"aute enim eiusmod\",\n \"ethereum_address\": \"0x6ecCa0E0Acb8Ca0EDc8ba1d364eE20B2B52dc53c\",\n \"id\": \"74dccc59-4193-5294-9a96-d5eb48e00e5f\"\n }\n ],\n \"default_inbox_id\": \"incididunt exercitation aliqua\",\n \"latest_terms_accepted\": \"sed dolor\",\n \"ethereum_address\": \"sit\",\n \"is_affiliate_partner\": false,\n \"affiliate_id\": \"reprehenderit irure quis eiusmod\",\n \"subscription\": {\n \"subscription_tier\": {\n \"name\": \"pariatur sit commodo ipsum dolore\",\n \"monthly_price\": \"incididunt aliqua proident\",\n \"yearly_price\": \"consectetur est dolore\",\n \"additional_credits_per_month\": 1539803697840337000,\n \"non_blockchain_transfer_limit\": -963505305,\n \"contacts_limit\": 826134861,\n \"users_limit\": -1640928108,\n \"rules_limit\": -338017958,\n \"connected_apps_limit\": 238852463,\n \"attachments_per_envelope_limit\": 816129983,\n \"attachments_size_per_envelope_limit\": 919115867,\n \"relayer_speed\": \"normal\",\n \"pdf_audit_log_enabled\": true\n },\n \"number_of_licences\": -463614727,\n \"valid_until\": \"2005-02-05T03:03:04.470Z\"\n },\n \"pending_subscription_renewal\": \"ut mollit ullamco\",\n \"number_of_non_blockchain_transactions_last_month\": \"cillum cupidatat est\",\n \"pending_company_details_change_request\": \"Duis occaecat\",\n \"verified_dnb\": \"ex incididunt proident voluptate occaecat\",\n \"verified_vies\": \"deserunt\",\n \"verified_bank\": \"nisi in\",\n \"verification_dnb\": \"labore dolor tempor Ut incididunt\",\n \"verification_vies\": \"consequat laborum\",\n \"verification_bank\": \"quis Ut\",\n \"dnb_verification_paid\": true,\n \"last_approved_details_change_request_date\": \"pariatur adipisicing laborum velit\",\n \"fiata_efbl_enabled\": true,\n \"fiata_carrier_id\": \"dolore\",\n \"additional_vats\": [\n {\n \"country\": \"MX\",\n \"id\": \"6454b14b-eb88-043a-8196-a8052efaca16\",\n \"company_id\": \"non ad consectetur mollit\",\n \"vat_number\": \"proident incididunt ea\",\n \"country_name\": \"adipisicing est aliquip consequat\",\n \"vies_verification\": {\n \"type\": \"vies\",\n \"status\": \"verified\",\n \"verified\": \"1999-04-11T11:14:33.562Z\",\n \"failure_reason\": \"mollit aliquip es\",\n \"processed\": \"2016-04-26T00:29:11.498Z\"\n },\n \"verified_vies\": \"ea pariatur adipisicing Ut tempor\"\n },\n {\n \"country\": \"DO\",\n \"id\": \"38eddfef-cb4f-95cb-7e5e-18356d0dd86e\",\n \"company_id\": \"magna ipsum adipisicing cillum\",\n \"vat_number\": \"tempor Duis\",\n \"country_name\": \"ipsum pariatur occaecat\",\n \"vies_verification\": {\n \"type\": \"bank\",\n \"status\": \"pending_review\",\n \"verified\": \"1996-10-18T09:54:06.242Z\",\n \"failure_reason\": \"quis proident id aliquip ei\",\n \"processed\": \"1979-09-27T18:42:04.371Z\"\n },\n \"verified_vies\": \"laboru\"\n }\n ],\n \"created\": \"1995-06-30T05:08:11.411Z\",\n \"wants_invoices_instead_of_proforma\": false,\n \"id\": \"d81a853d-86be-4744-722c-a04bbdb72e79\"\n}" } ] }, { "name": "Get credits transactions history", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/credits-history/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "credits-history", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "Returns a list of all credits transactions for a particular company." }, "response": [ { "name": "List of credits transactions for a particular company.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/credits-history/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "credits-history", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"sed\",\n \"title\": \"et ma\",\n \"type_id\": \"officia deserunt sit id magna\",\n \"value\": -96268751,\n \"created\": \"1971-08-10T03:57:22.436Z\",\n \"valid_until\": \"1958-05-07T04:43:32.029Z\",\n \"is_spend\": true,\n \"is_promotional\": true,\n \"regular_balance_before\": 47989671,\n \"promotional_balance_before\": 22939095,\n \"regular_balance_after\": 31744960,\n \"promotional_balance_after\": 27591841,\n \"spend_reason\": \"nulla cupidatat\",\n \"user_id\": \"veniam labore nostrud Excepteur\",\n \"department_id\": \"commodo aliqua \",\n \"company_id\": \"culpa sit commodo anim\"\n}" }, { "name": "Returned when user performing request has insufficient permissions or if user has no company.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/credits-history/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "credits-history", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned if company not found or client has no access to this company", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/credits-history/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "credits-history", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "companies details-change create", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"pariatur Duis\",\n \"branch\": \"magna commodo proident occaecat\",\n \"address\": \"consectetur\",\n \"address2\": \"sint\",\n \"postal_code\": \"adipisicing officia reprehenderit\",\n \"city\": \"eiusmod incididunt\",\n \"name_latin\": \"eiusmod qui cupidatat\",\n \"address_latin\": \"minim nostrud esse\",\n \"postal_code_latin\": \"fugiat reprehenderit Ut\",\n \"city_latin\": \"occaecat\",\n \"country\": \"MC\",\n \"telephone\": \"veniam\",\n \"website\": \"aliqua proident ullamco occaecat\",\n \"registration_number\": \"eiusm\",\n \"duns_number\": \"laborum fugiat minim anim\",\n \"eori_number\": \"dolore reprehenderit tempor\",\n \"lei_number\": \"commodo et\",\n \"vat_number\": \"consequat adipisicing sunt\",\n \"created_by\": {\n \"email\": \"7wtJ1p2ad0GL0@lvnouXeAJZnh.dikt\",\n \"telephone\": \"voluptate pariatur magna si\",\n \"name\": \"s\",\n \"first_name\": \"consectetur ea laboris\",\n \"last_name\": \"velit culpa ad\",\n \"company_id\": \"consequat laborum enim Duis labore\",\n \"company\": {\n \"name\": \"nisi aute\",\n \"address\": \"irure sint id esse in\",\n \"postal_code\": \"dolore reprehenderit\",\n \"city\": \"nulla magna sit id\",\n \"branch\": \"veniam do\",\n \"address2\": \"id deserunt\",\n \"country\": \"CC\",\n \"country_name\": \"Excepteur enim\",\n \"website\": \"elit sed sunt nulla\",\n \"vat_number\": \"in\",\n \"logo\": \"https://piBPzopqWrfoIVwQrgstmVT.xnpwke,g1-v7gcCpa,aU9aT1H04eVGrsD.S4-cID\",\n \"logo_name\": \"ex tempor sed comm\",\n \"created\": \"1959-08-21T07:16:57.034Z\",\n \"id\": \"urn:uuid:61a90d62-e2d8-b76a-d7c3-b99a6fee2245\",\n \"verified_bank\": \"officia magna esse\",\n \"verified_dnb\": \"id\"\n },\n \"logo\": \"http://mnWEybUtNiTjH.fxnc+GDqdPBW\",\n \"logo_name\": \"nulla non\",\n \"id\": \"8bb18908-87bd-3ad3-7ba7-068b02f0250c\"\n },\n \"created\": \"1952-05-11T13:57:30.357Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/details-change/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "details-change", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"pariatur Duis\",\n \"branch\": \"magna commodo proident occaecat\",\n \"address\": \"consectetur\",\n \"address2\": \"sint\",\n \"postal_code\": \"adipisicing officia reprehenderit\",\n \"city\": \"eiusmod incididunt\",\n \"name_latin\": \"eiusmod qui cupidatat\",\n \"address_latin\": \"minim nostrud esse\",\n \"postal_code_latin\": \"fugiat reprehenderit Ut\",\n \"city_latin\": \"occaecat\",\n \"country\": \"MC\",\n \"telephone\": \"veniam\",\n \"website\": \"aliqua proident ullamco occaecat\",\n \"registration_number\": \"eiusm\",\n \"duns_number\": \"laborum fugiat minim anim\",\n \"eori_number\": \"dolore reprehenderit tempor\",\n \"lei_number\": \"commodo et\",\n \"vat_number\": \"consequat adipisicing sunt\",\n \"created_by\": {\n \"email\": \"7wtJ1p2ad0GL0@lvnouXeAJZnh.dikt\",\n \"telephone\": \"voluptate pariatur magna si\",\n \"name\": \"s\",\n \"first_name\": \"consectetur ea laboris\",\n \"last_name\": \"velit culpa ad\",\n \"company_id\": \"consequat laborum enim Duis labore\",\n \"company\": {\n \"name\": \"nisi aute\",\n \"address\": \"irure sint id esse in\",\n \"postal_code\": \"dolore reprehenderit\",\n \"city\": \"nulla magna sit id\",\n \"branch\": \"veniam do\",\n \"address2\": \"id deserunt\",\n \"country\": \"CC\",\n \"country_name\": \"Excepteur enim\",\n \"website\": \"elit sed sunt nulla\",\n \"vat_number\": \"in\",\n \"logo\": \"https://piBPzopqWrfoIVwQrgstmVT.xnpwke,g1-v7gcCpa,aU9aT1H04eVGrsD.S4-cID\",\n \"logo_name\": \"ex tempor sed comm\",\n \"created\": \"1959-08-21T07:16:57.034Z\",\n \"id\": \"urn:uuid:61a90d62-e2d8-b76a-d7c3-b99a6fee2245\",\n \"verified_bank\": \"officia magna esse\",\n \"verified_dnb\": \"id\"\n },\n \"logo\": \"http://mnWEybUtNiTjH.fxnc+GDqdPBW\",\n \"logo_name\": \"nulla non\",\n \"id\": \"8bb18908-87bd-3ad3-7ba7-068b02f0250c\"\n },\n \"created\": \"1952-05-11T13:57:30.357Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/details-change/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "details-change", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"non quis\",\n \"branch\": \"ea aliqua\",\n \"address\": \"qui Excepteur\",\n \"address2\": \"fugiat nisi consectetur nostrud dolor\",\n \"postal_code\": \"aute ullamco tempor nulla\",\n \"city\": \"deserunt adipisicing\",\n \"name_latin\": \"ad minim\",\n \"address_latin\": \"quis\",\n \"postal_code_latin\": \"dolor quis pariatur\",\n \"city_latin\": \"laborum occaecat irure consequat culpa\",\n \"country\": \"AI\",\n \"country_name\": \"tempor commodo\",\n \"telephone\": \"ad culpa deserunt Excepteur officia\",\n \"website\": \"non\",\n \"registration_number\": \"reprehenderit a\",\n \"duns_number\": \"nostrud ea Duis\",\n \"eori_number\": \"voluptate in commodo sit\",\n \"lei_number\": \"sint amet\",\n \"vat_number\": \"est\",\n \"logo\": \"https://wAfdpUhHzunwzSEbitbFJ.zzkHtyqjhBGvGOjD.FPdT3pQRZhJyqn+tT4QOXK6oDportBcyAVxiTzj+LwQuohL3gkmvnx,I.ysgMS\",\n \"logo_name\": \"quis Lorem irure eu\",\n \"created_by\": {\n \"email\": \"3T4KoPq0OA@ZJKXCKPUcvWGhSaJ.hma\",\n \"telephone\": \"deserunt non cupidatat dolore\",\n \"name\": \"quis dolore consectetur\",\n \"first_name\": \"in incididunt velit ipsum ullamco\",\n \"last_name\": \"culpa eiusmod reprehenderit proi\",\n \"company_id\": \"aute esse\",\n \"company\": {\n \"name\": \"minim Excepteur\",\n \"address\": \"minim amet aute sint\",\n \"postal_code\": \"ea cillum commodo\",\n \"city\": \"ex aliquip aute\",\n \"branch\": \"commodo officia adipisicing est\",\n \"address2\": \"dolore Ut mini\",\n \"country\": \"BT\",\n \"country_name\": \"velit dolor dolore\",\n \"website\": \"non \",\n \"vat_number\": \"id Ut est proident\",\n \"logo\": \"http://vlcuUlXf.aoahaNRwz+oq53+F2p,j9uaD.2d-,f4\",\n \"logo_name\": \"laboris deserunt sunt mollit\",\n \"created\": \"2001-08-17T02:43:49.363Z\",\n \"id\": \"c57d56d0-ce0f-37fc-d428-363f1bd25cb7\",\n \"verified_bank\": \"ea dolore\",\n \"verified_dnb\": \"ipsum reprehenderit\"\n },\n \"logo\": \"http://mF.xozzuIFvIXjy3uyMYs6XobejrHpWp2s3RqrNUH4yOTu-cJH6bpWfDl7HwEhM5viMFM8GsdL.\",\n \"logo_name\": \"labore\",\n \"id\": \"5c5fb438-b637-77fe-251d-1b66a5823b98\"\n },\n \"created\": \"1970-10-02T13:11:23.904Z\",\n \"id\": \"25da2750-ce07-6d49-104c-e48651afc436\",\n \"logo_removed\": true\n}" } ] }, { "name": "Referral summary", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/referrals/summary/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "referrals", "summary", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "\nThis endpoint returns referral summary data for a specific time period.\n" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/referrals/summary/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "referrals", "summary", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"aliqua magna ad Lorem\",\n \"document_id\": \"f064cf98-2afa-0cfa-7aa3-dbfc69ac77e1\",\n \"document\": {\n \"document_type\": \"dolor eiusmod nulla ipsum\",\n \"create_on_blockchain_override\": true,\n \"id\": \"urn:uuid:d081373b-c763-9b40-6d52-6597f99049e1\",\n \"current_owner_id\": \"officia in cupidatat\",\n \"current_owner\": {\n \"company\": {\n \"name\": \"veniam sint est exercitation nisi\",\n \"address\": \"laboris\",\n \"postal_code\": \"qui cupidatat anim ullamco ut\",\n \"city\": \"do sed voluptate\",\n \"branch\": \"sunt reprehe\",\n \"address2\": \"do quis ut\",\n \"country\": \"ZM\",\n \"country_name\": \"incididunt est ad irure in\",\n \"website\": \"aliquip qui in aute\",\n \"vat_number\": \"nulla minim\",\n \"logo\": \"http://vhXqamRbw.ncHTA68ApldJ9X91.9VcdwooEIj+jO-UD0jXzDVb7bGuk.6E4jFZoO+vxFZeV.u,b+G2kIKZzpZ\",\n \"logo_name\": \"aute\",\n \"created\": \"1967-06-22T14:55:41.911Z\",\n \"id\": \"urn:uuid:5428b523-e7a8-8f4d-f567-231547e7d38f\",\n \"verified_bank\": \"do\",\n \"verified_dnb\": \"sed sunt\"\n },\n \"name\": \"laborum aliquip cupidatat\",\n \"ethereum_address\": \"0xB014F7dd3be1E44Bfdab8D3FfEdbF4a7C63BE40F\"\n },\n \"uploaded_by_id\": \"labore\",\n \"uploaded_by\": {\n \"email\": \"hlY5l@gcTWXGyWQIrPP.nzl\",\n \"telephone\": \"non sit amet sunt fugiat\",\n \"name\": \"qui culpa elit amet\",\n \"first_name\": \"do esse sint Lorem\",\n \"last_name\": \"qui\",\n \"company_id\": \"dolor ad dolor\",\n \"company\": {\n \"name\": \"enim officia et\",\n \"address\": \"magna velit\",\n \"postal_code\": \"tempor sunt aute\",\n \"city\": \"non minim offi\",\n \"branch\": \"enim aliqua non\",\n \"address2\": \"irure\",\n \"country\": \"TF\",\n \"country_name\": \"qui anim\",\n \"website\": \"voluptate Lorem culpa\",\n \"vat_number\": \"in laboris dolor\",\n \"logo\": \"https://dHM.ozpczHVQGwIBgaNNhkOwdthg6CrlyFEAqlJ8c6+RADoqFTXtdMlOUUHQA\",\n \"logo_name\": \"sint nostrud Ut Lorem consequat\",\n \"created\": \"2011-12-19T21:51:44.746Z\",\n \"id\": \"urn:uuid:ac5fb204-afb5-0130-52d4-52f2b01b9c62\",\n \"verified_bank\": \"magna ex sint eiusmod\",\n \"verified_dnb\": \"amet \"\n },\n \"logo\": \"https://DBAziLfpfvfwQRTlJIsqqITx.raEe-e5O8Aj7\",\n \"logo_name\": \"dolore \",\n \"id\": \"urn:uuid:ad04ed72-14fb-0fa1-358a-944b8d12b6f0\"\n },\n \"uploaded_by_company_id\": \"cupidatat in est nostrud dolor\",\n \"uploaded_by_company\": {\n \"name\": \"sunt mollit\",\n \"address\": \"in irure\",\n \"postal_code\": \"aute tempor\",\n \"city\": \"aliquip anim Excepteur elit\",\n \"branch\": \"non irure ea tempor\",\n \"address2\": \"ut pariatur tempor eu\",\n \"country\": \"ZM\",\n \"country_name\": \"aliqua sed cupidatat mollit\",\n \"website\": \"aliquip et tempor reprehenderi\",\n \"vat_number\": \"in Lorem nulla et\",\n \"logo\": \"https://OzuZctsRHZCqCLRfqXLwJMni.kzDWUFUCo5OIhcZdFM5d8huWMKw0L9vsyOeCRKVRV3g.p7m2r-sS2JknUsu-\",\n \"logo_name\": \"aute mollit\",\n \"created\": \"1943-06-18T08:03:31.316Z\",\n \"id\": \"d0738567-a706-e174-b1e4-a6d79b8f590b\",\n \"verified_bank\": \"dolore culpa non proident\",\n \"verified_dnb\": \"elit ex occaecat irure esse\"\n },\n \"type\": {\n \"id\": \"cupidatat nostrud sint\",\n \"name\": \"reprehenderi\",\n \"short_name\": \"eiusmod sed\",\n \"color\": -30571843,\n \"is_smart_bl\": true,\n \"blockchain_support\": \"in tempor aliquip\",\n \"create_on_blockchain\": true,\n \"transfer_on_blockchain\": false,\n \"document_id_required\": false,\n \"document_id_title\": \"Excepteur culpa laboris\",\n \"document_id_description\": \"\",\n \"accomplisher_required\": false,\n \"accomplisher_selectable\": false,\n \"accomplisher_title\": \"ut paria\",\n \"accomplisher_description\": \"\",\n \"accomplish_action_string\": \"vol\",\n \"accomplish_review_step_title\": \"\",\n \"accomplish_review_step_text\": \"\",\n \"accomplish_sign_step_title\": \"\",\n \"accomplish_sign_step_text\": \"\",\n \"accomplish_sign_step_button\": \"\",\n \"accomplish_sign_in_progress_title\": \"\",\n \"accomplish_sign_in_progress_content\": \"\",\n \"accomplish_sign_success_message_title\": \"\",\n \"accomplish_sign_success_message_text\": \"\",\n \"accomplish_sign_error_message_title\": \"\",\n \"accomplish_sign_error_message_text\": \"\",\n \"accomplish_notify_email_document_state\": \"\",\n \"accomplish_notify_email_subject_action\": \"\",\n \"issue_price_millicents\": 45652263,\n \"blockchain_transfer_limit\": -22778531,\n \"retention_period\": \"dolor quis\"\n },\n \"document_id\": \"laboris fugiat\",\n \"create_on_blockchain\": false,\n \"accomplisher_id\": \"do\",\n \"accomplisher\": {\n \"company\": {\n \"name\": \"dolor sed voluptate\",\n \"address\": \"dolore ad magna deserunt pariatur\",\n \"postal_code\": \"consectetur sed\",\n \"city\": \"enim do occaecat\",\n \"branch\": \"aliquip cillum adipisicing reprehenderit in\",\n \"address2\": \"do veniam ul\",\n \"country\": \"RS\",\n \"country_name\": \"dolore\",\n \"website\": \"aliquip ullamco\",\n \"vat_number\": \"culpa reprehenderit dolore\",\n \"logo\": \"http://MeMnTHfUotLZiybEOlDyVdp.ccfr,vS2o4qmLUDQTB.3b\",\n \"logo_name\": \"voluptate irure exercitation\",\n \"created\": \"2010-01-14T23:27:49.098Z\",\n \"id\": \"f0dc16f5-8e00-7486-2a79-b2f523519099\",\n \"verified_bank\": \"aute\",\n \"verified_dnb\": \"veniam aute\"\n },\n \"name\": \"aliqua laborum\",\n \"ethereum_address\": \"0xE6AaebcdebbcB89fcAfe110899AB8fbBAA11A8fF\"\n },\n \"accomplished\": \"1978-10-03T22:39:45.621Z\",\n \"accomplished_by_id\": \"aliquip\",\n \"accomplished_by_company_id\": \"ex\",\n \"destroyed\": \"2000-04-03T16:23:11.905Z\",\n \"destroyed_by_company_id\": \"mollit veniam\",\n \"notify_parties\": [\n \"SFI8UGaUcCGiY9@iChEZGxXwRxrIARAF.es\",\n \"3m4@sjvzxWUehRmvTCOrqPfrTztwKPx.iae\"\n ],\n \"meta_data\": {},\n \"display_name\": \"ut irure aliquip\",\n \"file_name\": \"consequat proident\",\n \"file_size\": -1608794180,\n \"file_content_type\": \"in id ea velit deserunt\",\n \"watermarkable\": true,\n \"icon\": \"ve\",\n \"file_type\": \"sint aute culpa\",\n \"created\": \"proident officia\",\n \"thumbnail\": \"https://kCEBbObFlQAxNyROgALu.nsyceqMwDJvpbPIgNZYZl0E,1Ia\",\n \"thumbnail_mime_type\": \"officia ut veniam consequat\"\n },\n \"action\": \"elit laborum quis eu\",\n \"action_performed_by_id\": \"urn:uuid:682e2cd2-d33a-451e-95d7-7c76d2228e88\",\n \"action_performed_by\": {\n \"email\": \"W6QuLDyFNrku@eAXGDlvrrXcfSavveNhY.rxn\",\n \"telephone\": \"Excepteur laborum aliqua ut\",\n \"name\": \"velit in quis dolore\",\n \"first_name\": \"anim do ipsum sit\",\n \"last_name\": \"labore cupidatat\",\n \"company_id\": \"tempor adipisicing consequat\",\n \"company\": {\n \"name\": \"anim nisi magna proident velit\",\n \"address\": \"dolor officia consequat ex\",\n \"postal_code\": \"cillum Lorem elit\",\n \"city\": \"adipisicing veniam\",\n \"branch\": \"deserunt voluptate exercitation\",\n \"address2\": \"nisi minim\",\n \"country\": \"NR\",\n \"country_name\": \"magna deserunt laborum\",\n \"website\": \"proident esse dolor\",\n \"vat_number\": \"do voluptate consequat et\",\n \"logo\": \"http://UmTGJQAlfVJkmSPnif.wefwYfatK9mHEWpn-fp+Z+ClRaDH4.rdFyiW0Kp1uKaPtGWn.URC7bmEx-3QidU1W9kO\",\n \"logo_name\": \"nulla in irure\",\n \"created\": \"1990-09-17T20:12:12.721Z\",\n \"id\": \"urn:uuid:25cf0817-a514-8e73-12e6-2d2ce92e4123\",\n \"verified_bank\": \"occaecat nisi\",\n \"verified_dnb\": \"labore do enim Ut\"\n },\n \"logo\": \"http://YIsqbCiIXcoIHOXrSyQlEFbohV.ysjnYQAlp1GcFBbikOPS.,bu\",\n \"logo_name\": \"officia Lorem Excepteur anim\",\n \"id\": \"4e11b594-ee97-0800-5438-407492056ff5\"\n },\n \"action_performed_by_company_id\": \"urn:uuid:42222a6d-dea9-135d-33d1-3f008fa396cb\",\n \"action_performed_by_company\": {\n \"name\": \"id nostrud irure dolor\",\n \"address\": \"irure nostrud commodo\",\n \"postal_code\": \"anim qui dolor\",\n \"city\": \"veniam deserunt\",\n \"branch\": \"in minim elit cupidatat\",\n \"address2\": \"ex in\",\n \"country\": \"HU\",\n \"country_name\": \"qui ipsum fugiat\",\n \"website\": \"irure dolore adipisicing fugiat anim\",\n \"vat_number\": \"ullamco laboris\",\n \"logo\": \"http://aRymYCnvnJyNcEQIoT.akjzoiFTUzxfWp+grvAy13dOVctgkvL7LMJVx-AM9CDas\",\n \"logo_name\": \"culpa in\",\n \"created\": \"1948-04-20T03:44:38.665Z\",\n \"id\": \"d735c359-e9fb-49dc-147b-8119dcd5f691\",\n \"verified_bank\": \"esse ullamco\",\n \"verified_dnb\": \"dolore eu \"\n },\n \"recipient_id\": \"c0d23273-2778-a8aa-cb4a-c8bf6a8ec732\",\n \"recipient\": {\n \"name\": \"eiusmod dolore quis\",\n \"address\": \"occaecat aliqua\",\n \"postal_code\": \"nostrud Excepteur reprehenderit\",\n \"city\": \"do\",\n \"branch\": \"Duis aliqua\",\n \"address2\": \"nisi quis qui ea\",\n \"country\": \"AF\",\n \"country_name\": \"magna laborum\",\n \"website\": \"mollit reprehenderit qui nisi\",\n \"vat_number\": \"consequat anim dolore in\",\n \"logo\": \"https://ljPcSkeYNwkyVNrfPLAWQ.zstqCiRtv,xbARMDTFkb5i\",\n \"logo_name\": \"velit ipsum exercitation\",\n \"created\": \"1946-04-16T16:51:45.748Z\",\n \"id\": \"urn:uuid:b80db94f-8377-0e91-18a1-4b77ea4a5cfb\",\n \"verified_bank\": \"velit ipsum aliqua\",\n \"verified_dnb\": \"elit\"\n },\n \"timestamp_start\": \"1970-10-06T01:26:48.317Z\",\n \"timestamp_end\": \"1996-07-11T18:21:45.128Z\",\n \"blockchain_record_url\": \"ad consectetur\"\n}" }, { "name": "Returned when the authenticated user is not a 3rd-party company.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/referrals/summary/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "referrals", "summary", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Request company details change", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"adipisicing nostrud\",\n \"address\": \"dolor deserunt labore inci\",\n \"postal_code\": \"occaecat Ut est commodo\",\n \"city\": \"cupidatat do est\",\n \"branch\": \"reprehenderit\",\n \"address2\": \"deserunt\",\n \"name_latin\": \"deserunt ad veniam non\",\n \"address_latin\": \"ullamco\",\n \"postal_code_latin\": \"laboris sunt dolor aute do\",\n \"city_latin\": \"ex minim elit Duis\",\n \"country\": \"AU\",\n \"billing_attn_to\": \"velit labore esse\",\n \"billing_email\": \"ol8a3@aWw.nq\",\n \"telephone\": \"dolor ad irure\",\n \"website\": \"elit occaecat do fugiat\",\n \"email\": \"7bMkUgWwgkk-Nf@nIzXEOECuaAXPCXxozDaLFz.veup\",\n \"registration_number\": \"voluptate dolor in\",\n \"duns_number\": \"eiusmod\",\n \"eori_number\": \"laboris veniam sint consectetur\",\n \"lei_number\": \"occaecat labore est\",\n \"vat_number\": \"non\",\n \"subscription\": {\n \"subscription_tier\": {\n \"name\": \"sed anim ut fugiat\",\n \"monthly_price\": \"aliquip ipsum reprehenderit adipisicing consectetur\",\n \"yearly_price\": \"ea reprehenderit quis aliqua\",\n \"additional_credits_per_month\": -4042505544361328600,\n \"non_blockchain_transfer_limit\": 1404767486,\n \"contacts_limit\": 52027954,\n \"users_limit\": -1342984806,\n \"rules_limit\": -1942772934,\n \"connected_apps_limit\": -671037901,\n \"attachments_per_envelope_limit\": 395578582,\n \"attachments_size_per_envelope_limit\": -1380732928,\n \"relayer_speed\": \"normal\",\n \"pdf_audit_log_enabled\": false\n },\n \"number_of_licences\": -1942100196,\n \"valid_until\": \"1995-01-30T12:12:23.690Z\"\n },\n \"fiata_efbl_enabled\": true,\n \"fiata_carrier_id\": \"Ut aliqua\",\n \"created\": \"2012-08-25T09:36:35.198Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/request-details-change/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "request-details-change", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "\nThis endpoint is used for requesting change of company details. \n" }, "response": [ { "name": "Successful submit of details change request.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/request-details-change/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "request-details-change", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when user performing request has insufficient permissions or if user has no company.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/request-details-change/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "request-details-change", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company is not found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/request-details-change/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "request-details-change", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when request change details are not filled out.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/request-details-change/", "host": ["{{baseUrl}}"], "path": [ "companies", ":company", "request-details-change", "" ], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "code": 472, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Renew or upgrade subscription", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"subscription_tier_id\": \"veniam minim\",\n \"payment_type_id\": \"nisi fugiat dolore sunt\",\n \"number_of_licences\": 1776671442,\n \"period\": \"yearly\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/subscriptions/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "subscriptions", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "Creates a subscription renewal or upgrade request." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"subscription_tier_id\": \"veniam minim\",\n \"payment_type_id\": \"nisi fugiat dolore sunt\",\n \"number_of_licences\": 1776671442,\n \"period\": \"yearly\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/subscriptions/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "subscriptions", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"subscription_tier_id\": \"officia\",\n \"payment_type_id\": \"eiusmod incididunt \",\n \"company_id\": \"cb38c12c-bcf1-67b2-c2e9-f4eef1894d73\",\n \"invoice_id\": \"Duis\",\n \"number_of_licences\": 372808597,\n \"period\": \"monthly\",\n \"type\": \"o\",\n \"applied\": \"1998-04-21T03:48:06.509Z\",\n \"created\": \"1957-02-18T16:00:21.402Z\",\n \"id\": \"8a422a16-d735-474c-c148-3d7f2dbf0c55\"\n}" }, { "name": "Returned when authentication credentials were not provided.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"subscription_tier_id\": \"veniam minim\",\n \"payment_type_id\": \"nisi fugiat dolore sunt\",\n \"number_of_licences\": 1776671442,\n \"period\": \"yearly\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:company/subscriptions/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "subscriptions", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Calculate envelopes issue price", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "envelope_ids", "value": "tempor", "description": "(Required) \nThe list of envelope internal ids for which you wish to calculate issue price.\n" }, { "key": "envelope_ids", "value": "do", "description": "(Required) \nThe list of envelope internal ids for which you wish to calculate issue price.\n" } ] }, "url": { "raw": "{{baseUrl}}/companies/:company/transfer-price/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "transfer-price", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "This endpoint is used for calculating issue price for a given set of envelopes.\nThe price is returned in credit milicents." }, "response": [ { "name": "Amount of credits in milicents that is required to issue documents.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "envelope_ids", "value": "Excepteur ex eu", "description": "(Required) \nThe list of envelope internal ids for which you wish to calculate issue price.\n" }, { "key": "envelope_ids", "value": "aliquip id aute", "description": "(Required) \nThe list of envelope internal ids for which you wish to calculate issue price.\n" } ] }, "url": { "raw": "{{baseUrl}}/companies/:company/transfer-price/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "transfer-price", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"100000\"" }, { "name": "Returned when user performing request has insufficient permissions.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "envelope_ids", "value": "Excepteur ex eu", "description": "(Required) \nThe list of envelope internal ids for which you wish to calculate issue price.\n" }, { "key": "envelope_ids", "value": "aliquip id aute", "description": "(Required) \nThe list of envelope internal ids for which you wish to calculate issue price.\n" } ] }, "url": { "raw": "{{baseUrl}}/companies/:company/transfer-price/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "transfer-price", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company is not found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "envelope_ids", "value": "Excepteur ex eu", "description": "(Required) \nThe list of envelope internal ids for which you wish to calculate issue price.\n" }, { "key": "envelope_ids", "value": "aliquip id aute", "description": "(Required) \nThe list of envelope internal ids for which you wish to calculate issue price.\n" } ] }, "url": { "raw": "{{baseUrl}}/companies/:company/transfer-price/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "transfer-price", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "companies get user departments", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:company/user-departments/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "user-departments", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:company/user-departments/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "user-departments", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"dolor deserunt\",\n \"address\": \"ut reprehenderit\",\n \"postal_code\": \"deserunt inci\",\n \"city\": \"dolore culpa incididunt\",\n \"branch\": \"ea ex proident dolor\",\n \"address2\": \"eu incididunt\",\n \"name_latin\": \"qui laborum veniam\",\n \"address_latin\": \"ea enim amet\",\n \"postal_code_latin\": \"non dolor veniam elit incididunt\",\n \"city_latin\": \"Excepteur voluptate\",\n \"country\": \"CV\",\n \"country_name\": \"aliquip mollit pariatur\",\n \"billing_attn_to\": \"do est exercitation eu\",\n \"billing_email\": \"nc7CHPRsB@BZGgsNzCMTvOwpKxLcBh.wf\",\n \"telephone\": \"dolor Excepteur non\",\n \"website\": \"ea quis aliqua\",\n \"email\": \"Pm0FAMjVK@FfQtMce.cyf\",\n \"registration_number\": \"tempor non commodo\",\n \"duns_number\": \"aute adipisicing sed cupidatat\",\n \"eori_number\": \"minim sint cillum\",\n \"lei_number\": \"minim\",\n \"vat_number\": \"enim officia ipsum quis ut\",\n \"vat_rate\": \"enim ipsum in \",\n \"country_vat_rate\": \"velit elit\",\n \"is_eu_company\": \"labore cupidatat commodo\",\n \"is_eu_vat_company\": \"in incididunt voluptate occaecat minim\",\n \"logo\": \"http://kbLaCOOUGo.duPP92uuekDeAkFn\",\n \"logo_name\": \"consequat anim ea minim\",\n \"inboxes\": [\n {\n \"name\": \"voluptate ea\",\n \"company_id\": \"id dolore\",\n \"ethereum_address\": \"0xE1CDfb4afd31Cccc42EC8920b7e60eb7c8D9B49D\",\n \"id\": \"c8553070-48ea-eef2-81b7-319cf8ad3a7a\"\n },\n {\n \"name\": \"est voluptate dolore elit\",\n \"company_id\": \"aute enim eiusmod\",\n \"ethereum_address\": \"0x6ecCa0E0Acb8Ca0EDc8ba1d364eE20B2B52dc53c\",\n \"id\": \"74dccc59-4193-5294-9a96-d5eb48e00e5f\"\n }\n ],\n \"default_inbox_id\": \"incididunt exercitation aliqua\",\n \"latest_terms_accepted\": \"sed dolor\",\n \"ethereum_address\": \"sit\",\n \"is_affiliate_partner\": false,\n \"affiliate_id\": \"reprehenderit irure quis eiusmod\",\n \"subscription\": {\n \"subscription_tier\": {\n \"name\": \"pariatur sit commodo ipsum dolore\",\n \"monthly_price\": \"incididunt aliqua proident\",\n \"yearly_price\": \"consectetur est dolore\",\n \"additional_credits_per_month\": 1539803697840337000,\n \"non_blockchain_transfer_limit\": -963505305,\n \"contacts_limit\": 826134861,\n \"users_limit\": -1640928108,\n \"rules_limit\": -338017958,\n \"connected_apps_limit\": 238852463,\n \"attachments_per_envelope_limit\": 816129983,\n \"attachments_size_per_envelope_limit\": 919115867,\n \"relayer_speed\": \"normal\",\n \"pdf_audit_log_enabled\": true\n },\n \"number_of_licences\": -463614727,\n \"valid_until\": \"2005-02-05T03:03:04.470Z\"\n },\n \"pending_subscription_renewal\": \"ut mollit ullamco\",\n \"number_of_non_blockchain_transactions_last_month\": \"cillum cupidatat est\",\n \"pending_company_details_change_request\": \"Duis occaecat\",\n \"verified_dnb\": \"ex incididunt proident voluptate occaecat\",\n \"verified_vies\": \"deserunt\",\n \"verified_bank\": \"nisi in\",\n \"verification_dnb\": \"labore dolor tempor Ut incididunt\",\n \"verification_vies\": \"consequat laborum\",\n \"verification_bank\": \"quis Ut\",\n \"dnb_verification_paid\": true,\n \"last_approved_details_change_request_date\": \"pariatur adipisicing laborum velit\",\n \"fiata_efbl_enabled\": true,\n \"fiata_carrier_id\": \"dolore\",\n \"additional_vats\": [\n {\n \"country\": \"MX\",\n \"id\": \"6454b14b-eb88-043a-8196-a8052efaca16\",\n \"company_id\": \"non ad consectetur mollit\",\n \"vat_number\": \"proident incididunt ea\",\n \"country_name\": \"adipisicing est aliquip consequat\",\n \"vies_verification\": {\n \"type\": \"vies\",\n \"status\": \"verified\",\n \"verified\": \"1999-04-11T11:14:33.562Z\",\n \"failure_reason\": \"mollit aliquip es\",\n \"processed\": \"2016-04-26T00:29:11.498Z\"\n },\n \"verified_vies\": \"ea pariatur adipisicing Ut tempor\"\n },\n {\n \"country\": \"DO\",\n \"id\": \"38eddfef-cb4f-95cb-7e5e-18356d0dd86e\",\n \"company_id\": \"magna ipsum adipisicing cillum\",\n \"vat_number\": \"tempor Duis\",\n \"country_name\": \"ipsum pariatur occaecat\",\n \"vies_verification\": {\n \"type\": \"bank\",\n \"status\": \"pending_review\",\n \"verified\": \"1996-10-18T09:54:06.242Z\",\n \"failure_reason\": \"quis proident id aliquip ei\",\n \"processed\": \"1979-09-27T18:42:04.371Z\"\n },\n \"verified_vies\": \"laboru\"\n }\n ],\n \"created\": \"1995-06-30T05:08:11.411Z\",\n \"wants_invoices_instead_of_proforma\": false,\n \"id\": \"d81a853d-86be-4744-722c-a04bbdb72e79\"\n}" } ] }, { "name": "Initiate verification", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "type", "value": "dnb", "description": "(Required) \nType of verification to initiate.\n" } ] }, "url": { "raw": "{{baseUrl}}/companies/:company/verify/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "verify", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] }, "description": "This endpoint is used for initiating company verifications." }, "response": [ { "name": "Returned when verification is successfully initiated", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "type", "value": "dnb", "description": "(Required) \nType of verification to initiate.\n" } ] }, "url": { "raw": "{{baseUrl}}/companies/:company/verify/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "verify", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when user performing request has insufficient permissions.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "type", "value": "dnb", "description": "(Required) \nType of verification to initiate.\n" } ] }, "url": { "raw": "{{baseUrl}}/companies/:company/verify/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "verify", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when company is not found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "type", "value": "dnb", "description": "(Required) \nType of verification to initiate.\n" } ] }, "url": { "raw": "{{baseUrl}}/companies/:company/verify/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "verify", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when verification cannot be initiated.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "type", "value": "dnb", "description": "(Required) \nType of verification to initiate.\n" } ] }, "url": { "raw": "{{baseUrl}}/companies/:company/verify/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "verify", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "code": 470, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when type parameter is invalid.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "type", "value": "dnb", "description": "(Required) \nType of verification to initiate.\n" } ] }, "url": { "raw": "{{baseUrl}}/companies/:company/verify/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "verify", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "code": 471, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when type parameter is missing.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "type", "value": "dnb", "description": "(Required) \nType of verification to initiate.\n" } ] }, "url": { "raw": "{{baseUrl}}/companies/:company/verify/", "host": ["{{baseUrl}}"], "path": ["companies", ":company", "verify", ""], "variable": [ { "key": "company", "value": "cons", "description": "(Required) \nThe company identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|-------------------------|-------------------------------------------------------------------------------------------------|\n| `self` | String `self` represents the currently logged in company. |\n| `by-id/{id}` | Determine company by its ID. Replace `{id}` with internal company id. |\n| `by-eth-addr/{eth_addr}`| Determine company by its ethereum address. Replace `{eth_addr}` with company's ethereum address|\n" } ] } }, "code": 472, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Create new company", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"adipisicing nostrud\",\n \"address\": \"dolor deserunt labore inci\",\n \"postal_code\": \"occaecat Ut est commodo\",\n \"city\": \"cupidatat do est\",\n \"branch\": \"reprehenderit\",\n \"address2\": \"deserunt\",\n \"name_latin\": \"deserunt ad veniam non\",\n \"address_latin\": \"ullamco\",\n \"postal_code_latin\": \"laboris sunt dolor aute do\",\n \"city_latin\": \"ex minim elit Duis\",\n \"country\": \"AU\",\n \"billing_attn_to\": \"velit labore esse\",\n \"billing_email\": \"ol8a3@aWw.nq\",\n \"telephone\": \"dolor ad irure\",\n \"website\": \"elit occaecat do fugiat\",\n \"email\": \"7bMkUgWwgkk-Nf@nIzXEOECuaAXPCXxozDaLFz.veup\",\n \"registration_number\": \"voluptate dolor in\",\n \"duns_number\": \"eiusmod\",\n \"eori_number\": \"laboris veniam sint consectetur\",\n \"lei_number\": \"occaecat labore est\",\n \"vat_number\": \"non\",\n \"subscription\": {\n \"subscription_tier\": {\n \"name\": \"sed anim ut fugiat\",\n \"monthly_price\": \"aliquip ipsum reprehenderit adipisicing consectetur\",\n \"yearly_price\": \"ea reprehenderit quis aliqua\",\n \"additional_credits_per_month\": -4042505544361328600,\n \"non_blockchain_transfer_limit\": 1404767486,\n \"contacts_limit\": 52027954,\n \"users_limit\": -1342984806,\n \"rules_limit\": -1942772934,\n \"connected_apps_limit\": -671037901,\n \"attachments_per_envelope_limit\": 395578582,\n \"attachments_size_per_envelope_limit\": -1380732928,\n \"relayer_speed\": \"normal\",\n \"pdf_audit_log_enabled\": false\n },\n \"number_of_licences\": -1942100196,\n \"valid_until\": \"1995-01-30T12:12:23.690Z\"\n },\n \"fiata_efbl_enabled\": true,\n \"fiata_carrier_id\": \"Ut aliqua\",\n \"created\": \"2012-08-25T09:36:35.198Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/", "host": ["{{baseUrl}}"], "path": ["companies", ""] }, "description": "The endpoint for creating companies. With this endpoint the 3rd-party system is\n responsible for checking the validity of the ethereum address. If you wish to transfer this responsibility to\n the user (recommended) please use the registration token endpoint. When a company is created the primary\n user is also created simultaneously." }, "response": [] }, { "name": "List companies", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/list/", "host": ["{{baseUrl}}"], "path": ["companies", "list", ""] }, "description": "Lists all companies that can be managed by the logged in user." }, "response": [] } ] }, { "name": "finance", "item": [ { "name": "List fintech categories", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/finance/categories/list/", "host": ["{{baseUrl}}"], "path": ["finance", "categories", "list", ""] }, "description": "Lists all visible fintech categories." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/finance/categories/list/", "host": ["{{baseUrl}}"], "path": ["finance", "categories", "list", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"name\": \"pariatur sit commodo velit officia\",\n \"id\": \"urn:uuid:916f3571-70a3-fae9-73d1-448be03dd28f\",\n \"description\": \"minim\",\n \"app_visibility\": \"COMING_SOON\"\n },\n {\n \"name\": \"cillum aute dolore in\",\n \"id\": \"urn:uuid:57d40780-9860-6bd8-4f5e-1111e4112b43\",\n \"description\": \"sit Excepteur sunt veniam dolore\",\n \"app_visibility\": \"HIDDEN\"\n }\n]" } ] }, { "name": "List fintech institutions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/finance/institutions/list/", "host": ["{{baseUrl}}"], "path": ["finance", "institutions", "list", ""] }, "description": "Lists all visible fintech institutions." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/finance/institutions/list/", "host": ["{{baseUrl}}"], "path": ["finance", "institutions", "list", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"name\": \"culpa aliquip sed nulla\",\n \"description\": \"aute anim veniam deserunt id\",\n \"id\": \"urn:uuid:d676a40b-0c9a-3b4f-da1d-4885879fb4ae\",\n \"category_id\": \"in magn\",\n \"features\": \"dolor est\",\n \"logo\": \"eu qui\",\n \"website_url\": \"https://DWdHzklKTBXTTMBqSwGKlUtBAS.nbav3KxbRmxTMJImHGg42vKISUK8.rQ7rRYVWixpOibgdGI\",\n \"email\": \"sKQZt8WEOr@woDcAjhgqRZmbCm.kksm\",\n \"app_visibility\": \"VISIBLE\",\n \"promoted\": false\n },\n {\n \"name\": \"consequat sed\",\n \"description\": \"tempor dolore sunt aliqua\",\n \"id\": \"ca8087ab-1cc7-c6bc-ef43-217cf371d654\",\n \"category_id\": \"sint in\",\n \"features\": \"aute amet mollit ipsum\",\n \"logo\": \"nisi aliquip ad sit\",\n \"website_url\": \"https://yZcqVeqKLofgINwUUUcIdTlusnm.aaQnHBkWAcQLrmB6m.PJJ+rG4kBHmVcR6.Dsb3YsayZBitdZt6URSFZgnF\",\n \"email\": \"kxBYbE1CsUYwZy@MCeRCoRDzwVtjqvoxME.pja\",\n \"app_visibility\": \"HIDDEN\",\n \"promoted\": false\n }\n]" } ] } ] }, { "name": "login-with-cargox", "item": [ { "name": "Grant access", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/login-with-cargox/authorize/", "host": ["{{baseUrl}}"], "path": ["login-with-cargox", "authorize", ""] }, "description": "\nGrant access to third party application.\n" }, "response": [ { "name": "Successful authorization.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/login-with-cargox/authorize/", "host": ["{{baseUrl}}"], "path": ["login-with-cargox", "authorize", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when user performing request has insufficient permissions or if user has no company.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/login-with-cargox/authorize/", "host": ["{{baseUrl}}"], "path": ["login-with-cargox", "authorize", ""] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when CargoX terms and conditions are not found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/login-with-cargox/authorize/", "host": ["{{baseUrl}}"], "path": ["login-with-cargox", "authorize", ""] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Retrieve third party application details", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/login-with-cargox/:client_id/", "host": ["{{baseUrl}}"], "path": ["login-with-cargox", ":client_id", ""], "variable": [ { "key": "client_id", "value": "cons", "description": "(Required) " } ] }, "description": "\nUse this method to fetch details of the third party application.\n" }, "response": [ { "name": "Returns the third party application details.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/login-with-cargox/:client_id/", "host": ["{{baseUrl}}"], "path": ["login-with-cargox", ":client_id", ""], "variable": [ { "key": "client_id", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned if third party application is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/login-with-cargox/:client_id/", "host": ["{{baseUrl}}"], "path": ["login-with-cargox", ":client_id", ""], "variable": [ { "key": "client_id", "value": "cons", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "registrations", "item": [ { "name": "app-tokens", "item": [ { "name": "Create an app authorization token", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"country\": \"CA\",\n \"name\": \"ipsum aliqua do laborum\",\n \"user_first_name\": \"nostrud quis\",\n \"user_last_name\": \"pariatur ad magna ipsum\",\n \"user_email\": \"Sdy2QfI2O30Ts6U@ApWWvuIIIrQaUZIPsTZnfLXOkzICuerC.fg\",\n \"third_party_system\": {\n \"name\": \"velit\",\n \"id\": \"urn:uuid:301069ad-0140-086b-b684-5578d532f787\"\n },\n \"redirect_url\": \"http://szdYMWAvGJVFr.uwh+iLLO6MAMchflQH6bGRVbZJ2egKtnDuAUjnz9KX\",\n \"created\": \"1961-04-24T12:10:20.972Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/registrations/app-tokens/", "host": ["{{baseUrl}}"], "path": ["registrations", "app-tokens", ""] }, "description": "The endpoint for creating app authorization tokens. \n Creating an authorization token is similar to creating a company with\n the difference that the result of this call is a registration token object that needs to be passed to the user\n and upon completing the registration, the company will be managed by the calling external system.\n This relieves the external system of having to deal with ethereum blockchain keys (private keys). The users\n themselves are the only actors in control of their private keys.\n\n The flow is as follows:\n\n - A third party system creates a registration token and receives a `registration_url` and redirects the user to it.\n - The user completes the registration and is redirected to `redirect_url` which is provided by the\n third party system\n - If the user is already registered, she is provided with a dialog where she can allow the third party system to\n manage her account." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/registrations/app-tokens/", "host": ["{{baseUrl}}"], "path": ["registrations", "app-tokens", ""] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"country\": \"BA\",\n \"registration_url\": \"ullamco aute ea veniam\",\n \"id\": \"ipsum occaecat commodo\",\n \"company_id\": \"veniam\",\n \"name\": \"dolor ea culpa\",\n \"user_first_name\": \"elit aute\",\n \"user_last_name\": \"veniam mollit Duis dolore adipisicing\",\n \"user_email\": \"dNS21mE5B@clbLqin.ys\",\n \"third_party_system\": {\n \"name\": \"exercitation quis\",\n \"id\": \"urn:uuid:2f861adf-a0a9-8287-d09d-af1dd248d61a\"\n },\n \"redirect_url\": \"https://NSpyzVZZmoyyovWVxGEUeYb.ayxQkl0bDZL,NNKoQL-jTGHF6B\",\n \"finished\": \"sed eiusmod fu\",\n \"created\": \"2005-06-18T11:33:35.365Z\"\n}" } ] }, { "name": "List all app authorization tokens", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/registrations/app-tokens/list/", "host": ["{{baseUrl}}"], "path": ["registrations", "app-tokens", "list", ""] }, "description": "Retrieves all app authorization tokens by logged in external system. Can be filtered by \n the finished attribute." }, "response": [ { "name": "List of app authorization tokens created by logged in external system.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/registrations/app-tokens/list/", "host": ["{{baseUrl}}"], "path": ["registrations", "app-tokens", "list", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"country\": \"BA\",\n \"registration_url\": \"ullamco aute ea veniam\",\n \"id\": \"ipsum occaecat commodo\",\n \"company_id\": \"veniam\",\n \"name\": \"dolor ea culpa\",\n \"user_first_name\": \"elit aute\",\n \"user_last_name\": \"veniam mollit Duis dolore adipisicing\",\n \"user_email\": \"dNS21mE5B@clbLqin.ys\",\n \"third_party_system\": {\n \"name\": \"exercitation quis\",\n \"id\": \"urn:uuid:2f861adf-a0a9-8287-d09d-af1dd248d61a\"\n },\n \"redirect_url\": \"https://NSpyzVZZmoyyovWVxGEUeYb.ayxQkl0bDZL,NNKoQL-jTGHF6B\",\n \"finished\": \"sed eiusmod fu\",\n \"created\": \"2005-06-18T11:33:35.365Z\"\n}" } ] }, { "name": "Retrieve app authorization token", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/registrations/app-tokens/:registration_token/", "host": ["{{baseUrl}}"], "path": [ "registrations", "app-tokens", ":registration_token", "" ], "variable": [ { "key": "registration_token", "value": "cons", "description": "(Required) " } ] }, "description": "Retrieves an app authorization token. This is useful for checking if authorization \n process was finished or not." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/registrations/app-tokens/:registration_token/", "host": ["{{baseUrl}}"], "path": [ "registrations", "app-tokens", ":registration_token", "" ], "variable": [ { "key": "registration_token", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"country\": \"BA\",\n \"registration_url\": \"ullamco aute ea veniam\",\n \"id\": \"ipsum occaecat commodo\",\n \"company_id\": \"veniam\",\n \"name\": \"dolor ea culpa\",\n \"user_first_name\": \"elit aute\",\n \"user_last_name\": \"veniam mollit Duis dolore adipisicing\",\n \"user_email\": \"dNS21mE5B@clbLqin.ys\",\n \"third_party_system\": {\n \"name\": \"exercitation quis\",\n \"id\": \"urn:uuid:2f861adf-a0a9-8287-d09d-af1dd248d61a\"\n },\n \"redirect_url\": \"https://NSpyzVZZmoyyovWVxGEUeYb.ayxQkl0bDZL,NNKoQL-jTGHF6B\",\n \"finished\": \"sed eiusmod fu\",\n \"created\": \"2005-06-18T11:33:35.365Z\"\n}" }, { "name": "Returned when App authorization token is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/registrations/app-tokens/:registration_token/", "host": ["{{baseUrl}}"], "path": [ "registrations", "app-tokens", ":registration_token", "" ], "variable": [ { "key": "registration_token", "value": "cons", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "companies", "item": [ { "name": "tokens/{registration token}", "item": [ { "name": "Retrieve registration token", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/registrations/companies/tokens/:registration_token/", "host": ["{{baseUrl}}"], "path": [ "registrations", "companies", "tokens", ":registration_token", "" ], "variable": [ { "key": "registration_token", "value": "cons", "description": "(Required) " } ] }, "description": "Retrieves valid registration token." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/registrations/companies/tokens/:registration_token/", "host": ["{{baseUrl}}"], "path": [ "registrations", "companies", "tokens", ":registration_token", "" ], "variable": [ { "key": "registration_token", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"country\": \"BA\",\n \"registration_url\": \"ullamco aute ea veniam\",\n \"id\": \"ipsum occaecat commodo\",\n \"company_id\": \"veniam\",\n \"name\": \"dolor ea culpa\",\n \"user_first_name\": \"elit aute\",\n \"user_last_name\": \"veniam mollit Duis dolore adipisicing\",\n \"user_email\": \"dNS21mE5B@clbLqin.ys\",\n \"third_party_system\": {\n \"name\": \"exercitation quis\",\n \"id\": \"urn:uuid:2f861adf-a0a9-8287-d09d-af1dd248d61a\"\n },\n \"redirect_url\": \"https://NSpyzVZZmoyyovWVxGEUeYb.ayxQkl0bDZL,NNKoQL-jTGHF6B\",\n \"finished\": \"sed eiusmod fu\",\n \"created\": \"2005-06-18T11:33:35.365Z\"\n}" }, { "name": "Returned when registration token is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/registrations/companies/tokens/:registration_token/", "host": ["{{baseUrl}}"], "path": [ "registrations", "companies", "tokens", ":registration_token", "" ], "variable": [ { "key": "registration_token", "value": "cons", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "registrations companies tokens update", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"country\": \"CA\",\n \"name\": \"ipsum aliqua do laborum\",\n \"user_first_name\": \"nostrud quis\",\n \"user_last_name\": \"pariatur ad magna ipsum\",\n \"user_email\": \"Sdy2QfI2O30Ts6U@ApWWvuIIIrQaUZIPsTZnfLXOkzICuerC.fg\",\n \"third_party_system\": {\n \"name\": \"velit\",\n \"id\": \"urn:uuid:301069ad-0140-086b-b684-5578d532f787\"\n },\n \"redirect_url\": \"http://szdYMWAvGJVFr.uwh+iLLO6MAMchflQH6bGRVbZJ2egKtnDuAUjnz9KX\",\n \"created\": \"1961-04-24T12:10:20.972Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/registrations/companies/tokens/:registration_token/", "host": ["{{baseUrl}}"], "path": [ "registrations", "companies", "tokens", ":registration_token", "" ], "variable": [ { "key": "registration_token", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/registrations/companies/tokens/:registration_token/", "host": ["{{baseUrl}}"], "path": [ "registrations", "companies", "tokens", ":registration_token", "" ], "variable": [ { "key": "registration_token", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"country\": \"BA\",\n \"registration_url\": \"ullamco aute ea veniam\",\n \"id\": \"ipsum occaecat commodo\",\n \"company_id\": \"veniam\",\n \"name\": \"dolor ea culpa\",\n \"user_first_name\": \"elit aute\",\n \"user_last_name\": \"veniam mollit Duis dolore adipisicing\",\n \"user_email\": \"dNS21mE5B@clbLqin.ys\",\n \"third_party_system\": {\n \"name\": \"exercitation quis\",\n \"id\": \"urn:uuid:2f861adf-a0a9-8287-d09d-af1dd248d61a\"\n },\n \"redirect_url\": \"https://NSpyzVZZmoyyovWVxGEUeYb.ayxQkl0bDZL,NNKoQL-jTGHF6B\",\n \"finished\": \"sed eiusmod fu\",\n \"created\": \"2005-06-18T11:33:35.365Z\"\n}" } ] } ] }, { "name": "registrations companies create", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Lorem irure tempor\",\n \"address\": \"dolore commodo anim nisi\",\n \"postal_code\": \"cillum incididunt\",\n \"city\": \"ad ut incididunt nisi quis\",\n \"country\": \"GW\",\n \"user_first_name\": \"Excepteur elit amet\",\n \"user_last_name\": \"elit tempor consectetur\",\n \"user_email\": \"3xroRHwYwKj4@YwKLNZHh.jn\",\n \"user_telephone\": \"magna in ut\",\n \"password\": \"ad ut incididunt\",\n \"repeat_password\": \"mollit ut laboris aliqua\",\n \"email_verification_hash\": \"in sit ad Ut dolore\",\n \"email_verification_code\": \"officia dolore\",\n \"branch\": \"enim dolor velit\",\n \"name_latin\": \"esse qui ut\",\n \"address_latin\": \"in adipisicing voluptate qui\",\n \"postal_code_latin\": \"culpa in\",\n \"city_latin\": \"eu adipisi\",\n \"registration_number\": \"commodo sint nulla cupidata\",\n \"vat_number\": \"fugiat nostrud\",\n \"duns_number\": \"ad dolore id\",\n \"eori_number\": \"consectetur exercitation\",\n \"lei_number\": \"voluptate nostrud commodo\",\n \"website\": \"in\",\n \"telephone\": \"aliqua elit esse ullamco\",\n \"invitation_code\": \"labore reprehenderit in tempor s\",\n \"referral_code\": \"in\",\n \"registration_token\": \"sed s\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/registrations/companies/", "host": ["{{baseUrl}}"], "path": ["registrations", "companies", ""] }, "description": "An endpoint for the company registration." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Lorem irure tempor\",\n \"address\": \"dolore commodo anim nisi\",\n \"postal_code\": \"cillum incididunt\",\n \"city\": \"ad ut incididunt nisi quis\",\n \"country\": \"GW\",\n \"user_first_name\": \"Excepteur elit amet\",\n \"user_last_name\": \"elit tempor consectetur\",\n \"user_email\": \"3xroRHwYwKj4@YwKLNZHh.jn\",\n \"user_telephone\": \"magna in ut\",\n \"password\": \"ad ut incididunt\",\n \"repeat_password\": \"mollit ut laboris aliqua\",\n \"email_verification_hash\": \"in sit ad Ut dolore\",\n \"email_verification_code\": \"officia dolore\",\n \"branch\": \"enim dolor velit\",\n \"name_latin\": \"esse qui ut\",\n \"address_latin\": \"in adipisicing voluptate qui\",\n \"postal_code_latin\": \"culpa in\",\n \"city_latin\": \"eu adipisi\",\n \"registration_number\": \"commodo sint nulla cupidata\",\n \"vat_number\": \"fugiat nostrud\",\n \"duns_number\": \"ad dolore id\",\n \"eori_number\": \"consectetur exercitation\",\n \"lei_number\": \"voluptate nostrud commodo\",\n \"website\": \"in\",\n \"telephone\": \"aliqua elit esse ullamco\",\n \"invitation_code\": \"labore reprehenderit in tempor s\",\n \"referral_code\": \"in\",\n \"registration_token\": \"sed s\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/registrations/companies/", "host": ["{{baseUrl}}"], "path": ["registrations", "companies", ""] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"amet in p\",\n \"address\": \"non do culpa\",\n \"postal_code\": \"ex nisi amet aute\",\n \"city\": \"non enim esse\",\n \"country\": \"GD\",\n \"user_first_name\": \"laboris consectetur\",\n \"user_last_name\": \"incididunt irure officia\",\n \"user_email\": \"jwER-t1Hxkyzvwh@DEthAZRshYZTyWrrZIVEPjjFrbiD.liia\",\n \"user_telephone\": \"deserunt eiusmod pariatur\",\n \"password\": \"aliqua fugiat irure\",\n \"repeat_password\": \"do dolor esse eiusmod\",\n \"email_verification_hash\": \"nostrud eiusmod officia amet ut\",\n \"email_verification_code\": \"laboris qui consectetur\",\n \"branch\": \"ipsum non\",\n \"name_latin\": \"id culpa\",\n \"address_latin\": \"qui\",\n \"postal_code_latin\": \"quis cupidatat culpa qui\",\n \"city_latin\": \"aute Excepteur\",\n \"registration_number\": \"qui nulla\",\n \"vat_number\": \"mollit laboris in fugiat\",\n \"duns_number\": \"et amet voluptate ullamco Ut\",\n \"eori_number\": \"exercitation ad nisi id\",\n \"lei_number\": \"in\",\n \"website\": \"aute deserunt incididunt ipsum in\",\n \"telephone\": \"dolor in sed in aliquip\",\n \"logo\": \"https://dA.vqulrQ+D.RpyZtIf21V9kqFHOuo4dDByDpKl5o.J,TA8csSZRTNO2il7yW+8rca-\",\n \"invitation_code\": \"dolor dolor Ut\",\n \"referral_code\": \"adipisicing\",\n \"registration_token\": \"sunt occaecat adipisicing amet\",\n \"id\": \"urn:uuid:d7ef2fa7-115d-088b-bc17-ed5a873f4276\"\n}" } ] }, { "name": "registrations companies transliterate", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/registrations/companies/transliterate/", "host": ["{{baseUrl}}"], "path": ["registrations", "companies", "transliterate", ""] }, "description": "Transliterate string" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/registrations/companies/transliterate/", "host": ["{{baseUrl}}"], "path": [ "registrations", "companies", "transliterate", "" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"name\": \"exercitation consectetur id in\",\n \"address\": \"nostrud occaecat tempor ipsum\",\n \"postal_code\": \"voluptate Ut\",\n \"city\": \"commodo aliquip minim\",\n \"country\": \"BW\",\n \"user_first_name\": \"aliquip\",\n \"user_last_name\": \"enim occaecat\",\n \"user_email\": \"XPixv1OSPasHU@FcAtlzRaSDZ.ps\",\n \"user_telephone\": \"exercitation Duis\",\n \"password\": \"anim\",\n \"repeat_password\": \"aliquip esse voluptate\",\n \"email_verification_hash\": \"mollit reprehenderit Ut laboris\",\n \"email_verification_code\": \"proident Lorem laborum\",\n \"branch\": \"dolor qui ex\",\n \"name_latin\": \"anim amet in eu\",\n \"address_latin\": \"eu ullamco\",\n \"postal_code_latin\": \"exercitation Ut ex qui\",\n \"city_latin\": \"mollit Lorem et occaecat\",\n \"registration_number\": \"pariatur labore\",\n \"vat_number\": \"sit mollit voluptate anim tempor\",\n \"duns_number\": \"voluptate\",\n \"eori_number\": \"incididunt eiusmod sit qui \",\n \"lei_number\": \"ea nulla Excepteur\",\n \"website\": \"occaecat\",\n \"telephone\": \"aute dolore tempor qui\",\n \"logo\": \"http://XiuPCAiDPmuUi.xjetTouou\",\n \"invitation_code\": \"laborum culpa cillum dolore\",\n \"referral_code\": \"deserunt velit\",\n \"registration_token\": \"ullamco reprehenderit\",\n \"id\": \"daefd162-3b0a-a410-ed25-d56e75c13256\"\n },\n {\n \"name\": \"consectetur in esse\",\n \"address\": \"do cillum qui dolore\",\n \"postal_code\": \"in dolore\",\n \"city\": \"dolor eu\",\n \"country\": \"NL\",\n \"user_first_name\": \"Duis eu proident\",\n \"user_last_name\": \"anim Excepteur amet aliquip\",\n \"user_email\": \"Z5eQjiMGD9@znuQrOfVSHbSgtZldG.ghg\",\n \"user_telephone\": \"voluptate\",\n \"password\": \"enim aliquip mollit aute est\",\n \"repeat_password\": \"quis\",\n \"email_verification_hash\": \"ut\",\n \"email_verification_code\": \"in velit in esse et\",\n \"branch\": \"in laboris\",\n \"name_latin\": \"ea dolore pariatur\",\n \"address_latin\": \"commodo Lorem dolor\",\n \"postal_code_latin\": \"pariatur\",\n \"city_latin\": \"et in\",\n \"registration_number\": \"laboris ullamco dolor minim culpa\",\n \"vat_number\": \"ex laborum Excepteur\",\n \"duns_number\": \"eiusmod exercitation nulla ea qui\",\n \"eori_number\": \"eius\",\n \"lei_number\": \"commodo aliqua et tempor\",\n \"website\": \"ex est\",\n \"telephone\": \"ullamco mollit eiusmod\",\n \"logo\": \"https://VwkSserdktdQTzXALkGFgkCPpYsgrHq.lwsrwH1sFYtJBgMzLz1R\",\n \"invitation_code\": \"ut anim\",\n \"referral_code\": \"mollit consectetur laboris\",\n \"registration_token\": \"est incididunt ea in exercitation\",\n \"id\": \"0579be44-6938-dfe1-fbc0-e49ed41495cd\"\n }\n]" } ] } ] }, { "name": "reset-codes/{id}", "item": [ { "name": "An endpoint for fetching data about registration codes.", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/registrations/reset-codes/:id/", "host": ["{{baseUrl}}"], "path": ["registrations", "reset-codes", ":id", ""], "variable": [ { "key": "id", "value": "cons", "description": "(Required) " } ] }, "description": "It mostly returns the info if the registration code is valid or not" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/registrations/reset-codes/:id/", "host": ["{{baseUrl}}"], "path": ["registrations", "reset-codes", ":id", ""], "variable": [ { "key": "id", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"KmARsb9NB@XfGjRDmYLYMPxBpFpFVYZ.sf\",\n \"telephone\": \"proident adipisicing dolore ut velit\",\n \"roles\": {},\n \"name\": \"deserunt nulla eu elit amet\",\n \"first_name\": \"deserunt sint\",\n \"last_name\": \"deserunt sit ex\",\n \"email_override\": \"14GJnTbhW6iVkr@pRkpAeocUMKpStaRuMmEPkDywroWu.dgzy\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"laboris in nostru\",\n \"company_department\": {\n \"name\": \"dolor adipisicing ea\"\n },\n \"role_at_company\": \"laborum exercitation ut minim\",\n \"locale\": \"en_GB\",\n \"is_active\": true,\n \"company_id\": \"consequat eu dolore\",\n \"password_set\": true,\n \"reset_password\": true,\n \"show_welcome_screen\": false,\n \"compact_layout\": true,\n \"dark_mode\": true,\n \"left_navigation_opened\": true,\n \"mobile_left_navigation_opened\": false,\n \"envelope_layout\": \"qui enim velit\",\n \"envelope_layout_width_percent\": 26387053,\n \"envelope_layout_height_percent\": -47871652,\n \"envelope_details_view\": \"aliqua elit\",\n \"latest_login\": \"1955-09-05T18:05:16.899Z\",\n \"email_verification_hash\": \"officia ex mollit sed\",\n \"email_verification_code\": \"e\",\n \"logo\": \"http://itZgoXGWjtYKuK.qiavW0Fs53Xw79Pesiq077MT1CmLsJPVu9IUphiqbl\",\n \"logo_name\": \"laborum Excepteur\",\n \"id\": \"urn:uuid:1c852e73-d47e-3eee-c969-5bf8f09ccc31\",\n \"notifications\": {\n \"title\": \"ad cupidatat\",\n \"cleared\": false,\n \"seen\": false,\n \"notification_type\": 11,\n \"reference_id\": \"7cecfea0-ebc5-6f10-7244-f22bb842f220\"\n },\n \"insecure_login_method_reminder\": \"2014-06-11T10:45:06.907Z\",\n \"is_cargox_system_user\": \"anim\",\n \"created\": \"2002-09-28T10:39:50.044Z\",\n \"notified_changelog_version\": \"\",\n \"subscribe_to_platform_news\": false\n}" } ] }, { "name": "An endpoint for fetching data about registration codes.", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"YgO3iGEQ2l@sxkYWEmLsptBWJghuGQxxMlp.qpn\",\n \"telephone\": \"sunt anim labo\",\n \"roles\": {},\n \"first_name\": \"eu dolor adipisicing pariatur aliquip\",\n \"last_name\": \"amet ipsum sit nulla\",\n \"email_override\": \"GZ2wq8@QKsBvfsFAawIJcEfYzJDtHlgZapyrMzT.nak\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"quis dolor\",\n \"company_department\": {\n \"name\": \"consequat cillum cupidatat ipsu\"\n },\n \"role_at_company\": \"do deserunt nisi amet\",\n \"locale\": \"ar_EG\",\n \"reset_password\": false,\n \"show_welcome_screen\": true,\n \"compact_layout\": false,\n \"dark_mode\": true,\n \"left_navigation_opened\": false,\n \"mobile_left_navigation_opened\": true,\n \"envelope_layout\": \"dolor dolore\",\n \"envelope_layout_width_percent\": -30068380,\n \"envelope_layout_height_percent\": 46871767,\n \"envelope_details_view\": \"cupidatat in sed est\",\n \"email_verification_hash\": \"consequat reprehenderit anim\",\n \"email_verification_code\": \"Duis anim\",\n \"notifications\": {\n \"title\": \"amet\",\n \"cleared\": false,\n \"seen\": true,\n \"notification_type\": 3,\n \"reference_id\": \"b083d345-43b8-3580-b823-f750ef184381\"\n },\n \"insecure_login_method_reminder\": \"1959-09-17T00:27:53.058Z\",\n \"created\": \"1983-01-24T19:41:28.605Z\",\n \"notified_changelog_version\": \"q\",\n \"subscribe_to_platform_news\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/registrations/reset-codes/:id/", "host": ["{{baseUrl}}"], "path": ["registrations", "reset-codes", ":id", ""], "variable": [ { "key": "id", "value": "cons", "description": "(Required) " } ] }, "description": "It mostly returns the info if the registration code is valid or not" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/registrations/reset-codes/:id/", "host": ["{{baseUrl}}"], "path": ["registrations", "reset-codes", ":id", ""], "variable": [ { "key": "id", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"KmARsb9NB@XfGjRDmYLYMPxBpFpFVYZ.sf\",\n \"telephone\": \"proident adipisicing dolore ut velit\",\n \"roles\": {},\n \"name\": \"deserunt nulla eu elit amet\",\n \"first_name\": \"deserunt sint\",\n \"last_name\": \"deserunt sit ex\",\n \"email_override\": \"14GJnTbhW6iVkr@pRkpAeocUMKpStaRuMmEPkDywroWu.dgzy\",\n \"accept_declaration_of_authorisation\": false,\n \"notes\": \"laboris in nostru\",\n \"company_department\": {\n \"name\": \"dolor adipisicing ea\"\n },\n \"role_at_company\": \"laborum exercitation ut minim\",\n \"locale\": \"en_GB\",\n \"is_active\": true,\n \"company_id\": \"consequat eu dolore\",\n \"password_set\": true,\n \"reset_password\": true,\n \"show_welcome_screen\": false,\n \"compact_layout\": true,\n \"dark_mode\": true,\n \"left_navigation_opened\": true,\n \"mobile_left_navigation_opened\": false,\n \"envelope_layout\": \"qui enim velit\",\n \"envelope_layout_width_percent\": 26387053,\n \"envelope_layout_height_percent\": -47871652,\n \"envelope_details_view\": \"aliqua elit\",\n \"latest_login\": \"1955-09-05T18:05:16.899Z\",\n \"email_verification_hash\": \"officia ex mollit sed\",\n \"email_verification_code\": \"e\",\n \"logo\": \"http://itZgoXGWjtYKuK.qiavW0Fs53Xw79Pesiq077MT1CmLsJPVu9IUphiqbl\",\n \"logo_name\": \"laborum Excepteur\",\n \"id\": \"urn:uuid:1c852e73-d47e-3eee-c969-5bf8f09ccc31\",\n \"notifications\": {\n \"title\": \"ad cupidatat\",\n \"cleared\": false,\n \"seen\": false,\n \"notification_type\": 11,\n \"reference_id\": \"7cecfea0-ebc5-6f10-7244-f22bb842f220\"\n },\n \"insecure_login_method_reminder\": \"2014-06-11T10:45:06.907Z\",\n \"is_cargox_system_user\": \"anim\",\n \"created\": \"2002-09-28T10:39:50.044Z\",\n \"notified_changelog_version\": \"\",\n \"subscribe_to_platform_news\": false\n}" } ] } ] }, { "name": "users/{user}", "item": [ { "name": "registrations users read", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/registrations/users/:user/", "host": ["{{baseUrl}}"], "path": ["registrations", "users", ":user", ""], "variable": [ { "key": "user", "value": "cons", "description": "(Required) " } ] }, "description": "An endpoint for the user account activation." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/registrations/users/:user/", "host": ["{{baseUrl}}"], "path": ["registrations", "users", ":user", ""], "variable": [ { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"Zk2-O39sYMyk@gicPUzlVAnhrOdwsMiSyghSycjJor.ybu\",\n \"password\": \"qui\",\n \"repeat_password\": \"ullamco deserunt\",\n \"name\": \"Duis et incididunt\",\n \"first_name\": \"ut ipsum minim commodo\",\n \"last_name\": \"tempor ex elit officia anim\",\n \"id\": \"urn:uuid:ddb48905-5df4-f20c-2a9a-1eae4fcf0f1d\"\n}" } ] }, { "name": "registrations users update", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"O4A@sZArraGscvQOI.uw\",\n \"password\": \"et sint veniam ipsum\",\n \"repeat_password\": \"irure mollit\",\n \"first_name\": \"labore ut sint\",\n \"last_name\": \"commodo est qui sint\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/registrations/users/:user/", "host": ["{{baseUrl}}"], "path": ["registrations", "users", ":user", ""], "variable": [ { "key": "user", "value": "cons", "description": "(Required) " } ] }, "description": "An endpoint for the user account activation." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/registrations/users/:user/", "host": ["{{baseUrl}}"], "path": ["registrations", "users", ":user", ""], "variable": [ { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"Zk2-O39sYMyk@gicPUzlVAnhrOdwsMiSyghSycjJor.ybu\",\n \"password\": \"qui\",\n \"repeat_password\": \"ullamco deserunt\",\n \"name\": \"Duis et incididunt\",\n \"first_name\": \"ut ipsum minim commodo\",\n \"last_name\": \"tempor ex elit officia anim\",\n \"id\": \"urn:uuid:ddb48905-5df4-f20c-2a9a-1eae4fcf0f1d\"\n}" } ] }, { "name": "registrations users partial update", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"O4A@sZArraGscvQOI.uw\",\n \"password\": \"et sint veniam ipsum\",\n \"repeat_password\": \"irure mollit\",\n \"first_name\": \"labore ut sint\",\n \"last_name\": \"commodo est qui sint\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/registrations/users/:user/", "host": ["{{baseUrl}}"], "path": ["registrations", "users", ":user", ""], "variable": [ { "key": "user", "value": "cons", "description": "(Required) " } ] }, "description": "An endpoint for the user account activation." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/registrations/users/:user/", "host": ["{{baseUrl}}"], "path": ["registrations", "users", ":user", ""], "variable": [ { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"Zk2-O39sYMyk@gicPUzlVAnhrOdwsMiSyghSycjJor.ybu\",\n \"password\": \"qui\",\n \"repeat_password\": \"ullamco deserunt\",\n \"name\": \"Duis et incididunt\",\n \"first_name\": \"ut ipsum minim commodo\",\n \"last_name\": \"tempor ex elit officia anim\",\n \"id\": \"urn:uuid:ddb48905-5df4-f20c-2a9a-1eae4fcf0f1d\"\n}" } ] }, { "name": "registrations users set user forgotten password", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"O4A@sZArraGscvQOI.uw\",\n \"password\": \"et sint veniam ipsum\",\n \"repeat_password\": \"irure mollit\",\n \"first_name\": \"labore ut sint\",\n \"last_name\": \"commodo est qui sint\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/registrations/users/:user/forgotten-password/", "host": ["{{baseUrl}}"], "path": [ "registrations", "users", ":user", "forgotten-password", "" ], "variable": [ { "key": "user", "value": "cons", "description": "(Required) " } ] }, "description": "An endpoint for the user account activation." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/registrations/users/:user/forgotten-password/", "host": ["{{baseUrl}}"], "path": [ "registrations", "users", ":user", "forgotten-password", "" ], "variable": [ { "key": "user", "value": "cons", "description": "(Required) " } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"Zk2-O39sYMyk@gicPUzlVAnhrOdwsMiSyghSycjJor.ybu\",\n \"password\": \"qui\",\n \"repeat_password\": \"ullamco deserunt\",\n \"name\": \"Duis et incididunt\",\n \"first_name\": \"ut ipsum minim commodo\",\n \"last_name\": \"tempor ex elit officia anim\",\n \"id\": \"urn:uuid:ddb48905-5df4-f20c-2a9a-1eae4fcf0f1d\"\n}" } ] } ] }, { "name": "registrations invitations read", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/registrations/invitations/:contact/", "host": ["{{baseUrl}}"], "path": ["registrations", "invitations", ":contact", ""], "variable": [ { "key": "contact", "value": "cons", "description": "(Required) " } ] }, "description": "An endpoint for fetching data about invitation activation." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/registrations/invitations/:contact/", "host": ["{{baseUrl}}"], "path": ["registrations", "invitations", ":contact", ""], "variable": [ { "key": "contact", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"d3EfNCJ7Zaz8Xg@KiOVqxXlaixxrxEnQyq.jeu\",\n \"company_id\": \"pariatur ex ut dolore\",\n \"company\": {\n \"name\": \"aute sint non commodo\",\n \"address\": \"nisi\",\n \"postal_code\": \"laborum et ipsum\",\n \"city\": \"cillum Duis\",\n \"branch\": \"magna culpa Lorem\",\n \"address2\": \"tempor nostrud\",\n \"country\": \"CH\",\n \"country_name\": \"veniam occaecat dolore cillum\",\n \"website\": \"in incididunt cupidatat dolor esse\",\n \"vat_number\": \"minim dolor\",\n \"logo\": \"https://sjPZoTJKhTqd.ocacuIbwf0xdyTwbqSpHkiZyesYJMzPowWCMoCn4UbEXX\",\n \"logo_name\": \"minim\",\n \"created\": \"1992-11-24T00:04:43.475Z\",\n \"id\": \"urn:uuid:812edadc-0df5-db53-5db3-86c687937af6\",\n \"verified_bank\": \"sed\",\n \"verified_dnb\": \"occaecat aute\"\n },\n \"my_inbox_id\": \"Duis\",\n \"their_inbox_id\": \"a\",\n \"their_inbox\": {\n \"company\": {\n \"name\": \"ad pariatur\",\n \"address\": \"dolore id\",\n \"postal_code\": \"eu\",\n \"city\": \"Lorem ullamco\",\n \"branch\": \"mollit in ipsum pariatur\",\n \"address2\": \"consectetur ad\",\n \"country\": \"DO\",\n \"country_name\": \"ex\",\n \"website\": \"laboris labore\",\n \"vat_number\": \"adipisicing cupidatat ullamco sit\",\n \"logo\": \"http://OhnLOsuKMMsgPDWbg.eaxJAErqxW2hUR9ikN0CkQ\",\n \"logo_name\": \"non\",\n \"created\": \"1997-04-08T07:57:45.039Z\",\n \"id\": \"4f12e38b-0532-de09-5e14-08738557dbda\",\n \"verified_bank\": \"culpa magna ullamco nisi cillum\",\n \"verified_dnb\": \"irure dolor\"\n },\n \"name\": \"laboris tempor\",\n \"ethereum_address\": \"0x425070A934ED190A15fdeBCA36edF0Ea8Fe481F9\"\n },\n \"message\": \"et eu deserunt laboris\",\n \"note\": \"dolore aliquip\",\n \"invitation_code\": \"proident non do\",\n \"status\": \"accepted\",\n \"created\": \"1988-07-06T20:53:38.131Z\",\n \"created_by_id\": \"elit esse laboris in\",\n \"created_by\": {\n \"email\": \"e1qaeCZwvD0fOz@RkNyN.oibh\",\n \"telephone\": \"velit ut et incididunt laborum\",\n \"name\": \"sed tempor Ut ad\",\n \"first_name\": \"occaecat ut dolore\",\n \"last_name\": \"nulla esse incid\",\n \"company_id\": \"est\",\n \"company\": {\n \"name\": \"deserunt aliqua adipisicing magna commodo\",\n \"address\": \"ad\",\n \"postal_code\": \"reprehenderit Lorem elit\",\n \"city\": \"tempor consectetur ut\",\n \"branch\": \"incididunt\",\n \"address2\": \"nulla dolor pariatur\",\n \"country\": \"PF\",\n \"country_name\": \"voluptate\",\n \"website\": \"consectetur cillum\",\n \"vat_number\": \"do mollit amet eiusmod\",\n \"logo\": \"http://BrpkcNxlbcqaijqgVamSLkZ.bgopvZ3-K5QL7BHD6CLoC3BpNzlpuVwrTm0CF3SV\",\n \"logo_name\": \"eu pariatur\",\n \"created\": \"1973-12-27T00:07:55.441Z\",\n \"id\": \"urn:uuid:e095db6d-79dc-7c28-af28-6e4e34825b3d\",\n \"verified_bank\": \"nisi\",\n \"verified_dnb\": \"labore est deserunt veniam\"\n },\n \"logo\": \"http://Y.qoY+m6u8C0E\",\n \"logo_name\": \"commodo eu minim fugiat\",\n \"id\": \"d50b7796-168b-3941-c9f6-3caa90c7459f\"\n },\n \"resolved\": \"1978-09-14T10:22:49.851Z\",\n \"resolved_by_id\": \"enim ad\",\n \"resolved_by\": {\n \"email\": \"OchlOHMO5@ILgychgOqlizKCmfDAXura.wodc\",\n \"telephone\": \"id aliqua\",\n \"name\": \"ex aliquip ea sit\",\n \"first_name\": \"est\",\n \"last_name\": \"est sit exercitation\",\n \"company_id\": \"incididunt\",\n \"company\": {\n \"name\": \"labore\",\n \"address\": \"dolor ut cupidatat non nostru\",\n \"postal_code\": \"dolore commodo nulla\",\n \"city\": \"velit veniam\",\n \"branch\": \"quis reprehenderit esse\",\n \"address2\": \"veniam sit\",\n \"country\": \"LT\",\n \"country_name\": \"consectetur nisi\",\n \"website\": \"exercitation amet tempor\",\n \"vat_number\": \"reprehenderit elit nulla\",\n \"logo\": \"http://uhGMBZDiIeDHzC.oeezv32eNhxPwBI5cDq3..V4+tGPqcV5bNX2DsBVyxU5bUjqvIWr\",\n \"logo_name\": \"aliqua officia pariatur nulla\",\n \"created\": \"1945-05-07T13:44:10.465Z\",\n \"id\": \"urn:uuid:f3088fcc-e87f-df11-b2a7-06546d7eaa44\",\n \"verified_bank\": \"ut pariatur\",\n \"verified_dnb\": \"fugiat tempor dolor veniam\"\n },\n \"logo\": \"http://RnTYyCercdzWSlqikCEdoTz.xfm+PNfIVLi6pw\",\n \"logo_name\": \"et\",\n \"id\": \"urn:uuid:fe6be31a-93d2-27e1-f61c-2e28a7a6e254\"\n },\n \"resolved_by_company_id\": \"aliqua consequat ut\",\n \"resolved_by_company\": {\n \"name\": \"ut nulla\",\n \"address\": \"incididunt\",\n \"postal_code\": \"sint et sunt\",\n \"city\": \"laborum\",\n \"branch\": \"esse enim qui proident\",\n \"address2\": \"Excepteur nisi mollit\",\n \"country\": \"PH\",\n \"country_name\": \"do ex\",\n \"website\": \"qui adipisicing sunt\",\n \"vat_number\": \"aliquip enim nulla eiusmod\",\n \"logo\": \"https://KoNTCcHmsMrTGrChxxuYhZJngDLwGo.mqlCx+BIL9wBB+Zp+ioT,KQ9ZwY1ftCRLMzngDiq5YvGVOSDQyWzghhK7Oc.5W.XTRU2QHE\",\n \"logo_name\": \"Lorem ullamco ex consequat cupidatat\",\n \"created\": \"2020-07-01T16:57:52.188Z\",\n \"id\": \"389dafae-53dd-0bed-8e5b-a780d4df4db1\",\n \"verified_bank\": \"nostrud\",\n \"verified_dnb\": \"tempor non deserunt nisi do\"\n },\n \"contact_person\": {\n \"email\": \"GW6cW17t@rP.cd\",\n \"telephone\": \"nulla veniam est consequat et\",\n \"name\": \"ea cillum\",\n \"first_name\": \"tempor qui\",\n \"last_name\": \"aliquip amet\",\n \"company_id\": \"consequat officia aliquip fugiat\",\n \"company\": {\n \"name\": \"labore magna officia nulla amet\",\n \"address\": \"Duis dolore veniam est\",\n \"postal_code\": \"enim id\",\n \"city\": \"culpa amet ad et\",\n \"branch\": \"quis Lorem\",\n \"address2\": \"voluptate quis sunt elit\",\n \"country\": \"BS\",\n \"country_name\": \"aliquip aliqua quis qui mollit\",\n \"website\": \"laborum in nulla\",\n \"vat_number\": \"commodo a\",\n \"logo\": \"https://AHGXHDMGYVvOAwlejBNVLTvFHmqIJKG.izVYWUiZauiKlBb\",\n \"logo_name\": \"commodo nostrud sunt ea cillum\",\n \"created\": \"2007-11-05T07:17:28.301Z\",\n \"id\": \"d45a6f64-70e2-4f2a-3835-2696e5a42bf8\",\n \"verified_bank\": \"do proident irure\",\n \"verified_dnb\": \"qui\"\n },\n \"logo\": \"https://DpWoWJmarJZAsvAcMSgnhZ.tuk4352feDYABJYY.xKniMvt.kZ-.ncVi4TncaIyGBSLeiwp3mYqRfGOVy-rJEreKWqB9J+FqqpktHd1s\",\n \"logo_name\": \"Ut do deserunt\",\n \"id\": \"urn:uuid:34f614f0-366c-7a04-742c-4f6a04caafa5\"\n },\n \"id\": \"34c10045-1da5-89c9-424a-3fc501718725\"\n}" } ] } ] }, { "name": "search/envelopes", "item": [ { "name": "List search results", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/search/envelopes/list/?type=cons&is_draft=cons&delivery_status=cons&sent=cons&delivered=cons&archived=cons&sealed=cons&tags=cons&ordering=cons&search=cons&limit=35678520&offset=35678520&company=cons&inbox=cons", "host": ["{{baseUrl}}"], "path": ["search", "envelopes", "list", ""], "query": [ { "key": "type", "value": "cons" }, { "key": "is_draft", "value": "cons" }, { "key": "delivery_status", "value": "cons" }, { "key": "sent", "value": "cons" }, { "key": "delivered", "value": "cons" }, { "key": "archived", "value": "cons" }, { "key": "sealed", "value": "cons" }, { "key": "tags", "value": "cons" }, { "key": "ordering", "value": "cons", "description": "Which field from to use when ordering the results." }, { "key": "search", "value": "cons", "description": "Search in search_text, tags, sender, recipient, document_type." }, { "key": "limit", "value": "35678520", "description": "Number of results to return per page." }, { "key": "offset", "value": "35678520", "description": "The initial index from which to return the results." }, { "key": "company", "value": "cons", "description": "(Required) \nThe string representation of the company UUID.\n" }, { "key": "inbox", "value": "cons", "description": "(Required) \nThe string representation of the company' inbox UUID.\n" } ] }, "description": "Searches the company's envelopes and returns a list of matches." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/search/envelopes/list/?type=cons&is_draft=cons&delivery_status=cons&sent=cons&delivered=cons&archived=cons&sealed=cons&tags=cons&ordering=cons&search=cons&limit=35678520&offset=35678520&company=cons&inbox=cons", "host": ["{{baseUrl}}"], "path": ["search", "envelopes", "list", ""], "query": [ { "key": "type", "value": "cons" }, { "key": "is_draft", "value": "cons" }, { "key": "delivery_status", "value": "cons" }, { "key": "sent", "value": "cons" }, { "key": "delivered", "value": "cons" }, { "key": "archived", "value": "cons" }, { "key": "sealed", "value": "cons" }, { "key": "tags", "value": "cons" }, { "key": "ordering", "value": "cons" }, { "key": "search", "value": "cons" }, { "key": "limit", "value": "35678520" }, { "key": "offset", "value": "35678520" }, { "key": "company", "value": "cons" }, { "key": "inbox", "value": "cons" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 45249198,\n \"results\": [\n {\n \"id\": \"tempor deserunt ad\",\n \"owner_id\": \"sed\",\n \"type\": \"proident eiusmod Lorem dolore\",\n \"is_draft\": true,\n \"sent\": \"2015-11-29\",\n \"delivered\": \"2021-08-24\",\n \"archived\": \"1949-04-28\",\n \"sealed\": false,\n \"created\": \"1985-03-09\"\n },\n {\n \"id\": \"culpa\",\n \"owner_id\": \"exercitation\",\n \"type\": \"enim in qui\",\n \"is_draft\": false,\n \"sent\": \"2020-03-12\",\n \"delivered\": \"2010-09-03\",\n \"archived\": \"1945-02-18\",\n \"sealed\": true,\n \"created\": \"1980-06-10\"\n }\n ],\n \"next\": \"http://MWEqwaAvowaGUnvYKBnBab.cdBY.iCP.7OglbGTrvkRWVOUui9,arMSU\",\n \"previous\": \"https://OOwZyldegqkkvgxWXDPdYJQcBXmNEGH.fshBsgv.AgRujvSO.iayAOp1Jh9JtMfG6veIz4rrNr\"\n}" } ] }, { "name": "search envelopes read", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/search/envelopes/:id/", "host": ["{{baseUrl}}"], "path": ["search", "envelopes", ":id", ""], "variable": [ { "key": "id", "value": "cons", "description": "(Required) " } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/search/envelopes/:id/", "host": ["{{baseUrl}}"], "path": ["search", "envelopes", ":id", ""], "variable": [ { "key": "id", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"aute dolor ullamco\",\n \"owner_id\": \"sunt eu sed nulla\",\n \"type\": \"veniam qui in\",\n \"is_draft\": true,\n \"sent\": \"1986-02-08\",\n \"delivered\": \"1954-03-09\",\n \"archived\": \"1979-05-28\",\n \"sealed\": true,\n \"created\": \"1950-02-11\"\n}" } ] } ] }, { "name": "service", "item": [ { "name": "Get API health", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/service/health/list/", "host": ["{{baseUrl}}"], "path": ["service", "health", "list", ""] }, "description": "Retrieve the information about API health." }, "response": [ { "name": "Returned when the API is available.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/service/health/list/", "host": ["{{baseUrl}}"], "path": ["service", "health", "list", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Get API status", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/service/ping/list/", "host": ["{{baseUrl}}"], "path": ["service", "ping", "list", ""] }, "description": "Retrieve the information if the API is available or not. This endpoint returns the status \n of the API." }, "response": [ { "name": "Returned when the API is available.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/service/ping/list/", "host": ["{{baseUrl}}"], "path": ["service", "ping", "list", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Get complete changelog", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/changelog/list/", "host": ["{{baseUrl}}"], "path": ["changelog", "list", ""] }, "description": "Returns a list of all changelog files." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/changelog/list/", "host": ["{{baseUrl}}"], "path": ["changelog", "list", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Generate email verification code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "email", "value": "Lorem aute cupidatat proident", "description": "(Required) Email address to be verified" } ] }, "url": { "raw": "{{baseUrl}}/email/verification/", "host": ["{{baseUrl}}"], "path": ["email", "verification", ""] }, "description": "Generates an email verification code that is sent to the user's email address. \n This endpoint returns email verification identifier hash." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "email", "value": "Lorem aute cupidatat proident", "description": "(Required) Email address to be verified" } ] }, "url": { "raw": "{{baseUrl}}/email/verification/", "host": ["{{baseUrl}}"], "path": ["email", "verification", ""] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": \"6XPANH@eJuyeWFDijmGgjQeGRQMG.bit\",\n \"id\": \"a491a274-7b30-9204-9b8e-7bb11c47bcd4\",\n \"is_verified\": true,\n \"valid_until\": \"1975-09-09T10:01:14.112Z\",\n \"verification_hash\": \"4f54d81c-b467-6298-2b70-796495fc8ada\"\n}" }, { "name": "Returned when email parameter is invalid.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "email", "value": "Lorem aute cupidatat proident", "description": "(Required) Email address to be verified" } ] }, "url": { "raw": "{{baseUrl}}/email/verification/", "host": ["{{baseUrl}}"], "path": ["email", "verification", ""] } }, "code": 471, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Retrieve logo", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/logos/:logo/", "host": ["{{baseUrl}}"], "path": ["logos", ":logo", ""], "variable": [ { "key": "blockchain_key", "value": "cons", "description": "(Required) \nThe logo model identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|---------------------------|-----------------------------------------------------------------------------------------------|\n| `by-user-id/{id}` | Determine user logo by its model ID. Replace `{id}` with internal user key id. |\n| `by-company-id/{id}` | Determine company logo by its model ID. Replace `{id}` with internal company key id. |\n" }, { "key": "logo", "value": "cons", "description": "(Required) " } ] }, "description": "Retrieves company or user logo and returns it in binary format." }, "response": [ { "name": "Returns logo in binary format.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/logos/:logo/", "host": ["{{baseUrl}}"], "path": ["logos", ":logo", ""], "variable": [ { "key": "blockchain_key", "value": "cons", "description": "(Required) \nThe logo model identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|---------------------------|-----------------------------------------------------------------------------------------------|\n| `by-user-id/{id}` | Determine user logo by its model ID. Replace `{id}` with internal user key id. |\n| `by-company-id/{id}` | Determine company logo by its model ID. Replace `{id}` with internal company key id. |\n" }, { "key": "logo", "value": "cons", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Returned when logo is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/logos/:logo/", "host": ["{{baseUrl}}"], "path": ["logos", ":logo", ""], "variable": [ { "key": "blockchain_key", "value": "cons", "description": "(Required) \nThe logo model identification parameter. See below for detailed explanation.\n\n| Parameter | Description |\n|---------------------------|-----------------------------------------------------------------------------------------------|\n| `by-user-id/{id}` | Determine user logo by its model ID. Replace `{id}` with internal user key id. |\n| `by-company-id/{id}` | Determine company logo by its model ID. Replace `{id}` with internal company key id. |\n" }, { "key": "logo", "value": "cons", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Exporters lookup", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/lookup/exporters/list/?country_code=cons&cargox_id=cons®istration_number=cons&vat_number=cons&duns_number=cons&lei_number=cons&eori_number=cons&verified_dnb=true&verified_band=true", "host": ["{{baseUrl}}"], "path": ["lookup", "exporters", "list", ""], "query": [ { "key": "country_code", "value": "cons", "description": "(Required) \nThe exporter ISO 3166-1 alpha-2 country code.\n" }, { "key": "cargox_id", "value": "cons", "description": "\nThe string value of the UUID-4 number assigned by CargoX that uniquely identifies an organization.\n" }, { "key": "registration_number", "value": "cons", "description": "\nThe registration number is assigned by an external body and uniquely identifies an organization.\n" }, { "key": "vat_number", "value": "cons", "description": "\nThe VAT number is assigned by an external body and uniquely identifies an organization.\n" }, { "key": "duns_number", "value": "cons", "description": "\nThe DUNS number is assigned by an external body and uniquely identifies an organization.\n" }, { "key": "lei_number", "value": "cons", "description": "\nThe LEI number is assigned by an external body and uniquely identifies an organization.\n" }, { "key": "eori_number", "value": "cons", "description": "\nThe EORI number is assigned by an external body and uniquely identifies an organization.\n" }, { "key": "verified_dnb", "value": "true", "description": "\nAllows querying exporters whose company details have been verified by CargoX via Duns & Bradstreet service.\n" }, { "key": "verified_band", "value": "true", "description": "\nAllows querying exporters whose company details have been verified by CargoX via bank transfer.\n" } ] }, "description": "Returns a list of exporters that match query conditions.\n\nCountry code parameter is required along with at least one other parameter." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/lookup/exporters/list/?country_code=cons&cargox_id=cons®istration_number=cons&vat_number=cons&duns_number=cons&lei_number=cons&eori_number=cons&verified_dnb=true&verified_band=true", "host": ["{{baseUrl}}"], "path": ["lookup", "exporters", "list", ""], "query": [ { "key": "country_code", "value": "cons" }, { "key": "cargox_id", "value": "cons" }, { "key": "registration_number", "value": "cons" }, { "key": "vat_number", "value": "cons" }, { "key": "duns_number", "value": "cons" }, { "key": "lei_number", "value": "cons" }, { "key": "eori_number", "value": "cons" }, { "key": "verified_dnb", "value": "true" }, { "key": "verified_band", "value": "true" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"matches_count\": 76042170,\n \"matches\": [\n {\n \"name\": \"culpa in velit\",\n \"branch\": \"velit irure\",\n \"address\": \"dolore reprehenderit nisi\",\n \"address2\": \"in elit cillum\",\n \"postal_code\": \"ut proident in laborum\",\n \"city\": \"ea sunt reprehenderit\",\n \"name_latin\": \"cupidatat Ut occaecat\",\n \"address_latin\": \"reprehenderit Lorem\",\n \"postal_code_latin\": \"aute proident aliquip\",\n \"city_latin\": \"cillum ullamco\",\n \"country\": \"FJ\",\n \"country_name\": \"incididunt tempor consectetur in\",\n \"telephone\": \"sed voluptate non\",\n \"website\": \"Lorem\",\n \"cargox_id\": \"et ipsum laborum sed ut\",\n \"registration_number\": \"deserunt amet sunt Ut\",\n \"company_vat_number\": \"Ut \",\n \"vat_number\": \"incididunt proident\",\n \"additional_vats\": [\n {\n \"country\": \"CD\",\n \"vat_number\": \"aute Duis minim labore\",\n \"country_name\": \"et Lorem ullamco veniam\",\n \"verified_vies\": \"dolor laborum cupidatat\"\n },\n {\n \"country\": \"BZ\",\n \"vat_number\": \"sunt amet\",\n \"country_name\": \"Ut laboris\",\n \"verified_vies\": \"ea\"\n }\n ],\n \"duns_number\": \"officia Lorem esse\",\n \"lei_number\": \"laborum sint dolore Excepteur\",\n \"eori_number\": \"pariatur proident\",\n \"verified_dnb\": \"1959-04-27T03:44:19.568Z\",\n \"verified_vies\": \"1971-02-19T15:12:33.996Z\",\n \"verified_bank\": \"1970-10-21T15:01:00.736Z\",\n \"logo\": \"http://xFGKbOKAdEREuAsAaCuq.alwNkZ4hndGWlkGCcFMHBZGw1tbsplYagjzHf+r8\",\n \"merged_ids\": [\n {\n \"merged_id\": \"0dfbc060-f8a0-a91f-93b1-3ff8dc6e87c4\"\n },\n {\n \"merged_id\": \"38abae49-a7f2-f798-208b-2e1fa7146480\"\n }\n ]\n },\n {\n \"name\": \"culpa proident\",\n \"branch\": \"id labore incididunt officia sed\",\n \"address\": \"pariatur\",\n \"address2\": \"reprehenderit est\",\n \"postal_code\": \"Excepteur id exercitation\",\n \"city\": \"Lorem consequat\",\n \"name_latin\": \"amet minim dolor aute proident\",\n \"address_latin\": \"minim veniam in Lorem\",\n \"postal_code_latin\": \"proident velit minim\",\n \"city_latin\": \"do\",\n \"country\": \"PH\",\n \"country_name\": \"sit sed irure\",\n \"telephone\": \"amet nulla fugiat qui ullamco\",\n \"website\": \"ut voluptate non\",\n \"cargox_id\": \"dolor eu\",\n \"registration_number\": \"enim deserunt officia\",\n \"company_vat_number\": \"sed consequat\",\n \"vat_number\": \"Duis dolore est pro\",\n \"additional_vats\": [\n {\n \"country\": \"EC\",\n \"vat_number\": \"nostrud dolore mollit quis\",\n \"country_name\": \"anim et\",\n \"verified_vies\": \"ipsum\"\n },\n {\n \"country\": \"MV\",\n \"vat_number\": \"magna Excepteur reprehenderit ex commodo\",\n \"country_name\": \"fugiat aute irure qui\",\n \"verified_vies\": \"nisi in qui\"\n }\n ],\n \"duns_number\": \"irure Ut\",\n \"lei_number\": \"aliqua cupidatat Ut\",\n \"eori_number\": \"amet et\",\n \"verified_dnb\": \"1958-07-25T18:58:31.902Z\",\n \"verified_vies\": \"2012-05-05T10:11:04.343Z\",\n \"verified_bank\": \"1959-04-25T19:52:47.508Z\",\n \"logo\": \"https://clAiULpUzQCPVApHqJFxnglknwdwuS.vpoWVTDTxMMP\",\n \"merged_ids\": [\n {\n \"merged_id\": \"urn:uuid:55bbebcf-79a5-56c3-a37f-5aadca2c9698\"\n },\n {\n \"merged_id\": \"b51a4525-0305-8252-1351-62485511e2f0\"\n }\n ]\n }\n ]\n}" } ] }, { "name": "request-headers list list", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/request-headers/list/", "host": ["{{baseUrl}}"], "path": ["request-headers", "list", ""] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/request-headers/list/", "host": ["{{baseUrl}}"], "path": ["request-headers", "list", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Get Terms and conditions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/terms-and-conditions/list/", "host": ["{{baseUrl}}"], "path": ["terms-and-conditions", "list", ""] }, "description": "\nGet the (latest) terms and conditions for CargoX Platform. Returns a list containing exactly one element -- the\ncurrently valid terms and conditions, along with the time the terms were entered into the system.\n" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/terms-and-conditions/list/", "host": ["{{baseUrl}}"], "path": ["terms-and-conditions", "list", ""] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"content\": \"ex\",\n \"id\": \"49e594ca-d195-4861-a68a-234b0ad90a1d\",\n \"created\": \"1980-05-30T10:22:56.417Z\"\n}" } ] } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "{{access_token_url}}", "type": "string" }, { "key": "clientId", "value": "{{client_id}}", "type": "string" }, { "key": "client_authentication", "value": "body", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" }, { "key": "tokenName", "value": "Bearer", "type": "string" }, { "key": "clientSecret", "value": "{{client_secret}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [""] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [""] } } ], "variable": [ { "key": "baseUrl", "value": "https://cargox.digital/api/v3/" }, { "key": "client_id", "value": "*client_id*" }, { "key": "client_secret", "value": "*client_secret*" }, { "key": "access_token_url", "value": "https://cargox.digital/oauth/token/" } ] }