# 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`<br>

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

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.<br>

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`).<br>

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  <br>

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": "test@gmail.com",
       "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"]
   }  
}
```

<br>

Schema for `POST To /leads/rateTables`

* ✅ = Required
* ⭕ = Optional<br>

<table data-header-hidden><thead><tr><th width="152.69140625">Field</th><th width="92.9296875"></th><th width="79.42578125"></th><th width="72.7109375"></th><th></th><th></th></tr></thead><tbody><tr><td><strong>Field</strong></td><td><strong>Type</strong></td><td><strong>For ITA</strong></td><td><strong>For personalized offers</strong></td><td><strong>Description</strong></td><td><strong>Example</strong></td></tr><tr><td>productTypes</td><td>array of strings</td><td>✅</td><td>✅</td><td>Types of products the user is interested in, such as credit cards.</td><td>["credit_card"]</td></tr><tr><td><p>personalInformation</p><p>.firstName</p></td><td>string</td><td>⭕ </td><td>✅</td><td>User's first name. This is required only if the user is interested in preselected offers.</td><td>John</td></tr><tr><td><p>personalInformation</p><p>.lastName</p></td><td>string</td><td>⭕ </td><td>✅ </td><td>User's last name. This is required only if the user is interested in preselected offers.</td><td>Doe</td></tr><tr><td><p>personalInformation</p><p>.email</p></td><td>string</td><td>⭕</td><td>✅</td><td>User's email address. This is required only if the user is interested in preselected offers.</td><td>john@example.com</td></tr><tr><td><p>personalInformation</p><p>.city</p></td><td>string</td><td>⭕</td><td>✅</td><td>City of the user's residence. This is required only if the user is interested in preselected offers.</td><td>New York</td></tr><tr><td><p>personalInformation</p><p>.state</p></td><td>string</td><td>⭕ </td><td>✅</td><td>State of the user's residence. This is required only if the user is interested in preselected offers.</td><td>NY</td></tr><tr><td><p>personalInformation</p><p>.primaryPhone</p></td><td>string</td><td>⭕</td><td>✅</td><td>Primary phone number of the user. This is required only if the user is interested in preselected offers.</td><td>2125556789</td></tr><tr><td><p>personalInformation</p><p>.address1</p></td><td>string</td><td>⭕</td><td>✅</td><td>Primary address of the user. This is required only if the user is interested in preselected offers.</td><td>45 West 21st Street</td></tr><tr><td><p>personalInformation</p><p>.address2</p></td><td>string</td><td>⭕</td><td>⭕</td><td>Secondary address of the user.</td><td>5th Floor</td></tr><tr><td><p>personalInformation</p><p>.zipcode</p></td><td>string</td><td>⭕</td><td>✅</td><td>Zipcode of the user's residence.This is required only if the user is interested in preselected offers.</td><td>10011</td></tr><tr><td><p>personalInformation</p><p>.dateOfBirth</p></td><td>string</td><td>⭕</td><td>✅</td><td>Date of birth of the user in YYYY-MM-DD format.This is required only if the user is interested in preselected offers.</td><td>1993-10-09</td></tr><tr><td><p>creditInformation</p><p>.providedCreditRating</p></td><td>string</td><td>⭕</td><td>⭕</td><td><p>User's self-provided credit rating. Options include:</p><ul><li>excellent</li><li>good</li><li>fair</li><li>poor</li><li>limited</li><li>unknown</li></ul></td><td>excellent</td></tr><tr><td><p>creditCardInformation</p><p>.cardPurposes</p></td><td>array</td><td>⭕</td><td>⭕</td><td><p>User’s selected card benefit.</p><p>Options include:</p><ul><li>balance_transfer</li><li>cash_back</li><li>earning_rewards</li><li>improve_credit</li><li>low_interest</li><li>new_to_credit</li><li>student</li><li>travel_incentives</li><li>other</li></ul></td><td><p>"travel_incentives"</p><p><br></p></td></tr><tr><td><p>financialInformation</p><p>.annualIncome</p></td><td>integer</td><td>⭕</td><td>✅</td><td>User's annual income.This is required only if the user is interested in preselected offers.</td><td>75000</td></tr><tr><td><p>legalInformation</p><p>.consentsToFcra</p></td><td>boolean</td><td>⭕</td><td>✅</td><td>Indicates if the user consents to FCRA terms.</td><td>TRUE</td></tr><tr><td><p>legalInformation</p><p>.fcraLanguage</p></td><td>string</td><td>⭕</td><td>✅</td><td>FCRA consent language.</td><td>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.</td></tr><tr><td><p>legalInformation</p><p>.consentsToTcpa</p></td><td>boolean</td><td>⭕</td><td>⭕</td><td>Indicates if the user consents to TCPA terms</td><td><br></td></tr><tr><td><p>legalInformation</p><p>.tcpaLanguage</p></td><td>string</td><td>⭕</td><td>⭕</td><td>TCPA consent language</td><td>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 (800) 614-7505 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.</td></tr><tr><td><p>clientTags</p><p>.subId</p></td><td>array of strings</td><td>⭕</td><td>⭕</td><td>Client-defined tags for tracking purposes.</td><td>["2ee169ef"]</td></tr></tbody></table>

