Skip to main content

El objeto Proyecto

Representación

{
"_id": "64a1b2c3d4e5f6789012345",
"name": "Mi Proyecto",
"description": "Proyecto de verificación KYC",
"status": "active",
"createdAt": "2023-06-01T12:34:56.000Z",
"updatedAt": "2023-07-01T10:00:00.000Z",
"flows": [
{
"_id": "f01a2b3c4d5e6f7890123456",
"name": "KYC Básico",
"status": "active"
}
],
"settings": {
"webhookUrl": "https://example.com/webhooks",
"notifications": {
"email": true,
"slack": false
}
}
}

Campos

CampoTipoDescripción
_idstringIdentificador único del proyecto
namestringNombre legible del proyecto
descriptionstringDescripción opcional del objetivo del proyecto
statusstringEstado del proyecto: active, paused, deleted
createdAtstring (ISO-8601)Fecha de creación
updatedAtstring (ISO-8601)Última actualización
flowsarrayLista de flujos asociados al proyecto
settings.webhookUrlstring (URL)URL para recibir eventos vía webhook
settings.notifications.emailbooleanHabilita notificaciones por email
settings.notifications.slackbooleanHabilita notificaciones por Slack

Notas

  • status: utiliza paused para mantenimiento temporal sin pérdida de datos.
  • flows: la lista puede omitirse en respuestas compactas; consulta el recurso de Flujos de Proyecto para detalles.
  • settings: configurable por API; valida las URLs y los dominios permitidos.