API reference — Urza’s Wallet

conventions

API conventions

The private FastAPI service exposes versioned routes under /api/v1/. Requests and responses use JSON unless a media type below says otherwise. Download the generated OpenAPI 3.1 contract.

Error envelope

{"error":{"code":"VALIDATION_ERROR","message":"…","request_id":"…"}}

Validation errors return 400 for invalid values and 422 for missing required fields. X-Request-Id correlates requests.

Rate limiting

FastAPI applies a per-process, per-client-IP sliding window of 60 requests per 60 seconds. Responses carry X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset. Excess requests return 429. Separate user/admin tiers and Redis counters are deferred.

Same-origin boundary

Browsers call Next.js route handlers at relative /api/… paths. The handlers and server components call the private API using INTERNAL_API_URL. Public web pages never expose that internal hostname to client components.

Editor access

/api/v1/admin/** requires HTTP Basic authentication with ADMIN_USERNAME and ADMIN_PASSWORD. Missing configuration returns 503; absent or incorrect credentials return 401 with a Basic challenge. The web middleware independently protects editor pages and proxies.

Draft Users, Alerts, Saved Comparisons and Documents are deferred. Account mutations return 401 stubs. Document routes describe the intended surface, but the production product repository does not implement document reads. These routes do not imply a working document service.

76 operations · 58 paths · OpenAPI 3.1

API group

Admin — Articles

PATCH/api/v1/admin/articles/{article_id}Update Article

Parameters

Name (* required)	Location	Type	Description
`article_id *`	path	`string`

Request body *

application/json

ArticleUpdateBody: object

Field (* required)	Type	Description
`title`	`string \| null`
`slug`	`string \| null`
`body_md`	`string \| null`
`excerpt`	`string \| null`
`summary`	`string \| null`
`image_url`	`string \| null`
`author`	`string \| null`
`published_at`	`string \| null`
`tags`	`array<string> \| null`
`related_product_ids`	`array<string> \| null`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

PATCH/api/v1/admin/articles/{article_id}/statusUpdate Article Status

Parameters

Name (* required)	Location	Type	Description
`article_id *`	path	`string`

Request body *

application/json

ArticleStatusBody: object

Field (* required)	Type	Description
`status *`	`string`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/admin/articlesList Articles Admin

Responses

200 Successful Response

application/json

unknown

POST/api/v1/admin/articlesCreate Article

Request body *

application/json

ArticleCreateBody: object

Field (* required)	Type	Description
`title *`	`string`
`slug`	`string \| null`
`vertical`	`string`
`body_md`	`string \| null`
`excerpt`	`string \| null`
`summary`	`string \| null`
`image_url`	`string \| null`
`author`	`string`
`published_at`	`string \| null`
`status`	`string`
`tags`	`array<string>`
`related_product_ids`	`array<string>`

Responses

201 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

API group

Admin — Guides

PATCH/api/v1/admin/guides/{guide_id}Update Guide

Parameters

Name (* required)	Location	Type	Description
`guide_id *`	path	`string`

Request body *

application/json

GuideUpdateBody: object

Field (* required)	Type	Description
`title`	`string \| null`
`cluster_id`	`string \| null`
`slug`	`string \| null`
`summary`	`string \| null`
`body_md`	`string \| null`
`author`	`string \| null`
`published_at`	`string \| null`
`order_in_cluster`	`integer \| null`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

PATCH/api/v1/admin/guides/{guide_id}/statusUpdate Guide Status

Parameters

Name (* required)	Location	Type	Description
`guide_id *`	path	`string`

Request body *

application/json

GuideStatusBody: object

Field (* required)	Type	Description
`status *`	`string`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

POST/api/v1/admin/guides/clusters/{cluster_id}/deactivateDeactivate Cluster Not Implemented

guide_clusters has no is_active column — deactivation is not implementable.

Parameters

Name (* required)	Location	Type	Description
`cluster_id *`	path	`string`

Responses

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

501 Successful Response

application/json

unknown

PUT/api/v1/admin/guides/clusters/{cluster_id}Update Cluster

Parameters

Name (* required)	Location	Type	Description
`cluster_id *`	path	`string`

Request body *

application/json

ClusterUpdateBody: object

Field (* required)	Type	Description
`title`	`string \| null`
`description`	`string \| null`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/admin/guides/clustersList Clusters Admin

Responses

200 Successful Response

application/json

unknown

POST/api/v1/admin/guides/clustersCreate Cluster Not Implemented

Creating clusters requires a DDL migration — not available at runtime.

Responses

501 Successful Response

application/json

unknown

GET/api/v1/admin/guidesList Guides Admin

Responses

200 Successful Response

application/json

unknown

DELETE/api/v1/admin/guides/journeys/{journey_id}Delete Journey

Parameters

Name (* required)	Location	Type	Description
`journey_id *`	path	`string`

Responses

204 Successful Response

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/admin/guides/journeys/{journey_id}Get Journey Admin

Parameters

Name (* required)	Location	Type	Description
`journey_id *`	path	`string`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

PATCH/api/v1/admin/guides/journeys/{journey_id}Update Journey

Parameters

Name (* required)	Location	Type	Description
`journey_id *`	path	`string`

Request body *

application/json

JourneyUpdateBody: object

Field (* required)	Type	Description
`title`	`string \| null`
`description`	`string \| null`
`end_cta_kind`	`string \| null`
`end_cta_label`	`string \| null`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

PUT/api/v1/admin/guides/journeys/{journey_id}/stepsReplace Journey Steps

Parameters

Name (* required)	Location	Type	Description
`journey_id *`	path	`string`

Request body *

application/json

array<JourneyStepEntry: object>

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/admin/guides/journeysList Journeys Admin

Responses

200 Successful Response

application/json

unknown

POST/api/v1/admin/guides/journeysCreate Journey

Request body *

application/json

JourneyCreateBody: object

Field (* required)	Type	Description
`title *`	`string`
`slug *`	`string`
`end_cta_kind *`	`string`
`end_cta_label *`	`string`
`description`	`string \| null`

Responses

201 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

POST/api/v1/admin/guidesCreate Guide

Request body *

application/json

GuideCreateBody: object

Field (* required)	Type	Description
`title *`	`string`
`cluster_id *`	`string`
`slug`	`string \| null`
`summary`	`string \| null`
`body_md`	`string \| null`
`author`	`string`
`status`	`string`
`published_at`	`string \| null`
`order_in_cluster`	`integer`

Responses

201 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

API group

Admin — Issuers

POST/api/v1/admin/issuers/{issuer_id}/deactivateDeactivate Issuer

Parameters

Name (* required)	Location	Type	Description
`issuer_id *`	path	`string`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/admin/issuers/{issuer_id}Get Issuer

Parameters

Name (* required)	Location	Type	Description
`issuer_id *`	path	`string`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

PATCH/api/v1/admin/issuers/{issuer_id}Update Issuer

Parameters

Name (* required)	Location	Type	Description
`issuer_id *`	path	`string`

Request body *

application/json

IssuerUpdateBody: object

Field (* required)	Type	Description
`name`	`string \| null`
`short_name`	`string \| null`
`vertical`	`string \| null`
`logo_url`	`string \| null`
`website_url`	`string \| null`
`is_active`	`boolean \| null`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/admin/issuersList Issuers

Responses

200 Successful Response

application/json

unknown

POST/api/v1/admin/issuersCreate Issuer

Request body *

application/json

IssuerCreateBody: object

Field (* required)	Type	Description
`id *`	`string`
`name *`	`string`
`short_name *`	`string`
`vertical`	`string \| null`
`logo_url`	`string \| null`
`website_url`	`string \| null`

Responses

201 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

API group

Admin — Offers

POST/api/v1/admin/offers/{offer_id}/deactivateDeactivate Offer

Parameters

Name (* required)	Location	Type	Description
`offer_id *`	path	`string`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

PATCH/api/v1/admin/offers/{offer_id}Update Offer

Parameters

Name (* required)	Location	Type	Description
`offer_id *`	path	`string`

Request body *

application/json

OfferUpdateBody: object

Field (* required)	Type	Description
`headline`	`string \| null`
`terms_snippet`	`string \| null`
`bonus_crc`	`number \| null`
`intro_apr_pct`	`number \| null`
`intro_period_months`	`integer \| null`
`active_from`	`string \| null`
`active_until`	`string \| null`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/admin/offersList Offers Admin

Responses

200 Successful Response

application/json

unknown

POST/api/v1/admin/offersCreate Offer

Request body *

application/json

OfferCreateBody: object

Field (* required)	Type	Description
`product_id *`	`string`
`headline *`	`string`
`terms_snippet`	`string \| null`
`bonus_crc`	`number \| null`
`intro_apr_pct`	`number \| null`
`intro_period_months`	`integer \| null`
`active_from`	`string \| null`
`active_until`	`string \| null`

Responses

201 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

API group

Admin — Products

GET/api/v1/admin/products/tarjetas/{product_id}Get Credit Card

Parameters

Name (* required)	Location	Type	Description
`product_id *`	path	`string`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

PATCH/api/v1/admin/products/tarjetas/{product_id}Update Credit Card

Parameters

Name (* required)	Location	Type	Description
`product_id *`	path	`string`

Request body *

application/json

CreditCardUpdateBody: object

Field (* required)	Type	Description
`product_name`	`string \| null`
`issuer_id`	`string \| null`
`network`	`string \| null`
`annual_fee_crc`	`number \| null`
`annual_fee_waivable`	`boolean \| null`
`interest_rate_annual_pct`	`number \| null`
`min_income_crc`	`number \| null`
`reward_type`	`string \| null`
`cashback_rate_pct`	`number \| null`
`currency`	`string \| null`
`benefits_summary`	`string \| null`
`editorial_score`	`integer \| null`
`editorial_summary`	`string \| null`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

PATCH/api/v1/admin/products/tarjetas/{product_id}/statusUpdate Product Status

Parameters

Name (* required)	Location	Type	Description
`product_id *`	path	`string`

Request body *

application/json

StatusUpdateBody: object

Field (* required)	Type	Description
`status *`	`string`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/admin/products/tarjetasList Credit Cards

Responses

200 Successful Response

application/json

unknown

POST/api/v1/admin/products/tarjetasCreate Credit Card

Request body *

application/json

CreditCardCreateBody: object

Field (* required)	Type	Description
`product_name *`	`string`
`issuer_id *`	`string`
`network *`	`string`
`status`	`string \| null`
`annual_fee_crc`	`number \| null`
`annual_fee_waivable`	`boolean`
`interest_rate_annual_pct`	`number \| null`
`min_income_crc`	`number \| null`
`reward_type`	`string`
`cashback_rate_pct`	`number \| null`
`currency`	`string`
`benefits_summary`	`string \| null`
`editorial_score`	`integer \| null`
`editorial_summary`	`string \| null`

Responses

201 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

API group

Admin — Reviews

GET/api/v1/admin/products/tarjetas/{product_id}/reviewGet Review For Admin

Parameters

Name (* required)	Location	Type	Description
`product_id *`	path	`string`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

PATCH/api/v1/admin/products/tarjetas/{product_id}/reviewUpdate Review

Parameters

Name (* required)	Location	Type	Description
`product_id *`	path	`string`

Request body *

application/json

ReviewUpdateBody: object

Field (* required)	Type	Description
`pros`	`array<string> \| null`
`cons`	`array<string> \| null`
`best_use_case`	`string \| null`
`review_body_md`	`string \| null`
`author`	`string \| null`
`published_at`	`string \| null`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

POST/api/v1/admin/products/tarjetas/{product_id}/reviewUpsert Review

Parameters

Name (* required)	Location	Type	Description
`product_id *`	path	`string`

Request body *

application/json

ReviewUpsertBody: object

Field (* required)	Type	Description
`pros`	`array<string> \| null`
`cons`	`array<string> \| null`
`best_use_case`	`string \| null`
`review_body_md`	`string \| null`
`author`	`string \| null`
`published_at`	`string \| null`

Responses

201 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

PATCH/api/v1/admin/products/tarjetas/{product_id}/review/statusUpdate Review Status

Parameters

Name (* required)	Location	Type	Description
`product_id *`	path	`string`

Request body *

application/json

ReviewStatusBody: object

Field (* required)	Type	Description
`status *`	`string`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

API group

Alerts Draft

DELETE/api/v1/alerts/{alert_id}Delete Alert

Parameters

Name (* required)	Location	Type	Description
`alert_id *`	path	`string`

Responses

204 Successful Response

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/alertsList Alerts

Responses

200 Successful Response

application/json

unknown

POST/api/v1/alertsCreate Alert

Responses

201 Successful Response

application/json

unknown

API group

Articles

GET/api/v1/articles/{vertical}/{slug}Get Article By Slug

Parameters

Name (* required)	Location	Type	Description
`vertical *`	path	`VerticalSlug: "tarjetas" \| "fondos-pension" \| "credito-hipotecario"`
`slug *`	path	`string`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/articles/for-product/{product_id}List Articles For Product

Parameters

Name (* required)	Location	Type	Description
`product_id *`	path	`string`
`limit`	query	`integer`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/articlesList Articles

Parameters

Name (* required)	Location	Type
`vertical *`	query	`VerticalSlug: "tarjetas" \| "fondos-pension" \| "credito-hipotecario"`
`tag`	query	`ArticleTag: "promociones" \| "guias" \| "noticias" \| "comparativas" \| "tips" \| null`
`page`	query	`integer`
`page_size`	query	`integer`

Responses

200 Successful Response

application/json

ArticleListResponse: object

Field (* required)	Type	Description
`data *`	`array<Article: object>`
`meta *`	`ArticleListMeta: object`

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/articles/latestList Latest Articles

Parameters

Name (* required)	Location	Type	Description
`vertical *`	query	`VerticalSlug: "tarjetas" \| "fondos-pension" \| "credito-hipotecario"`
`limit`	query	`integer`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

API group

Comparisons

POST/api/v1/compareCompare Products

Request body *

application/json

CompareBody: object

Field (* required)	Type	Description
`vertical *`	`VerticalSlug: "tarjetas" \| "fondos-pension" \| "credito-hipotecario"`
`ids *`	`array<string>`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

API group

Documents Draft

GET/api/v1/documents/{document_id}/downloadDownload Document

Parameters

Name (* required)	Location	Type	Description
`document_id *`	path	`string`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/documents/{document_id}Get Document

Parameters

Name (* required)	Location	Type	Description
`document_id *`	path	`string`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/documentsList Documents

Parameters

Name (* required)	Location	Type
`vertical`	query	`string \| null`
`issuer_id`	query	`string \| null`
`document_type`	query	`string \| null`
`access_level`	query	`string \| null`
`is_current_version`	query	`boolean \| null`
`page`	query	`integer`
`page_size`	query	`integer`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

POST/api/v1/documentsCreate Document

Upload a new document. Requires editor role (Clerk auth — stubbed 401).

Responses

201 Successful Response

application/json

unknown

API group

FX

GET/api/v1/fx/bcrGet Bcr Rate

Return the platform BCR reference exchange rate (CRC per USD). Used by the FEAT-007 calculator's cross-currency annotation only. Sourced from BCR (Banco Central de Costa Rica). For v1 the rate is a static constant; a daily rate-sync job replaces it in a follow-up.

Responses

200 Successful Response

application/json

BcrRateOut: object

Field (* required)	Type	Description
`rate_crc_per_usd *`	`number`
`effective_date *`	`string`

API group

Guides

GET/api/v1/guides/{slug}Get Guide By Slug

Parameters

Name (* required)	Location	Type	Description
`slug *`	path	`string`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/guides/clustersList Clusters

Responses

200 Successful Response

application/json

unknown

GET/api/v1/guidesList Guides

Parameters

Name (* required)	Location	Type	Description
`cluster`	query	`GuideClusterId: "empezando" \| "eligiendo" \| "usando" \| "resolviendo-problemas" \| null`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/guides/journeys/{slug}Get Journey By Slug

Parameters

Name (* required)	Location	Type	Description
`slug *`	path	`string`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/guides/journeysList Journeys

Responses

200 Successful Response

application/json

unknown

API group

Health

GET/api/v1/health Health Handler

Responses

200 Successful Response

application/json

unknown

GET/health Health Handler

Responses

200 Successful Response

application/json

unknown

API group

Leads

POST/api/v1/admin/deletion-requests/{request_id}/processAdmin Process Deletion Request

Parameters

Name (* required)	Location	Type	Description
`request_id *`	path	`string`

Request body *

application/json

object

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/admin/deletion-requestsAdmin List Deletion Requests

Responses

200 Successful Response

application/json

unknown

POST/api/v1/admin/leads/{lead_id}/anonymizeAdmin Anonymize Lead

Parameters

Name (* required)	Location	Type	Description
`lead_id *`	path	`string`

Responses

204 Successful Response

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/admin/leads/{lead_id}Admin Get Lead

Parameters

Name (* required)	Location	Type	Description
`lead_id *`	path	`string`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

PATCH/api/v1/admin/leads/{lead_id}Admin Patch Lead

Parameters

Name (* required)	Location	Type	Description
`lead_id *`	path	`string`

Request body *

application/json

LeadPatchPayload: object

Field (* required)	Type	Description
`status`	`LeadStatus: "new" \| "contacted" \| "converted" \| "discarded" \| null`
`notes`	`string \| null`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/admin/leadsAdmin List Leads

Parameters

Name (* required)	Location	Type
`status`	query	`LeadStatus: "new" \| "contacted" \| "converted" \| "discarded" \| null`
`vertical`	query	`string \| null`
`page`	query	`integer`
`page_size`	query	`integer`

Responses

200 Successful Response

application/json

LeadListResponse: object

Field (* required)	Type	Description
`data *`	`array<Lead: object>`
`meta *`	`LeadListMeta: object`

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

POST/api/v1/leads/deletion-requestSubmit Deletion Request

Anti-enumeration: response is always 202 with the same generic message regardless of whether the email matches any lead. Email shape validation (the 400/422 path) is handled by Pydantic — only a syntactically-bad email returns an error to the submitter.

Request body *

application/json

DeletionRequestPayload: object

Field (* required)	Type	Description
`email *`	`string`

Responses

202 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

POST/api/v1/leadsSubmit Lead

Persist the lead + consent record. PII safety: nothing about payload.name / payload.email is ever logged.

Parameters

Name (* required)	Location	Type	Description
`urza_session_id`	cookie	`string \| null`

Request body *

application/json

LeadSubmissionPayload: object

Field (* required)	Type	Description
`name *`	`string`
`email *`	`string`
`vertical *`	`"tarjetas" \| "fondos-pension" \| "credito-hipotecario"`
`product_id *`	`string`
`product_name *`	`string`
`source_surface *`	`"dashboard" \| "catalogo" \| "comparacion" \| "detalle" \| "finder" \| "wizard" \| "articulo" \| "guia"`
`consent_granted *`	`boolean`
`policy_version *`	`string`

Responses

201 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

API group

Offers

POST/api/v1/cta-eventsPost Cta Event

Parameters

Name (* required)	Location	Type	Description
`urza_session_id`	cookie	`string \| null`

Request body *

application/json

CtaEventSubmitPayload: object

Field (* required)	Type	Description
`product_id *`	`string`
`vertical *`	`string`
`source_surface *`	`CtaSourceSurface: "dashboard" \| "catalogo" \| "comparacion" \| "detalle" \| "finder" \| "wizard" \| "articulo" \| "guia"`
`event_type *`	`CtaEventType: "impression" \| "click" \| "form_open" \| "form_open_failed"`
`metadata`	`object \| null`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/offers/{product_id}Get Offer For Product

Parameters

Name (* required)	Location	Type	Description
`product_id *`	path	`string`

Responses

200 Successful Response

application/json

unknown

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

API group

Products

GET/api/v1/products/{vertical}/{id}Get Product

Parameters

Name (* required)	Location	Type	Description
`vertical *`	path	`string`
`id *`	path	`string`

Responses

200 Successful Response

application/json

object

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/products/{vertical}List Products

Parameters

Name (* required)	Location	Type
`vertical *`	path	`string`
`cursor`	query	`string \| null`
`limit`	query	`integer`
`issuer`	query	`array<string> \| null`
`status`	query	`string \| null`
`currency`	query	`string \| null`
`max_fee_crc`	query	`number \| null`
`network`	query	`array<string> \| null`
`reward_type`	query	`array<string> \| null`
`has_travel_benefits`	query	`boolean \| null`
`q`	query	`string \| null`
`fund_type`	query	`string \| null`
`rate_type`	query	`string \| null`
`sort`	query	`string \| null`
`sort_dir`	query	`string \| null`

Responses

200 Successful Response

application/json

ProductListResponse: object

Field (* required)	Type	Description
`data *`	`array<unknown>`
`meta *`	`ProductListMeta: object`

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/products/{vertical}/issuersList Issuers

Parameters

Name (* required)	Location	Type	Description
`vertical *`	path	`string`

Responses

200 Successful Response

application/json

IssuerListResponse: object

Field (* required)	Type	Description
`data *`	`array<Issuer: object>`

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

API group

Saved Comparisons Draft

DELETE/api/v1/comparisons/{comparison_id}Delete Saved Comparison

Parameters

Name (* required)	Location	Type	Description
`comparison_id *`	path	`string`

Responses

204 Successful Response

422 Validation Error

application/json

HTTPValidationError: object

Field (* required)	Type	Description
`detail`	`array<ValidationError: object>`

GET/api/v1/comparisonsList Saved Comparisons

Responses

200 Successful Response

application/json

unknown

POST/api/v1/comparisonsSave Comparison

Responses

201 Successful Response

application/json

unknown

API group

Users Draft

DELETE/api/v1/users/accountDelete Account

Responses

200 Successful Response

application/json

unknown

GET/api/v1/users/exportExport Data

Responses

200 Successful Response

application/json

unknown

GET/api/v1/users/profileGet Profile

Responses

200 Successful Response

application/json

unknown

PATCH/api/v1/users/profilePatch Profile

Responses

200 Successful Response

application/json

unknown