Kuenta Docs

Appearance

Obtener estado y pagos de deudor por número de identificación​

GET
/debtor-status/{id_number}

Con solo el número de identificación, devuelve todos los deudores asociados a ese documento para el acreedor
y solo las cuotas vigentes de los créditos activos (Formalized, Disbursing, Disbursed, Delinquent) con su link de pago.
No incluye historial de cuotas pagadas ni cuotas futuras.

Incluye por cada deudor:

  • Datos básicos del deudor
  • Totales agregados de sus cuotas vigentes (totalDue, totalMinPayment, totalOverdueAmount, próxima fecha si aplica)
  • Lista de cuotas vigentes (una por crédito) con monto total, mora, penalidad y link de pago

Notas funcionales:

  • minAmount siempre es 1 (pago mínimo simbólico)
  • No se devuelven cuotas futuras ni historial de pagos
  • Permisos requeridos: ReadClient

Authorizations​

bearerAuth

JWT token de autenticación. Utilice este esquema para autenticar solicitudes con un token JWT.

TypeHTTP (bearer)

Parameters​

Header Parameters

Config-Organization-ID*

ID de la organización configuradora

Typestring
Required
Example550e8400-e29b-41d4-a716-446655440000
formatuuid
Organization-ID*

ID de la organización creditor

Typestring
Required
Example660e8400-e29b-41d4-a716-446655440001
formatuuid

Path Parameters

id_number*

Número de identificación del deudor

Typestring
Required
Example1234567890
pattern^[0-9-]+$
minLength6
maxLength15

Responses​

Información de todos los deudores asociados al documento, con sus cuotas vigentes y links de pago
application/json
JSON
{
"data": {
"debtorsStatus": [
{
"debtor": {
"id": "e7e2f4c3-1c2b-4b8d-9b7a-5d8f5c9e1234",
"name": "Ana López",
"idNumber": "123456789",
"idType": "CC",
"phone": "+57300111111"
},
"totals": {
"totalDue": 250000,
"totalMinPayment": 1,
"totalOverdueAmount": 250000,
"nextDueDate": "2025-02-10",
"currency": "COP",
"currencySymbol": "$"
},
"installments": [
{
"creditId": "3c1e2cdd-bc6c-4b5e-98d2-7f4f4a8f1234",
"creditReference": "REF-001",
"creditStatus": "debt",
"productName": "Crédito de Consumo",
"currency": "COP",
"currencySymbol": "$",
"installmentId": "8a1e2cdd-bc6c-4b5e-98d2-7f4f4a8f5678",
"installmentNumber": 3,
"status": "Expired",
"isOverdue": true,
"daysOverdue": 15,
"date": "2025-02-10",
"issueDate": "2024-11-10",
"lastPaymentDate": "2025-01-05",
"amount": 250000,
"minAmount": 1,
"maxAmount": 260000,
"penalty": 12500,
"link": "https://app.kuenta.co/debtor/credits/3c1e2cdd-bc6c-4b5e-98d2-7f4f4a8f1234/installment/8a1e2cdd-bc6c-4b5e-98d2-7f4f4a8f5678"
}
]
},
{
"debtor": {
"id": "f9d2a4c3-2d3e-4c8f-8b7c-6e7f6d0a4321",
"name": "Ana López",
"idNumber": "123456789",
"idType": "CC",
"phone": "+57300222222"
},
"totals": {
"totalDue": 0,
"totalMinPayment": 0,
"totalOverdueAmount": 0,
"currency": "",
"currencySymbol": ""
},
"installments": [
]
}
]
},
"success": true
}

Playground​

Server
Authorization
Headers
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI