Overview

The Even Financial API is RESTful, encodes data as JSON and authenticates all requests. You can use it to do the following:

• Build a user experience for financial service search, comparison and recommendation that is both performant and compliant.
• Integrate with and programmatically manage your Even Financial account.
• Stream analytics data into your system in near real-time.

Authentication

Authorization Header Example

Authorization: Bearer 0ee2eb9d-b0a3-4ac0-ba67-2b6b5d9499cd_6d9aa523-48f7-4a58-85ad-d3ed13c6c6ba

All requests to the Even API must be authenticated using a bearer token. There are two types of bearer tokens:

• Publishable tokens can be published in application code and downloaded to a user's device. As a result, they only have restricted access to the API.
• Confidential tokens must be managed like a password or any other confidential secret. As a result, they have access to sensitive API endpoints.

A valid bearer token is formatted as two UUIDs concatenated with an underscore. A token must be specified in the Authentication header of each request. The header value must start with the string "Bearer", followed by a single space, followed by the bearer token with no trailing whitespace.

Financial Products

Loans

Personal Loan 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"
    ]
  }
}

Personal Loan 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."
    }
  ]
}

The loan product type includes the following:

• Personal Loans
• Student Loan Refinancing
• Co-Applicant Loans
• Secured Loans
• Line of Credit

To search for any loan product, you must set productTypes to ["loan"] on the lead

Personal Loans

In order to get pre-approved and pre-qualified personal loan offers, you should specify the following fields on the lead:

• personalInformation.firstName
• personalInformation.lastName
• personalInformation.address1
• personalInformation.address2 (when applicable)
• personalInformation.city
• personalInformation.state
• personalInformation.zipcode
• personalInformation.email
• personalInformation.primaryPhone
• personalInformation.dateOfBirth
• personalInformation.ssn
• loanInformation.purpose
• loanInformation.loanAmount
• mortgageInformation.propertyStatus
• creditInformation.providedCreditRating or creditInformation.providedNumericCreditScore
• financialInformation.employmentStatus
• financialInformation.employmentPayFrequency
• financialInformation.annualIncome
• educationInformation.educationLevel
• legalInformation.consentsToTcpa
• legalInformation.consentsToFcra
• legalInformation.tcpaLanguage

Student Loan Refinancing

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

• productSubTypes must be ["student_loan_refinance"]
• loanInformation.purpose must be "student_loan_refi"
• educationInformation.graduationDate must be specified.
• financialInformation.monthlyHousingPayment must be specified.
• financialInformation.availableAssets must be specified.
• personalInformation.citizenshipStatus must be specified.
• educationInformation.universityAttended must be specified. This is a free form text field for the university name, which should be taken from the GET /leads/universities utility endpoint.
• if educationInformation.educationLevel is "doctorate", then educationInformation.graduateDegreeType must be specified.

Co-Applicant Loans

Co-applicant loans maybe be returned when searching for personal loans if the following fields are specified on the lead:

• coApplicantInformation.firstName
• coApplicantInformation.lastName
• coApplicantInformation.address1
• coApplicantInformation.address2 (when applicable)
• coApplicantInformation.city
• coApplicantInformation.state
• coApplicantInformation.zipcode
• coApplicantInformation.dateOfBirth
• coApplicantInformation.annualIncome

Secured Loans

Searching for secured loans is just like searching for personal loans.

Line of Credit

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

Savings

Savings Request

POST /leads/rateTables

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

Savings 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": []
}

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:

• personalInformation.zipcode
• creditInformation.providedCreditRating or creditInformation.providedNumericCreditScore
• savingsInformation.minDepositAmount

Credit Cards

Credit Card 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"
    ]
  }
}

Credit Card 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": []
}

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:

• personalInformation.firstName
• personalInformation.lastName
• personalInformation.address1
• personalInformation.address2 (when applicable)
• personalInformation.city
• personalInformation.state
• personalInformation.zipcode
• personalInformation.email
• personalInformation.dateOfBirth
• creditInformation.providedCreditRating or creditInformation.providedNumericCreditScore
• creditCardInformation.cardPurposes
• creditCardInformation.allowAnnualFee
• legalInformation.consentsToFcra
• legalInformation.consentsToTcpa
• legalInformation.tcpaLanguage

Endpoints

Lead

A lead combines information about a user with search criteria for financial products, and is submitted in exchange for a rate table.

A rate table is a list of financial offers that match a submitted lead.

Lead Details

No fields are required on a lead, but depending on the type of product requested, a minimum subset is required in order to potentially receive personalized offers. For details, see the Financial Products overview.

A lead may request multiple product types, in which case the returned rate table will include a list for each product type with matching offers.

Asynchronous Rate Tables

Often a rate table will be built asynchronously. This means that although the rate table gets returned, the API may still be waiting for responses from one or more financial institutions. In these cases, you should poll the rate table until all responses are resolved before displaying the offers to the end user.

So, if you submit a lead via the "Submit lead" endpoint and the returned rate table has a non-empty pendingResponses array, you should reload the rate table via the "Get rate table" endpoint, and continue to do so until pendingResponses is empty.

Blocking Endpoint

You also have the option to submit a lead and receive a rate table syncronously via a blocking endpoint at https://integrations.evenfinancial.com/blocking/leads/rateTables.

The interface is identical to the "Submit lead" endpoint, but will only respond when all financial institution responses have been resolved. As a result, the pendingResponses field will always be empty and there will be no need to poll for more results. However, the response latency will likely be much higher than the asyncronous endpoint.

Submit lead

Code sample

curl -X POST 'https://api.evenfinancial.com/leads/rateTables' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}' \
  -d @- << EOF
{
  "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"
    ]
  }
}
EOF

fetch('https://api.evenfinancial.com/leads/rateTables', {
  method: 'POST',
  headers: {
    'Content-Type':'application/json',
    'Accept':'application/json',
    'Authorization':'Bearer {access-token}'
  },
  body: `{
  "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"
    ]
  }
}`
}).then(function(res) {
  return res.json();
}).then(function(body) {
  console.log(body);
});

import requests
import json

response = requests.post(
  'https://api.evenfinancial.com/leads/rateTables',
  headers={
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': 'Bearer {access-token}'
  },
  json=json.loads("""{
  "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"
    ]
  }
}""")
)

print(response.json())

require 'rest-client'
require 'json'

response = RestClient.post(
  'https://api.evenfinancial.com/leads/rateTables',
%q|{
  "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"
    ]
  }
}|,
  {
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}'
  } 
)

p JSON.parse(response)

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

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
401	Unauthorized	Unauthorized request	Inline

Response Schema

Status Code 400

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

Status Code 401

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

Get rate table

Code sample

curl -X GET 'https://api.evenfinancial.com/originator/rateTables/{uuid}' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

fetch('https://api.evenfinancial.com/originator/rateTables/{uuid}', {
  method: 'GET',
  headers: {
    'Accept':'application/json',
    'Authorization':'Bearer {access-token}'
  }
}).then(function(res) {
  return res.json();
}).then(function(body) {
  console.log(body);
});

import requests
import json

response = requests.get(
  'https://api.evenfinancial.com/originator/rateTables/{uuid}',
  headers={
    'Accept': 'application/json',
    'Authorization': 'Bearer {access-token}'
  }
)

print(response.json())

require 'rest-client'
require 'json'

response = RestClient.get(
  'https://api.evenfinancial.com/originator/rateTables/{uuid}',
  {
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}'
  } 
)

p JSON.parse(response)

GET /originator/rateTables/{uuid}

Return a RateTable given its UUID

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"
  }
]

401 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Succesfully retrieved rate table	RateTable
400	Bad Request	Invalid UUID	Inline
401	Unauthorized	Unauthorized request	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

Status Code 401

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

Get lead

Code sample

curl -X GET 'https://api.evenfinancial.com/leads/{uuid}' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

fetch('https://api.evenfinancial.com/leads/{uuid}', {
  method: 'GET',
  headers: {
    'Accept':'application/json',
    'Authorization':'Bearer {access-token}'
  }
}).then(function(res) {
  return res.json();
}).then(function(body) {
  console.log(body);
});

import requests
import json

response = requests.get(
  'https://api.evenfinancial.com/leads/{uuid}',
  headers={
    'Accept': 'application/json',
    'Authorization': 'Bearer {access-token}'
  }
)

print(response.json())

require 'rest-client'
require 'json'

response = RestClient.get(
  'https://api.evenfinancial.com/leads/{uuid}',
  {
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}'
  } 
)

p JSON.parse(response)

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.

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",
    "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
401	Unauthorized	Unauthorized request	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

Status Code 401

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

Offer Preview

Preview offers are matched based upon a simple set of anonymous criteria and as a result are not personalized. This is useful if you'd like to display offers without requesting personalized data. For example, you can improve a search experience by presenting example offers to the user prior to asking more detailed questions.

Offers returned by these endpoints are identical to those that would be included in a rate table. But keep in mind that they are not personalized, and it's a better user experience to ultimtely present personalized offers to a user.

Get loan preview offers

Code sample

curl -X GET 'https://api.evenfinancial.com/offerPreview/loanOffers' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

fetch('https://api.evenfinancial.com/offerPreview/loanOffers', {
  method: 'GET',
  headers: {
    'Accept':'application/json',
    'Authorization':'Bearer {access-token}'
  }
}).then(function(res) {
  return res.json();
}).then(function(body) {
  console.log(body);
});

import requests
import json

response = requests.get(
  'https://api.evenfinancial.com/offerPreview/loanOffers',
  headers={
    'Accept': 'application/json',
    'Authorization': 'Bearer {access-token}'
  }
)

print(response.json())

require 'rest-client'
require 'json'

response = RestClient.get(
  'https://api.evenfinancial.com/offerPreview/loanOffers',
  {
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}'
  } 
)

p JSON.parse(response)

GET /offerPreview/loanOffers

Get loan preview offers

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
401	Unauthorized	Unauthorized request	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

Status Code 401

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

Get credit card preview offers

Code sample

curl -X GET 'https://api.evenfinancial.com/offerPreview/creditCardOffers' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

fetch('https://api.evenfinancial.com/offerPreview/creditCardOffers', {
  method: 'GET',
  headers: {
    'Accept':'application/json',
    'Authorization':'Bearer {access-token}'
  }
}).then(function(res) {
  return res.json();
}).then(function(body) {
  console.log(body);
});

import requests
import json

response = requests.get(
  'https://api.evenfinancial.com/offerPreview/creditCardOffers',
  headers={
    'Accept': 'application/json',
    'Authorization': 'Bearer {access-token}'
  }
)

print(response.json())

require 'rest-client'
require 'json'

response = RestClient.get(
  'https://api.evenfinancial.com/offerPreview/creditCardOffers',
  {
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}'
  } 
)

p JSON.parse(response)

GET /offerPreview/creditCardOffers

Get credit card preview offers

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,
      "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
401	Unauthorized	Unauthorized request	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[allOf]	false	none	[An offer for a credit card]

Status Code 401

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

Get savings preview offers

Code sample

curl -X GET 'https://api.evenfinancial.com/offerPreview/savingsOffers' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

fetch('https://api.evenfinancial.com/offerPreview/savingsOffers', {
  method: 'GET',
  headers: {
    'Accept':'application/json',
    'Authorization':'Bearer {access-token}'
  }
}).then(function(res) {
  return res.json();
}).then(function(body) {
  console.log(body);
});

import requests
import json

response = requests.get(
  'https://api.evenfinancial.com/offerPreview/savingsOffers',
  headers={
    'Accept': 'application/json',
    'Authorization': 'Bearer {access-token}'
  }
)

print(response.json())

require 'rest-client'
require 'json'

response = RestClient.get(
  'https://api.evenfinancial.com/offerPreview/savingsOffers',
  {
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}'
  } 
)

p JSON.parse(response)

GET /offerPreview/savingsOffers

Get savings preview offers

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
401	Unauthorized	Unauthorized request	Inline

Response Schema

Status Code 200

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

Status Code 401

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

Analytics

The Analytics endpoints are optimized for streaming time series datasets out of the Even API and into your system via periodic polling. They support both backfilling and near real-time injestion.

Each request will return an object with two properties:

• data is the array of events that should be loaded into your database.
• nextUrl is the URL that should be persisted and used for the next request.

nextUrl will always include a timestamp query string parameter that indicates the lower bound for when the returned events hit Even's system. Events from financial institutions or other external systems may not be shared with Even for hours or days after they occur.

A response always contains at least an hour's worth of events, so requesting a URL with a timestamp that is less than an hour old will return an error. Furthermore, it can take a few minutes to prepare the response, so we suggest polling hourly, at 15 minutes past the hour.

Backfilling

When backfilling, the timestamp of your initial request URL should be slightly before when you went live. Responses will be optimized to potentially contain many hours of data, up to roughly 1000 events. You should request each subsequent URL in succession until you're caught up.

Event history only extends back to 2020-08-01, so don't attempt to backfill earlier than that.

Get lead events

Code sample

curl -X GET 'https://api.evenfinancial.com/supplyAnalytics/leadEvents?timestamp=2019-08-24T14%3A15%3A22Z' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

fetch('https://api.evenfinancial.com/supplyAnalytics/leadEvents?timestamp=2019-08-24T14%3A15%3A22Z', {
  method: 'GET',
  headers: {
    'Accept':'application/json',
    'Authorization':'Bearer {access-token}'
  }
}).then(function(res) {
  return res.json();
}).then(function(body) {
  console.log(body);
});

import requests
import json

response = requests.get(
  'https://api.evenfinancial.com/supplyAnalytics/leadEvents',
  params={
    'timestamp': '2019-08-24T14:15:22Z'
  },
  headers={
    'Accept': 'application/json',
    'Authorization': 'Bearer {access-token}'
  }
)

print(response.json())

require 'rest-client'
require 'json'

response = RestClient.get(
  'https://api.evenfinancial.com/supplyAnalytics/leadEvents',
  {
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
    'params' => {
      'timestamp' => '2019-08-24T14:15:22Z'
    }
  }
)

p JSON.parse(response)

GET /supplyAnalytics/leadEvents

Returns events associated with a lead. The event type is indicated by the eventType property and may include:

• leadCreated - lead was submitted to Even's API
• appSubmitted - lead was submitted to Even's API with enough data to submit to a financial institution's API
• apiApproved - lead was submitted to an financial institution's API and was matched with personalized offers
• apiRejected - lead was submitted to an financial institution's API and was not matched with any offers
• offerClicked - the user clicked on an offer belonging to the lead
• applied - the user applied for an offer in the financial institution's experience
• approved - the user was approved for an offer after applying in the financial institution's experience
• listed - the user's loan was listed on the financial institution's marketplace for funding
• funded - the user's loan was funded by the financial institution
• opened - the user opened an account with the financial institution
• conversion - the user met the financial institution's requirements for monetization

Each event will also include metadata applicable to the eventType.

Example responses

200 Response

{
  "nextUrl": "https://api.evenfinancial.com/supplyAnalytics/leadEvents?timestamp=2021-01-02T17:00:00Z",
  "data": [
    {
      "leadUuid": "4bbb25a6-6fcf-4ed3-88f9-6daacb0f8b33",
      "leadCreatedAt": "2021-01-01T11:24:45Z",
      "eventType": "offerClicked",
      "eventCreatedAt": "2019-09-22T17:44:22Z",
      "financialInstitutionUuid": "da14e06b-0866-4f02-a3b2-9443501b25b9",
      "financialInstitutionName": "OpenSky®"
    },
    {
      "leadUuid": "39afdb4a-ef26-42ed-a313-e28288f95099",
      "leadCreatedAt": "2021-01-01T20:42:06Z",
      "eventType": "apiApproved",
      "eventCreatedAt": "2019-10-10T20:44:28Z",
      "financialInstitutionUuid": "da14e06b-0866-4f02-a3b2-9443501b25b9",
      "financialInstitutionName": "LendingClub"
    }
  ]
}

401 Response

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

Invalid request

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

[
  {
    "attribute": "timestamp",
    "type": "malformed",
    "details": {
      "specified": "2021-02-01T17:00:00.000Z",
      "requirement": "must be at or before 2021-01-13T16:00:00Z"
    },
    "message": "timestamp must be at or before 2021-01-13T16:00:00Z, but is '2021-02-01T17:00:00Z'"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Success	LeadEventResponse
401	Unauthorized	Unauthorized request	Inline
422	Unprocessable Entity	Invalid request	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 lead payouts

Code sample

curl -X GET 'https://api.evenfinancial.com/supplyAnalytics/leadPayouts?timestamp=2019-08-24T14%3A15%3A22Z' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

fetch('https://api.evenfinancial.com/supplyAnalytics/leadPayouts?timestamp=2019-08-24T14%3A15%3A22Z', {
  method: 'GET',
  headers: {
    'Accept':'application/json',
    'Authorization':'Bearer {access-token}'
  }
}).then(function(res) {
  return res.json();
}).then(function(body) {
  console.log(body);
});

import requests
import json

response = requests.get(
  'https://api.evenfinancial.com/supplyAnalytics/leadPayouts',
  params={
    'timestamp': '2019-08-24T14:15:22Z'
  },
  headers={
    'Accept': 'application/json',
    'Authorization': 'Bearer {access-token}'
  }
)

print(response.json())

require 'rest-client'
require 'json'

response = RestClient.get(
  'https://api.evenfinancial.com/supplyAnalytics/leadPayouts',
  {
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
    'params' => {
      'timestamp' => '2019-08-24T14:15:22Z'
    }
  }
)

p JSON.parse(response)

GET /supplyAnalytics/leadPayouts

Returns payout events associated with a lead. Event data is limited to the amount that was paid out, and when the payout was booked.

Example responses

200 Response

{
  "nextUrl": "https://api.evenfinancial.com/supplyAnalytics/leadPayouts?timestamp=2021-01-05T03:00:00Z",
  "data": [
    {
      "leadUuid": "dda9f837-2560-4b42-bc85-f6edd047a4d5",
      "bookedAt": "2021-01-01T00:00:00Z",
      "payoutInCents": 20000
    },
    {
      "leadUuid": "a61d7cc3-3ad8-45b9-ba35-6572789203b3",
      "bookedAt": "2021-01-02T00:00:00Z",
      "payoutInCents": 10000
    }
  ]
}

401 Response

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

Invalid request

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

[
  {
    "attribute": "timestamp",
    "type": "malformed",
    "details": {
      "specified": "2021-02-01T17:00:00.000Z",
      "requirement": "must be at or before 2021-01-13T16:00:00Z"
    },
    "message": "timestamp must be at or before 2021-01-13T16:00:00Z, but is '2021-02-01T17:00:00Z'"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Success	LeadPayoutResponse
401	Unauthorized	Unauthorized request	Inline
422	Unprocessable Entity	Invalid request	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 lead client tags

Code sample

curl -X GET 'https://api.evenfinancial.com/supplyAnalytics/leadClientTags?timestamp=2019-08-24T14%3A15%3A22Z' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

fetch('https://api.evenfinancial.com/supplyAnalytics/leadClientTags?timestamp=2019-08-24T14%3A15%3A22Z', {
  method: 'GET',
  headers: {
    'Accept':'application/json',
    'Authorization':'Bearer {access-token}'
  }
}).then(function(res) {
  return res.json();
}).then(function(body) {
  console.log(body);
});

import requests
import json

response = requests.get(
  'https://api.evenfinancial.com/supplyAnalytics/leadClientTags',
  params={
    'timestamp': '2019-08-24T14:15:22Z'
  },
  headers={
    'Accept': 'application/json',
    'Authorization': 'Bearer {access-token}'
  }
)

print(response.json())

require 'rest-client'
require 'json'

response = RestClient.get(
  'https://api.evenfinancial.com/supplyAnalytics/leadClientTags',
  {
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
    'params' => {
      'timestamp' => '2019-08-24T14:15:22Z'
    }
  }
)

p JSON.parse(response)

GET /supplyAnalytics/leadClientTags

Returns client tags associated with a lead. Client tags are arbitrary key / value pairs used to enable custom segmentation.

Example responses

200 Response

{
  "shouldContinuePolling": true,
  "nextUrl": "https://api.evenfinancial.com/supplyAnalytics/leadClientTags?timestamp=2021-01-10T03:00:00Z",
  "data": [
    {
      "id": "e63aff4b-eea7-4f98-926c-15a15fc76ed3",
      "leadUuid": "a67b2027-29b2-43aa-a06f-2b60deaf3f2b",
      "key": "subId",
      "value": "425352",
      "createdAt": "2021-01-05T14:00:00Z"
    }
  ]
}

401 Response

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

Invalid request

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

[
  {
    "attribute": "timestamp",
    "type": "malformed",
    "details": {
      "specified": "2021-02-01T17:00:00.000Z",
      "requirement": "must be at or before 2021-01-13T16:00:00Z"
    },
    "message": "timestamp must be at or before 2021-01-13T16:00:00Z, but is '2021-02-01T17:00:00Z'"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Success	LeadClientTagsResponse
401	Unauthorized	Unauthorized request	Inline
422	Unprocessable Entity	Invalid request	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

The UI Events endpoints allow you to record events that occur while a user interacts with a search experience. This data is used both for funnel analysis and to make it easy to meet some compliance requirements from financial institutions.

Record new session

Code sample

curl -X POST 'https://api.evenfinancial.com/uiEvent/sessionInits' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}' \
  -d @- << EOF
{
  "sessionUuid": "0688aee8-ffa9-4d26-9262-47526493535e"
}
EOF

fetch('https://api.evenfinancial.com/uiEvent/sessionInits', {
  method: 'POST',
  headers: {
    'Content-Type':'application/json',
    'Accept':'application/json',
    'Authorization':'Bearer {access-token}'
  },
  body: `{
  "sessionUuid": "0688aee8-ffa9-4d26-9262-47526493535e"
}`
}).then(function(res) {
  return res.json();
}).then(function(body) {
  console.log(body);
});

import requests
import json

response = requests.post(
  'https://api.evenfinancial.com/uiEvent/sessionInits',
  headers={
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': 'Bearer {access-token}'
  },
  json=json.loads("""{
  "sessionUuid": "0688aee8-ffa9-4d26-9262-47526493535e"
}""")
)

print(response.json())

require 'rest-client'
require 'json'

response = RestClient.post(
  'https://api.evenfinancial.com/uiEvent/sessionInits',
%q|{
  "sessionUuid": "0688aee8-ffa9-4d26-9262-47526493535e"
}|,
  {
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}'
  } 
)

p JSON.parse(response)

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.

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
401	Unauthorized	Unauthorized request	Inline

Response Schema

Status Code 400

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

Status Code 401

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

Record offer display

Code sample

curl -X POST 'https://api.evenfinancial.com/uiEvent/offerDisplays' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}' \
  -d @- << EOF
{
  "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
  "rateTableUuid": "f4dda88e-e5bc-42b2-81a8-c348b4b628db",
  "offerUuid": "5d19bb70-d72b-45ae-9b5e-c4257877bdbb"
}
EOF

fetch('https://api.evenfinancial.com/uiEvent/offerDisplays', {
  method: 'POST',
  headers: {
    'Content-Type':'application/json',
    'Accept':'application/json',
    'Authorization':'Bearer {access-token}'
  },
  body: `{
  "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
  "rateTableUuid": "f4dda88e-e5bc-42b2-81a8-c348b4b628db",
  "offerUuid": "5d19bb70-d72b-45ae-9b5e-c4257877bdbb"
}`
}).then(function(res) {
  return res.json();
}).then(function(body) {
  console.log(body);
});

import requests
import json

response = requests.post(
  'https://api.evenfinancial.com/uiEvent/offerDisplays',
  headers={
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': 'Bearer {access-token}'
  },
  json=json.loads("""{
  "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
  "rateTableUuid": "f4dda88e-e5bc-42b2-81a8-c348b4b628db",
  "offerUuid": "5d19bb70-d72b-45ae-9b5e-c4257877bdbb"
}""")
)

print(response.json())

require 'rest-client'
require 'json'

response = RestClient.post(
  'https://api.evenfinancial.com/uiEvent/offerDisplays',
%q|{
  "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
  "rateTableUuid": "f4dda88e-e5bc-42b2-81a8-c348b4b628db",
  "offerUuid": "5d19bb70-d72b-45ae-9b5e-c4257877bdbb"
}|,
  {
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}'
  } 
)

p JSON.parse(response)

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.

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
401	Unauthorized	Unauthorized request	Inline

Response Schema

Status Code 400

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

Status Code 401

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

UI Utils

A collection of endpoints that can be used to improve a search experience.

Get university names

Code sample

curl -X GET 'https://api.evenfinancial.com/leads/universities?limit=1' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

fetch('https://api.evenfinancial.com/leads/universities?limit=1', {
  method: 'GET',
  headers: {
    'Accept':'application/json',
    'Authorization':'Bearer {access-token}'
  }
}).then(function(res) {
  return res.json();
}).then(function(body) {
  console.log(body);
});

import requests
import json

response = requests.get(
  'https://api.evenfinancial.com/leads/universities',
  params={
    'limit': '1'
  },
  headers={
    'Accept': 'application/json',
    'Authorization': 'Bearer {access-token}'
  }
)

print(response.json())

require 'rest-client'
require 'json'

response = RestClient.get(
  'https://api.evenfinancial.com/leads/universities',
  {
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
    'params' => {
      'limit' => '1'
    }
  }
)

p JSON.parse(response)

GET /leads/universities

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

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"
]

401 Response

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

Responses

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

Response Schema

Status Code 401

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

Get featured financial institutions

Code sample

curl -X GET 'https://api.evenfinancial.com/uiUtil/featuredFinancialInstitutions' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

fetch('https://api.evenfinancial.com/uiUtil/featuredFinancialInstitutions', {
  method: 'GET',
  headers: {
    'Accept':'application/json',
    'Authorization':'Bearer {access-token}'
  }
}).then(function(res) {
  return res.json();
}).then(function(body) {
  console.log(body);
});

import requests
import json

response = requests.get(
  'https://api.evenfinancial.com/uiUtil/featuredFinancialInstitutions',
  headers={
    'Accept': 'application/json',
    'Authorization': 'Bearer {access-token}'
  }
)

print(response.json())

require 'rest-client'
require 'json'

response = RestClient.get(
  'https://api.evenfinancial.com/uiUtil/featuredFinancialInstitutions',
  {
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}'
  } 
)

p JSON.parse(response)

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"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	The featured financial institutions belonging to the channel partner	Inline
400	Bad Request	Invalid request provided	Inline
401	Unauthorized	Unauthorized request	Inline

Response Schema

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

Status Code 401

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

Schemas

ApiError

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

Properties

Name	Type	Required	Description
attribute	string	false	The attribute that this error applies to. Omitted if this error is not in the context of a resource, or cannot be isolated to a single attribute.
type	string	false	A classification for this error, which can be used to render the appropriate custom error template, or take other programmatic actions.
details	object	false	Variables associated with this error that can be injected into a custom error template, or used to parameterize any other programatic actions.
message	string	false	A human-readable, English description of the error.

ApiErrorDetails

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

Properties

Name	Type	Required	Description
[any key]	string	false

AprType

"variable"

Enum

Value
variable
regular
fixed

BankAccountType

"checking"

Enum

Value
checking
savings
other

CardBenefit

"No Foreign Transaction Fees"

Enum

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

CardPurpose

"balance_transfer"

Enum

Value
balance_transfer
cash_back
earning_rewards
improve_credit
low_interest
new_to_credit
student
travel_incentives

CardType

"visa"

Enum

Value
visa
mastercard
american_express
discover

CitizenshipStatus

"citizen"

Enum

Value
citizen
permanent_resident
other

CompoundingMethod

"annually"

Enum

Value
annually
continuous
daily
monthly
quarterly
semiAnnually
simple
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,
    "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"
}

Properties

Name	Type	Required	Description
uuid	string [uuid]	false
partner	Partner	false
marketplace	Partner	false
productType	ProductType	false
productSubType	ProductSubType	false
url	string [url]	false
recommendationScore	number	false
disclaimer	string	false
productSubTypeDisclaimer	string	false
details	CreditCardOfferDetails	true

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,
  "foreignTransactionFee": 0,
  "cardBenefits": [
    "No Foreign Transaction Fees"
  ]
}

Properties

Name	Type	Required	Description
cardName	string	false	Display name of the card
cardImageUrl	string [url]	true
cardPurposes	CardPurpose array	false
ratesUrl	string [url]	false	External link to card rates, terms and conditions
maxPurchaseApr	number	false
minPurchaseApr	number	false
purchaseAprText	string	false
maxPurchaseIntroApr	number	false
minPurchaseIntroApr	number	false
purchaseIntroAprTerm	integer [int32]	false
purchaseIntroAprTermUnit	TermUnit	false
purchaseIntroAprText	string	false
maxCashAdvanceApr	number	false
minCashAdvanceApr	number	false
cashAdvanceAprText	string	false
maxCashAdvanceIntroApr	number	false
minCashAdvanceIntroApr	number	false
cashAdvanceIntroAprTerm	integer [int32]	false
cashAdvanceIntroAprTermUnit	TermUnit	false
cashAdvanceIntroAprText	string	false
maxBalanceTransferApr	number	false
minBalanceTransferApr	number	false
balanceTransferAprText	string	false
maxBalanceTransferIntroApr	number	false
minBalanceTransferIntroApr	number	false
balanceTransferIntroAprTerm	integer [int32]	false
balanceTransferIntroAprTermUnit	TermUnit	false
balanceTransferIntroAprText	string	false
maxAnnualFee	number	false
minAnnualFee	number	false
annualIntroFee	number	false
annualIntroFeeTerm	integer [int32]	false	Number of years the introductory anual fee is in effect
introOfferAmount	number	false
introOfferText	string	false
introOfferType	IntroOfferType	false
details	string array	false	List of card features which must be prominently displayed with the offer
additionalDetails	string array	false	List of card features which must be displayed with the offer
cardType	CardType	false
minimumCreditLine	number	false
minimumPenaltyApr	number	false
maximumPenaltyApr	number	false
balanceTransferFee	number	false
cashAdvanceFee	number	false
lateFee	number	false
foreignExchangeFee	number	false
accountOpeningFee	number	false
returnPaymentFee	number	false
monthlyServiceFee	number	false
recommendedCreditRatings	ProvidedCreditRating array	false
preQualified	boolean	true
preApproved	boolean	true
preSelected	boolean	false	Indicates that Even has determined that the user has an increased likelihood of being approved for this card.
foreignTransactionFee	number [float]	false	Percentage represented in decimal format added to all foreign transactions
cardBenefits	CardBenefit array	false

ClientTags

{
  "subid": [
    "123"
  ]
}

Properties

Name	Type	Required	Description
[any key]	string array	false

EducationLevel

"high_school"

Enum

Value
high_school
associate
bachelors
masters
doctorate
other_grad_degree
certificate
did_not_graduate
still_enrolled
other

EmploymentPayFrequency

"weekly"

Enum

Value
weekly
biweekly
twice_monthly
monthly

EmploymentStatus

"employed"

Enum

Value
employed
employed_full_time
employed_part_time
military
not_employed
self_employed
retired
other

EventType

"leadCreated"

Enum

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

FeaturedFinancialInstitution

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

Properties

Name	Type	Required	Description
uuid	string [uuid]	true	A unique identifier for the financial institution.
name	string	true	The name of the financial institution. This value is subject tochange, so financialInstitutionUuid should be used for grouping.
logoUrl	string [url]	true	The URL of an image logo for the associated financial institution.

IdType

"driver_license"

Enum

Value
driver_license
state_id
passport

GraduateDegreeType

"doctor_of_medicine"

Enum

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

Gender

"male"

Enum

Value
male
female

IntroOfferType

"miles"

Enum

Value
miles
points
statement_credit

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",
    "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	Description
leadProviderName	string	true	Name of company which provided the lead
personalInformation	LeadPersonalInformation	false
personalReferenceInformation	PersonalReferenceInformation	false
loanInformation	LeadLoanInformation	false
mortgageInformation	LeadMortgageInformation	false
creditCardInformation	LeadCreditCardInformation	false
savingsInformation	LeadSavingsInformation	false
creditInformation	LeadCreditInformation	false
financialInformation	LeadFinancialInformation	false
employmentInformation	LeadEmploymentInformation	false
legalInformation	LeadLegalInformation	false
educationInformation	LeadEducationInformation	false
coApplicantInformation	LeadCoApplicantInformation	false
healthInformation	LeadHealthInformation	false
identificationInformation	LeadIdentificationInformation	false
lifeInsuranceInformation	LeadLifeInsuranceInformation	false
refinanceLoans	RefinanceLoanInformation array	false
clientTags	ClientTags	false
sessionInformation	LeadSessionInformation	false
leadActions	LeadAction array	false
uuid	string [uuid]	true	Primary UUID for a Lead
companyUUID	string [uuid]	true	UUID for a company which created the Lead
sessionUuid	string [uuid]	false	UUID used to link leads across verticals, unique per user per supply sub-account
referralCompanyUuid	string [uuid]	false
trackingUuid	string [uuid]	false
isTest	boolean	true	Whether a Lead was created using a test access token
status	string	true	The furthest step of the funnel a Lead has reached
createdAt	string [date-time]	true
updatedAt	string [date-time]	true

LeadBestTimeToCall

"morning"

Enum

Value
morning
afternoon
evening
night

