Skip to main content
Documentation Powered by Redocly

Signt (stable)

Download OpenAPI specification:Download

Descripción

Servicio para generar documentos digitales totalmente customizables y poder firmarlos con NOM 151

Templates

Con estos endpoint se manejan todos los templates que son la base para la construcción de documentos, desde la creación de la base a través de un documento PDF así como el nombre y la descripción del propósito de este template.

Obtener una lista de templates

Authorizations:
apiKeyAuth
query Parameters
search
string
Example: search=test

Responses

Response samples

Content type
application/json
{}

Crear un nuevo templete

Authorizations:
apiKeyAuth
Request Body schema: multipart/form-data

Una petición multipart/form-data para crear un template

name
string

Nombre del template

description
string

Descripción del template

template
string <binary>

El archivo PDF del template

template_tmp_id
string <uuid>

Uuid del archivo si se subio con el api de archivos temporales

Responses

Response samples

Content type
application/json
{}

Obtener los detalles de un template

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del template

Responses

Response samples

Content type
application/json
{}

Actualizar un template

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del template

Request Body schema: multipart/form-data

Una petición multipart/form-data para actualizar template

name
string
description
string
template
string <binary>

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Borrar un template

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del template

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Cambiar el archivo base de un template

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del template

Request Body schema: multipart/form-data

Una petición multipart/form-data para cambiar el archivo base del template

template
string <binary>

Responses

Response samples

Content type
application/json
{}

Elementos de Template

Con estos endpoint se manejan todos los elementos de los templates para indicar los campos personalizables de los documentos, desde imágenes, texto y hasta firmas así como las posiciones en el documento de estos.

Obtener una lista de elementos de template

Authorizations:
apiKeyAuth
query Parameters
template_id
string
Example: template_id=51319186-a4a0-4497-a3c9-ebdbdaca0159

Template relacionado

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {}
}

Crear un elemento de template

Authorizations:
apiKeyAuth
Request Body schema: application/json

Una petición application/json para crear un elemento de template

name
string

Nombre del elemento de template

Texto (1) (integer) or Imagen (2) (integer) or Firma (3) (integer)
page
integer >= 1

Pagina donde se insertará el elemento del template

top
number >= 0

Posición desde arriba para insertar el elemento en la página

left
number >= 0

Posición desde la izquierda para insertar el elemento en la página

width
number >= 0

Ancho que ocupará el elemento en la página

height
number >= 0

Altura que ocupará el elemento en la página

object

Metadata de un elemento de tipo Texto

rules
Array of strings

Reglas de validación para el valor del elemento, referirse a la validación de laravel

template_id
string

El ID del template relacionado

Responses

Request samples

