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

200

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"first_page_url": "http://localhost:8000/templates?page=1",
"from": 1,
"last_page": 5,
"last_page_url": "http://localhost:8000/templates?page=5",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://localhost:8000/templates?page=1",
"label": "1",
"active": true
},
{"url": "http://localhost:8000/templates?page=2",
"label": "2",
"active": false
},
{"url": "http://localhost:8000/templates?page=3",
"label": "3",
"active": false
},
{"url": "http://localhost:8000/templates?page=4",
"label": "4",
"active": false
},
{"url": "http://localhost:8000/templates?page=5",
"label": "5",
"active": false
},
{"url": "http://localhost:8000/templates?page=2",
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://localhost:8000/templates",
"per_page": 20,
"prev_page_url": null,
"to": 20,
"total": 87,
"data": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Test",
"description": "Template test",
"pages": 5,
"created_at": "2021-03-10T00:09:30.000000Z",
"updated_at": "2021-03-10T00:09:30.000000Z"
}
]
}
}

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

201
400

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Test",
"description": "Template test",
"pages": 5,
"created_at": "2021-03-10T00:09:30.000000Z",
"updated_at": "2021-03-10T00:09:30.000000Z",
"template": "https://signt-platform-storage.s3.us-west-2.amazonaws.com/13/Cara%CC%81tula-de-Contrato.pdf?response-content-type=application%2Foctet-stream&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLXdlc3QtMiJHMEUCIG%2Bpoy2pJzlOR%2FZv3gxPAliR24keVQo%2BLAGpv6H1jSs7AiEAmeEmkSVZ2IK4rYBf6rIfEnOsEXXzDZVb0%2FQj70oQ%2Bpoq2gEIMhABGgwwMDE4OTU1NjA3NTkiDD%2BEpbp%2BPi8C1l7ftCq3ASAJ33pCCMEKu%2FnMaFE66YLK5vEIUGeHu2KAo2Gyj8QELB4PKc7dm%2BRXVl407jpFpwVvvvqioh86Mwg0GphoTkPiguEQwXMMI1Z1ZzOu93ozLWg0h2YfcF8b4qU3rRbR5Un0WehwfjCThzJXRFoFfcvFhKzLswBDR3D9LGowokJb0x7hOcK9bGTmBz2A0MtknXliffuIstawdkR%2BWjD2pM69hBPpbWmFU82uObuX%2Fc7qwOvkXIzGbDDQ28iCBjrhAVVyL517jKJ4zpMFwY%2BXgeREpWmCiHeVyktsav%2F9A69CoORunRtQmTP1OrpMU3%2BOev7y875JqlgsgGra4ozecQYhrRcu1l59El1vIWQ%2FeGHq%2BaieTV2LLoDcdXxM%2F72S2daShR%2FeWcydKUxbIRqmrwYhDHXWUjCPFRYqmTn1SgKEn6EKlOjdwWEXAml1eF4ufkIaGte1rX%2Bo%2FKMegtZ9gI0cb%2BotnPvGpovmzRhKaN%2FTnP6OPVkiooeC94xsWA6jF2fZG9ZHiSZL6HrtVV0sCSezVDLy1nBx7ik%2Bo0HycEt3kQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAQA4H36Y3RAUEDLOH%2F20210317%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20210317T172740Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Signature=0949718ab552c4add436b6e2d52326fa41440ce8b595398e28f4970262d8cffe"
}
}

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

200
404

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Test",
"description": "Template test",
"pages": 5,
"created_at": "2021-03-10T00:09:30.000000Z",
"updated_at": "2021-03-10T00:09:30.000000Z",
"template": "https://signt-platform-storage.s3.us-west-2.amazonaws.com/13/Cara%CC%81tula-de-Contrato.pdf?response-content-type=application%2Foctet-stream&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLXdlc3QtMiJHMEUCIG%2Bpoy2pJzlOR%2FZv3gxPAliR24keVQo%2BLAGpv6H1jSs7AiEAmeEmkSVZ2IK4rYBf6rIfEnOsEXXzDZVb0%2FQj70oQ%2Bpoq2gEIMhABGgwwMDE4OTU1NjA3NTkiDD%2BEpbp%2BPi8C1l7ftCq3ASAJ33pCCMEKu%2FnMaFE66YLK5vEIUGeHu2KAo2Gyj8QELB4PKc7dm%2BRXVl407jpFpwVvvvqioh86Mwg0GphoTkPiguEQwXMMI1Z1ZzOu93ozLWg0h2YfcF8b4qU3rRbR5Un0WehwfjCThzJXRFoFfcvFhKzLswBDR3D9LGowokJb0x7hOcK9bGTmBz2A0MtknXliffuIstawdkR%2BWjD2pM69hBPpbWmFU82uObuX%2Fc7qwOvkXIzGbDDQ28iCBjrhAVVyL517jKJ4zpMFwY%2BXgeREpWmCiHeVyktsav%2F9A69CoORunRtQmTP1OrpMU3%2BOev7y875JqlgsgGra4ozecQYhrRcu1l59El1vIWQ%2FeGHq%2BaieTV2LLoDcdXxM%2F72S2daShR%2FeWcydKUxbIRqmrwYhDHXWUjCPFRYqmTn1SgKEn6EKlOjdwWEXAml1eF4ufkIaGte1rX%2Bo%2FKMegtZ9gI0cb%2BotnPvGpovmzRhKaN%2FTnP6OPVkiooeC94xsWA6jF2fZG9ZHiSZL6HrtVV0sCSezVDLy1nBx7ik%2Bo0HycEt3kQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAQA4H36Y3RAUEDLOH%2F20210317%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20210317T172740Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Signature=0949718ab552c4add436b6e2d52326fa41440ce8b595398e28f4970262d8cffe",
"elements": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Campo 2",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"type": 1,
"page": 1,
"top": 20,
"left": 20,
"width": 50,
"height": 20,
"metadata": {"font": "times",
"font_size": 12,
"font_style": "BI",
"text_align": "J",
"line_height": 1.25,
"font_color_rgb": [0,
0,
0
]
},
"rules": ["required",
"string",
"max:50"
],
"created_at": "2021-03-10T00:09:30.000000Z",
"updated_at": "2021-03-10T00:09:30.000000Z"
}
]
}
}

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

200
404

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Test",
"description": "Template test",
"pages": 5,
"created_at": "2021-03-10T00:09:30.000000Z",
"updated_at": "2021-03-10T00:09:30.000000Z",
"elements": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Campo 2",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"type": 1,
"page": 1,
"top": 20,
"left": 20,
"width": 50,
"height": 20,
"metadata": {"font": "times",
"font_size": 12,
"font_style": "BI",
"text_align": "J",
"line_height": 1.25,
"font_color_rgb": [0,
0,
0
]
},
"rules": ["required",
"string",
"max:50"
],
"created_at": "2021-03-10T00:09:30.000000Z",
"updated_at": "2021-03-10T00:09:30.000000Z"
}
]
}
}

Borrar un template

Authorizations:

apiKeyAuth

path Parameters

id

required

string

Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del template

Responses

Response samples

200
404

Content type

application/json

{"success": true,
"result": "Ok"
}

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

200

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"first_page_url": "http://localhost:8000/template-elements?page=1",
"from": 1,
"last_page": 5,
"last_page_url": "http://localhost:8000/template-elements?page=5",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://localhost:8000/template-elements?page=1",
"label": "1",
"active": true
},
{"url": "http://localhost:8000/template-elements?page=2",
"label": "2",
"active": false
},
{"url": "http://localhost:8000/template-elements?page=3",
"label": "3",
"active": false
},
{"url": "http://localhost:8000/template-elements?page=4",
"label": "4",
"active": false
},
{"url": "http://localhost:8000/template-elements?page=5",
"label": "5",
"active": false
},
{"url": "http://localhost:8000/template-elements?page=2",
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://localhost:8000/template-elements",
"per_page": 20,
"prev_page_url": null,
"to": 20,
"total": 87,
"data": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Campo 2",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"type": 1,
"page": 1,
"top": 20,
"left": 20,
"width": 50,
"height": 20,
"metadata": {"font": "times",
"font_size": 12,
"font_style": "BI",
"text_align": "J",
"line_height": 1.25,
"font_color_rgb": [0,
0,
0
]
},
"rules": ["required",
"string",
"max:50"
],
"created_at": "2021-03-10T00:09:30.000000Z",
"updated_at": "2021-03-10T00:09:30.000000Z"
}
]
}
}

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

Payload

Content type

application/json