LeadCoApplicantInformation

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

Properties

Name	Type	Required	Description
firstName	string	false
lastName	string	false
dateOfBirth	string [date]	false
annualIncome	integer [int32]	false
streetAddress1	string	false	Street address (primary address line)
streetAddress2	string	false	Secondary address line
city	string	false
state	State	false
zipCode	string	false

LeadCreditInformation

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

Properties

Name	Type	Required	Description
providedCreditRating	ProvidedCreditRating	false
providedNumericCreditScore	integer [int32]	false	FICO credit score provided by a Lead

LeadCreditCardInformation

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

Properties

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

LeadClientTagsResponse

{
  "nextUrl": "string",
  "shouldContinuePolling": true,
  "data": [
    {
      "hash": "string",
      "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
      "key": "string",
      "value": "string",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ]
}

Properties

Name	Type	Required	Description
nextUrl	string	true	A URL which identifies where the next batch of LeadClientTags can be queried for.
shouldContinuePolling	boolean	true	If true, data is currently available at nextUrl. If false, you should wait an hour before requesting nextUrl.
data	LeadClientTag array	true	Lead client tag data for the requested time window.

LeadClientTag

{
  "hash": "string",
  "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
  "key": "string",
  "value": "string",
  "createdAt": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Description
hash	string	true	A unique hash for the client tag to assist with deduplication.
leadUuid	string [uuid]	true	The UUID of the lead that this client tag belongs to.
key	string	true	The key of this client tag.
value	string	true	The latest value for the client tag key.
createdAt	string [date-time]	true	The time that this client tag was added to the lead.

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

Name	Type	Required	Description
educationLevel	EducationLevel	false
graduateDegreeType	GraduateDegreeType	false
universityAttended	string	false	Name of university where a lead received their undergraduate degree.A lookup service for possible universities is available from using the /leads/universities endpoint.To maximize returned offers, this string must match one of the names returned from the lookup.
graduationDate	string [date]	false	Date the lead graudated from undergrad (YYYY-MM-DD)
graduateGraduationDate	string [date]	false	Lead's graduate school graduation date (YYYY-MM-DD)
graduateLastAttendedDate	string [date]	false	Lead's last attended month/year for graduate school (YYYY-MM-DD)
graduateUniversityAttended	string	false	Name of university where a lead received their graduate degree.A lookup service for possible universities is available from using the /leads/universities endpoint.To maximize returned offers, this string must match one of the names returned from the lookup.
undergraduateGraduationDate	string [date]	false	Date the lead graduated from undergrad (YYYY-MM-DD).
undergraduateLastAttendedDate	string [date]	false	Lead's last attended month/year for undergrad (YYYY-MM-DD)
undergraduateUniversityAttended	string	false	Name of university where a lead received their undergraduate degree.A lookup service for possible universities is available from using the /leads/universities endpoint.To maximize returned offers, this string must match one of the names returned from the lookup.

LeadEducationLevel

"high_school"

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	Description
employerName	string	false
employerAddress	string	false
employerAddress2	string	false
employerCity	string	false
employerPhone	string	false
employerState	string	false
employerZip	string	false
jobTitle	string	false
monthsEmployed	integer [int32]	false
directDeposit	boolean	false	Whether a Lead uses direct deposit for their salary
payDate1	string [date]	false
payDate2	string [date]	false
startDate	string [date]	false	The date the lead started working at their current employer (YYYY-MM-DD)

LeadFinancialInformation

{
  "employmentStatus": "employed",
  "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

Name	Type	Required	Description
employmentStatus	EmploymentStatus	false
employmentPayFrequency	EmploymentPayFrequency	false
annualIncome	integer [int32]	false
monthlyNetIncome	integer [int32]	false
bankName	string	false
bankRoutingNumber	string	false
bankAccountType	BankAccountType	false
creditCardDebt	integer [int32]	false
monthsAtBank	integer [int32]	false
bankAccountNumber	string	false
monthlyDebt	integer [int32]	false
totalAssets	integer [int32]	false
monthlyHousingPayment	integer [int32]	false
availableAssets	integer [int32]	false
additionalIncome	integer [int32]	false	The amount of additional income the lead recieves
additionalIncomeFrequency	EmploymentPayFrequency	false	The frequency the lead recieves additional income

LeadHealthInformation

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

Properties

Name	Type	Required	Description
gender	Gender	false
heightInInches	integer [int32]	false
weightInPounds	integer [int32]	false
tobaccoSmoker	boolean	false

LeadIdentificationInformation

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

Properties

Name	Type	Required	Description
idNumber	string	false	The ID number supplied by the lead
idState	string	false	The state of issue of the supplied ID
idType	IdType	false	The form of the ID number supplied by the lead

LeadLegalInformation

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

Properties

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

LeadLifeInsuranceInformation

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

Properties

Name	Type	Required	Description
carrier	string	true	Carrier of the policy
duration	integer [int64]	true	Duration, in years
policyAmount	integer [int64]	true	Policy amount, in dollars

LeadLoanInformation

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

Properties

Name	Type	Required	Description
purpose	LoanPurpose	false
loanAmount	integer [int32]	false

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

Name	Type	Required	Description
propertyType	PropertyType	false
propertyValue	integer [int32]	false
mortgageBalance	integer [int32]	false
lenderName	string	false
hasFHALoan	boolean	false
currentWithLoan	boolean	false
propertyStatus	PropertyStatus	false
mortgageType	MortgageType	false
mortgageAmount	integer [int32]	false	Amount the lead will borrow
downPaymentAmount	integer [int32]	false
propertyState	string	false
propertyCounty	string	false
propertyAddress1	string	false	Street address (primary address line)
propertyAddress2	string	false	Secondary address line
propertyZipcode	string	false
propertyCity	string	false
refinanceAmount	integer [int32]	false	Amount the lead will borrow for refinancing an existing mortgage
cashOutAmount	integer [int32]	false	Additional amount the lead will borrow against existing home equity in the case of refinance
occupancyType	OccupancyType	false
refinanceType	RefinanceType	false
propertySearchStatus	PropertySearchStatus	false
numUnits	integer [int32]	false	The number of legal units on the property
closingDate	string [date]	false
purchaseStatus	PurchaseStatus	false
purchaseDate	string [date]	false
monthlyHoaFee	number [float]	false	The amount of the HOA fee for the lead
mortgageCompany	string	false	The name of the company holding the lead's mortgage
mortgageEscrowAmount	number [float]	false	The amount of escrow the lead pays

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	Description
firstName	string	false
lastName	string	false
aliasFirstName	string	false	The first name the lead uses as an alias
aliasLastName	string	false	The last name the lead uses as an alias
email	string [email]	false
city	string	false
state	State	false
workPhone	string	false
primaryPhone	string	false
bestTimeToCall	LeadBestTimeToCall	false
address1	string	false	Street address (primary address line)
address2	string	false	Secondary address line
addressMoveInDate	string [date]	false	The date the lead moved into their current address
zipcode	string	false
monthsAtAddress	integer [int32]	false	Number of months the provided address has been the lead's primary residence
driversLicenseNumber	string	false
driversLicenseState	string	false	State in which the driver's license was issued
ipAddress	string [ip]	false	IP address
activeMilitary	boolean	false	Whether the lead is currently in the military (not a veteran)
militaryVeteran	boolean	false	Whether the lead is a veteran (should not be used if the lead is active in the military)
dateOfBirth	string [date]	false
educationLevel	string	false
ssn	string	false
citizenshipStatus	CitizenshipStatus	false

LeadSavingsInformation

{
  "minDepositAmount": 0
}

Properties

Name	Type	Required	Description
minDepositAmount	integer [int64]	false	The minimum amount a Lead is interesting in depositing when opening a new savings account

LeadSessionInformation

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

Properties

Name	Type	Required	Description
ipAddress	string	false
userAgent	string	false

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	Description
uuid	string [uuid]	true
actionType	LeadActionType	true
actionDate	string [date-time]	true
originatorKey	string	false
demandSubAccountId	integer [int64]	true
rejectReason	RejectReason	false
amount	integer [int32]	false
originationFee	integer [int32]	false
offerClickId	integer [int64]	false
createdAt	string [date-time]	true
deletedAt	string [date-time]	false

LeadActionType

"initialized"

Enum

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

LeadEvent

{
  "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
  "leadCreatedAt": "2019-08-24T14:15:22Z",
  "eventType": "leadCreated",
  "eventCreatedAt": "2019-08-24T14:15:22Z",
  "amountInCents": 0,
  "financialInstitutionUuid": "04da1391-4dfd-4103-aeec-373cd7afc295",
  "financialInstitutionName": "string",
  "productType": "credit_card"
}

Properties

Name	Type	Required	Description
leadUuid	string [uuid]	true	The unique identifier for the associated lead.
leadCreatedAt	string [date-time]	true	The time that the associated lead was created.
eventType	EventType	true
eventCreatedAt	string [date-time]	true	The time that the event occurred.
amountInCents	integer [int32]	false	The payout amount associated with event, in cents. Only present for some events.
financialInstitutionUuid	string [uuid]	false	A unique identifier for the associated financial institution. Only present for event types associated with financial institutions.
financialInstitutionName	string	false	The name of the associated financial institution. This value is subject to change, so financialInstitutionUuid should be used as a stable identifier. Only present for event types associated with financial institutions.
productType	ProductType	false	The product type for the associated offer. Only present for event types associated with offers.

LeadEventResponse

{
  "nextUrl": "string",
  "data": [
    {
      "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
      "leadCreatedAt": "2019-08-24T14:15:22Z",
      "eventType": "leadCreated",
      "eventCreatedAt": "2019-08-24T14:15:22Z",
      "amountInCents": 0,
      "financialInstitutionUuid": "04da1391-4dfd-4103-aeec-373cd7afc295",
      "financialInstitutionName": "string",
      "productType": "credit_card"
    }
  ]
}

Properties

Name	Type	Required	Description
nextUrl	string	true	The URL for the next request.
data	LeadEvent array	true	Lead event data for the requested time window.

LeadPayout

{
  "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
  "bookedAt": "2019-08-24T14:15:22Z",
  "payoutInCents": 0
}

Properties

Name	Type	Required	Description
leadUuid	string [uuid]	true	The unique identifier for the associated lead.
bookedAt	string [date-time]	true	The time that this payment was booked.
payoutInCents	number [double]	false	The payout amount in cents. May be fractional.

LeadPayoutResponse

{
  "nextUrl": "string",
  "data": [
    {
      "leadUuid": "5510f6c4-1e4d-436b-ae63-0e2a915ce318",
      "bookedAt": "2019-08-24T14:15:22Z",
      "payoutInCents": 0
    }
  ]
}

Properties

Name	Type	Required	Description
nextUrl	string	true	The URL for the next request.
data	LeadPayout array	true	Lead payout data for the requested time window.

LeadUuid

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

Properties

Name	Type	Required	Description
uuid	string [uuid]	true	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	Description
productTypes	ProductType array	false	Product types in which the Lead is interested
uuid	string [uuid]	false	Primary UUID for a Lead
sessionUuid	string [uuid]	false	UUID used to link leads across verticals, unique per user per supply sub-account
loanInformation	LeadLoanInformation	false
personalInformation	LeadPersonalInformation	false
personalReferenceInformation	PersonalReferenceInformation	false
mortgageInformation	LeadMortgageInformation	false
creditCardInformation	LeadCreditCardInformation	false
savingsInformation	LeadSavingsInformation	false
creditInformation	LeadCreditInformation	false
financialInformation	LeadFinancialInformation	false
employmentInformation	LeadEmploymentInformation	false
legalInformation	LeadLegalInformation	false
educationInformation	LeadEducationInformation	false
coApplicantInformation	LeadCoApplicantInformation	false
healthInformation	LeadHealthInformation	false
refinanceLoans	RefinanceLoanInformation array	false	One or more loans that the lead wishes to refinance or consolidate
identificationInformation	LeadIdentificationInformation	false
clientTags	ClientTags	false
sessionInformation	LeadSessionInformation	false
formCompleted	boolean	false	Whether the Lead has completed an application form
referralCompanyUuid	string [uuid]	false	UUID of company from which the Lead was referred
trackingUuid	string [uuid]	false	UUID for internal Even Financial tracking purposes. This field should never be set by 3rd party API consumers

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	Description
uuid	string [uuid]	false
originator	Originator	false
originatorId	string	false
termLength	integer [int32]	true
termUnit	TermUnit	true
maxAmount	integer [int32]	true
minAmount	integer [int32]	false
maxApr	number	false
minApr	number	false
meanApr	number	false
feeRate	number	false	The maximum percent of loan amount fee for an offer. maxFeeRate should be used instead
maxFeeRate	number	false
minFeeRate	number	false
feeFixed	number	false	The maximum fee, in dollars, for an offer. maxFeeFixed should be used instead
maxFeeFixed	number	false
minFeeFixed	number	false
allowPrepayment	boolean	true
prepaymentFee	number	false
monthlyPayment	number	false	The estimated maximum monthly payment, in dollars, for an offer. maxMonthlyPayment should be used instead
maxMonthlyPayment	number	false
minMonthlyPayment	number	false
meanMonthlyPayment	number	false
maxTotalPayment	number	false
minTotalPayment	number	false
meanTotalPayment	number	false
terms	string	false
url	string [url]	false
preQualified	boolean	true
preApproved	boolean	true
secured	boolean	true
sponsored	boolean	true
recommendationScore	number	false
payout	number	false
conversionProbability	number	false
productType	ProductType	false
productSubType	ProductSubType	false
productSubTypeDisclaimer	string	false
aprType	AprType	true

LoanPurpose

"auto_purchase"

Enum

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

MortgageAdjustmentType

"credits"

Enum

Value
credits
par
points

MortgageLoanType

"fifteen_year_fixed"

Enum

Value
fifteen_year_fixed
thirty_year_fixed
five_one_adjustable
seven_one_adjustable
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"
}

Properties

Name	Type	Required	Description
uuid	string [uuid]	false
partner	Partner	false
marketplace	Partner	false
productType	ProductType	false
productSubType	ProductSubType	false
url	string [url]	false
recommendationScore	number	false
disclaimer	string	false
productSubTypeDisclaimer	string	false
details	MortgageOfferDetails	true

MortgageOfferDetails

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

Properties

Name	Type	Required	Description
interestRate	number	true
loanType	MortgageLoanType	true
priceAdjustment	number	true
monthlyPayment	number	true
netClosingCosts	number	true
apr	number	true
loanTerm	integer [int32]	true
adjustmentType	MortgageAdjustmentType	true

MortgageType

"purchase"

Enum

Value
purchase
refinance

OccupancyType

"primary"

Enum

Value
primary
secondary
investment

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	Description
uuid	string [uuid]	true
partner	Partner	true
marketplace	Partner	false
productType	ProductType	true
productSubType	ProductSubType	true
url	string [url]	true
recommendationScore	number	false
disclaimer	string	false
productSubTypeDisclaimer	string	false

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	Description
id	integer [int64]	true
uuid	string [uuid]	true
leadUuid	string [uuid]	true
rateTableUuid	string [uuid]	true
offerUuid	string [uuid]	true
createdAt	string [date-time]	true
createdBy	string [uuid]	true

Originator

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

Properties

Name	Type	Required	Description
key	string	true
name	string	true
description	string	false
images	OriginatorImage array	true
disclaimer	string	false
companyUuid	string [uuid]	false

OriginatorImage

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

Properties

Name	Type	Required	Description
sizeKey	string	false
url	string	false

Partner

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

Properties

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

PendingResponse

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

Properties

Name	Type	Required	Description
partner	Partner	true
productTypes	ProductType array	true

PersonalReferenceInformation

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

Properties

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

PersonalReferenceRelationType

"parent"

Enum

Value
parent
employer
spouse
guardian
sibling
relative
friend
other

ProductType

"credit_card"

Enum

Value
credit_card
insurance
life_insurance
loan
mortgage
savings
other
unknown

ProductSubType

"credit_card"

Enum

Value
credit_card
secured_card
personal_loan
secured_loan
student_loan_refinance
co_applicant_loan
line_of_credit
purchase
refinance
savings_account
money_market_account
certificate_of_deposit
individual_retirement_account
cash_management_account
high_interest_checking
accidental_death_benefits
term_life
term_life_instant
whole_life

ProvidedCreditRating

"excellent"

Enum

Value
excellent
good
fair
poor
limited
unknown

PropertyStatus

"own_outright"

Enum

Value
own_outright
own_with_mortgage
rent

PropertySearchStatus

"found"

Enum

Value
found
not_found

PropertyType

"rent"

Enum

Value
rent
condo
multi_unit
single_family
townhouse

PurchaseStatus

"no_offer"

Enum

Value
no_offer
offer_accepted
offer_pending
under_contract

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,
        "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"
      ]
    }
  ]
}