Content type
application/json
{
  • "name": "Campo Nombre",
  • "type": 3,
  • "page": 1,
  • "top": 20,
  • "left": 20,
  • "width": 50,
  • "height": 20,
  • "metadata": {
    },
  • "rules": [
    ],
  • "template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Obtener los detalles de un elemento de template

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del elemento de template

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Actualizar un elemento de template

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del elementos template

Request Body schema: application/json

Una petición application/json para actualizar un elemento de template

name
string

Nombre del elemento de template

type
integer

Tipo de elemento de template type 1 = Text, type 2 = Image, type 3 = Firma

page
integer >= 1

Pagina donde se insertará el elemento del template

top
number >= 0

Posición desde arriba para insertar el elemento en la página

left
number >= 0

Posición desde la izquierda para insertar el elemento en la página

width
number >= 0

Ancho que ocupará el elemento en la página

height
number >= 0

Altura que ocupará el elemento en la página

object

Metadata de un elemento de tipo Texto

rules
Array of strings

Reglas de validación para el valor del elemento, referirse a la validación de laravel

template_id
string

El ID del template relacionado

Responses

Request samples

Content type
application/json
{
  • "name": "Campo Nombre",
  • "type": 1,
  • "page": 1,
  • "top": 20,
  • "left": 20,
  • "width": 50,
  • "height": 20,
  • "metadata": {
    },
  • "rules": [
    ],
  • "template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Borrar un elemento de template

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del elemento de template

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Establecer una imagen por defecto para un elemento de template

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del elemento de template, debe ser de tipo imagen

Request Body schema: application/json

Una petición multipart/form-data para establecer una imagen por defecto

default_value
string <binary>

La imagen a establecer como por defecto

Responses

Request samples

Content type
application/json
{
  • "default_value": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Documentos

Manejo de los documentos ya sean creados a partir de templates o documentos externos.

Obtener una lista de documentos

Authorizations:
apiKeyAuth
query Parameters
search
string
Example: search=test

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Crear un nuevo documento

Authorizations:
apiKeyAuth
Request Body schema: application/json

Una petición application/json para crear un document

name
string

El nombre del Documento

template_id
string

El ID del template relacionado con el documento

send_email
boolean

Envía un email a todos los firmantes registrados después de sellar con nom 151

autosigning
boolean

Bandera que indica si se firmara con NOM 151 el documento al terminar los usuarios de firmar

callback_url
string

URL en caso de que se quiera hacer llegar el documento al terminar el firmado de NOM 151.

expires_in
integer

Tiempo en minutos que durarán los tokens vinculados a este documento

Array of objects

Elementos del documento llenados, solo tipo Text

Responses

Request samples

Content type
application/json
{
  • "name": "Documento ejemplo",
  • "template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "send_email": true,
  • "autosigning": false,
  • "callback_url": "http://example.com",
  • "expires_in": 15,
  • "elements": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Verificar documento firmado con FIEL

Authorizations:
apiKeyAuth
Request Body schema: multipart/form-data
One of
file
string <binary>

archivo pdf a verificar, tamaño maximo 2mb

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Verificar firma FIEL en un documento

Authorizations:
apiKeyAuth
Request Body schema: multipart/form-data
signature
string <base64>

Sello digital de la firma FIEL que aparece en el documento descriptivo

cer
string <binary>

Archivo .cer de la FIEL que se desea validar

fiel_document
string <binary>

Archivo pdf que se firma con la fiel

fiel_doc_tmp_id
string <uuid>

Uuid del archivo si se subio con el api de archivos temporales

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Obtener los detalles de un documento

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del Documento

query Parameters
with_template_elems
boolean
Example: with_template_elems=false

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": [
    ]
}

Actualizar un document

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del Documento

Request Body schema: application/json

Una petición application/json para actualizar un documento

name
string

El nombre del Documento

template_id
string

El ID del template relacionado a este documento

send_email
boolean

Envía un email a todos los firmantes registrados después de sellar con nom 151

autosigning
boolean

Bandera que indica si se firmara con NOM 151 el documento al terminar los usuarios de firmar

callback_url
string

URL en caso de que se quiera hacer llegar el documento al terminar el firmado de NOM 151.

expires_in
integer

Tiempo en minutos que durarán los tokens vinculados a este documento

Responses

Request samples

Content type
application/json
{
  • "name": "Documento ejemplo",
  • "template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "send_email": true,
  • "autosigning": false,
  • "callback_url": "http://example.com",
  • "expires_in": 15
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Borrar un document

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del Documento

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Obtener una URL temporal del documento que ya ha sido generado

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del Documento

Responses

Response samples

Content type
application/json
{}

Obtener un token para acceder temporalmente a un documento de manera pública

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del Documento

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Obtener el preview del documento PDF

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El id para Identificar el Documento públicamente

Responses

Si el documento ya ha sido firmado con NOM 151 se renviaran los archivos por email a los firmantes

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El id para Identificar el Documento

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Llenar los elementos de texto del documento

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El id para Identificar el Documento

Request Body schema: application/json

Una peticion application/json para llenar los elementos de tipo texto del document en batch

fields
object

Objeto donde las key son los id del elemento del template y el value es el valor del elemento para el documento

Responses

Request samples

Content type
application/json
{
  • "fields": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": [
    ]
}

Agregar firmantes permanentes al documento

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El id para Identificar el Documento

Request Body schema: application/json
Array of objects
Array
id
string

Id del firmante permanente

password
string

Contraseña para proteger el certificado de la firma digital

expires_in
integer

Tiempo en minutos que durarán los tokens vinculados a este firmante

only_digital_signature
boolean

true en caso de que la firma autografa no se ponga en el documento

is_fiel_signature
boolean

true si la forma de firmar para este firmante es con FIEL

elements
Array of strings

Arreglo de elementos que el firmante debe firmar

Responses

Request samples

Content type
application/json
{
  • "signers": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": [
    ]
}

Remover firmante del documento

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El id para Identificar el Documento

query Parameters
signer_id
required
string
Example: signer_id=51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del firmante que se desea quitar del documento

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Duplicar un documento existente creado desde un archivo

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El id para Identificar el Documento a duplicar

Request Body schema: application/json

Una petición application/json para duplicar un documento

duplicate_signers
boolean

Indica si se deben duplicar los firmantes del documento original

document_name
string

Nombre del nuevo documento duplicado

send_email
boolean

Indica si se debe enviar un email a los firmantes del documento duplicado

expires_in
integer

Tiempo en minutos que durarán los tokens vinculados a los firmantes del documento duplicado

callback_url
string

URL a la que se enviará una notificación cuando el documento sea firmado

autosigning
boolean

Indica si el documento debe ser firmado automáticamente por los firmantes

Responses

Request samples

Content type
application/json
{
  • "duplicate_signers": true,
  • "document_name": "Documento Duplicado",
  • "send_email": true,
  • "expires_in": 15,
  • "callback_url": "https://example.com/callback",
  • "autosigning": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Obtener una lista de aprobaciones de un documento

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": [
    ]
}

Enviar solicitudes de aprobación para un documento

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El id para Identificar el Documento

Request Body schema: application/json

Una petición application/json para enviar solicitudes de aprobación

time_to_approve
integer

