Quick Start

Get started with the Eligibility Engine (EE) API in under 5 minutes. This guide will walk you through making your first API request.

Prerequisites

Before you begin, you'll need:

• OAuth Credentials: client_id and client_secret provided by the EE dev team.
• API Base URL: Choose your environment
  • Staging: https://staging.api.eligibility-engine.com/
  • Production: https://api.eligibility-engine.com/

Don't have credentials yet?

Contact the EE dev team to get your OAuth credentials.

Step 1: Get an Access Token

The Eligibility Engine API uses OAuth 2.0 Client Credentials flow for authentication. First, you'll need to obtain an access token.

Request

The POST /oauth/token endpoint can be used with either application/json or application/x-www-form-urlencoded content types. In the case of JSON, we have:

curl -X POST https://api.eligibility-engine.com/oauth/token \
  -H "Content-Type: application/json" \
  -d '{
    "grant_type": "client_credentials",
    "client_id": "your_client_id",
    "client_secret": "your_client_secret"
  }'

Whilst for form-encoded, we have:

curl -X POST https://api.eligibility-engine.com/oauth/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&client_id=your_client_id&client_secret=your_client_secret"

Response

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "criteria:read lenders:read products:read"
}

Token Expiry

Access tokens are valid for 1 hour (3600 seconds). When your token expires, simply request a new one using the same credentials.

Step 2: Make Your First API Request

Now that you have an access token, you can make requests to the API. Let's search for mortgage products.

Request

curl -X POST https://api.eligibility-engine.com/v1/products/filter \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "sort_by": "initial_rate",
    "offset": 0,
    "limit": 10,
    "filters": {}
  }'

Response

All API responses follow a consistent structure with metadata and results:

{
  "metadata": {
    "timestamp": "2026-01-21 12:00:00",
    "total_count": 1247,
    "request_parameters": {
      "sort_by": "initial_rate",
      "offset": 0,
      "limit": 10
    }
  },
  "results": [
    {
      "product_id": 1,
      "product_uuid": "550e8400-e29b-41d4-a716-446655440000",
      "lender_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "lender_name": "Example Bank",
      "lender_logo_uri": "https://example.com/logos/nationwide.png",
      "name": "Example Bank Club Customers Only 2 Year Fixed Rate Mortgage",
      "display_name": "2 Year Fixed Rate Mortgage",
      "code": "EX123",
      "mortgage_purpose": "purchase",
      "mortgage_type": "residential",
      ...
    }
  ]
}

Success!

You've made an API request! The response includes:

• metadata: Information about the request and result count
• results: An array of mortgage products sorted by initial rate

Next Steps

Now that you've started making requests, here's what you could explore next:

• Authentication

  ---

  Learn more about OAuth, token management, and scopes

  Authentication Guide

• API Overview

  ---

  Explore the three core capabilities: criteria, lenders, and products

  API Overview

• Detailed Specifications

  ---

  View complete endpoint docs, request/response schemas, and try the API interactively

  Swagger UI

Common Next Actions

Filter Products by Criteria

Add filters to narrow down product results:

curl -X POST https://api.eligibility-engine.com/v1/products/filter \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "sort_by": "initial_rate",
    "offset": 0,
    "limit": 10,
    "filters": {
      "mortgage_type": "residential",
      "max_ltv": 90,
      "rate_type": "fixed"
    }
  }'

Get Lender Information

Retrieve metadata for all lenders:

curl -X GET https://api.eligibility-engine.com/v1/lenders \
  -H "Authorization: Bearer your_access_token"

Assess Criteria Eligibility

Submit applicant criteria answers to evaluate eligibility:

curl -X POST https://api.eligibility-engine.com/v1/criteria/eligibility \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "partner_uuid": "your_partner_uuid",
    "partner_reference": "application_123",
    "mortgage_type": "residential",
    "criteria_answers": [
      {
        "criteria_id": 1,
        "answer": 12
      }
    ]
  }'

Explore More

For complete endpoint specifications, request/response schemas, and interactive testing, visit the Swagger UI documentation.