Offer Wall API - 1L & 2LM

Why Take Advantage of the Offer Wall API for 1L & 2LM

Some channel partners prefer a lightweight integration with Engine’s marketplace that delivers personalized offers without heavy engineering effort. To support this, Engine offers the ability to direct users into an Engine-hosted offer wall, through the Offer Wall API for 1L & 2LM—ideal for partners who are able to send lead data via API without having to build a frontend UX themselves, which allows partners to launch an integration quickly and speed up the timeline to realizing revenue, with a data-backed UX to maximize conversion rates. Because offer details are returned in the API response, this also gives partners first-party visibility into each lead's offers, allowing you to store that data for monitoring, analytics, and optimization.

Three Types of Engine Integrations for 1L + 2LM - Comparison Chart

High-Level Integration Overview

Business Preparation:

• To obtain a partnerPageUrl in API responses, partners must first contact their Engine Partner Manager to enable the Offer Wall API for that bearer token.

Technical integration overview:

1. Define productTypes: Decide which product types to include in your request. You can opt to receive offers for both 1st Look and 2nd Look Marketplace, or limit to only 1L or only 2LM offers.

2. Collect Lead Data: Gather all required user and contextual fields needed for the API payload.

3. Submit to Offer Wall API: Send a POST request to the /leads/rateTables endpoint with the assembled lead data as JSON.

4. Check for Offers: Review the response's loanOffers , specialOffers, and pendingResponses to confirm the presence of offers (or the potential for offers to be resolved, in the case of pendingResponses.

5. Make Subequent Request(s): If the pendingResponses array is not empty, poll the GET /rateTables endpoint once per second, until pendingResponses is empty. Once pendingResponses is empty, if either the loanOffers array or specialOffers array is not empty (i.e. contains one or more offer objects), that means the lead has offers and should be redirected.

6. Redirect to the Engine Offer Wall: Redirect the lead into the partnerPageUrl from the response (at the top level), and users will see their offers in a co-branded experience.

Integration Steps:

There are two steps involved for getting offers from Engine's 2nd Look Marketplace

Step 1: Submit Lead

As the first step, partners should post to the Submit Lead endpoint with the user's information:

POST - https://api.engine.tech/leads/rateTables

Post Request Authorization

Engine will provide testing and production API access tokens. All requests to the Engine API must be authenticated using a bearer token specified in the Authorization header.

The header value is prefixed with the string "Bearer". Please contact your Engine Partner Manager for an appropriate bearer token for API testing.

Authorization: Bearer eyJhbGciOieyJhbGciOieyJhbGiOieyJhbGciOixxxxxxxxxx

Other Header Information

The supply partner must include the server's userAgent in request headers (for logging, access control, and analytics) or the request will be rejected by Engine's servers.

The required format of the request to the Offer Wall API is as follows:

curl -L -X POST 'https://api.engine.tech/leads/rateTables' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
-H 'User-Agent: curl/7.68.0' \
--data-raw '{
  "productTypes": [
    "loan", "other"
  ],
  "personalInformation": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "city": "New York",
    "state": "NY",
    "primaryPhone": "2125556789",
    "address1": "45 West 21st Street",
    "address2": "5th Floor",
    "zipcode": "10010",
    "dateOfBirth": "1993-10-09",
    "ssn": "111-22-3333"
  },
  "loanInformation": {
    "purpose": "debt_consolidation",
    "loanAmount": 10000
  },
  "mortgageInformation": {
    "propertyStatus": "own_with_mortgage"
  },
  "creditInformation": {
    "providedCreditRating": "excellent"
  },
  "financialInformation": {
    "employmentStatus": "employed",
    "employmentPayFrequency": "weekly",
    "annualIncome": 75000
  },
  "educationInformation": {
    "educationLevel": "masters"
  },
  "legalInformation": {
    "consentsToFcra": true, // must be true
    "consentsToTcpa": true, // optional, can be false
    "consentsToSms:" true, // optional, can be false
    "tcpaLanguage": "I agree to be contacted...",
    "fcraLanguage": "By checking this box/clicking..."   
  },
  "sessionInformation": {
    "ipAddress": "8.8.8.8",
    "userAgent": "MyApp/2.1 (iOS 16.3; iPhone13,2)"
  },
  "clientTags": {
    "subId": [
      "aaa053cb"
    ]
  }
}'

Required fields:

Product Types

*In the productTypes array, you may pass ["loan"] for the lead to receive First Look / Personal Loan offers only), ["other"] for the lead to receive Second Look Marketplace offers only, or ["loan", "other"] for the lead to receive 1st Look offers when eligible, or else Second Look offers (if not eligible for any 1st Look offers).

Personal Information

Loan Information

Mortgage Information

Credit Information

Financial Information

Legal Information

Session Information

Client Tags

Regex Validations

The following fields have the regex checks and will return errors if your lead submission does not adhere to this logic:

personalInformation.primaryPhone

The primary must be a string of 10 digits, with or without a leading 1, and with or without special characters e.g. ()-.

The area code cannot be the same 3 digits repeated, e.g. 222or 333.

personalInformation.zipcode

The zip code must be a string of either:

1. 5 digits

2. 5 digits, a hyphen -, and 4 more digits

personalInformation.ssn

1. The SSN cannot have all digits in each group be identical (e.g., 111-11-1111 or 222-22-2222).

2. The following specific SSNs are not allowed because they are commonly used in examples or considered invalid:

• 123-45-6789

• 219-09-9999

• 078-05-1120

1. The first group of three digits cannot be:

• 666

• 000

• Any number starting with 9 (e.g., 900–999).

1. The middle group of two digits cannot be:

• 00

1. The last group of four digits cannot be:

• 0000

API Response and Parsing

Sample response:

{
    "uuid": "3a5ffdcd-4700-4dd0-9321-666a381c04fd",
    "leadUuid": "a8e6c5ab-3015-4048-b211-592a6b6c5bdd",
    "embedUrl": "string",
    "partnerPageUrl": "https://offers.fiona.com/partner/channel/loan/application?results=b9b212a8-b284-5986-813e-a8d8e87c1863&step=results",
    "creditCardOffers": [],
    "lifeInsuranceOffers": [],
    "lineOfCreditOffers": [],
    "loanOffers": [],
    "mortgageOffers": [],
    "savingsOffers": [],
    "specialOffers": [],
    "pendingOriginators": [
        {
            "key": "asyncMock",
            "name": "Async Originator Mock",
            "images": "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account_1-202-wqm88e4a.png",
            "companyUuid": "1ea348d9-ec08-4915-9de2-74fd55ea8d19"
        }
    ],
    "pendingResponses": [
        {
            "partner": {
                "uuid": "fa8ed168-9a3e-4612-aa2a-47781dede8f1",
                "name": "Engine Demo Loans Demand Sub Account 1",
                "description": "Demo Sub Account 1 - Description: This is a description of the FI, usually marketing material. <b> This section may include html.</b>",
                "disclaimer": "<p>Demo Sub Account 1 - Disclaimer: This is a disclaimer on the FI/offer, usually includes: \n<ul>\n<li>Legal Terms</li>\n<li>Stipulations</li>\n<li>Limitations</li>\n</ul>\n</p>\n<br/>\n<p>On occasion there may be a separate <a href=\"www.google.com\" target=\"_blank\">hyperlink to another site</a>, or <sup>1</sup>other tag types.</p>\n<br/>\n<sup>1</sup>These are common disclaimer conventions solved by the inclusion of basic HTML",
                "supportsPersonalizedOffers": false,
                "supportsPreSelect": false,
                "shouldDisplayPreSelect": false,
                "imageUrl": "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account_1-202-wqm88e4a.png"
            },
            "productTypes": [
                "loan"
            ]
        }
    ]
}

As shown in the sample response above, Partners will get the following information upon making a successful request:

• uuid - This is the Rate Table UUID

• leadUuid - This is the uuid for each lead, i.e. user (unless the same PII is posted multiple times, in which case a user may have >1 leadUuid associated with them. For thie reason, we suggest using Client Tags for your own attribution)

• partnerPageUrl - This URL directs to a customized offer wall page created by the Engine for the supply partner. It displays the offers returned for that lead, if any, in a compliance-approved Engine-hosted experience