Tiempo en minutos que el revisor tiene para aprobar el documento

reset_approvals
boolean

Indica si se deben reiniciar las aprobaciones existentes

Responses

Request samples

Content type
application/json
{
  • "time_to_approve": 86400,
  • "reset_approvals": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Elementos de Documento

Apartado para el manejo de los valores que toman los campos a llenar de un template para un documento en específico

Obtener una lista de elementos de documentos

Authorizations:
apiKeyAuth
query Parameters
document_id
string
Example: document_id=51319186-a4a0-4497-a3c9-ebdbdaca0159

Responses

Response samples

Content type
application/json
{}

Crear un nuevo elemento de documento

Authorizations:
apiKeyAuth
Request Body schema: multipart/form-data

Una petición multipart/form-data para crear un elemento de documento

One of
template_element_id
string

El ID del elemento del template relacionado

document_id
string

El ID del documento relacionado

value
string <binary>

La imagen a insertar en el documento

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Obtener los detalles de un elemento de documento

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del elemento de documento

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Actualizar un elemento de documento

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del elemento de documento

Request Body schema: application/json

Una petición application/json para actualizar un elemento de documento

One of
template_element_id
string

El ID del elemento del template relacionado

document_id
string

El ID del documento relacionado

value
string <binary>

La imagen a insertar en el documento

Responses

Request samples

Content type
application/json
{
  • "template_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "value": "Texto ejemplo"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Borrar un elemento de documento

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del elemento de documento

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Eventos de Documento

En este apartado se pueden modificar los elementos del historial de eventos que aparecen en la hoja extra de los documentos certificados con NOM 151, estos pueden incluir texto acompañado de imágenes para una mejor interpretación.

Obtener los eventos del documento

Authorizations:
apiKeyAuth
query Parameters
document_id
string
Example: document_id=51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del documento de los eventos

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {}
}

Crea un evento que aparecerá en el historial del documento

Authorizations:
apiKeyAuth
Request Body schema: multipart/form-data

Una petición multipart/form-data para crear eventos con imágenes

document_id
string
description
string
images
Array of strings <binary> <= 3 items
event_timestamp
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Obtener el detalle del evento solicitado

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del evento

Responses

Response samples

Content type
application/json
{
  • "id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "description": "Validación ine",
  • "event_timestamp": "2021-03-10T19:57:06.000000Z",
  • "created_at": "2021-03-10T19:57:06.000000Z",
  • "updated_at": "2021-03-10T19:57:06.000000Z"
}

Actualiza la información de un evento

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del evento

Request Body schema: application/json

Una petición application/json para actualizar un evento

document_id
string
description
string
event_timestamp
string

Responses

Request samples

Content type
application/json
{
  • "document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "description": "Validación ine",
  • "event_timestamp": "2021-03-10T19:57:06.000000Z"
}

Response samples

Content type
application/json
{
  • "id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "description": "Validación ine",
  • "event_timestamp": "2021-03-10T19:57:06.000000Z",
  • "created_at": "2021-03-10T19:57:06.000000Z",
  • "updated_at": "2021-03-10T19:57:06.000000Z"
}

Borra un evento

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

Id del evento

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Creación de Documentos

En este apartado se se crean documentos a partir de PDFs ya generados, solo para que se añadan las firmas de los firmantes.

Crear un nuevo documento en base a un archivo

Authorizations:
apiKeyAuth
Request Body schema: multipart/form-data

Una petición multipart/form-data para crear un documento

document_name
string
file
string <binary>
send_email
boolean
autosigning
boolean

Bandera que indica si se firmara con NOM 151 el documento al terminar los usuarios de firmar

callback_url
string

URL en caso de que se quiera hacer llegar el documento al terminar el firmado de NOM 151.

expires_in
integer

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Agrega campos de firma a un documento creado desde un archivo

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El id para Identificar el Documento públicamente

Request Body schema: application/json

Una petición application/json para crear los firmantes del documento creado desde PDF

Array of objects
Array
name
string
email
string
country
string
state
string
locality
string
organization
string
is_fiel_signature
boolean

Indica si el firmante firmara con fiel

password
string <= 10 characters
include_name_in_signature
boolean

true en caso de que el nombre del firmante se incluya en la firma

expires_in
integer

Tiempo en minutos que durarán los tokens vinculados a este signer

external_person_id
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "signers": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": [
    ]
}

Proceso de firmado

Endpoints para el manejo de elementos relacionados con la firma digital

Verifica que un documento haya sido firmado

Authorizations:
apiKeyAuth
Request Body schema: multipart/form-data

Una petición multipart/form-data con el documento a validar

file
string <binary>

Archivo PDF a verificar

file_tmp_id
string <uuid>

Uuid del archivo si se subio con el api de archivos temporales

sha256
string <sha256>

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Firma un documento con la NOM 151

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del documento

Responses

Response samples

Content type
application/json
{}

Genera un documento que ha sido completamente llenado y lo almacena en la nube

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del documento

Responses

Response samples

