Sobre este documento

Este documento contiene una guía rápida con los pasos a seguir para comenzar rápidamente a consumir los métodos para enviar documentos a firmar a través de la Plataforma de Firma Remota.

Introducción

A través de la Plataforma de Firma Remota (PFR) enviamos uno o varios documentos para que el Firmante o Firmantes revisen y firmen los documentos en su propio terminal en cualquier momento y en cualquier lugar.

El proceso de firma se inicia siempre adjuntando el envío (documentos, firmantes) a la PFR para que ésta actúe como tercero de confianza custodiando el paquete y así garantizando que no se modifica por ninguna de las partes implicadas en el proceso de firma. 

Existen dos métodos para enviar a firmar:

  • NewDocumentSet: envía el documento a la PFR. Como resultado de la petición devuelve el identificador del envío para hacer seguimiento. El firmante recibe un correo electrónico desde el cual accederá al documento para su revisión y firma. 
  • NewDocumentSetUrl: envía el documento a la PFR. Como resultado de la petición devuelve el identificador del envío para hacer seguimiento y la url para acceder al documento almacenado en la PFR de forma que con él se puede embeber el proceso de revisión y firma del documento:
    • en una aplicación web, el firmante realizará la revisión del documento en la PFR sin salir de su aplicación web.
    • enviar el enlace a través de otros medios, SMS por ejemplo.

En todos los casos se capturan todas las evidencias del proceso de firma.

Después se puede hacer seguimiento del envío a través de los métodos GetDocumentSet y GetLog e incluso obtener el documento firmado y certificado de evidencias a través de ellos para archivar la documentación en un repositorio documental.

 

Tipo de Firma

La Plataforma de Firma Remota, permite establecer tres tipo de firma:

  • 0, firma biométrica. Se firma con el dedo sobre un smartphone o tablet o con el ratón en un puesto PC.
  • 1, firma con autenticación fuerte. Una vez el firmante acepta el contenido del documento, recibe un SMS con una clave única para completar la firma del documento.
  • 2, notificación fehaciente. Basta con que el interviniente acepte el contenido del documento para completar la acción sobre él.

Ese valor se informa en el nodo RequestedAction

Firmantes

En cada envío se pueden establecer uno o varios intervinientes y el orden en el que firman dentro del proceso

            <edat:DocumentSetRecipients>
               <!--Zero or more repetitions:-->
               <edat:Recipient>
                  <!--Identificador numérico del firmante:-->
                  <edat:RecipientId>1</edat:RecipientId>
                  <!--Orden en el que firma 1, 2...etc. No se puede repetir:-->
                  <edat:RecipientOrder>1</edat:RecipientOrder>
                  <!--Nombre y apellidos del firmante:-->
                  <edat:RecipientName>Firmante Nombre</edat:RecipientName>
                  <!--DNI, NIE.. un documento con el que se pueda identificar la persona:-->
                  <edat:RecipientIdCard>700X</edat:RecipientIdCard>
                  <!--Número de teléfono donde se pueda recibir un SMS:-->
                  <edat:RecipientCellPhone>6553333222</edat:RecipientCellPhone>
                  <!--Correo electrónico:-->
                  <edat:RecipientMail>olga.fernandez@edatalia.com</edat:RecipientMail>
               </edat:Recipient>
            </edat:DocumentSetRecipients>

Los datos que se registran del firmante los deberá validar la primera vez que el firmante accede a la plataforma para firmar un documento, junto con las condiciones de uso de la plataforma.

Documentos

En un mismo paquete se pueden enviar a firmar uno o varios documentos. Bastará con indicar el orden en que se desea firma.

 <!--Lista de documentos para firmar. Por cada documento-->
<DocumentSetItems>
<Item>
<ItemId>Identificador de documento(1, 2, 3...etc)</ItemId>
<ItemOrder>Orden de firma del dcoumento (1, 2, 3...etc.)</ItemOrder>
<ItemMandatory>Indica si es obligatorio que el documento esté firmado (1 si, 0 no)</ItemMandatory>
<ItemName>Nombre del documento</ItemName>
<ItemPDFContentB64>Documento PDF en base64</ItemPDFContentB64>
</Item>
</DocumentSetItems>

Posicionamiento de la firma

En la sección WidgetPosition se encuentran los parámetros para indicar la posición de la firma.

  <WidgetPosition>                    
<Page>Número de página en la que se sitúa la firma</edat:Page>
<PositionX>Posición horizontal en pixels desde el margen izquierdo</PositionX>
<PositionY>Posición vertical en pixels desde el margen superior</PositionY>
<Height>Alto en pixels. Recomendado 40.</Height>
<Width>Ancho en pixels. Recomendado 120</Width>
</WidgetPosition>

Estos parámetros son obligatorios cuando:

  • el tipo de firma es Biométrica, se estará indicando dónde se visualizará el grafo de la firma.
  • Se ha establecido la firma con OTP. En este caso se mostrará una imagen jpg almacenada en la plataforma con la personalización de imagen establecida.

Consulta de datos sobre un envío

Hay dos formas de recuperar la información sobre un envío:
 
  • GetDocumentSet: permite obtener el estado (pendiente, rechazado, firmado, caducado…etc.)
  • GetLog:  permite obtener la traza completa del envío.
 
Ambos métodos también incluyen la posibilidad de recuperar el documento y el certificado de evidencias si se informa el valor 1 en el parámetro

Nota

Para cualquier consulta es necesario el identificador de documento que se obtiene como respuesta al subir un paquete a la plataforma. 

  • Share: