This API Service allows Customers utilizing the Comergence third party origination platform, to retrieve required data related to contacts for accounts they have an active relationship with.
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) |
Contacts
This API Service allows Customers utilizing the Comergence third party origination platform, to retrieve required data related to contacts for accounts they have an active relationship with. If Investor Marketing Service is enabled for the account Investor Marketing Contact types will also be returned in the API data. Relationship status can NOT be Terminated, Declined, or Canceled.
| Field Name | Field Type | Description |
| City | (string, optional) | City Location of Contact |
| Contact ID | (integer, optional) | Contact Unique ID |
| Contact Type | (string, optional) | Used to Sort Contacts by Groups |
| Designation Name | (string, optional) | Designation Name of Contact |
| (string, optional) | Email Address of Contact | |
| First Name | (string, optional) | First Name of Contact |
| Full Name | (string, optional) | Concatenated First Name And Last Name of Contact |
| Individual NMLS ID | (integer, optional) | Individual Originator NMLS ID of Contact |
| Is Primary Contact | (boolean, optional) | Is Primary/Notifications Contact (True/False) |
| Last Name | (string, optional) | Last Name of Contact |
| Officer Designation | (string, optional) | Designation Name of Contact |
| Phone | (string, optional) | Phone Number of Contact |
| State | (string, optional) | State Location of Contact |
| Zip | (string, optional) | Zip Code Location of Contact |
| Related Account | (optional) | Headquarter Account Details |
| Name | (string, optional) | Legal Name of Company/Location |
| NMLS ID | (integer, optional) | NMLS ID of the Company/Location |
| Custom Field Values | (optional) | Customer Custom Field. Allows Users to Enter Additional Information Related to Contact |
| 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) |