POST api/PersonalInfo/RequestIdCard

idCardRequestModel

Request Information

URI Parameters

None.

Body Parameters

Collection of IdCardDataModel
NameDescriptionTypeAdditional information
FirstName

string

None.

LastName

string

None.

PolicyId

integer

None.

MemberId

integer

None.

PlanName

string

None.

CoverageStartDate

date

None.

CoverageEndDate

date

None.

EffectiveDate

date

None.

IsCancelled

boolean

None.

PolicyNumber

string

None.

EmployeeCategoryPolicyId

string

None.

PolicyStatus

string

None.

PolicyActive

boolean

None.

CoverageType

string

None.

PolicyType

string

None.

DocumentId

integer

None.

MailTo

string

None.

DOB

date

None.

MailingAddress

IdCardMailingAddress

None.

ProfitRegion

string

None.

ProductCategory

string

None.

PolicyStartDate

date

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "PolicyId": 3,
    "MemberId": 4,
    "PlanName": "sample string 5",
    "CoverageStartDate": "2025-05-02T07:25:08.9695293-07:00",
    "CoverageEndDate": "2025-05-02T07:25:08.9695293-07:00",
    "EffectiveDate": "2025-05-02T07:25:08.9695293-07:00",
    "IsCancelled": true,
    "PolicyNumber": "sample string 6",
    "EmployeeCategoryPolicyId": "sample string 7",
    "PolicyStatus": "sample string 8",
    "PolicyActive": true,
    "CoverageType": "sample string 10",
    "PolicyType": "sample string 11",
    "DocumentId": 12,
    "MailTo": "sample string 13",
    "DOB": "2025-05-02T07:25:08.9695293-07:00",
    "MailingAddress": {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "Street": "sample string 3",
      "City": "sample string 4",
      "PostalCode": "sample string 5",
      "Country": {
        "Oid": 1,
        "Code": "sample string 2",
        "Name": "sample string 3"
      },
      "State": "sample string 6"
    },
    "ProfitRegion": "sample string 14",
    "ProductCategory": "sample string 15",
    "PolicyStartDate": "2025-05-02T07:25:08.9695293-07:00"
  },
  {
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "PolicyId": 3,
    "MemberId": 4,
    "PlanName": "sample string 5",
    "CoverageStartDate": "2025-05-02T07:25:08.9695293-07:00",
    "CoverageEndDate": "2025-05-02T07:25:08.9695293-07:00",
    "EffectiveDate": "2025-05-02T07:25:08.9695293-07:00",
    "IsCancelled": true,
    "PolicyNumber": "sample string 6",
    "EmployeeCategoryPolicyId": "sample string 7",
    "PolicyStatus": "sample string 8",
    "PolicyActive": true,
    "CoverageType": "sample string 10",
    "PolicyType": "sample string 11",
    "DocumentId": 12,
    "MailTo": "sample string 13",
    "DOB": "2025-05-02T07:25:08.9695293-07:00",
    "MailingAddress": {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "Street": "sample string 3",
      "City": "sample string 4",
      "PostalCode": "sample string 5",
      "Country": {
        "Oid": 1,
        "Code": "sample string 2",
        "Name": "sample string 3"
      },
      "State": "sample string 6"
    },
    "ProfitRegion": "sample string 14",
    "ProductCategory": "sample string 15",
    "PolicyStartDate": "2025-05-02T07:25:08.9695293-07:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfIdCardDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.MemberPortal.Data.Models.PersonalInfo">
  <IdCardDataModel>
    <CoverageEndDate>2025-05-02T07:25:08.9695293-07:00</CoverageEndDate>
    <CoverageStartDate>2025-05-02T07:25:08.9695293-07:00</CoverageStartDate>
    <CoverageType>sample string 10</CoverageType>
    <DOB>2025-05-02T07:25:08.9695293-07:00</DOB>
    <DocumentId>12</DocumentId>
    <EffectiveDate>2025-05-02T07:25:08.9695293-07:00</EffectiveDate>
    <EmployeeCategoryPolicyId>sample string 7</EmployeeCategoryPolicyId>
    <FirstName>sample string 1</FirstName>
    <IsCancelled>true</IsCancelled>
    <LastName>sample string 2</LastName>
    <MailTo>sample string 13</MailTo>
    <MailingAddress>
      <AddressLine1>sample string 1</AddressLine1>
      <AddressLine2>sample string 2</AddressLine2>
      <City>sample string 4</City>
      <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/GBG.MemberPortal.Data.Models.Common">
        <d4p1:Code>sample string 2</d4p1:Code>
        <d4p1:Name>sample string 3</d4p1:Name>
        <d4p1:Oid>1</d4p1:Oid>
      </Country>
      <PostalCode>sample string 5</PostalCode>
      <State>sample string 6</State>
      <Street>sample string 3</Street>
    </MailingAddress>
    <MemberId>4</MemberId>
    <PlanName>sample string 5</PlanName>
    <PolicyActive>true</PolicyActive>
    <PolicyId>3</PolicyId>
    <PolicyNumber>sample string 6</PolicyNumber>
    <PolicyStartDate>2025-05-02T07:25:08.9695293-07:00</PolicyStartDate>
    <PolicyStatus>sample string 8</PolicyStatus>
    <PolicyType>sample string 11</PolicyType>
    <ProductCategory>sample string 15</ProductCategory>
    <ProfitRegion>sample string 14</ProfitRegion>
  </IdCardDataModel>
  <IdCardDataModel>
    <CoverageEndDate>2025-05-02T07:25:08.9695293-07:00</CoverageEndDate>
    <CoverageStartDate>2025-05-02T07:25:08.9695293-07:00</CoverageStartDate>
    <CoverageType>sample string 10</CoverageType>
    <DOB>2025-05-02T07:25:08.9695293-07:00</DOB>
    <DocumentId>12</DocumentId>
    <EffectiveDate>2025-05-02T07:25:08.9695293-07:00</EffectiveDate>
    <EmployeeCategoryPolicyId>sample string 7</EmployeeCategoryPolicyId>
    <FirstName>sample string 1</FirstName>
    <IsCancelled>true</IsCancelled>
    <LastName>sample string 2</LastName>
    <MailTo>sample string 13</MailTo>
    <MailingAddress>
      <AddressLine1>sample string 1</AddressLine1>
      <AddressLine2>sample string 2</AddressLine2>
      <City>sample string 4</City>
      <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/GBG.MemberPortal.Data.Models.Common">
        <d4p1:Code>sample string 2</d4p1:Code>
        <d4p1:Name>sample string 3</d4p1:Name>
        <d4p1:Oid>1</d4p1:Oid>
      </Country>
      <PostalCode>sample string 5</PostalCode>
      <State>sample string 6</State>
      <Street>sample string 3</Street>
    </MailingAddress>
    <MemberId>4</MemberId>
    <PlanName>sample string 5</PlanName>
    <PolicyActive>true</PolicyActive>
    <PolicyId>3</PolicyId>
    <PolicyNumber>sample string 6</PolicyNumber>
    <PolicyStartDate>2025-05-02T07:25:08.9695293-07:00</PolicyStartDate>
    <PolicyStatus>sample string 8</PolicyStatus>
    <PolicyType>sample string 11</PolicyType>
    <ProductCategory>sample string 15</ProductCategory>
    <ProfitRegion>sample string 14</ProfitRegion>
  </IdCardDataModel>
</ArrayOfIdCardDataModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RequestIdCardResponse
NameDescriptionTypeAdditional information
IsValidCAARequest

boolean

None.

ZelisRequestCount

integer

None.

IsNonCAAMembersOnly

boolean

None.

ZelisResponse

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "IsValidCAARequest": true,
  "ZelisRequestCount": 2,
  "IsNonCAAMembersOnly": true,
  "ZelisResponse": true
}

application/xml, text/xml

Sample:
<RequestIdCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.MemberPortal.Data.Models.PersonalInfo">
  <IsNonCAAMembersOnly>true</IsNonCAAMembersOnly>
  <IsValidCAARequest>true</IsValidCAARequest>
  <ZelisRequestCount>2</ZelisRequestCount>
  <ZelisResponse>true</ZelisResponse>
</RequestIdCardResponse>