DOCUMENTATION HUB
  • Welcome
  • Platform
    • Platform Overview
    • Partners & Sites
    • Lender Hub Pipeline View
    • Landing Pages
    • Loan Assignment Links
    • Loan Officer Pages
    • Borrower Tasks
    • Borrower Document Uploads
    • Milestones
    • Troubleshooting Encompass eDisclosure packages
    • Testing Procedures
    • Blueprints
    • Sagas
      • Saga Methods Reference
    • Pushback Endpoints
    • Third Party Integrations
      • Credit Providers
        • CBC / Factual Data
        • Meridian Link
        • CoreLogic - CredCo
        • Informative Research
      • Loan Origination Systems (LOS)
        • BytePro
        • MortgageFlex
        • MeridianLink Mortgage
        • Encompass
      • Verification of Assets (VOA)
        • AccountChek by FormFree
        • Finicity
      • Verification of Employment/Income (VOIE)
        • The Work Number
      • Pricing Engines
        • Optimal Blue
        • Mortech
        • EPPS
        • PriceMyLoan
        • Polly
      • Payment Vendors
        • Celero Commerce (formerly Transnational)
      • AUS
        • Desktop Underwriter (DU)
        • Loan Product Advisor (LPA)
      • eSign
        • Dropbox Sign (formerly HelloSign)
        • DocuSign
        • EllieDocs
      • Fees
        • SmartFees
      • Customer Relationship Management (CRM)
        • SalesForce
        • TotalExpert
        • Velocify
      • Private Mortgage Insurance
    • Single Sign-On (SSO)
    • UI/UX Customizations
    • DNS Setup
    • Email White Labeling Setup
    • Notifications
    • Analytics
    • Pre-Qualification Letter
    • Teamwork
    • Reset Password
    • Webhooks
  • Encompass e-Disclosure Integration
  • Create Applications from Encompass Loans
  • Access Level Management
  • Lender Hub User Management
  • Reports Tab
  • API
    • API Overview
    • API Playground
  • Release Notes
    • Release Notes Overview
    • 2025 Release Notes
      • May 7th, 2025 Release Notes
      • April 9th, 2025 Release Notes
      • March 5th, 2025 Release Notes
      • February 5, 2025 Release Notes
      • January 8, 2025 Release Notes
    • 2024 Release Notes
      • December 4, 2024 Release Notes
      • November 6, 2024 Release Notes
      • October 10, New Feature Release: Task Due Dates & Notifications
      • October 2, 2024 Release Notes
      • September 4, 2024 Release Notes
      • August 7, 2024 Release Notes
      • July 10, 2024 Release Notes
      • June 5, 2024 Release Notes
      • May 1, 2024 Release Notes
      • April 3, 2024 Release Notes
      • March 11, 2024 Release Notes
      • February 6, 2024 Release Notes
      • January 24, 2024 Release Notes
      • January 10, 2024 Release Notes
    • 2023 Release Notes
      • December 27, 2023 Release Notes
      • December 12, 2023 Release Notes
      • November 29, 2023 Release Notes
      • November 15, 2023 Release Notes
      • November 1, 2023 Release Notes
      • October 17, 2023 Release Notes
      • September 27, 2023 Release Notes
      • September 6, 2023 Release Notes
      • August 16, 2023 Release Notes
      • August 15, 2023 Release Notes
      • July 27, 2023 Release Notes
      • June 27, 2023 Release Notes
      • June 7, 2023 Release Notes
      • May 17, 2023 Release Notes
      • April 25, 2023 Release Notes
      • April 4, 2023 Release Notes
      • March 15, 2023 Release Note
      • February 21, 2023 Release Notes
      • January 31, 2023 Release Notes
      • January 4, 2023 Release Notes
    • 2022 Release Notes
      • December 7, 2022 Release Notes
      • November 15, 2022 Release Notes
      • November 1, 2022 Release Notes
      • October 4, 2022 Release Notes
      • September 13, 2022 Release Notes
      • August 31, 2022 Release Notes
      • August 2, 2022 Release Notes
      • July 13, 2022 Release Notes
      • June 22, 2022 Release Notes
      • June 1, 2022 Release Notes
      • May 10, 2022 Release Notes
      • Apr 19, 2022 Release Notes
      • Mar 29, 2022 Release Notes
      • Mar 8, 2022 Release Notes
      • Feb 15, 2022 Release Notes
      • Jan 25, 2022 Release Notes
      • Jan 5, 2022 Release Notes
    • 2021 Release Notes
      • Dec 21, 2021 Release Notes
      • Nov 22, 2021 Release Notes
      • Nov 2, 2021 Release Notes
      • Oct 12, 2021 Release Notes
      • Sep 22, 2021 Release Notes
      • Aug 24, 2021 Release Notes
      • Aug 4, 2021 Release Notes
      • Jun 22, 2021 Release Notes
      • May 28, 2021 Release Notes
      • May 12, 2021 Release Notes
      • Apr 13, 2021 Release Notes
      • Mar 23, 2021 Release Notes
      • Feb 26, 2021 Release Notes
      • Feb 9, 2021 Release Notes
    • 2020 Release Notes
      • Dec 1, 2020 Release Notes
      • Nov 10, 2020 Release Notes
      • Oct 20, 2020 Release Notes
      • Sep 28, 2020 Release Notes
      • Sep 13, 2020 Release Notes
      • Aug 17, 2020 Release Notes
      • Jul 30, 2020 Release Notes
      • Jul 13, 2020 Release Notes
      • May 28, 2020 Release Notes
      • May 5, 2020 Release Notes
  • Client Resources
    • Client Resources Overview
    • Third Party Integrations Overview
    • Maxwell Onboarding Overview
    • Support Portal Quick Reference
    • Lender Hub User Management
    • Duplication of Applications
  • Broker Origination System (BOS)
    • Borrower Tasks in the Lender Hub
    • Exporting Client Documents from the Lender Hub
    • Exporting the MISMO 3.4 from the Lender Hub
    • Reset Password
  • Maxwell Business Intelligence
    • Data Dictionary
