Subida de ficheros adjuntos a solicitudes

Última revisión: 31 Mayo 2024

El SET podrá incorporar adjuntos (attachments) para que el usuario final pueda verlos o descargarlos durante el proces de firma en SignPage. Para hacerlo solo tendrás que agregar el objeto attachments en tu llamada, tal y como te explicamos a continuación.

"attachments":[
  {
    "type":"string",
    "helpText":"string",
    "fileReference":"string",
    "recipientKey" : "string" 
  }

Donde:

• type: (string) define el tipo de adjunto. Los valores disponibles son:

IMAGE, PDF, PDF_IMAGE, VIDEO, AUDIO

• fileReference: (string) para informar el origen del documento, es decir, el valor del token obtenido tras la subida del adjunto, o bien la URL en la que poder descargarlo. En la sección Variantes del Origen del Documento te explicamos cómo subir documentos, y de igual forma te sirve para tus adjuntos.

• recipientKey: (string) con el identificador del firmante al que se mostrará el adjunto.

Ejemplo:

"attachments":[
  {
    "type":"PDF",
    "helpText":"anexo informativo de contratación",
    "fileReference":"eyJ0eXAiOiJKV1QiLCJhbiBpcmVzIjoiMTcxNTA4NTEyMTU4M[...]XTYUQ",
    "recipientKey" : "signer1" 
  }

Ejemplo de un SET con adjuntos:

{
"groupCode": "myTestGroup_822",
"recipients": [
    {
      "key": "signer1",
      "name" : "John Doe",
      "mail" : "[email protected]"
    }
  ],
 "messages" : [{
        "document" : {
            "templateType": "uploaded",
            "templateReference": "hbiBpcmeyJ0eXAiOiJKV1QiLCJVzIjoiMTcxNTA4NTEyMTU4M[...]iMTcxN"
        },
        "policies" : [ {
            "attachments" : [ {
                "type":"PDF",
                "helpText":"anexo informativo de contratación",
                "fileReference":"eyJ0eXAiOiJKV1QiLCJhbiBpcmVzIjoiMTcxNTA4NTEyMTU4M[...]XTYUQ",
                "recipientKey" : "signer1" 
            } ],
            "signatures" : [ {
                "type" : "CLIENT",
                "recipientKey" : "signer1"     
            } ]
        } ]
    }]
}

Atributos opcionales

También podrás hacer uso de otras funcionalidades opcionales en tus adjuntos.

Adjuntos en el email

inMail: valor booleano que indicará si el adjunto se enviará o no en el mail de callback de finalización de la petición.

"inMail": true

Firma de adjuntos

Esta funcionalidad te la explicamos en la sección Firma automática de adjuntos