Content type
application/json
{}

Agrega la firma digital de este firmante al documento

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del firmante

Request Body schema: multipart/form-data

Una petición application/json para crear la firma

value
string <binary>

La imagen a insertar en el documento, formatos aceptados png,jpg,jpeg,svg

password
string

Clave para del certificado del usuario

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Firmar con FIEL

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del firmante

Request Body schema: multipart/form-data
password
string

Contraseña de la FIEL

cer
string <binary>

Archivo .cer de la FIEL

key
string <binary>

Archivo .key de la FIEL

message
string <html>

Mensaje custom que aparecera junto a los detalles de la firma

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Firmantes

En este apartado se manejan los firmantes para cada documento así como la creación de token para el uso de los accesos públicos

Obtener una lista de todos los firmantes registrados

Authorizations:
apiKeyAuth
query Parameters
document_id
string
Example: document_id=51319186-a4a0-4497-a3c9-ebdbdaca0159
is_permanent
string
Enum: "true" "false"

Filtrar los firmantes si son permanentes o temporales

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Crea un nuevo firmante para un documento

Authorizations:
apiKeyAuth
Request Body schema: application/json

Una petición application/json para crear un firmante

document_id
string

Identificador del documento relacionado al firmante if null se creara un firmante permanente

name
string
email
string
password
string

Contraseña para proteger el certificado de la firma digital

expires_in
integer

Tiempo en minutos que durarán los tokens vinculados a este firmante

public_key
string

Clave pública de la wallet (Eclipse Network) del firmante, para realizar o recibir endosos

country
string = 2 characters
state
string
locality
string
organization
string
person_id
string <uuid>

Id de una persona registrada en la plataforma people vinculada al mismo cliente, en caso de estar presente se tomaran los datos de nombre y email de la misma, en caso de estar dispinibles.

external_person_id
string
only_digital_signature
boolean

true en caso de que la firma autografa no se ponga en el documento

include_name_in_signature
boolean

true en caso de que el nombre del firmante se incluya en la firma

is_fiel_signature
boolean

true si la forma de firmar para este firmante es con FIEL

elements
Array of strings

Arreglo de elementos que el firmante debe firmar

Responses

Request samples

Content type
application/json
{
  • "document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "name": "Test Firmante",
  • "email": "test@example.com",
  • "password": "12345",
  • "expires_in": 15,
  • "public_key": "sd123cb1x3c2b1n3vb2m1v32b1mv3213cb8m312m1bn3",
  • "country": "MX",
  • "state": "México City",
  • "locality": "Iztapalapa",
  • "organization": "rem-tools",
  • "person_id": "51234686-a4a0-4497-a3c9-ebdbdaca0159",
  • "external_person_id": "1a3sd51fsd32g1sdg5",
  • "only_digital_signature": false,
  • "include_name_in_signature": false,
  • "is_fiel_signature": false,
  • "elements": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Obtener una lista de todos los firmantes con el id externo

Authorizations:
apiKeyAuth
query Parameters
external_id
required
string
Example: external_id=lsdgbsjdfnpqwe

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": [
    ]
}

Obtener una lista de todos los firmantes con el id externo

Authorizations:
apiKeyAuth
query Parameters
external_id
required
string
Example: external_id=lsdgbsjdfnpqwe

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": [
    ]
}

Obtener los detalles de un firmante

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del firmante

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": [
    ]
}

Actualiza los detalles de un firmante

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del firmante

Request Body schema: application/json
name
string

Nombre del firmante

email
string
expires_in
integer

Tiempo en minutos que durarán los tokens vinculados a este firmante

public_key
string

Clave pública de la wallet (Eclipse Network) del firmante, para realizar o recibir endosos

Responses

Request samples

