Ejemplos — Reenvío de correos de firma

Esta sección muestra ejemplos reales de uso del endpoint de reenvío de correos.

Los ejemplos ayudan a entender:

• Cómo enviar correctamente los datos
• Cómo debe ir el JSON de firmantes
• Qué respuestas esperar del sistema

---

Ejemplo 1 — Reenvío básico a un firmante

Se reenvía la notificación de firma a un solo firmante, actualizando su correo y teléfono.

Request

POST https://www.sandboxadmin.firmaris.co/api/integrations/forward_emails
x-api-key: Bearer sandbox_token_empresa_123
Content-Type: multipart/form-data

Body (form-data)

key	value
folioId	9ef63bb5b1d84969aed5ef648a1c0beb57758a0961efda6bc11747855f321f68
signers	[{"documentNumber":"123456789","email":"nuevo_correo@ejemplo.com","cellPhoneNumber":"3001234567"}]
urlReturn	https://miempresa.com/callback

---

Respuesta exitosa

{
  "success": true,
  "status": 200,
  "message": "Los correos han sido reenviados exitosamente."
}

---

Ejemplo 2 — Reenvío a múltiples firmantes

Se reenvían correos a varios firmantes del mismo folio.

Request

POST https://www.sandboxadmin.firmaris.co/api/integrations/forward_emails
x-api-key: Bearer sandbox_token_empresa_123
Content-Type: multipart/form-data

Body (form-data)

{
  "folioId": "9ef63bb5b1d84969aed5ef648a1c0beb57758a0961efda6bc11747855f321f68",
  "signers": [
    {
      "documentNumber": "123456789",
      "email": "firmante1@ejemplo.com",
      "cellPhoneNumber": "3001111111"
    },
    {
      "documentNumber": "987654321",
      "email": "firmante2@ejemplo.com",
      "cellPhoneNumber": "3002222222"
    }
  ],
  "urlReturn": "https://miempresa.com/callback"
}

---

Respuesta exitosa

{
  "success": true,
  "status": 200,
  "message": "Los correos han sido reenviados exitosamente."
}

---

Ejemplo 3 — Error por signers inválido

Ocurre cuando el campo signers no es un JSON válido.

Request

POST https://www.sandboxadmin.firmaris.co/api/integrations/forward_emails
x-api-key: Bearer sandbox_token_empresa_123
Content-Type: multipart/form-data

Body (incorrecto)

{
  "folioId": "9ef63bb5b1d84969aed5ef648a1c0beb57758a0961efda6bc11747855f321f68",
  "signers": "esto_no_es_json",
  "urlReturn": "https://miempresa.com/callback"
}

---

Respuesta de error

{
  "success": false,
  "status": 400,
  "error": {
    "message": "json de firmantes invalido"
  }
}

---

Ejemplo 4 — Error por firmante inexistente

Sucede cuando el documentNumber no pertenece a ningún firmante del folio.

Request

POST https://www.sandboxadmin.firmaris.co/api/integrations/forward_emails
x-api-key: Bearer sandbox_token_empresa_123
Content-Type: multipart/form-data

Body

{
  "folioId": "9ef63bb5b1d84969aed5ef648a1c0beb57758a0961efda6bc11747855f321f68",
  "signers": [
    {
      "documentNumber": "000000000",
      "email": "correo@ejemplo.com",
      "cellPhoneNumber": "3001234567"
    }
  ],
  "urlReturn": "https://miempresa.com/callback"
}

---

Respuesta de error

{
  "success": false,
  "status": 400,
  "error": {
    "message": "número de documento invalido"
  }
}

---

Ejemplo 5 — Error por falta de permisos

Ocurre cuando el token no pertenece a la empresa dueña del folio.

{
  "success": false,
  "status": 403,
  "error": {
    "message": "No tiene permisos para acceder al paquete de folios seleccionado"
  }
}

---

Ejemplo 6 — Error interno del sistema

Error no controlado durante el proceso de reenvío.

{
  "success": false,
  "status": 500,
  "error": {
    "message": "Ocurrió un error al reenviar los correos, por favor inténtelo de nuevo."
  }
}

---

Resumen rápido

• signers siempre es un JSON válido
• documentNumber identifica al firmante
• No se crean firmantes nuevos
• El link de firma no cambia
• El correo simplemente se reenvía

Estos ejemplos cubren los casos reales más comunes de uso del endpoint.