HomeGuíasAPI ReferenceChangelog
Log In
API Reference

Crear Document

Crea un Document a partir de un archivo en Base64 y devuelve la URL en la que el firmante completa la ceremonia de firma.

Se usa para iniciar el flujo de firma. El archivo se envía al proveedor, el Document queda en estado pending y los cambios de estado posteriores se notifican mediante los webhooks document.* (document.signed, document.canceled, document.failed) que luego se envían al endpoint de webhooks configurado por la organización. Una vez recibido document.signed, el documento firmado se descarga con GET /document/{document_id}/signed-url.

Con entity el Document queda asociado a esa entidad y el nombre del Customer asociado se usa como nombre del firmante. Con data el archivo se procesa como plantilla DOCX y sus campos se reemplazan al generar el documento; sin data se procesa como PDF.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Datos para crear un Document y generar su enlace de firma.

string
enum

Constancia de conservación a solicitar al proveedor.

Allowed:
auth_data
object

Metadatos propios que se guardan junto al documento en el proveedor. Máximo 9 pares; cada clave hasta 100 caracteres y cada valor hasta 1000.

data
object

Valores con los que se rellena el documento cuando es una plantilla DOCX. Al enviarlo, el archivo se procesa como DOCX en vez de PDF. Serializado no puede superar los 50000 caracteres. A los valores enviados se agregan siempre current_day (día del mes, 1 a 31), current_month (nombre del mes en minúscula, en el idioma del país de la organización: español o portugués) y current_year (año en 4 dígitos), con la fecha del día en la zona horaria de la organización, de modo que la plantilla no tenga que traer la fecha fija; si se envía alguno de esos nombres, prevalece el valor enviado.

string
required

Documento a firmar, codificado en Base64. Su texto debe incluir el marcador [[sign_here]], que indica dónde se ubica la firma del firmante.

entity
object

Entidad de Toku a asociar al Document. Su Customer aporta el nombre del firmante.

string

Idioma de la ceremonia de firma. Único valor soportado: es, que también es el valor por defecto.

places
array of objects

Campos adicionales que el firmante debe completar, además de la firma.

Places
string

Correo del firmante. Si se envía, el proveedor le hace llegar la invitación a firmar por correo; si se omite, el enlace de firma se entrega solo en la respuesta.

uri
required
length between 1 and 2083

URL a la que se redirige al firmante al terminar la ceremonia de firma.

string

Título del documento en la ceremonia de firma. Si se omite, se usa «Documento de firma electrónica».

Headers
string

Llave de API de una Account, para operar sobre esa Account en lugar de la principal.

Responses

401

La organización no tiene habilitada la firma electrónica.

403

La API key no se envió, no es válida o la organización está desactivada.

404

La entidad indicada en entity no existe.

422

El payload no es válido: document no es Base64, entity.type o language no están soportados, o algún campo incumple sus límites.

500

No se pudo crear el Document. Reintentar más tarde.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json