Quickstart

Overview

This guide provides a step-by-step approach for initiating and managing a loan application using the Partner API. Before you begin, please review the Realfinity Resources to understand how Clients and Loan Applications interact.

Prerequisites

To access the Partner API, you must have a Client Id and Client Secret. If you do not possess these, please contact your account executive or support team.

1. Generate an OAuth Token

Use the /oauth/token endpoint with your Realfinity-provided client_id and client_secret to generate an OAuth token. This token is crucial for future API requests.

2. Creating a Client

Use the /clients endpoint to create a Client. This is an essential first step, as Clients form the base to which multiple loan applications can be linked.

3. Starting a Loan Application

To begin a loan application with the /loan-applications endpoint, ensure a Client is created.