{"name": "Campo Nombre",
"type": 3,
"page": 1,
"top": 20,
"left": 20,
"width": 50,
"height": 20,
"metadata": {"font": "string",
"font_size": 12,
"font_style": "BI",
"text_align": "J",
"line_height": 1.25,
"font_color_rgb": [0,
0,
0
]
},
"rules": ["required",
"string",
"max:10"
],
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159"
}

Response samples

201
400

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Campo 2",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"type": 1,
"page": 1,
"top": 20,
"left": 20,
"width": 50,
"height": 20,
"metadata": {"font": "times",
"font_size": 12,
"font_style": "BI",
"text_align": "J",
"line_height": 1.25,
"font_color_rgb": [0,
0,
0
]
},
"rules": ["required",
"string",
"max:50"
],
"created_at": "2021-03-10T00:09:30.000000Z",
"updated_at": "2021-03-10T00:09:30.000000Z"
}
}

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

200
404

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Campo 2",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"type": 1,
"page": 1,
"top": 20,
"left": 20,
"width": 50,
"height": 20,
"metadata": {"font": "times",
"font_size": 12,
"font_style": "BI",
"text_align": "J",
"line_height": 1.25,
"font_color_rgb": [0,
0,
0
]
},
"rules": ["required",
"string",
"max:50"
],
"created_at": "2021-03-10T00:09:30.000000Z",
"updated_at": "2021-03-10T00:09:30.000000Z"
}
}

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

Payload

Content type

application/json

{"name": "Campo Nombre",
"type": 1,
"page": 1,
"top": 20,
"left": 20,
"width": 50,
"height": 20,
"metadata": {"font": "string",
"font_size": 12,
"font_style": "BI",
"text_align": "J",
"line_height": 1.25,
"font_color_rgb": [0,
0,
0
]
},
"rules": ["required",
"max:50"
],
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159"
}

Response samples

200
404

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Campo 2",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"type": 1,
"page": 1,
"top": 20,
"left": 20,
"width": 50,
"height": 20,
"metadata": {"font": "times",
"font_size": 12,
"font_style": "BI",
"text_align": "J",
"line_height": 1.25,
"font_color_rgb": [0,
0,
0
]
},
"rules": ["required",
"string",
"max:50"
],
"created_at": "2021-03-10T00:09:30.000000Z",
"updated_at": "2021-03-10T00:09:30.000000Z"
}
}

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

200
404

Content type

application/json

{"success": true,
"result": "Ok"
}

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

200

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"first_page_url": "http://localhost:8000/documents?page=1",
"from": 1,
"last_page": 5,
"last_page_url": "http://localhost:8000/documents?page=5",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://localhost:8000/documents?page=1",
"label": "1",
"active": true
},
{"url": "http://localhost:8000/documents?page=2",
"label": "2",
"active": false
},
{"url": "http://localhost:8000/documents?page=3",
"label": "3",
"active": false
},
{"url": "http://localhost:8000/documents?page=4",
"label": "4",
"active": false
},
{"url": "http://localhost:8000/documents?page=5",
"label": "5",
"active": false
},
{"url": "http://localhost:8000/documents?page=2",
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://localhost:8000/documents",
"per_page": 20,
"prev_page_url": null,
"to": 20,
"total": 87,
"data": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Documento ejemplo",
"send_email": false,
"autosigning": false,
"callback_url": "http://example.com",
"expires_in": 15,
"from_file": false,
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z",
"last_generated_at": "2021-02-26T01:06:59.000000Z",
"signed_at": null,
"fiel_sign_started_at": "2021-02-26T01:06:59.000000Z",
"fiel_doc_hash": "string",
"asn1_base64": "string",
"sha256": "string"
}
]
}
}

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

Payload

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": [{"template_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"value": "%16"
}
]
}

Response samples

201
400

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Documento ejemplo",
"send_email": false,
"autosigning": false,
"callback_url": "http://example.com",
"expires_in": 15,
"from_file": false,
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z",
"last_generated_at": "2021-02-26T01:06:59.000000Z",
"signed_at": null,
"fiel_sign_started_at": "2021-02-26T01:06:59.000000Z",
"fiel_doc_hash": "string",
"asn1_base64": "string",
"sha256": "string",
"elements": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"value": "Texto ejemplo",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z"
}
]
}
}

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

200
400
404

Content type

application/json

{"success": true,
"result": {"match": true,
"hash": "f65cf09147392b539fd7fb12d6d8c2b6ffd3f403166e577bcfa04ec9fe0aadde",
"timestamp_info": "signer cert serial number: 2A\r\nsigner cert issuer: L=Alvaro Obregon,ST=Ciudad de Mexico,C=MX,PostalCode=01030,STREET=Insurgentes Sur 1940\\, Col. Florida,CN=Autoridad Certificadora Raiz Segunda de Secretaria de Economia,OU=Direccion General de Normatividad Mercantil,O=Secretaria de Economia,E=acr2se@economia.gob.mx\r\ngenTime: 2021-08-24T21:28:57Z\r\ncertificates count: 1\r\nall certificates: EMAILADDRESS=acedicommx@edicomgroup.com, O=Edicomunicaciones Mexico S.A. de C.V., OU=TSA, CN=TSAEDICOMMX, STREET=Avda. Paseo de la Reforma 483 Pisos 25-27 Cuauhtemoc, OID.2.5.4.17=06500, C=MX, ST=Ciudad de Mexico, L=Cuauhtemoc; SKI=c2c859d69b38a1c13aa1bdab038e60bb32300210\r\nembedded certificate: EMAILADDRESS=acedicommx@edicomgroup.com, O=Edicomunicaciones Mexico S.A. de C.V., OU=TSA, CN=TSAEDICOMMX, STREET=Avda. Paseo de la Reforma 483 Pisos 25-27 Cuauhtemoc, OID.2.5.4.17=06500, C=MX, ST=Ciudad de Mexico, L=Cuauhtemoc; SKI=c2c859d69b38a1c13aa1bdab038e60bb32300210\r\nadding to certificate chain: EMAILADDRESS=acedicommx@edicomgroup.com, O=Edicomunicaciones Mexico S.A. de C.V., OU=TSA, CN=TSAEDICOMMX, STREET=Avda. Paseo de la Reforma 483 Pisos 25-27 Cuauhtemoc, OID.2.5.4.17=06500, C=MX, ST=Ciudad de Mexico, L=Cuauhtemoc\r\n1.2.840.113549.1.9.4=<Set oid='1.2.840.113549.1.9.4' name='pkcs9_messageDigest'></Set>\r\n1.2.840.113549.1.9.3=<Set oid='1.2.840.113549.1.9.3' name='pkcs9_contentType'></Set>\r\n1.2.840.113549.1.9.52=<Set oid='1.2.840.113549.1.9.52'></Set>\r\n1.2.840.113549.1.9.5=<Set oid='1.2.840.113549.1.9.5' name='pkcs9_signingTime'></Set>\r\n1.2.840.113549.1.9.16.2.47=<Set oid='1.2.840.113549.1.9.16.2.47' name='id_aa_signingCertificateV2'></Set>\r\n",
"document": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Documento ejemplo",
"send_email": false,
"autosigning": false,
"callback_url": "http://example.com",
"expires_in": 15,
"from_file": false,
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z",
"last_generated_at": "2021-02-26T01:06:59.000000Z",
"signed_at": null,
"fiel_sign_started_at": "2021-02-26T01:06:59.000000Z",
"fiel_doc_hash": "string",
"asn1_base64": "string",
"sha256": "string"
}
}
}

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

200
400

Content type

application/json

{"success": true,
"result": {"match": true
}
}

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

200
404

Content type

application/json

{"success": true,
"result": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Documento ejemplo",
"send_email": false,
"autosigning": false,
"callback_url": "http://example.com",
"expires_in": 15,
"from_file": false,
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z",
"last_generated_at": "2021-02-26T01:06:59.000000Z",
"signed_at": null,
"fiel_sign_started_at": "2021-02-26T01:06:59.000000Z",
"fiel_doc_hash": "string",
"asn1_base64": "string",
"sha256": "string",
"elements": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"value": "Texto ejemplo",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z"
}
}
]
}

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

Payload

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

200
404

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Documento ejemplo",
"send_email": false,
"autosigning": false,
"callback_url": "http://example.com",
"expires_in": 15,
"from_file": false,
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z",
"last_generated_at": "2021-02-26T01:06:59.000000Z",
"signed_at": null,
"fiel_sign_started_at": "2021-02-26T01:06:59.000000Z",
"fiel_doc_hash": "string",
"asn1_base64": "string",
"sha256": "string"
}
}