• loanOffers - This is an array that contains 1st Look offers (i.e. prequalified/preapproved loan offers)

• specialOffers - This is an array that contains 2nd Look Marketplace offers (i.e. alternative products such as debt relief and credit builders)

• pendingOriginators - Deprecated field. Partners should ignore this field

• pendingResponses - This is a list of FI partners from which Engine is awaiting responses.

  • If pendingResponses is empty, it means all offers from Engine's Financial Partners for the lead have been returned. The supply partner can redirect the lead into the partnerPageUrl immediately without the need for any further API calls (i.e. ignore Step 2 below)

  • If pendingResponses is NOT empty, it means Engine is still awaiting responses from FI partners. In this common scenario, the supply partner will need to poll the GET originator/rateTables/:uuid endpoint until all requests to FI partners are resolved.

You may ignore other returned fields, which are reserved for products for other marketplaces (or deprecated legacy fields).

Step 2: Poll the GET /rateTables endpoint

Instructions for making the secondary request

Supply partners must poll GET originator/rateTables/:uuid (uuid, NOT leadUuid) to retrieve complete offer information, until the pendingResponses is empty. We recommend polling once per second.

Below are the steps supply partners need to follow to make the secondary request:

1. Capture uuid: Capture the uuid returned in Engine's response (the call made in Step 1)

2. Execute GET request: Use the captured uuid to make a GET request to the endpoint below:

GET https://api.engine.tech/originator/rateTables/:uuid

1. Polling: If there are pendingResponses (i.e. the array is not empty), continue polling every second.

   • Rate tables will typically resolve within 15 seconds if productTypes is set to "loan" or "other"

   • Rate tables may take up to 30 seconds to fully resolve if productTypes is set to ["loan", "other"]

2. Edge case handling: In the edge case where there is no available offer for the lead after all pendingResponses are resolved, we advise partners against redirecting the lead to the partnerPageUrl , as it would display an empty offer wall (and you will likely want to handle no-offer cases within your own site/UX).

Below is a sample response from step 2's GET originator/rateTables/:uuid request. The pendingResponses field is empty, showing that all responses from Financial Institution partners have been received by the Engine.

Sample response:

{
  "uuid": "b9b212a8-b284-5986-813e-a8d8e87c1863",
  "leadUuid": "144bd0ea-b9c6-52d5-a7ef-dccb223d060d",
  "partnerPageUrl": "https://fiona.com/network/{channel}/{zone}/compare/{uuid}",
  "loanOffers": [],
  "mortgageOffers": [],
  "savingsOffers": [],
  "specialOffers": [
      {
          "uuid": "8ddc320c-2a52-4c87-ba35-bfce3a8a7b3a",
          "name": "Mock Credit Builder Offer",
          "desc": "Description of the credit builder offer",
          "url": "https://offers.moneylion.com/ref/37089591-5d47-4219-a532-a65f7bd8c535",
          "partnerName": "Engine Demo Loans Demand Sub Account 1",
          "partnerImageUrl": "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account_1-202-wqm88e4a.png",
          "productSubType": "credit_builder",
          "disclaimer": "test special offer disclaimer 1",
          "financialInstitutionUuid": "fa8ed168-9a3e-4612-aa2a-47781dede8f1"
      }
  ],
  "creditCardOffers": [],
  "pendingResponses": [],
  "pendingOriginators": []
}

Response Timing

For your visibility, below are the typical response time it takes for Engine to receive offers from all our Financial Institutions partners.

1st Look Response Time

2nd Look Marketplace Response Time

Error codes

Response types are mapped to HTTP status codes. In particular:

• 200 OK: when data is successfully returned for a GET request

• 201 Created: when new data is submitted to via a POST

• 400 Bad Request: the submitted data is malformed

• 401 Unauthorized: when the Authorization header is missing, if the value is invalid, or if the corresponding access token lacks the required scopes to complete the request

• 404 Not Found: the URL is invalid, or the resource ID reference in the URL does not exist

• 422 Unprocessable Entity: the submitted data is properly formatted, but invalid according to business logic (some legacy endpoints use 409 Conflict in this case)

• 5xx: server error