Saltar al contenido principal

Cargar un documento

Para cargar un documento a firmar utilizaremos el endpoint POST /api/v2/documents/create. Este endpoint permite cargar un documento a la plataforma de Signatura para que sea firmado por uno o más firmantes.

Los campos mínimos requeridos para cargar un documento son:

  • Título del documento
  • Archivo PDF a firmar
  • Configuración de firmantes

Requisitos del archivo​

El archivo debe ser un PDF válido, no protegido por contraseña y debe estar codificado en base64 de acuerdo al RFC 4648. Se recomienda que el archivo no supere los 2MB y que no contenga errores de formato.

Ejemplo de solicitud​

POST /api/v2/documents/create
Content-Type: application/json
Authorization: Bearer <apikey>

{
  "title": "Mi documento a firmar",
  "file_content": "<base64-encoded-file>",
  "signatures": [
    {
      "validations": {"EM": "user@example.com", "PH": null},
      "invite_channel": ["EM"]
    }
  ]
}

Validaciones de firmantes​

Para que un firmante pueda firmar un documento, es necesario que realice una o más validaciones. Las validaciones disponibles son:

  • Validación de correo electrónico (EM)
  • Validación de número de teléfono (PH)
  • Validación biométrica (BI)
  • Validación por clave fiscal AFIP Argentina (AF)

Para configurar las validaciones de un firmante, incluya el campo validations en la configuración del firmante. Cada validación debe ser un objeto con el código de la validación como clave y el valor correspondiente. Si el valor es null, el firmante podrá utilizar cualquier correo electrónico, número de teléfono, documento o CUIT para firmar el documento.

Ejemplo de un documento con validación de correo electrónico y clave fiscal AFIP fija​

En este caso el firmante deberá validar su correo electrónico e ingresar con clave fiscal correspondiente al CUIT 2012345678 para firmar el documento.

{
  ...
  "signatures": [
    {
      "validations": {"EM": null, "AF": "2012345678"},
    }
  }
}

Tipos de invitación​

Signatura permite enviar invitaciones a los firmantes para que firmen un documento. La invitación puede ser enviada por correo electrónico o por SMS. Para enviar una invitación por correo electrónico, incluya el campo invite_channel con el valor ["EM"] en la configuración del firmante. Para enviar una invitación por SMS, incluya el campo invite_channel con el valor ["PH"].

Ejemplo de un documento con invitación por correo electrónico​

{
  ...
  "signatures": [
    {
      "validations": {"EM": "test@example.org", "PH": null},
      "invite_channel": ["EM"]
    }
  ]
}

Ejemplo de un documento con invitación por SMS​

{
  ...
  "signatures": [
    {
      "validations": {"EM": null, "PH": "+5491123456789"},
      "invite_channel": ["PH"]
    }
  ]
}

Configurar una URL de redirección para el documento​

Si desea que el firmante sea redirigido a una URL específica después de firmar el documento, puede incluir el campo complete_url en la solicitud. La URL debe ser una dirección web válida y accesible por el firmante.

{
  ...
  "complete_url": "https://www.yourcompany.com/complete"
}

Esta URL también se puede especificar desde la página de Personalizar para que se aplique a todos los documentos cargados por la aplicación. En caso de que se especifique tanto en la solicitud como en la página de Personalizar, prevalecerá la URL de la solicitud.