Borrar un document

Authorizations:

apiKeyAuth

path Parameters

id

required

string

Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del Documento

Responses

Response samples

200
404

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

200
400
404

Content type

application/json

{"success": true,
"result": {"document_url": "https://signt-platform-storage.s3.us-west-2.amazonaws.com/36/Caratula-16-marzo.pdf?response-content-type=application%2Foctet-stream&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLXdlc3QtMiJHMEUCIG%2Bpoy2pJzlOR%2FZv3gxPAliR24keVQo%2BLAGpv6H1jSs7AiEAmeEmkSVZ2IK4rYBf6rIfEnOsEXXzDZVb0%2FQj70oQ%2Bpoq2gEIMhABGgwwMDE4OTU1NjA3NTkiDD%2BEpbp%2BPi8C1l7ftCq3ASAJ33pCCMEKu%2FnMaFE66YLK5vEIUGeHu2KAo2Gyj8QELB4PKc7dm%2BRXVl407jpFpwVvvvqioh86Mwg0GphoTkPiguEQwXMMI1Z1ZzOu93ozLWg0h2YfcF8b4qU3rRbR5Un0WehwfjCThzJXRFoFfcvFhKzLswBDR3D9LGowokJb0x7hOcK9bGTmBz2A0MtknXliffuIstawdkR%2BWjD2pM69hBPpbWmFU82uObuX%2Fc7qwOvkXIzGbDDQ28iCBjrhAVVyL517jKJ4zpMFwY%2BXgeREpWmCiHeVyktsav%2F9A69CoORunRtQmTP1OrpMU3%2BOev7y875JqlgsgGra4ozecQYhrRcu1l59El1vIWQ%2FeGHq%2BaieTV2LLoDcdXxM%2F72S2daShR%2FeWcydKUxbIRqmrwYhDHXWUjCPFRYqmTn1SgKEn6EKlOjdwWEXAml1eF4ufkIaGte1rX%2Bo%2FKMegtZ9gI0cb%2BotnPvGpovmzRhKaN%2FTnP6OPVkiooeC94xsWA6jF2fZG9ZHiSZL6HrtVV0sCSezVDLy1nBx7ik%2Bo0HycEt3kQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAQA4H36Y3RAUEDLOH%2F20210317%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20210317T183753Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Signature=5ce29670aede42e0925adfa22747ac63ac2142d46a4a345f4c3e9822a425e2fc"
}
}

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

200
404

Content type

application/json

{"success": true,
"result": {"token": "123|wWriJkT0VrduQAGHsNbiw5sG7tig5Z2BGu0kzWSR",
"expiration": "2021-04-07T15:14:19.000000Z"
}
}

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

Adjunta un archivo al documento

Authorizations:

apiKeyAuth

path Parameters

id

required

string

Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El id para Identificar el Documento públicamente

Request Body schema: multipart/form-data

Una petición multipart/form-data para subir un archivo

file	string <binary> Archivo a asociar con el documento
collection	string Nombre para agrupar los archivos subidos

Responses

Response samples

200
400
404

Content type

application/json

{"success": true,
"result": "File uploaded"
}

Adjunta archivos al documento desde URLs o S3 paths

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 con un arreglo de URLs o S3 paths

urls	Array of strings
paths	Array of strings
collection	string Nombre para agrupar los archivos subidos

Responses

Request samples

Payload

Content type

application/json

{"urls": ["http://example.com/image.jpg"
],
"paths": ["/path/to/file.jpg"
],
"collection": "ine"
}

Response samples

200
400
404

Content type

application/json

{"success": true,
"result": "Files Saved"
}

Obtener una lista de archivos relacionados con el documento

Authorizations:

apiKeyAuth

path Parameters

id

required

string

Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El id para Identificar el Documento públicamente

query Parameters

expires_in

required

integer

Example: expires_in=5

Minutos que durarán las URLs temporales

Responses

Response samples

200
404

Content type

application/json

{"success": true,
"result": [{"id": 240,
"model_type": "App\\Models\\Document",
"model_id": 78,
"uuid": "bd7f4c53-c9ec-47ba-8f42-c1b2da5d03d7",
"collection_name": "default",
"name": "media-libraryNEDAom",
"file_name": "Caratula-prueba.pdf",
"mime_type": "application/pdf",
"disk": "s3",
"conversions_disk": "s3",
"size": 131765,
"manipulations": [ ],
"custom_properties": [ ],
"generated_conversions": [ ],
"responsive_images": [ ],
"order_column": 159,
"created_at": "2021-08-10T15:24:25.000000Z",
"updated_at": "2021-08-10T15:24:25.000000Z",
"temp_url": "https://signt-platform-storage.s3.us-west-2.amazonaws.com/240/Caratula-prueba.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQA4H36Y37PY6FLFH%2F20210810%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20210810T194641Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Signature=3f2a1b48ea948d906cbe4f71dbd08201f30722224386e0c85115f8d94a83a750"
}
]
}

Borra un archivo relacionado con el documento

Authorizations:

apiKeyAuth

path Parameters

id

required

string

Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El id para Identificar el Documento públicamente

query Parameters

collection required	string Example: collection=ine Colleccion a la que pertenece el archivo
media_uuid required	string Example: media_uuid=bd7f4c53-c9ec-47ba-8f42-c1b2da5d03d7 Identificador uuid del archivo de media

Responses

Response samples

200
404

Content type

application/json

{"success": true,
"result": "Ok"
}

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

200
404

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

Payload

Content type

application/json

{"fields": {"1319186-a4a0-4497-a3c9-ebdbdaca0159": "Test"
}
}

Response samples

200
400

Content type

application/json

{"success": true,
"result": [{"template_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"value": "Texto ejemplo"
}
]
}

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

Payload

Content type

application/json

{"signers": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"password": "12345",
"expires_in": 15,
"only_digital_signature": false,
"is_fiel_signature": false,
"elements": ["51319186-a4a0-4497-a3c9-ebdbdaca0159",
"78932121-c7b0-4497-c9c4-abdfcaca9874"
]
}
]
}

Response samples

200
400

Content type

application/json

{"success": true,
"result": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z",
"signed_at": "2021-04-07T15:14:19.000000Z",
"person_id": "51456456-a4a0-4497-a3c9-ebdbdaca0159",
"external_person_id": null,
"include_name_in_signature": false,
"expires_in": 15,
"metadata": null,
"is_fiel_signature": false,
"is_permanent": false
}
]
}

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

200
404

Content type

application/json

{"success": true,
"result": "Ok"
}

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

200

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"first_page_url": "http://localhost:8000/document-elements?page=1",
"from": 1,
"last_page": 5,
"last_page_url": "http://localhost:8000/document-elements?page=5",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://localhost:8000/document-elements?page=1",
"label": "1",
"active": true
},
{"url": "http://localhost:8000/document-elements?page=2",
"label": "2",
"active": false
},
{"url": "http://localhost:8000/document-elements?page=3",
"label": "3",
"active": false
},
{"url": "http://localhost:8000/document-elements?page=4",
"label": "4",
"active": false
},
{"url": "http://localhost:8000/document-elements?page=5",
"label": "5",
"active": false
},
{"url": "http://localhost:8000/document-elements?page=2",
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://localhost:8000/document-elements",
"per_page": 20,
"prev_page_url": null,
"to": 20,
"total": 87,
"data": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"value": "Texto ejemplo",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z"
}
]
}
}

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

201
400

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"value": "Texto ejemplo",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z"
}
}

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

200
404

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"value": "Texto ejemplo",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z"
}
}

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

Payload

Content type

application/json

{"template_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"value": "Texto ejemplo"
}

Response samples

200
404

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"value": "Texto ejemplo",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z"
}
}

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

200
404

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

200

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"first_page_url": "http://localhost:8000/document-events?page=1",
"from": 1,
"last_page": 5,
"last_page_url": "http://localhost:8000/document-events?page=5",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://localhost:8000/document-events?page=1",
"label": "1",
"active": true
},
{"url": "http://localhost:8000/document-events?page=2",
"label": "2",
"active": false
},
{"url": "http://localhost:8000/document-events?page=3",
"label": "3",
"active": false
},
{"url": "http://localhost:8000/document-events?page=4",
"label": "4",
"active": false
},
{"url": "http://localhost:8000/document-events?page=5",
"label": "5",
"active": false
},
{"url": "http://localhost:8000/document-events?page=2",
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://localhost:8000/document-events",
"per_page": 20,
"prev_page_url": null,
"to": 20,
"total": 87,
"data": [{"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"
}
]
}
}

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

200
400

Content type

application/json

