https://api.veriko.mx/v1/summary Obtener resumen del dashboard
Devuelve los contadores agregados de validaciones del usuario y, en relationships.recent_validations, las últimas N validaciones (parámetro ?limit=, default 5, máximo 10). Incluye además comenzar_milestones_completed para el wizard /comenzar.
| Parámetro | Ubicación | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
limit | query | integer | opcional | Número máximo de validaciones recientes a devolver. Predeterminado: |
curl -X GET 'https://api.veriko.mx/v1/summary' \
-H 'Authorization: Bearer mxcep_••••'
Ejemplo en Python — próximamente.
Ejemplo en JavaScript — próximamente.
Ejemplo en PHP — próximamente.
| Campo | Tipo | Descripción |
|---|---|---|
type * | string | |
attributes * | object | Atributos agregados del dashboard del usuario (conteos, tasa de éxito, progreso del onboarding). |
total_validations | integer | Total acumulado de validaciones del usuario (todos los meses). |
monthly_validations | integer | Validaciones del mes calendario en curso (UTC). |
pending_month | integer | Validaciones del mes en curso aún en estado no terminal (`queued` o `processing`). |
valid_validations | integer | Validaciones del usuario con veredicto `valid` (acumulado histórico). |
avg_ticket | number | Ticket promedio (all-time) del usuario: promedio del monto sobre TODAS sus validaciones con monto > 0 (excluye playground y soft-deleted). `0` cuando no tiene ningún monto positivo. |
success_rate_percent | number | Tasa de éxito como porcentaje (0-100) sobre el total de validaciones. |
beneficiaries_count | integer | Cantidad de beneficiarios activos del usuario. |
comenzar_milestones_completed | integer | Cuenta de hitos completados del wizard `/comenzar`: (1) ≥1 validación OCR, (2) ≥1 validación directa, (3) ≥1 beneficiario, (4) (1) AND (2). Total máximo: 4. |
relationships | object | Relaciones JSON:API del dashboard (referencias a recursos asociados). |
recent_validations | object | Relación JSON:API con las validaciones recientes mostradas en el dashboard. |
data | array |
| Código | Clase | Descripción | Cuerpo |
|---|---|---|---|
| 200 | 2xx | Resumen del dashboard del usuario. | Sin cuerpo |
| 401 | 4xx | Se requiere autenticación o las credenciales son inválidas | ErrorResponse |
| Código | Clave | Detalle |
|---|---|---|
| 401 | unauthorized | Invalid or missing authentication credentials. Envelope
|