POST v1/api/ClientInquiry?caseId={caseId}
Retrieve Client Information getting all policies and client data
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| caseId |
(optional - but recommended) a unique identifier to both group calls, and to tie a Case to an Agency. |
string |
None. |
Body Parameters
ClientInquiryRequestDto
ClientInquiryRequestDto| Name | Description | Type | Additional information |
|---|---|---|---|
| PolicyId | string |
None. |
|
| ClientId | string |
None. |
|
| GovtId | string |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| MiddleName | string |
None. |
|
| BirthDate | string |
None. |
|
| string |
None. |
||
| OnlineLimitation | boolean |
None. |
|
| SiCheck | boolean |
None. |
|
| HomePhoneNumber | string |
None. |
|
| CellPhoneNumber | string |
None. |
|
| BusinessPhoneNumber | string |
None. |
|
| Name | string |
None. |
|
| Address1 | string |
None. |
|
| Address2 | string |
None. |
|
| Address3 | string |
None. |
|
| City | string |
None. |
|
| State | StateCodeEnum |
None. |
|
| PostalCode | string |
None. |
|
| Country | CountryCodeEnum |
None. |
Request Formats
application/json
Sample:
REQUEST
{
"FirstName" : "LEA ANN",
"LastName" : "WILLOCKS",
"City": "Chelmsford",
"Address1" : "*Galloway Rd*",
"State" : "MA"
}
Response Information
Resource Description
ClientInquiryResponseDto
ClientInquiryResponseDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Clients | Collection of ClientInquiryDataDto |
None. |
Response Formats
application/json
Sample:
RESPONSE
{
"Clients": [
{
"policyResponse": null,
"PolicyId": "044012272",
"ClientId": "M000038964",
"GovtId": "XXX-XX-1740",
"ClientIsOwner": true,
"PolicyStatus": "Lapsed",
"CompanyCode": "S1",
"BestMethodOfContact": null,
"BirthCountry": null,
"Email": "EYTKZOZZQ@EHDEQLZ.FTZ",
"AddressType": "HomeAddress",
"State": "Massachusetts",
"Country": "United States of America",
"FirstName": "LEA ANN",
"LastName": "WILLOCKS",
"MiddleName": "L",
"MaritalStatus": "MARRIED",
"BirthDate": "1961-02-14",
"Smoker": "Never",
"Gender": "Female",
"WorkPhone": "",
"CellPhone": "",
"HomePhone": "132-850-1398",
"Address1": "30 Galloway Rd,",
"Address2": "",
"Address3": "",
"City": "Chelmsford",
"PostalCode": "01824"
},
{
"policyResponse": {
"Coverage": [
],
"Plan": [
{
"CovProductCode": "NT2095",
"CovDescription": "T20 Effective 04-01-12",
"CovInsuranceType": "Term Life",
"CurrentAmount": 250000.0,
"MinimumAmount": 100000.0,
"MaximumAmount": 50000000.0
},
{
"CovProductCode": "T20 95",
"CovDescription": "",
"CovInsuranceType": "Term Life",
"CurrentAmount": 300000.0,
"MinimumAmount": 100000.0,
"MaximumAmount": 50000000.0
}
]
},
"PolicyId": "299567581",
"ClientId": "M000038964",
"GovtId": "XXX-XX-1740",
"ClientIsOwner": true,
"PolicyStatus": "Active",
"CompanyCode": "S1",
"BestMethodOfContact": null,
"BirthCountry": null,
"Email": "EYTKZOZZQ@EHDEQLZ.FTZ",
"AddressType": "HomeAddress",
"State": "Massachusetts",
"Country": "United States of America",
"FirstName": "LEA ANN",
"LastName": "WILLOCKS",
"MiddleName": "L",
"MaritalStatus": "MARRIED",
"BirthDate": "1961-02-14",
"Smoker": "Never",
"Gender": "Female",
"WorkPhone": "",
"CellPhone": "",
"HomePhone": "132-850-1398",
"Address1": "30 Galloway Rd,",
"Address2": "",
"Address3": "",
"City": "Chelmsford",
"PostalCode": "01824"
},
{
"policyResponse": {
"Coverage": [
],
"Plan": [
{
"CovProductCode": "NT2095",
"CovDescription": "T20 Effective 04-01-12",
"CovInsuranceType": "Term Life",
"CurrentAmount": 250000.0,
"MinimumAmount": 100000.0,
"MaximumAmount": 50000000.0
},
{
"CovProductCode": "T20 95",
"CovDescription": "",
"CovInsuranceType": "Term Life",
"CurrentAmount": 300000.0,
"MinimumAmount": 100000.0,
"MaximumAmount": 50000000.0
}
]
},
"PolicyId": "308635602",
"ClientId": "M000038964",
"GovtId": "XXX-XX-1740",
"ClientIsOwner": true,
"PolicyStatus": "Active",
"CompanyCode": "S1",
"BestMethodOfContact": null,
"BirthCountry": null,
"Email": "EYTKZOZZQ@EHDEQLZ.FTZ",
"AddressType": "HomeAddress",
"State": "Massachusetts",
"Country": "United States of America",
"FirstName": "LEA ANN",
"LastName": "WILLOCKS",
"MiddleName": "L",
"MaritalStatus": "MARRIED",
"BirthDate": "1961-02-14",
"Smoker": "Never",
"Gender": "Female",
"WorkPhone": "",
"CellPhone": "",
"HomePhone": "132-850-1398",
"Address1": "30 Galloway Rd,",
"Address2": "",
"Address3": "",
"City": "Chelmsford",
"PostalCode": "01824"
}
]
}