{"success": true,
"result": {"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"
}
}

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

200
404

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

Payload

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

200
400
404

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

200
404

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

200
400

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Documento ejemplo",
"send_email": false,
"autosigning": false,
"callback_url": "http://example.com",
"expires_in": 15,
"from_file": false,
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z",
"last_generated_at": "2021-02-26T01:06:59.000000Z",
"signed_at": null,
"fiel_sign_started_at": "2021-02-26T01:06:59.000000Z",
"fiel_doc_hash": "string",
"asn1_base64": "string",
"sha256": "string"
}
}

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

Payload

Content type

application/json

{"signers": [{"name": "Juan Perez",
"email": "test@test.com",
"country": "MX",
"state": "Ciudad de México",
"locality": "Xochimilco",
"organization": "Comp_Test",
"is_fiel_signature": false,
"password": "123456",
"include_name_in_signature": false,
"expires_in": 15,
"external_person_id": null,
"meta_signs": [{"page": 1,
"is_default": false,
"top": 20,
"left": 20,
"width": 50,
"height": 20
}
]
}
]
}

Response samples

200
400

Content type

application/json

{"success": true,
"result": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z",
"token": "126|O0mzWkpVauNj6kXy3HFBvwa7mJnfDAqKZCF4sCFL",
"expiration_date": "2021-04-07T15:14:19.000000Z"
}
]
}

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

200
404

Content type

application/json

{"success": true,
"result": {"match": true,
"hash": "f65cf09147392b539fd7fb12d6d8c2b6ffd3f403166e577bcfa04ec9fe0aadde",
"timestamp_info": "signer cert serial number: 2A\r\nsigner cert issuer: L=Alvaro Obregon,ST=Ciudad de Mexico,C=MX,PostalCode=01030,STREET=Insurgentes Sur 1940\\, Col. Florida,CN=Autoridad Certificadora Raiz Segunda de Secretaria de Economia,OU=Direccion General de Normatividad Mercantil,O=Secretaria de Economia,E=acr2se@economia.gob.mx\r\ngenTime: 2021-08-24T21:28:57Z\r\ncertificates count: 1\r\nall certificates: EMAILADDRESS=acedicommx@edicomgroup.com, O=Edicomunicaciones Mexico S.A. de C.V., OU=TSA, CN=TSAEDICOMMX, STREET=Avda. Paseo de la Reforma 483 Pisos 25-27 Cuauhtemoc, OID.2.5.4.17=06500, C=MX, ST=Ciudad de Mexico, L=Cuauhtemoc; SKI=c2c859d69b38a1c13aa1bdab038e60bb32300210\r\nembedded certificate: EMAILADDRESS=acedicommx@edicomgroup.com, O=Edicomunicaciones Mexico S.A. de C.V., OU=TSA, CN=TSAEDICOMMX, STREET=Avda. Paseo de la Reforma 483 Pisos 25-27 Cuauhtemoc, OID.2.5.4.17=06500, C=MX, ST=Ciudad de Mexico, L=Cuauhtemoc; SKI=c2c859d69b38a1c13aa1bdab038e60bb32300210\r\nadding to certificate chain: EMAILADDRESS=acedicommx@edicomgroup.com, O=Edicomunicaciones Mexico S.A. de C.V., OU=TSA, CN=TSAEDICOMMX, STREET=Avda. Paseo de la Reforma 483 Pisos 25-27 Cuauhtemoc, OID.2.5.4.17=06500, C=MX, ST=Ciudad de Mexico, L=Cuauhtemoc\r\n1.2.840.113549.1.9.4=<Set oid='1.2.840.113549.1.9.4' name='pkcs9_messageDigest'></Set>\r\n1.2.840.113549.1.9.3=<Set oid='1.2.840.113549.1.9.3' name='pkcs9_contentType'></Set>\r\n1.2.840.113549.1.9.52=<Set oid='1.2.840.113549.1.9.52'></Set>\r\n1.2.840.113549.1.9.5=<Set oid='1.2.840.113549.1.9.5' name='pkcs9_signingTime'></Set>\r\n1.2.840.113549.1.9.16.2.47=<Set oid='1.2.840.113549.1.9.16.2.47' name='id_aa_signingCertificateV2'></Set>\r\n",
"document": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Documento ejemplo",
"send_email": false,
"autosigning": false,
"callback_url": "http://example.com",
"expires_in": 15,
"from_file": false,
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z",
"last_generated_at": "2021-02-26T01:06:59.000000Z",
"signed_at": null,
"fiel_sign_started_at": "2021-02-26T01:06:59.000000Z",
"fiel_doc_hash": "string",
"asn1_base64": "string",
"sha256": "string"
}
}
}

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

200
400
404

Content type

application/json

