Kuenta Docs

Appearance

Listar análisis de crédito​

GET
/credit-analyses

Obtiene la lista de todos los análisis de crédito realizados en la organización.

Uso

Este endpoint permite consultar el historial de análisis de crédito realizados, incluyendo estados, resultados y metadatos de cada análisis.

Estados del análisis

  • Pending: Análisis en cola de espera
  • InProgress: Análisis en ejecución
  • Completed: Análisis completado exitosamente
  • Failed: Análisis falló durante la ejecución
  • Cancelled: Análisis cancelado por el usuario

Permisos requeridos

  • ReadAnalysis: Lectura de análisis de crédito

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 único de la organización para la cual se consultan los análisis.

Formato: UUID v4
Validación: Debe corresponder a una organización activa

Typestring
Required
Example123e4567-e89b-12d3-a456-426614174000
formatuuid
Organization-ID*

ID de la organización (campo legacy, usar Config-Organization-ID preferentemente).

Nota: En futuras versiones este header será deprecado.

Typestring
Required
Example123e4567-e89b-12d3-a456-426614174000
formatuuid

Query Parameters

page

Número de página para la paginación.

Valor por defecto: 1

Typeinteger
Example1
minimum1
default1
per_page

Número de elementos por página.

Rango: 1-100

Typeinteger
Example20
minimum1
maximum100
default20
status

Filtrar por estado del análisis.

Estados disponibles:

  • Pending: En cola
  • InProgress: En progreso
  • Completed: Completado
  • Failed: Falló
  • Cancelled: Cancelado
Typestring
Enum
PendingInProgressCompletedFailedCancelled
ExampleCompleted
debtor_id

Filtrar por ID del deudor específico.

Uso: Para ver análisis de un deudor en particular

Typestring
Example123e4567-e89b-12d3-a456-426614174000
formatuuid
date_from

Fecha de inicio para filtrar análisis.

Formato: YYYY-MM-DD

Typestring
Example2023-12-01
formatdate
date_to

Fecha de fin para filtrar análisis.

Formato: YYYY-MM-DD

Typestring
Example2023-12-31
formatdate
score_min

Puntaje mínimo de análisis para filtrar.

Rango: 0-1000

Typeinteger
Example600
minimum0
maximum1000
score_max

Puntaje máximo de análisis para filtrar.

Rango: 0-1000

Typeinteger
Example850
minimum0
maximum1000
include_metadata

Incluir metadatos detallados del análisis.

Typeboolean
Examplefalse
defaultfalse
sort_by

Campo por el cual ordenar los resultados.

Opciones:

  • created_at: Fecha de creación (defecto)
  • completed_at: Fecha de finalización
  • score: Puntaje obtenido
  • status: Estado del análisis
Typestring
Enum
created_atcompleted_atscorestatus
Examplecreated_at
defaultcreated_at
sort_order

Orden de los resultados.

Opciones:

  • desc: Descendente (más reciente primero)
  • asc: Ascendente (más antiguo primero)
Typestring
Enum
ascdesc
Exampledesc
defaultdesc
creditID

Filtrar por ID del análisis de crédito específico.

Uso: Para ver detalles de un análisis en particular

Typestring
Example123e4567-e89b-12d3-a456-426614174000
formatuuid

Responses​

Lista de análisis de crédito obtenida exitosamente
application/json
JSON
{
"message": "credit_analyses",
"data": [
{
"ID": "123e4567-e89b-12d3-a456-426614174000",
"debtorId": "456e7890-e89b-12d3-a456-426614174001",
"debtorName": "Juan Pérez González",
"status": "Completed",
"overallScore": 720,
"riskLevel": "Medium",
"recommendation": "Approve",
"scoreBreakdown": {
"identity": 85,
"income": 75,
"creditHistory": 68,
"financialStability": 72,
"employment": 80
},
"createdAt": "2023-12-01T14:30:00Z",
"startedAt": "2023-12-01T14:30:15Z",
"completedAt": "2023-12-01T14:32:30Z",
"executionTime": 135,
"model": "KuentaRisk_v2",
"version": "2.3.1",
"detailsUrl": "https://api.kuenta.co/v1/credit-analysis/analysis-123e4567-e89b-12d3-a456-426614174000",
"reportUrl": "https://api.kuenta.co/v1/credit-analysis/analysis-123e4567-e89b-12d3-a456-426614174000/report.pdf"
},
{
"ID": "234e5678-e89b-12d3-a456-426614174001",
"debtorId": "567e8901-e89b-12d3-a456-426614174002",
"debtorName": "María García López",
"status": "Completed",
"overallScore": 850,
"riskLevel": "Low",
"recommendation": "Approve",
"scoreBreakdown": {
"identity": 95,
"income": 88,
"creditHistory": 82,
"financialStability": 85,
"employment": 90
},
"createdAt": "2023-12-01T13:15:00Z",
"startedAt": "2023-12-01T13:15:10Z",
"completedAt": "2023-12-01T13:17:45Z",
"executionTime": 155,
"model": "KuentaRisk_v2",
"version": "2.3.1",
"detailsUrl": "https://api.kuenta.co/v1/credit-analysis/analysis-234e5678-e89b-12d3-a456-426614174001",
"reportUrl": "https://api.kuenta.co/v1/credit-analysis/analysis-234e5678-e89b-12d3-a456-426614174001/report.pdf"
},
{
"ID": "345e6789-e89b-12d3-a456-426614174002",
"debtorId": "678e9012-e89b-12d3-a456-426614174003",
"debtorName": "Tech Solutions SAS",
"status": "InProgress",
"overallScore": 0,
"riskLevel": "Low",
"recommendation": "ManualReview",
"createdAt": "2023-12-01T16:45:00Z",
"startedAt": "2023-12-01T16:45:05Z",
"model": "KuentaRisk_v2",
"version": "2.3.1",
"detailsUrl": "https://api.kuenta.co/v1/credit-analysis/analysis-345e6789-e89b-12d3-a456-426614174002"
}
],
"meta": {
"total": 147,
"page": 1,
"per_page": 20,
"total_pages": 8,
"has_next_page": true,
"has_prev_page": false
}
}

Playground​

Server
Authorization
Headers
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI