NAV Navigation
Javascript

User Experience API v1.8.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Overview

The User Experience API is centered around submitting a lead in exchange for a rate table.

These resources are used to search for any type of financial product supported by the API, e.g. personal loans, savings accounts, credit cards, etc.

The firmness of an offer on a rate table - i.e., pre-approved or pre-qualified - can vary depending upon the information on a lead and the financial institution making the offer.

No fields on a lead are required, but depending on the type of financial product requested, you will only get firm offers if some subset of fields are specified.

A rate table might indicate that we're still awaiting responses from one or more financial instutions. In this case, the rate table should be reloaded until it indicates that we're no long awaiting responses.

Blocking Rate Table Endpoint

Clients have the option to request a rate table syncronously via the following blocking endpoint:

POST https://integrations.evenfinancial.com/blocking/leads/rateTables

The interface is identical to that of api.evenfinancial.com/leads/rateTables, but will only respond when all financial institution responses have been received.

As a consequence, the pendingResponses field on the rate table will always be empty, so there's no need to poll for more results. However, the response latency will likely be much higher than the asyncronous endpoint.

Loans

To search for personal loans, you should set productTypes to ["loan"] on the lead. In order to get pre-approved and pre-qualified offers, you should also include the following fields:

If you'd like to potentially also get offers for co-applicant loans, include the following fields:

Example: Search for personal loans

Request

POST /leads/rateTables

{
  "productTypes": [
    "loan"
  ],
  "personalInformation": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "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,
    "consentsToTcpa": true,
    "tcpaLanguage": "I agree to be contacted by Even Financial and its partners at the telephone number(s) I have provided above to explore personal loan offers, including contact through automatic dialing systems, artificial or pre-recorded voice messaging, or text message. I understand my consent is not required as a condition to purchasing any goods or services from anyone."
  },
  "clientTags": {
    "subId": [
      "aaa053cb"
    ]
  }
}

Response

200 OK

{
  "uuid": "2c6cb6e4-0aa2-4ab5-9109-8679de537e10",
  "leadUuid": "f823a7c0-586a-4fc3-9cfa-c38694b80b2c",
  "loanOffers": [
    {
      "uuid": "fef16e91-960f-4ac7-a8ec-98d7a6b32c7e",
      "originator": {
        "key": "lending-club",
        "name": "LendingClub",
        "description": "Low fixed rate personal loans from $1,000 to $40,000",
        "images": [
          {
            "sizeKey": "150",
            "url": "aff-tag.evenfinancial.com/images/lendingclub/lendingclub_120.png"
          }
        ],
        "disclaimer": "Suspendisse rhoncus magna erat, nec rhoncus leo elementum eget."
      },
      "originatorId": null,
      "termLength": 36,
      "termUnit": "month",
      "maxAmount": 12000,
      "minAmount": 800,
      "maxApr": 35.99,
      "minApr": 25.01,
      "meanApr": 30.5,
      "feeRate": null,
      "maxFeeRate": null,
      "minFeeRate": null,
      "feeFixed": null,
      "maxFeeFixed": null,
      "minFeeFixed": null,
      "allowPrepayment": true,
      "prepaymentFee": 0,
      "monthlyPayment": 119.3,
      "maxMonthlyPayment": 137.4,
      "minMonthlyPayment": 119.3,
      "meanMonthlyPayment": 128.18,
      "maxTotalPayment": 4947,
      "minTotalPayment": 4295,
      "meanTotalPayment": 4615,
      "terms": null,
      "url": "https://offers.evenfinancial.com/ref/fef16e91-960f-4ac7-a8ec-98d7a6b32c7e",
      "preQualified": false,
      "preApproved": true,
      "sponsored": false,
      "aprType": "fixed",
      "recommendationScore": 95
    },
    ...
  ],
  "specialOffers": [],
  "savingsOffers": [],
  "creditCardOffers": [],
  "mortgageOffers": [],
  "pendingResponses": [
    {
      "partner": {
        "uuid": "91d08be0-2a8c-4d28-b399-7e1b38e2522e",
        "name": "Avant",
        "description": "Personal loans from $1,000 to $35,000",
        "disclaimer": "Suspendisse rhoncus magna erat, nec rhoncus leo elementum eget.",
        "imageUrl": "https://images.evenfinancial.com/old/images/avant/avant_120.png"
      },
      "productTypes": [
        "loan"
      ]
    }
  ],
  "pendingOriginators": [
    {
      "key": "avant",
      "name": "Avant",
      "description": "Personal loans from $1,000 to $35,000",
      "images": [
        {
          "sizeKey": "120",
          "url": "aff-tag.evenfinancial.com/images/avant/avant_120.png"
        }
      ],
      "disclaimer": "Suspendisse rhoncus magna erat, nec rhoncus leo elementum eget."
    }
  ]
}

Student Loan Refinancing

Searching for student loan refinancing loans is just like searching for generic personal loans, but with some additional requirements:

Request

POST /leads/rateTables

{
  "productTypes": [
    "loan"
  ],
  "productSubTypes": [
    "student_loan_refinance"
  ],
  "personalInformation": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "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",
    "citizenshipStatus": "citizen"
  },
  "loanInformation": {
    "purpose": "student_loan_refi",
    "loanAmount": 10000
  },
  "mortgageInformation": {
    "propertyStatus": "own_with_mortgage"
  },
  "creditInformation": {
    "providedCreditRating": "excellent"
  },
  "financialInformation": {
    "annualIncome": 75000,
    "availableAssets": 10000,
    "employmentStatus": "employed",
    "employmentPayFrequency": "weekly",
    "monthlyHousingPayment": 1000
  },
  "educationInformation": {
    "educationLevel": "doctorate",
    "graduationDate": "1999-06-30",
    "graduateDegreeType": "doctor_of_medicine",
    "universityAttended": "New York University"
  },
  "legalInformation": {
    "consentsToFcra": true,
    "consentsToTcpa": true,
    "tcpaLanguage": "I agree to be contacted by Even Financial and its partners at the telephone number(s) I have provided above to explore personal loan offers, including contact through automatic dialing systems, artificial or pre-recorded voice messaging, or text message. I understand my consent is not required as a condition to purchasing any goods or services from anyone."
  },
  "clientTags": {
    "subId": [
      "aaa053cb"
    ]
  }
}

Response

200 OK

{
  "uuid": "2c6cb6e4-0aa2-4ab5-9109-8679de537e10",
  "leadUuid": "f823a7c0-586a-4fc3-9cfa-c38694b80b2c",
  "loanOffers": [
    {
      "uuid": "fef16e91-960f-4ac7-a8ec-98d7a6b32c7e",
      "originator": {
        "key": "lendKey",
        "name": "Lend Key",
        "description": "Low fixed rate personal loans from $1,000 to $40,000",
        "images": [
          {
            "sizeKey": "150",
            "url": "aff-tag.evenfinancial.com/images/lendKey/lendkey_120.png"
          }
        ],
        "disclaimer": "Suspendisse rhoncus magna erat, nec rhoncus leo elementum eget."
      },
      "originatorId": null,
      "termLength": 36,
      "termUnit": "month",
      "maxAmount": 12000,
      "minAmount": 800,
      "maxApr": 35.99,
      "minApr": 25.01,
      "meanApr": 30.5,
      "feeRate": null,
      "maxFeeRate": null,
      "minFeeRate": null,
      "feeFixed": null,
      "maxFeeFixed": null,
      "minFeeFixed": null,
      "allowPrepayment": true,
      "prepaymentFee": 0,
      "monthlyPayment": 119.3,
      "maxMonthlyPayment": 137.4,
      "minMonthlyPayment": 119.3,
      "meanMonthlyPayment": 128.18,
      "maxTotalPayment": 4947,
      "minTotalPayment": 4295,
      "meanTotalPayment": 4615,
      "terms": null,
      "url": "https://offers.evenfinancial.com/ref/fef16e91-960f-4ac7-a8ec-98d7a6b32c7e",
      "preQualified": false,
      "preApproved": true,
      "sponsored": false,
      "aprType": "fixed",
      "recommendationScore": 95
    },
    ...
  ],
  "specialOffers": [],
  "savingsOffers": [],
  "creditCardOffers": [],
  "mortgageOffers": [],
  "pendingResponses": [
    {
      "partner": {
        "uuid": "91d08be0-2a8c-4d28-b399-7e1b38e2522e",
        "name": "SoFi",
        "description": "Personal loans from $1,000 to $35,000",
        "disclaimer": "Suspendisse rhoncus magna erat, nec rhoncus leo elementum eget.",
        "imageUrl": "https://images.evenfinancial.com/old/images/sofi/sofi_120.png"
      },
      "productTypes": [
        "loan"
      ]
    }
  ],
  "pendingOriginators": [
    {
      "key": "sofi",
      "name": "SoFi",
      "description": "Personal loans from $1,000 to $35,000",
      "images": [
        {
          "sizeKey": "120",
          "url": "aff-tag.evenfinancial.com/images/sofi/sofi_120.png"
        }
      ],
      "disclaimer": "Suspendisse rhoncus magna erat, nec rhoncus leo elementum eget."
    }
  ]
}

Line of Credit

Searching for line of credit is just like searching for personal loans

Request

POST /leads/rateTables

{
  "productTypes": [
    "loan"
  ],
  "personalInformation": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "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,
    "consentsToTcpa": true,
    "tcpaLanguage": "I agree to be contacted by Even Financial and its partners at the telephone number(s) I have provided above to explore personal loan offers, including contact through automatic dialing systems, artificial or pre-recorded voice messaging, or text message. I understand my consent is not required as a condition to purchasing any goods or services from anyone."
  },
  "clientTags": {
    "subId": [
      "aaa053cb"
    ]
  }
}

Response

200 OK

{
 "uuid": "2c6cb6e4-0aa2-4ab5-9109-8679de537e10",
 "leadUuid": "f823a7c0-586a-4fc3-9cfa-c38694b80b2c",,
 "loanAmount": 10000,
 "creditCardOffers": [],
 "lifeInsuranceOffers": [],
 "lineOfCreditOffers": [],
 "loanOffers": [
   {
     "minAmount": null,
     "maxFeeRate": null,
     "maxFeeFixed": null,
     "prepaymentFee": null,
     "payout": 5,
     "minMonthlyPayment": null,
     "originator": {
       "key": "creditfresh_loc",
       "name": "CreditFresh",
       "description": "With a Line of Credit by CBW Bank through CreditFresh, you will have a flexible way\nto access credit when you need it. A Line of Credit is an open-end credit product\nthat allows you to make draws, repay and redraw as the need arises.\nThe process to submit a request through CreditFresh's secure platform is simple and\nconvenient. If approved, you can access the money you need anytime, so long as\nyou have available credit and your account is in good standing. You are only charged\nbased on the amount of credit you use, not the total amount of credit you have\navailable to you.\nThe Line of Credit is offered by CBW Bank, Member FDIC.\n\nThe Line of Credit is available through CreditFresh's safe and secure online\n\nplatform. Some benefits include:\n- A personal line of credit between $500 - $3,500*.\n- Access your available credit whenever you need it so long as your account\nis in good standing.\n- Request a draw and you may receive your funds as soon as the same\nbusiness day**!\n- Easy to understand pricing with one simple charge for each billing cycle\nand clear repayment terms.\nTo see services offered in your state of residence, please visit the CreditFresh\nwebsite.",
       "images": [
         {
           "sizeKey": "120x40",
           "url": "https://images.evenfinancial.com/logos/prod/creditfresh.png"
         }
       ],
       "disclaimer": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam quam sapien, finibus at suscipit eget",
     },
     "minApr": null,
     "feeRate": null,
     "productSubType": "line_of_credit",
     "aprDescription": "Fixed APR †",
     "minFeeRate": null,
     "maxApr": 133.9,
     "conversionProbability": 0.009866715408861637,
     "monthlyPayment": 560,
     "terms": null,
     "recommendationScore": 500,
     "productSubTypeDisclaimer": null,
     "maxMonthlyPayment": 560,
     "originatorId": null,
     "maxAmount": 3500,
     "allowPrepayment": false,
     "termUnit": "open",
     "productType": "loan",
     "coApplicant": false,
     "preQualified": true,
     "displayTermUnit": null,
     "sponsored": false,
     "url": "https://offers.evenfinancial.com/ref/fef16e91-960f-4ac7-a8ec-98d7a6b32c7e",
     "meanApr": 133.9,
     "minFeeFixed": null,
     "aprType": "fixed",
     "termLength": 1,
     "meanTotalPayment": 560,
     "preApproved": false,
     "minTotalPayment": null,
     "maxTotalPayment": 560,
     "feeFixed": null,
     "secured": false,
     "meanMonthlyPayment": 560
   }
 ],
 "mortgageOffers": [],
 "savingsOffers": [],
 "specialOffers": [],
 "pendingOriginators": [],
 "pendingResponses": []
}

Savings

To search for savings accounts, you should set productTypes to ["savings"] on the lead. To get the best matching offers, you should also specify the following fields:

Example: Seach for savings accounts

Request

POST /leads/rateTables

{
  "productTypes": [
    "savings"
  ],
  "personalInformation": {
    "zipcode": "10010",
  },
  "creditInformation": {
    "providedCreditRating": "excellent"
  },
  "savingsInformation": {
    "minDepositAmount": 1000
  },
  "clientTags": {
    "subId": [
      "3fdb9596"
    ]
  }
}

Response

200 OK

{
  "uuid": "2c6cb6e4-0aa2-4ab5-9109-8679de537e10",
  "leadUuid": "f823a7c0-586a-4fc3-9cfa-c38694b80b2c",
  "loanOffers": [],
  "specialOffers": [],
  "savingsOffers": [
    {
      "uuid": "60a32cee-a5aa-4358-a5fe-f8070f8f2a14",
      "partner": {
        "uuid": "f7df60e5-13c0-4241-aba0-61a8877e142f",
        "name": "Partner Bank",
        "description": "Partner Bank Description",
        "disclaimer": "Partner Bank Disclaimer",
        "imageUrl": "https://dev-admin.evenfinancial.com/partner_image.gif"
      },
      "marketplace": {
        "uuid": "7a95da6d-2a03-4f58-beb0-d31eaddcfb15",
        "name": "Marketplace",
        "description": "Source of offers",
        "disclaimer": "Source disclaimer",
        "imageUrl": "https://dev-admin.evenfinancial.com/marketplace_image.gif"
      },
      "productType": "savings",
      "productSubType": "money_market_account",
      "url": "https://dev-offers.evenfinancial.com/ref/1ed2f58e-af3f-409e-a1e6-f7f00f18cd88",
      "consumerRating": 80,
      "details": {
        "name": "Ally Bank",
        "description": "Open an Account Today. Ally Bank, Member FDIC.",
        "details": "",
        "rate": 1.14,
        "annualPercentYield": 1.15,
        "compoundingMethod": "annually",
        "introductoryPeriodMonths": 0,
        "introductoryRate": 0,
        "minimumDeposit": 0,
        "minimumDepositWithFees": 0,
        "monthlyFee": 0,
        "checkWriting": false,
        "effectiveAsOf": 1501113600000
      }
    }
  ],
  "creditCardOffers": [],
  "mortgageOffers": [],
  "pendingResponses": [
    {
      "partner": {
        "uuid": "91d08be0-2a8c-4d28-b399-7e1b38e2522e",
        "name": "Partner Bank 2",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
        "disclaimer": "Cras vestibulum diam sed tempor sagittis.",
        "imageUrl": "https://images.evenfinancial.com/partnerBank2/partnerBank2Logo.png"
      },
      "productTypes": [
        "savings"
      ]
    }
  ],
  "pendingOriginators": []
}

Credit Cards

To search for credit cards, you should set productTypes to ["credit_card"] on the lead. To get the best matching offers, you should also specify the following fields:

Example: Searching for credit cards

Request

POST /leads/rateTables

{
  "productTypes": [
    "credit_card"
  ],
  "personalInformation": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "city": "New York",
    "state": "NY",
    "primaryPhone": "2125556789",
    "address1": "45 West 21st Street",
    "address2": "5th Floor",
    "zipcode": "10011",
    "dateOfBirth": "1993-10-09"
  },
  "creditCardInformation": {
    "allowAnnualFee": true,
    "cardPurposes": [
      "travel_incentives"
    ]
  },
  "creditInformation": {
    "providedCreditRating": "excellent",
  },
  "legalInformation": {
    "consentsToFcra": true,
    "consentsToTcpa": true,
    "tcpaLanguage": "I agree to be contacted by Even Financial and its partners at the telephone number(s) I have provided above to explore personal loan offers, including contact through automatic dialing systems, artificial or pre-recorded voice messaging, or text message. I understand my consent is not required as a condition to purchasing any goods or services from anyone."
  },
  "clientTags": {
    "subId": [
      "2ee169ef"
    ]
  }
}

Response

200 OK

{
  "uuid": "2c6cb6e4-0aa2-4ab5-9109-8679de537e10",
  "leadUuid": "f823a7c0-586a-4fc3-9cfa-c38694b80b2c",
  "loanOffers": [],
  "specialOffers": [],
  "savingsOffers": [],
  "creditCardOffers": [
    {
      "uuid": "6e6a6043-afaf-4c61-971b-a035282548f0",
      "partner": {
        "uuid": "f7df60e5-13c0-4241-aba0-61a8877e142f",
        "name": "Partner Bank",
        "description": "Partner Bank Description",
        "disclaimer": "Partner Bank Disclaimer",
        "supportsPersonalizedOffers": false,
        "supportsPreSelect": false,
        "imageUrl": "https://dev-admin.evenfinancial.com/partner_image.gif"
      },
      "marketplace": {
        "uuid": "7a95da6d-2a03-4f58-beb0-d31eaddcfb15",
        "name": "Marketplace",
        "description": "Source of offers",
        "disclaimer": "Source disclaimer",
        "imageUrl": "https://dev-admin.evenfinancial.com/marketplace_image.gif"
      },
      "productType": "credit_card",
      "productSubType": "credit_card",
      "url": "https://dev-offers.evenfinancial.com/ref/6bb3ed5c-f1d1-4c69-af1c-d02a4e028b3c",
      "details": {
        "cardName": "Credit Card",
        "cardImageUrl": "https://example.com/image",
        "cardPurposes": [
          "travel_incentives"
        ],
        "ratesUrl": "https://example.com/",
        "maxPurchaseApr": 15,
        "minPurchaseApr": 15,
        "maxPurchaseIntroApr": 0,
        "minPurchaseIntroApr": 0,
        "purchaseIntroAprTerm": 12,
        "purchaseIntroAprTermUnit": "month",
        "maxCashAdvanceApr": 15,
        "minCashAdvanceApr": 15,
        "maxCashAdvanceIntroApr": 0,
        "minCashAdvanceIntroApr": 0,
        "cashAdvanceIntroAprTerm": 12,
        "cashAdvanceIntroAprTermUnit": "month",
        "maxBalanceTransferApr": 15,
        "minBalanceTransferApr": 15,
        "maxBalanceTransferIntroApr": 0,
        "minBalanceTransferIntroApr": 0,
        "balanceTransferIntroAprTerm": 12,
        "balanceTransferIntroAprTermUnit": "month",
        "annualFee": 100,
        "annualIntroFee": 0,
        "annualIntroFeeTerm": 1,
        "details": [
          "Credit card detail"
        ],
        "additionalDetails": [
          "One click away credit card detail"
        ],
        "cardType": "visa",
        "minimumCreditLine": 5000,
        "minimumPenaltyApr": 10,
        "maximumPenaltyApr": 10,
        "balanceTransferFee": 25,
        "cashAdvanceFee": 5,
        "lateFee": 25,
        "foreignExchangeFee": 10,
        "accountOpeningFee": 0,
        "returnPaymentFee": 0,
        "monthlyServiceFee": 0,
        "recommendedCreditRatings": [
          "good"
        ],
        "preQualified": false,
        "preApproved": false,
        "preSelected": false,
        "aprType": "variable"
      }
    }
  ],
  "mortgageOffers": [],
  "pendingResponses": [
    {
      "partner": {
        "uuid": "91d08be0-2a8c-4d28-b399-7e1b38e2522e",
        "name": "Partner Bank 2",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
        "disclaimer": "Cras vestibulum diam sed tempor sagittis.",
        "imageUrl": "https://images.evenfinancial.com/partnerBank2/partnerBank2Logo.png"
      },
      "productTypes": [
        "credit_card"
      ]
    }
  ],
  "pendingOriginators": []
}

Base URLs:

Authentication

The bearer token corresponds to an access token record, and consists of two UUIDs joined by an underscore:

  1. the access token's unique identifier
  2. the access token's secret, which is only available upon access token creation

The header value is prefixed with the string "Bearer ", so a properly authenticated request will have a header that looks something like this:

Authorization: Bearer 0a930e7f-4a96-4388-8c12-c794a161084e_409cc5f2-4008-42aa-84a4-0b68f163f437

Requests are authorized using scopes that are associated with the access token. Each endpoint defines the scopes required to authorize a request.

- Flow: clientCredentials

- Token URL = [/auth/accessTokens](/auth/accessTokens)
Scope Scope Description
analytics:report:read Read data from analytics endpoints.
originator:rateTables:read Read rate tables.
svc-lead:leads:insert Submit leads.
svc-lead:leads:insert-test Any lead submitted using an access token with this scope will be designated a test lead.
svc-lead:leads:readRestricted Read leads.
ui-event:write Record UI events.

Lead / Rate Table

Submit a lead

Code samples

const inputBody = '{
  "productTypes": [
    "credit_card"
  ],
  "personalInformation": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "city": "New York",
    "state": "NY",
    "primaryPhone": "2125556789",
    "address1": "45 West 21st Street",
    "address2": "5th Floor",
    "zipcode": "10010",
    "dateOfBirth": "1993-10-09"
  },
  "creditCardInformation": {
    "allowAnnualFee": true,
    "cardPurposes": [
      "travel_incentives"
    ]
  },
  "creditInformation": {
    "providedCreditRating": "excellent",
    "providedNumericCreditScore": 750
  },
  "financialInformation": {
    "employmentStatus": "employed",
    "employmentPayFrequency": "weekly",
    "annualIncome": 120000
  },
  "legalInformation": {
    "consentsToFcra": true,
    "consentsToTcpa": true,
    "tcpaLanguage": "I agree to be contacted by Even Financial and its partners at the telephone number(s) I have provided above to explore personal loan offers, including contact through automatic dialing systems, artificial or pre-recorded voice messaging, or text message. I understand my consent is not required as a condition to purchasing any goods or services from anyone."
  },
  "clientTags": {
    "hello": [
      "world",
      "there"
    ],
    "something": [
      "else"
    ]
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.evenfinancial.com/leads',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /leads

Body parameter

{
  "productTypes": [
    "credit_card"
  ],
  "personalInformation": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "city": "New York",
    "state": "NY",
    "primaryPhone": "2125556789",
    "address1": "45 West 21st Street",
    "address2": "5th Floor",
    "zipcode": "10010",
    "dateOfBirth": "1993-10-09"
  },
  "creditCardInformation": {
    "allowAnnualFee": true,
    "cardPurposes": [
      "travel_incentives"
    ]
  },
  "creditInformation": {
    "providedCreditRating": "excellent",
    "providedNumericCreditScore": 750
  },
  "financialInformation": {
    "employmentStatus": "employed",
    "employmentPayFrequency": "weekly",
    "annualIncome": 120000
  },
  "legalInformation": {
    "consentsToFcra": true,
    "consentsToTcpa": true,
    "tcpaLanguage": "I agree to be contacted by Even Financial and its partners at the telephone number(s) I have provided above to explore personal loan offers, including contact through automatic dialing systems, artificial or pre-recorded voice messaging, or text message. I understand my consent is not required as a condition to purchasing any goods or services from anyone."
  },
  "clientTags": {
    "hello": [
      "world",
      "there"
    ],
    "something": [
      "else"
    ]
  }
}

Parameters

Name In Type Required Description
body body LeadRequest true A Lead object

Example responses

200 Response

{
  "uuid": "81c08fb9-559a-4bab-948c-ba38f8dd0dcc"
}

400 Response

[
  {
    "message": "Cannot parse parameter uuid as UUID: Invalid UUID string: 123"
  }
]

Responses

Status Meaning Description Schema
200 OK Lead created LeadUuid
400 Bad Request Invalid Body Inline

Response Schema

Status Code 400

Name Type Required Restrictions Description
anonymous [ApiError] false none none

Get a lead

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.evenfinancial.com/leads/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /leads/{uuid}

Return a Lead given its UUID. Depending on the access token scope, the response may contain a subset of a Lead object.

Parameters

Name In Type Required Description
uuid path string(uuid) true none

Example responses

200 Response

{
  "leadProviderName": "string",
  "personalInformation": {
    "firstName": "string",
    "lastName": "string",
    "aliasFirstName": "string",
    "aliasLastName": "string",
    "email": "user@example.com",
    "city": "string",
    "state": "AK",
    "workPhone": "string",
    "primaryPhone": "string",
    "bestTimeToCall": "morning",
    "address1": "string",
    "address2": "string",
    "addressMoveInDate": "2019-08-24",
    "zipcode": "string",
    "monthsAtAddress": 0,
    "driversLicenseNumber": "string",
    "driversLicenseState": "string",
    "ipAddress": "string",
    "activeMilitary": true,
    "militaryVeteran": true,
    "dateOfBirth": "2019-08-24",
    "educationLevel": "high_school",
    "ssn": "string",
    "citizenshipStatus": "citizen"
  },
  "personalReferenceInformation": {
    "firstName": "string",
    "lastName": "string",
    "primaryPhone": "string",
    "relationType": "parent"
  },
  "loanInformation": {
    "purpose": "auto_purchase",
    "loanAmount": 0
  },
  "mortgageInformation": {
    "propertyType": "rent",
    "propertyValue": 0,
    "mortgageBalance": 0,
    "lenderName": "string",
    "hasFHALoan": true,
    "currentWithLoan": true,
    "propertyStatus": "own_outright",
    "mortgageType": "purchase",
    "mortgageAmount": 0,
    "downPaymentAmount": 0,
    "propertyState": "string",
    "propertyCounty": "string",
    "propertyAddress1": "string",
    "propertyAddress2": "string",
    "propertyZipcode": "string",
    "propertyCity": "string",
    "refinanceAmount": 0,
    "cashOutAmount": 0,
    "occupancyType": "primary",
    "refinanceType": "cash_out",
    "propertySearchStatus": "found",
    "numUnits": 0,
    "closingDate": "2019-08-24",
    "purchaseStatus": "no_offer",
    "purchaseDate": "2019-08-24",
    "monthlyHoaFee": 0,
    "mortgageCompany": "string",
    "mortgageEscrowAmount": 0
  },
  "creditCardInformation": {
    "allowAnnualFee": true,
    "cardPurposes": [
      "balance_transfer"
    ]
  },
  "savingsInformation": {
    "minDepositAmount": 0
  },
  "creditInformation": {
    "providedCreditRating": "excellent",
    "providedNumericCreditScore": 0
  },
  "financialInformation": {
    "employmentStatus": "employed_full_time",
    "employmentPayFrequency": "weekly",
    "annualIncome": 0,
    "monthlyNetIncome": 0,
    "bankName": "string",
    "bankRoutingNumber": "string",
    "bankAccountType": "checking",
    "creditCardDebt": 0,
    "monthsAtBank": 0,
    "bankAccountNumber": "string",
    "monthlyDebt": 0,
    "totalAssets": 0,
    "monthlyHousingPayment": 0,
    "availableAssets": 0,
    "additionalIncome": 0,
    "additionalIncomeFrequency": "weekly"
  },
  "employmentInformation": {
    "employerName": "string",
    "employerAddress": "string",
    "employerAddress2": "string",
    "employerCity": "string",
    "employerPhone": "string",
    "employerState": "string",
    "employerZip": "string",
    "jobTitle": "string",
    "monthsEmployed": 0,
    "directDeposit": true,
    "payDate1": "2019-08-24",
    "payDate2": "2019-08-24",
    "startDate": "2019-08-24"
  },
  "legalInformation": {
    "consentsToFcra": true,
    "consentsToTcpa": true,
    "tcpaLanguage": "string",
    "consentsToSms": true
  },
  "educationInformation": {
    "educationLevel": "high_school",
    "graduateDegreeType": "doctor_of_medicine",
    "universityAttended": "string",
    "graduationDate": "2019-08-24",
    "graduateGraduationDate": "2019-08-24",
    "graduateLastAttendedDate": "2019-08-24",
    "graduateUniversityAttended": "string",
    "undergraduateGraduationDate": "2019-08-24",
    "undergraduateLastAttendedDate": "2019-08-24",
    "undergraduateUniversityAttended": "string"
  },
  "coApplicantInformation": {
    "firstName": "string",
    "lastName": "string",
    "dateOfBirth": "2019-08-24",
    "annualIncome": 0,
    "streetAddress1": "string",
    "streetAddress2": "string",
    "city": "string",
    "state": "AK",
    "zipCode": "string"
  },
  "healthInformation": {
    "gender": "male",
    "heightInInches": 0,
    "weightInPounds": 0,
    "tobaccoSmoker": true
  },
  "identificationInformation": {
    "idNumber": "string",
    "idState": "string",
    "idType": "driver_license"
  },
  "lifeInsuranceInformation": {
    "carrier": "string",
    "duration": 0,
    "policyAmount": 0
  },
  "refinanceLoans": [
    {
      "accountNumber": "string",
      "incomeBasedRepayment": true,
      "interestRate": 0,
      "loanAmount": 0,
      "loanServicer": "string",
      "loanType": "federal_student_loan",
      "nextPaymentAmount": 0,
      "nextPaymentDate": "2019-08-24"
    }
  ],
  "clientTags": {
    "subid": [
      "123"
    ]
  },
  "sessionInformation": {
    "ipAddress": "string",
    "userAgent": "string"
  },
  "leadActions": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "actionType": "initialized",
      "actionDate": "2019-08-24T14:15:22Z",
      "originatorKey": "string",
      "demandSubAccountId": 0,
      "rejectReason": "low_fico",
      "amount": 0,
      "originationFee": 0,
      "offerClickId": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "deletedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "companyUUID": "bb25b21f-4351-4e0a-bd6a-faa43df6ed9e",
  "sessionUuid": "0688aee8-ffa9-4d26-9262-47526493535e",
  "referralCompanyUuid": "427f8dd3-3534-47d8-a6af-90027e506eda",
  "trackingUuid": "20d86745-12ef-4b8a-91e5-6d9947ac4592",
  "isTest": true,
  "status": "initialized",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

400 Response

[
  {
    "message": "Lead UUID is invalid"
  }
]

Responses

Status Meaning Description Schema
200 OK Lead found Lead
400 Bad Request Invalid UUID Inline
404 Not Found Lead with the given UUID does not exist None

Response Schema

Status Code 400

Name Type Required Restrictions Description
anonymous [ApiError] false none none

Get a rate table

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.evenfinancial.com/originator/rateTables/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /originator/rateTables/{uuid}

Return a RateTable given its UUID

Parameters

Name In Type Required Description
uuid path string(uuid) true none

Example responses

Succesfully retrieved rate table

{
  "uuid": "2c6cb6e4-0aa2-4ab5-9109-8679de537e10",
  "leadUuid": "f823a7c0-586a-4fc3-9cfa-c38694b80b2c",
  "loanOffers": [],
  "specialOffers": [],
  "savingsOffers": [],
  "creditCardOffers": [
    {
      "uuid": "6e6a6043-afaf-4c61-971b-a035282548f0",
      "partner": {
        "uuid": "f7df60e5-13c0-4241-aba0-61a8877e142f",
        "name": "Partner Bank",
        "description": "Partner Bank Description",
        "disclaimer": "Partner Bank Disclaimer",
        "imageUrl": "https://dev-admin.evenfinancial.com/partner_image.gif"
      },
      "marketplace": {
        "uuid": "7a95da6d-2a03-4f58-beb0-d31eaddcfb15",
        "name": "Marketplace",
        "description": "Source of offers",
        "disclaimer": "Source disclaimer",
        "imageUrl": "https://dev-admin.evenfinancial.com/marketplace_image.gif"
      },
      "productType": "credit_card",
      "productSubType": "credit_card",
      "productSubTypeDisclaimer": "Iacta alea est",
      "url": "https://dev-offers.evenfinancial.com/ref/6bb3ed5c-f1d1-4c69-af1c-d02a4e028b3c",
      "details": {
        "cardName": "Credit Card",
        "cardImageUrl": "https://example.com/image",
        "cardPurposes": [
          "travel_incentives"
        ],
        "ratesUrl": "https://example.com/",
        "maxPurchaseApr": 15,
        "minPurchaseApr": 15,
        "maxPurchaseIntroApr": 0,
        "minPurchaseIntroApr": 0,
        "purchaseIntroAprTerm": 12,
        "purchaseIntroAprTermUnit": "month",
        "maxCashAdvanceApr": 15,
        "minCashAdvanceApr": 15,
        "maxCashAdvanceIntroApr": 0,
        "minCashAdvanceIntroApr": 0,
        "cashAdvanceIntroAprTerm": 12,
        "cashAdvanceIntroAprTermUnit": "month",
        "maxBalanceTransferApr": 15,
        "minBalanceTransferApr": 15,
        "maxBalanceTransferIntroApr": 0,
        "minBalanceTransferIntroApr": 0,
        "balanceTransferIntroAprTerm": 12,
        "balanceTransferIntroAprTermUnit": "month",
        "annualFee": 100,
        "annualIntroFee": 0,
        "annualIntroFeeTerm": 1,
        "details": [
          "Credit card detail"
        ],
        "additionalDetails": [
          "One click away credit card detail"
        ],
        "cardType": "visa",
        "minimumCreditLine": 5000,
        "minimumPenaltyApr": 10,
        "maximumPenaltyApr": 10,
        "balanceTransferFee": 25,
        "cashAdvanceFee": 5,
        "lateFee": 25,
        "foreignExchangeFee": 10,
        "accountOpeningFee": 0,
        "returnPaymentFee": 0,
        "monthlyServiceFee": 0,
        "recommendedCreditRatings": [
          "good"
        ]
      }
    }
  ],
  "mortgageOffers": [],
  "pendingResponses": [
    {
      "partner": {
        "uuid": "91d08be0-2a8c-4d28-b399-7e1b38e2522e",
        "name": "Partner Bank 2",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
        "disclaimer": "Cras vestibulum diam sed tempor sagittis.",
        "imageUrl": "https://images.evenfinancial.com/partnerBank2/partnerBank2Logo.png"
      },
      "productTypes": [
        "credit_card"
      ]
    }
  ]
}

400 Response

[
  {
    "message": "Cannot parse parameter uuid as UUID: Invalid UUID string: 123"
  }
]

Responses

Status Meaning Description Schema
200 OK Succesfully retrieved rate table RateTable
400 Bad Request Invalid UUID Inline
404 Not Found RateTable with the given UUID does not exist None

Response Schema

Status Code 400

Name Type Required Restrictions Description
anonymous [ApiError] false none none

Submit a lead and get a rate table

Code samples

const inputBody = '{
  "productTypes": [
    "credit_card"
  ],
  "personalInformation": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "city": "New York",
    "state": "NY",
    "primaryPhone": "2125556789",
    "address1": "45 West 21st Street",
    "address2": "5th Floor",
    "zipcode": "10010",
    "dateOfBirth": "1993-10-09"
  },
  "creditCardInformation": {
    "allowAnnualFee": true,
    "cardPurposes": [
      "travel_incentives"
    ]
  },
  "creditInformation": {
    "providedCreditRating": "excellent",
    "providedNumericCreditScore": 750
  },
  "financialInformation": {
    "employmentStatus": "employed",
    "employmentPayFrequency": "weekly",
    "annualIncome": 120000
  },
  "legalInformation": {
    "consentsToFcra": true,
    "consentsToTcpa": true,
    "tcpaLanguage": "I agree to be contacted by Even Financial and its partners at the telephone number(s) I have provided above to explore personal loan offers, including contact through automatic dialing systems, artificial or pre-recorded voice messaging, or text message. I understand my consent is not required as a condition to purchasing any goods or services from anyone."
  },
  "clientTags": {
    "hello": [
      "world",
      "there"
    ],
    "something": [
      "else"
    ]
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.evenfinancial.com/leads/rateTables',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /leads/rateTables

A shorthand operation for POST /leads followed by a POST /originator/rateTables. The response RateTable must still be queried until there are no more pendingResponses

Body parameter

{
  "productTypes": [
    "credit_card"
  ],
  "personalInformation": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "city": "New York",
    "state": "NY",
    "primaryPhone": "2125556789",
    "address1": "45 West 21st Street",
    "address2": "5th Floor",
    "zipcode": "10010",
    "dateOfBirth": "1993-10-09"
  },
  "creditCardInformation": {
    "allowAnnualFee": true,
    "cardPurposes": [
      "travel_incentives"
    ]
  },
  "creditInformation": {
    "providedCreditRating": "excellent",
    "providedNumericCreditScore": 750
  },
  "financialInformation": {
    "employmentStatus": "employed",
    "employmentPayFrequency": "weekly",
    "annualIncome": 120000
  },
  "legalInformation": {
    "consentsToFcra": true,
    "consentsToTcpa": true,
    "tcpaLanguage": "I agree to be contacted by Even Financial and its partners at the telephone number(s) I have provided above to explore personal loan offers, including contact through automatic dialing systems, artificial or pre-recorded voice messaging, or text message. I understand my consent is not required as a condition to purchasing any goods or services from anyone."
  },
  "clientTags": {
    "hello": [
      "world",
      "there"
    ],
    "something": [
      "else"
    ]
  }
}

Parameters

Name In Type Required Description
body body LeadRequest true A Lead object

Example responses

Succesfully created rate table

{
  "uuid": "2c6cb6e4-0aa2-4ab5-9109-8679de537e10",
  "leadUuid": "f823a7c0-586a-4fc3-9cfa-c38694b80b2c",
  "loanOffers": [],
  "specialOffers": [],
  "savingsOffers": [],
  "creditCardOffers": [
    {
      "uuid": "6e6a6043-afaf-4c61-971b-a035282548f0",
      "partner": {
        "uuid": "f7df60e5-13c0-4241-aba0-61a8877e142f",
        "name": "Partner Bank",
        "description": "Partner Bank Description",
        "disclaimer": "Partner Bank Disclaimer",
        "imageUrl": "https://dev-admin.evenfinancial.com/partner_image.gif"
      },
      "marketplace": {
        "uuid": "7a95da6d-2a03-4f58-beb0-d31eaddcfb15",
        "name": "Marketplace",
        "description": "Source of offers",
        "disclaimer": "Source disclaimer",
        "imageUrl": "https://dev-admin.evenfinancial.com/marketplace_image.gif"
      },
      "productType": "credit_card",
      "productSubType": "credit_card",
      "productSubTypeDisclaimer": "Iacta alea est",
      "url": "https://dev-offers.evenfinancial.com/ref/6bb3ed5c-f1d1-4c69-af1c-d02a4e028b3c",
      "details": {
        "cardName": "Credit Card",
        "cardImageUrl": "https://example.com/image",
        "cardPurposes": [
          "travel_incentives"
        ],
        "ratesUrl": "https://example.com/",
        "maxPurchaseApr": 15,
        "minPurchaseApr": 15,
        "maxPurchaseIntroApr": 0,
        "minPurchaseIntroApr": 0,
        "purchaseIntroAprTerm": 12,
        "purchaseIntroAprTermUnit": "month",
        "maxCashAdvanceApr": 15,
        "minCashAdvanceApr": 15,
        "maxCashAdvanceIntroApr": 0,
        "minCashAdvanceIntroApr": 0,
        "cashAdvanceIntroAprTerm": 12,
        "cashAdvanceIntroAprTermUnit": "month",
        "maxBalanceTransferApr": 15,
        "minBalanceTransferApr": 15,
        "maxBalanceTransferIntroApr": 0,
        "minBalanceTransferIntroApr": 0,
        "balanceTransferIntroAprTerm": 12,
        "balanceTransferIntroAprTermUnit": "month",
        "annualFee": 100,
        "annualIntroFee": 0,
        "annualIntroFeeTerm": 1,
        "details": [
          "Credit card detail"
        ],
        "additionalDetails": [
          "One click away credit card detail"
        ],
        "cardType": "visa",
        "minimumCreditLine": 5000,
        "minimumPenaltyApr": 10,
        "maximumPenaltyApr": 10,
        "balanceTransferFee": 25,
        "cashAdvanceFee": 5,
        "lateFee": 25,
        "foreignExchangeFee": 10,
        "accountOpeningFee": 0,
        "returnPaymentFee": 0,
        "monthlyServiceFee": 0,
        "recommendedCreditRatings": [
          "good"
        ]
      }
    }
  ],
  "mortgageOffers": [],
  "pendingResponses": [
    {
      "partner": {
        "uuid": "91d08be0-2a8c-4d28-b399-7e1b38e2522e",
        "name": "Partner Bank 2",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
        "disclaimer": "Cras vestibulum diam sed tempor sagittis.",
        "imageUrl": "https://images.evenfinancial.com/partnerBank2/partnerBank2Logo.png"
      },
      "productTypes": [
        "credit_card"
      ]
    }
  ]
}

400 Response

