GET api/v1/benefitconfirmations/{token}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
token

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of BenefitConfirmationAPI
NameDescriptionTypeAdditional information
SSN

string

None.
EEID

string

None.
BenID

string

None.
BenDeduction

string

None.
TotalBenAmount

string

None.
BenText

string

None.
PayFreq

string

None.
BenEffDate

date

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "ssn": "sample string 1",
    "eeid": "sample string 2",
    "benID": "sample string 3",
    "benDeduction": "sample string 4",
    "totalBenAmount": "sample string 5",
    "benText": "sample string 6",
    "payFreq": "sample string 7",
    "benEffDate": "2025-10-25T15:18:21.80824+00:00"
  },
  {
    "ssn": "sample string 1",
    "eeid": "sample string 2",
    "benID": "sample string 3",
    "benDeduction": "sample string 4",
    "totalBenAmount": "sample string 5",
    "benText": "sample string 6",
    "payFreq": "sample string 7",
    "benEffDate": "2025-10-25T15:18:21.80824+00:00"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfBenefitConfirmationAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <BenefitConfirmationAPI>
    <SSN>sample string 1</SSN>
    <EEID>sample string 2</EEID>
    <BenID>sample string 3</BenID>
    <BenDeduction>sample string 4</BenDeduction>
    <TotalBenAmount>sample string 5</TotalBenAmount>
    <BenText>sample string 6</BenText>
    <PayFreq>sample string 7</PayFreq>
    <BenEffDate>2025-10-25T15:18:21.80824+00:00</BenEffDate>
  </BenefitConfirmationAPI>
  <BenefitConfirmationAPI>
    <SSN>sample string 1</SSN>
    <EEID>sample string 2</EEID>
    <BenID>sample string 3</BenID>
    <BenDeduction>sample string 4</BenDeduction>
    <TotalBenAmount>sample string 5</TotalBenAmount>
    <BenText>sample string 6</BenText>
    <PayFreq>sample string 7</PayFreq>
    <BenEffDate>2025-10-25T15:18:21.80824+00:00</BenEffDate>
  </BenefitConfirmationAPI>
</ArrayOfBenefitConfirmationAPI>