Welcome

This page will help you get started with Realfinity. You'll be up and running!

Welcome to the Realfinity API! This interface is designed to seamlessly integrate with your applications, providing robust access to our system's resources including clients, loan applications, and users. Our API is structured to offer comprehensive management capabilities across these modules, ensuring that you can extend, customize, and enrich the functionality of your applications with ease.

Base URL

The Base URL for all API productions requests is https://api.realfinity.io/homedashboard.

API Resources

Our API is divided into several primary resources, each tailored to specific operational needs:

  • OAuth: Secure and manage access with Auth0 tokens.

  • Clients: Manage client data, including creation, retrieval, update, and deletion.

  • LoanApplications: Manage Loan Applications data, including creation, retrieval, update, and deletion.

  • Users: Administer user accounts and credentials within your system.

Each resource supports standard RESTful methods such as GET, POST, PUT, PATCH, and DELETE, providing you with the flexibility to interact with our system as per your business requirements.

Authorization

Access to the API requires proper authorization. Utilize the OAuth tokens endpoint to authenticate your requests. Ensure that each request to our API includes a valid Auth0 access token in the header.

Getting Started

To get started with the Realfinity HomeDashboard API:

  1. Review the API Documentation for detailed endpoint descriptions.

  2. Obtain necessary credentials and access tokens via the OAuth endpoint.

  3. Start making API calls to manage clients, loans, properties, and users effectively.

Support

Should you encounter any issues or require assistance, do not hesitate to contact our technical support team. For additional information, please refer to our Terms of Service.

We are committed to providing a powerful and reliable API to help you build and scale your applications. Explore our API, and take your real estate and loan management systems to the next level!

NextGetting Started

Last updated