Content type
application/json
{
  • "name": "Test Firmante",
  • "email": "test@example.com",
  • "expires_in": 15,
  • "public_key": "sd123cb1x3c2b1n3vb2m1v32b1mv3213cb8m312m1bn3"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Elimina un firmante

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del firmante

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Obtiene los documentos de los firmantes permanentes

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del firmante permanente

Responses

Response samples

Content type
application/json
{}

Crea un token de acceso público para este firmante

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del firmante

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Agrega la firma digital de este firmante al documento

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del firmante

Request Body schema: multipart/form-data

Una petición application/json para crear la firma

value
string <binary>

La imagen a insertar en el documento, formatos aceptados png,jpg,jpeg,svg

password
string

Clave para del certificado del usuario

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Firmar con FIEL

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del firmante

Request Body schema: multipart/form-data
password
string

Contraseña de la FIEL

cer
string <binary>

Archivo .cer de la FIEL

key
string <binary>

Archivo .key de la FIEL

message
string <html>

Mensaje custom que aparecera junto a los detalles de la firma

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Firmar un endoso

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del firmante

Request Body schema: multipart/form-data

Una petición application/json para endosar un firmante

endorsement_id
string

Id del endoso que se desea aplicar al firmante

wallet_private_key
string

Clave privada de la wallet del firmante

fiel_password
string

Clave de la FIEL del firmante

cer
string <binary>

Archivo .cer de la FIEL del firmante

key
string <binary>

Archivo .key de la FIEL del firmante

message
string <html>

Mensaje custom que aparecera junto a los detalles de la firma

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Revisores

En este apartado se manejan los revisores para cada documento, estos pueden ser asignados a un documento para que puedan aprobarlo o rechazarlo, así como el tiempo que tienen para aprobarlo.

Obtener una lista de todos los revisores registrados

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
{}

Crea un nuevo revisor

Authorizations:
apiKeyAuth
Request Body schema: application/json

Una petición application/json para crear un revisor

name
string
email
string
type
string
Enum: "document" "endorsement"

(Opcional) Tipo de revisor, puede ser document o endorsement

reviewable_id
string

(Opcional) Id del documento o endoso que el revisor revisará

Responses

Request samples

Content type
application/json
{
  • "name": "Test Revisor",
  • "email": "test.revisor@example.com",
  • "type": "document",
  • "reviewable_id": "12345678-1234-1234-1234-123456789012"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Obtener los detalles de un revisor

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 12345678-1234-1234-1234-123456789012

El ID del revisor

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Actualiza los detalles de un revisor

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 12345678-1234-1234-1234-123456789012

El ID del revisor

Request Body schema: application/json

Una petición application/json para actualizar un revisor

name
string
email
string <email> [ 5 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "Test Revisor Actualizado",
  • "email": "test.revisor@ejemplo.com"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Elimina un revisor

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 12345678-1234-1234-1234-123456789012

El ID del revisor

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Revisor eliminado con éxito"
}

Agrega un revisor a un documento

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 12345678-1234-1234-1234-123456789012

El ID del revisor

Request Body schema: application/json

Una petición application/json para agregar un revisor a un documento

document_id
string

Id del documento al que se agregará el revisor

Responses

Request samples

Content type
application/json
{
  • "document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Elimina un revisor de un documento

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 12345678-1234-1234-1234-123456789012

El ID del revisor

Request Body schema: application/json

Una petición application/json para eliminar un revisor de un documento

document_id
string

Id del documento del que se eliminará el revisor

Responses

Request samples

Content type
application/json
{
  • "document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Agrega un revisor a una aprobación de endoso

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 12345678-1234-1234-1234-123456789012

El ID del revisor

Request Body schema: application/json

Una petición application/json para agregar un revisor a una aprobación de endoso

endorsement_id
string

Id del endoso al que se agregará el revisor

Responses

Request samples

Content type
application/json
{
  • "endorsement_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Elimina un revisor de una aprobación de endoso

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 12345678-1234-1234-1234-123456789012

El ID del revisor

Request Body schema: application/json

Una petición application/json para eliminar un revisor de una aprobación de endoso

endorsement_id
string

Id del endoso del que se eliminará el revisor

Responses

Request samples

Content type
application/json
{
  • "endorsement_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Envía una solicitud de aprobación a un revisor

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 12345678-1234-1234-1234-123456789012

El ID del revisor

Request Body schema: application/json

Una petición application/json para enviar una solicitud de aprobación al revisor

time_to_approve
integer

Tiempo en minutos que el revisor tiene para aprobar el documento

Responses

Request samples

Content type
application/json
{
  • "time_to_approve": 86400
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

NOM 151

En este apartado se sellan documentos solo con los certificados y no se almacena ningún archivo de los documentos sellados, solo se guardan los datos referentes a los certificados y los hash de los documentos

Consulta de documentos externos

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
{}

Genera un documento sellado con NOM 151 y certificados digitales para cada firmante

Authorizations:
apiKeyAuth
Request Body schema: multipart/form-data

Una petición multipart/form-data para sellar un archivo con NOM 151

file
string <binary>

Archivo que se desea firmar

file_tmp_id
string <uuid>

Uuid del archivo si se subio con el api de archivos temporales

Array of objects

Firmantes de este documento

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": {
    }
}

Crea una constancia de NOM 151 para el sha256 de la peticion

Authorizations:
apiKeyAuth
Request Body schema: application/json
sha256
string <sha256> = 64 characters
filename
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "sha256": "stringstringstringstringstringstringstringstringstringstringstri",
  • "filename": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Obtener un documento correspondiente al sha256

Authorizations:
apiKeyAuth
path Parameters
sha256
required
string
Example: 65f45505a560f8aefbfc0ac31ffcddab1183b144b607df41c7b3c3424c05d4e9

Hash sha256 del archivo PDF

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Borra un documento correspondiente al sha256

Authorizations:
apiKeyAuth
path Parameters
sha256
required
string
Example: 65f45505a560f8aefbfc0ac31ffcddab1183b144b607df41c7b3c3424c05d4e9

Hash sha256 del archivo PDF

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Verifica que el documento enviado corresponda con uno registrado

Authorizations:
apiKeyAuth
Request Body schema: multipart/form-data

Una petición multipart/form-data con el documento a validar

file
string <binary>

Archivo que se desea validar

file_tmp_id
string <uuid>

Uuid del archivo si se subio con el api de archivos temporales

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Verifica la constancia digital a partir de el sha256 del documento

Authorizations:
apiKeyAuth
Request Body schema: multipart/form-data

Peticion application/json post

sha256
string <sha256>

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Batch

En este apartado se pueden firmar documentos con FIEL de manera masiva

Obtener una lista de todos los procesos por lotes

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
{}

Crea un nuevo proceso por lotes para firmar documentos con FIEL

Authorizations:
apiKeyAuth
Request Body schema: application/json

Una petición application/json para crear un proceso por lotes

name
string

Nombre del proceso por lotes

type
string
Enum: "document" "endorsement"

Tipo de proceso por lotes

signer_id
string

ID del firmante

document_ids
Array of strings

IDs de los documentos a procesar por lotes para el tipo de documento

endorsement_ids
Array of strings

IDs de los endosos a procesar por lotes para el tipo de endoso

Responses

Request samples

Content type
application/json
{
  • "name": "Proceso por lotes de prueba",
  • "type": "batch_process_type",
  • "signer_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "document_ids": [
    ],
  • "endorsement_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Obtener el detalle del proceso por lotes solicitado

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

ID del proceso por lotes

Responses

Response samples

Content type
application/json
{
  • "id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "type": "document",
  • "status": "pending"
}

Actualiza la información de un proceso por lotes

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

ID del proceso por lotes

Request Body schema: application/json

Una petición application/json para actualizar un proceso por lotes

name
string

Nombre del proceso por lotes

type
string

Tipo de proceso por lotes

signer_id
string

ID del firmante

document_ids
Array of strings

IDs de los documentos a procesar por lotes para el tipo de documento

endorsement_ids
Array of strings

IDs de los endosos a procesar por lotes para el tipo de endoso

Responses

Request samples

Content type
application/json
{
  • "name": "Proceso por lotes de prueba actualizado",
  • "type": "batch_process_type_updated",
  • "signer_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "document_ids": [
    ],
  • "endorsement_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "type": "document",
  • "status": "pending"
}

Borra un proceso por lotes

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

ID del proceso por lotes

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Procesa un proceso por lotes

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

ID del proceso por lotes

Request Body schema: multipart/form-data
wallet_private_key
string <binary>

Clave privada de la wallet para firmar endosos

fiel_password
string

Clave de la FIEL del firmante

cer
string <binary>

Archivo .cer de la FIEL del firmante

key
string <binary>

Archivo .key de la FIEL del firmante

message
string <html>

Mensaje custom que aparecera junto a los detalles de la firma

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Descarga un proceso por lotes en formato PDF

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

ID del proceso por lotes

Request Body schema: application/json
email
string

Correo electrónico del usuario que solicita la descarga

Responses

Request samples

Content type
application/json
{
  • "email": "test@example.com"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Creating zip file in background, you will receive an email when it is ready"
}

Público

Endpoints que no requieren autorización del ApiKey de Rem-Tools

Agrega la firma del firmante al documento

Authorizations:
bearerAuthPublicSigner
Request Body schema: multipart/form-data

Una petición multipart/form-data para crear la firma

value
string <binary>

La imagen a insertar en el documento, formatos aceptados png,jpg,jpeg,svg

finish
boolean

Caduca el token público, 0 o 1

password
string

Clave para del certificado del usuario

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Firmar publicamente con la FIEL del firmante

Authorizations:
bearerAuthPublicSigner
Request Body schema: multipart/form-data

Una petición multipart/form-data para crear la firma FIEL

password
string

Contraseña de la FIEL del firmante

cer
string <binary>

Archivo .cer que es parte de la FIEL

key
string <binary>

Archivo .key que es parte de la FIEL

message
string

Mensaje que acompaña la fecha en que se firmo el documento en el historial de eventos, no requerido

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Construir un preview del PDF

Authorizations:
bearerAuthPublicSigner

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Missing authorization token"
}

Elimina el token público para dejar de hacer cambios

Authorizations:
bearerAuthPublicSigner

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Obtiene la información del documento para el firmante

Authorizations:
bearerAuthPublicSigner

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Adjunta archivos a un documento

Authorizations:
bearerAuthPublicDoc
Request Body schema: application/json

Una petición application/json con un arreglo de URLs

urls
Array of strings
paths
Array of strings
collection
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Files saved"
}

Crea un firmante para este documento con un token para acceso público

Authorizations:
bearerAuthPublicDoc
Request Body schema: application/json

Una petición application/json para crear un firmante

name
string
email
string
password
string

Contraseña para proteger el certificado de la firma digital

country
string = 2 characters
state
string
locality
string
organization
string
external_person_id
string
expires_in
integer

Tiempo de expiración en minutos de los token vinculados, si es 0 no expiran

metadata
object
elements
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "Test Firmante",
  • "email": "test@example.com",
  • "password": "12345",
  • "country": "MX",
  • "state": "México City",
  • "locality": "Iztapalapa",
  • "organization": "rem-tools",
  • "external_person_id": "1a3sd51fsd32g1sdg5",
  • "expires_in": 15,
  • "metadata": null,
  • "elements": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Construir un preview del PDF

Authorizations:
bearerAuthPublicDoc

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Missing authorization token"
}

Webhooks

Webhooks que se envían al configurar el campo callback_url en los documentos

Documento terminado Webhook

Webhook que se envia cuando se ha configurado el autosigning y callback_url en la creación del documento

Request Body schema: application/json

Una petición application/json con la información del documento firmado

resource
string

Tipo de recurso

event
string

Tipo de evento

resource_id
string

Identificador del recurso

Document (object) or Document (object) (Document)

Información del evento

Responses

Request samples

Content type
application/json
{}

Firmante ha firmado Webhook

Webhook que se envia cuando se ha configurado el callback_url y un firmante ha firmado de manera pública con el parámetro finish igual a 1

Request Body schema: application/json

Una petición application/json con la información del firmante

resource
string

Tipo de recurso

event
string

Tipo de evento

resource_id
string

Identificador del recurso

Temporary Signer (object) or Permanent Signer (object)

Información del evento

Responses

Request samples

Content type
application/json
{
  • "resource": "Signer",
  • "event": "Sign",
  • "resource_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "payload": {
    }
}