## 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.evenfinancial.com/originator/rateTables/%7Buuid%7D)`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

<table data-header-hidden><thead><tr><th width="211.234375">Field</th><th width="117.97265625">Type</th><th width="217.86328125">Description</th><th>Example</th></tr></thead><tbody><tr><td>uuid</td><td>string</td><td>Rate table UUID</td><td>"123e4567-e89b-12d3-a456-426614174000"</td></tr><tr><td>leadUuid</td><td>string</td><td>Unique identifier for the lead associated with the credit card offer.</td><td>"123e4567-e89b-12d3-a456-426614174001"</td></tr><tr><td><p>creditCardOffers</p><p>.uuid</p></td><td>string</td><td>Unique identifier for the credit card offer.</td><td>"123e4567-e89b-12d3-a456-426614174002"</td></tr><tr><td><p>creditCardOffers</p><p>.partner</p><p>.uuid</p></td><td>string</td><td>Unique identifier for the issuer offering the credit card.</td><td>"123e4567-e89b-12d3-a456-426614174003"</td></tr><tr><td><p>creditCardOffers</p><p>.partner</p><p>.name</p></td><td>string</td><td>Name of the issuer offering the credit card.</td><td>"Bank of America"</td></tr><tr><td><p>creditCardOffers</p><p>.partner</p><p>.description</p></td><td>string</td><td>Description of the issuer.</td><td>"A leading global bank."</td></tr><tr><td><p>creditCardOffers</p><p>.partner</p><p>.disclaimer</p></td><td>string</td><td>Disclaimer for the issuer’s offers.</td><td>"Terms and conditions apply."</td></tr><tr><td><p>creditCardOffers</p><p>.partner</p><p>.supportsPersonalizedOffers</p></td><td>boolean</td><td>Not applicable for Credit Cards</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.partner</p><p>.shouldDisplayPreSelect</p></td><td>boolean</td><td>Not applicable for Credit Cards</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.partner</p><p>.supportsPreSelect</p></td><td>boolean</td><td>Not applicable for Credit Cards</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.partner</p><p>.imageUrl</p></td><td>string [url]</td><td>URL of the issuer's logo or image.</td><td>"https://example.com/partner-logo.png"</td></tr><tr><td><p>creditCardOffers</p><p>.productType</p></td><td>string</td><td>Type of the credit card product.</td><td>"credit_card"</td></tr><tr><td><p>creditCardOffers</p><p>.productSubType</p></td><td>string</td><td>Subtype of the credit card product.</td><td>"credit_card"</td></tr><tr><td><p>creditCardOffers</p><p>.url</p></td><td>string [url]</td><td>The click URL for the card offer to take the lead to the issuers sign up funnel</td><td>"https://example.com/card-offer"</td></tr><tr><td><p>creditCardOffers</p><p>.recommendationScore</p></td><td>number</td><td>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.</td><td><br></td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.cardName</p></td><td>string</td><td>The card name that will be displayed on the offer</td><td>"Cash Back Rewards Card"</td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.cardImageUrl</p></td><td>string [url]</td><td>URL of the card image </td><td>"https://example.com/card-image.png"</td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.cardPurposes</p></td><td><a href="https://engine.tech/docs/api-reference/#tocS_CardPurpose">CardPurpose array</a></td><td><p>List of benefits the card offers. Options include:</p><p><br></p><ul><li>    balance_transfer</li><li>    cash_back</li><li>    earning_rewards</li><li>    improve_credit</li><li>    low_interest</li><li>    new_to_credit</li><li>    student</li><li>    travel_incentives</li></ul></td><td><p>["cash_back",</p><p>  "travel_incentives"]</p><p> </p></td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.ratesUrl</p></td><td>string [url]</td><td>External link to card rates, terms, and conditions</td><td>"https://example.com/rates"</td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.maxPurchaseApr</p></td><td>number [double]</td><td>Maximum purchase APR in percentage</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.minPurchaseApr</p></td><td>number [double]</td><td>Minimum purchase APR in percentage</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.purchaseAprText</p></td><td>string</td><td>Description of the purchase APR</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.purchaseAprDisclaimer</p></td><td>string</td><td>The disclaimer goes in the tooltip of APR field</td><td>Please see mocks and card stats section for examples</td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.maxPurchaseIntroApr</p></td><td>number [double]</td><td>Maximum introductory purchase APR in percentage</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details.minPurchaseIntroApr</p></td><td>number [double]</td><td>Minimum introductory purchase APR in percentage</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.purchaseIntroAprTerm</p></td><td>integer [int32]</td><td>Introductory purchase APR term length</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.purchaseIntroAprTermUnit</p></td><td><a href="https://engine.tech/docs/api-reference/#tocS_TermUnit">TermUnit</a></td><td><p>Options include:</p><ul><li>day</li><li>month</li><li>year</li><li>open</li></ul></td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.purchaseIntroAprText</p></td><td>string</td><td>Description of the introductory purchase APR</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.maxCashAdvanceApr</p></td><td>number [double]</td><td>Maximum cash advance APR in percentage</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.minCashAdvanceApr</p></td><td>number [double]</td><td>Minimum cash advance APR in percentage</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.cashAdvanceAprText</p></td><td>string</td><td>Description of the cash advance APR</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.maxCashAdvanceIntroApr</p></td><td>number [double]</td><td>Maximum introductory cash advance APR in percentage</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.minCashAdvanceIntroApr</p></td><td>number [double]</td><td>Minimum introductory cash advance APR in percentage</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.cashAdvanceIntroAprTerm</p></td><td>integer [int32]</td><td>Introductory cash advance APR term length</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.cashAdvanceIntroAprTermUnit</p></td><td><a href="https://engine.tech/docs/api-reference/#tocS_TermUnit">TermUnit</a></td><td><p>Options include:</p><ul><li>day</li><li>month</li><li>year</li><li>open</li></ul></td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.cashAdvanceIntroAprText</p></td><td>string</td><td>Description of the introductory cash advance APR</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.maxBalanceTransferApr</p></td><td>number [double]</td><td>Maximum balance transfer APR in percentage</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.minBalanceTransferApr</p></td><td>number [double]</td><td>Minimum balance transfer APR in percentage</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.balanceTransferAprText</p></td><td>string</td><td>Description of the balance transfer APR</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.maxBalanceTransferIntroApr</p></td><td>number [double]</td><td>Maximum introductory balance transfer APR in percentage</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.minBalanceTransferIntroApr</p></td><td>number [double]</td><td>Minimum introductory balance transfer APR in percentage</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.balanceTransferIntroAprTerm</p></td><td>integer [int32]</td><td>Introductory balance transfer APR term length</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.balanceTransferIntroAprTermUnit</p></td><td><a href="https://engine.tech/docs/api-reference/#tocS_TermUnit">TermUnit</a></td><td><p>Options include:</p><ul><li>day</li><li>month</li><li>year</li><li>open</li></ul></td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.balanceTransferIntroAprText</p></td><td>string</td><td>Description of the introductory balance transfer APR</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.balanceTransferFee</p></td><td>number [double]</td><td>Balance transfer fee as a percentage</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.balanceTransferFeeDisclaimer</p></td><td>string</td><td>The disclaimer goes in the tooltip of Balance Transfer field if provided</td><td>Please see mocks and card stats section for examples</td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.maxAnnualFee</p></td><td>number [double]</td><td>Maximum annual fee in dollars</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.minAnnualFee</p></td><td>number [double]</td><td>Minimum annual fee in dollars</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.annualFeeDisclaimer</p></td><td>string</td><td>Disclaimer for the annual fee goes in the tooltip if provided</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.annualIntroFee</p></td><td>number [double]</td><td>Introductory annual fee in dollars</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.annualIntroFeeTerm</p></td><td>integer [int32]</td><td>Number of years the introductory annual fee is in effect</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.introOfferAmount</p></td><td>number [double]</td><td>Amount of the introductory offer</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.introOfferText</p></td><td>string</td><td>Description of the introductory offer</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.introOfferDisclaimer</p></td><td>string</td><td>The disclaimer goes in the tooltip of Intro offer field if provided</td><td>Please see mocks and card stats section for examples</td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.introOfferType</p></td><td><a href="https://engine.tech/docs/api-reference/#tocS_IntroOfferType">IntroOfferType</a></td><td><p>Options include:</p><ul><li>miles</li><li>points</li><li>statement_credit</li></ul></td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.details</p></td><td>string array</td><td>List of card features which must be prominently displayed with the offer</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.additionalDetails</p></td><td>string array</td><td>List of card features which must be displayed with the offer</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.cardType</p></td><td><a href="https://engine.tech/docs/api-reference/#tocS_CardType">CardType</a></td><td><p>Type of card, options include:</p><ul><li>visa</li><li>mastercard</li><li>american_express</li><li>discover</li></ul></td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.aprType</p></td><td><a href="https://engine.tech/docs/api-reference/#tocS_AprType">AprType</a></td><td><p>Variable</p><p>fixed</p><p>regular</p></td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.recommendedCreditRatings</p></td><td><a href="https://engine.tech/docs/api-reference/#tocS_ProvidedCreditRating">ProvidedCreditRating array</a></td><td><p>Recommended credit ratings for the card. Options include:</p><ul><li>excellent</li><li>good</li><li>fair</li><li>poor</li><li>limited</li><li>unknown</li></ul></td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.recommendedCreditRatingsDisclaimer</p></td><td>string</td><td>This goes in the tooltip for Recommended credit rating field if provided</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.preQualified</p></td><td>boolean</td><td>Good chance of approval</td><td><p>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.”</p><p><br></p></td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.preApproved</p></td><td>boolean</td><td>Excellent chance of approval</td><td><p>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.”</p><p><br></p></td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.preSelected</p></td><td>boolean</td><td>Moderate chance of approval</td><td><p>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.”</p><p><br></p></td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.rewardsDescription</p></td><td>string</td><td>Description of rewards associated with the card</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.rewardsDisclaimer</p></td><td>string</td><td>The disclaimer can be used for the tooltip of Rewards field. It will be displayed if provided</td><td>Please see mocks and card stats section for examples</td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.minDepositAmount</p></td><td>number [double]</td><td>Minimum deposit required in dollars</td><td> </td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.minDepositDisclaimer</p></td><td>string</td><td>The disclaimer can be used for the tooltip of Min Deposit field</td><td>Please see mocks and card stats section for examples</td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.badges</p></td><td>string array</td><td>Badges can be shown on top of every card to highlight key benefits of the card. These are available for ITA offers.</td><td><ul><li>Good for cashback rewards</li><li>Good for building credit</li></ul></td></tr><tr><td><p>creditCardOffers</p><p>.details</p><p>.isITA</p></td><td>boolean</td><td><p>If true = static offer</p><p> If false = personalized offer</p></td><td><br></td></tr></tbody></table>