Skip to content
Docs

Loan Originators API

Learn how to fetch and manage loan originator data using the Loan Originator API

View as Markdown
On this page· 9 sections

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. See Partner onboarding to get set up, or contact us if you haven't started yet.

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.

How it works#

Your system
Figure
  1. 1
    List loan originators, optionally by email
    GET/management/v1/loan-originator
  2. 2
    Loan originators, with the UUID to use on each request

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.

Optional fields in requests and responses are highlighted in green.

Request

GEThttps://api.test.figure.com/management/v1/loan-originator

Query parameters#

ParameterTypeRequiredDescription
emailstring[]NoOne or more email addresses to filter loan originators by
offsetintegerNoPagination offset (number of records to skip). Defaults to 0
limitintegerNoMaximum number of records to return. Defaults to 100

Example request#

GEThttps://api.test.figure.com/management/v1/loan-originator?email=john.doe@example.com&limit=10&offset=0

Response

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
}
Highlighted lines are optional.

Response schema#

FetchLoanOriginatorsResponse#

FieldTypeRequiredDescription
dataLoanOriginatorData[]YesArray of loan originator records
totalintegerYesTotal number of matching loan originators
countintegerYesNumber of records returned in this response

LoanOriginatorData#

FieldTypeRequiredDescription
loanOriginatorIdstring (UUID)YesUnique identifier for the loan originator
emailstringYesEmail address of the loan originator
firstNamestringYesFirst name
lastNamestringYesLast name
middleNamestringNoMiddle name
nmlsstringNoNMLS identifier
organizationstringYesOrganization name
phoneNumberstringNoPhone number
brokerCompanyBrokerCompanyDataNoAssociated broker company information

BrokerCompanyData#

FieldTypeRequiredDescription
brokerIdstring (UUID)YesUnique identifier for the broker company
brokerNamestringYesName of the broker company
brokerNmlsstringYesNMLS identifier for the broker company