GEThttps://api.veriko.mx/v1/finance/summary

Monthly financial summary (KPIs)

Audience
public
Auth
API key
Permission
finance:generate_self
How-to guide →

Returns the month's KPIs for the /finanzas panel:

  • Counts by verdict
  • Monetary aggregates (total / verified / unverified volume, average ticket, median, minimum, maximum, verified share)
  • Success rate
  • Average processing time
  • Daily breakdown
  • Counterparties and sending/receiving banks
  • Verdict distribution and comparison with the previous month (percentage deltas, null when the previous month had a zero base)

"Verified" means Banxico returned valid and the CEP was found. Any other verdict counts as unverified.

Parameters
ParameterInTypeRequiredDescription
month*querystringrequired

Month to query in YYYY-MM format.

e.g. 2026-04
user_idquerystring (uuid)optional

Administrators only — UUID of the user to query.

e.g. f47ac10b-58cc-4372-a567-0e02b2c3d479
Request
curl -X GET 'https://api.veriko.mx/v1/finance/summary' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response 200FinanceSummaryResponse — Monthly KPI blob for the user, including comparison against the previous month.
FieldTypeDescription
dataobject

Main response payload. Shape varies by endpoint (object, array, or JSON:API envelope with type, id, attributes).

typestring

JSON:API resource type. Always finance_summary.

e.g. finance_summary
attributesobject

Account financial indicators for a calendar month, with aggregates, breakdowns, and comparison with the previous month.

periodobject

Time range of the summary (full calendar month).

monthstring

Month in YYYY-MM format.

e.g. 2026-04
from_utcstring

Start of the month in UTC, in YYYY-MM-DD HH:MM:SS format.

e.g. 2026-04-01 06:00:00
to_utcstring

End of the month in UTC (exclusive), in YYYY-MM-DD HH:MM:SS format.

e.g. 2026-05-01 06:00:00
countsobject

Validation counts by verdict, plus records withdrawn through soft deletion during the period (informational).

totalinteger

Number of validations in the period, including those with pending status.

e.g. 287
validinteger

Validations with valid verdict in the period.

e.g. 228
invalidinteger

Validations with invalid verdict in the period.

e.g. 4
not_foundinteger

Validations with not_found verdict in the period.

e.g. 32
cep_unavailableinteger

Validations with cep_unavailable verdict in the period.

e.g. 18
returnedinteger

Validations whose operation was settled and later returned in the period.

e.g. 4
errorinteger

Validations that ended in a technical error.

e.g. 3
pendinginteger

Validations still in progress that had not reached a terminal status at the end of the period.

e.g. 2
deletedinteger

Validations withdrawn through soft deletion during the period.

e.g. 6
amountsobject

Monetary aggregates for the period. verified_volume sums only validations with valid result.

total_volumenumber

Summed amount in MXN of every validation in the period.

e.g. 1234567.89
verified_volumenumber

Volume in MXN of validations with valid result.

e.g. 980123.45
unverified_volumenumber

Difference between total and verified volume.

e.g. 254444.44
avg_ticketnumber

Average amount per validation in MXN.

e.g. 4302.32
median_ticketnumber

Median amount per validation in MXN.

e.g. 3100
max_ticketnumber

Largest individual amount in the month in MXN.

e.g. 250000
min_ticketnumber

Smallest individual amount in the month in MXN.

e.g. 50
verified_share_pctnumber

Percentage of total volume from verified validations, expressed from 0 to 100.

e.g. 79.4
success_ratenumber

Success rate: percentage of validations with valid result out of counts.total, expressed from 0 to 100.

e.g. 79.4
avg_processing_msinteger

Average processing time in milliseconds for the period.

e.g. 412
daily_breakdownarray

Daily breakdown for days with activity. Days with no validations are omitted.

top_counterpartiesarray

Top 5 user beneficiary accounts by verified volume in the month.

top_banks_receptorarray

Top 5 receiving banks by verified volume.

top_banks_emisorarray

Top 5 sending banks by verified volume.

verdict_distributionobject

Validation count by verdict value. Missing values imply zero.

e.g. {"valid":228,"not_found":32,"cep_unavailable":18,"invalid":4,"returned":4,"error":3}
comparison_prev_monthobject

Comparison against the previous month. Deltas are null when the previous month had a zero base (growth not defined).

prev_monthstring

Previous month in YYYY-MM format.

e.g. 2026-03
totalinteger

Number of validations in the previous month.

e.g. 251
verified_volumenumber

Verified volume in the previous month in MXN.

e.g. 880000
total_delta_pctnumber | nullnullable

Percentage change in total count vs. the previous month. null when the previous month had zero validations.

e.g. 14.3
volume_delta_pctnumber | nullnullable

Percentage change in verified volume vs. the previous month. null when the previous month had zero verified volume.

e.g. 11.4
foliostring

Deterministic statement folio for the month, identical to the value returned in the X-Finance-Folio header of the export endpoint.

e.g. A3F12B9C0D4E
metaobject

Response metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.

versionstring

API version that processed the request.

e.g. 1.47.0
api_versionstring

API route prefix version (e.g. v1).

e.g. v1
request_idstring

Unique request identifier (hex).

e.g. a1b2c3d4e5f66f5e4d3c2b1a
datetimeobject

Companion descriptor present in the meta block of every response (and in the meta of outgoing webhook bodies). Lets clients assert the timezone contract without re-reading the spec.

e.g. {"timezone":"UTC","format":"ISO 8601"}
timezone*string

Always UTC: The canonical timezone for every datetime field in the body.

e.g. UTC
format*string

Always ISO 8601: Explicit Z suffix on every datetime.

e.g. ISO 8601
linksobject

Pagination or related links, present only when the endpoint returns a paginated collection.

Response status codesGET /v1/finance/summary
StatusClassDescriptionBody
2002xxMonthly KPI blob for the user, including comparison against the previous month.FinanceSummaryResponse
4004xxInvalid or missing month parameterErrorResponse
4014xxAuthentication is required or the provided credentials are invalid.ErrorResponse
4034xxInsufficient permissions.ErrorResponse
Response headers200
HeaderTypeDescription
Cache-ControlstringPrivate cache directive with stale-while-revalidate.
Errors from GET /v1/finance/summary
StatusCodeExample
400invalid_month

'month' is required and must be YYYY-MM.

Envelope
meta.request_id
d5e6f7a8b9c11c9b8a7f6e5d
401unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c
403permission_denied

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c00c9b8a7f6e5d