Primeros pasos

                API Endpoint

                https://contractualis.com/app/dev/v1/
            

La API de Contractualis proporciona acceso programático para usar los servicios de la plataforma web de Contractualis directamente en tu sistema.

Permite iniciar sesión, enviar documentos, agregar firmantes, obtener saldo de tokens, conocer el status de un documento y más.

Para usar esta API, tu necesitas un API key. Unicamente Inicia sesión en tu cuenta Contractualis y ve a Ajustes -> API para activar y obtener tu API KEY.

Recuerda que la opción API debe estar marcada para poder hacer uso de ella, tu cuenta debe ser cuenta principal y estar vigente.

La información que envies en las solicitudes deberá de ir en formato JSON, de igual manera las respuestas obtenidas estarán en el mismo formato.

Inicio de sesión

                
                    # Aqui un ejemplo CURL
                    curl -X POST https://contractualis.com/app/dev/v1/users/login \
                    -H "Content-Type: application/json" \
                    -H "x-api-key: [APIKEY]"
                    -d '{
                        "email": "tu-correo@dominio.com",
                        "password": "tu-contraseña"
                    }'
                
            

Para obtener un JWT o JSON Web Token necesitas iniciar sesión, un JWT es necesario en cada solicitud que realices a nuestra API.

/users/login

HEADERS

x-api-key: [APIKEY]

                
                    Ejemplo de salida :

                    {
                        "status_code": "200",
                        "status_msg": "",
                        "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
                    }

                
            

PARÁMETROS DE CONSULTA

Campo	Tipo	Descripción
email	String	Tu correo electrónico en Contractualis
password	String	Tu contraseña en Contractualis

RESPUESTA

Campo	Tipo	Descripción
status_code	String	Codigo de respuesta
status_msg	String	Mensaje de respuesta
jwt	String	JSON Web Token

Obtener Tokens

                
                    # Aqui un ejemplo CURL
                    curl -X POST https://contractualis.com/app/dev/v1/users/tokens \
                    -H "Content-Type: application/json" \
                    -H "Authorization: Bearer [JWT]" \
                    -H "x-api-key: [APIKEY]"
                    -d '{
                        "email": "tu-correo@dominio.com"
                    }'
                
            

Este método permite obtener la cantidad de tokens disponibles en tu cuenta

/users/tokens

HEADERS

Authorization: Bearer [JWT], x-api-key: [APIKEY]

                
                    Ejemplo de salida :

                    {
                        "status_code": "200",
                        "status_msg": "",
                        "tokens": "50"
                    }

                
            

PARÁMETROS DE CONSULTA

Campo	Tipo	Descripción
email	String	Tu correo electrónico en Contractualis

RESPUESTA

Campo	Tipo	Descripción
status_code	String	Codigo de respuesta
status_msg	String	Mensaje de respuesta
tokens	String	Tokens disponibles

Obtener subcuentas

                
                    # Aqui un ejemplo CURL
                    curl -X POST https://contractualis.com/app/dev/v1/users/get-subaccounts \
                    -H "Content-Type: application/json" \
                    -H "Authorization: Bearer [JWT]" \
                    -H "x-api-key: [APIKEY]"
                    -d '{
                        "email": "tu-correo@dominio.com"
                    }'
                
            

Este método permite obtener todas las subcuentas activas en su cuenta, tanto las subcuentas tipo Operador como las subcuentas tipo Supervisor.

/users/get-subaccounts

HEADERS

Authorization: Bearer [JWT], x-api-key: [APIKEY]

                
                    Ejemplo de salida :

                    {
                        "status_code": 200,
                        "status_msg": "",
                        "records": [
                            {
                                "id": "f3ofd84jdl1dj3k3l..",
                                "email": "usuario@email.com",
                                "type": "supervisor",
                                "name": "Nombre de cuenta",
                                "firstname": "Apellido de cuenta",
                                "lastname": "Apellido de cuenta"
                            },
                            ..
                        ]
                    }

                
            

PARÁMETROS DE CONSULTA