{"success": true,
"result": {"document_url": "https://signt-platform-storage.s3.us-west-2.amazonaws.com/36/Caratula-16-marzo.pdf?response-content-type=application%2Foctet-stream&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLXdlc3QtMiJHMEUCIG%2Bpoy2pJzlOR%2FZv3gxPAliR24keVQo%2BLAGpv6H1jSs7AiEAmeEmkSVZ2IK4rYBf6rIfEnOsEXXzDZVb0%2FQj70oQ%2Bpoq2gEIMhABGgwwMDE4OTU1NjA3NTkiDD%2BEpbp%2BPi8C1l7ftCq3ASAJ33pCCMEKu%2FnMaFE66YLK5vEIUGeHu2KAo2Gyj8QELB4PKc7dm%2BRXVl407jpFpwVvvvqioh86Mwg0GphoTkPiguEQwXMMI1Z1ZzOu93ozLWg0h2YfcF8b4qU3rRbR5Un0WehwfjCThzJXRFoFfcvFhKzLswBDR3D9LGowokJb0x7hOcK9bGTmBz2A0MtknXliffuIstawdkR%2BWjD2pM69hBPpbWmFU82uObuX%2Fc7qwOvkXIzGbDDQ28iCBjrhAVVyL517jKJ4zpMFwY%2BXgeREpWmCiHeVyktsav%2F9A69CoORunRtQmTP1OrpMU3%2BOev7y875JqlgsgGra4ozecQYhrRcu1l59El1vIWQ%2FeGHq%2BaieTV2LLoDcdXxM%2F72S2daShR%2FeWcydKUxbIRqmrwYhDHXWUjCPFRYqmTn1SgKEn6EKlOjdwWEXAml1eF4ufkIaGte1rX%2Bo%2FKMegtZ9gI0cb%2BotnPvGpovmzRhKaN%2FTnP6OPVkiooeC94xsWA6jF2fZG9ZHiSZL6HrtVV0sCSezVDLy1nBx7ik%2Bo0HycEt3kQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAQA4H36Y3RAUEDLOH%2F20210317%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20210317T183753Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Signature=5ce29670aede42e0925adfa22747ac63ac2142d46a4a345f4c3e9822a425e2fc",
"asn1_base64": "MIIOTjADAgEAMIIORQYJKoZIhvcNAQcCoIIONjCCDjICAQMxDzANBglghkgBZQMEAgEFADCCAZ0GCyqGSIb3DQEJEAEEoIIBjASCAYgwggGEAgEBBg5gg2RlCoI8AgQBAgEBADAxMA0GCWCGSAFlAwQCAQUABCDL/nUHR5a/NXAMwSTA0xXb1SUe1dgBjp4/0piO3aCm6QIIXaNFucr/l38YDzIwMjEwODI0MjEyODU3WjAEgAIB9AIEb4J7t6CCAROkggEPMIIBCzEpMCcGCSqGSIb3DQEJARYaYWNlZGljb21teEBlZGljb21ncm91cC5jb20xLjAsBgNVBAoMJUVkaWNvbXVuaWNhY2lvbmVzIE1leGljbyBTLkEuIGRlIEMuVi4xDDAKBgNVBAsMA1RTQTEUMBIGA1UEAwwLVFNBRURJQ09NTVgxPTA7BgNVBAkMNEF2ZGEuIFBhc2VvIGRlIGxhIFJlZm9ybWEgNDgzIFBpc29zIDI1LTI3IEN1YXVodGVtb2MxDjAMBgNVBBETBTA2NTAwMQswCQYDVQQGEwJNWDEZMBcGA1UECAwQQ2l1ZGFkIGRlIE1leGljbzETMBEGA1UEBwwKQ3VhdWh0ZW1vY6CCCCYwgggiMIIGCqADAgECAgEqMA0GCSqGSIb3DQEBCwUAMIIBRTEXMBUGA1UEBxMOQWx2YXJvIE9icmVnb24xGTAXBgNVBAgTEENpdWRhZCBkZSBNZXhpY28xCzAJBgNVBAYTAk1YMQ4wDAYDVQQREwUwMTAzMDErMCkGA1UECRMiSW5zdXJnZW50ZXMgU3VyIDE5NDAsIENvbC4gRmxvcmlkYTFHMEUGA1UEAxM+QXV0b3JpZGFkIENlcnRpZmljYWRvcmEgUmFpeiBTZWd1bmRhIGRlIFNlY3JldGFyaWEgZGUgRWNvbm9taWExNDAyBgNVBAsTK0RpcmVjY2lvbiBHZW5lcmFsIGRlIE5vcm1hdGl2aWRhZCBNZXJjYW50aWwxHzAdBgNVBAoTFlNlY3JldGFyaWEgZGUgRWNvbm9taWExJTAjBgkqhkiG9w0BCQEWFmFjcjJzZUBlY29ub21pYS5nb2IubXgwHhcNMTcwNzE5MDAwMDAwWhcNMjkwNzE5MDAwMDAwWjCCAQsxEzARBgNVBAcTCkN1YXVodGVtb2MxGTAXBgNVBAgTEENpdWRhZCBkZSBNZXhpY28xCzAJBgNVBAYTAk1YMQ4wDAYDVQQREwUwNjUwMDE9MDsGA1UECRM0QXZkYS4gUGFzZW8gZGUgbGEgUmVmb3JtYSA0ODMgUGlzb3MgMjUtMjcgQ3VhdWh0ZW1vYzEUMBIGA1UEAxMLVFNBRURJQ09NTVgxDDAKBgNVBAsTA1RTQTEuMCwGA1UEChMlRWRpY29tdW5pY2FjaW9uZXMgTWV4aWNvIFMuQS4gZGUgQy5WLjEpMCcGCSqGSIb3DQEJARYaYWNlZGljb21teEBlZGljb21ncm91cC5jb20wggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDQ6yDMNi2cCZVayeaD0nQKyNTJe5OeMzg9QSx0IeniTTzbwyn17xscEOFidtSWdFNoPCjKkYGIdiMgqciMqrX9w9sbig0KsHNvx49yds3Dg6fGNNIfYy+KCMGpVZQGqPNI6ol72fync2lpa0Qdwc9fX5BTJ5YemrifPLd7GtyXOrAHOvYi+cllZs39Gkz08eafVz6jjFrAZPQoSVdDcONqRjh96NvfYiiWnmP078LkBADJ+BFk0Sdvqc3s0i1x6SwYXXwGOmzcAiXDBMDnDRhr9jfK2njTooDNEosG6J5mXEC/corssX5KHpvSFFbYMeI/l8exHp3I6TsfqsEWf2C8Y4LSeQEXKH//G2kwnZxAUj2eJhpGq0hBUnFobiJXnA6WAqo48KxrS0A8sXpqElPsM4ZSGU3TDXh06Ckns26Bni4B642ZF2sSCjDbVbKkzV8zQAKDkUPtdsfqiOthXmaKAJqYCQHibIrHQNQ5pkZkN46wTk5jx4SfDp4qd/IES8fj7imH3oMm21Mi5UzPpprFIwSweVRc4H0PG0oW2F0MWixrFyEFDemel4fzNhgbzYEUb4PsOqU/E0IM0cVn4iyszpNGD9RninKDnPsKpIYub+FnFF8iN9FYU+oiFjFJQicYB0KEg8Hz3lUQ8y9uibjKxrZ/ROE6Obkm+R2Q7NAgNwIDAQABo4IBUTCCAU0wHwYDVR0jBBgwFoAUEIEpKsESDXLNNYK1IVhZbvegSgYwHQYDVR0OBBYEFMLIWdabOKHBOqG9qwOOYLsyMAIQMD0GCCsGAQUFBwEBBDEwLzAtBggrBgEFBQcwAYYhaHR0cDovL29jc3AuZWNvbm9taWEuZ29iLm14OjgwODIvMEAGA1UdHwQ5MDcwNaAzoDGGL2h0dHBzOi8vd3d3LmFjcjJzZS5lY29ub21pYS5nb2IubXgvZWNvbm9taWEuY3JsMFEGA1UdIARKMEgwRgYJYINkZQqCPAoBMDkwNwYIKwYBBQUHAgEWK2h0dHBzOi8vd3d3LmFjcjJzZS5lY29ub21pYS5nb2IubXgvY3BzLmh0bWwwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwDwYDVR0TAQH/BAUwAwIBADAOBgNVHQ8BAf8EBAMCA+gwDQYJKoZIhvcNAQELBQADggIBAD9H7JOu2ViJ9M0hfLw9KBx7TKCJnlVaaCaJ/hAJC2XuZBjOP1JZ2+zZEYLOW/PqX5nFKM4LuKjQ4jkS89kqUWPT05NdKGScFRxKXkUkv0y/skyjXOl0HXxJIx4j+oP0Y3zLx8H5uiYSVSNl9oCqCHA2jCxMK9R1wRacG//MgoNamcnLY252co+JzwHLUjd0Mje0wE2PVDfJZUJBfPLkDirmnMtI0pFk6DA0I3QMQ7glvF5E3tLtMA/v5egQi05bVVrFxjFz1tmr1kCe40l4CmFGijA5Ye3c80CCiU6v0fdYCyTs3fQB45njd7u0nMQvc9XOIVNH3vjAALFc63lv0tL8cehCCBrhbadfJkayQsXOsnJiCHapZK+mzGB7169ilqNa35+XdnptFBO7xuEnkga59MxwguqVPs/RjePt4BgEzuP/0hgJPJtNCn2RK6h3TfK0/OwxF980xAPUQF8yZ4WcPN9KrcKkhZa7Fgej9rcD90VVGEROJ9C9yqi5S4M2ZQF3DHPX1YjnCier5cnQbNZWLo4j8p6ZFbnq3DsRtgDK3GDXLHIaFiGhWuPqlet2jjc9TwF2VIu6EL8EZ8K9Tu+fDqXXnQeg1spfODq6+PcyFD3AojDrhMlknmhuzZxkNQwuFrLQoka7mdTvgPBphJUJc8l0BY9sobrNJzJyy7T/MYIETzCCBEsCAQEwggFMMIIBRTEXMBUGA1UEBxMOQWx2YXJvIE9icmVnb24xGTAXBgNVBAgTEENpdWRhZCBkZSBNZXhpY28xCzAJBgNVBAYTAk1YMQ4wDAYDVQQREwUwMTAzMDErMCkGA1UECRMiSW5zdXJnZW50ZXMgU3VyIDE5NDAsIENvbC4gRmxvcmlkYTFHMEUGA1UEAxM+QXV0b3JpZGFkIENlcnRpZmljYWRvcmEgUmFpeiBTZWd1bmRhIGRlIFNlY3JldGFyaWEgZGUgRWNvbm9taWExNDAyBgNVBAsTK0RpcmVjY2lvbiBHZW5lcmFsIGRlIE5vcm1hdGl2aWRhZCBNZXJjYW50aWwxHzAdBgNVBAoTFlNlY3JldGFyaWEgZGUgRWNvbm9taWExJTAjBgkqhkiG9w0BCQEWFmFjcjJzZUBlY29ub21pYS5nb2IubXgCASowDQYJYIZIAWUDBAIBBQCggdMwGgYJKoZIhvcNAQkDMQ0GCyqGSIb3DQEJEAEEMBwGCSqGSIb3DQEJBTEPFw0yMTA4MjQyMTI4NTdaMC0GCSqGSIb3DQEJNDEgMB4wDQYJYIZIAWUDBAIBBQChDQYJKoZIhvcNAQELBQAwLwYJKoZIhvcNAQkEMSIEIHPxsMgHoCDXdi4AI/S4UlUNOS2AAJsMdCn9zNY+fMmPMDcGCyqGSIb3DQEJEAIvMSgwJjAkMCIEIINpfkuYKAs69giW6OG4XHFNJ6kzfgjsXq17VZzlL0NxMA0GCSqGSIb3DQEBCwUABIICACXO4JTlcaZcbxOd23Lf66bE63dshpCxzJ3zNUvc9u1kpWui4ObPdYhWdxbWuoEGGmsQZi2P8/acNWnu824+240b5G1M0/npgB8jr6uWa9LmhENms53IroHq5UC589T1wSAV28JjsDHVnQ+jfqJF7x+LxLcc5uUcwLWuQJVc468EHxM1bE/tEacc50q3QtclBolYQNWQHn8U29Won0iTQXBnSiUn4nAXjv+BP+lvOD2RFtSMRriaEAA/WVNfRwKLy0oz5UXldxpVfKuKx2xoT0h/Bk8TZBgDGMb3e9P28gOcglpMefd1L59XzL6VLwSP05EysK1uF/YJ5xoNkmLlB6JgfhS4OEojO9GAvlpdFEPsRMzMjcEv1G0f7VRGB16I1KEQLMO20aXamsp9Vl0Gqbtq1yYOGcMq44xosPgjOxo0G53PTu5QH+Qy1lzymOE1hH/BqsaxJwonGkfaiMDx7u5vCy1DAao/ssTOvLhUU5Gktj4lfjB/2N2xSyoxg+LZ27/g5+T8ZW6yMmdlK/SOpyJoA6362g59nBHcPN7LxbDIaJjABjcs5qsL5tSqHym9vDf4cvn6xxnYB9K6t7SfoVvbu6E1tkRl66kWem7SKPo6jYYCiwxdfU09z0Ub8vIzKGjiZKTJZK3WAY2Hh050yrInqDEb84gPrtuseE07y6l8"
}
}

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

