What is Prosperas #
Prosperas is a credit marketplace. The platform
connects individuals seeking credit with financial institutions capable
of providing it, integrating through applications consumers already use
regularly, such as mobile carriers, digital wallets, and payment
applications.
This guide is written for the integration team at a lender (bank or
fintech). It assumes no prior knowledge of how Prosperas operates
internally: here you’ll find the business model, the shared vocabulary,
and the recommended order in which to build your integration.
The B2B2C model #
Prosperas operates under a B2B2C
(business-to-business-to-consumer) model involving three
primary roles:
Origin → Consumer → Lender (originates the lead) /
(end user) / (processes the application)
-
Origin: The application or platform where
individuals interested in credit initiate their search (mobile carrier,
digital wallet, payment app). The Origin generates initial interest and
directs users into the Prosperas experience. -
Consumer: The end user seeking credit who
completes their application within the Prosperas flow using the
available offer catalog. -
Lender: The bank or fintech ally that receives
the application, evaluates it, and decides whether to grant credit.
This is your role if you’re reading this
guide.
How an application flows #
- The Consumer arrives through an Origin (e.g., a mobile carrier
mini-program). - Within the Prosperas experience, the Consumer browses offers and
selects one. - Prosperas collects the necessary information and assembles the
application (lead). - The application routes to the corresponding Lender based on the
selected offer. - The Lender processes the application and reports outcomes (approval,
disbursement, rejection) through status notifications (postbacks). - Prosperas maintains Consumer communication throughout the
process.
The Tracking ID lifecycle #
This is the single most important thing to get right
in your integration. One identifier follows each application from the
moment it is created until its final status arrives. Handle it correctly
and every postback you send maps unambiguously to the right application.
Handle it wrong and your status updates get lost.
One UUID per journey #
Prosperas generates a single UUID for each Consumer
journey (it is our internal session reference). You never generate it:
you receive it and you return it.
How that identifier travels #
The same value travels across the whole integration under different
names, depending on the channel:
- It travels as
trackingIdin every API
call Prosperas makes to your backend. - It travels as
clickId/
click_idin the hand-off redirect URL (when we
hand the Consumer over to your experience). - You echo it back in EVERY postback you send
us.
Aliases — same value: tracking ID =
clickId(in the redirect) = theclick_idfield
(in postbacks). One value with three names depending on where it
appears.
THE GOLDEN RULE #
Store the
click_idwe send you and return it
byte-for-byte in every postback. Never generate, transform, or truncate
it. Treat it as an opaque string — it may arrive as a plain UUID or as
orgname_UUID(exactly one underscore, e.g.
claro_7e1c...); do NOT split or parse on the
underscore.
Treating it as an opaque string means: don’t interpret it, don’t
strip prefixes, don’t lowercase it, don’t trim it. Copy back exactly
what you received.
Illustrative hand-off
redirect URL #
The redirect that hands you the Consumer carries the
click_id as a query parameter. The following is an
illustrative example (values are not real):
https://your-domain.com/apply?click_id=claro_7e1c9f24-3b8a-4d21-9e77-2a0f1c6b5d3e&product_id=ln_personal_01
Store the click_id value exactly as received and return
it in every postback for that application.
Recommended
integration path (order of operations) #
If you’re just starting, this is the order to build in. Each step
unlocks the next:
- Onboarding — Get your credentials. This is the
starting point: you receive access and your staging and production
environments get organized. - Embedded Flow — Expose your 2 API capabilities.
This is where your backend receives the application in real time,
evaluates it, and responds with a decision. - Postbacks — Send us status updates. You notify us
of each status change on the application (approval, disbursement,
rejection), echoing back theclick_id. - Product Data — Send us your product info. You
provide your product data so the marketplace renders it correctly for
the Consumer.
Glossary of key terms #
| Term | Definition |
|---|---|
| Origin | The application or platform that originates the Consumer’s interest and routes them into Prosperas (mobile carrier, digital wallet, payment app). |
| Consumer | The end user seeking credit who completes their application inside the Prosperas flow. |
| Lender | The bank or fintech that receives the application, evaluates it, and decides whether to grant credit. |
| Lead | The credit application generated by a Consumer; the central object traveling from Origin to Lender whose status gets reported over time. |
| Listing | The way a Lender’s credit offer is presented to the Consumer inside the Prosperas experience; a product’s storefront. |
| Campaign | The configuration defining how and when a Lender’s offer is shown: which product is promoted, with what budget, and under what lead-delivery conditions. |
| Product | The specific financial product a Lender offers (personal loan, payroll loan), with particular terms. |
| Tracking ID | The unique identifier following an application throughout its entire journey, enabling every status notification to match the correct application. It is the same value that travels as clickIdin the redirect and as click_id in postbacks. |
| product_id | The identifier of a Lender’s product, assigned by Prosperas. It rides along in API calls so you can reconcile each lead with the correct product in your catalog. |
| listing_id | The identifier of the listing (the published offer), assigned by Prosperas. Together with product_id, it lets a lead beprecisely attributed to the right Lender and offer. |
| Hand-off | The moment Prosperas hands the Consumer over to your experience, typically via a redirect that includes the click_id andapplication context data. |
| Out-of-band | Credential delivery through a separate, secure channel (not inside API calls or the app). Used to share integration secrets during onboarding. |
| Egress IP | The outbound IP address from which Prosperas originates its calls to your backend. You can use it to allowlist our traffic at your perimeter. |
| Pre-approval | A state in which the Lender signals a preliminary approval subject to later validations, ahead of the final decision and disbursement. |
Next steps #
- Onboarding and provisioning — access credentials
and staging/production environment organization. - Embedded Flow — institutional integration into the
Prosperas experience for real-time application evaluation and
processing. - Postback System — notifying Prosperas of status
changes for each application. - Product Data Requirements — necessary information
about products for correct marketplace rendering.
Last verified: 2026-07-01 · v1.1