Campo	Tipo	Descripción
email	String	Tu correo electrónico en Contractualis

RESPUESTA

Campo	Tipo	Descripción
status_code	String	Codigo de respuesta
status_msg	String	Mensaje de respuesta
records	String	Una lista de subcuentas existentes y activas de la cuenta principal.

Agregar firmante guardado

                
                    # Aqui un ejemplo CURL
                    curl -X POST https://contractualis.com/app/dev/v1/documents/add-saved-signer \
                    -H "Content-Type: application/json" \
                    -H "Authorization: Bearer [JWT]" \
                    -H "x-api-key: [APIKEY]"
                    -d '{
                        "email": "tu-correo@dominio.com",
                        "name": "nombre del firmante",
                        "signer_email": "correo@dominio.com",
                        "signature": "imagen de firma digital en formato base64",
                        "whatsapp": "numero de whatsapp del firmante",
                        "selfie": "imagen de selfie de firmante",
                        "identification_front": "imagen de identificacion de frente",
                        "identification_reverse": "imagen de identificacion de reverso"
                    }'
                
            

Este método permite agregar un firmante preguardado a tu cuenta para que este disponible para elegir a la hora de crear un documento, el firmante preguardado plasma su firma automaticamente en el documento.

/documents/add-saved-signer

HEADERS

Authorization: Bearer [JWT], x-api-key: [APIKEY]

                
                    Ejemplo de salida :

                    {
                        "status_code": 200,
                        "status_msg": "",
                        "id": "vTHAnCDTwnboYW6+umfbv..."
                    }

                
            

PARÁMETROS DE CONSULTA

Campo	Tipo	Descripción
email	String	Tu correo electrónico en Contractualis
name	String	El nombre completo del firmante
signer_email	String	El correo electrónico del firmante
signature	String	La imagen de firma digital del firmante en formato base64, debe contener "data:image/png;base64,"
whatsapp	String	El número de Whatsapp del firmante a 10 digitos (Opcional)
selfie	String	La imagen de selfie del firmante en formato base64, solo para VID (Opcional)
identification_front	String	La imagen de un documento de identificación del firmante en formato base64, solo para VID (Opcional)
identification_reverse	String	La imagen de un documento de identificación del firmante en formato base64, solo para VID (Opcional)

RESPUESTA

Campo	Tipo	Descripción
status_code	String	Codigo de respuesta
status_msg	String	Mensaje de respuesta
id	String	Identificador de firmante preguardado

Obtener firmantes guardados

                
                    # Aqui un ejemplo CURL
                    curl -X POST https://contractualis.com/app/dev/v1/documents/get-saved-signers \
                    -H "Content-Type: application/json" \
                    -H "Authorization: Bearer [JWT]" \
                    -H "x-api-key: [APIKEY]"
                    -d '{
                        "email": "tu-correo@dominio.com"
                    }'
                
            

Este método permite obtener los firmantes preguardados de tu cuenta.

/documents/get-saved-signers

HEADERS

Authorization: Bearer [JWT], x-api-key: [APIKEY]

                
                    Ejemplo de salida :

                    {
                        "status_code": "200",
                        "status_msg": "",
                        "records": [
                            {
                                "id": "0sboLAh+Zl/f5Eb2tiX7ElpLdUbzQjVrakltQmVYV3..",
                                "name": "Juan Perez",
                                "email": "emailsigner1@correo.com"
                            },
                            {
                                "id": "II/ATEXN0BNW+uzULj34wXhtUDZLRExRY1QyMDJJT5..",
                                "name": "Aldo Mata",
                                "email": "emailsigner2@correo.com"
                            }...
                    }

                
            

PARÁMETROS DE CONSULTA

Campo	Tipo	Descripción
email	String	Tu correo electrónico en Contractualis

RESPUESTA

Campo	Tipo	Descripción
status_code	String	Codigo de respuesta
status_msg	String	Mensaje de respuesta
records	String	Lista de firmantes preguardados en la cuenta

Generar sello de tiempo

                
                    # Aqui un ejemplo CURL
                    curl -X POST https://contractualis.com/app/dev/v1/documents/generate-timestamp \
                    -H "Content-Type: application/json" \
                    -H "Authorization: Bearer [JWT]" \
                    -H "x-api-key: [APIKEY]"
                    -d '{
                        "email": "tu-correo@dominio.com",
                        "lang": "idioma del documento",
                        "name": "nombre del documento",
                        "file": "archivo pdf en base64, ej: data:application/pdf;base64,JVBER..",
                        "attachments": "lista de archivos pdf en base64,
                                ejemplo: 
                                "attachments": [
                                    {
                                        "filename": "file1.pdf",
                                        "data": "data:application/pdf;base64,lV.."
                                    },
                                    {
                                        "filename": "file2.pdf",
                                        "data": "data:application/pdf;base64,lV.."
                                    },	
                                ]",
                        "subaccount": "id de subcuenta (opcional)"
                    }'
                
            

