Destinatarios actualizados
Contrato de respuesta: destinatarios actualizados.
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.
Propiedades principales
| Propiedad | Tipo | Obligatoria | Restricciones |
|---|---|---|---|
data | array de object | 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": [
{
"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
}
]
}Ver el esquema JSON completo
{
"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",
"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
},
"documentId": {
"type": "number",
"nullable": true
},
"templateId": {
"type": "number",
"nullable": true
}
},
"required": [
"envelopeId",
"role",
"readStatus",
"signingStatus",
"sendStatus",
"id",
"email",
"name",
"token",
"documentDeletedAt",
"expired",
"expiresAt",
"expirationNotifiedAt",
"signedAt",
"authOptions",
"signingOrder",
"signerCedula",
"rejectionReason"
]
}
}
},
"required": [
"data"
]
}