200
400
404

Content type

application/json

{"success": true,
"result": {"document_url": "https://signt-platform-storage.s3.us-west-2.amazonaws.com/36/Caratula-16-marzo.pdf?response-content-type=application%2Foctet-stream&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLXdlc3QtMiJHMEUCIG%2Bpoy2pJzlOR%2FZv3gxPAliR24keVQo%2BLAGpv6H1jSs7AiEAmeEmkSVZ2IK4rYBf6rIfEnOsEXXzDZVb0%2FQj70oQ%2Bpoq2gEIMhABGgwwMDE4OTU1NjA3NTkiDD%2BEpbp%2BPi8C1l7ftCq3ASAJ33pCCMEKu%2FnMaFE66YLK5vEIUGeHu2KAo2Gyj8QELB4PKc7dm%2BRXVl407jpFpwVvvvqioh86Mwg0GphoTkPiguEQwXMMI1Z1ZzOu93ozLWg0h2YfcF8b4qU3rRbR5Un0WehwfjCThzJXRFoFfcvFhKzLswBDR3D9LGowokJb0x7hOcK9bGTmBz2A0MtknXliffuIstawdkR%2BWjD2pM69hBPpbWmFU82uObuX%2Fc7qwOvkXIzGbDDQ28iCBjrhAVVyL517jKJ4zpMFwY%2BXgeREpWmCiHeVyktsav%2F9A69CoORunRtQmTP1OrpMU3%2BOev7y875JqlgsgGra4ozecQYhrRcu1l59El1vIWQ%2FeGHq%2BaieTV2LLoDcdXxM%2F72S2daShR%2FeWcydKUxbIRqmrwYhDHXWUjCPFRYqmTn1SgKEn6EKlOjdwWEXAml1eF4ufkIaGte1rX%2Bo%2FKMegtZ9gI0cb%2BotnPvGpovmzRhKaN%2FTnP6OPVkiooeC94xsWA6jF2fZG9ZHiSZL6HrtVV0sCSezVDLy1nBx7ik%2Bo0HycEt3kQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAQA4H36Y3RAUEDLOH%2F20210317%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20210317T183753Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Signature=5ce29670aede42e0925adfa22747ac63ac2142d46a4a345f4c3e9822a425e2fc"
}
}

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

200
400

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z",
"signed_at": "2021-04-07T15:14:19.000000Z",
"person_id": "51456456-a4a0-4497-a3c9-ebdbdaca0159",
"external_person_id": null,
"include_name_in_signature": false,
"expires_in": 15,
"metadata": null,
"is_fiel_signature": false,
"is_permanent": false
}
}

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

200
400

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z",
"signed_at": "2021-04-07T15:14:19.000000Z",
"person_id": "51456456-a4a0-4497-a3c9-ebdbdaca0159",
"external_person_id": null,
"include_name_in_signature": false,
"expires_in": 15,
"metadata": null,
"is_fiel_signature": false,
"is_permanent": false
}
}

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

200
404

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"first_page_url": "http://localhost:8000/signers?page=1",
"from": 1,
"last_page": 5,
"last_page_url": "http://localhost:8000/signers?page=5",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://localhost:8000/signers?page=1",
"label": "1",
"active": true
},
{"url": "http://localhost:8000/signers?page=2",
"label": "2",
"active": false
},
{"url": "http://localhost:8000/signers?page=3",
"label": "3",
"active": false
},
{"url": "http://localhost:8000/signers?page=4",
"label": "4",
"active": false
},
{"url": "http://localhost:8000/signers?page=5",
"label": "5",
"active": false
},
{"url": "http://localhost:8000/signers?page=2",
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://localhost:8000/signers",
"per_page": 20,
"prev_page_url": null,
"to": 20,
"total": 87,
"data": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z",
"signed_at": "2021-04-07T15:14:19.000000Z",
"person_id": "51456456-a4a0-4497-a3c9-ebdbdaca0159",
"external_person_id": null,
"include_name_in_signature": false,
"expires_in": 15,
"metadata": null,
"is_fiel_signature": false,
"is_permanent": false,
"fillable_elements": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"signer_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"document_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"filled_at": "2021-08-04T15:14:56.000000Z",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z"
}
]
}
]
}
}

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
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

Payload

Content type

application/json

{"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"password": "12345",
"expires_in": 15,
"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": ["51319186-a4a0-4497-a3c9-ebdbdaca0159",
"78932121-c7b0-4497-c9c4-abdfcaca9874"
]
}

Response samples

201
400

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z",
"signed_at": "2021-04-07T15:14:19.000000Z",
"person_id": "51456456-a4a0-4497-a3c9-ebdbdaca0159",
"external_person_id": null,
"include_name_in_signature": false,
"expires_in": 15,
"metadata": null,
"is_fiel_signature": false,
"is_permanent": false,
"fillable_elements": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"signer_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"document_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"filled_at": "2021-08-04T15:14:56.000000Z",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z"
}
]
}
}

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

200

Content type

application/json

{"success": true,
"result": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z",
"signed_at": "2021-04-07T15:14:19.000000Z",
"person_id": "51456456-a4a0-4497-a3c9-ebdbdaca0159",
"external_person_id": null,
"include_name_in_signature": false,
"expires_in": 15,
"metadata": null,
"is_fiel_signature": false,
"is_permanent": false,
"document": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Documento ejemplo",
"send_email": false,
"autosigning": false,
"callback_url": "http://example.com",
"expires_in": 15,
"from_file": false,
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z",
"last_generated_at": "2021-02-26T01:06:59.000000Z",
"signed_at": null,
"fiel_sign_started_at": "2021-02-26T01:06:59.000000Z",
"fiel_doc_hash": "string",
"asn1_base64": "string",
"sha256": "string"
}
}
]
}

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

200

Content type

application/json

{"success": true,
"result": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z",
"signed_at": "2021-04-07T15:14:19.000000Z",
"person_id": "51456456-a4a0-4497-a3c9-ebdbdaca0159",
"external_person_id": null,
"include_name_in_signature": false,
"expires_in": 15,
"metadata": null,
"is_fiel_signature": false,
"is_permanent": false,
"document": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Documento ejemplo",
"send_email": false,
"autosigning": false,
"callback_url": "http://example.com",
"expires_in": 15,
"from_file": false,
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z",
"last_generated_at": "2021-02-26T01:06:59.000000Z",
"signed_at": null,
"fiel_sign_started_at": "2021-02-26T01:06:59.000000Z",
"fiel_doc_hash": "string",
"asn1_base64": "string",
"sha256": "string"
}
}
]
}

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

200
404

Content type

application/json

{"success": true,
"result": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z",
"signed_at": "2021-04-07T15:14:19.000000Z",
"person_id": "51456456-a4a0-4497-a3c9-ebdbdaca0159",
"external_person_id": null,
"include_name_in_signature": false,
"expires_in": 15,
"metadata": null,
"is_fiel_signature": false,
"is_permanent": false,
"document": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Documento ejemplo",
"send_email": false,
"autosigning": false,
"callback_url": "http://example.com",
"expires_in": 15,
"from_file": false,
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z",
"last_generated_at": "2021-02-26T01:06:59.000000Z",
"signed_at": null,
"fiel_sign_started_at": "2021-02-26T01:06:59.000000Z",
"fiel_doc_hash": "string",
"asn1_base64": "string",
"sha256": "string"
}
}
]
}

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

Responses

Request samples

Payload

Content type

application/json

{"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"expires_in": 15
}