Este método permite generar el proceso completo de un sello de tiempo, puedes enviar un archivo, anexos y el sistema lo mezclará en un solo archivo y lo certificará automáticamente.

/documents/generate-timestamp

HEADERS

Authorization: Bearer [JWT], x-api-key: [APIKEY]

                
                    Ejemplo de salida :

                    {
                        "status_code": 200,
                        "status_msg": "",
                        "id": "0daa2ef20851fc88f444c4h3ec0e1c-17477832.."
                    }

                
            

PARÁMETROS DE CONSULTA

Campo	Tipo	Descripción
email	String	Tu correo electrónico en Contractualis
lang	String	Idioma del documento generado
name	String	Nombre del documento
file	String	Archivo en formato PDF en base64, debe contener "data:application/pdf;base64,"
attachments	String	Uno o varios archivos pdf que se anexarán al documento principal, debe ser una cadena JSON, ej: "attachments": [{"filename": "file1.pdf","data": "data:application/pdf;base64,lV.."},{"filename": "file2.pdf","data": "data:application/pdf;base64,lV.."},] (Opcional)
subaccount	String	Identificador de subcuenta, el registro aparecerá en dicha subcuenta, obtener identificadores de subcuentas con /users/get-subaccounts (Opcional)

RESPUESTA

Campo	Tipo	Descripción
status_code	String	Codigo de respuesta
status_msg	String	Mensaje de respuesta
id	String	Identificador de documento creado

Crear documento

                
                    # Aqui un ejemplo CURL
                    curl -X POST https://contractualis.com/app/dev/v1/documents/create-document \
                    -H "Content-Type: application/json" \
                    -H "Authorization: Bearer [JWT]" \
                    -H "x-api-key: [APIKEY]"
                    -d '{
                        "email": "tu-correo@dominio.com",
                        "lang": "idioma del documento",
                        "name": "nombre del documento",
                        "file": "archivo pdf en base64, ej: data:application/pdf;base64,JVBER..",
                        "typedocument": "contract",
                        "subaccount": "id de subcuenta (opcional)"
                    }'
                
            

Este método permite crear un documento en status borrador subiendo unicamente el documento principal, este método no finaliza un documento completamente.

/documents/create-document

HEADERS

Authorization: Bearer [JWT], x-api-key: [APIKEY]

                
                    Ejemplo de salida :

                    {
                        "status_code": 200,
                        "status_msg": "",
                        "id": "0daa2ef20851fc88f444c4d3ec0e1c-17477832.."
                    }

                
            

PARÁMETROS DE CONSULTA

Campo	Tipo	Descripción
email	String	Tu correo electrónico en Contractualis
lang	String	Idioma del documento generado
name	String	Nombre del documento
file	String	Archivo en formato PDF en base64, debe contener "data:application/pdf;base64,"
typedocument	String	Tipo de documento a crear, por el momento solo 'contract'
subaccount	String	Identificador de subcuenta, el registro aparecerá en dicha subcuenta, obtener identificadores de subcuentas con /users/get-subaccounts (Opcional)

RESPUESTA

