Offer Searches
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
uuidstring · uuidRequired
Header parameters
Api-Versionstring · enumOptionalPossible values:
Responses
200
Success
application/json
An OfferSearch sourced from generic offers customized to a Lead input. Formerly Known As - RateTable
uuidstring · uuidRequired
Primary UUID for an OfferSearch
leadUuidstring · uuidRequired
UUID of the associated Lead
partnerPageUrlstringOptional
Link to the PartnerPage if one exists
embedSnippetstringOptional
offer carousel url encoded embed html snippet
createdAtstring · date-timeOptional
400
Malformed UUID
application/json
401
Unauthorized request
application/json
404
Unknown UUID
get/offerSearches/{uuid}
GET /offerSearches/{uuid} HTTP/1.1
Host: api.engine.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"leadUuid": "123e4567-e89b-12d3-a456-426614174000",
"partnerPageUrl": "text",
"offers": [
{
"recommendationScore": 1,
"rank": 1,
"url": "https://example.com",
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"status": "active",
"version": 1,
"headline": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"productType": "text",
"isMonetized": true,
"legalLanguage": "text",
"unmonetizedUrl": "https://example.com",
"productVersions": [
1
],
"descriptionPoints": [
"text"
],
"productDisplayName": "text",
"financialInstitutionUuid": "123e4567-e89b-12d3-a456-426614174000",
"financialInstitutionImageUrl": "https://example.com",
"financialInstitutionDisplayName": "text"
}
],
"embedSnippet": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"pendingResponses": [
{
"partner": {
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"disclaimer": "text",
"supportsPreSelect": true,
"shouldDisplayPreSelect": true,
"supportsPersonalizedOffers": true,
"imageUrl": "text",
"subtextOverride": "text",
"headquarters": "text",
"assets": "text",
"brandName": "text",
"brandUuid": "123e4567-e89b-12d3-a456-426614174000"
},
"offerCatalogProductTypes": [
"text"
]
}
]
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Api-Versionstring · enumOptionalPossible values:
Body
uuidstring · uuidOptional
Primary UUID for a Lead
sessionUuidstring · uuidOptional
UUID used to link leads across verticals, unique per user per supply sub-account
deviceIdstring · uuidOptional
Unique identifier for the lead's device.
profileUuidstring · uuidOptional
The UUID of the profile that this lead belongs to.
showCapExceededOffersbooleanOptional
Whether offers are appended to a rate table despite having reached their provider cap
Responses
201
Success
application/json
An OfferSearch sourced from generic offers customized to a Lead input. Formerly Known As - RateTable
uuidstring · uuidRequired
Primary UUID for an OfferSearch
leadUuidstring · uuidRequired
UUID of the associated Lead
partnerPageUrlstringOptional
Link to the PartnerPage if one exists
embedSnippetstringOptional
offer carousel url encoded embed html snippet
createdAtstring · date-timeOptional
400
Malformed request
application/json
401
Unauthorized request
application/json
post/offerSearches
POST /offerSearches HTTP/1.1
Host: api.engine.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 4646
{
"productTypes": [
"AlternativeInvestments"
],
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"sessionUuid": "123e4567-e89b-12d3-a456-426614174000",
"deviceId": "123e4567-e89b-12d3-a456-426614174000",
"profileUuid": "123e4567-e89b-12d3-a456-426614174000",
"loanInformation": {
"purpose": "auto",
"loanAmount": 1
},
"personalInformation": {
"firstName": "text",
"lastName": "text",
"aliasFirstName": "text",
"aliasLastName": "text",
"email": "text",
"city": "text",
"state": "AK",
"workPhone": "text",
"primaryPhone": "text",
"bestTimeToCall": "morning",
"address1": "text",
"address2": "text",
"addressMoveInDate": "2026-01-01",
"zipcode": "text",
"monthsAtAddress": 1,
"driversLicenseNumber": "text",
"driversLicenseState": "text",
"ipAddress": "text",
"activeMilitary": true,
"militaryVeteran": true,
"dateOfBirth": "2026-01-01",
"ssn": "text",
"citizenshipStatus": "citizen",
"driversLicenseNumberHash": "text",
"ssnHash": "text"
},
"personalReferenceInformation": {
"firstName": "text",
"lastName": "text",
"primaryPhone": "text",
"relationType": "parent"
},
"mortgageInformation": {
"propertyType": "rent",
"propertyValue": 1,
"mortgageBalance": 1,
"lenderName": "text",
"hasFHALoan": true,
"currentWithLoan": true,
"propertyStatus": "own_outright",
"mortgageType": "purchase",
"mortgageAmount": 1,
"downPaymentAmount": 1,
"propertyState": "text",
"propertyCounty": "text",
"propertyAddress1": "text",
"propertyAddress2": "text",
"propertyZipcode": "text",
"propertyCity": "text",
"refinanceAmount": 1,
"cashOutAmount": 1,
"occupancyType": "primary",
"refinanceType": "cash_out",
"propertySearchStatus": "found",
"numUnits": 1,
"closingDate": "2026-01-01",
"purchaseStatus": "no_offer",
"purchaseDate": "2026-01-01",
"monthlyHoaFee": 1,
"mortgageCompany": "text",
"mortgageEscrowAmount": 1,
"includeFhaLoans": true,
"includeVaLoans": true,
"requestedLoanTerms": [
"ten_year_fixed"
],
"mortechCreditRating": "Excellent (780-850)"
},
"creditCardInformation": {
"allowAnnualFee": true,
"cardPurposes": [
"balance_transfer"
]
},
"savingsInformation": {
"minDepositAmount": 1,
"maxDepositAmount": 1
},
"creditInformation": {
"providedCreditRating": "excellent",
"providedNumericCreditScore": 1
},
"financialInformation": {
"employmentStatus": "employed",
"employmentPayFrequency": "weekly",
"annualIncome": 1,
"monthlyNetIncome": 1,
"bankName": "text",
"bankRoutingNumber": "text",
"bankAccountType": "checking",
"creditCardDebt": 1,
"monthsAtBank": 1,
"bankAccountNumber": "text",
"monthlyDebt": 1,
"totalAssets": 1,
"monthlyHousingPayment": 1,
"availableAssets": 1,
"additionalIncome": 1,
"additionalIncomeFrequency": "weekly",
"hasDirectDeposit": true,
"totalUnsecuredDebt": 1,
"bankAccountNumberHash": "text"
},
"employmentInformation": {
"employerName": "text",
"employerAddress": "text",
"employerAddress2": "text",
"employerCity": "text",
"employerPhone": "text",
"employerState": "text",
"employerZip": "text",
"jobTitle": "text",
"monthsEmployed": 1,
"directDeposit": true,
"payDate1": "2026-01-01",
"payDate2": "2026-01-01",
"startDate": "2026-01-01"
},
"legalInformation": {
"consentsToFcra": true,
"consentsToSms": true,
"consentsToTcpa": true,
"batchConsentVersion": "v1",
"fcraLanguage": "text",
"tcpaLanguage": "text",
"batchConsentLanguage": "text"
},
"educationInformation": {
"educationLevel": "high_school",
"graduateDegreeType": "doctor_of_medicine",
"universityOpeId": "text",
"graduateGraduationDate": "2026-01-01",
"graduateLastAttendedDate": "2026-01-01",
"graduateUniversityAttended": "text",
"graduateUniversityOpeId": "text",
"undergraduateGraduationDate": "2026-01-01",
"undergraduateLastAttendedDate": "2026-01-01",
"undergraduateUniversityAttended": "text",
"undergraduateUniversityOpeId": "text"
},
"coApplicantInformation": {
"firstName": "text",
"lastName": "text",
"dateOfBirth": "2026-01-01",
"annualIncome": 1,
"streetAddress1": "text",
"streetAddress2": "text",
"city": "text",
"state": "AK",
"zipcode": "text"
},
"healthInformation": {
"gender": "male",
"heightInInches": 1,
"weightInPounds": 1,
"tobaccoSmoker": true
},
"vehicleInformation": {
"monthlyPayment": 1,
"estimatedMileage": 1,
"vehicleIdentificationNumber": "text",
"vehicleUuid": "123e4567-e89b-12d3-a456-426614174000"
},
"autoInsuranceInformation": {
"numberOfVehicles": 1,
"hasAutoInsurance": true,
"currentIssuer": "text",
"policyHolderInformation": {
"isMilitary": true,
"isHomeOwner": true
}
},
"lifeInsuranceInformation": {
"carrierUuid": "123e4567-e89b-12d3-a456-426614174000",
"duration": 1,
"policyAmount": 1,
"packageTypes": [
"basic"
]
},
"refinanceLoans": [
{
"accountNumber": "text",
"incomeBasedRepayment": true,
"interestRate": 1,
"loanAmount": 1,
"loanServicer": "text",
"loanType": "federal_student_loan",
"nextPaymentAmount": 1,
"nextPaymentDate": "2026-01-01"
}
],
"identificationInformation": {
"idNumber": "text",
"idState": "text",
"idType": "driver_license"
},
"clientTags": {
"subid": [
"123"
]
},
"sessionInformation": {
"ipAddress": "text",
"userAgent": "text",
"browserFingerprint": "text"
},
"showCapExceededOffers": true
}{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"leadUuid": "123e4567-e89b-12d3-a456-426614174000",
"partnerPageUrl": "text",
"offers": [
{
"recommendationScore": 1,
"rank": 1,
"url": "https://example.com",
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"status": "active",
"version": 1,
"headline": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"productType": "text",
"isMonetized": true,
"legalLanguage": "text",
"unmonetizedUrl": "https://example.com",
"productVersions": [
1
],
"descriptionPoints": [
"text"
],
"productDisplayName": "text",
"financialInstitutionUuid": "123e4567-e89b-12d3-a456-426614174000",
"financialInstitutionImageUrl": "https://example.com",
"financialInstitutionDisplayName": "text"
}
],
"embedSnippet": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"pendingResponses": [
{
"partner": {
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"disclaimer": "text",
"supportsPreSelect": true,
"shouldDisplayPreSelect": true,
"supportsPersonalizedOffers": true,
"imageUrl": "text",
"subtextOverride": "text",
"headquarters": "text",
"assets": "text",
"brandName": "text",
"brandUuid": "123e4567-e89b-12d3-a456-426614174000"
},
"offerCatalogProductTypes": [
"text"
]
}
]
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
uuidstring · uuidRequired
The UUID of the lead
Header parameters
Api-Versionstring · enumOptionalPossible values:
Body
uuidstring · uuidOptional
Primary UUID for a Lead
sessionUuidstring · uuidOptional
UUID used to link leads across verticals, unique per user per supply sub-account
deviceIdstring · uuidOptional
Unique identifier for the lead's device.
profileUuidstring · uuidOptional
The UUID of the profile that this lead belongs to.
showCapExceededOffersbooleanOptional
Whether offers are appended to a rate table despite having reached their provider cap
Responses
201
Success
application/json
An OfferSearch sourced from generic offers customized to a Lead input. Formerly Known As - RateTable
uuidstring · uuidRequired
Primary UUID for an OfferSearch
leadUuidstring · uuidRequired
UUID of the associated Lead
partnerPageUrlstringOptional
Link to the PartnerPage if one exists
embedSnippetstringOptional
offer carousel url encoded embed html snippet
createdAtstring · date-timeOptional
400
Malformed request
application/json
401
Unauthorized request
application/json
post/leads/{uuid}/offerSearches
POST /leads/{uuid}/offerSearches HTTP/1.1
Host: api.engine.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 4646
{
"productTypes": [
"AlternativeInvestments"
],
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"sessionUuid": "123e4567-e89b-12d3-a456-426614174000",
"deviceId": "123e4567-e89b-12d3-a456-426614174000",
"profileUuid": "123e4567-e89b-12d3-a456-426614174000",
"loanInformation": {
"purpose": "auto",
"loanAmount": 1
},
"personalInformation": {
"firstName": "text",
"lastName": "text",
"aliasFirstName": "text",
"aliasLastName": "text",
"email": "text",
"city": "text",
"state": "AK",
"workPhone": "text",
"primaryPhone": "text",
"bestTimeToCall": "morning",
"address1": "text",
"address2": "text",
"addressMoveInDate": "2026-01-01",
"zipcode": "text",
"monthsAtAddress": 1,
"driversLicenseNumber": "text",
"driversLicenseState": "text",
"ipAddress": "text",
"activeMilitary": true,
"militaryVeteran": true,
"dateOfBirth": "2026-01-01",
"ssn": "text",
"citizenshipStatus": "citizen",
"driversLicenseNumberHash": "text",
"ssnHash": "text"
},
"personalReferenceInformation": {
"firstName": "text",
"lastName": "text",
"primaryPhone": "text",
"relationType": "parent"
},
"mortgageInformation": {
"propertyType": "rent",
"propertyValue": 1,
"mortgageBalance": 1,
"lenderName": "text",
"hasFHALoan": true,
"currentWithLoan": true,
"propertyStatus": "own_outright",
"mortgageType": "purchase",
"mortgageAmount": 1,
"downPaymentAmount": 1,
"propertyState": "text",
"propertyCounty": "text",
"propertyAddress1": "text",
"propertyAddress2": "text",
"propertyZipcode": "text",
"propertyCity": "text",
"refinanceAmount": 1,
"cashOutAmount": 1,
"occupancyType": "primary",
"refinanceType": "cash_out",
"propertySearchStatus": "found",
"numUnits": 1,
"closingDate": "2026-01-01",
"purchaseStatus": "no_offer",
"purchaseDate": "2026-01-01",
"monthlyHoaFee": 1,
"mortgageCompany": "text",
"mortgageEscrowAmount": 1,
"includeFhaLoans": true,
"includeVaLoans": true,
"requestedLoanTerms": [
"ten_year_fixed"
],
"mortechCreditRating": "Excellent (780-850)"
},
"creditCardInformation": {
"allowAnnualFee": true,
"cardPurposes": [
"balance_transfer"
]
},
"savingsInformation": {
"minDepositAmount": 1,
"maxDepositAmount": 1
},
"creditInformation": {
"providedCreditRating": "excellent",
"providedNumericCreditScore": 1
},
"financialInformation": {
"employmentStatus": "employed",
"employmentPayFrequency": "weekly",
"annualIncome": 1,
"monthlyNetIncome": 1,
"bankName": "text",
"bankRoutingNumber": "text",
"bankAccountType": "checking",
"creditCardDebt": 1,
"monthsAtBank": 1,
"bankAccountNumber": "text",
"monthlyDebt": 1,
"totalAssets": 1,
"monthlyHousingPayment": 1,
"availableAssets": 1,
"additionalIncome": 1,
"additionalIncomeFrequency": "weekly",
"hasDirectDeposit": true,
"totalUnsecuredDebt": 1,
"bankAccountNumberHash": "text"
},
"employmentInformation": {
"employerName": "text",
"employerAddress": "text",
"employerAddress2": "text",
"employerCity": "text",
"employerPhone": "text",
"employerState": "text",
"employerZip": "text",
"jobTitle": "text",
"monthsEmployed": 1,
"directDeposit": true,
"payDate1": "2026-01-01",
"payDate2": "2026-01-01",
"startDate": "2026-01-01"
},
"legalInformation": {
"consentsToFcra": true,
"consentsToSms": true,
"consentsToTcpa": true,
"batchConsentVersion": "v1",
"fcraLanguage": "text",
"tcpaLanguage": "text",
"batchConsentLanguage": "text"
},
"educationInformation": {
"educationLevel": "high_school",
"graduateDegreeType": "doctor_of_medicine",
"universityOpeId": "text",
"graduateGraduationDate": "2026-01-01",
"graduateLastAttendedDate": "2026-01-01",
"graduateUniversityAttended": "text",
"graduateUniversityOpeId": "text",
"undergraduateGraduationDate": "2026-01-01",
"undergraduateLastAttendedDate": "2026-01-01",
"undergraduateUniversityAttended": "text",
"undergraduateUniversityOpeId": "text"
},
"coApplicantInformation": {
"firstName": "text",
"lastName": "text",
"dateOfBirth": "2026-01-01",
"annualIncome": 1,
"streetAddress1": "text",
"streetAddress2": "text",
"city": "text",
"state": "AK",
"zipcode": "text"
},
"healthInformation": {
"gender": "male",
"heightInInches": 1,
"weightInPounds": 1,
"tobaccoSmoker": true
},
"vehicleInformation": {
"monthlyPayment": 1,
"estimatedMileage": 1,
"vehicleIdentificationNumber": "text",
"vehicleUuid": "123e4567-e89b-12d3-a456-426614174000"
},
"autoInsuranceInformation": {
"numberOfVehicles": 1,
"hasAutoInsurance": true,
"currentIssuer": "text",
"policyHolderInformation": {
"isMilitary": true,
"isHomeOwner": true
}
},
"lifeInsuranceInformation": {
"carrierUuid": "123e4567-e89b-12d3-a456-426614174000",
"duration": 1,
"policyAmount": 1,
"packageTypes": [
"basic"
]
},
"refinanceLoans": [
{
"accountNumber": "text",
"incomeBasedRepayment": true,
"interestRate": 1,
"loanAmount": 1,
"loanServicer": "text",
"loanType": "federal_student_loan",
"nextPaymentAmount": 1,
"nextPaymentDate": "2026-01-01"
}
],
"identificationInformation": {
"idNumber": "text",
"idState": "text",
"idType": "driver_license"
},
"clientTags": {
"subid": [
"123"
]
},
"sessionInformation": {
"ipAddress": "text",
"userAgent": "text",
"browserFingerprint": "text"
},
"showCapExceededOffers": true
}{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"leadUuid": "123e4567-e89b-12d3-a456-426614174000",
"partnerPageUrl": "text",
"offers": [
{
"recommendationScore": 1,
"rank": 1,
"url": "https://example.com",
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"status": "active",
"version": 1,
"headline": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"productType": "text",
"isMonetized": true,
"legalLanguage": "text",
"unmonetizedUrl": "https://example.com",
"productVersions": [
1
],
"descriptionPoints": [
"text"
],
"productDisplayName": "text",
"financialInstitutionUuid": "123e4567-e89b-12d3-a456-426614174000",
"financialInstitutionImageUrl": "https://example.com",
"financialInstitutionDisplayName": "text"
}
],
"embedSnippet": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"pendingResponses": [
{
"partner": {
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"disclaimer": "text",
"supportsPreSelect": true,
"shouldDisplayPreSelect": true,
"supportsPersonalizedOffers": true,
"imageUrl": "text",
"subtextOverride": "text",
"headquarters": "text",
"assets": "text",
"brandName": "text",
"brandUuid": "123e4567-e89b-12d3-a456-426614174000"
},
"offerCatalogProductTypes": [
"text"
]
}
]
}Last updated
Was this helpful?