cs-security-experience-api-services

(0 reviews)

Esta API permite la validación de identidad, gestión de OTP, generación de encuestas, manejo de tokens para portales y verificación en listas negras, todo a través de múltiples versiones que aseguran una autenticación y procesamiento de datos seguros.

🛡️cs-security-experience-api-services

Esta API ofrece servicios robustos de validación de identidad y seguridad empresarial. Incluye endpoints para:

Verificación de identidad y teléfono con múltiples proveedores
Operaciones avanzadas de Contraseña de Un Solo Uso (OTP)
Encuestas de seguridad y gestión de tokens empresariales
Integración completa con Experian, Inspektor, Fasecolda, Registraduría, Ariba, TransUnion
Evaluación de listas restrictivas y validaciones de autenticación
Firma electrónica y gestión de documentos digitales
Análisis de riesgo crediticio y financiero

Todos los servicios se exponen a través de versiones organizadas (v1, v3, v4) y proporcionan acceso seguro a validaciones de backend con alta disponibilidad y performance optimizado.

🌐 Información Base

Título de la API: cs-security-experience-api-services
Versión: 1.0.0
Plataforma: MuleSoft Anypoint Platform
URL Base Producción: https://security-experience-api-prod.us-e1.cloudhub.io/api/
URL Base QA: https://security-experience-api-qa.us-e1.cloudhub.io/api/
Protocolo: REST/SOAP
Formato de Datos: JSON/XML
Autenticación: OAuth 2.0 + Client ID

🚀 Cómo Comenzar

Autenticación: Asegúrate de tener el client_id requerido y el token Bearer OAuth 2.0 para acceso seguro.
URL Base: Usa la URL Base proporcionada como prefijo para todos los endpoints de la API.
Encabezados: Agrega los siguientes encabezados en tus solicitudes de API:-H "Content-Type: application/json"-H "client_id: TU_CLIENT_ID"-H "Authorization: Bearer TU_ACCESS_TOKEN"-H "X-Correlation-ID: TU_CORRELATION_ID" # Opcional pero recomendado para trazabilidad

Mejores Prácticas:

✅ Implementa retry con exponential backoff para manejo de errores
✅ Usa correlation IDs para trazabilidad de transacciones
✅ Valida todos los inputs antes de enviar requests
✅ Implementa logging completo de transacciones
✅ Renueva tokens cada 24 horas por seguridad

🚀 Cómo Consumir

Puedes acceder y consumir esta API a través de las siguientes plataformas:

🔗 MuleSoft Exchange (Authentication API)
🔗 Portal Público FGS

📍 Endpoints Disponibles

Método	Endpoint	Descripción
SOAP	`CheckBlsOperation`	Verificar si una persona está en listas restrictivas de lavado de activos (BLS)
POST	`/api/security/check_bls`	Validar identidad contra listas restrictivas BLS e Inspektor en tiempo real
POST	`/api/security/v1/OTP/initialize`	Inicializar proceso de autenticación con código OTP vía SMS/email
POST	`/api/security/v1/OTP/validate`	Validar código OTP ingresado por el usuario para completar autenticación
POST	`/api/security/v1/portal/generate_token`	Generar token JWT de sesión para acceso al portal web
POST	`/api/security/v1/portal/validate_token`	Verificar validez y vigencia del token JWT de sesión del portal
POST	`/api/security/v1/survey/generate`	Crear cuestionario dinámico de preguntas de seguridad personal
POST	`/api/security/v1/survey/validate`	Evaluar respuestas del cuestionario de seguridad contra base de datos
POST	`/api/customer/v1/identity/validate`	Verificar identidad del cliente mediante datos biométricos y documentos
POST	`/api/v3/security/check_bls`	Consultar listas restrictivas BLS versión 3.0 con mejoras de rendimiento
POST	`/api/security/v3/OTP/initialize`	Inicializar autenticación OTP v3.0 con soporte multi-canal
POST	`/api/v3/customer/identity/validate`	Validar identidad del cliente v3.0 con IA y reconocimiento facial
POST	`/api/security/v3/OTP/validate`	Verificar código OTP v3.0 con validación anti-fraude mejorada
POST	`/api/v3/security/portal/generate_token`	Generar token JWT v3.0 con claims extendidos y mayor seguridad
POST	`/api/v3/security/survey/generate`	Crear cuestionario inteligente v3.0 con preguntas adaptativas
POST	`/api/v3/security/survey/validate`	Evaluar respuestas del cuestionario v3.0 con scoring inteligente
POST	`/api/v3/security/portal/validate_token`	Validar token JWT v3.0 con verificación de permisos granular
POST	`/api/security/v3/authentication/business`	Autenticar usuarios empresariales con certificados digitales
POST	`/api/security/v3/authentication/supplier`	Autenticar proveedores con validación de estado comercial
POST	`/api/v4/customer/identity/portal/generate_token`	Generar token de identidad v4.0 para portal con OAuth 2.0
POST	`/api/v4/customer/identity/portal/validate_token`	Validar token de identidad v4.0 con refresh automático
GET	`/api/data-credito/HC2`	Consultar historial crediticio en DataCrédito (centrales de riesgo)
GET	`/api/fasecolda/obtainUrl`	Obtener URL de consulta vehicular en base FASECOLDA
GET	`/api/ariba/obtainPendingSuppliers`	Listar proveedores pendientes de aprobación en SAP Ariba
POST	`/api/assessment-files`	Subir y gestionar archivos de evaluación de riesgo crediticio
POST	`/api/v3/security/restrictiveList/inspektor`	Verificar personas/empresas en listas restrictivas Inspektor
POST	`/api/identity-and-phone-verification`	Verificar simultáneamente identidad y número telefónico del usuario
POST	`/api/otp-phone-selection`	Permitir al usuario seleccionar teléfono para recibir código OTP
POST	`/api/otp-pin-verification-otp-input`	Validar PIN y código OTP ingresados por el usuario
POST	`/api/obtaining-and-responding-exam`	Generar y procesar respuestas de examen de validación de identidad
POST	`/api/identity-validation-status`	Consultar estado actual del proceso de validación de identidad
GET	`/api/creditVisionOne`	Consultar score crediticio y reporte financiero en CreditVision
GET	`/api/creditValidation`	Validar capacidad crediticia y nivel de endeudamiento actual
GET	`/api/company-report`	Generar reporte completo de información comercial de empresa
POST	`/api/digital-signature`	Crear firma digital certificada para documentos oficiales GSE
GET	`/api/incomeEstimator`	Calcular estimación de ingresos basada en datos financieros

