https://api.veriko.mx/v1/summary Get dashboard summary
Returns a high-level summary including validation counts, beneficiary count, and recent validations for the dashboard view.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | integer | optional | Maximum number of recent validations to return. Default: |
curl -X GET 'https://api.veriko.mx/v1/summary' \
-H 'Authorization: Bearer mxcep_••••'
Python example — coming soon.
JavaScript example — coming soon.
PHP example — coming soon.
| Field | Type | Description |
|---|---|---|
type * | string | |
attributes * | object | Aggregated user dashboard attributes (counts, success rate, onboarding progress). |
total_validations | integer | Cumulative validation count for the user across all months. |
monthly_validations | integer | Validations in the current calendar month (UTC). |
pending_month | integer | Current-month validations still in a non-terminal state (`queued` or `processing`). |
valid_validations | integer | User's validations with verdict `valid` (lifetime total). |
avg_ticket | number | User's lifetime average ticket: average amount over ALL of the user's validations with amount > 0 (excludes playground and soft-deleted). `0` when there is no positive amount. |
success_rate_percent | number | Success rate as a percentage (0-100) over the total validations. |
beneficiaries_count | integer | Count of the user's active beneficiaries. |
comenzar_milestones_completed | integer | Milestones cleared in the `/comenzar` wizard: (1) ≥1 OCR validation, (2) ≥1 direct validation, (3) ≥1 beneficiary, (4) (1) AND (2). Max total: 4. |
relationships | object | Dashboard JSON:API relationships (references to associated resources). |
recent_validations | object | JSON:API relationship pointing to the recent validations shown in the dashboard. |
data | array |
| Status | Class | Description | Body |
|---|---|---|---|
| 200 | 2xx | Dashboard summary for the authenticated user. | No body |
| 401 | 4xx | Authentication is required or the provided credentials are invalid. | ErrorResponse |
| Status | Code | Detail |
|---|---|---|
| 401 | unauthorized | Invalid or missing authentication credentials. Envelope
|