Properties

Name	Type	Required	Description
uuid	string [uuid]	true	Primary UUID for a RateTable
leadUuid	string [uuid]	true	UUID of the associated Lead
loanAmount	integer [int32]	true	Lead's provided loan amount at the time of RateTable creation
creditCardOffers	CreditCardOffer array	true
loanOffers	LoanOffer array	true
mortgageOffers	MortgageOffer array	true
savingsOffers	SavingsOffer array	true
specialOffers	SpecialOffer array	true
pendingOriginators	Originator array	true	List of originators which have been queried, but have not responded yet. This list only contains loan originators, and should no longer be used
pendingResponses	PendingResponse array	true	List of demand partners which have been queried, but have not responded yet. It is a guarantee that no offers will be added to the rate table after this list is empty

RefinanceLoanInformation

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

Properties

Name	Type	Required	Description
accountNumber	string	false	The account number for a loan the lead is refinancing
incomeBasedRepayment	boolean	false	If the repayment is income-based for a loan the lead is refinancing
interestRate	number [float]	false	The interest rate for a loan the lead is refinancing
loanAmount	integer [int32]	false	The loan amount for a loan the lead is refinancing
loanServicer	string	false	The name of a loan servicer of a loan the lead is refinancing
loanType	RefinanceLoanType	false	The loan type for a loan the lead is refinancing
nextPaymentAmount	number [float]	false	The amount the next payment will be on a loan the lead is refinancing
nextPaymentDate	string [date]	false	The next payment date for a loan the lead is refinancing