Campo	Tipo	Descripción
status_code	String	Codigo de respuesta
status_msg	String	Mensaje de respuesta
id	String	Identificador de documento creado

Generar Documento

                
                    # Aqui un ejemplo CURL
                    curl -X POST https://contractualis.com/app/dev/v1/documents/generate-document \
                    -H "Content-Type: application/json" \
                    -H "Authorization: Bearer [JWT]" \
                    -H "x-api-key: [APIKEY]"
                    -d '{
                        "email": "tu-correo@dominio.com",
                        "lang": "idioma del documento",
                        "name": "nombre del documento",
                        "type": "contract"
                        "signers": "lista de firmantes en json,
                                ejemplo:
                                "signers": [
                                    {
                                        "email": "usuario@email.com",
                                        "name": "Nombre de firmante",
                                        "whatsappcode": "52",
                                        "whatsapp": "1234567890",
                                        "verificationid": 0,
                                        "signtype": 0
                                    },
                                    {
                                        "idsavedsigner": "e4PQNyt3iR1bY+uEznQDbk..",
                                        "email": "usuario2@email.com"
                                    }        
                                ]
                                ",
                        "file": "archivo pdf en base64, ej: data:application/pdf;base64,JVBER..",
                        "attachments": "lista de archivos pdf en base64,
                                ejemplo: 
                                "attachments": [
                                    {
                                        "filename": "file1.pdf",
                                        "data": "data:application/pdf;base64,lV.."
                                    },
                                    {
                                        "filename": "file2.pdf",
                                        "data": "data:application/pdf;base64,lV.."
                                    },	
                                ]",
                        "subaccount": "id de subcuenta (opcional)"
                    }'
                
            

Este método permite generar el proceso completo de un documento, ya sea contrato o documento, puedes enviar un archivo, anexos, una lista de firmantes y el sistema lo mezclará en un solo archivo y lo mandará a firma a los firmantes, si solo es firmado por firmantes preguardados lo enviará a blockchain automáticamente.

/documents/generate-document

HEADERS

Authorization: Bearer [JWT], x-api-key: [APIKEY]

                
                    Ejemplo de salida :

                    {
                        "status_code": 200,
                        "status_msg": "The document was created and the signers was notified.",
                        "id": "aebe3b4940a7bc81-1748.."
                    }

                
            

PARÁMETROS DE CONSULTA

Campo	Tipo	Descripción
email	String	Tu correo electrónico en Contractualis
lang	String	Idioma del documento generado
name	String	Nombre del documento
type	String	Tipo del documento, puede ser tipo 'contract' o tipo 'document'
signers	String	Lista de firmantes en formato JSON, puedes enviar 2 tipos de firmantes: nuevos firmantes o firmantes preguardados, ej: "signers": [{"email": "usuario@email.com","name": "Nombre de firmante", "whatsappcode": "52","whatsapp": "1234567890","verificationid": 0,"signtype": 0},{"idsavedsigner": "e4PQNyt3iR1bY+uEznQDbk..","email": "usuario2@email.com"}] verificationid se refiere a si se requiere solicitar verificación de identidad (0=no,1=si) signtype se refiere a cual tipo de firma permite utilizar al firmante (0=cualquiera,1=autografa,2=sat) idsavedsigner para el caso de enviar firmante preguardado, se requiere el id del firmante guardado, se obtiene identificador en /documents/get-saved-signers
file	String	Archivo en formato PDF en base64, debe contener "data:application/pdf;base64,"
attachments	String	Uno o varios archivos pdf que se anexarán al documento principal, debe ser una cadena JSON, ej: "attachments": [{"filename": "file1.pdf","data": "data:application/pdf;base64,lV.."},{"filename": "file2.pdf","data": "data:application/pdf;base64,lV.."},] (Opcional)
subaccount	String	Identificador de subcuenta, el registro aparecerá en dicha subcuenta, obtener identificadores de subcuentas con /users/get-subaccounts (Opcional)

RESPUESTA

