API Specifications

To search for credit cards, you should set productTypes to ["credit_card"] on the lead and make requests to: https://api.engine.tech/leads/rateTables

If you have already created a lead and have a lead UUID, you can make requests to: https://api.engine.tech/leads/:leadUuid/rateTables

Passing PII (e.g., name, address, annual income, DOB) into the request allows leads to be evaluated for credit cards through the issuer's underwriting evaluations and receive personalized offers. As PII is added to the lead, Engine and its partners may return, either or both, personalized offers (with a higher probability of issuer approval) and ITA offers.

In the simplest case, you need only include "productTypes": ["credit_card"] in the request body to return some ITA credit card offers (identified by isITA: true).

For more information, see the official API documentation:

https://engine.tech/docs/api-reference/#submit-a-lead-and-get-a-rate-table

Credit Card Search Request

Sample request to POST https://api.engine.tech/leads/rateTables/

curl --location 'https://api.engine.tech/leads/rateTables' \
--header 'Authorization: Bearer <AUTH_TOKEN>' \
--header 'Content-Type: application/json' \
--data 
{
   "productTypes": [
       "credit_card"
   ],
   "creditCardInformation": {
       "cardPurposes": [
           "travel_incentives"
       ]
   },
   "personalInformation": {
       "firstName": "John",
       "lastName": "Doe",
       "address1": "45 West 21st Street",
       "address2": "5th Floor",
       "city": "New York",
       "state": "NY",
       "email": "[email protected]",
       "zipcode": "10011",
       "dateOfBirth": "1985-10-09",
       "primaryPhone": "2125556789"
   },
   "financialInformation": {
       "annualIncome": 130000
   },
   "creditInformation": {
       "providedCreditRating": "excellent"
   },
   "legalInformation": {
       "consentsToFcra": true,
       "fcraLanguage": "I consent to Engine by MoneyLion's Credit Authorization, which authorizes Engine by MoneyLion and its marketplace partners to obtain consumer report information about me from consumer reporting agencies, now, and periodically in the future, for the purpose of providing me with personalized offers for financial products and services."
   },
   "clientTags": {
        "subId": ["2ee169ef"]
   }  
}

Schema for POST To /leads/rateTables

• ✅ = Required

• ⭕ = Optional

Field	Type	For ITA	For personalized offers	Description	Example
productTypes	array of strings	✅	✅	Types of products the user is interested in, such as credit cards.	["credit_card"]
personalInformation .firstName	string	⭕	✅	User's first name. This is required only if the user is interested in preselected offers.	John
personalInformation .lastName	string	⭕	✅	User's last name. This is required only if the user is interested in preselected offers.	Doe
personalInformation .email	string	⭕	✅	User's email address. This is required only if the user is interested in preselected offers.	[email protected]
personalInformation .city	string	⭕	✅	City of the user's residence. This is required only if the user is interested in preselected offers.	New York
personalInformation .state	string	⭕	✅	State of the user's residence. This is required only if the user is interested in preselected offers.	NY
personalInformation .primaryPhone	string	⭕	✅	Primary phone number of the user. This is required only if the user is interested in preselected offers.	2125556789
personalInformation .address1	string	⭕	✅	Primary address of the user. This is required only if the user is interested in preselected offers.	45 West 21st Street
personalInformation .address2	string	⭕	⭕	Secondary address of the user.	5th Floor
personalInformation .zipcode	string	⭕	✅	Zipcode of the user's residence.This is required only if the user is interested in preselected offers.	10011
personalInformation .dateOfBirth	string	⭕	✅	Date of birth of the user in YYYY-MM-DD format.This is required only if the user is interested in preselected offers.	1993-10-09
creditInformation .providedCreditRating	string	⭕	⭕	User's self-provided credit rating. Options include: excellent good fair poor limited unknown	excellent
creditCardInformation .cardPurposes	array	⭕	⭕	User’s selected card benefit. Options include: balance_transfer cash_back earning_rewards improve_credit low_interest new_to_credit student travel_incentives other	"travel_incentives"
financialInformation .annualIncome	integer	⭕	✅	User's annual income.This is required only if the user is interested in preselected offers.	75000
legalInformation .consentsToFcra	boolean	⭕	✅	Indicates if the user consents to FCRA terms.	TRUE
legalInformation .fcraLanguage	string	⭕	✅	FCRA consent language.	I consent to Engine by MoneyLion’s Credit Authorization, which authorizes Engine by MoneyLion and its marketplace partners to obtain consumer report information about me from consumer reporting agencies, now, and periodically in the future, for the purpose of providing me with personalized offers for financial products and services.
legalInformation .consentsToTcpa	boolean	⭕	⭕	Indicates if the user consents to TCPA terms
legalInformation .tcpaLanguage	string	⭕	⭕	TCPA consent language	By selecting this checkbox, I consent for ML Enterprise Inc. to send text messages to my phone number, including for marketing purposes, regarding services from ML Enterprise Inc. I agree that such text messages may be sent by automated dialing systems. I understand that my consent is not required as a condition to purchase products or services. To opt out, call [phone] or reply STOP. For info, reply HELP. Message and data rates may apply. Message frequency varies. For additional information, please review our SMS Terms and Privacy Policy.
clientTags .subId	array of strings	⭕	⭕	Client-defined tags for tracking purposes.	["2ee169ef"]

Credit Card Response

Partners building a Native API integration must make a secondary request to Engine’s API to retrieve offer information. Below are instructions for this secondary request:

• Capture the uuid returned in the initial API response (please note: uuid is distinct from leadUuid - uuid denotes the Rate Table UUID)

• Execute a GET request to Engine’s Offers Endpoint: https://api.engine.tech/originator/rateTables/:uuid
• Poll the endpoint once every second until pendingResponses is empty (may take up to 15 seconds)

Sample 200 OK response

{
   "uuid": "2c6cb6e4-0aa2-4ab5-9109-8679de537e10",
   "leadUuid": "f823a7c0-586a-4fc3-9cfa-c38694b80b2c",
   "loanOffers": [],
   "specialOffers": [],
   "savingsOffers": [],
   "creditCardOffers": [
       {
           "uuid": "d4cf1716-41c0-4125-a96f-6904a4d89329",
           "partner": {
               "uuid": "d4cf1716-41c0-4125-a96f-6904a4d89329",
               "name": "Issuer Name",
               "description": "Issuer Description",
               "disclaimer": "Issuer Disclaimer",
               "supportsPersonalizedOffers": true,
               "supportsPreSelect": false,
               "shouldDisplayPreSelect": false,
               "imageUrl": "https://images.evenfinancial.com/logos/dev/card.png"
           },
           "productType": "credit_card",
           "productSubType": "credit_card",
           "url": "https://offers.moneylion.com/ref/1987b283-ba27-4bd4-8ea8-34771b0d5dda",
           "recommendationScore": 24700,
           "details": {
               "cardName": "Credit Card Name that will be displayed on the offer",
               "cardImageUrl": "www.included.com/image",
               "cardPurposes": [
                   "improve_credit",
                   "new_to_credit"
               ],
               "ratesUrl": "https://www.xyz.com/terms-condition",
               "maxPurchaseApr": 35.9,
               "minPurchaseApr": 35.9,
               "purchaseAprText": "14.99% - 29.99% Regular APR",
               "maxPurchaseIntroApr": 0,
               "minPurchaseIntroApr": 0,
               "purchaseIntroAprTerm": 12,
               "purchaseIntroAprTermUnit": "month",
               "purchaseIntroAprText": "Get 0% Intro APR for 15 months on purchases",
               "maxCashAdvanceApr": 15,
               "minCashAdvanceApr": 15,
               "cashAdvanceAprText": "Variable",
               "maxCashAdvanceIntroApr": 0,
               "minCashAdvanceIntroApr": 0,
               "cashAdvanceIntroAprTerm": 12,
               "cashAdvanceIntroAprTermUnit": "month",
               "cashAdvanceIntroAprText": "Variable",
               "maxBalanceTransferApr": 15,
               "minBalanceTransferApr": 15,
               "balanceTransferAprText": "15% to 20% Variable APR, based on your creditworthiness",
               "maxBalanceTransferIntroApr": 0,
               "minBalanceTransferIntroApr": 0,
               "balanceTransferIntroAprTerm": 12,
               "balanceTransferIntroAprTermUnit": "month",
               "balanceTransferIntroAprText": "Get 0% Intro APR for 12 months on balance transfers",
               "balanceTransferFee": 20,
               "balanceTransferFeeDisclaimer": "Up to 20%, See Terms",
               "annualFee": 100,
               "annualIntroFee": 0,
               "annualIntroFeeTerm": 1,
               "purchaseAprDisclaimer": "See Terms",
               "details": [
                   "Earn unlimited 2X miles on every purchase, every day",
                   "Easy application! Get a response in 60 seconds or less.",
                   "Use everywhere Mastercard(r) is accepted; in-store, online, and in-app.",
                   "No security deposit required! Keep more money in your pocket.",
                   "24/7 online access to your account making it easy to check balances."
               ],
               "cardType": "mastercard",
               "recommendedCreditRatings": [
                   "limited",
                   "poor",
                   "fair",
                   "good"
               ],
               "preQualified": false,
               "preApproved": true,
               "preSelected": false,
               "aprType": "Variable",
               "isITA": false
           }
       },
       {
           "uuid": "8d7eb63a-a25f-4ea3-9df7-2eb96970164e",
           "partner": {
               "uuid": "ebc180cb-7039-451e-b52d-207aedad04a7",
               "name": "Issuer name",
               "description": "Issuer description",
               "disclaimer": "Issuer disclaimer",
               "supportsPersonalizedOffers": false,
               "supportsPreSelect": false,
               "shouldDisplayPreSelect": false,
               "imageUrl": "https://images.evenfinancial.com/logos/dev/image.png"
           },
           "productType": "credit_card",
           "productSubType": "credit_card",
           "url": "https://offers.moneylion.com/ref/d52a7ad2-3665-4265-8d5c-40c7b75658e8",
           "recommendationScore": 16000,
           "details": {
               "cardName": "Credit card name that will be displayed on the offer",
               "cardImageUrl": "https://images.evenfinancial.com/logos/dev/cardimage.png",
               "cardPurposes": [
                   "new_to_credit",
                   "improve_credit"
               ],
               "ratesUrl": "https://www.destinycard.com/terms-condition?product=213",
               "maxPurchaseApr": 20,
               "minPurchaseApr": 15,
               "purchaseAprText": "15% or 20%",
               "purchaseAprDisclaimer": "See Terms",
               "maxAnnualFee": 0,
               "minAnnualFee": 0,
               "annualFeeDisclaimer": "$85 - $175 for first year, $49 annually thereafter.",
               "annualIntroFee": 0,
               "annualIntroFeeTerm": 1,
               "introOfferAmount": 50000,
               "introOfferType": "miles",
               "introOfferDisclaimer": "Earn 50,000 bonus miles after $1,500 in purchases within the first 3 months of account opening.",
               "details": [
                   "Build your access to credit - $200 credit limit.",
                   "Easy application! Get a response in 60 seconds or less.",
                   "Does your credit need a little work? No problem!",
                   "Use nationwide wherever the card is accepted.",
                   "Fast and Easy Application Process",
                   "Zero Fraud Liability for Unauthorized Charges"
               ],
               "cardType": "visa",
               "recommendedCreditRatings": [
                   "fair",
                   "poor",
                   "limited",
                   "good"
               ],
               "recommendedCreditRatingDisclaimer": "Tooltip for credit rating",
               "preQualified": false,
               "preApproved": false,
               "preSelected": false,
               "aprType": "variable",
               "minDepositAmount": 200,
               "minDepositDisclaimer": "See Terms",
               "rewardsDescription": "1% - 5% Cashback",
               "rewardsDisclaimer": "See Terms",
               "badges": [
                   "Good for cash back rewards"
               ],
               "isITA": true
           }
       }
   ],
   "lifeInsuranceOffers": [],
   "lineOfCreditOffers": [],
   "loanOffers": [],
   "mortgageOffers": [],
   "savingsOffers": [],
   "specialOffers": [],
   "pendingOriginators": [],
   "pendingResponses": [
       {
           "partner": {
               "uuid": "b8a65180-6dae-44eb-ac97-97117d11f4d0",
               "name": "Issuer Name",
               "description": "Issuer Description",
               "disclaimer": "Issuer Disclaimer",
               "supportsPersonalizedOffers": true,
               "supportsPreSelect": false,
               "shouldDisplayPreSelect": true,
               "imageUrl": "https://images.engine.tech/logos/dev/card.png"
           },
           "productTypes": [
               "credit_card"
           ]
       }
   ]
}