[
  {
    "attribute": "string",
    "type": "string",
    "details": {
      "property1": "string",
      "property2": "string"
    },
    "message": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Succesfully created rate table RateTable
400 Bad Request Bad Request Inline

Response Schema

Status Code 400

Name Type Required Restrictions Description
anonymous [ApiError] false none none

Offer Preview

Get loan preview offers

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.evenfinancial.com/offerPreview/loanOffers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /offerPreview/loanOffers

Get loan preview offers

Parameters

Name In Type Required Description
loanAmount query integer(int32) false none
providedCreditRating query ProvidedCreditRating false none
loanPurpose query LoanPurpose false none
zipCode query string false none

Enumerated Values

Parameter Value
providedCreditRating excellent
providedCreditRating good
providedCreditRating fair
providedCreditRating poor
providedCreditRating limited
providedCreditRating unknown
loanPurpose auto_purchase
loanPurpose auto_refinance
loanPurpose baby
loanPurpose boat
loanPurpose business
loanPurpose car_repair
loanPurpose cosmetic
loanPurpose credit_card_refi
loanPurpose debt_consolidation
loanPurpose emergency
loanPurpose engagement
loanPurpose green
loanPurpose home_improvement
loanPurpose home_purchase
loanPurpose home_refi
loanPurpose household_expenses
loanPurpose large_purchases
loanPurpose life_event
loanPurpose medical_dental
loanPurpose motorcycle
loanPurpose moving_relocation
loanPurpose rv
loanPurpose special_occasion
loanPurpose student_loan
loanPurpose student_loan_refi
loanPurpose taxes
loanPurpose vacation
loanPurpose wedding
loanPurpose other
loanPurpose unknown

Example responses

200 Response

[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "originator": {
      "key": "string",
      "name": "string",
      "description": "string",
      "images": [
        {
          "sizeKey": "string",
          "url": "string"
        }
      ],
      "disclaimer": "string",
      "companyUuid": "fdfe4f8f-1fcb-4da9-b882-48ec3a9a0d16"
    },
    "originatorId": "string",
    "termLength": 0,
    "termUnit": "day",
    "maxAmount": 0,
    "minAmount": 0,
    "maxApr": 0,
    "minApr": 0,
    "meanApr": 0,
    "feeRate": 0,
    "maxFeeRate": 0,
    "minFeeRate": 0,
    "feeFixed": 0,
    "maxFeeFixed": 0,
    "minFeeFixed": 0,
    "allowPrepayment": true,
    "prepaymentFee": 0,
    "monthlyPayment": 0,
    "maxMonthlyPayment": 0,
    "minMonthlyPayment": 0,
    "meanMonthlyPayment": 0,
    "maxTotalPayment": 0,
    "minTotalPayment": 0,
    "meanTotalPayment": 0,
    "terms": "string",
    "url": "string",
    "preQualified": true,
    "preApproved": true,
    "secured": true,
    "sponsored": true,
    "recommendationScore": 0,
    "payout": 0,
    "conversionProbability": 0,
    "productType": "credit_card",
    "productSubType": "credit_card",
    "productSubTypeDisclaimer": "string",
    "aprType": "variable"
  }
]

Responses

Status Meaning Description Schema
200 OK array of loan offers Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [LoanOffer] false none none
» originatorId string false none none
» termLength integer(int32) true none none

Get credit card preview offers

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.evenfinancial.com/offerPreview/creditCardOffers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /offerPreview/creditCardOffers

Get credit card preview offers

Parameters

Name In Type Required Description
providedCreditRating query ProvidedCreditRating false none
zipCode query string false none
cardPurposes query CardPurpose false none

Enumerated Values

Parameter Value
providedCreditRating excellent
providedCreditRating good
providedCreditRating fair
providedCreditRating poor
providedCreditRating limited
providedCreditRating unknown
cardPurposes balance_transfer
cardPurposes cash_back
cardPurposes earning_rewards
cardPurposes improve_credit
cardPurposes low_interest
cardPurposes new_to_credit
cardPurposes student
cardPurposes travel_incentives
cardPurposes unknown

Example responses

200 Response

[
  {
    "details": {
      "cardName": "string",
      "cardImageUrl": "string",
      "cardPurposes": [
        "balance_transfer"
      ],
      "ratesUrl": "string",
      "maxPurchaseApr": 0,
      "minPurchaseApr": 0,
      "purchaseAprText": "string",
      "maxPurchaseIntroApr": 0,
      "minPurchaseIntroApr": 0,
      "purchaseIntroAprTerm": 0,
      "purchaseIntroAprTermUnit": "day",
      "purchaseIntroAprText": "string",
      "maxCashAdvanceApr": 0,
      "minCashAdvanceApr": 0,
      "cashAdvanceAprText": "string",
      "maxCashAdvanceIntroApr": 0,
      "minCashAdvanceIntroApr": 0,
      "cashAdvanceIntroAprTerm": 0,
      "cashAdvanceIntroAprTermUnit": "day",
      "cashAdvanceIntroAprText": "string",
      "maxBalanceTransferApr": 0,
      "minBalanceTransferApr": 0,
      "balanceTransferAprText": "string",
      "maxBalanceTransferIntroApr": 0,
      "minBalanceTransferIntroApr": 0,
      "balanceTransferIntroAprTerm": 0,
      "balanceTransferIntroAprTermUnit": "day",
      "balanceTransferIntroAprText": "string",
      "maxAnnualFee": 0,
      "minAnnualFee": 0,
      "annualIntroFee": 0,
      "annualIntroFeeTerm": 0,
      "introOfferAmount": 0,
      "introOfferText": "string",
      "introOfferType": "miles",
      "details": [
        "string"
      ],
      "additionalDetails": [
        "string"
      ],
      "cardType": "visa",
      "minimumCreditLine": 0,
      "minimumPenaltyApr": 0,
      "maximumPenaltyApr": 0,
      "balanceTransferFee": 0,
      "cashAdvanceFee": 0,
      "lateFee": 0,
      "foreignExchangeFee": 0,
      "accountOpeningFee": 0,
      "returnPaymentFee": 0,
      "monthlyServiceFee": 0,
      "recommendedCreditRatings": [
        "excellent"
      ],
      "preQualified": true,
      "preApproved": true,
      "preSelected": true,
      "earningProgram": {
        "transactionLevelEarningScheme": [
          {
            "type": "basic",
            "groups": [
              {
                "earnRate": 0,
                "earnRateText": "string",
                "items": [
                  {
                    "type": "category",
                    "earnRate": 0,
                    "personalization": {
                      "totalSpent": 0,
                      "totalEarned": 0,
                      "totalValue": 0
                    },
                    "category": {
                      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                      "name": "string",
                      "displayName": "string",
                      "phrase": "string"
                    },
                    "merchant": {
                      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                      "name": "string",
                      "logo": "string",
                      "category": {
                        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                        "name": "string",
                        "displayName": "string",
                        "phrase": "string"
                      }
                    }
                  }
                ],
                "personalization": {
                  "totalSpent": 0,
                  "totalEarned": 0,
                  "totalValue": 0
                }
              }
            ],
            "detail": "string",
            "explaination": "string",
            "personalization": {
              "totalSpent": 0,
              "totalEarned": 0,
              "totalValue": 0
            }
          }
        ],
        "cardLevelEarningScheme": [
          {
            "type": "One Time",
            "name": "Sign-Up Bonus",
            "bonus": "string",
            "redemptionValue": "string",
            "requirement": "string",
            "personalization": {
              "minimumSpendMet": true,
              "qualifyingSpend": "string"
            }
          }
        ],
        "personalization": {
          "totalSpent": 0,
          "totalEarned": 0,
          "totalValue": 0
        }
      },
      "foreignTransactionFee": 0,
      "cardBenefits": [
        "No Foreign Transaction Fees"
      ]
    },
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "partner": {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "name": "string",
      "description": "string",
      "disclaimer": "string",
      "supportsPersonalizedOffers": true,
      "imageUrl": "string"
    },
    "marketplace": {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "name": "string",
      "description": "string",
      "disclaimer": "string",
      "supportsPersonalizedOffers": true,
      "imageUrl": "string"
    },
    "productType": "credit_card",
    "productSubType": "credit_card",
    "url": "string",
    "recommendationScore": 0,
    "disclaimer": "string",
    "productSubTypeDisclaimer": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK array of credit card offers Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [allOf] false none [An offer for a credit card]
»»»» detail string false none A phrase describing the context around the earning groups
»»»» explaination string false none A full sentence describing the context around the earning groups
»»» cardLevelEarningScheme [CardLevelEarningScheme] true none Card level bonuses, such as sign-on and anniversary bonuses
»» foreignTransactionFee number(float) false none Percentage represented in decimal format added to all foreign transactions
»» cardBenefits [CardBenefit] false none [Benefits or benefit categories related to a credit card]

Get savings preview offers

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.evenfinancial.com/offerPreview/savingsOffers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /offerPreview/savingsOffers

Get savings preview offers

Parameters

Name In Type Required Description
maxDepositAmount query number(int64) false none
minDepositAmount query number(int64) false none
zipCode query string false none

Example responses

200 Response

[
  {
    "details": {
      "name": "string",
      "description": "string",
      "details": "string",
      "rate": 0,
      "annualPercentYield": 0,
      "compoundingMethod": "annually",
      "introductoryPeriodMonths": 0,
      "introductoryRate": 0,
      "minimumDeposit": 0,
      "minimumDepositWithFees": 0,
      "monthlyFee": 0,
      "checkWriting": true,
      "effectiveAsOf": "2019-08-24T14:15:22Z"
    },
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "partner": {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "name": "string",
      "description": "string",
      "disclaimer": "string",
      "supportsPersonalizedOffers": true,
      "imageUrl": "string"
    },
    "marketplace": {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "name": "string",
      "description": "string",
      "disclaimer": "string",
      "supportsPersonalizedOffers": true,
      "imageUrl": "string"
    },
    "productType": "credit_card",
    "productSubType": "credit_card",
    "url": "string",
    "recommendationScore": 0,
    "disclaimer": "string",
    "productSubTypeDisclaimer": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK array of savings offers Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [allOf] false none [An offer for a savings account]

Offer Augmentation

The Offer Augmentation API is in Beta

Calculate rewards values

Code samples

const inputBody = '{
  "rateTableUuid": "f4dda88e-e5bc-42b2-81a8-c348b4b628db",
  "plaidAssetReportToken": "string",
  "aggregatedSpending": {
    "aggregates": [
      {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "amount": 0
      }
    ],
    "unit": "usd"
  },
  "annualSpend": true,
  "preferredRedemptionTypes": [
    {
      "redemptionTypeUuid": "7fa19829-5a02-45b6-8bbe-9ab885ffb806",
      "weight": 0
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.evenfinancial.com/offerAugmentation/rewardValueCalculations',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /offerAugmentation/rewardValueCalculations

For a rate table, will calculate the expected reward value for each credit card offer, based upon specified spending habits and preferred redemption types.

For non-credit-card offers, the rewardValue will always be null.

Body parameter

{
  "rateTableUuid": "f4dda88e-e5bc-42b2-81a8-c348b4b628db",
  "plaidAssetReportToken": "string",
  "aggregatedSpending": {
    "aggregates": [
      {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "amount": 0
      }
    ],
    "unit": "usd"
  },
  "annualSpend": true,
  "preferredRedemptionTypes": [
    {
      "redemptionTypeUuid": "7fa19829-5a02-45b6-8bbe-9ab885ffb806",
      "weight": 0
    }
  ]
}

Parameters

Name In Type Required Description
body body RewardValueCalculation false Create a reward value calculation

Example responses

200 Response

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "rateTableUuid": "f4dda88e-e5bc-42b2-81a8-c348b4b628db",
  "plaidAssetReportToken": "string",
  "aggregatedSpending": {
    "aggregates": [
      {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "amount": 0
      }
    ],
    "unit": "usd"
  },
  "annualSpend": true,
  "preferredRedemptionTypes": [
    {
      "redemptionTypeUuid": "7fa19829-5a02-45b6-8bbe-9ab885ffb806",
      "weight": 0
    }
  ],
  "offerCalculations": [
    {
      "staticOfferUuid": "00163cbf-115c-4779-927f-98c2facfe864",
      "earningProgram": [
        {
          "transactionLevelEarningScheme": [
            {
              "type": "basic",
              "groups": [
                {
                  "earnRate": 0,
                  "earnRateText": "string",
                  "items": [
                    {
                      "type": "category",
                      "earnRate": 0,
                      "personalization": {
                        "totalSpent": 0,
                        "totalEarned": 0,
                        "totalValue": 0
                      },
                      "category": {
                        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                        "name": "string",
                        "displayName": "string",
                        "phrase": "string"
                      },
                      "merchant": {
                        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                        "name": "string",
                        "logo": "string",
                        "category": {
                          "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                          "name": "string",
                          "displayName": "string",
                          "phrase": "string"
                        }
                      }
                    }
                  ],
                  "personalization": {
                    "totalSpent": 0,
                    "totalEarned": 0,
                    "totalValue": 0
                  }
                }
              ],
              "detail": "string",
              "explaination": "string",
              "personalization": {
                "totalSpent": 0,
                "totalEarned": 0,
                "totalValue": 0
              }
            }
          ],
          "cardLevelEarningScheme": [
            {
              "type": "One Time",
              "name": "Sign-Up Bonus",
              "bonus": "string",
              "redemptionValue": "string",
              "requirement": "string",
              "personalization": {
                "minimumSpendMet": true,
                "qualifyingSpend": "string"
              }
            }
          ],
          "personalization": {
            "totalSpent": 0,
            "totalEarned": 0,
            "totalValue": 0
          }
        }
      ]
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e"
}

Not authorized

[
  {
    "message": "Access token is missing"
  }
]

Responses

Status Meaning Description Schema
200 OK Reward value calculated successfully RewardValueCalculation
401 Unauthorized Not authorized Inline

Response Schema

Status Code 401

Name Type Required Restrictions Description
anonymous [ApiError] false none none

Get spending categories

Code samples


const headers = {
  'Accept':'application/json'
};

fetch('https://api.evenfinancial.com/offerAugmentation/spendingCategories',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /offerAugmentation/spendingCategories

Returns a list of spending categories to use when calculating reward values for a rate table.

Example responses

Successfully returned spending categories

[
  {
    "uuid": "d0c91bff-8336-48ba-a6f2-4b4f7d2c8526",
    "name": "Travel"
  },
  {
    "uuid": "78f8ae08-0e72-4336-a708-3c9eba246085",
    "parentUuid": "d0c91bff-8336-48ba-a6f2-4b4f7d2c8526",
    "name": "Airfare"
  }
]

Not authorized

[
  {
    "message": "Access token is missing"
  }
]

Responses

Status Meaning Description Schema
200 OK Successfully returned spending categories Inline
401 Unauthorized Not authorized Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [SpendingCategory] false none none

Status Code 401

Name Type Required Restrictions Description
anonymous [ApiError] false none none

Get redemption types

Code samples


const headers = {
  'Accept':'application/json'
};

fetch('https://api.evenfinancial.com/offerAugmentation/redemptionTypes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /offerAugmentation/redemptionTypes

Returns a list of redemption types for use when calculating reward values for a rate table.

Example responses

Successfully returned redemption types

[
  {
    "uuid": "982f343e-68cc-4937-8ed8-5105b6f99728",
    "name": "Flights"
  },
  {
    "uuid": "cc430374-a3e6-4c51-9054-a9766b9bb356",
    "parentUuid": "982f343e-68cc-4937-8ed8-5105b6f99728",
    "name": "American Airlines"
  }
]

Not authorized

[
  {
    "message": "Access token is missing"
  }
]

Responses

Status Meaning Description Schema
200 OK Successfully returned redemption types Inline
401 Unauthorized Not authorized Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [RedemptionType] false none none

Status Code 401

Name Type Required Restrictions Description
anonymous [ApiError] false none none

Add Plaid asset report token to lead

Code samples

const inputBody = '{
  "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
  "token": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.evenfinancial.com/offerAugmentation/plaidAssetReportTokens',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /offerAugmentation/plaidAssetReportTokens

Associated a Plaid asset report token with a lead. This will be used by the POST /offerAugmentation/rewardValueCalculations endpoint to perform the calculation.

Body parameter

{
  "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
  "token": "string"
}

Parameters

Name In Type Required Description
body body PlaidAssetReportToken false Create a Plaid asset report token

Example responses

200 Response

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
  "token": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e"
}

Not authorized

[
  {
    "message": "Access token is missing"
  }
]

Token already associated with lead

[
  {
    "attribute": "token",
    "message": "The token '514fd8c2' is already associated with the lead",
    "type": "alreadyAssociated",
    "details": {
      "specified": "514fd8c2"
    }
  }
]

Responses

Status Meaning Description Schema
200 OK Token added successfully PlaidAssetReportToken
401 Unauthorized Not authorized Inline
422 Unprocessable Entity Token already associated with lead Inline

Response Schema

Status Code 401

Name Type Required Restrictions Description
anonymous [ApiError] false none none

Status Code 422

Name Type Required Restrictions Description
anonymous [ApiError] false none none

UI Events

Record the beginning of a new session

Code samples

const inputBody = '{
  "sessionUuid": "0688aee8-ffa9-4d26-9262-47526493535e"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.evenfinancial.com/uiEvent/sessionInits',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /uiEvent/sessionInits

Records that a user has begun a new session. A session can be any extended interaction with the Even API by an individual user.

The most common use case is to initiate a session when a user lands on a financial offer search experience. You can either supply sessionUuid in the request body, or submit an empty body and one will be generated for you. In either case, the returned sessionUuid should be included in the lead body of subsequent rate table requests.

Body parameter

{
  "sessionUuid": "0688aee8-ffa9-4d26-9262-47526493535e"
}

Parameters

Name In Type Required Description
body body SessionInitNew false none

Example responses

201 Response

{
  "id": 0,
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "sessionUuid": "0688aee8-ffa9-4d26-9262-47526493535e",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e"
}

Invalid request body JSON format

[
  {
    "attribute": "uuid",
    "type": "notUuid",
    "message": "uuid must be a uuid, but is 123",
    "details": {
      "specified": "123"
    }
  }
]

Responses

Status Meaning Description Schema
201 Created Session initiated successfully SessionInit
400 Bad Request Invalid request body JSON format Inline

Response Schema

Status Code 400

Name Type Required Restrictions Description
anonymous [ApiError] false none none

Record an offer display

Code samples

const inputBody = '{
  "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
  "rateTableUuid": "f4dda88e-e5bc-42b2-81a8-c348b4b628db",
  "offerUuid": "5d19bb70-d72b-45ae-9b5e-c4257877bdbb"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.evenfinancial.com/uiEvent/offerDisplays',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /uiEvent/offerDisplays

Records that an offer was displayed to a user.

You can also use a pixel to record this event, by rendering an img tag in the DOM alongside the offer, where the src URL follows this pattern:

/uiEvent/offerDisplays/{leadUuid}/{rateTableUuid}/{offerUuid}/pixel.gif

So, for example:

<img src="https://api.evenfinancial.com/uiEvent/offerDisplays/39197a3f-d2f4-43eb-9999-7f7a154d79bc/eb0e6cc4-df13-42fe-b254-c58c9b35a3d6/a698f56f-0946-4642-9720-5f280bc8b2e0/pixel.gif">

The URL will always respond successfully with a transparent 1x1 GIF.

Body parameter

{
  "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
  "rateTableUuid": "f4dda88e-e5bc-42b2-81a8-c348b4b628db",
  "offerUuid": "5d19bb70-d72b-45ae-9b5e-c4257877bdbb"
}

Parameters

Name In Type Required Description
body body OfferDisplay false none

Example responses

201 Response

{
  "id": 0,
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
  "rateTableUuid": "f4dda88e-e5bc-42b2-81a8-c348b4b628db",
  "offerUuid": "5d19bb70-d72b-45ae-9b5e-c4257877bdbb",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e"
}

Invalid request body JSON format

[
  {
    "attribute": "leadUuid",
    "type": "missing",
    "message": "leadUuid must be specified"
  }
]

Responses

Status Meaning Description Schema
201 Created Offer display event recorded successfully OfferDisplay
400 Bad Request Invalid request body JSON format Inline

Response Schema

Status Code 400

Name Type Required Restrictions Description
anonymous [ApiError] false none none

UI Utils

Get university names

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.evenfinancial.com/leads/universities?limit=1',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /leads/universities

Returns a list of possible university names for use in a lead's educationInformation.universityAttened field given a user input fragment.

Parameters

Name In Type Required Description
name query string false Part of a university name for search
offset query integer(int64) false at what offset do you want to start looking at, default 0
limit query integer(int32) true limit results

Example responses

A list of completion suggestions for a full supported university name

[
  "Johns Hopkins University",
  "Johns Hopkins University - Carey Business School",
  "Johns Hopkins University - Paul Nifle School of Advanced International Studies",
  "Johns Hopkins University - Peabody Conservatory of Music",
  "Johns Hopkins University - School of Arts & Science",
  "Johns Hopkins University - School of Medicine",
  "Johns Hopkins University - School of Nursing",
  "Johns Hopkins University - School of Public Health",
  "Johns Hopkins University - SPSBE",
  "Saint Johns University",
  "Cornell University Johnson, MBA",
  "Johnson College",
  "Johnson County Community College",
  "Johnson University",
  "Johnson & Wales University",
  "Northern Vermont University - Johnson (FKA Johnson State College + Lyndon State College)",
  "Northern Vermont University - Lyndon (FKA Lyndon State College + Johnson State College)",
  "University of Pittsburgh - Johnstown"
]

Responses

Status Meaning Description Schema
200 OK A list of completion suggestions for a full supported university name Inline

Response Schema

Code samples


const headers = {
  'Accept':'application/json'
};

fetch('https://api.evenfinancial.com/uiUtil/featuredFinancialInstitutions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /uiUtil/featuredFinancialInstitutions

Returns a list of selected financial institution logos, in the preferred order, to be used for display on the initial page of a UX, before the user enters their information.

Example responses

200 Response

[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "logoUrl": "string"
  }
]
Status Meaning Description Schema
200 OK The featured financial institutions belonging to the channel partner Inline
400 Bad Request Invalid request provided Inline

Status Code 200

Name Type Required Restrictions Description
anonymous [FeaturedFinancialInstitution] false none none

Status Code 400

Name Type Required Restrictions Description
anonymous [ApiError] false none none

Analytics

The Analytics API is in Beta

Get lead events

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.evenfinancial.com/supplyAnalytics/leadEvents',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /supplyAnalytics/leadEvents

A variety of event types can be associated with a lead, including:

This endpoint provides access to these events for analysis. You can stream all events by making paginated requests. The first of these requests would be:

GET /supplyAnalytics/leadEvents

This will return the first page of events. To get the next page, simply request the URL that was returned with the last result set:

GET /supplyAnalytics/leadEvents?timestamp=2019-11-19T16:00:00Z

When backfilling, each page will have a maximum of roughly 1000 events. Once caught up, the page will contain the last hour's events, so you should poll hourly. Events will become available in the API within 90 minutes of when they initially occur. Event history only goes back to 2020-08-01.

Parameters

Name In Type Required Description
timestamp query string(date-time) false The minium eventCreatedAt time that should be returned.

Detailed descriptions

timestamp: The minium eventCreatedAt time that should be returned.

Example responses

Success

{
  "data": [
    {
      "id": "356a192b7913b04c54574d18c28d46e6395428ab",
      "leadUuid": "39afdb4a-ef26-42ed-a313-e28288f95099",
      "leadCreatedAt": "2019-10-10T20:42:06Z",
      "eventType": "apiApproved",
      "eventCreatedAt": "2019-10-10T20:44:28Z",
      "financialInstitutionUuid": "da14e06b-0866-4f02-a3b2-9443501b25b9",
      "financialInstitutionName": "LendingClub"
    }
  ],
  "nextUrl": "https://api.evenfinancial.com/supplyAnalytics/leadEvents?timestamp=2019-10-10T20:00:00Z"
}
{
  "data": [
    {
      "id": "da4b9237bacccdf19c0760cab7aec4a8359010b0",
      "leadUuid": "4bbb25a6-6fcf-4ed3-88f9-6daacb0f8b33",
      "leadCreatedAt": "2019-09-21T11:24:45Z",
      "eventType": "offerClicked",
      "eventCreatedAt": "2019-09-22T17:44:22Z",
      "financialInstitutionUuid": "da14e06b-0866-4f02-a3b2-9443501b25b9",
      "financialInstitutionName": "OpenSky®",
      "offerUuid": "5243140e-0a98-4301-9b6b-1283a52b857b",
      "offerName": "OpenSky® Secured Visa® Credit Card"
    }
  ],
  "nextUrl": "https://api.evenfinancial.com/supplyAnalytics/leadEvents?timestamp=2019-09-22T17:00:00Z"
}

Not authorized

[
  {
    "message": "Access token is missing"
  }
]
[
  {
    "message": "Access token is missing"
  }
]

Invalid query parameters

[
  {
    "attribute": "timestamp",
    "type": "notDateTime",
    "message": "timestamp must be date-time, but was 123"
  }
]

Responses

Status Meaning Description Schema
200 OK Success LeadEventResponse
401 Unauthorized Not authorized Inline
422 Unprocessable Entity Invalid query parameters Inline

Response Schema

Status Code 401

Name Type Required Restrictions Description
anonymous [ApiError] false none none

Status Code 422

Name Type Required Restrictions Description
anonymous [ApiError] false none none

Get revenue summaries

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://api.evenfinancial.com/analytics/revenueSummaries',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /analytics/revenueSummaries

Provides historical revenue statistics and funnel performance. The metrics returned are aggregated either by a time period (e.g. day, week or month) and or lead attributes such as credit rating, loan purpose or referral URL.

For each aggregated group, the result includes the number of leads, submitted applications, funded applications, along with the amount of revenue. Either attributed or booked revenue is supported.

For example, to get attributed monthly revenue, grouped by credit rating for Q1 of 2019, make the following request:

GET /analytics/revenueSummaries?groupBy=creditRating&minTime=2019-01-01&maxTime=2019-03-31&revenueType=attributed

Parameters

Name In Type Required Description
revenueType query array[string] false There are two dates associated with revenue:
minDate query string(date) false Results will only represent revenue either booked or attributed on or after this date, if specified. If not specified, defaults to 30 days ago. Date format must be YYYY-MM-DD.
maxDate query string(date) false Results will only represent revenue either booked or attributed on or before this date, if specified. If not specified, defaults to today. Date format must be YYYY-MM-DD.
groupBy query array[string] false The results can be aggregated by only one field at a time. If multiple values are specified, then the first value will be used. If none is specified, then the default is day. Time range grouping (i.e., one of day, week or month) will use the create time for the lead.
clientTagKey query ClientTags false Results will only represent leads that have a client tag with the specified key. If specified, the results will be grouped by the distinct values of the client tag. Consequently, anything specified by the groupBy parameter will be ignored.
subAccountUuid query string(uuid) false Results will only represent leads that belong to the sub-account corresponding to the specified UUID.
companyUuid query string(uuid) false Results will only represent leads that are affiliated with a specific company, which itself may have one or more sub accounts. For internal use only. For internal users, this is absolutely required.

Detailed descriptions

revenueType: There are two dates associated with revenue:

The minDate and maxDate parameters will filter against the specified date type. If none is specified, then the default is attributed.

Also, the results will only include a totalAttributedRevenue field if revenueType is attributed, and will only include totalBookedRevenue and totalUnattributedRevenue if it's booked.

minDate: Results will only represent revenue either booked or attributed on or after this date, if specified. If not specified, defaults to 30 days ago. Date format must be YYYY-MM-DD.

maxDate: Results will only represent revenue either booked or attributed on or before this date, if specified. If not specified, defaults to today. Date format must be YYYY-MM-DD.

groupBy: The results can be aggregated by only one field at a time. If multiple values are specified, then the first value will be used. If none is specified, then the default is day. Time range grouping (i.e., one of day, week or month) will use the create time for the lead.

The creditRating, loanPurpose, and referralUrl fields in the response body will not show up in the results unless explicitly aggregated on. Similarly leadCreatedAtMin and leadCreatedAtMax will not show unless grouped by time range.

If the clientTag query parameter is specified, then any value specified here will be ignored.

clientTagKey: Results will only represent leads that have a client tag with the specified key. If specified, the results will be grouped by the distinct values of the client tag. Consequently, anything specified by the groupBy parameter will be ignored.

subAccountUuid: Results will only represent leads that belong to the sub-account corresponding to the specified UUID.

companyUuid: Results will only represent leads that are affiliated with a specific company, which itself may have one or more sub accounts. For internal use only. For internal users, this is absolutely required.

Enumerated Values

Parameter Value
revenueType attributed
revenueType booked
groupBy day
groupBy week
groupBy month
groupBy creditRating
groupBy loanPurpose
groupBy referralUrl

Example responses

Successfully returned records

[
  {
    "leadCreatedAtMin": "2020-01-01",
    "leadCreatedAtMax": "2020-02-01",
    "leadCount": 500,
    "submittedApplicatonCount": 500,
    "preApprovedApplicationCount": 300,
    "offerClickCount": 100,
    "fundedCount": 90,
    "totalAttributedRevenue": 3000
  },
  {
    "leadCreatedAtMin": "2020-02-01",
    "leadCreatedAtMax": "2020-03-01",
    "leadCount": 600,
    "submittedApplicatonCount": 400,
    "preApprovedApplicationCount": 200,
    "offerClickCount": 100,
    "fundedCount": 70,
    "totalAttributedRevenue": 2000
  }
]

Not authorized

[
  {
    "message": "Access token is missing"
  }
]
[
  {
    "message": "Access token is missing"
  }
]

Invalid query parameters

[
  {
    "attribute": "groupBy",
    "type": "notInEnum",
    "message": "groupBy must be one of \"day\", \"week\", \"month\", \"creditRating\", \"loanPurpose\", but is \"year\"",
    "details": {
      "specified": "year",
      "enum": [
        "day",
        "week",
        "month",
        "creditRating",
        "loanPurpose"
      ]
    }
  }
]

Responses

Status Meaning Description Schema
200 OK Successfully returned records Inline
401 Unauthorized Not authorized Inline
422 Unprocessable Entity Invalid query parameters Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [RevenueSummary] false none none

Status Code 401

Name Type Required Restrictions Description
anonymous [ApiError] false none none

Status Code 422

Name Type Required Restrictions Description
anonymous [ApiError] false none none

Schemas

AggregatedSpending

{
  "aggregates": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "amount": 0
    }
  ],
  "unit": "usd"
}

A representation of a user's spending, aggregated over a period of time

Properties

Name Type Required Restrictions Description
aggregates [SpendingAggregate] false none none

AnalyticsEventType

"leadCreated"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous leadCreated
anonymous appSubmitted
anonymous apiApproved
anonymous apiRejected
anonymous offerClicked
anonymous applied
anonymous approved
anonymous listed
anonymous opened
anonymous funded
anonymous conversion

AnalyticsOfferProductType

"loan"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous loan
anonymous savings
anonymous creditCard
anonymous special

ApiError

{
  "attribute": "string",
  "type": "string",
  "details": {
    "property1": "string",
    "property2": "string"
  },
  "message": "string"
}

Properties

Name Type Required Restrictions Description
attribute string false read-only none
type string false read-only none

ApiErrorDetails

{
  "property1": "string",
  "property2": "string"
}

Properties

Name Type Required Restrictions Description
additionalProperties string false none none

AprType

"variable"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous variable
anonymous regular
anonymous fixed

BankAccountType

"checking"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous checking
anonymous savings
anonymous other
anonymous unknown

BonusPersonalization

{
  "minimumSpendMet": true,
  "qualifyingSpend": "string"
}

Personalized values calculated for a specific bonus, such as a Sign On Bonus

Properties

Name Type Required Restrictions Description
minimumSpendMet boolean false none Were the conditions of the bonus met
qualifyingSpend string false none The amount of spend the user had within the time period of the bonus

CardBenefit

"No Foreign Transaction Fees"

Benefits or benefit categories related to a credit card

Properties

Name Type Required Restrictions Description
anonymous string false none Benefits or benefit categories related to a credit card

Enumerated Values

Property Value
anonymous No Foreign Transaction Fees
anonymous Purchase Protection
anonymous Return Protection
anonymous Price Protection
anonymous Fraud Protection
anonymous Extended Warranty
anonymous Travel Accident Insurance
anonymous Trip Interruption Insurance
anonymous Car Rental Insurance
anonymous Baggage Insurance
anonymous Baggage Delay Insurance
anonymous Hotel Burglary Insurance
anonymous Travel & Emergency Assistance
anonymous Roadside Assistance
anonymous Concierge Service
anonymous Lounge Access
anonymous Identity Theft Assistance
anonymous In-Flight Savings
anonymous Free Checked Bag
anonymous Priority Boarding
anonymous No Blackout Dates
anonymous Free Companion Ticket
anonymous Discount Companion Ticket
anonymous Global Entry or TSA PreCheck
anonymous Private Jet Perks
anonymous Lounge Access Discount
anonymous 24/7 Cardholder Support
anonymous Authorized User
anonymous Entertainment Access
anonymous Airline Fee Credit
anonymous Late Fee Pass
anonymous Credit Score Reporting
anonymous No Flight Change Fees
anonymous 24/7 Account Monitoring
anonymous Amex Offers
anonymous Visa Signature Offers
anonymous MasterCard Offers
anonymous Free Hotel Stay
anonymous Extended Hotel Stay
anonymous Dining Concierge
anonymous 2 Lounge Passes
anonymous Hilton Honors Silver Membership
anonymous Hilton Honors Gold Membership
anonymous World of Hyatt Discoverist Status
anonymous SPG Gold Membership
anonymous Marriott Rewards Silver Status
anonymous Hertz Presidents Circle Elite Status
anonymous 2 Free Checked Bags
anonymous Auto Discounts
anonymous InCircle Partnership
anonymous ShopRunner
anonymous WiFi Access
anonymous ShopSafe
anonymous BoA Preferred Rewards
anonymous MasterCard Fuel Rewards Network
anonymous Missed Event Ticket Protection
anonymous Account Freezing
anonymous Cell Phone Protection
anonymous GPA Rewards
anonymous In-Flight WiFi Credit
anonymous Citi Private Pass
anonymous Priceless Cities
anonymous The Hotel Collection
anonymous By Invitation Only
anonymous Luxury Hotel Collection
anonymous Expedia+ Silver Status
anonymous Expedia+ Gold Status
anonymous $100 American Airlines Discount
anonymous Disney Parks Perks and Savings
anonymous Ritz-Carlton Gold Elite Status
anonymous Ritz-Carlton Club Level Upgrade
anonymous Annual Travel Credit
anonymous IHG Platinum Elite Status
anonymous QuickBooks Connect
anonymous ReceiptMatch
anonymous Employee Spending Limits
anonymous FX International Payments
anonymous No Pre-Set Spending Limit
anonymous Purchase Financing
anonymous Amex Open Savings
anonymous Amazon Special Financing
anonymous $100 Ritz-Carlton Hotel Credit
anonymous British Airways Companion Ticket
anonymous Mercedes-Benz Gift Certificates
anonymous Mercedes-Benz Excess Mileage Waiver
anonymous JetBlue Annual Statement Credit
anonymous 20% Discount on Delta Flights for Delta Private Jet Members
anonymous Expense Report Features
anonymous Business Cell Phone Protection
anonymous Free Shipping on most Target.com orders
anonymous 30 Extra Days for Returns
anonymous Free clothing altertaions
anonymous Personal shopping
anonymous Shopmyway Savings
anonymous Online Subscription Credit
anonymous Uber Exclusive Access
anonymous Airline Benefits
anonymous Hotel Benefits
anonymous Other Travel Benefits
anonymous Emergency Assistance
anonymous Experiences
anonymous Shopping Benefits
anonymous Cardholder Benefits
anonymous Enhanced Security
anonymous Business Benefits
anonymous Other Benefits
anonymous In-Flight Discounts
anonymous Fee Coverage
anonymous Flight Credits & Discounts
anonymous Hotel Membership Status
anonymous Hotel Credit & Free Stays
anonymous Travel Credit
anonymous Travel Experiences Programs
anonymous Car Rental Membership Status
anonymous Extra Gas Rewards
anonymous Shopping Protection
anonymous Shopping Discounts
anonymous Free Shipping
anonymous The Boingo American Express Preferred Plan
anonymous AirSpace Lounge
anonymous Uber Monthly Credit
anonymous Ride Share Benefits
anonymous Delta Sky Club
anonymous Admirals Club Membership
anonymous Priority Pass Select Membership (Prestige)
anonymous Priority Pass Select Membership (Standard Plus)
anonymous Daily Breakfast
anonymous Early Check-in & Late Check-out
anonymous Room Upgrades
anonymous Complementary WiFi
anonymous Amex Hotel Collection Credit
anonymous Temporary Account Numbers
anonymous One-Time 50% Discount on Companion Ticket
anonymous Airline Travel Credit
anonymous United Club Membership
anonymous Chip Technology
anonymous Earn More Miles for Sharing Travel Stories
anonymous Mastercard World Elite Concierge and Luxury Travel Benefits
anonymous 20% Savings on Delta In-Flight Purchases
anonymous 25% Savings on United In-Flight Food and Drink Purchases
anonymous $100 Hilton Properties Credit
anonymous $250 Hilton Resort Credit
anonymous Hilton Honors Diamond Membership
anonymous Free Birthday Gift
anonymous 2x Points During Your Birthday Month
anonymous Car Rental VIP Perks
anonymous Free shipping with the purchase of a bra
anonymous Monthly Dining Credit
anonymous Amazon Prime Student

CardLevelEarningScheme

{
  "type": "One Time",
  "name": "Sign-Up Bonus",
  "bonus": "string",
  "redemptionValue": "string",
  "requirement": "string",
  "personalization": {
    "minimumSpendMet": true,
    "qualifyingSpend": "string"
  }
}

An earning event which is based on spend or is over time

Properties

None

CardLevelEarningSchemeName

"Sign-Up Bonus"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous Sign-Up Bonus
anonymous Anniversary Bonus
anonymous Annual Bonus
anonymous Usage Bonus

CardLevelEarningSchemeType

"One Time"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous One Time
anonymous Recurring

CardPurpose

"balance_transfer"

Purposes or categories related to a credit card

Properties

Name Type Required Restrictions Description
anonymous string false none Purposes or categories related to a credit card

Enumerated Values

Property Value
anonymous balance_transfer
anonymous cash_back
anonymous earning_rewards
anonymous improve_credit
anonymous low_interest
anonymous new_to_credit
anonymous student
anonymous travel_incentives
anonymous unknown

CardType

"visa"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous visa
anonymous mastercard
anonymous american_express
anonymous discover

CitizenshipStatus

"citizen"

Citizenship status

Properties

Name Type Required Restrictions Description
anonymous string false none Citizenship status

Enumerated Values

Property Value
anonymous citizen
anonymous permanent_resident
anonymous other
anonymous unknown

CompoundingMethod

"annually"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous annually
anonymous continuous
anonymous daily
anonymous monthly
anonymous quarterly
anonymous semiAnnually
anonymous simple
anonymous weekly

CreditCardOffer

{
  "details": {
    "cardName": "string",
    "cardImageUrl": "string",
    "cardPurposes": [
      "balance_transfer"
    ],
    "ratesUrl": "string",
    "maxPurchaseApr": 0,
    "minPurchaseApr": 0,
    "purchaseAprText": "string",
    "maxPurchaseIntroApr": 0,
    "minPurchaseIntroApr": 0,
    "purchaseIntroAprTerm": 0,
    "purchaseIntroAprTermUnit": "day",
    "purchaseIntroAprText": "string",
    "maxCashAdvanceApr": 0,
    "minCashAdvanceApr": 0,
    "cashAdvanceAprText": "string",
    "maxCashAdvanceIntroApr": 0,
    "minCashAdvanceIntroApr": 0,
    "cashAdvanceIntroAprTerm": 0,
    "cashAdvanceIntroAprTermUnit": "day",
    "cashAdvanceIntroAprText": "string",
    "maxBalanceTransferApr": 0,
    "minBalanceTransferApr": 0,
    "balanceTransferAprText": "string",
    "maxBalanceTransferIntroApr": 0,
    "minBalanceTransferIntroApr": 0,
    "balanceTransferIntroAprTerm": 0,
    "balanceTransferIntroAprTermUnit": "day",
    "balanceTransferIntroAprText": "string",
    "maxAnnualFee": 0,
    "minAnnualFee": 0,
    "annualIntroFee": 0,
    "annualIntroFeeTerm": 0,
    "introOfferAmount": 0,
    "introOfferText": "string",
    "introOfferType": "miles",
    "details": [
      "string"
    ],
    "additionalDetails": [
      "string"
    ],
    "cardType": "visa",
    "minimumCreditLine": 0,
    "minimumPenaltyApr": 0,
    "maximumPenaltyApr": 0,
    "balanceTransferFee": 0,
    "cashAdvanceFee": 0,
    "lateFee": 0,
    "foreignExchangeFee": 0,
    "accountOpeningFee": 0,
    "returnPaymentFee": 0,
    "monthlyServiceFee": 0,
    "recommendedCreditRatings": [
      "excellent"
    ],
    "preQualified": true,
    "preApproved": true,
    "preSelected": true,
    "earningProgram": {
      "transactionLevelEarningScheme": [
        {
          "type": "basic",
          "groups": [
            {
              "earnRate": 0,
              "earnRateText": "string",
              "items": [
                {
                  "type": "category",
                  "earnRate": 0,
                  "personalization": {
                    "totalSpent": 0,
                    "totalEarned": 0,
                    "totalValue": 0
                  },
                  "category": {
                    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                    "name": "string",
                    "displayName": "string",
                    "phrase": "string"
                  },
                  "merchant": {
                    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                    "name": "string",
                    "logo": "string",
                    "category": {
                      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                      "name": "string",
                      "displayName": "string",
                      "phrase": "string"
                    }
                  }
                }
              ],
              "personalization": {
                "totalSpent": 0,
                "totalEarned": 0,
                "totalValue": 0
              }
            }
          ],
          "detail": "string",
          "explaination": "string",
          "personalization": {
            "totalSpent": 0,
            "totalEarned": 0,
            "totalValue": 0
          }
        }
      ],
      "cardLevelEarningScheme": [
        {
          "type": "One Time",
          "name": "Sign-Up Bonus",
          "bonus": "string",
          "redemptionValue": "string",
          "requirement": "string",
          "personalization": {
            "minimumSpendMet": true,
            "qualifyingSpend": "string"
          }
        }
      ],
      "personalization": {
        "totalSpent": 0,
        "totalEarned": 0,
        "totalValue": 0
      }
    },
    "foreignTransactionFee": 0,
    "cardBenefits": [
      "No Foreign Transaction Fees"
    ]
  },
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "partner": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "description": "string",
    "disclaimer": "string",
    "supportsPersonalizedOffers": true,
    "imageUrl": "string"
  },
  "marketplace": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "description": "string",
    "disclaimer": "string",
    "supportsPersonalizedOffers": true,
    "imageUrl": "string"
  },
  "productType": "credit_card",
  "productSubType": "credit_card",
  "url": "string",
  "recommendationScore": 0,
  "disclaimer": "string",
  "productSubTypeDisclaimer": "string"
}

An offer for a credit card

Properties

None

CreditCardOfferDetails

{
  "cardName": "string",
  "cardImageUrl": "string",
  "cardPurposes": [
    "balance_transfer"
  ],
  "ratesUrl": "string",
  "maxPurchaseApr": 0,
  "minPurchaseApr": 0,
  "purchaseAprText": "string",
  "maxPurchaseIntroApr": 0,
  "minPurchaseIntroApr": 0,
  "purchaseIntroAprTerm": 0,
  "purchaseIntroAprTermUnit": "day",
  "purchaseIntroAprText": "string",
  "maxCashAdvanceApr": 0,
  "minCashAdvanceApr": 0,
  "cashAdvanceAprText": "string",
  "maxCashAdvanceIntroApr": 0,
  "minCashAdvanceIntroApr": 0,
  "cashAdvanceIntroAprTerm": 0,
  "cashAdvanceIntroAprTermUnit": "day",
  "cashAdvanceIntroAprText": "string",
  "maxBalanceTransferApr": 0,
  "minBalanceTransferApr": 0,
  "balanceTransferAprText": "string",
  "maxBalanceTransferIntroApr": 0,
  "minBalanceTransferIntroApr": 0,
  "balanceTransferIntroAprTerm": 0,
  "balanceTransferIntroAprTermUnit": "day",
  "balanceTransferIntroAprText": "string",
  "maxAnnualFee": 0,
  "minAnnualFee": 0,
  "annualIntroFee": 0,
  "annualIntroFeeTerm": 0,
  "introOfferAmount": 0,
  "introOfferText": "string",
  "introOfferType": "miles",
  "details": [
    "string"
  ],
  "additionalDetails": [
    "string"
  ],
  "cardType": "visa",
  "minimumCreditLine": 0,
  "minimumPenaltyApr": 0,
  "maximumPenaltyApr": 0,
  "balanceTransferFee": 0,
  "cashAdvanceFee": 0,
  "lateFee": 0,
  "foreignExchangeFee": 0,
  "accountOpeningFee": 0,
  "returnPaymentFee": 0,
  "monthlyServiceFee": 0,
  "recommendedCreditRatings": [
    "excellent"
  ],
  "preQualified": true,
  "preApproved": true,
  "preSelected": true,
  "earningProgram": {
    "transactionLevelEarningScheme": [
      {
        "type": "basic",
        "groups": [
          {
            "earnRate": 0,
            "earnRateText": "string",
            "items": [
              {
                "type": "category",
                "earnRate": 0,
                "personalization": {
                  "totalSpent": 0,
                  "totalEarned": 0,
                  "totalValue": 0
                },
                "category": {
                  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                  "name": "string",
                  "displayName": "string",
                  "phrase": "string"
                },
                "merchant": {
                  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                  "name": "string",
                  "logo": "string",
                  "category": {
                    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                    "name": "string",
                    "displayName": "string",
                    "phrase": "string"
                  }
                }
              }
            ],
            "personalization": {
              "totalSpent": 0,
              "totalEarned": 0,
              "totalValue": 0
            }
          }
        ],
        "detail": "string",
        "explaination": "string",
        "personalization": {
          "totalSpent": 0,
          "totalEarned": 0,
          "totalValue": 0
        }
      }
    ],
    "cardLevelEarningScheme": [
      {
        "type": "One Time",
        "name": "Sign-Up Bonus",
        "bonus": "string",
        "redemptionValue": "string",
        "requirement": "string",
        "personalization": {
          "minimumSpendMet": true,
          "qualifyingSpend": "string"
        }
      }
    ],
    "personalization": {
      "totalSpent": 0,
      "totalEarned": 0,
      "totalValue": 0
    }
  },
  "foreignTransactionFee": 0,
  "cardBenefits": [
    "No Foreign Transaction Fees"
  ]
}

Properties

Name Type Required Restrictions Description
cardName string false none Display name of the card
cardImageUrl string(url) true none none
cardPurposes [CardPurpose] false none [Purposes or categories related to a credit card]

ClientTags

{
  "subid": [
    "123"
  ]
}

Arbitrary key-values mappings to associate with a Lead. This field can be use to attach subids to a Lead

Properties

Name Type Required Restrictions Description
additionalProperties [string] false none none

EarningGroup

{
  "earnRate": 0,
  "earnRateText": "string",
  "items": [
    {
      "type": "category",
      "earnRate": 0,
      "personalization": {
        "totalSpent": 0,
        "totalEarned": 0,
        "totalValue": 0
      },
      "category": {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "name": "string",
        "displayName": "string",
        "phrase": "string"
      },
      "merchant": {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "name": "string",
        "logo": "string",
        "category": {
          "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
          "name": "string",
          "displayName": "string",
          "phrase": "string"
        }
      }
    }
  ],
  "personalization": {
    "totalSpent": 0,
    "totalEarned": 0,
    "totalValue": 0
  }
}

A group of qualifiers which share the same default earn rate

Properties

Name Type Required Restrictions Description
earnRate number true none Numerical representation of the earn rate for this group
earnRateText string true none Display text for what the group earns
items [EarningItem] true none [An association of an earn rate and a qualifier, like a category or merchant]

EarningItem

{
  "type": "category",
  "earnRate": 0,
  "personalization": {
    "totalSpent": 0,
    "totalEarned": 0,
    "totalValue": 0
  },
  "category": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "displayName": "string",
    "phrase": "string"
  },
  "merchant": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "logo": "string",
    "category": {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "name": "string",
      "displayName": "string",
      "phrase": "string"
    }
  }
}

An association of an earn rate and a qualifier, like a category or merchant

Properties

None

EarningItemCategory

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "name": "string",
  "displayName": "string",
  "phrase": "string"
}

A Category

Properties

Name Type Required Restrictions Description
uuid string(uuid) false none none
name string false none A detailed name for the category
displayName string false none A more user friendly name for the category
phrase string false none Sentence friendly

EarningItemMerchant

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "name": "string",
  "logo": "string",
  "category": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "displayName": "string",
    "phrase": "string"
  }
}

A business or store that is affiliated with a credit card earning program

Properties

Name Type Required Restrictions Description
uuid string(uuid) false none none
name string false none The merchant's name
logo string false none Logo URL

EarningItemType

"category"

Refers to the type (and schema) of the item

Properties

Name Type Required Restrictions Description
anonymous string false none Refers to the type (and schema) of the item

Enumerated Values

Property Value
anonymous category
anonymous merchant
anonymous ebp
anonymous paymentMethod

EarningItemPersonalization

{
  "totalSpent": 0,
  "totalEarned": 0,
  "totalValue": 0
}

Personalized values calculated for a specific item, such as an earning group or bonus

Properties

Name Type Required Restrictions Description
totalSpent number false none The amount the user spent in dollars within a calendar year
totalEarned number false none The amount of points/miles/dollars the user would have received within a calendar year
totalValue number false none The value in USD of the totalEarned amount based on the user's custom point valuation

EarningProgram

{
  "transactionLevelEarningScheme": [
    {
      "type": "basic",
      "groups": [
        {
          "earnRate": 0,
          "earnRateText": "string",
          "items": [
            {
              "type": "category",
              "earnRate": 0,
              "personalization": {
                "totalSpent": 0,
                "totalEarned": 0,
                "totalValue": 0
              },
              "category": {
                "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                "name": "string",
                "displayName": "string",
                "phrase": "string"
              },
              "merchant": {
                "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                "name": "string",
                "logo": "string",
                "category": {
                  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                  "name": "string",
                  "displayName": "string",
                  "phrase": "string"
                }
              }
            }
          ],
          "personalization": {
            "totalSpent": 0,
            "totalEarned": 0,
            "totalValue": 0
          }
        }
      ],
      "detail": "string",
      "explaination": "string",
      "personalization": {
        "totalSpent": 0,
        "totalEarned": 0,
        "totalValue": 0
      }
    }
  ],
  "cardLevelEarningScheme": [
    {
      "type": "One Time",
      "name": "Sign-Up Bonus",
      "bonus": "string",
      "redemptionValue": "string",
      "requirement": "string",
      "personalization": {
        "minimumSpendMet": true,
        "qualifyingSpend": "string"
      }
    }
  ],
  "personalization": {
    "totalSpent": 0,
    "totalEarned": 0,
    "totalValue": 0
  }
}