Endosos

En este apartado se pueden crear los endosos para los documentos, para que estos puedan ser transmitidos a otras personas o empresas, así como la creación de un token en blockchain para la verificación de estos endosos.

Firmar un endoso

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del firmante

Request Body schema: multipart/form-data

Una petición application/json para endosar un firmante

endorsement_id
string

Id del endoso que se desea aplicar al firmante

wallet_private_key
string

Clave privada de la wallet del firmante

fiel_password
string

Clave de la FIEL del firmante

cer
string <binary>

Archivo .cer de la FIEL del firmante

key
string <binary>

Archivo .key de la FIEL del firmante

message
string <html>

Mensaje custom que aparecera junto a los detalles de la firma

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Obtener una lista de todos los endosos

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Crea un endoso

Authorizations:
apiKeyAuth
Request Body schema: application/json

Una petición application/json para crear un endoso

name
string

Nombre del endoso

type
string
Enum: "guarantee" "collection" "ownership"

Tipo de endoso

auto_certify
boolean

Indica si el endoso se certifica automáticamente

signer_id
string

ID del firmante

document_id
string

ID del documento al que se le aplicará el endoso

endorsement_id
string

ID del endoso al que se le aplicará el endoso

endorsee_id
string

ID del endosatario (Signer)

Responses