Campo	Tipo	Descripción
status_code	String	Codigo de respuesta
status_msg	String	Mensaje de respuesta
id	String	Identificador de documento creado

Obtener documentos listos

                
                    # Aqui un ejemplo CURL
                    curl -X POST https://contractualis.com/app/dev/v1/documents/get-ready-documents \
                    -H "Content-Type: application/json" \
                    -H "Authorization: Bearer [JWT]" \
                    -H "x-api-key: [APIKEY]"
                    -d '{
                        "email": "tu-correo@dominio.com"
                    }'
                
            

Este método permite obtener los documentos en borrador que ya se encuentran firmados por todos y que están listos para ser enviados a blockchain, si te quedaste sin tokens y necesitas conocer los registros que quedaron firmados pero no enviados deberás utilizar este método.

/documents/get-ready-documents

HEADERS

Authorization: Bearer [JWT], x-api-key: [APIKEY]

                
                    Ejemplo de salida :

                    {
                        "status_code": 200,
                        "status_msg": "",
                        "records": [
                            {
                                "id": "GWpqI50r3+Relpofi3d232dzOXV0VHY3SnZrYzZLMS9I...",
                                "tokentime": "e5709553b0ff9j1sd1ddf1c733b90f-1748...",
                                "creator": "correo@dominio.com",
                                "name": "Nombre del documento"
                            }
                        ]
                    }

                
            

PARÁMETROS DE CONSULTA

Campo	Tipo	Descripción
email	String	Tu correo electrónico en Contractualis

RESPUESTA

Campo	Tipo	Descripción
status_code	String	Codigo de respuesta
status_msg	String	Mensaje de respuesta
records	String	Lista de registros firmados y listos para finalizar

Finalizar documento listo

                
                    # Aqui un ejemplo CURL
                    curl -X POST https://contractualis.com/app/dev/v1/documents/finish-ready-document \
                    -H "Content-Type: application/json" \
                    -H "Authorization: Bearer [JWT]" \
                    -H "x-api-key: [APIKEY]"
                    -d '{
                        "email": "tu-correo@dominio.com",
                        "id": "identificador del documento"
                    }'
                
            

Este método permite finalizar un documento en borrador que ya esta firmado y listo para enviar a Blockchain, si te quedaste sin tokens y necesitas finalizar un registro utiliza este método.

/documents/finish-ready-document

HEADERS

Authorization: Bearer [JWT], x-api-key: [APIKEY]

                
                    Ejemplo de salida :

                    {
                        "status_code": 200,
                        "status_msg": "",
                        "id": "e5709553b03f081ghfgrwdf1c733b90f-17483123..."
                    }

                
            

PARÁMETROS DE CONSULTA

Campo	Tipo	Descripción
email	String	Tu correo electrónico en Contractualis
id	String	Identificador del documento

RESPUESTA

Campo	Tipo	Descripción
status_code	String	Codigo de respuesta
status_msg	String	Mensaje de respuesta
id	String	Identificador de documento enviado

Eliminar borrador

                
                    # Aqui un ejemplo CURL
                    curl -X POST https://contractualis.com/app/dev/v1/documents/delete-draft \
                    -H "Content-Type: application/json" \
                    -H "Authorization: Bearer [JWT]" \
                    -H "x-api-key: [APIKEY]"
                    -d '{
                        "email": "tu-correo@dominio.com",
                        "id": "identificador del documento"
                    }'
                
            

Este método permite eliminar un documento en status borrador.

/documents/delete-draft

HEADERS

Authorization: Bearer [JWT], x-api-key: [APIKEY]

                
                    Ejemplo de salida :

                    {
                        {
                            "status_code": 200,
                            "status_msg": "The document was successfully deleted"
                        }
                    }

                
            

PARÁMETROS DE CONSULTA

Campo	Tipo	Descripción
email	String	Tu correo electrónico en Contractualis
id	String	Identificador del documento

RESPUESTA

Campo	Tipo	Descripción
status_code	String	Codigo de respuesta
status_msg	String	Mensaje de respuesta

