POST v1/api/FindPolicies
Retrieve a Policy Information for Government Id and Birth Date
Request Information
URI Parameters
None.
Body Parameters
PolicyRequestDto
PolicyRequestDtoName | Description | Type | Additional information |
---|---|---|---|
GovtId | string |
Required |
|
BirthDate | date |
Required |
|
OnlineLimitation | boolean |
None. |
|
IssueType | string |
None. |
|
IssueState | StateCodeEnum |
None. |
|
PolicyStatus | string |
None. |
|
SiCheck | boolean |
None. |
|
ReturnPolicyCoverage | boolean |
None. |
|
Coverage | Collection of CoverageDto |
None. |
Request Formats
application/json
Sample:
REQUEST { "GovtId": "123450637", "BirthDate": "1971-11-14" }
application/xml
Sample:
REQUEST <PolicyRequestDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <BirthDate>1971-11-14</BirthDate> <GovtId>123450637</GovtId> </PolicyRequestDto>
Response Information
Resource Description
List of PolicyResponseDto
PolicyResponseDtoName | Description | Type | Additional information |
---|---|---|---|
Coverage | Collection of CoverageDto |
None. |
|
Plan | Collection of PlanDto |
None. |
|
AppliedBefore | boolean |
None. |
|
PolicyCoverage | Collection of PolicyCoverageDto |
None. |
|
ClientId | string |
None. |
Response Formats
application/json
Sample:
RESPONSE { "Coverage":[], "Plan":[ { "CovProductCode":"NT1595", "CovDescription":"T15 Effective 04-01-12", "CovInsuranceType":"Term Life", "CurrentAmount":250000.0, "MinimumAmount":100000.0, "MaximumAmount":50000000.0 } ] }
application/xml
Sample:
RESPONSE <PolicyResponseDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Coverage xmlns:d2p1="http://schemas.datacontract.org/2004/07/LPESService" /> <Plan> <SBLIPlan> <CovDescription>T15 Effective 04-01-12</CovDescription> <CovInsuranceType>Term Life</CovInsuranceType> <CovProductCode>NT1595</CovProductCode> <CurrentAmount>250000</CurrentAmount> <MaximumAmount>50000000</MaximumAmount> <MinimumAmount>100000</MinimumAmount> </SBLIPlan> </Plan> </PolicyResponseDto>