Reward earning data for the card

Properties

Name Type Required Restrictions Description
transactionLevelEarningScheme [TransactionLevelEarningScheme] true none Grouped by earn rate, the rules that earn multipliers on each transaction

EarningProgramPersonalization

{
  "totalSpent": 0,
  "totalEarned": 0,
  "totalValue": 0
}

Annual value of this card for the user, only returned in a simulation

Properties

Name Type Required Restrictions Description
totalSpent number false none The amount the user spent in dollars within a calendar year
totalEarned number false none The amount of points/miles/dollars the user would have received within a calendar year
totalValue number false none The value in USD of the totalEarned amount based on the user's custom point valuation, minus fees

EducationLevel

"high_school"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous high_school
anonymous associate
anonymous bachelors
anonymous masters
anonymous doctorate
anonymous other_grad_degree
anonymous certificate
anonymous did_not_graduate
anonymous still_enrolled
anonymous other
anonymous unknown

EmploymentPayFrequency

"weekly"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous weekly
anonymous biweekly
anonymous twice_monthly
anonymous monthly
anonymous unknown

EmploymentStatus

"employed_full_time"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous employed_full_time
anonymous employed_part_time
anonymous military
anonymous not_employed
anonymous self_employed
anonymous retired
anonymous other
anonymous unknown

FeaturedFinancialInstitution

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "name": "string",
  "logoUrl": "string"
}

Properties

Name Type Required Restrictions Description
uuid string(uuid) true read-only A unique identifier for the financial institution.
name string true read-only The name of the financial institution. This value is subject to
change, so financialInstitutionUuid should be used for grouping.
logoUrl string(url) true read-only The URL of an image logo for the associated financial institution.

IdType

"driver_license"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous driver_license
anonymous state_id
anonymous passport

GraduateDegreeType

"doctor_of_medicine"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous doctor_of_medicine
anonymous doctor_of_osteopathic_medicine
anonymous doctor_of_optometry
anonymous doctor_of_dental_medicine
anonymous dentariae_medicinae_doctoris
anonymous doctor_of_dental_surgery
anonymous doctor_of_veterinary_medicine
anonymous doctor_of_pharmacy
anonymous veterinariae_medicinae_doctoris
anonymous master_of_arts
anonymous master_of_science
anonymous master_of_research
anonymous master_of_research_project
anonymous master_of_studies
anonymous master_of_business_administration
anonymous master_of_library_science
anonymous master_of_public_administration
anonymous master_of_public_health
anonymous master_of_laws
anonymous master_of_arts_liberal_studies
anonymous master_of_fine_arts
anonymous master_of_music
anonymous master_of_education
anonymous master_of_engineering
anonymous master_of_architecture
anonymous juris_doctor
anonymous other
anonymous unknown

Gender

"male"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous male
anonymous female
anonymous unknown

IntroOfferType

"miles"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous miles
anonymous points
anonymous statement_credit

IpAddress

null

Properties

Name Type Required Restrictions Description
anonymous string false none none

oneOf

Name Type Required Restrictions Description
anonymous any false none none

xor

Name Type Required Restrictions Description
anonymous any false none none

Lead

{
  "leadProviderName": "string",
  "personalInformation": {
    "firstName": "string",
    "lastName": "string",
    "aliasFirstName": "string",
    "aliasLastName": "string",
    "email": "user@example.com",
    "city": "string",
    "state": "AK",
    "workPhone": "string",
    "primaryPhone": "string",
    "bestTimeToCall": "morning",
    "address1": "string",
    "address2": "string",
    "addressMoveInDate": "2019-08-24",
    "zipcode": "string",
    "monthsAtAddress": 0,
    "driversLicenseNumber": "string",
    "driversLicenseState": "string",
    "ipAddress": "string",
    "activeMilitary": true,
    "militaryVeteran": true,
    "dateOfBirth": "2019-08-24",
    "educationLevel": "high_school",
    "ssn": "string",
    "citizenshipStatus": "citizen"
  },
  "personalReferenceInformation": {
    "firstName": "string",
    "lastName": "string",
    "primaryPhone": "string",
    "relationType": "parent"
  },
  "loanInformation": {
    "purpose": "auto_purchase",
    "loanAmount": 0
  },
  "mortgageInformation": {
    "propertyType": "rent",
    "propertyValue": 0,
    "mortgageBalance": 0,
    "lenderName": "string",
    "hasFHALoan": true,
    "currentWithLoan": true,
    "propertyStatus": "own_outright",
    "mortgageType": "purchase",
    "mortgageAmount": 0,
    "downPaymentAmount": 0,
    "propertyState": "string",
    "propertyCounty": "string",
    "propertyAddress1": "string",
    "propertyAddress2": "string",
    "propertyZipcode": "string",
    "propertyCity": "string",
    "refinanceAmount": 0,
    "cashOutAmount": 0,
    "occupancyType": "primary",
    "refinanceType": "cash_out",
    "propertySearchStatus": "found",
    "numUnits": 0,
    "closingDate": "2019-08-24",
    "purchaseStatus": "no_offer",
    "purchaseDate": "2019-08-24",
    "monthlyHoaFee": 0,
    "mortgageCompany": "string",
    "mortgageEscrowAmount": 0
  },
  "creditCardInformation": {
    "allowAnnualFee": true,
    "cardPurposes": [
      "balance_transfer"
    ]
  },
  "savingsInformation": {
    "minDepositAmount": 0
  },
  "creditInformation": {
    "providedCreditRating": "excellent",
    "providedNumericCreditScore": 0
  },
  "financialInformation": {
    "employmentStatus": "employed_full_time",
    "employmentPayFrequency": "weekly",
    "annualIncome": 0,
    "monthlyNetIncome": 0,
    "bankName": "string",
    "bankRoutingNumber": "string",
    "bankAccountType": "checking",
    "creditCardDebt": 0,
    "monthsAtBank": 0,
    "bankAccountNumber": "string",
    "monthlyDebt": 0,
    "totalAssets": 0,
    "monthlyHousingPayment": 0,
    "availableAssets": 0,
    "additionalIncome": 0,
    "additionalIncomeFrequency": "weekly"
  },
  "employmentInformation": {
    "employerName": "string",
    "employerAddress": "string",
    "employerAddress2": "string",
    "employerCity": "string",
    "employerPhone": "string",
    "employerState": "string",
    "employerZip": "string",
    "jobTitle": "string",
    "monthsEmployed": 0,
    "directDeposit": true,
    "payDate1": "2019-08-24",
    "payDate2": "2019-08-24",
    "startDate": "2019-08-24"
  },
  "legalInformation": {
    "consentsToFcra": true,
    "consentsToTcpa": true,
    "tcpaLanguage": "string",
    "consentsToSms": true
  },
  "educationInformation": {
    "educationLevel": "high_school",
    "graduateDegreeType": "doctor_of_medicine",
    "universityAttended": "string",
    "graduationDate": "2019-08-24",
    "graduateGraduationDate": "2019-08-24",
    "graduateLastAttendedDate": "2019-08-24",
    "graduateUniversityAttended": "string",
    "undergraduateGraduationDate": "2019-08-24",
    "undergraduateLastAttendedDate": "2019-08-24",
    "undergraduateUniversityAttended": "string"
  },
  "coApplicantInformation": {
    "firstName": "string",
    "lastName": "string",
    "dateOfBirth": "2019-08-24",
    "annualIncome": 0,
    "streetAddress1": "string",
    "streetAddress2": "string",
    "city": "string",
    "state": "AK",
    "zipCode": "string"
  },
  "healthInformation": {
    "gender": "male",
    "heightInInches": 0,
    "weightInPounds": 0,
    "tobaccoSmoker": true
  },
  "identificationInformation": {
    "idNumber": "string",
    "idState": "string",
    "idType": "driver_license"
  },
  "lifeInsuranceInformation": {
    "carrier": "string",
    "duration": 0,
    "policyAmount": 0
  },
  "refinanceLoans": [
    {
      "accountNumber": "string",
      "incomeBasedRepayment": true,
      "interestRate": 0,
      "loanAmount": 0,
      "loanServicer": "string",
      "loanType": "federal_student_loan",
      "nextPaymentAmount": 0,
      "nextPaymentDate": "2019-08-24"
    }
  ],
  "clientTags": {
    "subid": [
      "123"
    ]
  },
  "sessionInformation": {
    "ipAddress": "string",
    "userAgent": "string"
  },
  "leadActions": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "actionType": "initialized",
      "actionDate": "2019-08-24T14:15:22Z",
      "originatorKey": "string",
      "demandSubAccountId": 0,
      "rejectReason": "low_fico",
      "amount": 0,
      "originationFee": 0,
      "offerClickId": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "deletedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "companyUUID": "bb25b21f-4351-4e0a-bd6a-faa43df6ed9e",
  "sessionUuid": "0688aee8-ffa9-4d26-9262-47526493535e",
  "referralCompanyUuid": "427f8dd3-3534-47d8-a6af-90027e506eda",
  "trackingUuid": "20d86745-12ef-4b8a-91e5-6d9947ac4592",
  "isTest": true,
  "status": "initialized",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
leadProviderName string true none Name of company which provided the lead

LeadBestTimeToCall

"morning"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous morning
anonymous afternoon
anonymous evening
anonymous night

LeadCoApplicantInformation

{
  "firstName": "string",
  "lastName": "string",
  "dateOfBirth": "2019-08-24",
  "annualIncome": 0,
  "streetAddress1": "string",
  "streetAddress2": "string",
  "city": "string",
  "state": "AK",
  "zipCode": "string"
}

The personal information of a co-applicant that may be considered in the underwriting and approval of a loan.

Properties

Name Type Required Restrictions Description
firstName string false none none
lastName string false none none
dateOfBirth string(date) false none none
annualIncome integer(int32) false none none
streetAddress1 string false none Street address (primary address line)
streetAddress2 string false none Secondary address line
city string false none none

LeadCreditInformation

{
  "providedCreditRating": "excellent",
  "providedNumericCreditScore": 0
}

Credit history information relating to a Lead

Properties

None

LeadCreditCardInformation

{
  "allowAnnualFee": true,
  "cardPurposes": [
    "balance_transfer"
  ]
}

Properties

Name Type Required Restrictions Description
allowAnnualFee boolean false none none
cardPurposes [CardPurpose] false none A list of card purposes in which the lead is interested

LeadEducationInformation

{
  "educationLevel": "high_school",
  "graduateDegreeType": "doctor_of_medicine",
  "universityAttended": "string",
  "graduationDate": "2019-08-24",
  "graduateGraduationDate": "2019-08-24",
  "graduateLastAttendedDate": "2019-08-24",
  "graduateUniversityAttended": "string",
  "undergraduateGraduationDate": "2019-08-24",
  "undergraduateLastAttendedDate": "2019-08-24",
  "undergraduateUniversityAttended": "string"
}

Properties

None

LeadEducationLevel

"high_school"

Properties

None

LeadEmploymentInformation

{
  "employerName": "string",
  "employerAddress": "string",
  "employerAddress2": "string",
  "employerCity": "string",
  "employerPhone": "string",
  "employerState": "string",
  "employerZip": "string",
  "jobTitle": "string",
  "monthsEmployed": 0,
  "directDeposit": true,
  "payDate1": "2019-08-24",
  "payDate2": "2019-08-24",
  "startDate": "2019-08-24"
}

Properties

Name Type Required Restrictions Description
employerName string false none none
employerAddress string false none none
employerAddress2 string false none none
employerCity string false none none
employerPhone string false none none
employerState string false none none
employerZip string false none none
jobTitle string false none none
monthsEmployed integer(int32) false none none
directDeposit boolean false none Whether a Lead uses direct deposit for their salary
payDate1 string(date) false none none
payDate2 string(date) false none none
startDate string(date) false none The date the lead started working at their current employer (YYYY-MM-DD)

LeadFinancialInformation

{
  "employmentStatus": "employed_full_time",
  "employmentPayFrequency": "weekly",
  "annualIncome": 0,
  "monthlyNetIncome": 0,
  "bankName": "string",
  "bankRoutingNumber": "string",
  "bankAccountType": "checking",
  "creditCardDebt": 0,
  "monthsAtBank": 0,
  "bankAccountNumber": "string",
  "monthlyDebt": 0,
  "totalAssets": 0,
  "monthlyHousingPayment": 0,
  "availableAssets": 0,
  "additionalIncome": 0,
  "additionalIncomeFrequency": "weekly"
}

Properties

None

LeadHealthInformation

{
  "gender": "male",
  "heightInInches": 0,
  "weightInPounds": 0,
  "tobaccoSmoker": true
}

Properties

None

LeadIdentificationInformation

{
  "idNumber": "string",
  "idState": "string",
  "idType": "driver_license"
}

Properties

Name Type Required Restrictions Description
idNumber string false none The ID number supplied by the lead
idState string false none The state of issue of the supplied ID

LeadLegalInformation

{
  "consentsToFcra": true,
  "consentsToTcpa": true,
  "tcpaLanguage": "string",
  "consentsToSms": true
}

Information regarding a Lead's communication concent

Properties

Name Type Required Restrictions Description
consentsToFcra boolean false none Whether the lead was shown, and consented to a Fair Credit Reporting Act notice
consentsToTcpa boolean false none Whether the lead was shown, and consented to a Telephone Consumer Protection Act notice
tcpaLanguage string false none The exact text to which the lead consented
consentsToSms boolean false none The lead agrees to recieve SMS text messages from the Financial Institution

LeadLifeInsuranceInformation

{
  "carrier": "string",
  "duration": 0,
  "policyAmount": 0
}

Life insurance information

Properties

Name Type Required Restrictions Description
carrier string true none Carrier of the policy
duration integer(int64) true none Duration, in years
policyAmount integer(int64) true none Policy amount, in dollars

LeadLoanInformation

{
  "purpose": "auto_purchase",
  "loanAmount": 0
}

Properties

None

LeadMortgageInformation

{
  "propertyType": "rent",
  "propertyValue": 0,
  "mortgageBalance": 0,
  "lenderName": "string",
  "hasFHALoan": true,
  "currentWithLoan": true,
  "propertyStatus": "own_outright",
  "mortgageType": "purchase",
  "mortgageAmount": 0,
  "downPaymentAmount": 0,
  "propertyState": "string",
  "propertyCounty": "string",
  "propertyAddress1": "string",
  "propertyAddress2": "string",
  "propertyZipcode": "string",
  "propertyCity": "string",
  "refinanceAmount": 0,
  "cashOutAmount": 0,
  "occupancyType": "primary",
  "refinanceType": "cash_out",
  "propertySearchStatus": "found",
  "numUnits": 0,
  "closingDate": "2019-08-24",
  "purchaseStatus": "no_offer",
  "purchaseDate": "2019-08-24",
  "monthlyHoaFee": 0,
  "mortgageCompany": "string",
  "mortgageEscrowAmount": 0
}

Properties

None

LeadPersonalInformation

{
  "firstName": "string",
  "lastName": "string",
  "aliasFirstName": "string",
  "aliasLastName": "string",
  "email": "user@example.com",
  "city": "string",
  "state": "AK",
  "workPhone": "string",
  "primaryPhone": "string",
  "bestTimeToCall": "morning",
  "address1": "string",
  "address2": "string",
  "addressMoveInDate": "2019-08-24",
  "zipcode": "string",
  "monthsAtAddress": 0,
  "driversLicenseNumber": "string",
  "driversLicenseState": "string",
  "ipAddress": "string",
  "activeMilitary": true,
  "militaryVeteran": true,
  "dateOfBirth": "2019-08-24",
  "educationLevel": "high_school",
  "ssn": "string",
  "citizenshipStatus": "citizen"
}

Properties

Name Type Required Restrictions Description
firstName string false none none
lastName string false none none
aliasFirstName string false none The first name the lead uses as an alias
aliasLastName string false none The last name the lead uses as an alias
email string(email) false none none
city string false none none

LeadSavingsInformation

{
  "minDepositAmount": 0
}

Properties

Name Type Required Restrictions Description
minDepositAmount integer(int64) false none The minimum amount a Lead is interesting in depositing when opening a new savings account

LeadSessionInformation

{
  "ipAddress": "string",
  "userAgent": "string"
}

Browsing session information accociated with a Lead

Properties

Name Type Required Restrictions Description
ipAddress string false none none
userAgent string false none none

LeadAction

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "actionType": "initialized",
  "actionDate": "2019-08-24T14:15:22Z",
  "originatorKey": "string",
  "demandSubAccountId": 0,
  "rejectReason": "low_fico",
  "amount": 0,
  "originationFee": 0,
  "offerClickId": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
uuid string(uuid) true none none

LeadActionType

"initialized"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous initialized
anonymous api_rejected
anonymous api_approved
anonymous api_listing
anonymous clicked_referral_link
anonymous clicked_special_offer_link
anonymous special_offer_conversion
anonymous applied
anonymous rejected
anonymous approved
anonymous listed
anonymous funded
anonymous not_funded
anonymous clicked_credit_card_offer_link
anonymous clicked_mortgage_offer_link
anonymous clicked_savings_offer_link
anonymous unknown

LeadEvent

{
  "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
  "leadCreatedAt": "2019-08-24T14:15:22Z",
  "eventType": "leadCreated",
  "eventCreatedAt": "2019-08-24T14:15:22Z",
  "eventPayout": 0,
  "eventDollarAmount": 0,
  "financialInstitutionUuid": "04da1391-4dfd-4103-aeec-373cd7afc295",
  "financialInstitutionName": "string",
  "rateTableUuid": "f4dda88e-e5bc-42b2-81a8-c348b4b628db",
  "offerUuid": "5d19bb70-d72b-45ae-9b5e-c4257877bdbb",
  "offerName": "string",
  "offerProductType": "loan",
  "offerFirmness": "preSelected"
}

Properties

Name Type Required Restrictions Description
leadUuid string(uuid) true none A unique identifier for the associated lead.
leadCreatedAt string(date-time) true none The time that the associated lead was created.

LeadEventResponse

{
  "data": [
    {
      "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
      "leadCreatedAt": "2019-08-24T14:15:22Z",
      "eventType": "leadCreated",
      "eventCreatedAt": "2019-08-24T14:15:22Z",
      "eventPayout": 0,
      "eventDollarAmount": 0,
      "financialInstitutionUuid": "04da1391-4dfd-4103-aeec-373cd7afc295",
      "financialInstitutionName": "string",
      "rateTableUuid": "f4dda88e-e5bc-42b2-81a8-c348b4b628db",
      "offerUuid": "5d19bb70-d72b-45ae-9b5e-c4257877bdbb",
      "offerName": "string",
      "offerProductType": "loan",
      "offerFirmness": "preSelected"
    }
  ],
  "nextUrl": "string"
}

Properties

Name Type Required Restrictions Description
data [LeadEvent] true none none

LeadUuid

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Properties

Name Type Required Restrictions Description
uuid string(uuid) true none UUID corresponding to the created Lead

LeadRequest

{
  "summary": "A lead request",
  "value": {
    "productTypes": [
      "loan",
      "savings"
    ],
    "personalInformation": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john@example.com",
      "city": "New York",
      "state": "NY",
      "workPhone": "2125551234",
      "primaryPhone": "2125556789",
      "address1": "45 West 21st Street",
      "address2": "5th Floor",
      "zipcode": "10010",
      "monthsAtAddress": 5,
      "driversLicenseNumber": "111222333",
      "driversLicenseState": "NY",
      "ipAddress": "8.8.8.8",
      "activeMilitary": false,
      "militaryVeteran": true,
      "dateOfBirth": "1993-10-09",
      "ssn": "111-22-3333"
    },
    "loanInformation": {
      "purpose": "debt_consolidation",
      "loanAmount": 10000
    },
    "mortgageInformation": {
      "propertyType": "condo",
      "propertyStatus": "own_with_mortgage",
      "propertyValue": 200000,
      "mortgageBalance": 10000,
      "lenderName": "Bank OF NY",
      "hasFHALoan": true,
      "currentWithLoan": true
    },
    "creditCardInformation": {
      "allowAnnualFee": true,
      "cardPurposes": [
        "travel_incentives"
      ]
    },
    "savingsInformation": {
      "minDepositAmount": 1000
    },
    "creditInformation": {
      "providedCreditRating": "excellent",
      "providedNumericCreditScore": 750
    },
    "financialInformation": {
      "creditCardDebt": 5000,
      "employmentStatus": "employed",
      "employmentPayFrequency": "weekly",
      "annualIncome": 120000,
      "monthlyNetIncome": 10000,
      "bankName": "Santander",
      "bankRoutingNumber": "231372691",
      "bankAccountType": "savings",
      "monthsAtBank": 10,
      "bankAccountNumber": "1234567890"
    },
    "employmentInformation": {
      "employerName": "EVEN Financial",
      "employerAddress": "45 W 21st St",
      "employerCity": "New York",
      "employerState": "NY",
      "employerZip": "10010",
      "jobTitle": "Software Engineer",
      "monthsEmployed": 14,
      "directDeposit": true,
      "payDate1": "2004-10-06",
      "payDate2": "2004-11-06"
    },
    "educationInformation": {
      "educationLevel": "masters",
      "graduateDegreeType": "master_of_science",
      "universityAttended": "Johns Hopkins University"
    },
    "coApplicantInformation": {
      "firstName": "Jane",
      "lastName": "Doe",
      "dateOfBirth": "1984-03-06",
      "annualIncome": 100000,
      "streetAddress1": "45 West 21st Street",
      "streetAddress2": "5th Floor",
      "city": "New York",
      "state": "NY",
      "zipcode": "10010"
    },
    "healthInformation": {
      "gender": "male",
      "heightInInches": 72,
      "weightInPounds": 195,
      "tobaccoSmoker": false
    },
    "legalInformation": {
      "consentsToFcra": true,
      "consentsToTcpa": true,
      "tcpaLanguage": "I agree to be contacted by Even Financial and its partners at the telephone number(s) I have provided above to explore personal loan offers, including contact through automatic dialing systems, artificial or pre-recorded voice messaging, or text message. I understand my consent is not required as a condition to purchasing any goods or services from anyone."
    },
    "clientTags": {
      "hello": [
        "world",
        "there"
      ],
      "something": [
        "else"
      ]
    }
  }
}

