This API Service allows Customers to retrieve NMLS data for a given entity per request.
Visit Optimal Blue's Digital Marketplace by clicking HERE to register and access all API documentation. For more information please contact Optimal Blue Sales.
Please Note: The "Try It" feature does not work with this API as the dataset is live.
| Data Type | Description |
| String | A sequence of characters. See API Documentation for more details, such as, maximum length of specific fields |
| Integer | Mathematical values (Numbers). See API Documentation for more details |
| Boolean | Has one or two possible values (Example, True or False) |
Branch
API returns general Branch details based on provided Branch NMLS ID.
| Field Name | Field Type | Description |
| Branch NMLS ID | (integer, optional) | Branch Location NMLS ID |
| City | (string, optional) | Branch City Location |
| Company NMLS ID | (integer, optional) | Headquarters NMLS ID of which the Branch Belongs |
| Country | (string, optional) | Branch Country Location |
| Is Authorized | (boolean, optional) | Is Authorized to Conduct Business. 'Yes Denotes the Branch Holds at Least One License that is Valid for Conducting Business, 'No' Denotes that the Branch does NOT hold any Licenses that are Valid for Conducting Business |
| Name | (string, optional) | Legal Name of Branch |
| Postal Code | (string, optional) | Branch Zip Code Location |
| State | (string, optional) | Branch State Location |
| Street | (string, optional) | Line 1 of the Branch Street Address |
| Street 2 | (string, optional) | Line 2 of the Branch Street Address |
Branch Licenses
API returns all branch licenses (or a specific branch license) based on provided Branch NMLS ID.
| Field Name | Field Type | Description |
| Is Authorized | (boolean, optional) | Is Authorized to Conduct Business; 'Yes' or 'No' Designation of whether the License Authorizes the Branch to do Business |
| Issue Date | (string, optional) | Date on which License was First Approved |
| License ID | (integer, optional) | Unique Identifier for the License by NMLS |
| License Number | (string, optional) | License Number Assigned by the Regulator |
| License Type | (string, optional) | The Name of the License, Type of License |
| NMLS ID | (integer, optional) | Branch NMLS ID of License Holder |
| Regulator | (string, optional) | Name of Regulating State or Territory that Issued the License |
| Renewed Through | (string, optional) | Renewed Through |
| Status | (string, optional) | Current Status of the License |
| Status Date | (string, optional) | Effective Date of the Current Status of the License |
Branch Trade Names
API returns branch trade names for state licenses based on Branch NMLS ID.
| Field Name | Field Type | Description |
| Name Type | (string, optional) | Name Type (O/PO/PL); Other Trade Names, Prior Legal Names, Prior Other Trade Names, Prior Legal Names (Federal Institutions Only) |
| NMLS ID | (integer, optional) | Branch Location NMLS ID |
| Other Trade Name | (string, optional) | Other Trade Name; Prior Legal Name, Other trade name or Prior Other Trade Name used by the Branch in the Specified Jurisdiction. (Note that Prior Legal Names are not Jurisdiction Specific.) For Federal Institutions, Only Prior Legal Names are included, and are not Jurisdiction Specific. |
| Regulator | (string, optional) | The Regulating State or Territory in which the Other Trade Name is used. |
Company
API returns general Company details based on provided Company NMLS ID.
| Field Name | Field Type | Description |
| Business Structure | (string, optional) | The Organizational Type of the Company (Corporation, Sole Proprietorship, etc.). The Field will be NULL for Federally Registered Institutions that have not held a State License |
| City | (string, optional) | Headquarter City Location |
| Company NMLS ID | (integer, optional) | Headquarter NMLS ID of the Company |
| Country | (string, optional) | Headquarter Country Location |
| Date Formed | (string, optional) | Date Company was legally Organized |
| Fiscal Year End | (string, optional) | MM/DD of Fiscal Year End; referring to the Completion of a One-Year or 12 Month Accounting Period |
| Formed In | (string, optional) | Formed In |
| Name | (string, optional) | Legal Name of Company |
| Postal Code | (string, optional) | Headquarter Zip Code Location |
| Primary Federal Regulator | (string, optional) | Name of Primary Federal Agency which Regulates the Company |
| Registration Status | (string, optional) | Status of the company’s federal registration (Active or Inactive). |
| State | (string, optional) | Headquarter State Location |
| Stock Symbol | (string, optional) | Stock Ticker Symbol for publicly traded company. Usually Letters Representing Particular Securities Listed or Traded Publicly. When a Company Issues Securities to the Public Marketplace, it selects a Ticket Symbol for its Shares. Investors and Traders use the Ticker Symbol to Place Trade Orders |
| Street | (string, optional) | Line 1 of the Headquarter Street Address |
| Street 2 | (string, optional) | Line 2 of the Headquarter Street Address |
Company Licenses
API returns all company licenses (or a specific company license) based on provided Company NMLS ID.
| Field Name | Field Type | Description |
| Is Authorized | (boolean, optional) | Is Authorized to Conduct Business; 'Yes' or 'No' Designation of whether the License Authorizes the Company to do Business |
| Issue Date | (string, optional) | Date on which License was First Approved |
| License ID | (integer, optional) | Unique Identifier for the License by NMLS |
| License Number | (string, optional) | License Number Assigned by the Regulator |
| License Type | (string, optional) | The Name of the License, Type of License |
| NMLS ID | (integer, optional) | Company NMLS ID of License Holder |
| Regulator | (string, optional) | Name of Regulating State or Territory that Issued the License |
| Renewed Through | (string, optional) | Renewed Through Year (YYYY); Upon Completion of Renewal this Field will be Updated to Show that the License has been Renewed for the Next Period. Shows 'None' for non-approved Licenses |
| Status | (string, optional) | Current Status of the License |
| Status Date | (string, optional) | Effective Date of the Current Status of the License |
Company Trade Names
API returns company trade names for state licenses based on Company NMLS ID.
| Field Name | Field Type | Description |
| Name Type | (string, optional) | Name Type (O/PO/PL); Other Trade Names, Prior Legal Names, Prior Other Trade Names, Prior Legal Names (Federal Institutions Only) |
| NMLS ID | (integer, optional) | NMLS ID of the Company |
| Other Trade Name | (string, optional) | Prior Legal Name, Other trade name or Prior Other Trade Name used by the Company in the Specified Jurisdiction. (Note that Prior Legal Names are not Jurisdiction Specific.) For Federal Institutions, only Prior Legal Names are included, and are not Jurisdiction Specific. |
| Regulator | (string, optional) | The regulating state or territory in which the other trade name is used |
Individual
API returns general Individual details based on provided Individual NMLS ID.
| Field Name | Field Type | Description |
| First Name | (string, optional) | First Name of the Individual |
| Individual NMLS ID | (integer, optional) | NMLS ID of the Individual |
| Last Name | (string, optional) | Last Name of the Individual |
| Middle Name | (string, optional) | Middle Name of the Individual |
| Suffix | (string, optional) | Suffix of the Individual |
Individual Licenses
API returns all individual licenses (or a specific individual license) based on provided Individual NMLS ID.
| Field Name | Field Type | Description |
| Is Authorized | (boolean, optional) | Is Authorized to Conduct Business; 'Yes' or 'No' Designation of whether the License Authorizes the Individual to do Business |
| Issue Date | (string, optional) | Date on which License was First Approved |
| License ID | (integer, optional) | Unique Identifier for the License from NMLS |
| License Number | (string, optional) | License Number Assigned by the Regulator |
| License Type | (string, optional) | The Name of the License; Type of License |
| NMLS ID | (integer, optional) | NMLS ID of the Individual |
| Regulator | (string, optional) | Regulating State or Territory that Issued the License |
| Renewed Through | (string, optional) | Renewed Through Year (YYYY); Upon Completion of Renewal this Field will be Updated to Show that the License has been Renewed for the Next Period. Shows 'None' for non-approved Licenses |
| Status | (string, optional) | Current Status of the License |
| Status Date | (string, optional) | Effective Date of the Current Status of the License |
Individual Locations
API returns location details of the Individual based on Individual NMLS ID.
| Field Name | Field Type | Description |
| City | (string, optional) | City of the Location’s Street Address |
| Company Name | (string, optional) | The Legal Name of the Company to which the Location belongs |
| Country | (string, optional) | Country of the Location’s Street Address |
| Individual NMLS ID | (integer, optional) | NMLS ID of the Individual |
| Location NMLS ID | (integer, optional) | Company or Branch NMLS ID of the Location |
| Location Type | (string, optional) | Location Type; Branch = Branch, Work = Employing (Federally Regulated Institution), Main = Company Headquarters |
| Postal Code | (string, optional) | Zip Code of Location’s Street Address |
| Start Date | (string, optional) | The date on which the Individual First Worked out of the Location |
| State | (string, optional) | State of the Location’s Street Address |
| Street | (string, optional) | Line 1 and line two of the Location’s Street Address |
Individual Other Names
API returns all other names of the individual based on Individual NMLS ID.
| Field Name | Field Type | Description |
| First Name | (string, optional) | First Name of the Individual |
| Individual NMLS ID | (integer, optional) | NMLS ID of the Individual |
| Last Name | (string, optional) | Last Name of the Individual |
| Middle Name | (string, optional) | Middle Name of the Individual |
| Suffix | (string, optional) | Suffix of the Individual |
| Name Type | (string, optional) | Other Name Categories; Other Names, Prior Other Names, or Prior Legal Names |
Individual Registration
API returns a record if Individual has active federal registration based on Individual NMLS ID.
| Field Name | Field Type | Description |
| Individual NMLS ID | (integer, optional) | NMLS ID of the Individual |
| Is Authorized To Conduct Business | (boolean, optional) | “Yes” or “No” designation of whether the federal registration authorizes the individual to conduct business. |
| Registration Name | (string, optional) | Federal Mortgage Loan Originator - Registration |
| Status | (string, optional) | Status of the Individual’s Federal Registration |
Individual Registration Details
API returns a list of companies that an individual is currently authorized to represent.
| Field Name | Field Type | Description |
| Employer Name | (string, optional) | The name of the Federally Regulated Company as entered by the Individual in their Employment History on the NMLS MU4R Form |
| Individual NMLS ID | (integer, optional) | NMLS ID of the Individual |
| Institution Name | (string, optional) | The Legal Name of the Federally Regulated Company |
| Institution NMLS ID | (integer, optional) | The NMLS ID of the Federally Regulated Company |
| Primary Federal Regulator | (string, optional) | Federal Agency which Regulates the Company |
| Start Date | (string, optional) | The Date that the Individual was First Authorized to Represent this Company |
Individual Sponsorship
API returns a list of state-regulated companies that an individual is authorized to represent.
| Field Name | Field Type | Description |
| Company Name | (string, optional) | Legal Name of the Company Sponsoring the License |
| Company NMLS ID | (integer, optional) | NMLS ID of the Company Sponsoring the License |
| Individual NMLS ID | (integer, optional) | NMLS ID of the Individual |
| License ID | (integer, optional) | Unique Identifier of the License |
| License Type | (string, optional) | The Name of the License; Type of License |
| Regulator | (string, optional) | Regulating state or Territory that issued the License being Sponsored. |
| Start Date | (string, optional) | The Date on which the Individual was first Authorized to Represent the Company. |