V1 Contracts

The Business Field Definition Attributes](#business-field-definition-attributes) are described below.

Business Contact Attributes

ATTRIBUTEDESCRIPTION
categoryId
int32
The business category ID for the business contact. Possible values are:
0 - Appraiser
1 - Attorney
2 - Credit Company
3 - Doc Signing
4 - Escrow Company
5 - Flood Insurance
6 - Hazard Insurance
7 - Lender
8 - Mortgage Insurance
9 - Real Estate Agent
10 - Servicing
11 - Title Insurance
12 - Underwriter
13 - Surveyor
14 - No Category
15 - Organization
16 - Verification
17 - Investor
18 - Warehouse Bank
19 - Builder
20 - Dealer
21 - TradeAssignee


categoryFields
object
categoryFields.fieldId
int32
categoryFields.fieldValue
string


companyName
string
The contact's company name.
fees
string
Rate or fee charged by the contact’s services.


personalContactLicense
object
Licensing information.
personalContactLicense.licenseAuthName
string
Name of the licensing authority.
personalContactLicense.licenseAuthType
string
Type of license.
personalContactLicense.licenseIssueDate
string
Date the license was issued.
personalContactLicense.licenseNumber
string
License number.
personalContactLicense.licenseStateCode
string
State the license was issued.


businessContactLicense
object
Business licensing information.
businessContactLicense.licenseAuthName
string
Name of the licensing authority.
businessContactLicense.licenseAuthType
string
Type of license.
businessContactLicense.licenseIssueDate
string
Date the license was issued.
businessContactLicense.licenseNumber
string
License number.
businessContactLicense.licenseStateCode
string
State the license was issued.


noSpam
boolean
firstName
string
Required. The contact's first name.

Note: Either firstName or lastName is required.
lastName
string
Required. The contact's last name.

Note: Either firstName or lastName is required.
ownerId
string
accessLevel
integer
Possible values are: 0 – Private, 1- Public.


currentMailingAddress
object
The contact's home address.
currentMailingAddress.street1
string
Line 1 of the contact's home address.
currentMailingAddress.street2
string
Line 2 of the contact's home address.
currentMailingAddress.city
string
The state in which the contact's home is located.
currentMailingAddress.state
string
The state in which the contact's home is located.
currentMailingAddress.zip
string
The zip code in which the contact's home is located.


businessWebURL
string
Website address for the business.
jobTitle
string
The contact's job title.
workPhone
string
The contact's work phone number.
homePhone
string
The contact's home phone number.
mobilePhone
string
The contact's cell phone number.
faxNumber
string
The contact's fax number.
personalEmail
string
The contact's personal email address.
businessEmail
string
Required. The contact's work email address.
salutation
string
Ms., Miss, Mrs., Mr., Dr., etc.
id
string
The contactId (or id) is the unique identifier of the contact. It is returned in the response header when the contact is created.
groupIDs
Array of integers
The unique identifier of each contact group to which the contact belongs.

Business Field Definition Attributes

ATTRIBUTEDESCRIPTION
filterOnly
boolean
When set to true, the corresponding canonical field is used only for filtering contacts.

When set to false, the corresponding canonical field is used for selection, sorting and filtering contacts.
category
string
Category of a field. For example, Borrower Contact, Opportunity, Recent Events, Appointments, Loan, Trade, Milestone, Loan Folder, Pipeline, etc.
description
string
A detailed explanation of what each field represents.
canonicalName
string
The canonical name of the field.
dataType
string
Type of a field. For example, Integer, String, YN(checkbox), Datetime, etc.
dataSource
string
Source of the field. Possible values are Loan and BorrowerContact.
maxLength
int32
The maximum length of the data. If the field dataType is string, then maxLength represents the maximum number of characters accepted as input.
options
array of strings
Array of strings representing possible options for field values.

Business Contact Query Attributes

ATTRIBUTEDESCRIPTION
fields
array of strings
List of business contact fields to query.
Provide the canonical field names for the contact.
loanMatchType
string
Type of loans to query. Possible values are:
None
AnyClosed
LastClosed
AnyOriginated
* LastOriginated