Properties

Name Type Required Restrictions Description
productTypes [ProductType] false none Product types in which the Lead is interested

LoanOffer

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "originator": {
    "key": "string",
    "name": "string",
    "description": "string",
    "images": [
      {
        "sizeKey": "string",
        "url": "string"
      }
    ],
    "disclaimer": "string",
    "companyUuid": "fdfe4f8f-1fcb-4da9-b882-48ec3a9a0d16"
  },
  "originatorId": "string",
  "termLength": 0,
  "termUnit": "day",
  "maxAmount": 0,
  "minAmount": 0,
  "maxApr": 0,
  "minApr": 0,
  "meanApr": 0,
  "feeRate": 0,
  "maxFeeRate": 0,
  "minFeeRate": 0,
  "feeFixed": 0,
  "maxFeeFixed": 0,
  "minFeeFixed": 0,
  "allowPrepayment": true,
  "prepaymentFee": 0,
  "monthlyPayment": 0,
  "maxMonthlyPayment": 0,
  "minMonthlyPayment": 0,
  "meanMonthlyPayment": 0,
  "maxTotalPayment": 0,
  "minTotalPayment": 0,
  "meanTotalPayment": 0,
  "terms": "string",
  "url": "string",
  "preQualified": true,
  "preApproved": true,
  "secured": true,
  "sponsored": true,
  "recommendationScore": 0,
  "payout": 0,
  "conversionProbability": 0,
  "productType": "credit_card",
  "productSubType": "credit_card",
  "productSubTypeDisclaimer": "string",
  "aprType": "variable"
}

Properties

Name Type Required Restrictions Description
uuid string(uuid) false none none

LoanPurpose

"auto_purchase"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous auto_purchase
anonymous auto_refinance
anonymous baby
anonymous boat
anonymous business
anonymous car_repair
anonymous cosmetic
anonymous credit_card_refi
anonymous debt_consolidation
anonymous emergency
anonymous engagement
anonymous green
anonymous home_improvement
anonymous home_purchase
anonymous home_refi
anonymous household_expenses
anonymous large_purchases
anonymous life_event
anonymous medical_dental
anonymous motorcycle
anonymous moving_relocation
anonymous rv
anonymous special_occasion
anonymous student_loan
anonymous student_loan_refi
anonymous taxes
anonymous vacation
anonymous wedding
anonymous other
anonymous unknown

MortgageAdjustmentType

"credits"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous credits
anonymous par
anonymous points

MortgageLoanType

"fifteen_year_fixed"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous fifteen_year_fixed
anonymous thirty_year_fixed
anonymous five_one_adjustable
anonymous seven_one_adjustable
anonymous ten_one_adjustable

MortgageOffer

{
  "details": {
    "interestRate": 0,
    "loanType": "fifteen_year_fixed",
    "priceAdjustment": 0,
    "monthlyPayment": 0,
    "netClosingCosts": 0,
    "apr": 0,
    "loanTerm": 0,
    "adjustmentType": "credits"
  },
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "partner": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "description": "string",
    "disclaimer": "string",
    "supportsPersonalizedOffers": true,
    "imageUrl": "string"
  },
  "marketplace": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "description": "string",
    "disclaimer": "string",
    "supportsPersonalizedOffers": true,
    "imageUrl": "string"
  },
  "productType": "credit_card",
  "productSubType": "credit_card",
  "url": "string",
  "recommendationScore": 0,
  "disclaimer": "string",
  "productSubTypeDisclaimer": "string"
}

An offer for a mortgage

Properties

None

MortgageOfferDetails

{
  "interestRate": 0,
  "loanType": "fifteen_year_fixed",
  "priceAdjustment": 0,
  "monthlyPayment": 0,
  "netClosingCosts": 0,
  "apr": 0,
  "loanTerm": 0,
  "adjustmentType": "credits"
}

Properties

Name Type Required Restrictions Description
interestRate number true none none

MortgageType

"purchase"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous purchase
anonymous refinance
anonymous unknown

OccupancyType

"primary"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous primary
anonymous secondary
anonymous investment
anonymous unknown

Offer

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "partner": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "description": "string",
    "disclaimer": "string",
    "supportsPersonalizedOffers": true,
    "imageUrl": "string"
  },
  "marketplace": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "description": "string",
    "disclaimer": "string",
    "supportsPersonalizedOffers": true,
    "imageUrl": "string"
  },
  "productType": "credit_card",
  "productSubType": "credit_card",
  "url": "string",
  "recommendationScore": 0,
  "disclaimer": "string",
  "productSubTypeDisclaimer": "string"
}

Properties

Name Type Required Restrictions Description
uuid string(uuid) true none none

OfferCalculation

{
  "staticOfferUuid": "00163cbf-115c-4779-927f-98c2facfe864",
  "earningProgram": [
    {
      "transactionLevelEarningScheme": [
        {
          "type": "basic",
          "groups": [
            {
              "earnRate": 0,
              "earnRateText": "string",
              "items": [
                {
                  "type": "category",
                  "earnRate": 0,
                  "personalization": {
                    "totalSpent": 0,
                    "totalEarned": 0,
                    "totalValue": 0
                  },
                  "category": {
                    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                    "name": "string",
                    "displayName": "string",
                    "phrase": "string"
                  },
                  "merchant": {
                    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                    "name": "string",
                    "logo": "string",
                    "category": {
                      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                      "name": "string",
                      "displayName": "string",
                      "phrase": "string"
                    }
                  }
                }
              ],
              "personalization": {
                "totalSpent": 0,
                "totalEarned": 0,
                "totalValue": 0
              }
            }
          ],
          "detail": "string",
          "explaination": "string",
          "personalization": {
            "totalSpent": 0,
            "totalEarned": 0,
            "totalValue": 0
          }
        }
      ],
      "cardLevelEarningScheme": [
        {
          "type": "One Time",
          "name": "Sign-Up Bonus",
          "bonus": "string",
          "redemptionValue": "string",
          "requirement": "string",
          "personalization": {
            "minimumSpendMet": true,
            "qualifyingSpend": "string"
          }
        }
      ],
      "personalization": {
        "totalSpent": 0,
        "totalEarned": 0,
        "totalValue": 0
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
staticOfferUuid string(uuid) true none The offer UUID from the specified rate table whose reward value was
calculated.
earningProgram [EarningProgram] true none Reward earning data for the card associated with the given static offer uuid

OfferDisplay

{
  "id": 0,
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
  "rateTableUuid": "f4dda88e-e5bc-42b2-81a8-c348b4b628db",
  "offerUuid": "5d19bb70-d72b-45ae-9b5e-c4257877bdbb",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e"
}

Properties

Name Type Required Restrictions Description
id integer(int64) true read-only none
uuid string(uuid) true read-only none
leadUuid string(uuid) true none none
rateTableUuid string(uuid) true none none
offerUuid string(uuid) true none none
createdAt string(date-time) true read-only none
createdBy string(uuid) true read-only none

OfferFirmness

"preSelected"

The firmness of the associated offer. Only present for event types associated with offers.

Properties

Name Type Required Restrictions Description
anonymous string false none The firmness of the associated offer. Only present for event types associated with offers.

Enumerated Values

Property Value
anonymous preSelected
anonymous preQualified
anonymous preApproved

Originator

{
  "key": "string",
  "name": "string",
  "description": "string",
  "images": [
    {
      "sizeKey": "string",
      "url": "string"
    }
  ],
  "disclaimer": "string",
  "companyUuid": "fdfe4f8f-1fcb-4da9-b882-48ec3a9a0d16"
}

Properties

Name Type Required Restrictions Description
key string true none none
name string true none none
description string false none none
images [OriginatorImage] true none none

OriginatorImage

{
  "sizeKey": "string",
  "url": "string"
}

Properties

Name Type Required Restrictions Description
sizeKey string false none none
url string false none none

Partner

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "name": "string",
  "description": "string",
  "disclaimer": "string",
  "supportsPersonalizedOffers": true,
  "imageUrl": "string"
}

Properties

Name Type Required Restrictions Description
uuid string(uuid) true none none
name string true none none
description string true none none
disclaimer string true none none
supportsPersonalizedOffers boolean true none Whether the partner supports returning pre-qualified or pre-approved offers
imageUrl string(url) true none none

PlaidAssetReportToken

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
  "token": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e"
}

Properties

Name Type Required Restrictions Description
uuid string(uuid) true read-only A unique identifier for this Plaid asset report token
leadUuid string(uuid) true none The UUID of the lead with which the asset associated.
token string true none The Plaid asset report token itself.
createdAt string(date-time) true read-only When the token was added.
createdBy string(uuid) true read-only The UUID of the access token that was used to add this token.

PendingResponse

{
  "partner": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "description": "string",
    "disclaimer": "string",
    "supportsPersonalizedOffers": true,
    "imageUrl": "string"
  },
  "productTypes": [
    "credit_card"
  ]
}

Properties

None

PersonalReferenceInformation

{
  "firstName": "string",
  "lastName": "string",
  "primaryPhone": "string",
  "relationType": "parent"
}

Properties

Name Type Required Restrictions Description
firstName string false none The first name of the personal reference supplied by the lead
lastName string false none The last name of the personal reference supplied by the lead
primaryPhone string false none The phone number of the personal reference supplied by the lead

PersonalReferenceRelationType

"parent"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous parent
anonymous employer
anonymous spouse
anonymous guardian
anonymous sibling
anonymous relative
anonymous friend
anonymous other

PreferredRedemptionType

{
  "redemptionTypeUuid": "7fa19829-5a02-45b6-8bbe-9ab885ffb806",
  "weight": 0
}

Properties

Name Type Required Restrictions Description
redemptionTypeUuid string(uuid) true none A unique identifier for the redemption type. This is used to reference
redemption type in POST /offerAugmentation/rewardValueCalculations.
weight integer(int32) true none The user's weight of the preference. > -1 indicates the user would value this type of redemption at $0 0 indicates the user doesnt have a preference Positive integers indicate a preference, which is normalized against other preferences

ProductType

"credit_card"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous credit_card
anonymous insurance
anonymous life_insurance
anonymous loan
anonymous mortgage
anonymous savings
anonymous other
anonymous unknown

ProductSubType

"credit_card"

A type of financial product

Properties

Name Type Required Restrictions Description
anonymous string false none A type of financial product

Enumerated Values

Property Value
anonymous credit_card
anonymous secured_card
anonymous personal_loan
anonymous student_loan_refinance
anonymous co_applicant_loan
anonymous line_of_credit
anonymous purchase
anonymous refinance
anonymous savings_account
anonymous money_market_account
anonymous certificate_of_deposit
anonymous individual_retirement_account
anonymous cash_management_account
anonymous high_interest_checking
anonymous accidental_death_benefits
anonymous term_life

ProvidedCreditRating

"excellent"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous excellent
anonymous good
anonymous fair
anonymous poor
anonymous limited
anonymous unknown

PropertyStatus

"own_outright"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous own_outright
anonymous own_with_mortgage
anonymous rent
anonymous unknown

PropertySearchStatus

"found"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous found
anonymous not_found
anonymous unknown

PropertyType

"rent"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous rent
anonymous condo
anonymous multi_unit
anonymous single_family
anonymous townhouse
anonymous unknown

PurchaseStatus

"no_offer"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous no_offer
anonymous offer_accepted
anonymous offer_pending
anonymous under_contract
anonymous unknown

RateTable

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
  "loanAmount": 0,
  "creditCardOffers": [
    {
      "details": {
        "cardName": "string",
        "cardImageUrl": "string",
        "cardPurposes": [
          "balance_transfer"
        ],
        "ratesUrl": "string",
        "maxPurchaseApr": 0,
        "minPurchaseApr": 0,
        "purchaseAprText": "string",
        "maxPurchaseIntroApr": 0,
        "minPurchaseIntroApr": 0,
        "purchaseIntroAprTerm": 0,
        "purchaseIntroAprTermUnit": "day",
        "purchaseIntroAprText": "string",
        "maxCashAdvanceApr": 0,
        "minCashAdvanceApr": 0,
        "cashAdvanceAprText": "string",
        "maxCashAdvanceIntroApr": 0,
        "minCashAdvanceIntroApr": 0,
        "cashAdvanceIntroAprTerm": 0,
        "cashAdvanceIntroAprTermUnit": "day",
        "cashAdvanceIntroAprText": "string",
        "maxBalanceTransferApr": 0,
        "minBalanceTransferApr": 0,
        "balanceTransferAprText": "string",
        "maxBalanceTransferIntroApr": 0,
        "minBalanceTransferIntroApr": 0,
        "balanceTransferIntroAprTerm": 0,
        "balanceTransferIntroAprTermUnit": "day",
        "balanceTransferIntroAprText": "string",
        "maxAnnualFee": 0,
        "minAnnualFee": 0,
        "annualIntroFee": 0,
        "annualIntroFeeTerm": 0,
        "introOfferAmount": 0,
        "introOfferText": "string",
        "introOfferType": "miles",
        "details": [
          "string"
        ],
        "additionalDetails": [
          "string"
        ],
        "cardType": "visa",
        "minimumCreditLine": 0,
        "minimumPenaltyApr": 0,
        "maximumPenaltyApr": 0,
        "balanceTransferFee": 0,
        "cashAdvanceFee": 0,
        "lateFee": 0,
        "foreignExchangeFee": 0,
        "accountOpeningFee": 0,
        "returnPaymentFee": 0,
        "monthlyServiceFee": 0,
        "recommendedCreditRatings": [
          "excellent"
        ],
        "preQualified": true,
        "preApproved": true,
        "preSelected": true,
        "earningProgram": {
          "transactionLevelEarningScheme": [
            {
              "type": "basic",
              "groups": [
                {
                  "earnRate": 0,
                  "earnRateText": "string",
                  "items": [
                    {
                      "type": "category",
                      "earnRate": 0,
                      "personalization": {
                        "totalSpent": 0,
                        "totalEarned": 0,
                        "totalValue": 0
                      },
                      "category": {
                        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                        "name": "string",
                        "displayName": "string",
                        "phrase": "string"
                      },
                      "merchant": {
                        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                        "name": "string",
                        "logo": "string",
                        "category": {
                          "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                          "name": "string",
                          "displayName": "string",
                          "phrase": "string"
                        }
                      }
                    }
                  ],
                  "personalization": {
                    "totalSpent": 0,
                    "totalEarned": 0,
                    "totalValue": 0
                  }
                }
              ],
              "detail": "string",
              "explaination": "string",
              "personalization": {
                "totalSpent": 0,
                "totalEarned": 0,
                "totalValue": 0
              }
            }
          ],
          "cardLevelEarningScheme": [
            {
              "type": "One Time",
              "name": "Sign-Up Bonus",
              "bonus": "string",
              "redemptionValue": "string",
              "requirement": "string",
              "personalization": {
                "minimumSpendMet": true,
                "qualifyingSpend": "string"
              }
            }
          ],
          "personalization": {
            "totalSpent": 0,
            "totalEarned": 0,
            "totalValue": 0
          }
        },
        "foreignTransactionFee": 0,
        "cardBenefits": [
          "No Foreign Transaction Fees"
        ]
      },
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "partner": {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "name": "string",
        "description": "string",
        "disclaimer": "string",
        "supportsPersonalizedOffers": true,
        "imageUrl": "string"
      },
      "marketplace": {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "name": "string",
        "description": "string",
        "disclaimer": "string",
        "supportsPersonalizedOffers": true,
        "imageUrl": "string"
      },
      "productType": "credit_card",
      "productSubType": "credit_card",
      "url": "string",
      "recommendationScore": 0,
      "disclaimer": "string",
      "productSubTypeDisclaimer": "string"
    }
  ],
  "loanOffers": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "originator": {
        "key": "string",
        "name": "string",
        "description": "string",
        "images": [
          {
            "sizeKey": "string",
            "url": "string"
          }
        ],
        "disclaimer": "string",
        "companyUuid": "fdfe4f8f-1fcb-4da9-b882-48ec3a9a0d16"
      },
      "originatorId": "string",
      "termLength": 0,
      "termUnit": "day",
      "maxAmount": 0,
      "minAmount": 0,
      "maxApr": 0,
      "minApr": 0,
      "meanApr": 0,
      "feeRate": 0,
      "maxFeeRate": 0,
      "minFeeRate": 0,
      "feeFixed": 0,
      "maxFeeFixed": 0,
      "minFeeFixed": 0,
      "allowPrepayment": true,
      "prepaymentFee": 0,
      "monthlyPayment": 0,
      "maxMonthlyPayment": 0,
      "minMonthlyPayment": 0,
      "meanMonthlyPayment": 0,
      "maxTotalPayment": 0,
      "minTotalPayment": 0,
      "meanTotalPayment": 0,
      "terms": "string",
      "url": "string",
      "preQualified": true,
      "preApproved": true,
      "secured": true,
      "sponsored": true,
      "recommendationScore": 0,
      "payout": 0,
      "conversionProbability": 0,
      "productType": "credit_card",
      "productSubType": "credit_card",
      "productSubTypeDisclaimer": "string",
      "aprType": "variable"
    }
  ],
  "mortgageOffers": [
    {
      "details": {
        "interestRate": 0,
        "loanType": "fifteen_year_fixed",
        "priceAdjustment": 0,
        "monthlyPayment": 0,
        "netClosingCosts": 0,
        "apr": 0,
        "loanTerm": 0,
        "adjustmentType": "credits"
      },
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "partner": {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "name": "string",
        "description": "string",
        "disclaimer": "string",
        "supportsPersonalizedOffers": true,
        "imageUrl": "string"
      },
      "marketplace": {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "name": "string",
        "description": "string",
        "disclaimer": "string",
        "supportsPersonalizedOffers": true,
        "imageUrl": "string"
      },
      "productType": "credit_card",
      "productSubType": "credit_card",
      "url": "string",
      "recommendationScore": 0,
      "disclaimer": "string",
      "productSubTypeDisclaimer": "string"
    }
  ],
  "savingsOffers": [
    {
      "details": {
        "name": "string",
        "description": "string",
        "details": "string",
        "rate": 0,
        "annualPercentYield": 0,
        "compoundingMethod": "annually",
        "introductoryPeriodMonths": 0,
        "introductoryRate": 0,
        "minimumDeposit": 0,
        "minimumDepositWithFees": 0,
        "monthlyFee": 0,
        "checkWriting": true,
        "effectiveAsOf": "2019-08-24T14:15:22Z"
      },
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "partner": {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "name": "string",
        "description": "string",
        "disclaimer": "string",
        "supportsPersonalizedOffers": true,
        "imageUrl": "string"
      },
      "marketplace": {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "name": "string",
        "description": "string",
        "disclaimer": "string",
        "supportsPersonalizedOffers": true,
        "imageUrl": "string"
      },
      "productType": "credit_card",
      "productSubType": "credit_card",
      "url": "string",
      "recommendationScore": 0,
      "disclaimer": "string",
      "productSubTypeDisclaimer": "string"
    }
  ],
  "specialOffers": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "name": "string",
      "desc": "string",
      "url": "string",
      "partnerName": "string",
      "partnerImageUrl": "string",
      "recommendationScore": 0,
      "payout": 0
    }
  ],
  "pendingOriginators": [
    {
      "key": "string",
      "name": "string",
      "description": "string",
      "images": [
        {
          "sizeKey": "string",
          "url": "string"
        }
      ],
      "disclaimer": "string",
      "companyUuid": "fdfe4f8f-1fcb-4da9-b882-48ec3a9a0d16"
    }
  ],
  "pendingResponses": [
    {
      "partner": {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "name": "string",
        "description": "string",
        "disclaimer": "string",
        "supportsPersonalizedOffers": true,
        "imageUrl": "string"
      },
      "productTypes": [
        "credit_card"
      ]
    }
  ]
}