Response samples

200
400
404

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z",
"signed_at": "2021-04-07T15:14:19.000000Z",
"person_id": "51456456-a4a0-4497-a3c9-ebdbdaca0159",
"external_person_id": null,
"include_name_in_signature": false,
"expires_in": 15,
"metadata": null,
"is_fiel_signature": false,
"is_permanent": false
}
}

Elimina un firmante

Authorizations:

apiKeyAuth

path Parameters

id

required

string

Example: 51319186-a4a0-4497-a3c9-ebdbdaca0159

El ID del firmante

Responses

Response samples

200
404

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

200
404

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"first_page_url": "http://localhost:8000/signers/51319186-a4a0-4497-a3c9-ebdbdaca0159/documents?page=1",
"from": 1,
"last_page": 5,
"last_page_url": "http://localhost:8000/signers/51319186-a4a0-4497-a3c9-ebdbdaca0159/documents?page=5",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://localhost:8000/signers/51319186-a4a0-4497-a3c9-ebdbdaca0159/documents?page=1",
"label": "1",
"active": true
},
{"url": "http://localhost:8000/signers/51319186-a4a0-4497-a3c9-ebdbdaca0159/documents?page=2",
"label": "2",
"active": false
},
{"url": "http://localhost:8000/signers/51319186-a4a0-4497-a3c9-ebdbdaca0159/documents?page=3",
"label": "3",
"active": false
},
{"url": "http://localhost:8000/signers/51319186-a4a0-4497-a3c9-ebdbdaca0159/documents?page=4",
"label": "4",
"active": false
},
{"url": "http://localhost:8000/signers/51319186-a4a0-4497-a3c9-ebdbdaca0159/documents?page=5",
"label": "5",
"active": false
},
{"url": "http://localhost:8000/signers/51319186-a4a0-4497-a3c9-ebdbdaca0159/documents?page=2",
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://localhost:8000/signers/51319186-a4a0-4497-a3c9-ebdbdaca0159/documents",
"per_page": 20,
"prev_page_url": null,
"to": 20,
"total": 87,
"data": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Documento ejemplo",
"send_email": false,
"autosigning": false,
"callback_url": "http://example.com",
"expires_in": 15,
"from_file": false,
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z",
"last_generated_at": "2021-02-26T01:06:59.000000Z",
"signed_at": null,
"fiel_sign_started_at": "2021-02-26T01:06:59.000000Z",
"fiel_doc_hash": "string",
"asn1_base64": "string",
"sha256": "string"
}
]
}
}

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

200
404

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z",
"signed_at": "2021-04-07T15:14:19.000000Z",
"person_id": "51456456-a4a0-4497-a3c9-ebdbdaca0159",
"external_person_id": null,
"include_name_in_signature": false,
"expires_in": 15,
"metadata": null,
"is_fiel_signature": false,
"is_permanent": false,
"token": "125|Nghx5nhUndSnCjQVQqNd4iKeTfaxbg86mBpSktKS",
"expiration_token": "2021-08-04T15:14:56.000000Z",
"fillable_elements": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"signer_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"document_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"filled_at": "2021-08-04T15:14:56.000000Z",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z"
}
]
}
}

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

200
400

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z",
"signed_at": "2021-04-07T15:14:19.000000Z",
"person_id": "51456456-a4a0-4497-a3c9-ebdbdaca0159",
"external_person_id": null,
"include_name_in_signature": false,
"expires_in": 15,
"metadata": null,
"is_fiel_signature": false,
"is_permanent": false
}
}

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

200
400

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z",
"signed_at": "2021-04-07T15:14:19.000000Z",
"person_id": "51456456-a4a0-4497-a3c9-ebdbdaca0159",
"external_person_id": null,
"include_name_in_signature": false,
"expires_in": 15,
"metadata": null,
"is_fiel_signature": false,
"is_permanent": false
}
}

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

200

Content type

application/json

{"success": true,
"result": {"current_page": 1,
"first_page_url": "http://localhost:8000/external?page=1",
"from": 1,
"last_page": 5,
"last_page_url": "http://localhost:8000/external?page=5",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
},
{"url": "http://localhost:8000/external?page=1",
"label": "1",
"active": true
},
{"url": "http://localhost:8000/external?page=2",
"label": "2",
"active": false
},
{"url": "http://localhost:8000/external?page=3",
"label": "3",
"active": false
},
{"url": "http://localhost:8000/external?page=4",
"label": "4",
"active": false
},
{"url": "http://localhost:8000/external?page=5",
"label": "5",
"active": false
},
{"url": "http://localhost:8000/external?page=2",
"label": "Next &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://localhost:8000/external",
"per_page": 20,
"prev_page_url": null,
"to": 20,
"total": 87,
"data": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"filename": "Contrato_prueba.pdf",
"sha256": "65f45505a560f8aefbfc0ac31ffcddab1183b144b607df41c7b3c3424c05d4e9",
"asn1_base64": "string",
"metadata": null,
"signed_at": "2021-07-29T18:29:05.000000Z",
"created_at": "2021-07-29T18:29:03.000000Z",
"updated_at": "2021-07-29T18:29:05.000000Z"
}
]
}
}

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

400

Content type

application/json

{"success": false,
"error": {"file": ["The file field is required"
]
}
}

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

Payload

Content type

application/json

{"sha256": "stringstringstringstringstringstringstringstringstringstringstri",
"filename": "string"
}

Response samples

200
400

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"filename": "Contrato_prueba.pdf",
"sha256": "65f45505a560f8aefbfc0ac31ffcddab1183b144b607df41c7b3c3424c05d4e9",
"asn1_base64": "string",
"metadata": null,
"signed_at": "2021-07-29T18:29:05.000000Z",
"created_at": "2021-07-29T18:29:03.000000Z",
"updated_at": "2021-07-29T18:29:05.000000Z"
}
}

Obtener un documento correspondiente al sha256

Authorizations:

apiKeyAuth

path Parameters

sha256

required

string

Example: 65f45505a560f8aefbfc0ac31ffcddab1183b144b607df41c7b3c3424c05d4e9

Hash sha256 del archivo PDF

Responses

Response samples

200
404

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"filename": "Contrato_prueba.pdf",
"sha256": "65f45505a560f8aefbfc0ac31ffcddab1183b144b607df41c7b3c3424c05d4e9",
"asn1_base64": "string",
"metadata": null,
"signed_at": "2021-07-29T18:29:05.000000Z",
"created_at": "2021-07-29T18:29:03.000000Z",
"updated_at": "2021-07-29T18:29:05.000000Z"
}
}

Borra un documento correspondiente al sha256

Authorizations:

apiKeyAuth

path Parameters

sha256

required

string

Example: 65f45505a560f8aefbfc0ac31ffcddab1183b144b607df41c7b3c3424c05d4e9

Hash sha256 del archivo PDF

Responses

Response samples

200
404

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

200
404

Content type

application/json

{"success": true,
"result": {"match": true,
"document_hash": "65f45505a560f8aefbfc0ac31ffcddab1183b144b607df41c7b3c3424c05d4e9",
"document": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"filename": "Contrato_prueba.pdf",
"sha256": "65f45505a560f8aefbfc0ac31ffcddab1183b144b607df41c7b3c3424c05d4e9",
"asn1_base64": "string",
"metadata": null,
"signed_at": "2021-07-29T18:29:05.000000Z",
"created_at": "2021-07-29T18:29:03.000000Z",
"updated_at": "2021-07-29T18:29:05.000000Z"
}
}
}

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

200
404

Content type

application/json

