Loan Originator
Welcome to Figure's Loan Originator API guide. This documentation provides the necessary information for fetching loan originator data, including looking up originators by email or retrieving a paginated list.
You must be onboarded before using the API. Please visit the Partner Onboarding Page for more information.
Overview
The Loan Originator API allows you to retrieve loan originator information associated with your organization. It offers the following capabilities:
- Fetch by Email: Look up one or more loan originators by their email addresses.
- Paginated Listing: Retrieve a paginated list of all loan originators available to your organization.
The following sequence diagram illustrates the typical flow:
Loan Originator Flow
Fetch Loan Originators
Retrieve loan originator data by email address or with pagination. You can query for specific originators using the email parameter, or paginate through all available originators using offset and limit.
Fields in the request/response that are colored yellowgreen are optional.
Request:
GET https://api.figure.com/management/v1/loan-originator
Query Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string[] | No | One or more email addresses to filter loan originators by |
offset | integer | No | Pagination offset (number of records to skip). Defaults to 0 |
limit | integer | No | Maximum number of records to return. Defaults to 100 |
Example Request:
GET https://api.figure.com/management/v1/loan-originator?email=john.doe@example.com&limit=10&offset=0
Response:
{
"data": [
{
"loanOriginatorId": string, // UUID format
"email": string,
"firstName": string,
"lastName": string,
"middleName": string,
"nmls": string,
"phoneNumber": string,
"organization": string,
"brokerCompany": {
"brokerId": string, // UUID format
"brokerName": string,
"brokerNmls": string
}
}
],
"total": integer, // total number of matching records
"count": integer // number of records in this response
}
Response Schema
FetchLoanOriginatorsResponse
| Field | Type | Required | Description |
|---|---|---|---|
data | LoanOriginatorData[] | Yes | Array of loan originator records |
total | integer | Yes | Total number of matching loan originators |
count | integer | Yes | Number of records returned in this response |
LoanOriginatorData
| Field | Type | Required | Description |
|---|---|---|---|
loanOriginatorId | string (UUID) | Yes | Unique identifier for the loan originator |
email | string | Yes | Email address of the loan originator |
firstName | string | Yes | First name |
lastName | string | Yes | Last name |
middleName | string | No | Middle name |
nmls | string | No | NMLS identifier |
organization | string | Yes | Organization name |
phoneNumber | string | No | Phone number |
brokerCompany | BrokerCompanyData | No | Associated broker company information |
BrokerCompanyData
| Field | Type | Required | Description |
|---|---|---|---|
brokerId | string (UUID) | Yes | Unique identifier for the broker company |
brokerName | string | Yes | Name of the broker company |
brokerNmls | string | Yes | NMLS identifier for the broker company |