Obtener documentos

                
                    # Aqui un ejemplo CURL
                    curl -X POST https://contractualis.com/app/dev/v1/documents/get-documents \
                    -H "Content-Type: application/json" \
                    -H "Authorization: Bearer [JWT]" \
                    -H "x-api-key: [APIKEY]"
                    -d '{
                        "email": "tu-correo@dominio.com"
                    }'
                
            

Este método permite obtener los documentos que se han enviado a blockchain y estan pendientes o completados.

/documents/get-documents

HEADERS

Authorization: Bearer [JWT], x-api-key: [APIKEY]

                
                    Ejemplo de salida :

                    {
                        "status_code": 200,
                        "status_msg": "",
                        "records": [
                            {
                                "id": "NHGGLKHUEX/NgllkexQCMdEEwYlBp54ps98d5f4dMvajhzc3ZmUkE9PQ==",
                                "tokentime": "e5702jk49d2kd1ddf1c733b90f-174554681",
                                "documentname": "Contrato de trabajo",
                                "status": "Pendiente",
                                "creationdate": "2025-05-27 09:17:33"
                            },
                            {
                                "id": "wqPNSJ1F2xLZdwimTrZpVVCYTFwRH5f21pdofd2G2pxNWHHhU3c9PQ==",
                                "tokentime": "e5709553flfo39df21c733b90f-154894564612",
                                "documentname": "Contrato de arrendamiento",
                                "status": "Completado",
                                "creationdate": "2025-05-26 21:18:34"
                            }
                        ]
                    }

                
            

PARÁMETROS DE CONSULTA

Campo	Tipo	Descripción
email	String	Tu correo electrónico en Contractualis

RESPUESTA

Campo	Tipo	Descripción
status_code	String	Codigo de respuesta
status_msg	String	Mensaje de respuesta
records	String	Lista de documentos

Obtener detalle documento

                
                    # Aqui un ejemplo CURL
                    curl -X POST https://contractualis.com/app/dev/v1/documents/get-details-document \
                    -H "Content-Type: application/json" \
                    -H "Authorization: Bearer [JWT]" \
                    -H "x-api-key: [APIKEY]"
                    -d '{
                        "email": "tu-correo@dominio.com",
                        "id": "Pk9uMW+HjL3JLF5DR8F5LPP9QQS5F5MLXZYm5sVEh..."
                    }'
                
            

Este método permite obtener los detalles de un documento en particular

/documents/get-details-document

HEADERS

Authorization: Bearer [JWT], x-api-key: [APIKEY]

                
                    Ejemplo de salida :

                    {
                        "status_code": 200,
                        "status_msg": "",
                        "data": {
                            "iddocument": "oF7AmUOI55HJ58GL9QV41ZUWXJ6T29ZUVE9PQ==",
                            "type": "contract",
                            "step": "notifications",
                            "documentname": "Contrato de Trabajo",
                            "doc_language": "es",
                            "creationdate": "27 de May de 2025",
                            "status": "Pendiente",
                            "signers": {
                                "name": "Usuario 1",
                                "email": "email1@email.com",
                                "position": "",
                                "verificationid": 0,
                                "verificationidcompleted": 0,
                                "verificationvideoproof": 0,
                                "verificationvideoproofcompleted": 0,
                                "signtype": 0,
                                "alreadysign": true
                            },
                            {
                                "name": "Luis Garcia",
                                "email": "usuario1@email.com",
                                "position": "",
                                "verificationid": 0,
                                "verificationidcompleted": 0,
                                "verificationvideoproof": 0,
                                "verificationvideoproofcompleted": 0,
                                "signtype": 0,
                                "alreadysign": true
                            },
                            "attenders": [
                                {
                                    "name": "Usuario 1",
                                    "email": "email1@email.com",
                                    "position": "",
                                    "verificationid": 0,
                                    "verificationidcompleted": 0,
                                    "signtype": 0,
                                    "alreadysign": true
                                },
                                {
                                    "name": "Luis Garcia",
                                    "email": "usuario1@email.com",
                                    "position": "",
                                    "verificationid": 0,
                                    "verificationidcompleted": 0,
                                    "signtype": 0,
                                    "alreadysign": true
                                }
                            ]
                        }
                    }

                
            