Powered by GitBook
On this page
  • API Pre-Release Mode
  • About GraphQL
  • Queries & Mutations
  • API Endpoints
  1. API

API Overview

PreviousReports TabNextAPI Playground

Last updated 1 year ago

Our API is based on and has a single endpoint. GraphQL APIs are organized in terms of types and fields and use types to ensure apps only ask for what’s possible and provide clear and helpful errors. Apps can use types to avoid writing manual parsing code.

API Pre-Release Mode

Our GraphQL API is currently evolving at a rapid pace to meet all of our platform's needs. You should expect frequent changes and growing capabilities at this time. We are not planning to provide production API access to lenders until Q2 2023 unless there is a compelling use case that cannot be solved with Sagas and Pushback Endpoints.

We will be releasing the API for direct use by our lenders in the near future, but for now we encourage our lenders to use our and pushback endpoints for most integration scenarios.

As we progress towards a public release of the API, there are a number of important changes we will be making that will impact any API integration:

  • API Endpoint Splitting - we intend to split the GraphQL Api into two distinct endpoints:

    • Transactional API - intended for access by a borrower or lender agent,

    • Administration API - intended for access by a system administrator.

  • Namespacing Mutations - we will be moving all of our mutations into a number of namespaces by topic to make it easier to navigate the mutations and find the appropriate mutation for a given use case.

  • API Throttling - to protect our system resources, we will impose certain rate limits on API usage.

  • Improved schema documentation

  • Improved error codes / error messages - right now most errors have the same error code and it is difficult to determine the cause of the error without access to the Maxwell backend logs.

  • Mutation return values - right now a lot of mutations return either true/false when they should really return the updated data according to GraphQL conventions.

  • Improve subscriptions - unify GraphQL subscriptions for Saga completion and "events" into a single GraphQL subscription.

  • Versioning - we will have a more formal versioning system and deprecation mechanism.

  • Improve Pagination performance

About GraphQL

GraphQL is a query language for APIs and a runtime for fulfilling those queries with our existing data. GraphQL provides a complete and understandable description of the data in our API, gives clients the power to ask for exactly what they need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools.

Here is an example query defining exactly the data and its shape that you need from the server:

{
	partner(id: 1234) {
    sites {
      items {
        id
        name
        domain        
      }
    }
  }	
}

...and the response from the server in JSON format:

{
  "data": {
    "partner": {
      "sites": {
        "items": [
          {
            "id": "1",
            "name": "Hawkins Mortgage",
            "domain": "mortgage.hawkinsbank.com"
          },
          {
            "id": "2",
            "name": "Hawkins Credit Card Services",
            "domain": "credit.hawkinsbank.com"
          },
          {
            "id": "3",
            "name": "Hawkins Auto Finance",
            "domain": "auto.hawkinsbank.com"
          },
        ]
      }
    }
  }
}

Queries & Mutations

API Endpoints

You can query your data at the following endpoints:

Before you can access the API we must provide you with an authorization token to be passed in the request's HTTP header.

"Authorization": "Bearer YOUR_TOKEN"

Queries are used to request data from the API, and Mutations are used to modify data. See examples in the section.

Production:

Staging:

GraphQL
Sagas
API Playground
https://api-production.mortgagehippo.com/graphql
https://api-staging.mortgagehippo.com/graphql