| Attribute Name | \nType | \nFormat | \nEnum | \n
|---|---|---|---|
| eventType | \nstring | \n\n | leadCreated appSubmitted apiApproved apiRejected offerClicked affiliateOfferClicked applied approved listed opened funded conversation lenderQualifiedLead | \n
| leadUuid | \nstring | \nuuid | \n\n |
| leadCreatedAt | \nstring | \ndate-time | \n\n |
| eventCreatedAt | \nstring | \ndate-time | \n\n |
| eventDeletedAt | \nstring | \ndate-time | \n\n |
| amountInCents | \ndouble | \n\n | \n |
| supplySubAccountName | \nstring | \n\n | \n |
| supplySubAccountUuid | \nstring | \nuuid | \n\n |
| financialInstitutionName | \nstring | \n\n | \n |
| financialInstitutionUuid | \nstring | \nuuid | \n\n |
| unifiedProductType | \nstring | \n\n | \n |
| productType | \nstring | \n\n | creditCard insurance lifeInsurance loan mortgage savings other | \n
| productSubType | \nstring | \n\n | \n |
| isTest | \nboolean | \n\n | Whether a Lead was created using a test access token | \n
| paginationTimestamp | \nstring | \ndate-time | \nTime when the event entered our system. | \n
| Event Type | \nRequired Attributes | \nOptional Attributes | \n
|---|---|---|
| leadCreated | \neventType leadUuid leadCreatedAt eventCreatedAt | \n\n |
| appSubmitted | \neventType leadUuid leadCreatedAt eventCreatedAt | \n\n |
| apiApproved | \neventType leadUuid leadCreatedAt eventCreatedAt financialInstitutionName financialInstitutionUuid | \nunifiedProductType productType productSubType | \n
| apiRejected | \neventType leadUuid leadCreatedAt eventCreatedAt financialInstitutionName financialInstitutionUuid | \nunifiedProductType productType productSubType | \n
| offerClicked | \neventType leadUuid leadCreatedAt eventCreatedAt financialInstitutionName financialInstitutionUuid | \nunifiedProductType productType productSubType | \n
| affiliateOfferClicked | \neventType leadUuid leadCreatedAt eventCreatedAt financialInstitutionName financialInstitutionUuid | \nunifiedProductType productType productSubType | \n
| applied | \neventType leadUuid leadCreatedAt eventCreatedAt financialInstitutionName financialInstitutionUuid | \nunifiedProductType productType productSubType | \n
| approved | \neventType leadUuid leadCreatedAt eventCreatedAt financialInstitutionName financialInstitutionUuid | \nunifiedProductType productType productSubType | \n
| listed | \neventType leadUuid leadCreatedAt eventCreatedAt financialInstitutionName financialInstitutionUuid | \nunifiedProductType productType productSubType | \n
| opened | \neventType leadUuid leadCreatedAt eventCreatedAt financialInstitutionName financialInstitutionUuid | \nunifiedProductType productType productSubType | \n
| Event Type | \nDefinition | \nRequired Attributes | \nOptional Attributes | \n
|---|---|---|---|
| leadCreated | \nA user enters the marketplace funnel | \nSee under common event types | \n\n |
| appSubmitted | \nThe lead has filled out the information in the Engine by MoneyLion application and a rate table has been created | \nSee under common event types | \n\n |
| apiApproved | \nFinancial institution has pre-approved or pre-qualified a user for at least one offer | \nSee under common event types | \n\n |
| apiRejected | \nFinancial institution has not pre-approved or pre-qualified a user for any offers | \nSee under common event types | \n\n |
| offerClicked | \nThe user clicks on or is auto redirected into an offer | \nSee under common event types | \n\n |
| affiliateOfferClicked | \nThe user clicks on or is auto redirected into an affiliate offer | \nSee under common event types | \n\n |
| applied | \nThe user applied for an offer in the financial institution's experience | \neventType leadUuid leadCreatedAt eventCreatedAt financialInstitutionName financialInstitutionUuid | \nunifiedProductType productType productSubType amountInCents | \n
| approved | \nThe user was approved for an offer after applying in the financial institution's experience | \neventType leadUuid leadCreatedAt eventCreatedAt financialInstitutionName financialInstitutionUuid | \nunifiedProductType productType productSubType amountInCents | \n
| listed | \nThe user's loan was listed on the financial institution's marketplace for funding | \neventType leadUuid leadCreatedAt eventCreatedAt financialInstitutionName financialInstitutionUuid | \nunifiedProductType productType productSubType amountInCents | \n
| funded | \nThe user has a loan funded | \neventType leadUuid leadCreatedAt eventCreatedAt financialInstitutionName financialInstitutionUuid | \nunifiedProductType productType productSubType amountInCents | \n
| opened | \nThe user monetizes with a special offer | \nSee under common events | \n\n |
| conversion | \nThis event varies by lender, and will be deprecated. | \neventType leadUuid leadCreatedAt eventCreatedAt financialInstitutionName financialInstitutionUuid | \nunifiedProductType productType productSubType | \n
| lenderQualifiedLead | \nFinancial institution further collected information from a lead | \neventType leadUuid leadCreatedAt eventCreatedAt financialInstitutionName financialInstitutionUuid amountInCents | \nunifiedProductType productType productSubType | \n
![](\"https://api.engine.tech/uiEvent/offerDisplays/39197a3f-d2f4-43eb-9999-7f7a154d79bc/eb0e6cc4-df13-42fe-b254-c58c9b35a3d6/a698f56f-0946-4642-9720-5f280bc8b2e0/pixel.gif\"){kind=tracking}
`\n\nThe URL will always respond successfully with a transparent 1x1 GIF.\n",
"operationId": "createOfferDisplay",
"security": [
{
"publishableBearerToken": []
}
],
"tags": [
"UI Events"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OfferDisplayCreateData"
},
"examples": {
"offerDisplayCreateData": {
"$ref": "#/components/examples/OfferDisplayCreateData"
}
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OfferDisplay"
},
"examples": {
"offerDisplay": {
"$ref": "#/components/examples/OfferDisplay"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedRequest"
}
}
}
},
"/leads/universities": {
"get": {
"x-implemented-by": {
"service": "lead",
"path": "/leads/universities"
},
"summary": "Get university names",
"description": "Get a list of university names that correspond to the specified fragment.\n\nThis is useful for implementing an autocomplete input for the `educationInformation.universityAttended` lead field when searching for student loan refinancing loans. See the [Student Loan Refinancing overview](https://engine.tech/docs/api-reference/#student-loan-refinancing).",
"operationId": "getUniversities",
"security": [
{
"publishableBearerToken": []
}
],
"tags": [
"UI Utils"
],
"parameters": [
{
"name": "name",
"in": "query",
"description": "Fragment of a university name to seach for.",
"schema": {
"type": "string"
}
},
{
"name": "offset",
"in": "query",
"description": "Number of results to skip before the first returned result.",
"schema": {
"type": "integer",
"format": "int64",
"minimum": 0,
"default": 0
}
},
{
"name": "limit",
"in": "query",
"description": "Maximum number of results to return.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 100
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"examples": {
"universityNamesMatchingJohns": {
"$ref": "#/components/examples/UniversityNamesMatchingJohns"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedRequest"
}
}
}
},
"/leads/vehicles/years": {
"get": {
"x-lint-skip": [
"index-endpoint-has-limit"
],
"summary": "Get vehicle years",
"description": "Get all available vehicle years\n\nThis is useful for implementing a select input for vehicle years when searching for auto loan refinancing loans. A valid combination of year, make, model, and trim corresponds to a vehicle UUID that can be used in the `vehicleInformation.vehicleUuid` field. See the [Auto Loan Refinancing overview](https://engine.tech/docs/api-reference/#auto-loan-refinancing).",
"operationId": "getVehicleYears",
"security": [
{
"publishableBearerToken": []
}
],
"tags": [
"UI Utils"
],
"parameters": [
{
"name": "minYear",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "maxYear",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Valid vehicle years",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}
}
},
"/leads/vehicles/makes": {
"get": {
"x-lint-skip": [
"index-endpoint-has-limit"
],
"summary": "Get vehicle makes",
"description": "Get all makes for the given vehicle year\n\nThis is useful for implementing a select input for vehicle makes when searching for auto loan refinancing loans. A valid combination of year, make, model, and trim corresponds to a vehicle UUID that can be used in the `vehicleInformation.vehicleUuid` field. See the [Auto Loan Refinancing overview](https://engine.tech/docs/api-reference/#auto-loan-refinancing).",
"operationId": "getVehicleMakes",
"security": [
{
"publishableBearerToken": []
}
],
"tags": [
"UI Utils"
],
"parameters": [
{
"name": "year",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Makes for given vehicle year",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidRequest"
}
}
}
},
"/leads/vehicles/models": {
"get": {
"x-lint-skip": [
"index-endpoint-has-limit"
],
"summary": "Get vehicle models",
"description": "Get all models for the given vehicle year and make\n\nThis is useful for implementing a select input for vehicle models when searching for auto loan refinancing loans. A valid combination of year, make, model, and trim corresponds to a vehicle UUID that can be used in the `vehicleInformation.vehicleUuid` field. See the [Auto Loan Refinancing overview](https://engine.tech/docs/api-reference/#auto-loan-refinancing).",
"operationId": "getVehicleModels",
"security": [
{
"publishableBearerToken": []
}
],
"tags": [
"UI Utils"
],
"parameters": [
{
"name": "year",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "make",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Models for given vehicle year and make",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidRequest"
}
}
}
},
"/leads/vehicles/trims": {
"get": {
"x-lint-skip": [
"index-endpoint-has-limit"
],
"summary": "Get vehicle trims",
"description": "Get vehicle details, including trims and uuids, for the given year, make, and model\n\nThis is useful for implementing a select input for vehicle trims when searching for auto loan refinancing loans. A valid combination of year, make, model, and trim corresponds to a vehicle UUID that can be used in the `vehicleInformation.vehicleUuid` field. The uuid field returned in successful response objects corresponds to a valid `vehicleUuid`. See the [Auto Loan Refinancing overview](https://engine.tech/docs/api-reference/#auto-loan-refinancing).",
"operationId": "getVehicleTrims",
"security": [
{
"publishableBearerToken": []
}
],
"tags": [
"UI Utils"
],
"parameters": [
{
"name": "year",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "make",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "model",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Vehicle details, including trim and uuid, for the given year, make, model",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VehicleDetails"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidRequest"
}
}
}
},
"/uiUtil/featuredFinancialInstitutions": {
"x-implemented-by": {
"service": "partner-data",
"path": "/userExperience/featuredFinancialInstitutions"
},
"get": {
"summary": "Get featured financial institutions",
"description": "Get a list of featured financial institution names and logos that can be displayed prior to collecting personal information in a search application to improve the user experience.\n",
"operationId": "getFeaturedFinancialInstitutions",
"security": [
{
"publishableBearerToken": []
}
],
"tags": [
"UI Utils"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeaturedFinancialInstitution"
}
},
"examples": {
"featuredFinancialInstitutions": {
"$ref": "#/components/examples/FeaturedFinancialInstitutions"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedRequest"
},
"422": {
"description": "Invalid request",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
}
}
}
}
}