PARÁMETROS DE CONSULTA

Campo	Tipo	Descripción
email	String	Tu correo electrónico en Contractualis
ID	String	Identificador del documento

RESPUESTA

Campo	Tipo	Descripción
status_code	String	Codigo de respuesta
status_msg	String	Mensaje de respuesta
data	String	Información del documento solicitado

Webhooks (Notificaciones)

                
                    # Aqui un ejemplo de notificacion document.signed
                    {
                        "event": "document.signed",
                        "timestamp": "2025-05-27T09:18:22-06:00",
                        "data": {
                            "document_id": "fj378h2ghjs0fj3jdff7dksam==",
                            "tokentime": "e57095kdl3kduaRf1ddf1c733b90f-548454895",
                            "signer": {
                                "name": "Luis Garcia",
                                "email": "luisgarcia@email.com",
                                "signed_at": "2025-05-27 09:18:11"
                            },
                            "status": "signed"
                        }
                    }

                    # Aqui un ejemplo de notificacion account.notokens
                    {
                        "event": "account.notokens",
                        "timestamp": "2025-05-27T08:45:24-06:00"
                    }

                    # Aqui un ejemplo de notificacion document.sended
                    {
                        "event": "document.sended",
                        "timestamp": "2025-05-27T09:18:21-06:00",
                        "data": {
                            "document_id": "fj378h2ghjs0fj3jdff7dksam==",
                            "document": {
                                "name": "Contrato de Trabajo",
                                "creator": "Luis Garcia",
                                "tokentime": "e57095kdl3kduaRf1ddf1c733b90f-548454895",
                            },
                            "status": "pending"
                        }
                    }

                    # Aqui un ejemplo de notificacion account.notokens
                    {
                        "event": "document.completed",
                        "timestamp": "2025-05-27T10:58:46-06:00",
                        "data": {
                            "document_id": "fj378h2ghjs0fj3jdff7dksam==",
                            "document": {
                                "name": "Contrato de Trabajo",
                                "creator": "Luis Garcia",
                                "tokentime": "e57095kdl3kduaRf1ddf1c733b90f-548454895",
                                "hash": "073e81f76eaa47489885cb48d1c8b2da7b1961...",
                                "url": "[url de documento]",
                                "nom151": "[url de constancia nom-151]",
                                "certificate": "[url de certificado contractualis]",
                                "audittrail": "[url de audit trail]"
                            },
                            "status": "completed"
                        }
                    }
                
            

Los Webhooks o notificaciones es un mecanismo en el que Contractualis puede notificarle eventos importantes en tiempo real relacionados a sus documentos creados con nosotros. Usted unicamente registra una URL en su cuenta en la sección de Ajustes - API y podrá recibir los eventos asociados a los documentos creados mediante el API.

Una vez registrada la url de su WebHook le enviaremos la información relacionada a traves de Peticiones HTTP POST lo que evita que usted tenga que estar constantemente preguntando en busca de cambios relacionados a sus documentos, lo que evita una sobrecarga de sistema en ambas partes.

HEADERS

Content-Type: application/json

REQUERIMIENTOS DE WEBHOOK

Requisito	Descripción
Certificado SSL	Debe contar con certificado de seguridad SSL, ayuda a establecer comunicaciones seguras en Internet.
Respuesta	Debe responder con codigo de respuesta 200 para reconocer la recepción del evento.
Tiempo limite	Debe responder lo más pronto posible, no realizar tareas complejas antes de enviar la respuesta.

EVENTOS

Evento	Descripción
document.signed	Se produce cuando un documento es firmado por un firmante.
document.sended	Se produce cuando un documento es enviado a blockchain, aún no esta completado.
document.completed	Se produce cuando un documento es agregado a blockchain y está completado.
account.notokens	Se produce cuando te has quedado sin tokens al intentar enviar un documento.