{"success": true,
"result": {"valid": true,
"hash": "f65cf09147392b539fd7fb12d6d8c2b6ffd3f403166e577bcfa04ec9fe0aadde",
"timestamp_info": "signer cert serial number: 2A\r\nsigner cert issuer: L=Alvaro Obregon,ST=Ciudad de Mexico,C=MX,PostalCode=01030,STREET=Insurgentes Sur 1940\\, Col. Florida,CN=Autoridad Certificadora Raiz Segunda de Secretaria de Economia,OU=Direccion General de Normatividad Mercantil,O=Secretaria de Economia,E=acr2se@economia.gob.mx\r\ngenTime: 2021-08-24T21:28:57Z\r\ncertificates count: 1\r\nall certificates: EMAILADDRESS=acedicommx@edicomgroup.com, O=Edicomunicaciones Mexico S.A. de C.V., OU=TSA, CN=TSAEDICOMMX, STREET=Avda. Paseo de la Reforma 483 Pisos 25-27 Cuauhtemoc, OID.2.5.4.17=06500, C=MX, ST=Ciudad de Mexico, L=Cuauhtemoc; SKI=c2c859d69b38a1c13aa1bdab038e60bb32300210\r\nembedded certificate: EMAILADDRESS=acedicommx@edicomgroup.com, O=Edicomunicaciones Mexico S.A. de C.V., OU=TSA, CN=TSAEDICOMMX, STREET=Avda. Paseo de la Reforma 483 Pisos 25-27 Cuauhtemoc, OID.2.5.4.17=06500, C=MX, ST=Ciudad de Mexico, L=Cuauhtemoc; SKI=c2c859d69b38a1c13aa1bdab038e60bb32300210\r\nadding to certificate chain: EMAILADDRESS=acedicommx@edicomgroup.com, O=Edicomunicaciones Mexico S.A. de C.V., OU=TSA, CN=TSAEDICOMMX, STREET=Avda. Paseo de la Reforma 483 Pisos 25-27 Cuauhtemoc, OID.2.5.4.17=06500, C=MX, ST=Ciudad de Mexico, L=Cuauhtemoc\r\n1.2.840.113549.1.9.4=<Set oid='1.2.840.113549.1.9.4' name='pkcs9_messageDigest'></Set>\r\n1.2.840.113549.1.9.3=<Set oid='1.2.840.113549.1.9.3' name='pkcs9_contentType'></Set>\r\n1.2.840.113549.1.9.52=<Set oid='1.2.840.113549.1.9.52'></Set>\r\n1.2.840.113549.1.9.5=<Set oid='1.2.840.113549.1.9.5' name='pkcs9_signingTime'></Set>\r\n1.2.840.113549.1.9.16.2.47=<Set oid='1.2.840.113549.1.9.16.2.47' name='id_aa_signingCertificateV2'></Set>\r\n",
"document": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"filename": "Contrato_prueba.pdf",
"sha256": "65f45505a560f8aefbfc0ac31ffcddab1183b144b607df41c7b3c3424c05d4e9",
"asn1_base64": "string",
"metadata": null,
"signed_at": "2021-07-29T18:29:05.000000Z",
"created_at": "2021-07-29T18:29:03.000000Z",
"updated_at": "2021-07-29T18:29:05.000000Z"
}
}
}

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

201
403

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

200
400
403

Content type

application/json

{"success": true,
"result": "Ok"
}

Construir un preview del PDF

Authorizations:

bearerAuthPublicSigner

Responses

Response samples

403

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

200
403

Content type

application/json

{"success": true,
"result": "Ok"
}

Obtiene la información del documento para el firmante

Authorizations:

bearerAuthPublicSigner

Responses

Response samples

200
403

Content type

application/json

{"success": true,
"result": {"document": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Documento ejemplo",
"send_email": false,
"autosigning": false,
"callback_url": "http://example.com",
"expires_in": 15,
"from_file": false,
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z",
"last_generated_at": "2021-02-26T01:06:59.000000Z",
"signed_at": null,
"fiel_sign_started_at": "2021-02-26T01:06:59.000000Z",
"fiel_doc_hash": "string",
"asn1_base64": "string",
"sha256": "string"
},
"sign_elements": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"signer_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"document_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"filled_at": "2021-08-04T15:14:56.000000Z",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z"
}
]
}
}

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

Payload

Content type

application/json

{"urls": ["http://example.com/image.jpg"
],
"paths": ["/path/to/file.jpg"
],
"collection": "ine"
}

Response samples

200
400
403

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

Payload

Content type

application/json

{"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"password": "12345",
"country": "MX",
"state": "México City",
"locality": "Iztapalapa",
"organization": "rem-tools",
"external_person_id": "1a3sd51fsd32g1sdg5",
"expires_in": 15,
"metadata": null,
"elements": ["51319186-a4a0-4497-a3c9-ebdbdaca0159",
"78932121-c7b0-4497-c9c4-abdfcaca9874"
]
}

Response samples

200
400
403

Content type

application/json

{"success": true,
"result": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z",
"signed_at": "2021-04-07T15:14:19.000000Z",
"person_id": "51456456-a4a0-4497-a3c9-ebdbdaca0159",
"external_person_id": null,
"include_name_in_signature": false,
"expires_in": 15,
"metadata": null,
"is_fiel_signature": false,
"is_permanent": false,
"fillable_elements": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"signer_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"document_element_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"filled_at": "2021-08-04T15:14:56.000000Z",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z"
}
]
}
}

Construir un preview del PDF

Authorizations:

bearerAuthPublicDoc

Responses

Response samples

403

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

Payload

Content type

application/json

{"resource": "Document",
"event": "Finish",
"resource_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"payload": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"template_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Documento ejemplo",
"send_email": false,
"autosigning": false,
"callback_url": "http://example.com",
"expires_in": 15,
"from_file": false,
"created_at": "2021-02-26T01:06:59.000000Z",
"updated_at": "2021-02-26T01:06:59.000000Z",
"last_generated_at": "2021-02-26T01:06:59.000000Z",
"signed_at": null,
"fiel_sign_started_at": "2021-02-26T01:06:59.000000Z",
"fiel_doc_hash": "string",
"asn1_base64": "string",
"sha256": "string",
"document_url": "https://signt-platform-storage.s3.us-west-2.amazonaws.com/36/Caratula-16-marzo.pdf?response-content-type=application%2Foctet-stream&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLXdlc3QtMiJHMEUCIG%2Bpoy2pJzlOR%2FZv3gxPAliR24keVQo%2BLAGpv6H1jSs7AiEAmeEmkSVZ2IK4rYBf6rIfEnOsEXXzDZVb0%2FQj70oQ%2Bpoq2gEIMhABGgwwMDE4OTU1NjA3NTkiDD%2BEpbp%2BPi8C1l7ftCq3ASAJ33pCCMEKu%2FnMaFE66YLK5vEIUGeHu2KAo2Gyj8QELB4PKc7dm%2BRXVl407jpFpwVvvvqioh86Mwg0GphoTkPiguEQwXMMI1Z1ZzOu93ozLWg0h2YfcF8b4qU3rRbR5Un0WehwfjCThzJXRFoFfcvFhKzLswBDR3D9LGowokJb0x7hOcK9bGTmBz2A0MtknXliffuIstawdkR%2BWjD2pM69hBPpbWmFU82uObuX%2Fc7qwOvkXIzGbDDQ28iCBjrhAVVyL517jKJ4zpMFwY%2BXgeREpWmCiHeVyktsav%2F9A69CoORunRtQmTP1OrpMU3%2BOev7y875JqlgsgGra4ozecQYhrRcu1l59El1vIWQ%2FeGHq%2BaieTV2LLoDcdXxM%2F72S2daShR%2FeWcydKUxbIRqmrwYhDHXWUjCPFRYqmTn1SgKEn6EKlOjdwWEXAml1eF4ufkIaGte1rX%2Bo%2FKMegtZ9gI0cb%2BotnPvGpovmzRhKaN%2FTnP6OPVkiooeC94xsWA6jF2fZG9ZHiSZL6HrtVV0sCSezVDLy1nBx7ik%2Bo0HycEt3kQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAQA4H36Y3RAUEDLOH%2F20210317%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20210317T183753Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Signature=5ce29670aede42e0925adfa22747ac63ac2142d46a4a345f4c3e9822a425e2fc",
"signers": [{"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z",
"signed_at": "2021-04-07T15:14:19.000000Z",
"person_id": "51456456-a4a0-4497-a3c9-ebdbdaca0159",
"external_person_id": null,
"include_name_in_signature": false,
"expires_in": 15,
"metadata": null,
"is_fiel_signature": false,
"is_permanent": false
}
],
"template": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Test",
"description": "Template test",
"pages": 5,
"created_at": "2021-03-10T00:09:30.000000Z",
"updated_at": "2021-03-10T00:09:30.000000Z"
}
}
}

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

Payload

Content type

application/json

{"resource": "Signer",
"event": "Sign",
"resource_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"payload": {"id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"name": "Noe Chavez",
"email": "noechavez@rem.tools",
"document_id": "51319186-a4a0-4497-a3c9-ebdbdaca0159",
"created_at": "2021-04-07T15:14:19.000000Z",
"updated_at": "2021-04-07T15:14:19.000000Z",
"signed_at": "2021-04-07T15:14:19.000000Z",
"person_id": "51456456-a4a0-4497-a3c9-ebdbdaca0159",
"external_person_id": null,
"include_name_in_signature": false,
"expires_in": 15,
"metadata": null,
"is_fiel_signature": false,
"is_permanent": false
}
}