GET api/SyncEncompassDetails?entityId={entityId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| entityId | string |
Required |
Body Parameters
None.
Response Information
Resource Description
BranchRoot| Name | Description | Type | Additional information |
|---|---|---|---|
| basicInfo | BasicInfomation |
None. |
Response Formats
application/json, text/json
Sample:
{
"basicInfo": {
"Id": 1,
"OrganizationName": "sample string 2",
"IsLoginDisabled": true,
"IsMfaEnabled": true,
"BrokerSelection": "sample string 5",
"NumberOfChildOrganizations": 6,
"ChildOrganizations": [
{
"EntityId": "sample string 1",
"EntityName": "sample string 2",
"EntityType": "sample string 3"
},
{
"EntityId": "sample string 1",
"EntityName": "sample string 2",
"EntityType": "sample string 3"
}
],
"parentOrg": {
"entityId": "sample string 1",
"entityName": "sample string 2",
"entityType": "sample string 3"
},
"NumberOfUsers": 7,
"HierarchyPath": "sample string 8",
"UseParentInfoForCompanyDetails": true,
"OrganizationType": "sample string 10",
"ChannelTypes": [
"sample string 1",
"sample string 2"
],
"NoAfterHourWires": true,
"CanAcceptFirstPayments": true,
"TpoId": "sample string 13",
"OrgId": "sample string 14",
"CompanyOwnerName": "sample string 15",
"CompanyLegalName": "sample string 16",
"Address": {
"street1": "sample string 1",
"street2": "sample string 2",
"city": "sample string 3",
"state": "sample string 4",
"zip": "sample string 5"
},
"BillingAddress": {
"SameAsMainAddress": true
},
"PhoneNumber": "sample string 17",
"FaxNumber": "sample string 18",
"Email": "sample string 19",
"Website": "sample string 20",
"LastLoanSubmittedDate": "2026-11-01T14:03:06.8420679-05:00",
"RateLockInfo": {
"UseParentInfoForRateLock": true,
"RateSheetEmail": "sample string 2",
"RateSheetFax": "sample string 3",
"LockInfoEmail": "sample string 4",
"LockInfoFax": "sample string 5"
},
"ProductAndPricing": {
"UseParentInfoForEpps": true,
"PriceGroups": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"EppsUserName": "sample string 2",
"EppsCompModel": "sample string 3"
},
"ApprovalStatus": {
"UseParentInfoApprovalStatus": true,
"CurrentStatus": "sample string 2",
"AddToWatchlist": true,
"CurrentStatusDate": "2026-11-01T14:03:06.8420679-05:00",
"ApprovedDate": "2026-11-01T14:03:06.8420679-05:00",
"ApplicationDate": "2026-11-01T14:03:06.8420679-05:00"
},
"BusinessInformation": {
"UseParentInfoForBusinessInfo": true,
"IsIncorporated": true,
"StateOfIncorporation": "sample string 3",
"DateOfIncorporation": "2026-11-01T14:03:06.8420679-05:00",
"YearsInBusiness": "sample string 5",
"TypeOfEntity": "sample string 6",
"TaxId": "sample string 7",
"UseSsnFormat": true,
"Lei": "sample string 9",
"NmlsId": "sample string 10",
"FinancialsPeriod": "sample string 11",
"EoCompany": "sample string 12",
"EoPolicyNumber": "sample string 13",
"MersOriginatingOrgId": "sample string 14",
"IsLpaSponsored": true
},
"PrimarySalesRepAe": {
"UserId": "sample string 1",
"Name": "sample string 2",
"Persona": [
"sample string 1",
"sample string 2"
],
"Phone": "sample string 3",
"Email": "sample string 4",
"AssignedDate": "2026-11-01T14:03:06.8420679-05:00"
}
}
}
application/xml, text/xml
Sample:
<BranchRoot xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NWP.API.Encompass.Controllers">
<basicInfo>
<Address>
<city>sample string 3</city>
<state>sample string 4</state>
<street1>sample string 1</street1>
<street2>sample string 2</street2>
<zip>sample string 5</zip>
</Address>
<ApprovalStatus>
<AddToWatchlist>true</AddToWatchlist>
<ApplicationDate>2026-11-01T14:03:06.8420679-05:00</ApplicationDate>
<ApprovedDate>2026-11-01T14:03:06.8420679-05:00</ApprovedDate>
<CurrentStatus>sample string 2</CurrentStatus>
<CurrentStatusDate>2026-11-01T14:03:06.8420679-05:00</CurrentStatusDate>
<UseParentInfoApprovalStatus>true</UseParentInfoApprovalStatus>
</ApprovalStatus>
<BillingAddress>
<SameAsMainAddress>true</SameAsMainAddress>
</BillingAddress>
<BrokerSelection>sample string 5</BrokerSelection>
<BusinessInformation>
<DateOfIncorporation>2026-11-01T14:03:06.8420679-05:00</DateOfIncorporation>
<EoCompany>sample string 12</EoCompany>
<EoPolicyNumber>sample string 13</EoPolicyNumber>
<FinancialsPeriod>sample string 11</FinancialsPeriod>
<IsIncorporated>true</IsIncorporated>
<IsLpaSponsored>true</IsLpaSponsored>
<Lei>sample string 9</Lei>
<MersOriginatingOrgId>sample string 14</MersOriginatingOrgId>
<NmlsId>sample string 10</NmlsId>
<StateOfIncorporation>sample string 3</StateOfIncorporation>
<TaxId>sample string 7</TaxId>
<TypeOfEntity>sample string 6</TypeOfEntity>
<UseParentInfoForBusinessInfo>true</UseParentInfoForBusinessInfo>
<UseSsnFormat>true</UseSsnFormat>
<YearsInBusiness>sample string 5</YearsInBusiness>
</BusinessInformation>
<CanAcceptFirstPayments>true</CanAcceptFirstPayments>
<ChannelTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</ChannelTypes>
<ChildOrganizations>
<ChildORG>
<EntityId>sample string 1</EntityId>
<EntityName>sample string 2</EntityName>
<EntityType>sample string 3</EntityType>
</ChildORG>
<ChildORG>
<EntityId>sample string 1</EntityId>
<EntityName>sample string 2</EntityName>
<EntityType>sample string 3</EntityType>
</ChildORG>
</ChildOrganizations>
<CompanyLegalName>sample string 16</CompanyLegalName>
<CompanyOwnerName>sample string 15</CompanyOwnerName>
<Email>sample string 19</Email>
<FaxNumber>sample string 18</FaxNumber>
<HierarchyPath>sample string 8</HierarchyPath>
<Id>1</Id>
<IsLoginDisabled>true</IsLoginDisabled>
<IsMfaEnabled>true</IsMfaEnabled>
<LastLoanSubmittedDate>2026-11-01T14:03:06.8420679-05:00</LastLoanSubmittedDate>
<NoAfterHourWires>true</NoAfterHourWires>
<NumberOfChildOrganizations>6</NumberOfChildOrganizations>
<NumberOfUsers>7</NumberOfUsers>
<OrgId>sample string 14</OrgId>
<OrganizationName>sample string 2</OrganizationName>
<OrganizationType>sample string 10</OrganizationType>
<PhoneNumber>sample string 17</PhoneNumber>
<PrimarySalesRepAe>
<AssignedDate>2026-11-01T14:03:06.8420679-05:00</AssignedDate>
<Email>sample string 4</Email>
<Name>sample string 2</Name>
<Persona xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</Persona>
<Phone>sample string 3</Phone>
<UserId>sample string 1</UserId>
</PrimarySalesRepAe>
<ProductAndPricing>
<EppsCompModel>sample string 3</EppsCompModel>
<EppsUserName>sample string 2</EppsUserName>
<PriceGroups xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>sample string 1</d4p1:Key>
<d4p1:Value>sample string 2</d4p1:Value>
</d4p1:KeyValueOfstringstring>
<d4p1:KeyValueOfstringstring>
<d4p1:Key>sample string 3</d4p1:Key>
<d4p1:Value>sample string 4</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</PriceGroups>
<UseParentInfoForEpps>true</UseParentInfoForEpps>
</ProductAndPricing>
<RateLockInfo>
<LockInfoEmail>sample string 4</LockInfoEmail>
<LockInfoFax>sample string 5</LockInfoFax>
<RateSheetEmail>sample string 2</RateSheetEmail>
<RateSheetFax>sample string 3</RateSheetFax>
<UseParentInfoForRateLock>true</UseParentInfoForRateLock>
</RateLockInfo>
<TpoId>sample string 13</TpoId>
<UseParentInfoForCompanyDetails>true</UseParentInfoForCompanyDetails>
<Website>sample string 20</Website>
<parentOrg>
<entityId>sample string 1</entityId>
<entityName>sample string 2</entityName>
<entityType>sample string 3</entityType>
</parentOrg>
</basicInfo>
</BranchRoot>