Auditoría del sobre
Contrato de respuesta: auditoría del 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 |
|---|---|---|---|
data | array de combinación (allOf) | Sí | Sin restricciones adicionales en este nivel. |
count | number | Sí | Sin restricciones adicionales en este nivel. |
currentPage | number | Sí | Sin restricciones adicionales en este nivel. |
perPage | number | Sí | Sin restricciones adicionales en este nivel. |
totalPages | number | Sí | Sin restricciones adicionales en este nivel. |
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.
{
"data": [
{
"id": "recurso_de_ejemplo",
"createdAt": "2026-10-06T12:00:00.000Z",
"envelopeId": "sobre_de_ejemplo",
"type": "ENVELOPE_ITEM_CREATED",
"data": {
"envelopeItemId": "archivo_de_ejemplo",
"envelopeItemTitle": "valor_de_ejemplo"
}
}
],
"count": 1,
"currentPage": 1,
"perPage": 10,
"totalPages": 1
}Ver el esquema JSON de la referencia
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"envelopeId": {
"type": "string"
},
"name": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"userId": {
"type": "number",
"nullable": true
},
"userAgent": {
"type": "string",
"nullable": true
},
"ipAddress": {
"type": "string",
"nullable": true
}
},
"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"
]
},
{
"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"
]
},
{
"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"
]
},
{
"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"
]
},
{
"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"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"DOCUMENT_COMPLETED"
]
},
"data": {
"type": "object",
"properties": {
"transactionId": {
"type": "string"
}
},
"required": [
"transactionId"
]
}
},
"required": [
"type",
"data"
]
},
{
"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"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TEMPLATE"
]
},
"templateId": {
"type": "number"
}
},
"required": [
"type",
"templateId"
]
}
]
}
},
"required": [
"title"
]
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"DOCUMENT_DELETED"
]
},
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"SOFT",
"HARD"
]
}
},
"required": [
"type"
]
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"DOCUMENT_CANCELLED"
]
},
"data": {
"type": "object",
"properties": {
"reason": {
"type": "string"
}
}
}
},
"required": [
"type",
"data"
]
},
{
"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"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"DOCUMENT_DELEGATED_OWNER_CREATED"
]
},
"data": {
"type": "object",
"properties": {
"delegatedOwnerName": {
"type": "string",
"nullable": true
},
"delegatedOwnerEmail": {
"type": "string"
},
"teamName": {
"type": "string"
}
},
"required": [
"delegatedOwnerName",
"delegatedOwnerEmail",
"teamName"
]
}
},
"required": [
"type",
"data"
]
},
{
"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",
"FREE_SIGNATURE",
"INITIALS",
"NAME",
"EMAIL",
"DATE",
"TEXT",
"NUMBER",
"RADIO",
"CHECKBOX",
"DROPDOWN"
]
},
"recipientId": {
"type": "number"
}
},
"required": [
"fieldId",
"fieldType",
"recipientId"
]
}
}
},
"required": [
"fields"
]
}
},
"required": [
"type",
"data"
]
},
{
"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"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"EMAIL"
]
},
"data": {
"type": "string"
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"DATE"
]
},
"data": {
"type": "string"
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"NAME"
]
},
"data": {
"type": "string"
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TEXT"
]
},
"data": {
"type": "string"
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"SIGNATURE"
]
},
{
"type": "string",
"enum": [
"FREE_SIGNATURE"
]
}
]
},
"data": {
"type": "string"
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"RADIO"
]
},
"data": {
"type": "string"
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"CHECKBOX"
]
},
"data": {
"type": "string"
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"DROPDOWN"
]
},
"data": {
"type": "string"
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"NUMBER"
]
},
"data": {
"type": "string"
}
},
"required": [
"type",
"data"
]
}
]
},
"fieldSecurity": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"ACCOUNT",
"PASSKEY",
"TWO_FACTOR_AUTH",
"PASSWORD",
"EXPLICIT_NONE"
]
}
}
}
},
"required": [
"recipientEmail",
"recipientName",
"recipientId",
"recipientRole",
"fieldId",
"field"
]
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"DOCUMENT_FIELD_UNINSERTED"
]
},
"data": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"SIGNATURE",
"FREE_SIGNATURE",
"INITIALS",
"NAME",
"EMAIL",
"DATE",
"TEXT",
"NUMBER",
"RADIO",
"CHECKBOX",
"DROPDOWN"
]
},
"fieldId": {
"type": "string"
}
},
"required": [
"field",
"fieldId"
]
}
},
"required": [
"type",
"data"
]
},
{
"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"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"EMAIL"
]
},
"data": {
"type": "string"
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"DATE"
]
},
"data": {
"type": "string"
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"NAME"
]
},
"data": {
"type": "string"
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TEXT"
]
},
"data": {
"type": "string"
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"SIGNATURE"
]
},
{
"type": "string",
"enum": [
"FREE_SIGNATURE"
]
}
]
},
"data": {
"type": "string"
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"RADIO"
]
},
"data": {
"type": "string"
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"CHECKBOX"
]
},
"data": {
"type": "string"
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"DROPDOWN"
]
},
"data": {
"type": "string"
}
},
"required": [
"type",
"data"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"NUMBER"
]
},
"data": {
"type": "string"
}
},
"required": [
"type",
"data"
]
}
]
},
"fieldSecurity": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"ACCOUNT",
"PASSKEY",
"TWO_FACTOR_AUTH",
"PASSWORD",
"EXPLICIT_NONE"
]
}
}
}
},
"required": [
"recipientEmail",
"recipientName",
"recipientId",
"recipientRole",
"fieldId",
"field"
]
}
},
"required": [
"type",
"data"
]
},
{
"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"
]
},
{
"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"
]
},
{
"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"
]
},
{
"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",
"nullable": true
},
"to": {
"type": "string",
"nullable": true
}
},
"required": [
"type",
"from",
"to"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PASSWORD"
]
}
},
"required": [
"type"
]
}
]
}
}
},
"required": [
"changes"
]
}
},
"required": [
"type",
"data"
]
},
{
"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"
]
},
{
"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"
]
},
{
"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"
]
}
}
},
"required": [
"recipientEmail",
"recipientName",
"recipientId",
"recipientRole",
"actionAuth"
]
}
},
"required": [
"type",
"data"
]
},
{
"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",
"nullable": true
}
},
"required": [
"recipientEmail",
"recipientName",
"recipientId",
"recipientRole",
"reason"
]
}
},
"required": [
"type",
"data"
]
},
{
"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"
]
},
{
"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"
]
},
{
"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"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"DOCUMENT_SENT"
]
},
"data": {
"type": "object"
}
},
"required": [
"type",
"data"
]
},
{
"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"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"DOCUMENT_EXTERNAL_ID_UPDATED"
]
},
"data": {
"type": "object",
"properties": {
"from": {
"type": "string",
"nullable": true
},
"to": {
"type": "string",
"nullable": true
}
}
}
},
"required": [
"type",
"data"
]
},
{
"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"
]
},
{
"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"
]
},
{
"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"
]
},
{
"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"
]
}
]
}
}
},
"required": [
"fieldId",
"fieldRecipientEmail",
"fieldRecipientId",
"fieldType",
"changes"
]
}
},
"required": [
"type",
"data"
]
},
{
"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"
]
}
}
},
"required": [
"recipientEmail",
"recipientName",
"recipientId",
"recipientRole",
"accessAuth",
"actionAuth"
]
}
},
"required": [
"type",
"data"
]
},
{
"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"
]
},
{
"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"
]
},
{
"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"
]
},
{
"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"
]
},
{
"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"
]
}
]
}
}
},
"required": [
"recipientEmail",
"recipientName",
"recipientId",
"recipientRole",
"changes"
]
}
},
"required": [
"type",
"data"
]
},
{
"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"
]
},
{
"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"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"DOCUMENT_RECIPIENT_CSC_CERT_DERIVATION_INITIATED"
]
},
"data": {
"type": "object",
"properties": {
"recipientEmail": {
"type": "string"
},
"recipientName": {
"type": "string"
},
"recipientId": {
"type": "number"
},
"recipientRole": {
"type": "string"
},
"providerId": {
"type": "string"
}
},
"required": [
"recipientEmail",
"recipientName",
"recipientId",
"recipientRole",
"providerId"
]
}
},
"required": [
"type",
"data"
]
},
{
"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"
},
"selectionMode": {
"type": "string",
"enum": [
"single",
"retained",
"signer",
"first_listed"
]
},
"candidateCount": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true
},
"certificateType": {
"type": "string",
"enum": [
"personal",
"institutional"
]
}
},
"required": [
"recipientEmail",
"recipientName",
"recipientId",
"recipientRole",
"providerId",
"credentialId",
"signatureAlgorithm",
"digestAlgorithm"
]
}
},
"required": [
"type",
"data"
]
},
{
"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"
]
},
{
"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"
]
},
{
"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"
]
},
{
"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"
]
}
]
}
]
}
},
"count": {
"type": "number"
},
"currentPage": {
"type": "number"
},
"perPage": {
"type": "number"
},
"totalPages": {
"type": "number"
}
},
"required": [
"data",
"count",
"currentPage",
"perPage",
"totalPages"
]
}