API Bundles Overview
YAPU offers a catalog of standard API bundles — pre-defined integration use cases that combine one or more API calls to deliver a complete, end-to-end workflow. Each bundle is designed around a specific business need and comes with clearly defined actors, data flows, and responsibilities.
What is an API bundle?
An API bundle is a packaged integration use case. Rather than building a custom integration from scratch, clients select the bundle that matches their operational need and follow a structured specification and delivery process.
Each bundle includes:
- A defined use case and business purpose
- The actors involved (client system, loan officer, YAPU platform)
- The trigger event that initiates the API call
- The data exchanged in each direction
- Clear client and YAPU responsibilities
- Technical requirements and delivery timeline
Standalone vs non-standalone
| Type | Description | Example |
|---|---|---|
| Standalone API | Can be called independently, with no dependency on other YAPU APIs or platform state | YAPU SNAP |
| Non-standalone API bundle | Depends on the YAPU platform context (e.g., a questionnaire or client record must already exist) | Standard API bundles |
All bundles listed on this page are non-standalone. They operate within the YAPU platform ecosystem. For the standalone option, see YAPU SNAP.
How to choose the right bundle
Use these questions to identify the bundle that fits your use case:
- What triggers the integration? Is it a user action (e.g., submitting a form), a scheduled event, or a status change?
- What data needs to move? Is your system sending data to YAPU, receiving data from YAPU, or both?
- What is the business outcome? What should happen in your system as a result of the integration?
Bring your answers to the specification call with your YAPU contact — this is where the right bundle (or combination of bundles) is confirmed.
Standard API bundle catalog
The table below shows all ten standard bundles and how they differ across three dimensions: trigger events, inbound autofill, and eligibility checking. Use it to quickly identify which bundle matches your use case.
| Bundle | Trigger: Submit | Trigger: Update | Trigger: Approval | Autofill | Eligibility check |
|---|---|---|---|---|---|
| Bundle 1 | ✓ | ||||
| Bundle 2 | ✓ | ✓ | |||
| Bundle 3 | ✓ | ✓ | |||
| Bundle 4 | ✓ | ✓ | |||
| Bundle 5 | ✓ | ✓ | ✓ | ||
| Bundle 6 | ✓ | ✓ | ✓ | ||
| Bundle 7 | ✓ | ✓ | |||
| Bundle 8 | ✓ | ✓ | ✓ | ||
| Bundle 9 | ✓ | ✓ | ✓ | ||
| Bundle 10 | ✓ | ✓ | ✓ | ✓ | |
| Bundle 11 | ✓ | ✓ | ✓ | ✓ |
Trigger events explained:
- Submit — fires when a loan officer presses Submit on a completed questionnaire
- Update — fires whenever an existing questionnaire or Credit Committee Report is modified
- Approval — fires when a YAPU user sets the report status to "Approval"
Inbound features explained:
- Autofill — YAPU sends the customer ID to your system and receives back profile data to pre-fill the questionnaire
- Eligibility check — YAPU queries your system to confirm whether the customer is eligible before the questionnaire proceeds; ineligible customers are stopped immediately
Next steps
- YAPU SNAP — if you need the standalone climate risk API
- Getting Started — begin the integration onboarding process
- Integration Process — understand timelines and responsibilities
- Support & Contact — speak with your YAPU representative