Firma en bloque

Última revisión: 14 Junio 2022

Desde el API se permite crear solicitudes de firma en bloque asociadas a un usuario (o firmante) a partir de las solicitudes pendientes de firma que tenga el mismo agrupándolas en una única solicitud de firma. Estos documentos se podrán firmar según la configuración con un certificado centralizado en Viafirma Fortress o mediante un OTP SMS.

Agrupar solicitudes pendientes de firma

El servicio genera una solicitud de firma a partir de todas las solicitudes pendientes de firma asociadas al {userCode} indicado, el servicio devolverá un link donde, en función de la configuración se permitirá firmar todas las solicitudes en estado WAITING_CLIENT_SIGNATURE.

• SERVICIO: {urlbase}/documents/api/v3/messages/batchLink
• METHOD: POST
• CONTENT/APPLICATION: JSON

{
  "userCode":"string",
  "groupCode":"string",
  "otpRecipient": "string",
  "index": 0,
  "max": 0,
  "signType": "string",
  "redirectURL": "string"
}

Parámetros

• userCode (required): código de usuario o recipientKey al que esté asociado el documento en estado WAITING_CLIENT_SIGNATURE
• groupCode (required): código de grupo
• otpRecipient (optional): email o móvil al que se mandará el OTP en caso de seleccionar firma OTP
• index (optional): índice del páginado a mostrar para la firma en bloque
• max (optional): número máximo de documentos a firmar
• signType (optional): mecanismo de firma en bloque autorizado: (FORTRESS, OTP_SMS, CLIENT) (null = permite todos los mecanismos y el usuario final elige)
• redirectURL (optional): URL a la que redirigirá una vez completado el proceso de firma

Ejemplo:

{
  "userCode":"[email protected]",
  "groupCode":"group001",
  "otpRecipient": "[email protected]",
  "index": 0,
  "max": 5,
  "signType": "string"
}

Respuesta

• RESPONSE: 200 HTTP status code 200/OK
• RRESPONSE CONTENT TYPE: application/json

{
  "code": "string",
  "link": "string"
}

• code: código identificativo de la solicitud
• link: URL de la solicitud de firma en bloque

Respuestas Error

Respuestas alternativas en caso de fallo: se devolverán HTTP status codes distintos de 200/OK. En ese caso siempre se devolverá un JSON con la descripción del problema:

    {
      "code": "string",
      "type": "string",
      "message": "string",
      "trace" : "string"
    }