RefinanceLoanType

"federal_student_loan"

Enum

Value
federal_student_loan
private_student_loan

RefinanceType

"cash_out"

Enum

Value
cash_out
rate_term

RejectReason

"low_fico"

Enum

Value
low_fico
no_fico
major_derogatory
underwriting_decline
debt_to_income_ratio
not_in_active_state
incorrect_data_provided
duplicate

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"
}

Properties

Name	Type	Required	Description
uuid	string [uuid]	false
partner	Partner	false
marketplace	Partner	false
productType	ProductType	false
productSubType	ProductSubType	false
url	string [url]	false
recommendationScore	number	false
disclaimer	string	false
productSubTypeDisclaimer	string	false
details	SavingsOfferDetails	true

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	Description
name	string	false
description	string	false
details	string	false
rate	number	false	Annual interest rate
annualPercentYield	number	true
compoundingMethod	CompoundingMethod	true
introductoryPeriodMonths	integer [int32]	false
introductoryRate	number	false
minimumDeposit	number	true
minimumDepositWithFees	number	false
monthlyFee	number	true
checkWriting	boolean	false	Whether the account allows checks
effectiveAsOf	string [date-time]	false	When the offer was last validated, formatted as yyyy-MM-ddTHH:mm:ss.SSSZZ

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	Description
id	integer [int64]	true
uuid	string [uuid]	true
sessionUuid	string [uuid]	true
createdAt	string [date-time]	true
createdBy	string [uuid]	true

SessionInitNew

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

Properties

Name	Type	Required	Description
sessionUuid	string [uuid]	false	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	Description
uuid	string [uuid]	false
name	string	false
desc	string	false	Description
url	string [url]	false
partnerName	string	false
partnerImageUrl	string [url]	false
recommendationScore	number	false
payout	number	false

State

"AK"

Enum

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

TermUnit

"day"

Enum

Value
day
month
year
open