Distribución del sobre
Contrato de respuesta: distribución 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.
Propiedades principales
| Propiedad | Tipo | Obligatoria | Restricciones |
|---|---|---|---|
success | boolean | Sí | Sin restricciones adicionales en este nivel. |
id | string | Sí | Sin restricciones adicionales en este nivel. |
recipients | array de object | Sí | Sin restricciones adicionales en este nivel. |
signingUrl es un marcador del valor que devuelve la API; no es una ruta de firma construida por la integración.
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.
{
"success": true,
"id": "sobre_de_ejemplo",
"recipients": [
{
"id": 501,
"name": "Ana Ejemplo",
"email": "ana@example.com",
"token": "token_de_destinatario_ejemplo",
"role": "SIGNER",
"signingOrder": null,
"signingUrl": "URL_DE_FIRMA_DEVUELTA_POR_LA_API"
}
]
}Ver el esquema JSON completo
{
"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",
"nullable": true
},
"signingUrl": {
"type": "string"
}
},
"required": [
"id",
"name",
"email",
"token",
"role",
"signingOrder",
"signingUrl"
]
}
}
},
"required": [
"success",
"id",
"recipients"
]
}