Credit Cards Response Schema

uuid	string	Rate table UUID	"123e4567-e89b-12d3-a456-426614174000"
leadUuid	string	Unique identifier for the lead associated with the credit card offer.	"123e4567-e89b-12d3-a456-426614174001"
creditCardOffers .uuid	string	Unique identifier for the credit card offer.	"123e4567-e89b-12d3-a456-426614174002"
creditCardOffers .partner .uuid	string	Unique identifier for the issuer offering the credit card.	"123e4567-e89b-12d3-a456-426614174003"
creditCardOffers .partner .name	string	Name of the issuer offering the credit card.	"Bank of America"
creditCardOffers .partner .description	string	Description of the issuer.	"A leading global bank."
creditCardOffers .partner .disclaimer	string	Disclaimer for the issuer’s offers.	"Terms and conditions apply."
creditCardOffers .partner .supportsPersonalizedOffers	boolean	Not applicable for Credit Cards
creditCardOffers .partner .shouldDisplayPreSelect	boolean	Not applicable for Credit Cards
creditCardOffers .partner .supportsPreSelect	boolean	Not applicable for Credit Cards
creditCardOffers .partner .imageUrl	string [url]	URL of the issuer's logo or image.	"https://example.com/partner-logo.png"
creditCardOffers .productType	string	Type of the credit card product.	"credit_card"
creditCardOffers .productSubType	string	Subtype of the credit card product.	"credit_card"
creditCardOffers .url	string [url]	The click URL for the card offer to take the lead to the issuers sign up funnel	"https://example.com/card-offer"
creditCardOffers .recommendationScore	number	Each offer has a recommendation score. We recommend displaying the offers with the highest recommendation score at the top as they have higher probability of conversion. Our rate table response is already structured to return offers from highest to lowest recommendation score for optimal presentation.
creditCardOffers .details .cardName	string	The card name that will be displayed on the offer	"Cash Back Rewards Card"
creditCardOffers .details .cardImageUrl	string [url]	URL of the card image	"https://example.com/card-image.png"
creditCardOffers .details .cardPurposes	CardPurpose array	List of benefits the card offers. Options include: balance_transfer cash_back earning_rewards improve_credit low_interest new_to_credit student travel_incentives	["cash_back", "travel_incentives"]
creditCardOffers .details .ratesUrl	string [url]	External link to card rates, terms, and conditions	"https://example.com/rates"
creditCardOffers .details .maxPurchaseApr	number [double]	Maximum purchase APR in percentage
creditCardOffers .details .minPurchaseApr	number [double]	Minimum purchase APR in percentage
creditCardOffers .details .purchaseAprText	string	Description of the purchase APR
creditCardOffers .details .purchaseAprDisclaimer	string	The disclaimer goes in the tooltip of APR field	Please see mocks and card stats section for examples
creditCardOffers .details .maxPurchaseIntroApr	number [double]	Maximum introductory purchase APR in percentage
creditCardOffers .details.minPurchaseIntroApr	number [double]	Minimum introductory purchase APR in percentage
creditCardOffers .details .purchaseIntroAprTerm	integer [int32]	Introductory purchase APR term length
creditCardOffers .details .purchaseIntroAprTermUnit	TermUnit	Options include: day month year open
creditCardOffers .details .purchaseIntroAprText	string	Description of the introductory purchase APR
creditCardOffers .details .maxCashAdvanceApr	number [double]	Maximum cash advance APR in percentage
creditCardOffers .details .minCashAdvanceApr	number [double]	Minimum cash advance APR in percentage
creditCardOffers .details .cashAdvanceAprText	string	Description of the cash advance APR
creditCardOffers .details .maxCashAdvanceIntroApr	number [double]	Maximum introductory cash advance APR in percentage
creditCardOffers .details .minCashAdvanceIntroApr	number [double]	Minimum introductory cash advance APR in percentage
creditCardOffers .details .cashAdvanceIntroAprTerm	integer [int32]	Introductory cash advance APR term length
creditCardOffers .details .cashAdvanceIntroAprTermUnit	TermUnit	Options include: day month year open
creditCardOffers .details .cashAdvanceIntroAprText	string	Description of the introductory cash advance APR
creditCardOffers .details .maxBalanceTransferApr	number [double]	Maximum balance transfer APR in percentage
creditCardOffers .details .minBalanceTransferApr	number [double]	Minimum balance transfer APR in percentage
creditCardOffers .details .balanceTransferAprText	string	Description of the balance transfer APR
creditCardOffers .details .maxBalanceTransferIntroApr	number [double]	Maximum introductory balance transfer APR in percentage
creditCardOffers .details .minBalanceTransferIntroApr	number [double]	Minimum introductory balance transfer APR in percentage
creditCardOffers .details .balanceTransferIntroAprTerm	integer [int32]	Introductory balance transfer APR term length
creditCardOffers .details .balanceTransferIntroAprTermUnit	TermUnit	Options include: day month year open
creditCardOffers .details .balanceTransferIntroAprText	string	Description of the introductory balance transfer APR
creditCardOffers .details .balanceTransferFee	number [double]	Balance transfer fee as a percentage
creditCardOffers .details .balanceTransferFeeDisclaimer	string	The disclaimer goes in the tooltip of Balance Transfer field if provided	Please see mocks and card stats section for examples
creditCardOffers .details .maxAnnualFee	number [double]	Maximum annual fee in dollars
creditCardOffers .details .minAnnualFee	number [double]	Minimum annual fee in dollars
creditCardOffers .details .annualFeeDisclaimer	string	Disclaimer for the annual fee goes in the tooltip if provided
creditCardOffers .details .annualIntroFee	number [double]	Introductory annual fee in dollars
creditCardOffers .details .annualIntroFeeTerm	integer [int32]	Number of years the introductory annual fee is in effect
creditCardOffers .details .introOfferAmount	number [double]	Amount of the introductory offer
creditCardOffers .details .introOfferText	string	Description of the introductory offer
creditCardOffers .details .introOfferDisclaimer	string	The disclaimer goes in the tooltip of Intro offer field if provided	Please see mocks and card stats section for examples
creditCardOffers .details .introOfferType	IntroOfferType	Options include: miles points statement_credit
creditCardOffers .details .details	string array	List of card features which must be prominently displayed with the offer
creditCardOffers .details .additionalDetails	string array	List of card features which must be displayed with the offer
creditCardOffers .details .cardType	CardType	Type of card, options include: visa mastercard american_express discover
creditCardOffers .details .aprType	AprType	Variable fixed regular
creditCardOffers .details .recommendedCreditRatings	ProvidedCreditRating array	Recommended credit ratings for the card. Options include: excellent good fair poor limited unknown
creditCardOffers .details .recommendedCreditRatingsDisclaimer	string	This goes in the tooltip for Recommended credit rating field if provided
creditCardOffers .details .preQualified	boolean	Good chance of approval	We recommend showing this disclaimer to the end user - “Your credit profile suggests you’re likely to be approved for this offer. Final approval will still require a credit check and verification of your financial details by the issuing bank.”
creditCardOffers .details .preApproved	boolean	Excellent chance of approval	We recommend showing this disclaimer to the end user - “We have conducted a preliminary review based on the information you provided and think that you have an excellent chance of being approved for this offer. Final approval will still require a credit check and verification of your financial details by the issuing bank.”
creditCardOffers .details .preSelected	boolean	Moderate chance of approval	We recommend showing this disclaimer to the end user - “Based on your credit profile, there is a reasonable chance you may be approved for this offer. Final approval will still require a credit check and verification of your financial details by issuing bank.”
creditCardOffers .details .rewardsDescription	string	Description of rewards associated with the card
creditCardOffers .details .rewardsDisclaimer	string	The disclaimer can be used for the tooltip of Rewards field. It will be displayed if provided	Please see mocks and card stats section for examples
creditCardOffers .details .minDepositAmount	number [double]	Minimum deposit required in dollars
creditCardOffers .details .minDepositDisclaimer	string	The disclaimer can be used for the tooltip of Min Deposit field	Please see mocks and card stats section for examples
creditCardOffers .details .badges	string array	Badges can be shown on top of every card to highlight key benefits of the card. These are available for ITA offers.	Good for cashback rewards Good for building credit
creditCardOffers .details .isITA	boolean	If true = static offer If false = personalized offer