📤 Ejemplos de Uso

Ejemplo de Solicitud

curl --location 'https://security-experience-api-qa.us-e1.cloudhub.io/api/customer/v1/identity/validate' \
  -H "Authorization: Bearer {oauth_token}" \
  -H "client_id: {client_id}" \
  -H "client_secret: {client_secret}" \
  -H "Content-Type: application/json" \
  -d '{
    "IdUserEntity": "ODAwMjI2MTc1LjE=",
    "ParamProduct": "3364",
    "Product": "010",
    "Channel": "001",
    "DataValidation": {
        "Person": {
            "Identification": {
                "Number": "00000000",
                "Type": "1",
                "ExpeditionDate": "1584230400000"
            },
            "LastName": "APELLIDO",
            "FirstName": "NOMBRES"
        }
    }
  }'

⚠️ Manejo de Errores

Se utilizan códigos de estado HTTP estándar para el manejo de errores:

📊 Códigos de Respuesta

Código	Estado	Descripción	Causa Común	Acción Recomendada
`200`	✅ OK	La solicitud fue exitosa	Operación completada correctamente	Continuar con el procesamiento
`400`	❌ Bad Request	Parámetros faltantes o inválidos	Formato de datos incorrecto	Revisar estructura del JSON y campos requeridos
`401`	🔒 Unauthorized	Autenticación fallida	Token expirado o client_id inválido	Renovar token de autenticación
`403`	🚫 Forbidden	Sin permisos suficientes	Client_id sin permisos para el endpoint	Verificar permisos asignados al client_id
`404`	🔍 Not Found	Endpoint o recurso no encontrado	URL incorrecta o recurso inexistente	Verificar la URL y documentación
`429`	⏰ Rate Limited	Demasiadas solicitudes	Exceso de requests por minuto	Implementar retry con exponential backoff
`500`	💥 Internal Server Error	Error inesperado en el servidor	Fallo interno del sistema	Contactar soporte técnico con correlation ID
`503`	🛠️ Service Unavailable	Servicio temporalmente no disponible	Mantenimiento o sobrecarga	Reintentar más tarde

❓ Preguntas Frecuentes

🔑 Error 401 - Unauthorized

Síntomas: Respuesta "Authentication failed"
Causas: Token expirado, client_id incorrecto, headers malformados
Solución: Verificar y renovar credenciales, validar formato de headers

⏰ Error 504 - Gateway Timeout

Síntomas: Timeout después de 30 segundos
Causas: Servicios externos lentos, sobrecarga del sistema
Solución: Implementar timeouts más cortos, usar retry con backoff

📊 Error 429 - Rate Limiting

Síntomas: "Too Many Requests"
Causas: Exceso de requests por minuto (límite: 100/min)
Solución: Implementar queue con rate limiting, espaciar requests

📞 Soporte

Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.

Correo electrónico: epalma@fgs.co

📅 Información Adicional

Documentación mejorada y actualizada en Octubre 2025 por epalma@fgs.co - Edna Nayibe Palma

📋 Nota Importante: Esta documentación se actualiza continuamente. Para la versión más reciente y cambios en tiempo real, consulta siempre el Portal de Exchange oficial.

🔒 Aviso de Seguridad: Nunca compartas credenciales de API en repositorios públicos o documentación. Usa siempre variables de entorno para información sensible y rota tokens regularmente.

home