A RateTable customized to a Lead input

Properties

Name Type Required Restrictions Description
uuid string(uuid) true none Primary UUID for a RateTable
leadUuid string(uuid) true none UUID of the associated Lead
loanAmount integer(int32) true none Lead's provided loan amount at the time of RateTable creation
creditCardOffers [CreditCardOffer] true none [An offer for a credit card]

RefinanceLoanInformation

{
  "accountNumber": "string",
  "incomeBasedRepayment": true,
  "interestRate": 0,
  "loanAmount": 0,
  "loanServicer": "string",
  "loanType": "federal_student_loan",
  "nextPaymentAmount": 0,
  "nextPaymentDate": "2019-08-24"
}

Refinance loan information

Properties

Name Type Required Restrictions Description
accountNumber string false none The account number for a loan the lead is refinancing
incomeBasedRepayment boolean false none If the repayment is income-based for a loan the lead is refinancing
interestRate number(float) false none The interest rate for a loan the lead is refinancing
loanAmount integer(int32) false none The loan amount for a loan the lead is refinancing
loanServicer string false none The name of a loan servicer of a loan the lead is refinancing

RefinanceLoanType

"federal_student_loan"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous federal_student_loan
anonymous private_student_loan

RefinanceType

"cash_out"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous cash_out
anonymous rate_term
anonymous unknown

RejectReason

"low_fico"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous low_fico
anonymous no_fico
anonymous major_derogatory
anonymous underwriting_decline
anonymous debt_to_income_ratio
anonymous not_in_active_state
anonymous incorrect_data_provided
anonymous duplicate
anonymous unknown

RevenueSummary

{
  "leadCreatedAtMin": "2019-08-24",
  "leadCreatedAtMax": "2019-08-24",
  "clientTagValue": "string",
  "creditRating": "string",
  "loanPurpose": "string",
  "referralUrl": null,
  "leadCount": 0,
  "submittedApplicationCount": 0,
  "preApprovedApplicationCount": 0,
  "offerClickCount": 0,
  "fundedCount": 0,
  "totalBookedRevenue": 0,
  "totalAttributedRevenue": 0,
  "totalUnattributedRevenue": 0
}

Properties

Name Type Required Restrictions Description
leadCreatedAtMin string(date) true none The beginning day of the bucket, in the UTC timezone. If data is aggregated by week, this defaults to the Monday of each week. If aggregated by month, instead this defaults to the first of each month.
leadCreatedAtMax string(date) true none The beginning day of the subsequent bucket. By default, this is the day after the leadCreatedAtMin. If data was requested to be aggregated by week, instead this is 7 days after the leadCreatedAtMin. If instead by month, this is the first day of the next month of this bucket.
clientTagValue string false none The actual value of a client tag key-value pair, used for aggregation. Only present if a client tag is specified in the query.
creditRating string false none One of (Fair, Poor, Good, Excellent). Only present if credit rating is specified as a group by clause
loanPurpose string false none Self-reported purpose for a lead for applying to this loan, e.g. taxes, student loan refinancing. Only present if loan purpose is specified as a group by clause.
referralUrl any false none Url from which a lead was referred. This has only the host, as other url parameters such as utm will be stripped out. Only present if referral Url is requested as a group by clause.
leadCount integer(int32) true none Sum of all leads for the queried partner and time period, for the loan vertical. If booked revenue was requested, instead this column indicates the number of leads paid out to the queried partner.
submittedApplicationCount integer(int32) true none Number of leads from the queried partner that submitted an application. If booked revenue was requested, this number is restricted to just leads that were paid out for.
preApprovedApplicationCount integer(int32) true none Number of pre-approved applications from the queried partner. If booked revenue was requested, this number is restricted to just leads that were paid out for.
offerClickCount integer(int32) true none Number of leads that clicked on at least one offer, after pre-approval. If booked revenue was requested, this number is restricted to just leads that were paid out for.
fundedCount integer(int32) true none Number of leads funded by an external loan provider. If booked revenue was requested, this number is restricted to just leads that were paid out for.
totalBookedRevenue integer(int32) false none Total revenue to the supply partner in cents (i.e. $1.23 is reported as 123) for a particular bucket. Booked revenue is considered to be revenue that has actually been paid out. This column is only present in the response if booked revenue was requested.
totalAttributedRevenue integer(int32) false none Total revenue to the supply partner in cents (i.e. $1.23 is reported as 123) for a particular bucket. Attributed revenue is considered to be revenue that is projected based on a conversion event, but may not necessarily have been paid out.
totalUnattributedRevenue integer(int32) false none Total booked revenue to the supply partner in cents (i.e. $1.23 is reported as 123) for a particular bucket. Unattributed revenue is revenue that is paid out but can not be attributed to any lead, and therefore funnel statistics on unattributed revenue behavior would not apply.

RevenueSummaryGrouping

"day"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous day
anonymous week
anonymous month
anonymous creditRating
anonymous loanPurpose
anonymous referralUrl

RevenueType

"attributed"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous attributed
anonymous booked

RedemptionType

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "parentUuid": "a234027b-494b-4285-a8ce-894cd0943051",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
uuid string(uuid) true none A unique identifier for the redemption type. This is used to reference
redemption types in POST /offerAugmentation/rewardValueCalculations.
parentUuid string(uuid) false none The UUID of the redemption type's parent redemption type.
name string true none The name of the redemption type.

RewardValueCalculation

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "rateTableUuid": "f4dda88e-e5bc-42b2-81a8-c348b4b628db",
  "plaidAssetReportToken": "string",
  "aggregatedSpending": {
    "aggregates": [
      {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "amount": 0
      }
    ],
    "unit": "usd"
  },
  "annualSpend": true,
  "preferredRedemptionTypes": [
    {
      "redemptionTypeUuid": "7fa19829-5a02-45b6-8bbe-9ab885ffb806",
      "weight": 0
    }
  ],
  "offerCalculations": [
    {
      "staticOfferUuid": "00163cbf-115c-4779-927f-98c2facfe864",
      "earningProgram": [
        {
          "transactionLevelEarningScheme": [
            {
              "type": "basic",
              "groups": [
                {
                  "earnRate": 0,
                  "earnRateText": "string",
                  "items": [
                    {
                      "type": "category",
                      "earnRate": 0,
                      "personalization": {
                        "totalSpent": 0,
                        "totalEarned": 0,
                        "totalValue": 0
                      },
                      "category": {
                        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                        "name": "string",
                        "displayName": "string",
                        "phrase": "string"
                      },
                      "merchant": {
                        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                        "name": "string",
                        "logo": "string",
                        "category": {
                          "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                          "name": "string",
                          "displayName": "string",
                          "phrase": "string"
                        }
                      }
                    }
                  ],
                  "personalization": {
                    "totalSpent": 0,
                    "totalEarned": 0,
                    "totalValue": 0
                  }
                }
              ],
              "detail": "string",
              "explaination": "string",
              "personalization": {
                "totalSpent": 0,
                "totalEarned": 0,
                "totalValue": 0
              }
            }
          ],
          "cardLevelEarningScheme": [
            {
              "type": "One Time",
              "name": "Sign-Up Bonus",
              "bonus": "string",
              "redemptionValue": "string",
              "requirement": "string",
              "personalization": {
                "minimumSpendMet": true,
                "qualifyingSpend": "string"
              }
            }
          ],
          "personalization": {
            "totalSpent": 0,
            "totalEarned": 0,
            "totalValue": 0
          }
        }
      ]
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e"
}

Properties

Name Type Required Restrictions Description
uuid string(uuid) true read-only A unique identifier for the caclulation.
rateTableUuid string(uuid) true none The UUID of the rate table for the calculation.
plaidAssetReportToken string false none A Plaid asset report token to retrieve transaction data for the user. Any
relevant tokens previously associated with the rate table's lead via
POST /offerAugmentation/plaidAssetReportTokens will also be taken into
account.

SavingsOffer

{
  "details": {
    "name": "string",
    "description": "string",
    "details": "string",
    "rate": 0,
    "annualPercentYield": 0,
    "compoundingMethod": "annually",
    "introductoryPeriodMonths": 0,
    "introductoryRate": 0,
    "minimumDeposit": 0,
    "minimumDepositWithFees": 0,
    "monthlyFee": 0,
    "checkWriting": true,
    "effectiveAsOf": "2019-08-24T14:15:22Z"
  },
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "partner": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "description": "string",
    "disclaimer": "string",
    "supportsPersonalizedOffers": true,
    "imageUrl": "string"
  },
  "marketplace": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "description": "string",
    "disclaimer": "string",
    "supportsPersonalizedOffers": true,
    "imageUrl": "string"
  },
  "productType": "credit_card",
  "productSubType": "credit_card",
  "url": "string",
  "recommendationScore": 0,
  "disclaimer": "string",
  "productSubTypeDisclaimer": "string"
}

An offer for a savings account

Properties

None

SavingsOfferDetails

{
  "name": "string",
  "description": "string",
  "details": "string",
  "rate": 0,
  "annualPercentYield": 0,
  "compoundingMethod": "annually",
  "introductoryPeriodMonths": 0,
  "introductoryRate": 0,
  "minimumDeposit": 0,
  "minimumDepositWithFees": 0,
  "monthlyFee": 0,
  "checkWriting": true,
  "effectiveAsOf": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
name string false none none
description string false none none
details string false none none
rate number false none Annual interest rate
annualPercentYield number true none none

SessionInit

{
  "id": 0,
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "sessionUuid": "0688aee8-ffa9-4d26-9262-47526493535e",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e"
}

Properties

Name Type Required Restrictions Description
id integer(int64) true none none
uuid string(uuid) true none none
sessionUuid string(uuid) true none none
createdAt string(date-time) true none none
createdBy string(uuid) true none none

SessionInitNew

{
  "sessionUuid": "0688aee8-ffa9-4d26-9262-47526493535e"
}

Properties

Name Type Required Restrictions Description
sessionUuid string(uuid) false none You may specify the session's UUID; if you don't, one will be generated for you.

SpecialOffer

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "name": "string",
  "desc": "string",
  "url": "string",
  "partnerName": "string",
  "partnerImageUrl": "string",
  "recommendationScore": 0,
  "payout": 0
}

Properties

Name Type Required Restrictions Description
uuid string(uuid) false none none
name string false none none
desc string false none Description
url string(url) false none none
partnerName string false none none
partnerImageUrl string(url) false none none
recommendationScore number false none none
payout number false none none

SpendingAggregate

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "amount": 0
}

Properties

Name Type Required Restrictions Description
uuid string(uuid) true none A category, merchant or other spending group's uuid
amount number(float) true none A representation of how much (in value or relative) the user spent in this group

SpendingAggregateUnit

"usd"

The unit of the values in spend aggregates

Properties

Name Type Required Restrictions Description
anonymous string false none The unit of the values in spend aggregates

Enumerated Values

Property Value
anonymous usd
anonymous none

SpendingCategory

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "parentUuid": "a234027b-494b-4285-a8ce-894cd0943051",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
uuid string(uuid) true none A unique identifier for the spending category. This is used to reference
spending categories in POST /offerAugmentation/rewardValueCalculations.
parentUuid string(uuid) false none The UUID of the spending category's parent spending category.
name string true none The name of the spending category.

State

"AK"

state

Properties

Name Type Required Restrictions Description
state string(state) false none A two character upper case state, Puerto Rico, or District of Columbia code

Enumerated Values

Property Value
state AK
state AL
state AR
state AZ
state CA
state CO
state CT
state DC
state DE
state FL
state GA
state HI
state IA
state ID
state IL
state IN
state KS
state KY
state LA
state MA
state MD
state ME
state MI
state MN
state MO
state MS
state MT
state NC
state ND
state NE
state NH
state NJ
state NM
state NV
state NY
state OH
state OK
state OR
state PA
state PR
state RI
state SC
state SD
state TN
state TX
state UT
state VA
state VI
state VT
state WA
state WI
state WV
state WY

TermUnit

"day"

Unit of measure for offer term lengths, or open for a single term.

Properties

Name Type Required Restrictions Description
anonymous string false none Unit of measure for offer term lengths, or open for a single term.

Enumerated Values

Property Value
anonymous day
anonymous month
anonymous year
anonymous open

TransactionLevelEarningScheme

{
  "type": "basic",
  "groups": [
    {
      "earnRate": 0,
      "earnRateText": "string",
      "items": [
        {
          "type": "category",
          "earnRate": 0,
          "personalization": {
            "totalSpent": 0,
            "totalEarned": 0,
            "totalValue": 0
          },
          "category": {
            "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
            "name": "string",
            "displayName": "string",
            "phrase": "string"
          },
          "merchant": {
            "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
            "name": "string",
            "logo": "string",
            "category": {
              "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
              "name": "string",
              "displayName": "string",
              "phrase": "string"
            }
          }
        }
      ],
      "personalization": {
        "totalSpent": 0,
        "totalEarned": 0,
        "totalValue": 0
      }
    }
  ],
  "detail": "string",
  "explaination": "string",
  "personalization": {
    "totalSpent": 0,
    "totalEarned": 0,
    "totalValue": 0
  }
}

A context around a nuumber of earning groups, such as caps, tiers, etc

Properties

None

TransactionLevelEarningSchemeType

"basic"

The type of context this is. Basic contexts have no details.

Properties

Name Type Required Restrictions Description
anonymous string false none The type of context this is. Basic contexts have no details.

Enumerated Values

Property Value
anonymous basic
anonymous calculation
anonymous introductory
anonymous rotating
anonymous capped