Skip to content

Welcome to the Eligibility Engine API

The Eligibility Engine (EE) API provides mortgage eligibility assessment and product sourcing capabilities for partners. This documentation will help you get started with integrating the API into your applications.

What You Can Do

As a partner, you have read-only access to three core capabilities:

  • Criteria Assessment - Evaluate mortgage applications against lender lending criteria
  • Lender Information - Access lender metadata, logos, and product offerings
  • Product Filtering - Search and filter mortgage products with comprehensive filtering options

Quick Navigation

  • Quick Start

    Get up and running in under 5 minutes with your first API call

    Quick Start

  • Authentication

    Learn how OAuth 2.0 authentication works with the API

    Authentication

  • API Overview

    Understand the API's capabilities and core concepts

    API Overview

  • Interactive Docs

    Explore detailed endpoint specifications in Swagger UI

    Swagger UI

API Environments

We provide two environments for you to use:

Environment Base URL Purpose
Staging https://staging.api.eligibility-engine.com/ Development and testing
Production https://api.eligibility-engine.com/ Live applications

Getting Credentials

To access the API, you'll need OAuth credentials (client_id and client_secret). These are provided by the EE dev team when you become a partner. If you don't have credentials yet, please contact us on the support email given below. Note, credentials differ between staging and production environments.

Support

Need help? Get in touch with the EE dev team on:

What's Next?

  1. New to the API? Start with the Quick Start guide to make your first request
  2. Need authentication details? Read the Authentication guide
  3. Want to understand capabilities? Check out the API Overview
  4. Ready to explore? Visit the interactive Swagger documentation