Developer Center
Back to Engine.tech
  • Welcome!
  • Top of Funnel Applications
    • Embeddable Calculators
      • Embeddable Personal Loan Calculator
      • Embeddable Debt Consolidation Loan Calculator
      • Embeddable Personal Loan vs Debt Relief Calculator
      • Embeddable Savings Calculator
      • Adding Your Client Tags for Reporting Attribution
  • Loans / Savings / Second Look Marketplace
    • Hosted Integrations
      • Partner Pages / Embeds
        • Loans Partner Pages
          • Frond-End Customization Options
          • Preferred Look Partner Pages
          • Bridge Partner Pages
          • Special Offer Partner Pages
        • Loans Embeds
        • Pre-Populating Existing Customer Data
        • Adding Your Client Tags for Reporting Attribution
      • Mobile SDK
        • Mobile SDK - Prefilling Lead Data
        • Adding Your Client Tags to Reporting for Mobile SDK Integrations
        • Event Handlers for Real-Time Tracking in the Engine Mobile SDK
    • Native API (Build Your Own)
      • Financial Product Verticals
        • Loans
          • Personal Loans
            • Collecting User Information for Personal Loans
            • Displaying Personal Loan Offers
            • API Specifications
            • FAQs
          • Home Equity Line of Credit (HELOC)
            • Displaying Offers HELOC
            • Risk Factors & Requirements
            • Dos & Don’ts for All HELOC Supply Partners
            • Dos & Don’ts for HELOC Native Partners (API)
            • Our Embed/Partner Page Implementation
            • HELOC-specific disclosures
          • Auto Loan Refinancing (ALR)
            • Collecting User Information
            • Displaying Auto Loan Refinance Offers
            • API Specifications
            • FAQs
        • Savings
          • Collection User Information for Savings
          • Displaying Savings Offers
          • Marketplace Display Requirements
          • Reporting
          • API Specifications
        • 2nd Look Marketplace
          • 2nd Look Marketplace (Financial Services Providers)
          • 2nd Look Marketplace (Channel Partners)
            • Collecting User Information for 2LM
            • Displaying 2L Marketplace Offers
      • Adding Your Client Tags to Reporting for Native API Integrations
      • General Compliance Guidelines
        • Consumer Information Fields
          • Additional Compliance Recommendations & Best Practices
        • Disclosures
        • Consents
        • Offer Display Fields
    • Reporting Options for Channel Partners
      • Channel Partner Reporting - Looker
      • Channel Partner Reporting - Analytics API
  • Credit Cards Marketplace
    • Native API (Build Your Own)
      • Getting Started
      • Flow Design
      • Collecting User Information for Credit Cards
      • Displaying Credit Card Offers
      • API Specifications
      • Compliance Guidelines
  • New Marketplaces (Credit Builders, Earned Wage Access, Debt Relief)
    • Hosted Integrations
      • New Marketplaces Embeds
      • Adding Your Client Tags for Reporting Attribution
  • References
    • Brand Guidelines and Assets
    • Appendix
      • Appendix A - Notices
      • Appendix B - Disclosures
      • Appendix C - Consents
      • Appendix D: API Field to Offer Card Mappings
      • Appendix E: Appending Client Tags for Partner Page and Embed Integrations
Powered by GitBook
On this page
  • Loans
  • Personal Loan (Unsecured)
  • Secured Loan
  • Line of Credit
  • Home Equity Line of Credit
  • Auto Loan Refinance
  • 2nd Look Marketplace

Was this helpful?

  1. References
  2. Appendix

Appendix D: API Field to Offer Card Mappings

This page contains screenshots of how offer response fields from the Engine API should be displayed in your UI.

PreviousAppendix C - ConsentsNextAppendix E: Appending Client Tags for Partner Page and Embed Integrations

Last updated 6 months ago

Was this helpful?

Loans

Here are examples of how different Loan offers are represented on Engine’s owned experiences, with the relevant API response fields for each offer (each element of the loanOffers array denotes an individual loan offer, represented as a JSON object):


For Secured Loan or Line of Credit products, two additional fields must be displayed:

  • Product Sub Type Label (ie. Secured Loan) - returned via API in snake case

  • Product Sub Type Disclaimer


For Secured Loan or Line of Credit products, two additional fields must be displayed:

  • Product Sub Type Label (ie. Home Equity Line of Credit) - returned via API in snake case

  • Product Sub Type Disclaimer



Here is an example of how a 2nd Look Marketplace offer is represented on Engine’s owned experiences, with the relevant API response fields for each offer (each element of the specialOffers array denotes an individual offer, represented as a JSON object):


Secured Loan
Line of Credit
Home Equity Line of Credit
Auto Loan Refinance
2nd Look Marketplace
Personal Loan (Unsecured)
Unsecured Personal Loan offer card with API fields
Secured Loan offer card with API fields
Home Equity Line of Credit offer card with API fields