HabitantoAPI MOROSIDADAcceso con Habitanto
Habitanto para integradores

API de consulta
de morosidad

Consulta información de morosidad de manera segura y eficiente mediante nuestra API REST.

Acceso bajo solicitudVer endpoint

Integración segura · Respuesta mínima · Sin datos financieros

GET/v1/morosos

Authorization

Bearer hbt_live_••••••••••••

Query

cedula=1712345678
200 OKtrue
✓
Consulta seguraInformación autorizada
Simple por diseño

¿Qué es esta API?

Una integración sencilla para consultar si un contacto presenta deuda vencida dentro del condominio autorizado.

La respuesta se limita a un valor booleano: true o false. No expone nombres, montos, unidades ni información financiera detallada.

01Acceso controladoCada credencial está asociada a un condominio.
02Privacidad primeroSolo devuelve la información indispensable.
Integración directa

Cómo funciona

De la solicitud de acceso a tu primera consulta en cuatro pasos.

01

Solicita acceso

Cuéntanos sobre tu empresa, condominio y caso de uso.

02

Obtén tu Bearer Token

Recibe una credencial única para autenticar tus consultas.

03

Consume el endpoint

Envía la cédula o el correo mediante una solicitud GET.

04

Recibe la información

Procesa una respuesta booleana, simple y predecible.

Seguridad

Autenticación

La API utiliza autenticación mediante Bearer Token. Todas las solicitudes deben incluir la credencial en el header Authorization.

✓ Guarda el token en variables de entorno.✓ Nunca lo expongas en aplicaciones frontend.✓ Revoca de inmediato una credencial comprometida.
Header requeridoObligatorio
Authorization: Bearer {TOKEN}

Ejemplo

Authorization: Bearer hbt_live_xxxxxxxxxxxxxxxxx
Por compatibilidad, la API también admite X-API-Key.
Referencia esencial

Endpoint disponible

Todo lo necesario para realizar una consulta, en un solo lugar.

GET/v1/morosos Disponible
URL basehttps://api.habitanto.com
HeaderAuthorization: Bearer {TOKEN}
Parámetros de consulta

Debes enviar al menos cedula o correo.

cedulastring

Cédula registrada del contacto

Condicional
correostring

Correo principal o secundario

Condicional
Ejemplo requestcURL
curl --request GET \
  --url 'https://api.habitanto.com/v1/morosos?cedula=1712345678' \
  --header 'Authorization: Bearer hbt_live_xxxxxxxxxxxxxxxxx'
200 OKapplication/json
true

El contacto tiene deuda vencida.

200 OKapplication/json
false

El contacto no tiene deuda vencida o no fue encontrado.

Respuestas claras

Respuestas y errores

Códigos esenciales para manejar el resultado de cada solicitud.

200

Consulta exitosa

La respuesta contiene true o false.

400

Solicitud inválida

Falta la cédula o el correo.

401

Token inválido

Credencial ausente, inválida o revocada.

500

Error interno

No fue posible procesar la consulta.

Las respuestas exitosas contienen únicamente un booleano JSON. Los errores utilizan el formato { "message": "Descripción del error" }.

Empieza tu integración

¿Necesitas acceso?

Las credenciales de integración son gestionadas directamente por el equipo de Habitanto.

Comunícate con el equipo de HabitantoEllos te ayudarán a solicitar y gestionar el acceso.