Objetos
Se hace un listado de los diferentes tipos de objetos mencionados en la documentación.
Objeto Document
Representa un documento dentro del sistema de eFirma.
| Nombre | Tipo | Descripción |
|---|---|---|
| id | String | El id único del documento |
| name | String | El nombre del documento |
| createdat | Date | Fecha en que se creó el documento |
| hash | String | El hash del documento original (documento sin firmar) |
| owner | String | El email de la cuenta que creó el documento |
| users | [ ]User | Una lista de objetos del tipo User en formato JSON |
| tags | [ ]String | Arreglo de strings con las etiquetas del documento |
| signatures | [ ]Signature | 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 |
| return_url | String | URL para redirigir al usuario una vez que se firme el documento |
| reject_url | String | URL para redirigir al usuario en caso de que decida rechazar el documento |
| original_file | String | URL que permite descargar el documento original |
| signed_file | String | URL que permite descargar el documento con las firmas |
| merged_file | String | URL que permite descargar el documento original junto con la constancia de las firmas |
Objeto User
Representa un usuario asociado a un documento.
| Nombre | Tipo de Dato | Descripción |
|---|---|---|
| String | El correo electrónico del usuario | |
| type | String | El permiso del usuario sobre el documento, hay 2 valores posibles: signer o observer |
| ignore_invitation | Bool | Define si le enviaremos al usuario el correo electrónico de invitación a firmar |
| access_token | String | El token para acceder al documento previa la validación del usuario |
| iframe_url | String | Una URL que permitirá montar el documento en un iFrame |
| sidreq | Bool (Opcional) | En caso de ser verdadero, solicitará a los firmantes su Identificación Oficial. |
| order | Int | Define el turno del firmante |
| role | String | Define el rol del firmante en el documento |
| video_required | Bool | Solicita al usuario prueba de vida |
Objeto Organizacion
Representa una organización o empresa.
| Nombre | Tipo de Dato | Descripción |
|---|---|---|
| names | [ ]String | Los nombres por los que se puede llamar a la organización |
| rfc | String | El RFC siendo validado |
| active_esignature | Bool | Status de los certificados de facturación de la empresa |
| certificates | [ ]Certificados | Lista de objetos Certificados involucrados |
Objeto Certificados
Representa un certificado de facturación.
| Nombre | Tipo de Dato | Descripción |
|---|---|---|
| owner | String | CURP de los dueños del RFC |
| serial | String | Número serial del certificado |
| active | Bool | Status de los certificados de facturación de la empresa |
Nota
Puede aparecer el mismo RFC varias veces con diferentes seriales, esto significa que han sido certificados que han vencido.
Objeto Signature
Representa la firma de un usuario en un documento.
| Nombre | Tipo de Dato | Descripción |
|---|---|---|
| String | El correo electrónico del usuario | |
| name | String | Nombre del Firmante. Aparecerá cuando ya tenga cuenta en eFirma |
| lname | String | Apellido del Firmante. Aparecerá cuando ya tenga cuenta en eFirma |
| signature_type | Integer | 1: Firma Electrónica Avanzada, 2: Firma Digital |
| signed | Bool | Nos indica si el usuario ya firmó el documento |
Objeto Plantilla
Representa una plantilla de documento.
| Nombre | Tipo de Dato | Descripción |
|---|---|---|
| id | String | El id único de la plantilla en nuestros sistemas |
| ref | String | El nombre de referencia del documento |
| custom_fields | [ ]CustomField | Una lista de objetos del tipo CustomField en formato JSON |
| autosigner | [ ]Object | Un listado de los autofirmantes dados de alta para la plantilla |
Autofirmantes
Los autofirmantes serán solicitados para la firma de la plantilla y una vez firmada, cada documento generado a partir de la misma se firmará por ellos de manera automática.
Objeto Snippets
Representa un snippet reutilizable dentro de una plantilla.
| Nombre | Tipo de Dato | Descripción |
|---|---|---|
| name | String | El nombre del snippet definido en la plantilla |
| custom_fields | [ ]JsonObject | Arreglo JSON de objetos incluyendo las variables a llenar N veces |
| custom_fields | [ ]CustomField | Una lista de objetos del tipo CustomField en formato JSON |
| autosigner | [ ]Object | Un listado de los autofirmantes dados de alta para la plantilla |
Objeto CustomField
Representa un campo personalizado dentro de una plantilla.
| Nombre | Tipo de Dato | Descripción |
|---|---|---|
| name | String | El nombre de la variable utilizado en la plantilla |
| fname | String | El nombre amistoso, se mostrará para el llenado en la plataforma. Suele ser una pregunta ej: ¿Cómo te llamas? |
| type | String | El tipo de campo |
| choices | [ ]String | En caso de ser un campo de opción múltiple, se listan las opciones |
Objeto Callback
Representa la información enviada a través de un callback cuando ocurre un evento en un documento.
| Nombre | Tipo de Dato | Descripción |
|---|---|---|
| id | String | Identificador único del callback |
| event | String | Tipo de evento asociado al callback: sign, reject, delete, expired |
| fully_signed | Bool | Indica si el documento está completamente firmado |
| name | String | Nombre completo del usuario que accionó (opcional) |
| rfc | String | Registro Federal de Contribuyentes (opcional) |
| curp | String | Clave Única de Registro de Población (opcional) |
| String | Correo electrónico del usuario (opcional) | |
| timestamp | String | Marca de tiempo del evento |
| message | String | Mensaje adicional (opcional) |
| original_file | String | Archivo original (opcional) |
| evidence_file | String | Archivo de evidencia (opcional) |
| merged_file | String | Archivo combinado (opcional) |
| signed_file | String | Archivo firmado (opcional) |
Eventos de Callback
| Evento | Descripción |
|---|---|
sign | Se dispara cuando un usuario firma el documento |
reject | Se dispara cuando un usuario rechaza el documento |
delete | Se dispara cuando el documento es eliminado |
expired | Se dispara cuando el documento ha expirado |