Saltar al contenido principal

Paquete de documentos

Para cada estado del paquete de documentos, se genera una petición con el siguiente cuerpo, variando en la descripción del estado (status).


Estados notificados

NombreDescripción
CREATEEste estado se notifica cuando se crea un paquete de documentos.
FINISHEste estado se notifica cuando todas las partes firmaron el paquete de documentos.

🧪 Ejemplos de notificaciones

tip

Puedes copiar cualquiera de los ejemplos según el lenguaje de tu preferencia.

Parámetros de notificación

NombreTipoDescripción
packageStringCódigo del documento.
nameStringNombre del documento.
statusStringstado actual del proceso de firma (ej. SIGNED, REJECTED, BLOCKED, etc.)
documentsStringLista de documentos que hacen parte del paquete.
documents.urlStringurl del documento.
documents.codeStringCódigo del documento
documents.nameArrayNombre del documento.

Creación de proceso

{
"package": "idPAckage", //Identificador del paquete
"name": "Documentos de prueba del API", //Nombre del paquete de documentos
"status": "CREATE", //Estado del paquete de documentos
"documents": [
{
"code": "DOCUMENTCODE",
"name": "Documento de prueba 1",
"url": "https://test.auco.ai/contrato-de-prueba1.pdf"
},
{
"code": "DOCUMENTCODE",
"name": "Documento de prueba 2",
"url": "https://test.auco.ai/contrato-de-prueba2.pdf"
}
]
}

Finalización del proceso

{
"package": "idPAckage",
"name": "Documentos de prueba del API",
"status": "FINISH",
"documents": [
{
"code": "DOCUMENTCODE",
"name": "Documento de prueba 1",
"url": "https://test.auco.ai/contrato-de-prueba1.pdf"
},
{
"code": "DOCUMENTCODE",
"name": "Documento de prueba 2",
"url": "https://test.auco.ai/contrato-de-prueba2.pdf"
}
]
}