{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "api.signteq.io" } ], "info": { "name": "signteq.io API", "_postman_id": "f90c6df0-953b-4abc-9831-f888b6cbc5ad", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Documents", "description": "\nWhen you create a request, you need to upload documents to be signed. With the following \/document endpoints you can access or download theese documents.", "item": [ { "name": "Get Document", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/documents\/:document", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/documents\/:document", "variable": [ { "id": "document", "key": "document", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the document." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "name": "Get Document Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/documents\/:document", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/documents\/:document", "variable": [ { "id": "document", "key": "document", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the document." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "header": null, "cookie": [], "body": "{\n \"id\": null,\n \"name\": \"Harum rerum corporis alias quis id enim quo..pdf\",\n \"size\": 12655,\n \"type\": \"pdf\",\n \"meta\": null,\n \"versions\": [],\n \"pages\": []\n}" } ] }, { "name": "Download Document", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/documents\/:document\/download", "query": [ { "key": "type", "value": "completed", "description": "Either original or completed.", "disabled": false } ], "raw": "https:\/\/{{baseUrl}}\/v1\/documents\/:document\/download?type=completed", "variable": [ { "id": "document", "key": "document", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the document." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "name": "Download Document Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/documents\/:document\/download", "query": [ { "key": "type", "value": "completed", "description": "Either original or completed.", "disabled": false } ], "raw": "https:\/\/{{baseUrl}}\/v1\/documents\/:document\/download?type=completed", "variable": [ { "id": "document", "key": "document", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the document." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "header": null, "cookie": [], "body": "null" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "v1\/ekyc\/verify", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/ekyc\/verify", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/ekyc\/verify" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "v1\/ksv\/report", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/ksv\/report", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/ksv\/report" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "v1\/address\/verify", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/address\/verify", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/address\/verify" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "v1\/data\/sanitize", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/data\/sanitize", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/data\/sanitize" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Organization Settings", "description": "", "item": [ { "name": "Get Organization Notifications", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization\/notifications", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization\/notifications", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "name": "Get Organization Notifications Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization\/notifications", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization\/notifications", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "header": null, "cookie": [], "body": "{\n \"recipient_reminder\": null,\n \"document_viewed\": null,\n \"document_signed\": null,\n \"document_declined\": null,\n \"document_completed\": null,\n \"copy_document_completed\": null,\n \"copy_recipients_document_completed\": null\n}" } ] }, { "name": "Update Organization Notifications", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization\/notifications", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization\/notifications", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipient_reminder\": false,\n \"document_viewed\": true,\n \"document_signed\": false,\n \"document_declined\": false,\n \"document_completed\": false,\n \"copy_document_completed\": false,\n \"copy_recipients_document_completed\": false\n}" }, "description": "Updates the specified organization notification settings by setting the values of the parameters passed. Any parameters not provided will be left unchanged." }, "response": [ { "name": "Update Organization Notifications Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization\/notifications", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization\/notifications", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipient_reminder\": false,\n \"document_viewed\": true,\n \"document_signed\": false,\n \"document_declined\": false,\n \"document_completed\": false,\n \"copy_document_completed\": false,\n \"copy_recipients_document_completed\": false\n}" }, "description": "Updates the specified organization notification settings by setting the values of the parameters passed. Any parameters not provided will be left unchanged." }, "header": null, "cookie": [], "body": "{\n \"recipient_reminder\": null,\n \"document_viewed\": null,\n \"document_signed\": null,\n \"document_declined\": null,\n \"document_completed\": null,\n \"copy_document_completed\": null,\n \"copy_recipients_document_completed\": null\n}" } ] }, { "name": "Get Organization Signature Settings", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization\/signatures", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization\/signatures", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "name": "Get Organization Signature Settings Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization\/signatures", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization\/signatures", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "header": null, "cookie": [], "body": "{\n \"allow_draw\": null,\n \"allow_type\": null,\n \"allow_upload\": null,\n \"allow_mobilephone\": null,\n \"include_document_id\": null,\n \"include_docutrust_seal\": null\n}" } ] }, { "name": "Update Organization Signature Settings", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization\/signatures", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization\/signatures", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"signature_settings\": {\n \"allow_draw\": false,\n \"allow_type\": false,\n \"allow_upload\": false,\n \"allow_mobilephone\": false,\n \"include_document_id\": false,\n \"include_docutrust_seal\": false\n },\n \"document_password\": {\n \"password\": \"dolor\",\n \"encryption_level\": \"256\"\n },\n \"allow_draw\": true,\n \"allow_type\": true,\n \"allow_upload\": true,\n \"allow_mobilephone\": true,\n \"include_document_id\": false,\n \"include_docutrust_seal\": true\n}" }, "description": "Updates the specified organization signature settings by setting the values of the parameters passed. Any parameters not provided will be left unchanged." }, "response": [ { "name": "Update Organization Signature Settings Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization\/signatures", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization\/signatures", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"signature_settings\": {\n \"allow_draw\": false,\n \"allow_type\": false,\n \"allow_upload\": false,\n \"allow_mobilephone\": false,\n \"include_document_id\": false,\n \"include_docutrust_seal\": false\n },\n \"document_password\": {\n \"password\": \"dolor\",\n \"encryption_level\": \"256\"\n },\n \"allow_draw\": true,\n \"allow_type\": true,\n \"allow_upload\": true,\n \"allow_mobilephone\": true,\n \"include_document_id\": false,\n \"include_docutrust_seal\": true\n}" }, "description": "Updates the specified organization signature settings by setting the values of the parameters passed. Any parameters not provided will be left unchanged." }, "header": null, "cookie": [], "body": "{\n \"allow_draw\": null,\n \"allow_type\": null,\n \"allow_upload\": null,\n \"allow_mobilephone\": null,\n \"include_document_id\": null,\n \"include_docutrust_seal\": null\n}" } ] }, { "name": "Get Organization Branding", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization\/branding", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization\/branding", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "name": "Get Organization Branding Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization\/branding", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization\/branding", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "header": null, "cookie": [], "body": "{\n \"primary_bg_color\": null,\n \"logo_online_light\": null,\n \"logo_online_dark\": null,\n \"logo_email\": null\n}" } ] }, { "name": "Update Organization Branding", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization\/branding", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization\/branding", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "primary_bg_color", "value": "#bb0000", "type": "text" }, { "key": "logo_online_light", "src": [], "type": "file" }, { "key": "logo_online_dark", "src": [], "type": "file" }, { "key": "logo_email", "src": [], "type": "file" } ] }, "description": "Updates the specified organizations branding settings by setting the values of the parameters passed. Any parameters not provided will be left unchanged." }, "response": [ { "name": "Update Organization Branding Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization\/branding", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization\/branding", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "primary_bg_color", "value": "#bb0000", "type": "text" }, { "key": "logo_online_light", "src": [], "type": "file" }, { "key": "logo_online_dark", "src": [], "type": "file" }, { "key": "logo_email", "src": [], "type": "file" } ] }, "description": "Updates the specified organizations branding settings by setting the values of the parameters passed. Any parameters not provided will be left unchanged." }, "header": null, "cookie": [], "body": "{\n \"primary_bg_color\": null,\n \"logo_online_light\": null,\n \"logo_online_dark\": null,\n \"logo_email\": null\n}" } ] }, { "name": "Get Organization Stamp", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization\/stamp", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization\/stamp", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "name": "Get Organization Stamp Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization\/stamp", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization\/stamp", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "header": null, "cookie": [], "body": "null" } ] }, { "name": "Update Organization Stamp", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization\/stamp", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization\/stamp", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "stamp", "src": [], "type": "file" } ] }, "description": "Updates the specified organization stamp." }, "response": [ { "name": "Update Organization Stamp Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization\/stamp", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization\/stamp", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "stamp", "src": [], "type": "file" } ] }, "description": "Updates the specified organization stamp." }, "header": null, "cookie": [], "body": "null" } ] }, { "name": "Delete Organization Stamp", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization\/stamp", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization\/stamp", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the specified organization stamp." }, "response": [ { "name": "Delete Organization Stamp Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization\/stamp", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization\/stamp", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the specified organization stamp." }, "header": null, "cookie": [], "body": "{}" } ] } ] }, { "name": "Organizations", "description": "\nsignteq is multi-organizations capable. All requests, documents, recipients, etc. are not only assigned to a user but also to a specific organization.", "item": [ { "name": "List Organizations", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all of your organizations associated with an account." }, "response": [ { "name": "List Organizations Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all of your organizations associated with an account." }, "header": null, "cookie": [], "body": "[\n {\n \"id\": \"48f43beb-38d0-4e08-b782-67b4362390fa\",\n \"created_at\": \"2022-09-07T13:50:10.000000Z\",\n \"updated_at\": \"2022-09-07T13:50:10.000000Z\",\n \"name\": \"Streich-Ward\",\n \"sender_name\": null,\n \"reply_to\": null\n },\n {\n \"id\": \"1e18a4f8-acba-410e-9ff4-ad8d5a9dd510\",\n \"created_at\": \"2022-09-07T13:50:10.000000Z\",\n \"updated_at\": \"2022-09-07T13:50:10.000000Z\",\n \"name\": \"Wisozk, Schroeder and Farrell\",\n \"sender_name\": null,\n \"reply_to\": null\n }\n]" } ] }, { "name": "Create Organization", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Demo GmbH\",\n \"sender_name\": \"Demo\",\n \"reply_to\": \"demo@example.com\"\n}" }, "description": "Please note that when you create organizations, a booking (according to the signteq.io price list) is initiated and a monthly subscription is created." }, "response": [ { "name": "Create Organization Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Demo GmbH\",\n \"sender_name\": \"Demo\",\n \"reply_to\": \"demo@example.com\"\n}" }, "description": "Please note that when you create organizations, a booking (according to the signteq.io price list) is initiated and a monthly subscription is created." }, "header": null, "cookie": [], "body": "{\n \"id\": \"2f311495-b721-46e8-8129-9cd756f9ae19\",\n \"created_at\": \"2022-09-07T13:50:10.000000Z\",\n \"updated_at\": \"2022-09-07T13:50:10.000000Z\",\n \"name\": \"Thompson-Zulauf\",\n \"sender_name\": null,\n \"reply_to\": null\n}" } ] }, { "name": "Get Organization", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves the details of an existing organization. You only need to supply the unique organization identifier." }, "response": [ { "name": "Get Organization Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves the details of an existing organization. You only need to supply the unique organization identifier." }, "header": null, "cookie": [], "body": "{\n \"id\": \"8612f06d-06bc-4056-b859-96243453265f\",\n \"created_at\": \"2022-09-07T13:50:10.000000Z\",\n \"updated_at\": \"2022-09-07T13:50:10.000000Z\",\n \"name\": \"Kirlin and Sons\",\n \"sender_name\": null,\n \"reply_to\": null\n}" } ] }, { "name": "Update Organization", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Demo GmbH\",\n \"sender_name\": \"Demo\",\n \"reply_to\": \"demo@example.com\"\n}" }, "description": "Updates the specified organization by setting the values of the parameters passed. Any parameters not provided will be left unchanged." }, "response": [ { "name": "Update Organization Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Demo GmbH\",\n \"sender_name\": \"Demo\",\n \"reply_to\": \"demo@example.com\"\n}" }, "description": "Updates the specified organization by setting the values of the parameters passed. Any parameters not provided will be left unchanged." }, "header": null, "cookie": [], "body": "{\n \"id\": \"7118c80b-ba24-4f1b-8c07-b61007b71799\",\n \"created_at\": \"2022-09-07T13:50:10.000000Z\",\n \"updated_at\": \"2022-09-07T13:50:10.000000Z\",\n \"name\": \"Deckow and Sons\",\n \"sender_name\": null,\n \"reply_to\": null\n}" } ] }, { "name": "Delete Organization", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Permanently deletes a organization. This cannot be undone. Also immediately cancels all outstanding requests from the organization. If you delete an organization, the associated billing plan will be canceled at the end of the current period." }, "response": [ { "name": "Delete Organization Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/organizations\/:organization", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/organizations\/:organization", "variable": [ { "id": "organization", "key": "organization", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the organization." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Permanently deletes a organization. This cannot be undone. Also immediately cancels all outstanding requests from the organization. If you delete an organization, the associated billing plan will be canceled at the end of the current period." }, "header": null, "cookie": [], "body": "{}" } ] } ] }, { "name": "Recipients", "description": "", "item": [ { "name": "List Recipients", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/recipients", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/recipients" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated<\/a> list of your recipients." }, "response": [ { "name": "List Recipients Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/recipients", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/recipients" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated<\/a> list of your recipients." }, "header": null, "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"3f874027-2451-4e78-a67b-cec93d43fb18\",\n \"email\": \"xcollins@example.org\",\n \"name\": \"Ellis Wehner\",\n \"phonenumber\": null\n },\n {\n \"id\": \"70840e63-d9ff-4c0b-8092-592519230853\",\n \"email\": \"anissa11@example.com\",\n \"name\": \"Holden Wilkinson\",\n \"phonenumber\": null\n }\n ],\n \"links\": {\n \"first\": \"\\\/?page=1\",\n \"last\": \"\\\/?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Zur\\u00fcck\",\n \"active\": false\n },\n {\n \"url\": \"\\\/?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Weiter »\",\n \"active\": false\n }\n ],\n \"path\": \"\\\/\",\n \"per_page\": \"15\",\n \"to\": 2,\n \"total\": 2\n }\n}" } ] }, { "name": "Create Recipient", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/recipients", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/recipients" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"phonenumber\": \"+43 664 123 456\"\n}" }, "description": "" }, "response": [ { "name": "Create Recipient Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/recipients", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/recipients" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"phonenumber\": \"+43 664 123 456\"\n}" }, "description": "" }, "header": null, "cookie": [], "body": "{\n \"id\": \"f5f7ff37-8c6d-4fb4-8c52-50cb6afd94a1\",\n \"email\": \"emard.lera@example.com\",\n \"name\": \"Noelia White\",\n \"phonenumber\": null\n}" } ] }, { "name": "Get Recipient", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/recipients\/:recipient", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/recipients\/:recipient", "variable": [ { "id": "recipient", "key": "recipient", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the recipient." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves the details of an existing recipient. You need only supply the unique recipient identifier." }, "response": [ { "name": "Get Recipient Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/recipients\/:recipient", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/recipients\/:recipient", "variable": [ { "id": "recipient", "key": "recipient", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the recipient." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves the details of an existing recipient. You need only supply the unique recipient identifier." }, "header": null, "cookie": [], "body": "{\n \"id\": \"d43ef57c-c927-47db-b408-1b49f997ad0c\",\n \"email\": \"fredy60@example.net\",\n \"name\": \"Montana Hayes\",\n \"phonenumber\": null\n}" } ] }, { "name": "Update Recipient", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/recipients\/:recipient", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/recipients\/:recipient", "variable": [ { "id": "recipient", "key": "recipient", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the recipient." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"laborum\"\n}" }, "description": "" }, "response": [ { "name": "Update Recipient Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/recipients\/:recipient", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/recipients\/:recipient", "variable": [ { "id": "recipient", "key": "recipient", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the recipient." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"laborum\"\n}" }, "description": "" }, "header": null, "cookie": [], "body": "{\n \"id\": \"3cfcd90e-a724-4232-a9cf-e9a3922849e2\",\n \"email\": \"vschultz@example.org\",\n \"name\": \"Major Gutkowski\",\n \"phonenumber\": null\n}" } ] }, { "name": "Delete Recipient", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/recipients\/:recipient", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/recipients\/:recipient", "variable": [ { "id": "recipient", "key": "recipient", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the recipient." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "name": "Delete Recipient Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/recipients\/:recipient", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/recipients\/:recipient", "variable": [ { "id": "recipient", "key": "recipient", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the recipient." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "header": null, "cookie": [], "body": "{}" } ] } ] }, { "name": "Requests", "description": "\nIn order to obtain signatures or send documents, you must create a request. Any number of documents can be attached to this request.", "item": [ { "name": "List Requests", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/requests", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/requests", "variable": [ { "id": "state", "key": "state", "value": "earum", "description": "The state of the request. One of trashed<\/code>, draft<\/code>, sent<\/code>, completed<\/code>, declined<\/code>, canceled<\/code>." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated<\/a> list of your requests. The requests are returned sorted by creation date,\nwith the most recent request appearing first. By appending the API's state<\/code>\nparameter to the API request URL and setting it to a request status you can filter your results accordingly." }, "response": [ { "name": "List Requests Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/requests", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/requests", "variable": [ { "id": "state", "key": "state", "value": "earum", "description": "The state of the request. One of trashed<\/code>, draft<\/code>, sent<\/code>, completed<\/code>, declined<\/code>, canceled<\/code>." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated<\/a> list of your requests. The requests are returned sorted by creation date,\nwith the most recent request appearing first. By appending the API's state<\/code>\nparameter to the API request URL and setting it to a request status you can filter your results accordingly." }, "header": null, "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"4be02d1d-f05a-44a7-bcaf-2ec9bbf810b8\",\n \"type\": \"signature\",\n \"subject\": \"Impedit et sint aut voluptatum quia.\",\n \"message\": \"Quia distinctio quidem voluptatibus consequatur ea debitis consectetur. Aliquam voluptas illum deleniti sint maiores quidem. Nisi sunt eaque omnis nulla laborum voluptatibus. Hic repudiandae est deleniti officia qui accusamus.\",\n \"sandbox\": null,\n \"created_at\": \"2022-09-07T15:50:10+02:00\",\n \"updated_at\": \"2022-09-07T15:50:10+02:00\",\n \"canceled_at\": null,\n \"released_at\": null,\n \"declined_at\": null,\n \"completed_at\": null,\n \"settings\": {\n \"deadline_at\": \"2022-09-09T15:50:10+02:00\",\n \"auto_reminders\": true,\n \"retention_policy\": null,\n \"delete_after_download\": false,\n \"copy_document_completed\": true,\n \"copy_recipients_document_completed\": true,\n \"close_on_success\": false,\n \"redirect_success_url\": null,\n \"redirect_error_url\": null\n },\n \"meta\": null\n },\n {\n \"id\": \"502e2ed6-ae19-492b-84b5-024ff8be9ac4\",\n \"type\": \"signature\",\n \"subject\": \"Impedit velit quo dolorem sed ea voluptatum similique.\",\n \"message\": \"Eaque saepe sed earum est dolorem eum. Autem qui aut dolores velit voluptas. Aut similique est sed aut odit sed aliquid vitae.\",\n \"sandbox\": null,\n \"created_at\": \"2022-09-07T15:50:10+02:00\",\n \"updated_at\": \"2022-09-07T15:50:10+02:00\",\n \"canceled_at\": null,\n \"released_at\": null,\n \"declined_at\": null,\n \"completed_at\": null,\n \"settings\": {\n \"deadline_at\": \"2022-10-04T15:50:10+02:00\",\n \"auto_reminders\": true,\n \"retention_policy\": null,\n \"delete_after_download\": false,\n \"copy_document_completed\": true,\n \"copy_recipients_document_completed\": true,\n \"close_on_success\": false,\n \"redirect_success_url\": null,\n \"redirect_error_url\": null\n },\n \"meta\": null\n }\n ],\n \"links\": {\n \"first\": \"\\\/?page=1\",\n \"last\": \"\\\/?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Zur\\u00fcck\",\n \"active\": false\n },\n {\n \"url\": \"\\\/?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Weiter »\",\n \"active\": false\n }\n ],\n \"path\": \"\\\/\",\n \"per_page\": \"15\",\n \"to\": 2,\n \"total\": 2\n }\n}" } ] }, { "name": "Create Request", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/requests", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/requests" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"signature\",\n \"subject\": \"Non-disclosure agreement\",\n \"message\": \"Hi John, please sign the NDA. If you have any questions, feel free to contact me.\",\n \"settings\": {\n \"deadline_at\": \"2021-09-26T21:40:29+02:00\",\n \"auto_reminders\": false,\n \"copy_document_completed\": true,\n \"copy_recipients_document_completed\": false,\n \"retention_policy\": 30,\n \"delete_after_download\": true,\n \"close_on_success\": false,\n \"redirect_success_url\": \"https:\\\/\\\/example.com\\\/redirect\",\n \"redirect_error_url\": \"https:\\\/\\\/example.com\\\/redirect\"\n },\n \"meta\": {\n \"internal_id\": 123\n },\n \"documents\": [\n {\n \"name\": \"voluptatem\",\n \"html\": {\n \"0\": {\n \"content\": \"sequi\",\n \"orientation\": \"quia\",\n \"size\": \"eius\"\n },\n \"1\": [],\n \"content\": \"molestiae\",\n \"orientation\": \"landscape\",\n \"size\": \"c6\"\n },\n \"fields\": [\n {\n \"anchor\": \"a\",\n \"anchor_position\": \"TOP\",\n \"page\": 1,\n \"type\": \"signature\",\n \"width\": 200,\n \"height\": 9,\n \"x\": 550,\n \"y\": 200,\n \"required\": true,\n \"read_only\": false,\n \"value\": \"rem\",\n \"placeholder\": \"Your Name\",\n \"meta\": {\n \"font\": \"Arial\",\n \"font_size\": 16,\n \"line_height\": 18,\n \"bold\": false,\n \"italic\": \"false\",\n \"underline\": \"false\"\n },\n \"recipient_id\": \"123\"\n },\n []\n ],\n \"meta\": []\n },\n {\n \"name\": \"voluptatem\",\n \"fields\": [\n [],\n []\n ],\n \"meta\": []\n }\n ],\n \"recipients\": [\n {\n \"id\": \"1\",\n \"type\": \"signatory\",\n \"email\": \"john@example.com\",\n \"name\": \"John Doe\",\n \"access_pin\": \"1234\",\n \"phonenumber\": \"+43 664 123 456\",\n \"do_not_notify\": true,\n \"language\": \"ipsa\",\n \"notification_phonenumber\": \"odit\",\n \"notification_channels\": \"maiores\"\n },\n {\n \"id\": \"1\",\n \"type\": \"signatory\",\n \"email\": \"john@example.com\",\n \"name\": \"John Doe\",\n \"do_not_notify\": true,\n \"language\": \"ipsa\",\n \"notification_phonenumber\": \"odit\",\n \"notification_channels\": \"maiores\"\n }\n ]\n}" }, "description": "There are two types of requests. Requesting signatures (signature<\/code>) or sending documents (information<\/code>)." }, "response": [ { "name": "Create Request Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/requests", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/requests" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"signature\",\n \"subject\": \"Non-disclosure agreement\",\n \"message\": \"Hi John, please sign the NDA. If you have any questions, feel free to contact me.\",\n \"settings\": {\n \"deadline_at\": \"2021-09-26T21:40:29+02:00\",\n \"auto_reminders\": false,\n \"copy_document_completed\": true,\n \"copy_recipients_document_completed\": false,\n \"retention_policy\": 30,\n \"delete_after_download\": true,\n \"close_on_success\": false,\n \"redirect_success_url\": \"https:\\\/\\\/example.com\\\/redirect\",\n \"redirect_error_url\": \"https:\\\/\\\/example.com\\\/redirect\"\n },\n \"meta\": {\n \"internal_id\": 123\n },\n \"documents\": [\n {\n \"name\": \"voluptatem\",\n \"html\": {\n \"0\": {\n \"content\": \"sequi\",\n \"orientation\": \"quia\",\n \"size\": \"eius\"\n },\n \"1\": [],\n \"content\": \"molestiae\",\n \"orientation\": \"landscape\",\n \"size\": \"c6\"\n },\n \"fields\": [\n {\n \"anchor\": \"a\",\n \"anchor_position\": \"TOP\",\n \"page\": 1,\n \"type\": \"signature\",\n \"width\": 200,\n \"height\": 9,\n \"x\": 550,\n \"y\": 200,\n \"required\": true,\n \"read_only\": false,\n \"value\": \"rem\",\n \"placeholder\": \"Your Name\",\n \"meta\": {\n \"font\": \"Arial\",\n \"font_size\": 16,\n \"line_height\": 18,\n \"bold\": false,\n \"italic\": \"false\",\n \"underline\": \"false\"\n },\n \"recipient_id\": \"123\"\n },\n []\n ],\n \"meta\": []\n },\n {\n \"name\": \"voluptatem\",\n \"fields\": [\n [],\n []\n ],\n \"meta\": []\n }\n ],\n \"recipients\": [\n {\n \"id\": \"1\",\n \"type\": \"signatory\",\n \"email\": \"john@example.com\",\n \"name\": \"John Doe\",\n \"access_pin\": \"1234\",\n \"phonenumber\": \"+43 664 123 456\",\n \"do_not_notify\": true,\n \"language\": \"ipsa\",\n \"notification_phonenumber\": \"odit\",\n \"notification_channels\": \"maiores\"\n },\n {\n \"id\": \"1\",\n \"type\": \"signatory\",\n \"email\": \"john@example.com\",\n \"name\": \"John Doe\",\n \"do_not_notify\": true,\n \"language\": \"ipsa\",\n \"notification_phonenumber\": \"odit\",\n \"notification_channels\": \"maiores\"\n }\n ]\n}" }, "description": "There are two types of requests. Requesting signatures (signature<\/code>) or sending documents (information<\/code>)." }, "header": null, "cookie": [], "body": "{\n \"id\": \"66deeab2-95e6-42d9-814b-c68e6711f2ef\",\n \"type\": \"signature\",\n \"subject\": \"Necessitatibus vel qui illo.\",\n \"message\": \"At qui repudiandae voluptatem provident. Eum id assumenda accusantium quia rerum.\",\n \"sandbox\": null,\n \"created_at\": \"2022-09-07T15:50:10+02:00\",\n \"updated_at\": \"2022-09-07T15:50:10+02:00\",\n \"canceled_at\": null,\n \"released_at\": null,\n \"declined_at\": null,\n \"completed_at\": null,\n \"settings\": {\n \"deadline_at\": \"2022-09-28T15:50:10+02:00\",\n \"auto_reminders\": true,\n \"retention_policy\": null,\n \"delete_after_download\": false,\n \"copy_document_completed\": true,\n \"copy_recipients_document_completed\": true,\n \"close_on_success\": false,\n \"redirect_success_url\": null,\n \"redirect_error_url\": null\n },\n \"meta\": null\n}" } ] }, { "name": "Get Request", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/requests\/:request", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/requests\/:request", "variable": [ { "id": "request", "key": "request", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the request." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves the details of an existing request. You need only supply the unique request identifier." }, "response": [ { "name": "Get Request Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/requests\/:request", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/requests\/:request", "variable": [ { "id": "request", "key": "request", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the request." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves the details of an existing request. You need only supply the unique request identifier." }, "header": null, "cookie": [], "body": "{\n \"id\": \"f2f8296d-a906-4bfb-8a58-d9d84e6b810e\",\n \"type\": \"signature\",\n \"subject\": \"Facere voluptatibus ea aut quia quas deleniti enim.\",\n \"message\": \"Quia omnis ea placeat amet quia culpa nesciunt. Nemo impedit incidunt voluptate aut dolores consequatur. Sed officiis quam sed sit.\",\n \"sandbox\": null,\n \"created_at\": \"2022-09-07T15:50:10+02:00\",\n \"updated_at\": \"2022-09-07T15:50:10+02:00\",\n \"canceled_at\": null,\n \"released_at\": null,\n \"declined_at\": null,\n \"completed_at\": null,\n \"settings\": {\n \"deadline_at\": \"2022-09-21T15:50:10+02:00\",\n \"auto_reminders\": true,\n \"retention_policy\": null,\n \"delete_after_download\": false,\n \"copy_document_completed\": true,\n \"copy_recipients_document_completed\": true,\n \"close_on_success\": false,\n \"redirect_success_url\": null,\n \"redirect_error_url\": null\n },\n \"meta\": null\n}" } ] }, { "name": "Delete Request", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/requests\/:request", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/requests\/:request", "variable": [ { "id": "request", "key": "request", "value": "perferendis", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Permanently deletes a request. This cannot be undone." }, "response": [] }, { "name": "Cancel Request", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/requests\/:request\/cancel", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/requests\/:request\/cancel", "variable": [ { "id": "request", "key": "request", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the request." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"reason\": \"asperiores\"\n}" }, "description": "" }, "response": [ { "name": "Cancel Request Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/requests\/:request\/cancel", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/requests\/:request\/cancel", "variable": [ { "id": "request", "key": "request", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the request." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"reason\": \"asperiores\"\n}" }, "description": "" }, "header": null, "cookie": [], "body": "{}" } ] }, { "name": "Complete Request", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/requests\/:request\/complete", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/requests\/:request\/complete", "variable": [ { "id": "request", "key": "request", "value": "tempore", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "name": "Complete Request Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/requests\/:request\/complete", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/requests\/:request\/complete", "variable": [ { "id": "request", "key": "request", "value": "tempore", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "header": null, "cookie": [], "body": "{}" } ] }, { "name": "Extend Request", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/requests\/:request\/extend", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/requests\/:request\/extend", "variable": [ { "id": "request", "key": "request", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the request." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"deadline_at\": \"quia\"\n}" }, "description": "" }, "response": [ { "name": "Extend Request Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/requests\/:request\/extend", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/requests\/:request\/extend", "variable": [ { "id": "request", "key": "request", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the request." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"deadline_at\": \"quia\"\n}" }, "description": "" }, "header": null, "cookie": [], "body": "{}" } ] }, { "name": "Retrieve Request Audit Trail", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/requests\/:request\/audit", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/requests\/:request\/audit", "variable": [ { "id": "request", "key": "request", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the request." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "name": "Retrieve Request Audit Trail Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/requests\/:request\/audit", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/requests\/:request\/audit", "variable": [ { "id": "request", "key": "request", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the request." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "header": null, "cookie": [], "body": "{\n \"id\": null,\n \"timestamp\": \"2022-09-07T15:50:10+02:00\",\n \"device\": null,\n \"ip_address\": null,\n \"user\": null,\n \"recipient\": null,\n \"action\": {\n \"slug\": null,\n \"label\": null,\n \"sub_label\": null\n }\n}" } ] } ] }, { "name": "Signature", "description": "", "item": [ { "name": "Sign Document", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/sign", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/sign" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"perferendis\",\n \"html\": [\n {\n \"content\": \"ipsa\",\n \"orientation\": \"est\",\n \"size\": \"et\"\n },\n {\n \"content\": \"ipsa\",\n \"size\": \"et\"\n }\n ],\n \"meta\": {\n \"internal_id\": 123\n },\n \"seal\": {\n \"page\": 1,\n \"x\": 550,\n \"y\": 200,\n \"anchor\": \"signature1\",\n \"anchor_position\": \"CENTER\",\n \"meta\": []\n }\n}" }, "description": "Digitally sign a document directly without going through the classic request flow. A complete document must be submitted as no fields, signature images, etc. can be added in this process.\nA documents can be uploaded either by providing a URL, through sending the file base64 encoded or as HTML. Please only specify one of three upload parameters (url, base64 or html).<\/b>" }, "response": [ { "name": "Sign Document Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/sign", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/sign" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"perferendis\",\n \"html\": [\n {\n \"content\": \"ipsa\",\n \"orientation\": \"est\",\n \"size\": \"et\"\n },\n {\n \"content\": \"ipsa\",\n \"size\": \"et\"\n }\n ],\n \"meta\": {\n \"internal_id\": 123\n },\n \"seal\": {\n \"page\": 1,\n \"x\": 550,\n \"y\": 200,\n \"anchor\": \"signature1\",\n \"anchor_position\": \"CENTER\",\n \"meta\": []\n }\n}" }, "description": "Digitally sign a document directly without going through the classic request flow. A complete document must be submitted as no fields, signature images, etc. can be added in this process.\nA documents can be uploaded either by providing a URL, through sending the file base64 encoded or as HTML. Please only specify one of three upload parameters (url, base64 or html).<\/b>" }, "header": null, "cookie": [], "body": "{\n \"id\": null,\n \"name\": \"Asperiores voluptas magnam ullam provident laboriosam aspernatur est..pdf\",\n \"size\": 12655,\n \"type\": \"pdf\",\n \"meta\": null,\n \"versions\": [],\n \"pages\": []\n}" } ] } ] }, { "name": "Team", "description": "\nManage your team", "item": [ { "name": "List Team Members", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/team", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/team" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated<\/a> list of the team members associated with an account." }, "response": [ { "name": "List Team Members Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/team", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/team" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated<\/a> list of the team members associated with an account." }, "header": null, "cookie": [], "body": "[\n {\n \"id\": \"ac9a05a2-bf3e-4330-b9a4-5af746fc0001\",\n \"gender\": \"male\",\n \"firstname\": \"Phyllis\",\n \"lastname\": \"Ratke\",\n \"email\": \"casey.vonrueden@example.org\",\n \"permission\": null\n },\n {\n \"id\": \"35d5cf47-89b1-42ea-9a65-ea00fa34a43a\",\n \"gender\": \"male\",\n \"firstname\": \"Elza\",\n \"lastname\": \"Macejkovic\",\n \"email\": \"isac40@example.com\",\n \"permission\": null\n }\n]" } ] }, { "name": "Create Team Member", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/team", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/team" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"gender\": \"est\",\n \"firstname\": \"iusto\",\n \"lastname\": \"id\",\n \"permission\": \"manager\",\n \"email\": \"john@example.com\"\n}" }, "description": "Please note that when you create team members, a booking (according to the signteq.io price list) is initiated and a monthly subscription is created." }, "response": [ { "name": "Create Team Member Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/team", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/team" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"gender\": \"est\",\n \"firstname\": \"iusto\",\n \"lastname\": \"id\",\n \"permission\": \"manager\",\n \"email\": \"john@example.com\"\n}" }, "description": "Please note that when you create team members, a booking (according to the signteq.io price list) is initiated and a monthly subscription is created." }, "header": null, "cookie": [], "body": "{\n \"id\": \"3d533851-c738-403e-9508-eb1f1aa0bc90\",\n \"gender\": \"female\",\n \"firstname\": \"Roberto\",\n \"lastname\": \"Terry\",\n \"email\": \"domenica98@example.net\",\n \"permission\": null\n}" } ] }, { "name": "Get Team Member", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/team\/:teamMember", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/team\/:teamMember", "variable": [ { "id": "teamMember", "key": "teamMember", "value": "molestiae", "description": "" }, { "id": "team", "key": "team", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "member\" string required The ID of the team member." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves the details of an existing team member. You only need to supply the unique team member identifier." }, "response": [ { "name": "Get Team Member Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/team\/:teamMember", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/team\/:teamMember", "variable": [ { "id": "teamMember", "key": "teamMember", "value": "molestiae", "description": "" }, { "id": "team", "key": "team", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "member\" string required The ID of the team member." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves the details of an existing team member. You only need to supply the unique team member identifier." }, "header": null, "cookie": [], "body": "{\n \"id\": \"99ae078c-20ff-45fc-8099-f4bbe57d2644\",\n \"gender\": \"male\",\n \"firstname\": \"Emmanuelle\",\n \"lastname\": \"Kling\",\n \"email\": \"will.lura@example.com\",\n \"permission\": null\n}" } ] }, { "name": "Update Team Member", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/team\/:teamMember", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/team\/:teamMember", "variable": [ { "id": "teamMember", "key": "teamMember", "value": "qui", "description": "" }, { "id": "team", "key": "team", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "member\" string required The ID of the team member." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"gender\": \"blanditiis\",\n \"firstname\": \"impedit\",\n \"lastname\": \"veniam\",\n \"permission\": \"manager\",\n \"email\": \"john@example.com\"\n}" }, "description": "Updates the specified team member by setting the values of the parameters passed. Any parameters not provided will be left unchanged." }, "response": [ { "name": "Update Team Member Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/team\/:teamMember", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/team\/:teamMember", "variable": [ { "id": "teamMember", "key": "teamMember", "value": "qui", "description": "" }, { "id": "team", "key": "team", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "member\" string required The ID of the team member." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"gender\": \"blanditiis\",\n \"firstname\": \"impedit\",\n \"lastname\": \"veniam\",\n \"permission\": \"manager\",\n \"email\": \"john@example.com\"\n}" }, "description": "Updates the specified team member by setting the values of the parameters passed. Any parameters not provided will be left unchanged." }, "header": null, "cookie": [], "body": "{\n \"id\": \"1fd551cd-31ac-4888-a8cf-dc1586c96682\",\n \"gender\": \"male\",\n \"firstname\": \"Griffin\",\n \"lastname\": \"Simonis\",\n \"email\": \"myrl.mcdermott@example.net\",\n \"permission\": null\n}" } ] }, { "name": "Delete Team Member", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/team\/:teamMember", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/team\/:teamMember", "variable": [ { "id": "teamMember", "key": "teamMember", "value": "qui", "description": "" }, { "id": "team", "key": "team", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "member\" string required The ID of the team member." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes a team member. If you delete a team member, the associated billing plan will be canceled at the end of the current period." }, "response": [ { "name": "Delete Team Member Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/team\/:teamMember", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/team\/:teamMember", "variable": [ { "id": "teamMember", "key": "teamMember", "value": "qui", "description": "" }, { "id": "team", "key": "team", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "member\" string required The ID of the team member." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes a team member. If you delete a team member, the associated billing plan will be canceled at the end of the current period." }, "header": null, "cookie": [], "body": "{}" } ] } ] }, { "name": "Templates", "description": "\nTo simplify the creation of requests, templates can be created. For example, you can create templates in the signteq.io UI and use them via the API. If you use the same document very often and only need to customize a few data, templates are the right choice.", "item": [ { "name": "List Templates", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/templates", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/templates" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated<\/a> list of your templates." }, "response": [ { "name": "List Templates Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/templates", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/templates" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated<\/a> list of your templates." }, "header": null, "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"e90f4cd6-343c-47c7-bf6b-a8d131b2a4d2\",\n \"created_at\": \"2022-09-07T15:50:10+02:00\",\n \"subject\": \"Qui ex qui nam incidunt.\",\n \"settings\": {\n \"verify_phonenumber\": false,\n \"verify_email\": true\n },\n \"recipients\": [],\n \"permalink\": \"http:\\\/\\\/api.signteq.io\\\/t\\\/e90f4cd6-343c-47c7-bf6b-a8d131b2a4d2?signature=3396c17b36823bfeddf72ae54000fcdec2a0142d682f2d1934c860d650d4596f\",\n \"qrcode\": \"http:\\\/\\\/api.signteq.io\\\/templates\\\/e90f4cd6-343c-47c7-bf6b-a8d131b2a4d2\\\/qrcode?signature=36dcf1d6a69bb0e74a288c0e914a78e3decea7985835b5206772e47025007fbb\"\n },\n {\n \"id\": \"b2fa3249-7c10-4d9c-8926-4fb576ca339a\",\n \"created_at\": \"2022-09-07T15:50:10+02:00\",\n \"subject\": \"Vero porro sit quidem non.\",\n \"settings\": {\n \"verify_phonenumber\": false,\n \"verify_email\": true\n },\n \"recipients\": [],\n \"permalink\": \"http:\\\/\\\/api.signteq.io\\\/t\\\/b2fa3249-7c10-4d9c-8926-4fb576ca339a?signature=24ae30b1302421b7dd3232e4b6adb032d3bd8fe0120577c6a31afd8930c11092\",\n \"qrcode\": \"http:\\\/\\\/api.signteq.io\\\/templates\\\/b2fa3249-7c10-4d9c-8926-4fb576ca339a\\\/qrcode?signature=8dd103e660d009bb0ec3e122572d5a9aabce87583e710f30cc3e0541ad86db7a\"\n }\n ],\n \"links\": {\n \"first\": \"\\\/?page=1\",\n \"last\": \"\\\/?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Zur\\u00fcck\",\n \"active\": false\n },\n {\n \"url\": \"\\\/?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Weiter »\",\n \"active\": false\n }\n ],\n \"path\": \"\\\/\",\n \"per_page\": \"15\",\n \"to\": 2,\n \"total\": 2\n }\n}" } ] }, { "name": "Create Template", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/templates", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/templates" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"subject\": \"cupiditate\",\n \"recipients\": [\n \"quas\",\n \"officiis\"\n ],\n \"settings\": {\n \"verify_phonenumber\": true\n },\n \"documents\": [\n {\n \"name\": \"consectetur\",\n \"fields\": [\n {\n \"page\": 1,\n \"type\": \"signature\",\n \"width\": 200,\n \"height\": 8,\n \"x\": 1,\n \"y\": 15,\n \"required\": true,\n \"value\": \"corporis\",\n \"placeholder\": \"Your Name\",\n \"meta\": {\n \"font\": \"Arial\",\n \"font_size\": 16,\n \"line_height\": 18,\n \"bold\": false,\n \"italic\": \"false\",\n \"underline\": \"false\"\n },\n \"recipient_id\": \"Client\"\n },\n []\n ]\n },\n {\n \"name\": \"consectetur\",\n \"fields\": [\n [],\n []\n ]\n }\n ]\n}" }, "description": "Templates can either be used as templates for requests or can be accessed directly via a URL. The creation process is the same in both cases." }, "response": [ { "name": "Create Template Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/templates", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/templates" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"subject\": \"cupiditate\",\n \"recipients\": [\n \"quas\",\n \"officiis\"\n ],\n \"settings\": {\n \"verify_phonenumber\": true\n },\n \"documents\": [\n {\n \"name\": \"consectetur\",\n \"fields\": [\n {\n \"page\": 1,\n \"type\": \"signature\",\n \"width\": 200,\n \"height\": 8,\n \"x\": 1,\n \"y\": 15,\n \"required\": true,\n \"value\": \"corporis\",\n \"placeholder\": \"Your Name\",\n \"meta\": {\n \"font\": \"Arial\",\n \"font_size\": 16,\n \"line_height\": 18,\n \"bold\": false,\n \"italic\": \"false\",\n \"underline\": \"false\"\n },\n \"recipient_id\": \"Client\"\n },\n []\n ]\n },\n {\n \"name\": \"consectetur\",\n \"fields\": [\n [],\n []\n ]\n }\n ]\n}" }, "description": "Templates can either be used as templates for requests or can be accessed directly via a URL. The creation process is the same in both cases." }, "header": null, "cookie": [], "body": "{\n \"id\": \"f65b4bd8-d071-4798-9677-177caa95013c\",\n \"created_at\": \"2022-09-07T15:50:10+02:00\",\n \"subject\": \"Dignissimos ab et quia totam rem.\",\n \"settings\": {\n \"verify_phonenumber\": false,\n \"verify_email\": true\n },\n \"recipients\": [],\n \"permalink\": \"http:\\\/\\\/api.signteq.io\\\/t\\\/f65b4bd8-d071-4798-9677-177caa95013c?signature=273370df2f335a7d83fa407e0a285be6d3c8c27369ceee8b4cae335f4c83d992\",\n \"qrcode\": \"http:\\\/\\\/api.signteq.io\\\/templates\\\/f65b4bd8-d071-4798-9677-177caa95013c\\\/qrcode?signature=78c8858622eeb4640ed6f26517172d4b03b23cb6250c21782a4b8ed6fc233107\"\n}" } ] }, { "name": "Get Template", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/templates\/:template", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/templates\/:template", "variable": [ { "id": "template", "key": "template", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the template." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves the details of an existing template. You need only supply the unique template identifier." }, "response": [ { "name": "Get Template Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/templates\/:template", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/templates\/:template", "variable": [ { "id": "template", "key": "template", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the template." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves the details of an existing template. You need only supply the unique template identifier." }, "header": null, "cookie": [], "body": "{\n \"id\": \"cf2cd695-bfb5-4b0a-8c38-8de441ea9b99\",\n \"created_at\": \"2022-09-07T15:50:10+02:00\",\n \"subject\": \"Pariatur id labore in itaque hic voluptatem et.\",\n \"settings\": {\n \"verify_phonenumber\": false,\n \"verify_email\": true\n },\n \"recipients\": [],\n \"permalink\": \"http:\\\/\\\/api.signteq.io\\\/t\\\/cf2cd695-bfb5-4b0a-8c38-8de441ea9b99?signature=e7768ca0294ddd9eed67af618c6283b2fc3ba8904f4f40838f0c2bb6d06c5c90\",\n \"qrcode\": \"http:\\\/\\\/api.signteq.io\\\/templates\\\/cf2cd695-bfb5-4b0a-8c38-8de441ea9b99\\\/qrcode?signature=b1ab48b0a8f393072bbc924614db14f1590db5e4b806e3ff93d293677d0a84b6\"\n}" } ] }, { "name": "Use Template", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/templates\/:template", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/templates\/:template", "variable": [ { "id": "template", "key": "template", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the template." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"message\": \"Hi John, please sign the NDA. If you have any questions, feel free to contact me.\",\n \"settings\": {\n \"deadline_at\": \"2021-09-26T21:40:29+02:00\",\n \"auto_reminders\": true,\n \"retention_policy\": 30,\n \"delete_after_download\": true,\n \"copy_document_completed\": false,\n \"copy_recipients_document_completed\": true,\n \"redirect_success_url\": \"https:\\\/\\\/example.com\\\/redirect\",\n \"redirect_error_url\": \"https:\\\/\\\/example.com\\\/redirect\"\n },\n \"meta\": {\n \"internal_id\": 123\n },\n \"recipients\": [\n {\n \"id\": \"1\",\n \"type\": \"signatory\",\n \"email\": \"john@example.com\",\n \"name\": \"John Doe\",\n \"phonenumber\": \"+43 664 123 456\",\n \"access_pin\": \"1234\",\n \"do_not_notify\": false,\n \"language\": \"ex\"\n },\n {\n \"id\": \"1\",\n \"type\": \"signatory\",\n \"email\": \"john@example.com\",\n \"name\": \"John Doe\",\n \"phonenumber\": \"+43 664 123 456\",\n \"language\": \"ex\"\n }\n ],\n \"fields\": [\n {\n \"id\": \"14ca4897-b791-4fe3-babb-28a9faebd2d3\",\n \"value\": \"John Doe\",\n \"read_only\": false\n },\n {\n \"id\": \"14ca4897-b791-4fe3-babb-28a9faebd2d3\",\n \"value\": \"John Doe\",\n \"read_only\": false\n }\n ]\n}" }, "description": "Use this template to create a request." }, "response": [ { "name": "Use Template Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/templates\/:template", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/templates\/:template", "variable": [ { "id": "template", "key": "template", "value": "f5cfac16-3275-4e77-b33c-72bccace0130", "description": "The ID of the template." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"message\": \"Hi John, please sign the NDA. If you have any questions, feel free to contact me.\",\n \"settings\": {\n \"deadline_at\": \"2021-09-26T21:40:29+02:00\",\n \"auto_reminders\": true,\n \"retention_policy\": 30,\n \"delete_after_download\": true,\n \"copy_document_completed\": false,\n \"copy_recipients_document_completed\": true,\n \"redirect_success_url\": \"https:\\\/\\\/example.com\\\/redirect\",\n \"redirect_error_url\": \"https:\\\/\\\/example.com\\\/redirect\"\n },\n \"meta\": {\n \"internal_id\": 123\n },\n \"recipients\": [\n {\n \"id\": \"1\",\n \"type\": \"signatory\",\n \"email\": \"john@example.com\",\n \"name\": \"John Doe\",\n \"phonenumber\": \"+43 664 123 456\",\n \"access_pin\": \"1234\",\n \"do_not_notify\": false,\n \"language\": \"ex\"\n },\n {\n \"id\": \"1\",\n \"type\": \"signatory\",\n \"email\": \"john@example.com\",\n \"name\": \"John Doe\",\n \"phonenumber\": \"+43 664 123 456\",\n \"language\": \"ex\"\n }\n ],\n \"fields\": [\n {\n \"id\": \"14ca4897-b791-4fe3-babb-28a9faebd2d3\",\n \"value\": \"John Doe\",\n \"read_only\": false\n },\n {\n \"id\": \"14ca4897-b791-4fe3-babb-28a9faebd2d3\",\n \"value\": \"John Doe\",\n \"read_only\": false\n }\n ]\n}" }, "description": "Use this template to create a request." }, "header": null, "cookie": [], "body": "{\n \"id\": \"0413e716-5ad1-415b-b221-52244907862b\",\n \"type\": \"signature\",\n \"subject\": \"Qui reprehenderit enim voluptas maxime est nisi.\",\n \"message\": \"Quae delectus quo dicta quas voluptas. Ducimus magnam quos fugiat aut voluptate beatae. Id nisi ea animi unde quae omnis.\",\n \"sandbox\": null,\n \"created_at\": \"2022-09-07T15:50:10+02:00\",\n \"updated_at\": \"2022-09-07T15:50:10+02:00\",\n \"canceled_at\": null,\n \"released_at\": null,\n \"declined_at\": null,\n \"completed_at\": null,\n \"settings\": {\n \"deadline_at\": \"2022-09-26T15:50:10+02:00\",\n \"auto_reminders\": true,\n \"retention_policy\": null,\n \"delete_after_download\": false,\n \"copy_document_completed\": true,\n \"copy_recipients_document_completed\": true,\n \"close_on_success\": false,\n \"redirect_success_url\": null,\n \"redirect_error_url\": null\n },\n \"meta\": null\n}" } ] }, { "name": "Delete Template", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "v1\/templates\/:template", "query": [], "raw": "https:\/\/{{baseUrl}}\/v1\/templates\/:template", "variable": [ { "id": "template", "key": "template", "value": "minus", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Permanently deletes a template. It cannot be undone." }, "response": [] } ] } ], "auth": { "type": "bearer" } }