Credenciales
Reciba su API Key con scope integrate y la URL del entorno (sandbox o producción).
Todo lo que necesita para integrar HearthingX
Documentación oficial, arquitectura recomendada y consola API para validar cada paso del flujo. La biometría productiva es exclusivamente por WebSocket en vivo, desde cualquier plataforma.
Cómo comenzar
Documentación
Revise la guía paso a paso y pruebe cada endpoint en la consola API en vivo.
Implementación
Integre REST y WebSocket en su plataforma, o utilice el SDK web si aplica.
Validación
Ejecute el flujo completo en la consola API y conserve el ID de sesión y el resultado de la captura.
Documentación
Guía de integración paso a paso
Endpoints, ejemplos de request/response, criterios de validación y protocolo WebSocket.
Abrir →SDK
SDK TypeScript
MicrophoneCapture, HearthingxBiometricStream y HearthingxBffClient — opcional para integraciones web.
Disponible al formalizar su integración. Vea la sección SDK en la guía.
Documentación
Guía técnica completa
Flujo WebSocket, variables del contrato y especificación detallada del API.
Abrir recurso →Postman
Colección Postman
Sesión, ambiente, confirmación de enrolamiento y auditoría (REST).
Abrir recurso →Referencia
Cliente Node de referencia
Ejemplo de stream en vivo con micrófono, ClientHello, tramas y end_of_stream.
Disponible bajo solicitud a su contacto comercial HearthingX.
Demo
Demo en vivo
Experiencia de registro y verificación por voz con el mismo contrato API.
Abrir →Requisitos mínimos
- API Key con scope integrate (nunca en el navegador de sus usuarios finales).
- Backend-for-Frontend que proxifique REST y WebSocket hacia HearthingX.
- Captura PCM 16 kHz mono con layout block (Rama A + B).
- Prefonovocal con audio real del micrófono (no ceros sintéticos).
- Comprender que DENY o AUDIO_QUALITY reflejan calidad de captura, no fallo del API.
- Flujo de registro: confirmar enrolamiento tras una captura exitosa (ALLOW).
Qué puede esperar del servicio
- HearthingX garantiza contrato API y trazabilidad, no un porcentaje fijo de ALLOW.
- Puede integrar desde cualquier plataforma que respete el protocolo REST + WebSocket.
- Rechazos por eco o reverberación indican entorno o captura; son accionables en su lado.
Detalle técnico en la guía de integración.
Arquitectura recomendada
┌─────────────┐ REST/WS ┌─────────────┐ API Key ┌──────────────┐ │ Su app/web │ ───────────────► │ Su BFF │ ───────────────► │ HearthingX │ │ (sin key) │ │ (servidor) │ │ API │ └─────────────┘ └─────────────┘ └──────────────┘
Integre el contrato en la tecnología de su elección. La demo en vivo de esta plataforma ilustra una implementación web de referencia.
Valide su integración en vivo
Ejecute los pasos del flujo (conexión, sesión, ambiente y captura de voz) desde la consola integrada.