Plantillas como sobres

Una plantilla es un sobre con type: "TEMPLATE". Define PDFs, destinatarios y campos reutilizables. Cada uso crea un documento independiente con su propio ID y proceso.

Encuentra la plantillaCopiar link al encabezado

curl --fail-with-body \
  'https://business.digito.do/api/v2/envelope?type=TEMPLATE&page=1&perPage=10' \
  -H "Authorization: $DIGITO_API_TOKEN"

Obtén el detalle de la plantilla para conocer los recipients[].id y envelopeItems[].id. Los destinatarios del uso se relacionan con los IDs de la plantilla; no con su posición en una lista.

Crea un documento sin distribuirloCopiar link al encabezado

curl --fail-with-body \
  'https://business.digito.do/api/v2/envelope/use' \
  -H "Authorization: $DIGITO_API_TOKEN" \
  -F 'payload={
  "envelopeId": "envelope_plantilla_ejemplo",
  "externalId": "contrato-002",
  "distributeDocument": false,
  "recipients": [
    {
      "id": 123,
      "email": "ana@example.com",
      "name": "Ana Pérez"
    }
  ],
  "override": {
    "title": "Contrato de Ana Pérez",
    "language": "es"
  }
}'

Aunque no se sustituyan PDFs, esta operación usa un formulario multipart. La respuesta contiene el id del nuevo documento y sus recipients. Conserva el nuevo ID para consultar, revisar y distribuir.

customDocumentData permite relacionar PDFs de sustitución con elementos de la plantilla. prefillFields permite completar campos según su variante; revisa el contrato antes de utilizarlos. No envíes un identificador de campo del documento nuevo cuando la operación requiere uno de la plantilla.

Separa preparación y envíoCopiar link al encabezado

Mantén distributeDocument: false mientras revisas la integración. Distribuir inmediatamente puede iniciar comunicaciones a personas reales. Después de revisar datos, campos y archivos, usa la operación de distribución con el ID del documento creado.

Editar la plantilla y preparar un documento son procesos distintos. Si tu sistema depende de una configuración concreta, registra qué plantilla utilizó y verifica sus destinatarios antes de cada uso.

El firmante se autentica de nuevo con Digito ID antes de cada acción de firma. Una sesión abierta en Business, una clave de API, un token de destinatario o un token de integración no sustituye esta autenticación.

Referencia para usar una plantilla.

Guía completa de reutilizaciónCopiar link al encabezado

Crear un documento desde una plantilla explica cómo identificar un firmante, precompletar un campo de texto, sustituir un PDF y revisar el nuevo borrador. Consulta esa guía cuando necesites resolver IDs de plantilla y de documento en un mismo flujo.