Obtener varios sobres
Consulta varios sobres por sus identificadores.
/envelope/get-manyURL base: https://business.digito.do/api/v2.
Ejemplos
Configura DIGITO_API_TOKEN en el servidor. Sustituye los IDs y archivos de ejemplo por los de tu equipo. TypeScript usa fetch y FormData de Node.js.
curl --fail-with-body \
--request POST \
--url 'https://business.digito.do/api/v2/envelope/get-many' \
--header "Authorization: $DIGITO_API_TOKEN" \
--header 'Content-Type: application/json' \
--data-binary @- <<'JSON'
{
"ids": {
"type": "envelopeId",
"ids": [
"sobre_de_ejemplo",
"otro_sobre_de_ejemplo"
]
}
}
JSONAntes de empezar
idsadmite los tipos y variantes que especifica el contrato completo. No conviertas automáticamente todos los identificadores a números.
Autenticación
Envía el token de la API en el encabezado Authorization. El acceso corresponde al equipo y a los permisos del token. Conserva el token en tu servidor.
Authorization: api_TU_TOKENAntes de cada acción de firma, el firmante debe autenticarse de nuevo con Digito ID. Una sesión previa de Business, un token de destinatario o un token de la API no sustituye este requisito.
Parámetros
Esta operación no declara parámetros de ruta ni de consulta.
Cuerpo de la solicitud
El cuerpo es obligatorio.
Tipo de contenido: application/json.
Objeto de ejemplo
{
"ids": {
"type": "envelopeId",
"ids": [
"sobre_de_ejemplo",
"otro_sobre_de_ejemplo"
]
}
}Los valores muestran una solicitud posible; no son valores predeterminados del servidor.
| Propiedad | Tipo | Obligatoria | Restricciones |
|---|---|---|---|
ids | una variante (oneOf) | Sí | Sin restricciones adicionales en este nivel. |
Ver el esquema completo de la solicitud
{
"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"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"documentId"
]
},
"ids": {
"type": "array",
"items": {
"type": "number"
},
"minItems": 1,
"maxItems": 20
}
},
"required": [
"type",
"ids"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"templateId"
]
},
"ids": {
"type": "array",
"items": {
"type": "number"
},
"minItems": 1,
"maxItems": 20
}
},
"required": [
"type",
"ids"
]
}
]
}
},
"required": [
"ids"
]
}Respuesta de éxito
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.
Esta referencia muestra las propiedades documentadas para Digito. Conserva el resto de la respuesta recibida en tu aplicación.
Este objeto sintético ilustra las propiedades documentadas de una respuesta 200. Los identificadores, fechas, estados y tokens son datos de ejemplo.
{
"data": [
{
"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"
}
}
]
}Respuestas y errores
| Estado | Descripción | Contenido y esquema |
|---|---|---|
200 | Respuesta correcta. | application/json |
400 | Datos de entrada inválidos. | application/json |
401 | No se proporcionó autorización. | application/json |
403 | Permisos insuficientes. | application/json |
500 | Error interno del servidor. | application/json |
Los esquemas enlazados incluyen propiedades anidadas, campos obligatorios, variantes, enumeraciones, nulabilidad y restricciones. Consulta errores y reintentos para manejar respuestas no exitosas.
Identificador de operación: envelope-getMany.