AucoFace
Para cada estado del documento, se genera una petición con el siguiente cuerpo, variando en la descripción del estado (status).
Estados notificados
Nombre | Descripción |
---|---|
CREATE | Este estado se notifica cuando se crea un documento o se carga un PDF a la plataforma. |
FINISH | Este estado se notifica cuando todas las partes firmaron el documento. |
NOTIFICATION | Este estado se notificará cuando un participante del documento ha realizado el proceso de firma. |
REJECT | Este estado se notifica cuando al menos un firmante ha rechazado la firma del documento. |
REJECTED | Este evento muestra el detalle de la cancelación del proceso. |
BLOCKED | Este estado es notificado cuando uno de los firmantes a excedido el número de intentos de validación de identidad (3) y requiere de una validación manual. |
EXPIRED | Este estado se notificará cuando el documento haya expirado, solo si tiene fecha de expiración; esta fecha es definida en la creación del mismo. |
🧪 Ejemplos de notificaciones
tip
Puedes copiar cualquiera de los ejemplos según el lenguaje de tu preferencia.
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|---|---|
code | String | Código del documento. |
name | String | Nombre del documento. |
signer | String | Información del firmante, presente únicamente cuando el estado es NOTIFICATION , BLOCKED o REJECTED . |
url | String | url del documento. |
status | String | stado actual del proceso de firma (ej. SIGNED , REJECTED , BLOCKED , etc.) |
message | String | Contenido textual asociado al estado del firmante. Si el estado es REJECTED , contiene el mensaje individual escrito por el participante. En caso de BLOCKED , vea lista de estados de bloqueo. |
tags | Array | Lista de etiquetas asignadas al documento, si fueron definidas durante su creación. |
custom | Array | Lista de campos personalizados registrados en el documento, si fueron especificados. |
Creación de proceso
- JSON
{
"code": "DOCUMENTCODE",
"name": "Contrato de prueba del API",
"status": "CREATE",
"url": "https://test.auco.ai/contrato-de-prueba-id-98-DOCUMENTCODE.pdf"
}
Finalización del proceso
- JSON
{
"code": "DOCUMENTCODE",
"name": "Contrato de prueba del API",
"status": "FINISH",
"url": "https://test.auco.ai/contrato-de-prueba-id-98-DOCUMENTCODE.pdf"
}
Bloqueo de firmante
- JSON
{
"name": "document name",
"signer": {
"id": "participan_id",
"name": "participant name",
"email": "email",
"phone": "phone"
},
"status": "REJECTED",
"message": "OTP_CODE_INVALID",
"tags": ["document tag"],
"custom": ["{'info':'required', 'definition': 'urgent'}"]
}
Detalle de rechazo
- JSON
{
"name": "document name",
"signer": {
"id": "participan_id",
"name": "participant name",
"email": "email",
"phone": "phone"
},
"status": "REJECTED",
"message": "message",
"tags": ["document tags"]
}
Expiración de proceso
- JSON
{
"code": "DOCUMENTCODE",
"name": "Contrato de prueba del API",
"status": "EXPIRED",
"url": "https://test.auco.ai/contrato-de-prueba-id-98-DOCUMENTCODE.pdf",
"tags": ["document tag"],
"custom": ["{'info':'required', 'definition': 'urgent'}"]
}