Sobre
Contrato de respuesta: sobre.
Este esquema conserva los nombres técnicos, tipos y restricciones de la API. Las propiedades incluidas en required son obligatorias; nullable admite null. oneOf requiere una variante, anyOf admite las variantes indicadas y allOf combina sus restricciones.
Esta referencia muestra las propiedades documentadas para Digito. Conserva el resto de la respuesta recibida en tu aplicación.
Propiedades principales
| Propiedad | Tipo | Obligatoria | Restricciones |
|---|---|---|---|
internalVersion | number | Sí | Sin restricciones adicionales en este nivel. |
type | string | Sí | Valores: "DOCUMENT", "TEMPLATE" |
status | string | Sí | Valores: "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" |
source | string | Sí | Valores: "DOCUMENT", "TEMPLATE" |
visibility | string | Sí | Valores: "EVERYONE", "MANAGER_AND_ABOVE", "ADMIN" |
templateType | string | Sí | Valores: "PUBLIC", "PRIVATE", "ORGANISATION" |
id | string | Sí | Sin restricciones adicionales en este nivel. |
secondaryId | string | Sí | Sin restricciones adicionales en este nivel. |
externalId | string o null | Sí | Sin restricciones adicionales en este nivel. |
createdAt | string | Sí | Sin restricciones adicionales en este nivel. |
updatedAt | string | Sí | Sin restricciones adicionales en este nivel. |
completedAt | string o null | Sí | Sin restricciones adicionales en este nivel. |
deletedAt | string o null | Sí | Sin restricciones adicionales en este nivel. |
title | string | Sí | Sin restricciones adicionales en este nivel. |
authOptions | object o null | Sí | Sin restricciones adicionales en este nivel. |
formValues | object o null | Sí | Sin restricciones adicionales en este nivel. |
publicTitle | string | Sí | Sin restricciones adicionales en este nivel. |
publicDescription | string | Sí | Sin restricciones adicionales en este nivel. |
userId | number | Sí | Sin restricciones adicionales en este nivel. |
teamId | number | Sí | Sin restricciones adicionales en este nivel. |
folderId | string o null | Sí | Sin restricciones adicionales en este nivel. |
templateId | number o null | Sí | Sin restricciones adicionales en este nivel. |
documentMeta | object | Sí | Sin restricciones adicionales en este nivel. |
recipients | array de object | Sí | Sin restricciones adicionales en este nivel. |
fields | array de object | Sí | Sin restricciones adicionales en este nivel. |
envelopeItems | array de object | Sí | Sin restricciones adicionales en este nivel. |
team | object | Sí | Sin restricciones adicionales en este nivel. |
user | object | Sí | Sin restricciones adicionales en este nivel. |
En esta respuesta, el contrato deja positionX, positionY, width y height sin un tipo explícito. Los números del ejemplo son valores sintéticos; conserva la representación que devuelve la API y no deduzcas un tipo de respuesta a partir del ejemplo.
Ejemplo de la estructura
Este objeto es una muestra sintética de la estructura. Los identificadores, fechas, estados y tokens sirven como ejemplos de formato; no describen una operación real ni valores predeterminados.
{
"internalVersion": 1,
"type": "DOCUMENT",
"status": "DRAFT",
"source": "DOCUMENT",
"visibility": "EVERYONE",
"templateType": "PRIVATE",
"id": "sobre_de_ejemplo",
"secondaryId": "envelope_secundario_de_ejemplo",
"externalId": null,
"createdAt": "2026-10-06T12:00:00.000Z",
"updatedAt": "2026-10-06T12:00:00.000Z",
"completedAt": null,
"deletedAt": null,
"title": "Contrato de servicios",
"authOptions": null,
"formValues": null,
"publicTitle": "valor_de_ejemplo",
"publicDescription": "valor_de_ejemplo",
"userId": 1,
"teamId": 1,
"folderId": null,
"templateId": null,
"documentMeta": {
"signingOrder": "PARALLEL",
"distributionMethod": "EMAIL",
"id": "metadatos_del_sobre_de_ejemplo",
"subject": null,
"message": null,
"timezone": null,
"dateFormat": null,
"redirectUrl": null,
"typedSignatureEnabled": true,
"uploadSignatureEnabled": true,
"drawSignatureEnabled": true,
"allowDictateNextSigner": false,
"language": "es",
"emailSettings": null,
"emailId": null,
"emailReplyTo": null,
"envelopeExpirationPeriod": null
},
"recipients": [
{
"envelopeId": "sobre_de_ejemplo",
"role": "SIGNER",
"readStatus": "NOT_OPENED",
"signingStatus": "NOT_SIGNED",
"sendStatus": "NOT_SENT",
"id": 501,
"email": "ana@example.com",
"name": "Ana Ejemplo",
"token": "token_de_destinatario_ejemplo",
"documentDeletedAt": null,
"expired": null,
"expiresAt": null,
"expirationNotifiedAt": null,
"signedAt": null,
"authOptions": null,
"signingOrder": null,
"signerCedula": null,
"rejectionReason": null
}
],
"fields": [
{
"envelopeId": "sobre_de_ejemplo",
"envelopeItemId": "archivo_de_ejemplo",
"type": "SIGNATURE",
"id": 701,
"secondaryId": "field_secundario_de_ejemplo",
"recipientId": 501,
"page": 1,
"positionX": 60,
"positionY": 75,
"width": 25,
"height": 8,
"customText": "valor_de_ejemplo",
"inserted": false,
"fieldMeta": null
}
],
"envelopeItems": [
{
"envelopeId": "sobre_de_ejemplo",
"documentDataId": "datos_del_documento_de_ejemplo",
"id": "archivo_de_ejemplo",
"title": "Contrato de servicios",
"order": 1
}
],
"team": {
"id": 1,
"url": "equipo-de-ejemplo"
},
"user": {
"id": 1,
"name": "Luis Ejemplo",
"email": "integracion@example.com"
}
}Ver el esquema JSON de la referencia
{
"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"
]
},
"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",
"nullable": true
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"completedAt": {
"type": "string",
"nullable": true
},
"deletedAt": {
"type": "string",
"nullable": true
},
"title": {
"type": "string"
},
"authOptions": {
"type": "object",
"nullable": true,
"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",
"nullable": true,
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
}
},
"publicTitle": {
"type": "string"
},
"publicDescription": {
"type": "string"
},
"userId": {
"type": "number"
},
"teamId": {
"type": "number"
},
"folderId": {
"type": "string",
"nullable": true
},
"templateId": {
"type": "number",
"nullable": true
},
"documentMeta": {
"type": "object",
"properties": {
"signingOrder": {
"type": "string",
"enum": [
"PARALLEL",
"SEQUENTIAL"
]
},
"distributionMethod": {
"type": "string",
"enum": [
"EMAIL",
"NONE"
]
},
"id": {
"type": "string"
},
"subject": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"timezone": {
"type": "string",
"nullable": true
},
"dateFormat": {
"type": "string",
"nullable": true
},
"redirectUrl": {
"type": "string",
"nullable": true
},
"typedSignatureEnabled": {
"type": "boolean"
},
"uploadSignatureEnabled": {
"type": "boolean"
},
"drawSignatureEnabled": {
"type": "boolean"
},
"allowDictateNextSigner": {
"type": "boolean"
},
"language": {
"type": "string"
},
"emailSettings": {
"type": "object",
"nullable": true,
"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",
"nullable": true
},
"emailReplyTo": {
"type": "string",
"nullable": true
},
"envelopeExpirationPeriod": {
"nullable": true,
"anyOf": [
{
"type": "object",
"properties": {
"unit": {
"type": "string",
"enum": [
"day",
"week",
"month",
"year"
]
},
"amount": {
"type": "integer",
"minimum": 1
}
},
"required": [
"unit",
"amount"
]
},
{
"type": "object",
"properties": {
"disabled": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"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",
"nullable": true
},
"expired": {
"type": "string",
"nullable": true
},
"expiresAt": {
"type": "string",
"nullable": true
},
"expirationNotifiedAt": {
"type": "string",
"nullable": true
},
"signedAt": {
"type": "string",
"nullable": true
},
"authOptions": {
"type": "object",
"nullable": true,
"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"
]
}
}
},
"required": [
"accessAuth",
"actionAuth"
]
},
"signingOrder": {
"type": "number",
"nullable": true
},
"signerCedula": {
"type": "string",
"nullable": true
},
"rejectionReason": {
"type": "string",
"nullable": true
}
},
"required": [
"envelopeId",
"role",
"readStatus",
"signingStatus",
"sendStatus",
"id",
"email",
"name",
"token",
"documentDeletedAt",
"expired",
"expiresAt",
"expirationNotifiedAt",
"signedAt",
"authOptions",
"signingOrder",
"signerCedula",
"rejectionReason"
]
}
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"envelopeId": {
"type": "string"
},
"envelopeItemId": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"SIGNATURE",
"FREE_SIGNATURE",
"INITIALS",
"NAME",
"EMAIL",
"DATE",
"TEXT",
"NUMBER",
"RADIO",
"CHECKBOX",
"DROPDOWN"
]
},
"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"
]
},
{
"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"
]
},
{
"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"
]
},
{
"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"
]
},
{
"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"
]
},
{
"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",
"nullable": true,
"minimum": 1,
"maximum": 10
},
"letterSpacing": {
"type": "number",
"nullable": true,
"minimum": 0,
"maximum": 100
},
"verticalAlign": {
"type": "string",
"nullable": true,
"enum": [
"top",
"middle",
"bottom",
null
]
}
},
"required": [
"type"
]
},
{
"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",
"nullable": true
},
"value": {
"type": "string"
},
"minValue": {
"type": "number",
"nullable": true
},
"maxValue": {
"type": "number",
"nullable": true
},
"textAlign": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"lineHeight": {
"type": "number",
"nullable": true,
"minimum": 1,
"maximum": 10
},
"letterSpacing": {
"type": "number",
"nullable": true,
"minimum": 0,
"maximum": 100
},
"verticalAlign": {
"type": "string",
"nullable": true,
"enum": [
"top",
"middle",
"bottom",
null
]
}
},
"required": [
"type"
]
},
{
"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"
]
},
{
"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"
]
},
{
"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"
]
}
]
}
},
"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"
]
}
},
"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",
"team",
"user"
]
}