Request samples

Content type
application/json
{
  • "name": "Endoso de prueba",
  • "type": "guarantee",
  • "auto_certify": true,
  • "signer_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "endorsement_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "endorsee_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159"
}

Response samples

Content type
application/json
{
  • "id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "name": "Endoso de prueba",
  • "type": "Endoso de prueba",
  • "sha256": "65f45505a560f8aefbfc0ac31ffcddab1183b144b607df41c7b3c3424c05d4e9",
  • "auto_certify": false,
  • "signer_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "endorsement_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "original_document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "endorsee_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "status": "pending",
  • "metadata": null,
  • "signed_at": "2021-07-29T18:29:05.000000Z",
  • "certified_at": "2021-07-29T18:29:05.000000Z",
  • "blockchain_metadata": null,
  • "certificate_base64": "MIIC..."
}

Obtener el detalle del endoso solicitado

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

ID del endoso

Responses

Response samples

Content type
application/json
{
  • "id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "name": "Endoso de prueba",
  • "type": "Endoso de prueba",
  • "sha256": "65f45505a560f8aefbfc0ac31ffcddab1183b144b607df41c7b3c3424c05d4e9",
  • "auto_certify": false,
  • "signer_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "endorsement_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "original_document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "endorsee_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "status": "pending",
  • "metadata": null,
  • "signed_at": "2021-07-29T18:29:05.000000Z",
  • "certified_at": "2021-07-29T18:29:05.000000Z",
  • "blockchain_metadata": null,
  • "certificate_base64": "MIIC..."
}

Actualiza la información de un endoso

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

ID del endoso

Request Body schema: application/json

Una petición application/json para actualizar un endoso

name
string

Nombre del endoso

type
string

Tipo de endoso

auto_certify
boolean

Indica si el endoso se certifica automáticamente

signer_id
string

ID del firmante

document_id
string

ID del documento al que se le aplicará el endoso

endorsement_id
string

ID del endoso al que se le aplicará el endoso

endorsee_name
string

Nombre del endosatario

endorsee_public_id
string

ID público del endosatario CURP o RFC

endorsee_public_key
string

Clave pública del endosatario

endorsee_contact
string

Información de contacto del endosatario

Responses

Request samples

