eFirma API

Documentos

Objeto Documento

Un objeto del tipo Documento contiene los siguientes atributos:

Nombre Tipo de dato Descripción
id String El id único del documento en nuestro sistemas.
name String El nombre del documento en nuestro sistema.
createdat Date Fecha en que el documento fue creado en nuestros sistemas.
hash String El hash del documento original (documento sin firmar).
owner String Un email de la cuenta que creo el documento.
users []Object Una lista de objetos del tipo User en formato JSON.
signatures []Object Una lista de objetos del tipo Signature.
fully_signed Bool Indica si el documento ha sido firmado por todos los firmantes.
callback_url String URL a la cual se hará una llamada notificando cuando un usuario tome una acción en el documento.
original_file String URL que permite descargar el documento original.
signed_file String URL que permite descargar el documento con las firmas.

Objeto User

Un objeto del tipo User contiene los siguientes atributos:

Nombre Tipo de dato Descripción
email String El correo electrónico del usuario.
type String El permiso del usuario sobre el documento, hay 2 valores posibles signer o observer.

Obtener un documento

Permite obtener los datos respecto a un documento que está almacenado en nuestros sistemas.

GET /document/get/:id

Parámetro Tipo de dato Descripción
:id String El id único del documento en nuestro sistemas.

Regresará un objeto Documento.

Obtener todos los documentos

Permite obtener una lista objectos del tipo Documento a los cuales tienes acceso.

GET /document/get_all

Crear un documento

Permite crear/subir un documento a nuestros sistemas para su firmado, el contenido debe venir en un multipart/form-data y los parametros en formato JSON dentro de un campo con nombre "data".

POST /document

Parámetro Tipo de dato Descripción
name String El nombre con el cual se creará el documento.
signature_type Int Especifica el tipo de firma electrónica a utilizar dentro del documento.
1 = Firma Electrónica Avanzada, 2 = Firma Autógrafa Digital.
users []Object Una lista de objetos del tipo User de los usuarios que tienen permisos dentro del documento.
send_mails Bool En caso de ser falso, no se enviarán los correos de invitación a los usuarios del documento.
idcard_required Bool (Opcional) En caso de ser verdadero, el documento generado requerirá una identificación anexa para poder ser firmado.
allowed_ids [String]Bool (Opcional) Un arreglo indexado donde el indice representa el nombre de la identificación a aceptar y el valor otorgado al indice representa si es permitido el documento para identificarse al firmar. Por ejemplo: { "idcard" : true, "passport" : false, "fmcard" : true }, los indices permitidos son: idcard, passport, fmcard.
expiry_in Int (Opcional) Plazo para la celebración del contrato, el parametro puede ser entre 1 y 90 días. Valor predefinido de 30 días.
desc String (Opcional) Descripción del documento que se agregará en la nota de invitación enviada a los usuarios por correo electrónico.
callback_url String (Opcional) URL para notificar cuando una acción sea ejercida sobre el documento.
return_url String (Opcional) URL para redirigir al usuario una vez que se firme el documento.

Eliminar un documento

Permite eliminar un documento de nuestros sistemas.

Nota: Solo se puede eliminar un documento que no ha sido firmado.

DELETE /document/:id
Parámetro Tipo de dato Descripción
:id String El id único del documento en nuestro sistemas.