This API (Application Program Interface) Service allows Customers utilizing the Comergence third party origination platform, to retrieve required data related to current counterparties.
Visit Optimal Blue's Digital Marketplace by clicking HERE to register and access all API documentation. For more information please contact Optimal Blue Sales.
| 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) |
Companies
API returns ALL counterparty company and relationship information.
| Field Name | Field Type | Description |
| Address 1 | (string, optional) | Line 1 of the Headquarter Street Address |
| Address 2 | (string, optional) | Line 2 of the Headquarter Street Address |
| 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. |
| Business Tax ID | (string, optional) | A Business Tax ID; Also Referred to as an Employer Identification Number (EIN), is a Unique Nine-Digit Number used to Identify the Tax Account of a Business Entity. |
| City | (string, optional) | Headquarter City Location |
| Client SID | (string, optional) | System Generated Unique ID |
| Client UID | (string, optional) | Customer Entered Unique ID |
| Company Fax | (string, optional) | Company Fax Number |
| Company Name | (string, optional) | Legal Name of Company |
| Company NMLS ID | (integer, optional) | Headquarter NMLS ID of the Company |
| Company Phone | (string, optional) | Company Phone Number |
| Country | (string, optional) | Headquarter Country Location |
| Date Formed | (string, optional) | Date Company was legally Organized |
| FDIC/NCUA Certification Number | (string, optional) | A Unique Number assigned by the FDIC (Federal Deposit Insurance Corporation) or NCUA (National Credit Union Administration), used to Identify Institutions and for the issuance of Insurance Certificates |
| Fiscal Year End | (string, optional) | MM/DD of Fiscal Year End; referring to the Completion of a One-Year or 12 Month Accounting Period |
| Formation State | (string, optional) | State and Country in which the Corporation was Formed |
| MERS ID | (string, optional) | The Mortgage Identification Number (MIN) is a unique 18-Digit Number used to Track a Mortgage Loan throughout it's Life, from the Origination to Securitization to Payoff or Foreclosure. Created by the Mortgage Electronic Registration System (MERS) |
| 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. |
| Zip | (string, optional) | Headquarter Zip Code Location |
| DBA Name | (string, optional) | "Doing Business As" Name; Name under which Company Operates that Differs from it's Legal, Registered Name. |
| DBA Name Type | (string, optional) | "Doing Business As" Type (Prior Legal Name, Other Trade Name, etc.) |
| Regulator | (string, optional) | State or Federal Agency which Regulates the Company |
| Account Assignee First Name | (string, optional) | First Name of Account Assigned User |
| Account Assignee Last Name | (string, optional) | Last Name of Account Assigned User |
| Channel Name | (string, optional) | Customer Business Channel Name (Wholesale, Correspondent, etc.) |
| Channel SID | (string, optional) | System Generated Unique Channel ID |
| Channel UID | (string, optional) | Customer Entered Unique Channel ID |
| Next Renewal Date | (string, optional) | Current Renewal Date (Date Renewal Application will Launch if Auto Renewal is set 'ON') |
| Relationship Status | (string, optional) | Current Relationship Status, per Business Channel (Active, Inactive, Pending Renewal, etc.) |
| Status Change Date | (string, optional) | Effective Date of Current Relationship Status |
| Status Reason | (string, optional) | Customer Reason for Relationship Status Change/Update |
| Website | (string, optional) | The Website(s) of the State Regulated Company; Web Presence |
| Custom Field | (optional) | Customer Custom Field. Allows Users to Enter Additional Information Related to Company |
| Display Order | (integer) | Custom Field Display Order |
| Editable | (boolean) | Shows If Field Can Be Editable after Saving the First Time (True/False) |
| Field Description | (string, optional) | Custom Field Description. Used to Describe Additional Information Field |
| Field Name | (string) | Custom Field Field Name; Title |
| Help Text | (string, optional) | Custom Field Help Text, Hover-text to Assist Users in Understanding the Purpose of the Additional Information Field |
| ID | (integer) | Custom Field Unique ID |
| Required | (boolean) | Is Custom Field Required to be Filled prior to Saving (True/False) |
| Values List | (string, optional) | Custom Field Values |
| Visible | (boolean) | Flag To Indicate Visibility to Customer Users (True/False) |
Branches
API returns branches information of all companies in next relationship status with customer: Active, Inactive, Watchlist, Suspended, Renewal Suspended, Pending, Pending Renewal. Available filters: by Company NMLS ID (optional) to get branches of a specific company; by Branch NMLS ID (optional) to get a specific branch information; if filters are empty, result set will include all related branches.
| Field Name | Field Type | Description |
| Address 1 | (string, optional) | Line 1 of the Branch Street Address |
| Address 2 | (string, optional) | Line 2 of the Branch Street Address |
| Branch Name | (string, optional) | Legal Name of Branch |
| 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 |
| State | (string, optional) | Branch State Location |
| Zip | (string, optional) | Branch Zip Code Location |
| Account Executive First Name | (string, optional) | First Name of Account Assigned User at Branch Location |
| Account Executive Last Name | (string, optional) | Last Name of Account Assigned User at Branch Location |
| Approval Status | (string, optional) | Branch Location Current Relationship Status, per channel (Active, Inactive, Pending Renewal, etc.) |
| Approval Status Date | (string, optional) | Effective Date of Branch Location Current Relationship Status |
| Branch SID | (string, optional) | System Generated Unique Branch ID |
| Branch UID | (string, optional) | Customer Entered Unique Branch ID |
| Channel Name | (string, optional) | Customer Business Channel name (Wholesale, Correspondent, etc.) |
Company Licenses
API returns Companies Licenses information of all companies in next relationship status with customer: Active, Inactive, Watchlist, Suspended, Renewal Suspended, Pending, Pending Renewal. Available filters: by Company NMLS ID (optional) to get only Licenses of a specific Company; by License ID (optional) to get information about specific License; if filters are empty, result set will have all related company licenses.
| Field Name | Field Type | Description |
| Company NMLS ID | (integer, optional) | Headquarter NMLS ID of the Company |
| Is Authorized | (boolean, optional) | Is Authorized to Conduct Business; 'Yes' or 'No' Designation of whether the License Authorizes the Company or Branch to do Business |
| Issue Date | (string, optional) | Date on which License was First Approved |
| License Category | (string, optional) | License Category: Company (C) or Branch (B) |
| License Holder NMLS ID | (integer, optional) | Company or Location/Branch NMLS ID of License Holder, dependent on license category |
| License ID | (string, 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 |
| 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 |
Agencies
API returns Agency information of all companies in next relationship status with customer: Active, Inactive, Watchlist, Suspended, Renewal Suspended, Pending, Pending Renewal.
| Field Name | Field Type | Definition |
| Agency Name | (string, optional) | Name of Agency (VA, FHA, USDA, Freddie Mae, Etc.) |
| Approval Date | (integer, optional) | Effective Date of Agency Approval |
| End Date | (integer, optional | Effective Date Agency Relationship Ended |
| ID Number | (string, optional) | ID Number Issued by Agency |
| Is Applicable | (boolean, optional) | Input Flag from Client Account Agencies (False); To Indicate if Agency approval is Applicable of Not |
| Related Account | (optional) | Headquarter Account Details |
| Name | (string, optional) | Legal Name of Company |
| NMLS ID | (integer, optional) | Headquarter NMLS ID of the Company |
Documents
API returns all documents that were uploaded to customer by all clients that have any relationship to customer. Additionally, API also allows customer to Download a specific document uploaded by client to the customer by providing File ID.
| Field Name | Field Type | Description |
| Channels | (Array[string], optional) | Customer Business Channels Document is Assigned to as Required or Optional |
| Company NMLS ID | (integer, optional) | Headquarter NMLS ID of the Company |
| Description | (string, optional) | Customer Document Description; Allows Users to Describe the Document Requirement in Detail |
| ID | (integer, optional) | Document ID |
| Name | (string, optional) | Customer Document Name/ Title |
| Uploaded By | (string, optional) | User who Uploaded the Document |
| Uploaded Date | (string, optional) | Date User Uploaded the Document |
Financial Documents
API returns all financial documents that were uploaded by clients if there is active relationship or only those financial documents uploaded by a Client till relationship was terminated. The required filters for the request include financial document period and year. The request may additionally be filtered to retrieve financial documents for a specific Client, and/or uploaded date range.
| Field Name | Field Type | Description |
| Audited | (boolean, optional) | True/False |
| Company NMLS ID | (integer, optional) | Headquarter NMLS ID of the Company |
| Financial Document ID | (integer, optional) | Internal financial document ID |
| Period | (string, optional) | Period for quarter or annual |
| Reviewed By | (string, optional) | Reviewer user name |
| Reviewed Date | (string, optional) | Review date |
| Type | (Financial document type) | |
| Uploaded By | (string, optional) | Upload actioned by user name |
| Uploaded Date | (string, optional) | Upload date |
| Year | (integer, optional) | Period year |
Individual Licenses
API returns all Individuals Licenses related to all companies in next relationship status with customer: Active, Inactive, Watchlist, Suspended, Renewal Suspended, Pending, Pending Renewal. Available filters: by Company NMLS ID (optional) to get only Individuals Licenses related to a specific Company; by Individual NMLS ID (optional) to get licenses for a specific Individual; if filters are empty, result set will have all related individual’s licenses.
| Field Name | Field Type | Description |
| Company NMLS ID | (integer, optional) | Headquarter NMLS ID of the Company |
| Individual First Name | (string, optional) | First Name of the Licensed Individual |
| Individual Last Name | (string, optional) | Last Name of the Licensed Individual |
| Individual NMLS ID | (integer, optional) | NMLS ID of the Individual |
| 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 | (string, 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 |
| 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 Registrations
API returns Individuals with Federal Registration related to all companies in next relationship status with customer: Active, Inactive, Watchlist, Suspended, Renewal Suspended, Pending, Pending Renewal. Available filters: by Company NMLS ID (optional) to get only FR Individuals for a specific Company; by Individual NMLS ID (optional) to get information about specific Individual Registration; if filters are empty, result set will have all related individual registrations.
| Field Name | Field Type | Description |
| Company Name | (string, optional) | Legal Name of the Federally Regulated Company |
| Company NMLS ID | (integer, optional) | The NMLS ID of the Federally Regulated Company |
| 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 |
| End Date | (string, optional) | The date that the Individual was Last Authorized to Represent this Company. When the 'EndDate' is null the Record Contains a Company that the Individual is Currently Authorized to Represent. When the 'EndDate' is populated the Record contains a Company that the Individual was Previously authorized to Represent |
| Individual First Name | (string, optional) | First Name of Federally Registered Individual |
| Individual Last Name | (string, optional) | Last Name of Federally Registered Individual |
| Individual NMLS ID | (integer, optional) | NMLS ID of the Individual |
| 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 |
Owners
API returns owners information related to all companies in next relationship status with customer: Active, Inactive, Watchlist, Suspended, Renewal Suspended, Pending, Pending Renewal.
| Field Name | Field Type | Description |
| Company Owners | (optional) | Company/Companies holding 1% or more ownership |
| Address | (string, optional) | Street Address of Company Owner |
| Business Tax ID | (string, optional) | Company Owner Business Tax ID; Also Referred to as an Employer Identification Number (EIN), is a Unique Nine-Digit Number used to Identify the Tax Account of a Business Entity. |
| City | (string, optional) | City Location of Company Owner |
| Company Name | (string, optional) | Company Name Entered for Company Owner |
| Fax | (string, optional) | Fax Number of Company Owner |
| Ownership Percentage | (number, optional) | Current Ownership Percentage Held by Company Owner |
| Phone | (string, optional) | Phone Number of Company Owner |
| State | (string, optional) | State Location of Company Owner |
| Suite | (string, optional) | Suite Location of Company Owner |
| Zip | (string, optional) | Zip Code Location of Company Owner |
| Individual Owners | (optional) | Individual(s) holding 1% or more ownership |
| City | (string, optional) | City Location of Individual Owner |
| (string, optional) | Email Address of Individual Owner | |
| First Name | (string, optional) | First Name of Individual Owner |
| Full Name | (string, optional) | Concatenated First And Last Name of Individual Owner |
| Individual NMLS ID | (integer, optional) | Originator NMLS ID of Individual Owner |
| Is Primary Contact | (boolean, optional) | Is Primary/Notifications Contact (True/False) |
| Last Name | (string, optional) | Last Name of Individual Owner |
| Ownership Percentage | (number, optional) | Ownership Percentage of Individual Owner |
| Phone | (string, optional) | Phone Number of Individual Owner |
| State | (string, optional) | State Location of Individual Owner |
| Zip | (string, optional) | Zip Code Location of Individual Owner |
| Related Account | (optional) | Headquarter Account Details |
| Name | (string, optional) | Legal Name of Company |
| NMLS ID | (integer, optional) | Headquarter NMLS ID of the Company |