Content type
application/json
{
  • "name": "Endoso de prueba actualizado",
  • "type": "endorsement_updated",
  • "auto_certify": false,
  • "signer_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "endorsement_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "endorsee_name": "Endosatario de prueba actualizado",
  • "endorsee_public_id": "XAXX010101HNEXXXA",
  • "endorsee_public_key": "as4cv1d25v15xdv1x32b1c5b1dfb32n1gf58mg1h32m1gh8k4g2sd3vgsdg523sd1g8",
  • "endorsee_contact": "test@example.com"
}

Response samples

Content type
application/json
{
  • "id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "name": "Endoso de prueba",
  • "type": "Endoso de prueba",
  • "sha256": "65f45505a560f8aefbfc0ac31ffcddab1183b144b607df41c7b3c3424c05d4e9",
  • "auto_certify": false,
  • "signer_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "endorsement_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "original_document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "endorsee_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "status": "pending",
  • "metadata": null,
  • "signed_at": "2021-07-29T18:29:05.000000Z",
  • "certified_at": "2021-07-29T18:29:05.000000Z",
  • "blockchain_metadata": null,
  • "certificate_base64": "MIIC..."
}

Borra un endoso

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

ID del endoso

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Certifica un endoso

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

ID del endoso

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Descarga un endoso en formato PDF

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

ID del endoso

Responses

Response samples

Obtener las aprobaciones de un endoso

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

ID del endoso

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": [
    ]
}

Envía una solicitud de aprobación para un endoso

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

ID del endoso

Request Body schema: application/json

Una petición application/json para enviar solicitudes de aprobación

time_to_approve
integer

Tiempo en minutos que el revisor tiene para aprobar el documento

reset_approvals
boolean

Indica si se deben reiniciar las aprobaciones existentes

Responses

Request samples

Content type
application/json
{
  • "time_to_approve": 86400,
  • "reset_approvals": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Batch

En este apartado se pueden firmar documentos con FIEL de manera masiva

Obtener una lista de todos los procesos por lotes

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
{}

Crea un nuevo proceso por lotes para firmar documentos con FIEL

Authorizations:
apiKeyAuth
Request Body schema: application/json

Una petición application/json para crear un proceso por lotes

name
string

Nombre del proceso por lotes

type
string
Enum: "document" "endorsement"

Tipo de proceso por lotes

signer_id
string

ID del firmante

document_ids
Array of strings

IDs de los documentos a procesar por lotes para el tipo de documento

endorsement_ids
Array of strings

IDs de los endosos a procesar por lotes para el tipo de endoso

Responses

Request samples

Content type
application/json
{
  • "name": "Proceso por lotes de prueba",
  • "type": "batch_process_type",
  • "signer_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "document_ids": [
    ],
  • "endorsement_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Obtener el detalle del proceso por lotes solicitado

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

ID del proceso por lotes

Responses

Response samples

Content type
application/json
{
  • "id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "type": "document",
  • "status": "pending"
}

Actualiza la información de un proceso por lotes

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

ID del proceso por lotes

Request Body schema: application/json

Una petición application/json para actualizar un proceso por lotes

name
string

Nombre del proceso por lotes

type
string

Tipo de proceso por lotes

signer_id
string

ID del firmante

document_ids
Array of strings

IDs de los documentos a procesar por lotes para el tipo de documento

endorsement_ids
Array of strings

IDs de los endosos a procesar por lotes para el tipo de endoso

Responses

Request samples

Content type
application/json
{
  • "name": "Proceso por lotes de prueba actualizado",
  • "type": "batch_process_type_updated",
  • "signer_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "document_ids": [
    ],
  • "endorsement_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
  • "type": "document",
  • "status": "pending"
}

Borra un proceso por lotes

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

ID del proceso por lotes

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Ok"
}

Procesa un proceso por lotes

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

ID del proceso por lotes

Request Body schema: multipart/form-data
wallet_private_key
string <binary>

Clave privada de la wallet para firmar endosos

fiel_password
string

Clave de la FIEL del firmante

cer
string <binary>

Archivo .cer de la FIEL del firmante

key
string <binary>

Archivo .key de la FIEL del firmante

message
string <html>

Mensaje custom que aparecera junto a los detalles de la firma

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    }
}

Descarga un proceso por lotes en formato PDF

Authorizations:
apiKeyAuth
path Parameters
id
required
string
Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

ID del proceso por lotes

Request Body schema: application/json
email
string

Correo electrónico del usuario que solicita la descarga

Responses

Request samples

Content type
application/json
{
  • "email": "test@example.com"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "result": "Creating zip file in background, you will receive an email when it is ready"
}
rem

JOIN US ON

facebooktwitterLinkedIn
AVISOS DE PRIVACIDADClientesProveedoresTrabajadoresUsuarios
POLÍTICASSeguridad de la informaciónTransferencia de datosPolítica disciplinaria
CONTACThello@rem.tools55-91-03-80-54
© Copyright rem 2022 All rights reserved.