POST api/Insured/InsuredContacts
Insured contacts list endpoint.
Request Information
URI Parameters
None.
Body Parameters
List of insured database Ids.
InsuredDataBaseIds| Name | Description | Type | Additional information |
|---|---|---|---|
| InsuredDataBaseId | Collection of globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{
"insuredDataBaseId": [
"e1485cbb-5330-4518-b45a-fd47366df353",
"3dd2e874-fc4c-41af-85ec-f64b197932af"
]
}
application/xml, text/xml
Sample:
<InsuredDataBaseIds xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.OData">
<InsuredDataBaseId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>e1485cbb-5330-4518-b45a-fd47366df353</d2p1:guid>
<d2p1:guid>3dd2e874-fc4c-41af-85ec-f64b197932af</d2p1:guid>
</InsuredDataBaseId>
</InsuredDataBaseIds>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
List of InsuredContacts against given insured database Ids.
InsuredContacts| Name | Description | Type | Additional information |
|---|---|---|---|
| DatabaseId | globally unique identifier |
None. |
|
| PrimaryContact | boolean |
None. |
|
| FirstName | string |
None. |
|
| MiddleName | string |
None. |
|
| LastName | string |
None. |
|
| Type | ContactType |
None. |
|
| HomePhone | string |
None. |
|
| OfficePhone | string |
None. |
|
| CellPhone | string |
None. |
|
| PersonalFax | string |
None. |
|
| BusinessFax | string |
None. |
|
| PersonalEMail | string |
None. |
|
| BusinessEMail | string |
None. |
|
| Prefix | Prefix |
None. |
|
| Suffix | Suffix |
None. |
|
| Gender | GenderCode |
None. |
|
| MaritalStatus | MaritalStatusCode |
None. |
|
| SocialSecurityNumber | string |
None. |
|
| Education | Education |
None. |
|
| Birthday | date |
None. |
|
| Note | string |
None. |
|
| IsDriver | boolean |
None. |
|
| DLNumber | string |
None. |
|
| DLYear | integer |
None. |
|
| DLStateName | string |
None. |
|
| Description | string |
None. |
|
| IsHealthPlanMember | boolean |
None. |
|
| IndustryName | string |
None. |
|
| ChangeDate | date |
None. |
|
| InsuredDatabaseId | globally unique identifier |
None. |
|
| Active | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"databaseId": "4e45a324-531b-4ce2-8608-52caf0c83735",
"primaryContact": true,
"firstName": "sample string 3",
"middleName": "sample string 4",
"lastName": "sample string 5",
"type": 0,
"homePhone": "sample string 6",
"officePhone": "sample string 7",
"cellPhone": "sample string 8",
"personalFax": "sample string 9",
"businessFax": "sample string 10",
"personalEMail": "sample string 11",
"businessEMail": "sample string 12",
"prefix": 0,
"suffix": 0,
"gender": 0,
"maritalStatus": 0,
"socialSecurityNumber": "sample string 13",
"education": 0,
"birthday": "2025-11-15T04:41:46.001998-06:00",
"note": "sample string 14",
"isDriver": true,
"dlNumber": "sample string 16",
"dlYear": 1,
"dlStateName": "sample string 17",
"description": "sample string 18",
"isHealthPlanMember": true,
"industryName": "sample string 20",
"changeDate": "2025-11-15T04:41:46.001998-06:00",
"insuredDatabaseId": "fe47377d-dfb2-49fb-a0ad-e352020a43d8",
"active": true
}
application/xml, text/xml
Sample:
<InsuredContacts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum"> <Active>true</Active> <Birthday>2025-11-15T04:41:46.001998-06:00</Birthday> <BusinessEMail>sample string 12</BusinessEMail> <BusinessFax>sample string 10</BusinessFax> <CellPhone>sample string 8</CellPhone> <ChangeDate>2025-11-15T04:41:46.001998-06:00</ChangeDate> <DLNumber>sample string 16</DLNumber> <DLStateName>sample string 17</DLStateName> <DLYear>1</DLYear> <DatabaseId>4e45a324-531b-4ce2-8608-52caf0c83735</DatabaseId> <Description>sample string 18</Description> <Education>No_High_School_Diploma</Education> <FirstName>sample string 3</FirstName> <Gender>M</Gender> <HomePhone>sample string 6</HomePhone> <IndustryName>sample string 20</IndustryName> <InsuredDatabaseId>fe47377d-dfb2-49fb-a0ad-e352020a43d8</InsuredDatabaseId> <IsDriver>true</IsDriver> <IsHealthPlanMember>true</IsHealthPlanMember> <LastName>sample string 5</LastName> <MaritalStatus>S</MaritalStatus> <MiddleName>sample string 4</MiddleName> <Note>sample string 14</Note> <OfficePhone>sample string 7</OfficePhone> <PersonalEMail>sample string 11</PersonalEMail> <PersonalFax>sample string 9</PersonalFax> <Prefix>MR</Prefix> <PrimaryContact>true</PrimaryContact> <SocialSecurityNumber>sample string 13</SocialSecurityNumber> <Suffix>JR</Suffix> <Type>Owner</Type> </InsuredContacts>