Contact group information is represented in the contactGroup object.
Contact Group Attributes
| ATTRIBUTE | DESCRIPTION |
|---|---|
| id string | The unique identifier of the group. This is unique within each group type of contact groups. |
| contactType string | Possible values are Borrower and Business. |
| groupType string | Possible values are Public and Private, and are applicable only for Business contact groups. |
| name string | The name of the group. |
| description string | Detailed explanation of a group. |
| createdDate string | System-generated date and time when the group was created. |
Entity Ref Attributes for Contact Group
| ATTRIBUTE | DESCRIPTION |
|---|---|
| entityId string | References the entity ID of the contact. This is the unique identifier that is associated to the business/ borrower contact. |
| entityType string | Indicates the type of contact. Possible values are Business and Borrower. |
| entityName string | The full name of the contact. |
| entityUri string | The location of the contact in encompass. Example: /v1/borrowerContacts/78135c8c-0dfa-496f-9b7a-ab0fa8ef229f |
© ICE Mortgage Technology, Inc. All rights reserved.