{ "openapi": "3.1.1", "info": { "title": "Legaldoc v2 API", "description": "Welcome to the Legaldoc v2 API.\n\nThis API provides access to our system, which you can use to integrate applications, automate workflows, or build custom tools.", "version": "1.0.0" }, "servers": [ { "url": "https://app.legaldoc.com/api/v2" } ], "paths": { "/envelope/attachment": { "get": { "operationId": "envelope-attachment-find", "summary": "Find attachments", "description": "Find all attachments for an envelope", "tags": [ "Envelope Attachments" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "query", "name": "envelopeId", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "token", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "link" ] }, "label": { "type": "string" }, "data": { "type": "string" } }, "required": [ "id", "type", "label", "data" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/attachment/create": { "post": { "operationId": "envelope-attachment-create", "summary": "Create attachment", "description": "Create a new attachment for an envelope", "tags": [ "Envelope Attachments" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "data": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "data": { "type": "string", "format": "uri" } }, "required": [ "label", "data" ] } }, "required": [ "envelopeId", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/attachment/update": { "post": { "operationId": "envelope-attachment-update", "summary": "Update attachment", "description": "Update an existing attachment", "tags": [ "Envelope Attachments" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "data": { "type": "string", "format": "uri" } }, "required": [ "label", "data" ] } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/attachment/delete": { "post": { "operationId": "envelope-attachment-delete", "summary": "Delete attachment", "description": "Delete an attachment from an envelope", "tags": [ "Envelope Attachments" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/item/create-many": { "post": { "operationId": "envelope-item-createMany", "summary": "Create envelope items", "description": "Create multiple envelope items for an envelope", "tags": [ "Envelope Items" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "envelopeId": { "type": "string" } }, "required": [ "envelopeId" ] }, "files": { "type": "array", "items": { "type": "string", "contentMediaType": "application/octet-stream" } } }, "required": [ "payload" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "envelopeId": { "type": "string" }, "order": { "type": "number" }, "documentDataId": { "type": "string" } }, "required": [ "id", "title", "envelopeId", "order", "documentDataId" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/item/update-many": { "post": { "operationId": "envelope-item-updateMany", "summary": "Update envelope items", "description": "Update multiple envelope items for an envelope", "tags": [ "Envelope Items" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "envelopeItemId": { "type": "string" }, "order": { "type": "integer", "minimum": 1 }, "title": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "envelopeItemId" ] }, "minItems": 1 } }, "required": [ "envelopeId", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "order": { "type": "number" }, "title": { "type": "string" }, "envelopeId": { "type": "string" } }, "required": [ "id", "order", "title", "envelopeId" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/item/delete": { "post": { "operationId": "envelope-item-delete", "summary": "Delete envelope item", "description": "Delete an envelope item from an envelope", "tags": [ "Envelope Items" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "envelopeItemId": { "type": "string" } }, "required": [ "envelopeId", "envelopeItemId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/item/{envelopeItemId}/download": { "get": { "operationId": "envelope-item-download", "summary": "Download an envelope item", "description": "Download an envelope item by its ID", "tags": [ "Envelope Items" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "envelopeItemId", "description": "The ID of the envelope item to download.", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "version", "description": "The version of the envelope item to download. \"signed\" returns the completed document with all signatures and the audit trail, \"original\" returns the original uploaded document, \"pending\" returns the original document with currently-inserted fields burned in (only valid while the envelope is in PENDING status; not a final executed document).", "schema": { "type": "string", "enum": [ "original", "signed", "pending" ], "default": "signed" } } ], "responses": { "200": { "description": "Successful response", "headers": { "Content-Type": { "schema": { "type": "string", "enum": [ "application/pdf" ] }, "required": true } }, "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/recipient/{recipientId}": { "get": { "operationId": "envelope-recipient-get", "summary": "Get envelope recipient", "description": "Returns an envelope recipient given an ID", "tags": [ "Envelope Recipients" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "recipientId", "schema": { "type": "number" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "readStatus": { "type": "string", "enum": [ "NOT_OPENED", "OPENED" ] }, "signingStatus": { "type": "string", "enum": [ "NOT_SIGNED", "SIGNED", "REJECTED" ] }, "sendStatus": { "type": "string", "enum": [ "NOT_SENT", "SENT" ] }, "id": { "type": "number" }, "email": { "type": "string" }, "name": { "type": "string" }, "token": { "type": "string" }, "documentDeletedAt": { "type": [ "string", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE", "CLAVE_UNICA", "FAO_HASH" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "envelopeItemId": { "type": "string" }, "type": { "type": "string", "enum": [ "SIGNATURE", "INITIALS", "NAME", "EMAIL", "DATE", "TEXT", "NUMBER", "RADIO", "CHECKBOX", "DROPDOWN", "RUT", "RUT_FIRMADO" ] }, "id": { "type": "number" }, "secondaryId": { "type": "string" }, "recipientId": { "type": "number" }, "page": { "type": "number" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ], "title": "signature" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "title": "initials" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "title": "name" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ], "title": "email" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ], "title": "date" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "title": "text" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "title": "number" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "radio" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ], "title": "radio" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "checkbox" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "validationRule": { "type": "string" }, "validationLength": { "type": "number" }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ], "title": "checkbox" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ], "title": "dropdown" } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason", "fields" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/recipient/create-many": { "post": { "operationId": "envelope-recipient-createMany", "summary": "Create envelope recipients", "description": "Create multiple recipients for an envelope", "tags": [ "Envelope Recipients" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "email": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "maxLength": 254 } ] }, "name": { "type": "string", "maxLength": 255 }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": "number" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE", "CLAVE_UNICA", "FAO_HASH" ] }, "default": [] } }, "required": [ "email", "name", "role" ] } } }, "required": [ "envelopeId", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "readStatus": { "type": "string", "enum": [ "NOT_OPENED", "OPENED" ] }, "signingStatus": { "type": "string", "enum": [ "NOT_SIGNED", "SIGNED", "REJECTED" ] }, "sendStatus": { "type": "string", "enum": [ "NOT_SENT", "SENT" ] }, "id": { "type": "number" }, "email": { "type": "string" }, "name": { "type": "string" }, "token": { "type": "string" }, "documentDeletedAt": { "type": [ "string", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE", "CLAVE_UNICA", "FAO_HASH" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/recipient/update-many": { "post": { "operationId": "envelope-recipient-updateMany", "summary": "Update envelope recipients", "description": "Update multiple recipients for an envelope", "tags": [ "Envelope Recipients" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "email": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "maxLength": 254 } ] }, "name": { "type": "string", "maxLength": 255 }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": "number" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE", "CLAVE_UNICA", "FAO_HASH" ] }, "default": [] } }, "required": [ "id" ] } } }, "required": [ "envelopeId", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "readStatus": { "type": "string", "enum": [ "NOT_OPENED", "OPENED" ] }, "signingStatus": { "type": "string", "enum": [ "NOT_SIGNED", "SIGNED", "REJECTED" ] }, "sendStatus": { "type": "string", "enum": [ "NOT_SENT", "SENT" ] }, "id": { "type": "number" }, "email": { "type": "string" }, "name": { "type": "string" }, "token": { "type": "string" }, "documentDeletedAt": { "type": [ "string", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE", "CLAVE_UNICA", "FAO_HASH" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/recipient/delete": { "post": { "operationId": "envelope-recipient-delete", "summary": "Delete envelope recipient", "description": "Delete an envelope recipient", "tags": [ "Envelope Recipients" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "recipientId": { "type": "number" } }, "required": [ "recipientId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/recipient/{recipientId}/reject": { "post": { "operationId": "envelope-recipient-rejectOnBehalfOf", "summary": "Reject envelope recipient on behalf of", "description": "Records a rejection on behalf of a recipient. Use this when a recipient has declined to sign outside of the platform. The rejection is flagged as external in the document audit log. By default the action is attributed to the API user; supply `actAsEmail` to attribute it to a specific team member.", "tags": [ "Envelope Recipients" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "recipientId", "description": "The ID of the recipient to reject the document on behalf of.", "schema": { "type": "number" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "reason": { "type": "string", "minLength": 1 }, "actAsEmail": { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" } }, "required": [ "envelopeId", "reason" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "readStatus": { "type": "string", "enum": [ "NOT_OPENED", "OPENED" ] }, "signingStatus": { "type": "string", "enum": [ "NOT_SIGNED", "SIGNED", "REJECTED" ] }, "sendStatus": { "type": "string", "enum": [ "NOT_SENT", "SENT" ] }, "id": { "type": "number" }, "email": { "type": "string" }, "name": { "type": "string" }, "token": { "type": "string" }, "documentDeletedAt": { "type": [ "string", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE", "CLAVE_UNICA", "FAO_HASH" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "envelopeItemId": { "type": "string" }, "type": { "type": "string", "enum": [ "SIGNATURE", "INITIALS", "NAME", "EMAIL", "DATE", "TEXT", "NUMBER", "RADIO", "CHECKBOX", "DROPDOWN", "RUT", "RUT_FIRMADO" ] }, "id": { "type": "number" }, "secondaryId": { "type": "string" }, "recipientId": { "type": "number" }, "page": { "type": "number" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ], "title": "signature" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "title": "initials" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "title": "name" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ], "title": "email" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ], "title": "date" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "title": "text" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "title": "number" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "radio" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ], "title": "radio" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "checkbox" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "validationRule": { "type": "string" }, "validationLength": { "type": "number" }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ], "title": "checkbox" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ], "title": "dropdown" } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason", "fields" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/field/{fieldId}": { "get": { "operationId": "envelope-field-get", "summary": "Get envelope field", "description": "Returns an envelope field given an ID", "tags": [ "Envelope Fields" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "fieldId", "schema": { "type": "number" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "envelopeItemId": { "type": "string" }, "type": { "type": "string", "enum": [ "SIGNATURE", "INITIALS", "NAME", "EMAIL", "DATE", "TEXT", "NUMBER", "RADIO", "CHECKBOX", "DROPDOWN", "RUT", "RUT_FIRMADO" ] }, "id": { "type": "number" }, "secondaryId": { "type": "string" }, "recipientId": { "type": "number" }, "page": { "type": "number" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ], "title": "signature" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "title": "initials" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "title": "name" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ], "title": "email" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ], "title": "date" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "title": "text" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "title": "number" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "radio" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ], "title": "radio" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "checkbox" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "validationRule": { "type": "string" }, "validationLength": { "type": "number" }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ], "title": "checkbox" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ], "title": "dropdown" } ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/field/create-many": { "post": { "operationId": "envelope-field-createMany", "summary": "Create envelope fields", "description": "Create multiple fields for an envelope", "tags": [ "Envelope Fields" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "data": { "type": "array", "items": { "anyOf": [ { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SIGNATURE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "type" ], "default": { "type": "signature", "fontSize": 18, "overflow": "auto" } } }, "required": [ "type" ], "title": "SIGNATURE" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "initials", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ], "title": "INITIALS" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "name", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ], "title": "NAME" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "email", "fontSize": 12, "textAlign": "left", "overflow": "auto" } } }, "required": [ "type" ], "title": "EMAIL" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "date", "fontSize": 12, "textAlign": "left", "overflow": "auto" } } }, "required": [ "type" ], "title": "DATE" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "default": { "type": "text", "fontSize": 12, "textAlign": "left", "label": "", "placeholder": "", "text": "", "required": false, "readOnly": false } } }, "required": [ "type" ], "title": "TEXT" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "default": { "type": "number", "fontSize": 12, "textAlign": "left", "label": "", "placeholder": "", "required": false, "readOnly": false } } }, "required": [ "type" ], "title": "NUMBER" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "radio" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ], "default": { "type": "radio", "fontSize": 12, "values": [ { "id": 1, "checked": false, "value": "" } ], "required": false, "readOnly": false, "direction": "vertical" } } }, "required": [ "type" ], "title": "RADIO" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "checkbox" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "validationRule": { "type": "string" }, "validationLength": { "type": "number" }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ], "default": { "type": "checkbox", "fontSize": 12, "values": [ { "id": 1, "checked": false, "value": "" } ], "validationRule": "", "validationLength": 0, "required": false, "readOnly": false, "direction": "vertical" } } }, "required": [ "type" ], "title": "CHECKBOX" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ], "default": { "type": "dropdown", "fontSize": 12, "values": [ { "value": "Option 1" } ], "defaultValue": "", "required": false, "readOnly": false } } }, "required": [ "type" ], "title": "DROPDOWN" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RUT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "rut" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "rut", "fontSize": 12, "overflow": "auto" } } }, "required": [ "type" ], "title": "RUT" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RUT_FIRMADO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "rut_firmado" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "rut_firmado", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ], "title": "RUT_FIRMADO" } ] }, { "type": "object", "properties": { "recipientId": { "type": "number" }, "envelopeItemId": { "type": "string" } }, "required": [ "recipientId" ] }, { "type": "object", "properties": { "page": { "type": "number", "minimum": 1 }, "positionX": { "type": "number", "minimum": 0, "maximum": 100 }, "positionY": { "type": "number", "minimum": 0, "maximum": 100 }, "width": { "type": "number", "minimum": 0, "maximum": 100 }, "height": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "page", "positionX", "positionY", "width", "height" ] } ], "title": "Coordinates" }, { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SIGNATURE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "type" ], "default": { "type": "signature", "fontSize": 18, "overflow": "auto" } } }, "required": [ "type" ], "title": "SIGNATURE" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "initials", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ], "title": "INITIALS" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "name", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ], "title": "NAME" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "email", "fontSize": 12, "textAlign": "left", "overflow": "auto" } } }, "required": [ "type" ], "title": "EMAIL" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "date", "fontSize": 12, "textAlign": "left", "overflow": "auto" } } }, "required": [ "type" ], "title": "DATE" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "default": { "type": "text", "fontSize": 12, "textAlign": "left", "label": "", "placeholder": "", "text": "", "required": false, "readOnly": false } } }, "required": [ "type" ], "title": "TEXT" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "default": { "type": "number", "fontSize": 12, "textAlign": "left", "label": "", "placeholder": "", "required": false, "readOnly": false } } }, "required": [ "type" ], "title": "NUMBER" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "radio" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ], "default": { "type": "radio", "fontSize": 12, "values": [ { "id": 1, "checked": false, "value": "" } ], "required": false, "readOnly": false, "direction": "vertical" } } }, "required": [ "type" ], "title": "RADIO" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "checkbox" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "validationRule": { "type": "string" }, "validationLength": { "type": "number" }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ], "default": { "type": "checkbox", "fontSize": 12, "values": [ { "id": 1, "checked": false, "value": "" } ], "validationRule": "", "validationLength": 0, "required": false, "readOnly": false, "direction": "vertical" } } }, "required": [ "type" ], "title": "CHECKBOX" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ], "default": { "type": "dropdown", "fontSize": 12, "values": [ { "value": "Option 1" } ], "defaultValue": "", "required": false, "readOnly": false } } }, "required": [ "type" ], "title": "DROPDOWN" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RUT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "rut" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "rut", "fontSize": 12, "overflow": "auto" } } }, "required": [ "type" ], "title": "RUT" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RUT_FIRMADO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "rut_firmado" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "rut_firmado", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ], "title": "RUT_FIRMADO" } ] }, { "type": "object", "properties": { "recipientId": { "type": "number" }, "envelopeItemId": { "type": "string" } }, "required": [ "recipientId" ] }, { "type": "object", "properties": { "placeholder": { "type": "string" }, "width": { "type": "number", "minimum": 0, "maximum": 100 }, "height": { "type": "number", "minimum": 0, "maximum": 100 }, "matchAll": { "type": "boolean" } }, "required": [ "placeholder" ] } ], "title": "Placeholder" } ] } } }, "required": [ "envelopeId", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "envelopeItemId": { "type": "string" }, "type": { "type": "string", "enum": [ "SIGNATURE", "INITIALS", "NAME", "EMAIL", "DATE", "TEXT", "NUMBER", "RADIO", "CHECKBOX", "DROPDOWN", "RUT", "RUT_FIRMADO" ] }, "id": { "type": "number" }, "secondaryId": { "type": "string" }, "recipientId": { "type": "number" }, "page": { "type": "number" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ], "title": "signature" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "title": "initials" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "title": "name" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ], "title": "email" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ], "title": "date" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "title": "text" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "title": "number" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "radio" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ], "title": "radio" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "checkbox" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "validationRule": { "type": "string" }, "validationLength": { "type": "number" }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ], "title": "checkbox" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ], "title": "dropdown" } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/field/update-many": { "post": { "operationId": "envelope-field-updateMany", "summary": "Update envelope fields", "description": "Update multiple envelope fields for an envelope", "tags": [ "Envelope Fields" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "data": { "type": "array", "items": { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SIGNATURE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "type" ], "default": { "type": "signature", "fontSize": 18, "overflow": "auto" } } }, "required": [ "type" ], "title": "SIGNATURE" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "initials", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ], "title": "INITIALS" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "name", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ], "title": "NAME" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "email", "fontSize": 12, "textAlign": "left", "overflow": "auto" } } }, "required": [ "type" ], "title": "EMAIL" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "date", "fontSize": 12, "textAlign": "left", "overflow": "auto" } } }, "required": [ "type" ], "title": "DATE" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "default": { "type": "text", "fontSize": 12, "textAlign": "left", "label": "", "placeholder": "", "text": "", "required": false, "readOnly": false } } }, "required": [ "type" ], "title": "TEXT" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "default": { "type": "number", "fontSize": 12, "textAlign": "left", "label": "", "placeholder": "", "required": false, "readOnly": false } } }, "required": [ "type" ], "title": "NUMBER" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "radio" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ], "default": { "type": "radio", "fontSize": 12, "values": [ { "id": 1, "checked": false, "value": "" } ], "required": false, "readOnly": false, "direction": "vertical" } } }, "required": [ "type" ], "title": "RADIO" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "checkbox" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "validationRule": { "type": "string" }, "validationLength": { "type": "number" }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ], "default": { "type": "checkbox", "fontSize": 12, "values": [ { "id": 1, "checked": false, "value": "" } ], "validationRule": "", "validationLength": 0, "required": false, "readOnly": false, "direction": "vertical" } } }, "required": [ "type" ], "title": "CHECKBOX" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ], "default": { "type": "dropdown", "fontSize": 12, "values": [ { "value": "Option 1" } ], "defaultValue": "", "required": false, "readOnly": false } } }, "required": [ "type" ], "title": "DROPDOWN" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RUT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "rut" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "rut", "fontSize": 12, "overflow": "auto" } } }, "required": [ "type" ], "title": "RUT" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RUT_FIRMADO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "rut_firmado" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "rut_firmado", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ], "title": "RUT_FIRMADO" } ] }, { "type": "object", "properties": { "id": { "type": "number" }, "envelopeItemId": { "type": "string" } }, "required": [ "id" ] }, { "type": "object", "properties": { "page": { "type": "number", "minimum": 1 }, "positionX": { "type": "number", "minimum": 0, "maximum": 100 }, "positionY": { "type": "number", "minimum": 0, "maximum": 100 }, "width": { "type": "number", "minimum": 0, "maximum": 100 }, "height": { "type": "number", "minimum": 0, "maximum": 100 } } } ] } } }, "required": [ "envelopeId", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "envelopeItemId": { "type": "string" }, "type": { "type": "string", "enum": [ "SIGNATURE", "INITIALS", "NAME", "EMAIL", "DATE", "TEXT", "NUMBER", "RADIO", "CHECKBOX", "DROPDOWN", "RUT", "RUT_FIRMADO" ] }, "id": { "type": "number" }, "secondaryId": { "type": "string" }, "recipientId": { "type": "number" }, "page": { "type": "number" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ], "title": "signature" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "title": "initials" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "title": "name" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ], "title": "email" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ], "title": "date" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "title": "text" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "title": "number" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "radio" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ], "title": "radio" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "checkbox" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "validationRule": { "type": "string" }, "validationLength": { "type": "number" }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ], "title": "checkbox" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ], "title": "dropdown" } ] }, "documentId": { "type": [ "number", "null" ] }, "templateId": { "type": [ "number", "null" ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/field/delete": { "post": { "operationId": "envelope-field-delete", "summary": "Delete envelope field", "description": "Delete an envelope field", "tags": [ "Envelope Fields" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldId": { "type": "number" } }, "required": [ "fieldId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope": { "get": { "operationId": "envelope-find", "summary": "Find envelopes", "description": "Find envelopes based on search criteria", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "query", "name": "query", "description": "The search query.", "schema": { "type": "string" } }, { "in": "query", "name": "page", "description": "The pagination page number, starts at 1.", "schema": { "type": "number", "minimum": 1 } }, { "in": "query", "name": "perPage", "description": "The number of items per page.", "schema": { "type": "number", "minimum": 1, "maximum": 100 } }, { "in": "query", "name": "type", "description": "Filter envelopes by type (DOCUMENT or TEMPLATE).", "schema": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] } }, { "in": "query", "name": "templateId", "description": "Filter envelopes by the template ID used to create it.", "schema": { "type": "number" } }, { "in": "query", "name": "source", "description": "Filter envelopes by how it was created.", "schema": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE", "TEMPLATE_DIRECT_LINK" ] } }, { "in": "query", "name": "status", "description": "Filter envelopes by the current status.", "schema": { "type": "string", "enum": [ "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" ] } }, { "in": "query", "name": "hasExpiredRecipients", "description": "Filter for envelopes that have at least one recipient whose signing link has expired.", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "in": "query", "name": "folderId", "description": "Filter envelopes by folder ID.", "schema": { "type": "string" } }, { "in": "query", "name": "orderByColumn", "schema": { "type": "string", "enum": [ "createdAt" ] } }, { "in": "query", "name": "orderByDirection", "description": "Sort direction.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "internalVersion": { "type": "number" }, "type": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" ] }, "source": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE", "TEMPLATE_DIRECT_LINK" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "templateType": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] }, "id": { "type": "string" }, "secondaryId": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "completedAt": { "type": [ "string", "null" ] }, "deletedAt": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "formValues": { "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "publicTitle": { "type": "string" }, "publicDescription": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "folderId": { "type": [ "string", "null" ] }, "templateId": { "type": [ "number", "null" ] }, "user": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ] }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "readStatus": { "type": "string", "enum": [ "NOT_OPENED", "OPENED" ] }, "signingStatus": { "type": "string", "enum": [ "NOT_SIGNED", "SIGNED", "REJECTED" ] }, "sendStatus": { "type": "string", "enum": [ "NOT_SENT", "SENT" ] }, "id": { "type": "number" }, "email": { "type": "string" }, "name": { "type": "string" }, "token": { "type": "string" }, "documentDeletedAt": { "type": [ "string", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE", "CLAVE_UNICA", "FAO_HASH" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason" ] } }, "team": { "type": [ "object", "null" ], "properties": { "id": { "type": "number" }, "url": { "type": "string" } }, "required": [ "id", "url" ] } }, "required": [ "internalVersion", "type", "status", "source", "visibility", "templateType", "id", "secondaryId", "externalId", "createdAt", "updatedAt", "completedAt", "deletedAt", "title", "authOptions", "formValues", "publicTitle", "publicDescription", "userId", "teamId", "folderId", "templateId", "user", "recipients", "team" ] } }, "count": { "type": "number" }, "currentPage": { "type": "number" }, "perPage": { "type": "number" }, "totalPages": { "type": "number" } }, "required": [ "data", "count", "currentPage", "perPage", "totalPages" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/{envelopeId}/audit-log": { "get": { "operationId": "envelope-auditLog-find", "summary": "Get envelope audit logs", "description": "Find audit logs based on a search criteria", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "envelopeId", "description": "Envelope ID", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "page", "description": "The pagination page number, starts at 1.", "schema": { "type": "number", "minimum": 1 } }, { "in": "query", "name": "perPage", "description": "The number of items per page.", "schema": { "type": "number", "minimum": 1, "maximum": 100 } }, { "in": "query", "name": "orderByColumn", "schema": { "type": "string", "enum": [ "createdAt" ] } }, { "in": "query", "name": "orderByDirection", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "envelopeId": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "userId": { "type": [ "number", "null" ] }, "userAgent": { "type": [ "string", "null" ] }, "ipAddress": { "type": [ "string", "null" ] } }, "required": [ "id", "createdAt", "envelopeId" ] }, { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ENVELOPE_ITEM_CREATED" ] }, "data": { "type": "object", "properties": { "envelopeItemId": { "type": "string" }, "envelopeItemTitle": { "type": "string" } }, "required": [ "envelopeItemId", "envelopeItemTitle" ] } }, "required": [ "type", "data" ], "title": "ENVELOPE_ITEM_CREATED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ENVELOPE_ITEM_DELETED" ] }, "data": { "type": "object", "properties": { "envelopeItemId": { "type": "string" }, "envelopeItemTitle": { "type": "string" } }, "required": [ "envelopeItemId", "envelopeItemTitle" ] } }, "required": [ "type", "data" ], "title": "ENVELOPE_ITEM_DELETED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ENVELOPE_ITEM_UPDATED" ] }, "data": { "type": "object", "properties": { "envelopeItemId": { "type": "string" }, "changes": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "field", "from", "to" ] } } }, "required": [ "envelopeItemId", "changes" ] } }, "required": [ "type", "data" ], "title": "ENVELOPE_ITEM_UPDATED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ENVELOPE_ITEM_PDF_REPLACED" ] }, "data": { "type": "object", "properties": { "envelopeItemId": { "type": "string" }, "envelopeItemTitle": { "type": "string" } }, "required": [ "envelopeItemId", "envelopeItemTitle" ] } }, "required": [ "type", "data" ], "title": "ENVELOPE_ITEM_PDF_REPLACED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL_SENT" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "emailType": { "type": "string", "enum": [ "SIGNING_REQUEST", "VIEW_REQUEST", "APPROVE_REQUEST", "ASSISTING_REQUEST", "CC", "DOCUMENT_COMPLETED", "REMINDER" ] }, "isResending": { "type": "boolean" } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "emailType", "isResending" ] } }, "required": [ "type", "data" ], "title": "EMAIL_SENT" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_COMPLETED" ] }, "data": { "type": "object", "properties": { "transactionId": { "type": "string" } }, "required": [ "transactionId" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_COMPLETED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_CREATED" ] }, "data": { "type": "object", "properties": { "title": { "type": "string" }, "source": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT" ] } }, "required": [ "type" ], "title": "DOCUMENT" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEMPLATE" ] }, "templateId": { "type": "number" } }, "required": [ "type", "templateId" ], "title": "TEMPLATE" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEMPLATE_DIRECT_LINK" ] }, "templateId": { "type": "number" }, "directRecipientEmail": { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" } }, "required": [ "type", "templateId", "directRecipientEmail" ], "title": "TEMPLATE_DIRECT_LINK" } ] } }, "required": [ "title" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_CREATED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_DELETED" ] }, "data": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SOFT", "HARD" ] } }, "required": [ "type" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_DELETED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_CANCELLED" ] }, "data": { "type": "object", "properties": { "reason": { "type": "string" } } } }, "required": [ "type", "data" ], "title": "DOCUMENT_CANCELLED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_MOVED_TO_TEAM" ] }, "data": { "type": "object", "properties": { "movedByUserId": { "type": "number" }, "fromPersonalAccount": { "type": "boolean" }, "toTeamId": { "type": "number" } }, "required": [ "movedByUserId", "fromPersonalAccount", "toTeamId" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_MOVED_TO_TEAM" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_DELEGATED_OWNER_CREATED" ] }, "data": { "type": "object", "properties": { "delegatedOwnerName": { "type": [ "string", "null" ] }, "delegatedOwnerEmail": { "type": "string" }, "teamName": { "type": "string" } }, "required": [ "delegatedOwnerName", "delegatedOwnerEmail", "teamName" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_DELEGATED_OWNER_CREATED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_FIELDS_AUTO_INSERTED" ] }, "data": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "number" }, "fieldType": { "type": "string", "enum": [ "SIGNATURE", "INITIALS", "NAME", "EMAIL", "DATE", "TEXT", "NUMBER", "RADIO", "CHECKBOX", "DROPDOWN", "RUT", "RUT_FIRMADO" ] }, "recipientId": { "type": "number" } }, "required": [ "fieldId", "fieldType", "recipientId" ] } } }, "required": [ "fields" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_FIELDS_AUTO_INSERTED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_FIELD_INSERTED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "fieldId": { "type": "string" }, "field": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ], "title": "INITIALS" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ], "title": "EMAIL" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ], "title": "DATE" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ], "title": "NAME" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ], "title": "TEXT" }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "SIGNATURE" ] }, { "type": "string", "enum": [] } ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ], "title": "RADIO" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ], "title": "CHECKBOX" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ], "title": "DROPDOWN" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ], "title": "NUMBER" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RUT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "rut" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "rut", "fontSize": 12, "overflow": "auto" } } }, "required": [ "type" ], "title": "RUT" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RUT_FIRMADO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "rut_firmado" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "rut_firmado", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ], "title": "RUT_FIRMADO" } ] }, "fieldSecurity": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE", "CLAVE_UNICA", "FAO_HASH" ] } } } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "fieldId", "field" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_FIELD_INSERTED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_FIELD_UNINSERTED" ] }, "data": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "SIGNATURE", "INITIALS", "NAME", "EMAIL", "DATE", "TEXT", "NUMBER", "RADIO", "CHECKBOX", "DROPDOWN", "RUT", "RUT_FIRMADO" ] }, "fieldId": { "type": "string" } }, "required": [ "field", "fieldId" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_FIELD_UNINSERTED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_FIELD_PREFILLED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "fieldId": { "type": "string" }, "field": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ], "title": "INITIALS" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ], "title": "EMAIL" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ], "title": "DATE" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ], "title": "NAME" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ], "title": "TEXT" }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "SIGNATURE" ] }, { "type": "string", "enum": [] } ] }, "data": { "type": "string" } }, "required": [ "type", "data" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ], "title": "RADIO" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ], "title": "CHECKBOX" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ], "title": "DROPDOWN" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "data": { "type": "string" } }, "required": [ "type", "data" ], "title": "NUMBER" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RUT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "rut" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "rut", "fontSize": 12, "overflow": "auto" } } }, "required": [ "type" ], "title": "RUT" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RUT_FIRMADO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "rut_firmado" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "rut_firmado", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ], "title": "RUT_FIRMADO" } ] }, "fieldSecurity": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE", "CLAVE_UNICA", "FAO_HASH" ] } } } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "fieldId", "field" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_FIELD_PREFILLED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_VISIBILITY_UPDATED" ] }, "data": { "type": "object", "properties": { "from": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "to": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "from", "to" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_VISIBILITY_UPDATED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_GLOBAL_AUTH_ACCESS_UPDATED" ] }, "data": { "type": "object", "properties": { "from": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "to": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "from", "to" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_GLOBAL_AUTH_ACCESS_UPDATED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_GLOBAL_AUTH_ACTION_UPDATED" ] }, "data": { "type": "object", "properties": { "from": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "to": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "from", "to" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_GLOBAL_AUTH_ACTION_UPDATED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_META_UPDATED" ] }, "data": { "type": "object", "properties": { "changes": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "DATE_FORMAT" ] }, { "type": "string", "enum": [ "MESSAGE" ] }, { "type": "string", "enum": [ "REDIRECT_URL" ] }, { "type": "string", "enum": [ "SUBJECT" ] }, { "type": "string", "enum": [ "TIMEZONE" ] }, { "type": "string", "enum": [ "EMAIL_ID" ] }, { "type": "string", "enum": [ "EMAIL_REPLY_TO" ] }, { "type": "string", "enum": [ "EMAIL_SETTINGS" ] } ] }, "from": { "type": [ "string", "null" ] }, "to": { "type": [ "string", "null" ] } }, "required": [ "type", "from", "to" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "PASSWORD" ] } }, "required": [ "type" ], "title": "PASSWORD" } ] } } }, "required": [ "changes" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_META_UPDATED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_OPENED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "accessAuth" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_OPENED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_VIEWED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "accessAuth" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_VIEWED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_RECIPIENT_COMPLETED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE", "CLAVE_UNICA", "FAO_HASH" ] } } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "actionAuth" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_RECIPIENT_COMPLETED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_RECIPIENT_REJECTED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "reason": { "type": "string" }, "isExternal": { "type": "boolean" }, "onBehalfOfUserEmail": { "type": "string" }, "onBehalfOfUserName": { "type": [ "string", "null" ] } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "reason" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_RECIPIENT_REJECTED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_ACCESS_AUTH_2FA_REQUESTED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" } }, "required": [ "recipientEmail", "recipientName", "recipientId" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_ACCESS_AUTH_2FA_REQUESTED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_ACCESS_AUTH_2FA_VALIDATED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" } }, "required": [ "recipientEmail", "recipientName", "recipientId" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_ACCESS_AUTH_2FA_VALIDATED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_ACCESS_AUTH_2FA_FAILED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" } }, "required": [ "recipientEmail", "recipientName", "recipientId" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_ACCESS_AUTH_2FA_FAILED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_SENT" ] }, "data": { "type": "object" } }, "required": [ "type", "data" ], "title": "DOCUMENT_SENT" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_TITLE_UPDATED" ] }, "data": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_TITLE_UPDATED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_EXTERNAL_ID_UPDATED" ] }, "data": { "type": "object", "properties": { "from": { "type": [ "string", "null" ] }, "to": { "type": [ "string", "null" ] } } } }, "required": [ "type", "data" ], "title": "DOCUMENT_EXTERNAL_ID_UPDATED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FIELD_CREATED" ] }, "data": { "type": "object", "properties": { "fieldId": { "type": "string" }, "fieldRecipientEmail": { "type": "string" }, "fieldRecipientId": { "type": "number" }, "fieldType": { "type": "string" } }, "required": [ "fieldId", "fieldRecipientEmail", "fieldRecipientId", "fieldType" ] } }, "required": [ "type", "data" ], "title": "FIELD_CREATED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FIELD_DELETED" ] }, "data": { "type": "object", "properties": { "fieldId": { "type": "string" }, "fieldRecipientEmail": { "type": "string" }, "fieldRecipientId": { "type": "number" }, "fieldType": { "type": "string" } }, "required": [ "fieldId", "fieldRecipientEmail", "fieldRecipientId", "fieldType" ] } }, "required": [ "type", "data" ], "title": "FIELD_DELETED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FIELD_UPDATED" ] }, "data": { "type": "object", "properties": { "fieldId": { "type": "string" }, "fieldRecipientEmail": { "type": "string" }, "fieldRecipientId": { "type": "number" }, "fieldType": { "type": "string" }, "changes": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DIMENSION" ] }, "from": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "required": [ "width", "height" ] }, "to": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "required": [ "width", "height" ] } }, "required": [ "type", "from", "to" ], "title": "DIMENSION" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "POSITION" ] }, "from": { "type": "object", "properties": { "page": { "type": "number" }, "positionX": { "type": "number" }, "positionY": { "type": "number" } }, "required": [ "page", "positionX", "positionY" ] }, "to": { "type": "object", "properties": { "page": { "type": "number" }, "positionX": { "type": "number" }, "positionY": { "type": "number" } }, "required": [ "page", "positionX", "positionY" ] } }, "required": [ "type", "from", "to" ], "title": "POSITION" } ] } } }, "required": [ "fieldId", "fieldRecipientEmail", "fieldRecipientId", "fieldType", "changes" ] } }, "required": [ "type", "data" ], "title": "FIELD_UPDATED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RECIPIENT_CREATED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE", "CLAVE_UNICA", "FAO_HASH" ] } } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "accessAuth", "actionAuth" ] } }, "required": [ "type", "data" ], "title": "RECIPIENT_CREATED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RECIPIENT_UPDATED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "changes": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "from": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "to": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "enum": [ "ACTION_AUTH" ] } }, "required": [ "from", "to", "type" ], "title": "ACTION_AUTH" }, { "type": "object", "properties": { "from": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "to": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "enum": [ "ACCESS_AUTH" ] } }, "required": [ "from", "to", "type" ], "title": "ACCESS_AUTH" }, { "type": "object", "properties": { "from": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "to": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "enum": [ "NAME" ] } }, "required": [ "from", "to", "type" ], "title": "NAME" }, { "type": "object", "properties": { "from": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "to": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "enum": [ "ROLE" ] } }, "required": [ "from", "to", "type" ], "title": "ROLE" }, { "type": "object", "properties": { "from": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "to": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "type": "string", "enum": [ "EMAIL" ] } }, "required": [ "from", "to", "type" ], "title": "EMAIL" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RUT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "rut" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "rut", "fontSize": 12, "overflow": "auto" } } }, "required": [ "type" ], "title": "RUT" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RUT_FIRMADO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "rut_firmado" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "rut_firmado", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ], "title": "RUT_FIRMADO" } ] } } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "changes" ] } }, "required": [ "type", "data" ], "title": "RECIPIENT_UPDATED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RECIPIENT_DELETED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole" ] } }, "required": [ "type", "data" ], "title": "RECIPIENT_DELETED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_RECIPIENT_EXPIRED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" } }, "required": [ "recipientEmail", "recipientName", "recipientId" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_RECIPIENT_EXPIRED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_RECIPIENT_CSC_AUTHENTICATED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "providerId": { "type": "string" }, "credentialId": { "type": "string" }, "signatureAlgorithm": { "type": "string" }, "digestAlgorithm": { "type": "string" } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "providerId", "credentialId", "signatureAlgorithm", "digestAlgorithm" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_RECIPIENT_CSC_AUTHENTICATED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_RECIPIENT_CSC_AUTHENTICATION_FAILED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "providerId": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "providerId", "reason" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_RECIPIENT_CSC_AUTHENTICATION_FAILED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_RECIPIENT_CSC_SIGN_REQUESTED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "providerId": { "type": "string" }, "credentialId": { "type": "string" }, "sessionId": { "type": "string" }, "numSignatures": { "type": "number" } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "providerId", "credentialId", "sessionId", "numSignatures" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_RECIPIENT_CSC_SIGN_REQUESTED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_RECIPIENT_CSC_AUTHORIZED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "providerId": { "type": "string" }, "credentialId": { "type": "string" }, "sessionId": { "type": "string" }, "sadExpiresAt": { "type": "string" } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "providerId", "credentialId", "sessionId", "sadExpiresAt" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_RECIPIENT_CSC_AUTHORIZED" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DOCUMENT_RECIPIENT_CSC_SIGNED" ] }, "data": { "type": "object", "properties": { "recipientEmail": { "type": "string" }, "recipientName": { "type": "string" }, "recipientId": { "type": "number" }, "recipientRole": { "type": "string" }, "providerId": { "type": "string" }, "credentialId": { "type": "string" }, "sessionId": { "type": "string" }, "numItemsSigned": { "type": "number" }, "signatureAlgorithm": { "type": "string" }, "digestAlgorithm": { "type": "string" } }, "required": [ "recipientEmail", "recipientName", "recipientId", "recipientRole", "providerId", "credentialId", "sessionId", "numItemsSigned", "signatureAlgorithm", "digestAlgorithm" ] } }, "required": [ "type", "data" ], "title": "DOCUMENT_RECIPIENT_CSC_SIGNED" } ] } ] } }, "count": { "type": "number" }, "currentPage": { "type": "number" }, "perPage": { "type": "number" }, "totalPages": { "type": "number" } }, "required": [ "data", "count", "currentPage", "perPage", "totalPages" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/{envelopeId}/audit-log/download": { "get": { "operationId": "envelope-auditLog-downloadPdf", "summary": "Download envelope audit log PDF", "description": "Download the audit log for a document as a PDF.", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "envelopeId", "description": "The ID of the envelope to download the audit log for.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "headers": { "Content-Type": { "schema": { "type": "string", "enum": [ "application/pdf" ] }, "required": true } }, "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/{envelopeId}/certificate/download": { "get": { "operationId": "envelope-certificate-downloadPdf", "summary": "Download envelope certificate PDF", "description": "Download the signing certificate for a completed document as a PDF.", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "envelopeId", "description": "The ID of the envelope to download the certificate for.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "headers": { "Content-Type": { "schema": { "type": "string", "enum": [ "application/pdf" ] }, "required": true } }, "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/{envelopeId}": { "get": { "operationId": "envelope-get", "summary": "Get envelope", "description": "Returns an envelope given an ID", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "envelopeId", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "internalVersion": { "type": "number" }, "type": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" ] }, "source": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE", "TEMPLATE_DIRECT_LINK" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "templateType": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] }, "id": { "type": "string" }, "secondaryId": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "completedAt": { "type": [ "string", "null" ] }, "deletedAt": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "formValues": { "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "publicTitle": { "type": "string" }, "publicDescription": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "folderId": { "type": [ "string", "null" ] }, "templateId": { "type": [ "number", "null" ] }, "documentMeta": { "type": "object", "properties": { "signingOrder": { "type": "string", "enum": [ "PARALLEL", "SEQUENTIAL" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "id": { "type": "string" }, "subject": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "dateFormat": { "type": [ "string", "null" ] }, "redirectUrl": { "type": [ "string", "null" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "allowDictateNextSigner": { "type": "boolean" }, "language": { "type": "string" }, "emailSettings": { "type": [ "object", "null" ], "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "required": [ "recipientSigningRequest", "recipientRemoved", "recipientSigned", "documentPending", "documentCompleted", "documentDeleted", "ownerDocumentCompleted", "ownerRecipientExpired", "ownerDocumentCreated" ], "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ] }, "envelopeExpirationPeriod": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month", "year" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ], "title": "Duration" }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ], "title": "Disabled" } ] } }, "required": [ "signingOrder", "distributionMethod", "id", "subject", "message", "timezone", "dateFormat", "redirectUrl", "typedSignatureEnabled", "uploadSignatureEnabled", "drawSignatureEnabled", "allowDictateNextSigner", "language", "emailSettings", "emailId", "emailReplyTo", "envelopeExpirationPeriod" ] }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "readStatus": { "type": "string", "enum": [ "NOT_OPENED", "OPENED" ] }, "signingStatus": { "type": "string", "enum": [ "NOT_SIGNED", "SIGNED", "REJECTED" ] }, "sendStatus": { "type": "string", "enum": [ "NOT_SENT", "SENT" ] }, "id": { "type": "number" }, "email": { "type": "string" }, "name": { "type": "string" }, "token": { "type": "string" }, "documentDeletedAt": { "type": [ "string", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE", "CLAVE_UNICA", "FAO_HASH" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason" ] } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "envelopeItemId": { "type": "string" }, "type": { "type": "string", "enum": [ "SIGNATURE", "INITIALS", "NAME", "EMAIL", "DATE", "TEXT", "NUMBER", "RADIO", "CHECKBOX", "DROPDOWN", "RUT", "RUT_FIRMADO" ] }, "id": { "type": "number" }, "secondaryId": { "type": "string" }, "recipientId": { "type": "number" }, "page": { "type": "number" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ], "title": "signature" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "title": "initials" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "title": "name" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ], "title": "email" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ], "title": "date" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "title": "text" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "title": "number" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "radio" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ], "title": "radio" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "checkbox" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "validationRule": { "type": "string" }, "validationLength": { "type": "number" }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ], "title": "checkbox" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ], "title": "dropdown" } ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } }, "envelopeItems": { "type": "array", "items": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "documentDataId": { "type": "string" }, "id": { "type": "string" }, "title": { "type": "string" }, "order": { "type": "number" } }, "required": [ "envelopeId", "documentDataId", "id", "title", "order" ] } }, "directLink": { "type": [ "object", "null" ], "properties": { "directTemplateRecipientId": { "type": "number" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "token": { "type": "string" } }, "required": [ "directTemplateRecipientId", "enabled", "id", "token" ] }, "team": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" } }, "required": [ "id", "url" ] }, "user": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ] } }, "required": [ "internalVersion", "type", "status", "source", "visibility", "templateType", "id", "secondaryId", "externalId", "createdAt", "updatedAt", "completedAt", "deletedAt", "title", "authOptions", "formValues", "publicTitle", "publicDescription", "userId", "teamId", "folderId", "templateId", "documentMeta", "recipients", "fields", "envelopeItems", "directLink", "team", "user" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/get-many": { "post": { "operationId": "envelope-getMany", "summary": "Get multiple envelopes", "description": "Retrieve multiple envelopes by their IDs", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "envelopeId" ] }, "ids": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 20 } }, "required": [ "type", "ids" ], "title": "envelopeId" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "documentId" ] }, "ids": { "type": "array", "items": { "type": "number" }, "minItems": 1, "maxItems": 20 } }, "required": [ "type", "ids" ], "title": "documentId" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "templateId" ] }, "ids": { "type": "array", "items": { "type": "number" }, "minItems": 1, "maxItems": 20 } }, "required": [ "type", "ids" ], "title": "templateId" } ] } }, "required": [ "ids" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "internalVersion": { "type": "number" }, "type": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" ] }, "source": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE", "TEMPLATE_DIRECT_LINK" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "templateType": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] }, "id": { "type": "string" }, "secondaryId": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "completedAt": { "type": [ "string", "null" ] }, "deletedAt": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "formValues": { "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "publicTitle": { "type": "string" }, "publicDescription": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "folderId": { "type": [ "string", "null" ] }, "templateId": { "type": [ "number", "null" ] }, "documentMeta": { "type": "object", "properties": { "signingOrder": { "type": "string", "enum": [ "PARALLEL", "SEQUENTIAL" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "id": { "type": "string" }, "subject": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "dateFormat": { "type": [ "string", "null" ] }, "redirectUrl": { "type": [ "string", "null" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "allowDictateNextSigner": { "type": "boolean" }, "language": { "type": "string" }, "emailSettings": { "type": [ "object", "null" ], "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "required": [ "recipientSigningRequest", "recipientRemoved", "recipientSigned", "documentPending", "documentCompleted", "documentDeleted", "ownerDocumentCompleted", "ownerRecipientExpired", "ownerDocumentCreated" ], "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ] }, "envelopeExpirationPeriod": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month", "year" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ], "title": "Duration" }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ], "title": "Disabled" } ] } }, "required": [ "signingOrder", "distributionMethod", "id", "subject", "message", "timezone", "dateFormat", "redirectUrl", "typedSignatureEnabled", "uploadSignatureEnabled", "drawSignatureEnabled", "allowDictateNextSigner", "language", "emailSettings", "emailId", "emailReplyTo", "envelopeExpirationPeriod" ] }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "readStatus": { "type": "string", "enum": [ "NOT_OPENED", "OPENED" ] }, "signingStatus": { "type": "string", "enum": [ "NOT_SIGNED", "SIGNED", "REJECTED" ] }, "sendStatus": { "type": "string", "enum": [ "NOT_SENT", "SENT" ] }, "id": { "type": "number" }, "email": { "type": "string" }, "name": { "type": "string" }, "token": { "type": "string" }, "documentDeletedAt": { "type": [ "string", "null" ] }, "expired": { "type": [ "string", "null" ] }, "expiresAt": { "type": [ "string", "null" ] }, "expirationNotifiedAt": { "type": [ "string", "null" ] }, "signedAt": { "type": [ "string", "null" ] }, "authOptions": { "type": [ "object", "null" ], "properties": { "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE", "CLAVE_UNICA", "FAO_HASH" ] } } }, "required": [ "accessAuth", "actionAuth" ] }, "signingOrder": { "type": [ "number", "null" ] }, "rejectionReason": { "type": [ "string", "null" ] } }, "required": [ "envelopeId", "role", "readStatus", "signingStatus", "sendStatus", "id", "email", "name", "token", "documentDeletedAt", "expired", "expiresAt", "expirationNotifiedAt", "signedAt", "authOptions", "signingOrder", "rejectionReason" ] } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "envelopeItemId": { "type": "string" }, "type": { "type": "string", "enum": [ "SIGNATURE", "INITIALS", "NAME", "EMAIL", "DATE", "TEXT", "NUMBER", "RADIO", "CHECKBOX", "DROPDOWN", "RUT", "RUT_FIRMADO" ] }, "id": { "type": "number" }, "secondaryId": { "type": "string" }, "recipientId": { "type": "number" }, "page": { "type": "number" }, "positionX": {}, "positionY": {}, "width": {}, "height": {}, "customText": { "type": "string" }, "inserted": { "type": "boolean" }, "fieldMeta": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "overflow", "type" ], "title": "signature" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "title": "initials" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "title": "name" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ], "title": "email" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "overflow", "type" ], "title": "date" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "title": "text" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "title": "number" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "radio" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ], "title": "radio" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "checkbox" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "validationRule": { "type": "string" }, "validationLength": { "type": "number" }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type", "direction" ], "title": "checkbox" }, { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ], "title": "dropdown" } ] } }, "required": [ "envelopeId", "envelopeItemId", "type", "id", "secondaryId", "recipientId", "page", "positionX", "positionY", "width", "height", "customText", "inserted", "fieldMeta" ] } }, "envelopeItems": { "type": "array", "items": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "documentDataId": { "type": "string" }, "id": { "type": "string" }, "title": { "type": "string" }, "order": { "type": "number" } }, "required": [ "envelopeId", "documentDataId", "id", "title", "order" ] } }, "directLink": { "type": [ "object", "null" ], "properties": { "directTemplateRecipientId": { "type": "number" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "token": { "type": "string" } }, "required": [ "directTemplateRecipientId", "enabled", "id", "token" ] }, "team": { "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" } }, "required": [ "id", "url" ] }, "user": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "name", "email" ] } }, "required": [ "internalVersion", "type", "status", "source", "visibility", "templateType", "id", "secondaryId", "externalId", "createdAt", "updatedAt", "completedAt", "deletedAt", "title", "authOptions", "formValues", "publicTitle", "publicDescription", "userId", "teamId", "folderId", "templateId", "documentMeta", "recipients", "fields", "envelopeItems", "directLink", "team", "user" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/create": { "post": { "operationId": "envelope-create", "summary": "Create envelope", "description": "Create an envelope using form data.", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "type": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] }, "delegatedDocumentOwner": { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" }, "externalId": { "type": "string", "maxLength": 255 }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } }, "formValues": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "folderId": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "email": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "maxLength": 254 } ] }, "name": { "type": "string", "maxLength": 255 }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": "number" }, "accessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] }, "default": [] }, "actionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD", "EXPLICIT_NONE", "CLAVE_UNICA", "FAO_HASH" ] }, "default": [] }, "fields": { "type": "array", "items": { "allOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SIGNATURE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "signature" ] } }, "required": [ "type" ], "default": { "type": "signature", "fontSize": 18, "overflow": "auto" } } }, "required": [ "type" ], "title": "SIGNATURE" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INITIALS" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "initials" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "initials", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ], "title": "INITIALS" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NAME" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "name" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "name", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ], "title": "NAME" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "EMAIL" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "email" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "email", "fontSize": 12, "textAlign": "left", "overflow": "auto" } } }, "required": [ "type" ], "title": "EMAIL" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATE" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ], "default": "auto" }, "type": { "type": "string", "enum": [ "date" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "date", "fontSize": 12, "textAlign": "left", "overflow": "auto" } } }, "required": [ "type" ], "title": "DATE" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TEXT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "default": { "type": "text", "fontSize": 12, "textAlign": "left", "label": "", "placeholder": "", "text": "", "required": false, "readOnly": false } } }, "required": [ "type" ], "title": "TEXT" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "number" ] }, "numberFormat": { "type": [ "string", "null" ] }, "value": { "type": "string" }, "minValue": { "type": [ "number", "null" ] }, "maxValue": { "type": [ "number", "null" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] }, "lineHeight": { "type": [ "number", "null" ], "minimum": 1, "maximum": 10 }, "letterSpacing": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "verticalAlign": { "type": [ "string", "null" ], "enum": [ "top", "middle", "bottom", null ] } }, "required": [ "type" ], "default": { "type": "number", "fontSize": 12, "textAlign": "left", "label": "", "placeholder": "", "required": false, "readOnly": false } } }, "required": [ "type" ], "title": "NUMBER" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RADIO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "radio" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ], "default": { "type": "radio", "fontSize": 12, "values": [ { "id": 1, "checked": false, "value": "" } ], "required": false, "readOnly": false, "direction": "vertical" } } }, "required": [ "type" ], "title": "RADIO" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CHECKBOX" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "checkbox" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "checked": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "id", "checked", "value" ] } }, "validationRule": { "type": "string" }, "validationLength": { "type": "number" }, "direction": { "type": "string", "enum": [ "vertical", "horizontal" ], "default": "vertical" } }, "required": [ "type" ], "default": { "type": "checkbox", "fontSize": 12, "values": [ { "id": 1, "checked": false, "value": "" } ], "validationRule": "", "validationLength": 0, "required": false, "readOnly": false, "direction": "vertical" } } }, "required": [ "type" ], "title": "CHECKBOX" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DROPDOWN" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "dropdown" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] } }, "defaultValue": { "type": "string" } }, "required": [ "type" ], "default": { "type": "dropdown", "fontSize": 12, "values": [ { "value": "Option 1" } ], "defaultValue": "", "required": false, "readOnly": false } } }, "required": [ "type" ], "title": "DROPDOWN" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RUT" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "rut" ] }, "text": { "type": "string" }, "characterLimit": { "type": "number", "minimum": 0 }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "rut", "fontSize": 12, "overflow": "auto" } } }, "required": [ "type" ], "title": "RUT" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "RUT_FIRMADO" ] }, "fieldMeta": { "type": "object", "properties": { "label": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "fontSize": { "type": "number", "minimum": 8, "maximum": 96, "default": 12 }, "overflow": { "type": "string", "enum": [ "auto", "horizontal", "vertical", "crop" ] }, "type": { "type": "string", "enum": [ "rut_firmado" ] }, "textAlign": { "type": "string", "enum": [ "left", "center", "right" ] } }, "required": [ "type" ], "default": { "type": "rut_firmado", "fontSize": 12, "textAlign": "left" } } }, "required": [ "type" ], "title": "RUT_FIRMADO" } ] }, { "type": "object", "properties": { "identifier": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "page": { "type": "number", "minimum": 1 }, "positionX": { "type": "number", "minimum": 0, "maximum": 100 }, "positionY": { "type": "number", "minimum": 0, "maximum": 100 }, "width": { "type": "number", "minimum": 0, "maximum": 100 }, "height": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "page", "positionX", "positionY", "width", "height" ] } ] } } }, "required": [ "email", "name", "role" ] } }, "meta": { "type": "object", "properties": { "subject": { "type": "string", "maxLength": 254 }, "message": { "type": "string", "maxLength": 5000 }, "timezone": { "type": "string" }, "dateFormat": { "type": "string", "enum": [ "yyyy-MM-dd hh:mm a", "yyyy-MM-dd", "dd/MM/yyyy", "dd-MM-yyyy", "MM/dd/yyyy", "yy-MM-dd", "MMMM dd, yyyy", "EEEE, MMMM dd, yyyy", "dd/MM/yyyy hh:mm a", "dd/MM/yyyy HH:mm", "dd-MM-yyyy hh:mm a", "dd-MM-yyyy HH:mm", "MM/dd/yyyy hh:mm a", "MM/dd/yyyy HH:mm", "dd.MM.yyyy", "dd.MM.yyyy HH:mm", "yyyy-MM-dd HH:mm", "yy-MM-dd hh:mm a", "yy-MM-dd HH:mm", "yyyy-MM-dd HH:mm:ss", "MMMM dd, yyyy hh:mm a", "MMMM dd, yyyy HH:mm", "EEEE, MMMM dd, yyyy hh:mm a", "EEEE, MMMM dd, yyyy HH:mm", "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "signingOrder": { "type": "string", "enum": [ "PARALLEL", "SEQUENTIAL" ] }, "allowDictateNextSigner": { "type": "boolean" }, "redirectUrl": { "type": "string" }, "language": { "type": "string", "enum": [ "en", "es" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ], "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" }, "emailSettings": { "type": [ "object", "null" ], "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "envelopeExpirationPeriod": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month", "year" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ], "title": "Duration" }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ], "title": "Disabled" } ] }, "reminderSettings": { "type": [ "object", "null" ], "properties": { "sendAfter": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ], "title": "Duration" }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ], "title": "Disabled" } ] }, "repeatEvery": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ], "title": "Duration" }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ], "title": "Disabled" } ] } }, "required": [ "sendAfter", "repeatEvery" ] } } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "data": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": [ "link" ], "default": "link" } }, "required": [ "label", "data" ] } } }, "required": [ "title", "type" ] }, "files": { "type": "array", "items": { "type": "string", "contentMediaType": "application/octet-stream" } } }, "required": [ "payload" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/use": { "post": { "operationId": "envelope-use", "summary": "Use envelope", "description": "Create a document envelope from a template envelope. Upload custom files to replace the template PDFs and map them to specific envelope items using identifiers.", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "payload": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "externalId": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "email": { "anyOf": [ { "type": "string", "enum": [ "" ] }, { "type": "string", "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$", "maxLength": 254 } ] }, "name": { "type": "string", "maxLength": 255 }, "signingOrder": { "type": "number" } }, "required": [ "id", "email" ] } }, "distributeDocument": { "type": "boolean" }, "customDocumentData": { "type": "array", "items": { "type": "object", "properties": { "identifier": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "envelopeItemId": { "type": "string" } }, "required": [ "identifier", "envelopeItemId" ] } }, "folderId": { "type": "string" }, "prefillFields": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "id": { "type": "number" } }, "required": [ "id" ] }, { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text" ] }, "label": { "type": "string" }, "placeholder": { "type": "string" }, "value": { "type": "string" } }, "required": [ "type" ], "title": "text" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "number" ] }, "label": { "type": "string" }, "placeholder": { "type": "string" }, "value": { "type": "string" } }, "required": [ "type" ], "title": "number" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "radio" ] }, "label": { "type": "string" }, "value": { "type": "string" } }, "required": [ "type" ], "title": "radio" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "checkbox" ] }, "label": { "type": "string" }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "type" ], "title": "checkbox" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dropdown" ] }, "label": { "type": "string" }, "value": { "type": "string" } }, "required": [ "type" ], "title": "dropdown" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "date" ] }, "value": { "type": "string" } }, "required": [ "type" ], "title": "date" } ] } ] } }, "override": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "subject": { "type": "string", "maxLength": 254 }, "message": { "type": "string", "maxLength": 5000 }, "timezone": { "type": "string" }, "dateFormat": { "type": "string", "enum": [ "yyyy-MM-dd hh:mm a", "yyyy-MM-dd", "dd/MM/yyyy", "dd-MM-yyyy", "MM/dd/yyyy", "yy-MM-dd", "MMMM dd, yyyy", "EEEE, MMMM dd, yyyy", "dd/MM/yyyy hh:mm a", "dd/MM/yyyy HH:mm", "dd-MM-yyyy hh:mm a", "dd-MM-yyyy HH:mm", "MM/dd/yyyy hh:mm a", "MM/dd/yyyy HH:mm", "dd.MM.yyyy", "dd.MM.yyyy HH:mm", "yyyy-MM-dd HH:mm", "yy-MM-dd hh:mm a", "yy-MM-dd HH:mm", "yyyy-MM-dd HH:mm:ss", "MMMM dd, yyyy hh:mm a", "MMMM dd, yyyy HH:mm", "EEEE, MMMM dd, yyyy hh:mm a", "EEEE, MMMM dd, yyyy HH:mm", "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" ] }, "redirectUrl": { "type": "string" }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "emailSettings": { "type": "object", "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "language": { "type": "string", "enum": [ "en", "es" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "allowDictateNextSigner": { "type": "boolean" }, "envelopeExpirationPeriod": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month", "year" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ], "title": "Duration" }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ], "title": "Disabled" } ] } } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "data": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": [ "link" ], "default": "link" } }, "required": [ "label", "data" ] } }, "formValues": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } } }, "required": [ "envelopeId" ] }, "files": { "type": "array", "items": { "type": "string", "contentMediaType": "application/octet-stream" } } }, "required": [ "payload" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" }, "token": { "type": "string" }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": [ "number", "null" ] }, "signingUrl": { "type": "string" } }, "required": [ "id", "name", "email", "token", "role", "signingOrder", "signingUrl" ] } } }, "required": [ "id", "recipients" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/update": { "post": { "operationId": "envelope-update", "summary": "Update envelope", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "data": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "externalId": { "type": [ "string", "null" ], "maxLength": 255 }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } }, "folderId": { "type": [ "string", "null" ] }, "templateType": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] } } }, "meta": { "type": "object", "properties": { "subject": { "type": "string", "maxLength": 254 }, "message": { "type": "string", "maxLength": 5000 }, "timezone": { "type": "string" }, "dateFormat": { "type": "string", "enum": [ "yyyy-MM-dd hh:mm a", "yyyy-MM-dd", "dd/MM/yyyy", "dd-MM-yyyy", "MM/dd/yyyy", "yy-MM-dd", "MMMM dd, yyyy", "EEEE, MMMM dd, yyyy", "dd/MM/yyyy hh:mm a", "dd/MM/yyyy HH:mm", "dd-MM-yyyy hh:mm a", "dd-MM-yyyy HH:mm", "MM/dd/yyyy hh:mm a", "MM/dd/yyyy HH:mm", "dd.MM.yyyy", "dd.MM.yyyy HH:mm", "yyyy-MM-dd HH:mm", "yy-MM-dd hh:mm a", "yy-MM-dd HH:mm", "yyyy-MM-dd HH:mm:ss", "MMMM dd, yyyy hh:mm a", "MMMM dd, yyyy HH:mm", "EEEE, MMMM dd, yyyy hh:mm a", "EEEE, MMMM dd, yyyy HH:mm", "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "signingOrder": { "type": "string", "enum": [ "PARALLEL", "SEQUENTIAL" ] }, "allowDictateNextSigner": { "type": "boolean" }, "redirectUrl": { "type": "string" }, "language": { "type": "string", "enum": [ "en", "es" ] }, "typedSignatureEnabled": { "type": "boolean" }, "uploadSignatureEnabled": { "type": "boolean" }, "drawSignatureEnabled": { "type": "boolean" }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ], "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" }, "emailSettings": { "type": [ "object", "null" ], "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } }, "envelopeExpirationPeriod": { "nullable": true, "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month", "year" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ], "title": "Duration" }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ], "title": "Disabled" } ] }, "reminderSettings": { "type": [ "object", "null" ], "properties": { "sendAfter": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ], "title": "Duration" }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ], "title": "Disabled" } ] }, "repeatEvery": { "anyOf": [ { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "day", "week", "month" ] }, "amount": { "type": "integer", "minimum": 1 } }, "required": [ "unit", "amount" ], "title": "Duration" }, { "type": "object", "properties": { "disabled": { "type": "boolean", "enum": [ true ] } }, "required": [ "disabled" ], "title": "Disabled" } ] } }, "required": [ "sendAfter", "repeatEvery" ] } } } }, "required": [ "envelopeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "internalVersion": { "type": "number" }, "type": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" ] }, "source": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE", "TEMPLATE_DIRECT_LINK" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "templateType": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "ORGANISATION" ] }, "id": { "type": "string" }, "secondaryId": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "completedAt": { "type": [ "string", "null" ] }, "deletedAt": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "authOptions": { "type": [ "object", "null" ], "properties": { "globalAccessAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "TWO_FACTOR_AUTH" ] } }, "globalActionAuth": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT", "PASSKEY", "TWO_FACTOR_AUTH", "PASSWORD" ] } } }, "required": [ "globalAccessAuth", "globalActionAuth" ] }, "formValues": { "type": [ "object", "null" ], "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "publicTitle": { "type": "string" }, "publicDescription": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "folderId": { "type": [ "string", "null" ] } }, "required": [ "internalVersion", "type", "status", "source", "visibility", "templateType", "id", "secondaryId", "externalId", "createdAt", "updatedAt", "completedAt", "deletedAt", "title", "authOptions", "formValues", "publicTitle", "publicDescription", "userId", "teamId", "folderId" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/delete": { "post": { "operationId": "envelope-delete", "summary": "Delete envelope", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" } }, "required": [ "envelopeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/cancel": { "post": { "operationId": "envelope-cancel", "summary": "Cancel envelope", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "envelopeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/duplicate": { "post": { "operationId": "envelope-duplicate", "summary": "Duplicate envelope", "description": "Duplicate an envelope with all its settings", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string", "minLength": 1 }, "includeRecipients": { "type": "boolean", "default": true }, "includeFields": { "type": "boolean", "default": true } }, "required": [ "envelopeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/distribute": { "post": { "operationId": "envelope-distribute", "summary": "Distribute envelope", "description": "Send the envelope to recipients based on your distribution method", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "meta": { "type": "object", "properties": { "subject": { "type": "string", "maxLength": 254 }, "message": { "type": "string", "maxLength": 5000 }, "timezone": { "type": "string" }, "dateFormat": { "type": "string", "enum": [ "yyyy-MM-dd hh:mm a", "yyyy-MM-dd", "dd/MM/yyyy", "dd-MM-yyyy", "MM/dd/yyyy", "yy-MM-dd", "MMMM dd, yyyy", "EEEE, MMMM dd, yyyy", "dd/MM/yyyy hh:mm a", "dd/MM/yyyy HH:mm", "dd-MM-yyyy hh:mm a", "dd-MM-yyyy HH:mm", "MM/dd/yyyy hh:mm a", "MM/dd/yyyy HH:mm", "dd.MM.yyyy", "dd.MM.yyyy HH:mm", "yyyy-MM-dd HH:mm", "yy-MM-dd hh:mm a", "yy-MM-dd HH:mm", "yyyy-MM-dd HH:mm:ss", "MMMM dd, yyyy hh:mm a", "MMMM dd, yyyy HH:mm", "EEEE, MMMM dd, yyyy hh:mm a", "EEEE, MMMM dd, yyyy HH:mm", "yyyy-MM-dd'T'HH:mm:ss.SSSXXX" ] }, "distributionMethod": { "type": "string", "enum": [ "EMAIL", "NONE" ] }, "redirectUrl": { "type": "string" }, "language": { "type": "string", "enum": [ "en", "es" ] }, "emailId": { "type": [ "string", "null" ] }, "emailReplyTo": { "type": [ "string", "null" ], "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\\u{0080}-\\u{FFFF}-]+@[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?(?:\\.[a-zA-Z0-9\\u{0080}-\\u{FFFF}](?:[a-zA-Z0-9\\u{0080}-\\u{FFFF}-]{0,61}[a-zA-Z0-9\\u{0080}-\\u{FFFF}])?)*$" }, "emailSettings": { "type": [ "object", "null" ], "properties": { "recipientSigningRequest": { "type": "boolean", "default": true }, "recipientRemoved": { "type": "boolean", "default": true }, "recipientSigned": { "type": "boolean", "default": true }, "documentPending": { "type": "boolean", "default": true }, "documentCompleted": { "type": "boolean", "default": true }, "documentDeleted": { "type": "boolean", "default": true }, "ownerDocumentCompleted": { "type": "boolean", "default": true }, "ownerRecipientExpired": { "type": "boolean", "default": true }, "ownerDocumentCreated": { "type": "boolean", "default": true } }, "default": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } } } } }, "required": [ "envelopeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "id": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" }, "token": { "type": "string" }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": [ "number", "null" ] }, "signingUrl": { "type": "string" } }, "required": [ "id", "name", "email", "token", "role", "signingOrder", "signingUrl" ] } } }, "required": [ "success", "id", "recipients" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/envelope/redistribute": { "post": { "operationId": "envelope-redistribute", "summary": "Redistribute envelope", "description": "Redistribute the envelope to the provided recipients who have not actioned the envelope. Will use the distribution method set in the envelope. This also refreshes the signing-link expiration for the targeted unsigned recipients, renewing any expired links.", "tags": [ "Envelope" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "number" }, "minItems": 1 } }, "required": [ "envelopeId", "recipients" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "id": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" }, "token": { "type": "string" }, "role": { "type": "string", "enum": [ "CC", "SIGNER", "VIEWER", "APPROVER", "ASSISTANT" ] }, "signingOrder": { "type": [ "number", "null" ] }, "signingUrl": { "type": "string" } }, "required": [ "id", "name", "email", "token", "role", "signingOrder", "signingUrl" ] } } }, "required": [ "success", "id", "recipients" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/folder": { "get": { "operationId": "folder-findFolders", "summary": "Find folders", "description": "Find folders based on a search criteria", "tags": [ "Folder" ], "security": [ { "apiKey": [] } ], "parameters": [ { "in": "query", "name": "query", "description": "The search query.", "schema": { "type": "string" } }, { "in": "query", "name": "page", "description": "The pagination page number, starts at 1.", "schema": { "type": "number", "minimum": 1 } }, { "in": "query", "name": "perPage", "description": "The number of items per page.", "schema": { "type": "number", "minimum": 1, "maximum": 100 } }, { "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "parentId": { "type": [ "string", "null" ] }, "pinned": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "type": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] } }, "required": [ "id", "name", "userId", "teamId", "parentId", "pinned", "createdAt", "updatedAt", "visibility", "type" ] } }, "count": { "type": "number" }, "currentPage": { "type": "number" }, "perPage": { "type": "number" }, "totalPages": { "type": "number" } }, "required": [ "data", "count", "currentPage", "perPage", "totalPages" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/folder/create": { "post": { "operationId": "folder-createFolder", "summary": "Create new folder", "description": "Creates a new folder in your team", "tags": [ "Folder" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 100 }, "parentId": { "type": "string" }, "type": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "parentId": { "type": [ "string", "null" ] }, "pinned": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "type": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] } }, "required": [ "id", "name", "userId", "teamId", "parentId", "pinned", "createdAt", "updatedAt", "visibility", "type" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/folder/update": { "post": { "operationId": "folder-updateFolder", "summary": "Update folder", "description": "Updates an existing folder", "tags": [ "Folder" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "folderId": { "type": "string" }, "data": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 100 }, "parentId": { "type": [ "string", "null" ] }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "pinned": { "type": "boolean" } } } }, "required": [ "folderId", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "userId": { "type": "number" }, "teamId": { "type": "number" }, "parentId": { "type": [ "string", "null" ] }, "pinned": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "visibility": { "type": "string", "enum": [ "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" ] }, "type": { "type": "string", "enum": [ "DOCUMENT", "TEMPLATE" ] } }, "required": [ "id", "name", "userId", "teamId", "parentId", "pinned", "createdAt", "updatedAt", "visibility", "type" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/folder/delete": { "post": { "operationId": "folder-deleteFolder", "summary": "Delete folder", "description": "Deletes an existing folder", "tags": [ "Folder" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "folderId": { "type": "string" } }, "required": [ "folderId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/embedding/create-presign-token": { "post": { "operationId": "embeddingPresign-createEmbeddingPresignToken", "summary": "Create embedding presign token", "description": "Creates a presign token for embedding operations with configurable expiration time", "tags": [ "Embedding" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expiresIn": { "type": "number", "minimum": 0, "maximum": 10080, "default": 60 }, "scope": { "type": "string" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" }, "expiresAt": { "type": "string" }, "expiresIn": { "type": "number" } }, "required": [ "token", "expiresAt", "expiresIn" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } }, "/embedding/verify-presign-token": { "post": { "operationId": "embeddingPresign-verifyEmbeddingPresignToken", "summary": "Verify embedding presign token", "description": "Verifies a presign token for embedding operations and returns the associated API token", "tags": [ "Embedding" ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "minLength": 1 }, "scope": { "type": "string" } }, "required": [ "token" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } }, "required": [ "message", "code" ] } } } } } } } }, "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "in": "header", "name": "Authorization" } } }, "security": [ { "apiKey": [] } ], "x-ext-urls": {} }