POST api/Enroll/AddEnrollment

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SSN	string	None.
LastName	string	None.
FirstName	string	None.
MiddleName	string	None.
Generation	Generation	None.
Address1	string	None.
Address2	string	None.
City	string	None.
State	string	None.
Zipcode	string	None.
Phone	string	None.
Birthdate	date	None.
Gender	GenderType	None.
Email	string	None.
EntryDate	date	None.
PortalCode	string	None.
RequestedEffectiveDate	date	None.
IPAddress	string	None.
SmartIdentifier	string	None.
OriginalEffectiveDate	date	None.
Dependents	Collection of DependentRequest	None.
ProductCodes	Collection of string	None.
PremiumMode	LimitedMode	None.
AccountType	DraftType	None.
AccountHolderName	string	None.
AccountNumber	string	None.
AuthorizationId	string	None.
BankName	string	None.
RoutingNumber	string	None.
BankAccountType	AccountType	None.
CardType	CreditCardType	None.
ExpirationDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "SSN": "sample string 1",
  "LastName": "sample string 2",
  "FirstName": "sample string 3",
  "MiddleName": "sample string 4",
  "Generation": 0,
  "Address1": "sample string 5",
  "Address2": "sample string 6",
  "City": "sample string 7",
  "State": "sample string 8",
  "Zipcode": "sample string 9",
  "Phone": "sample string 10",
  "Birthdate": "2025-01-22T01:53:15.4178353-06:00",
  "Gender": 0,
  "Email": "sample string 12",
  "EntryDate": "2025-01-22T01:53:15.4178353-06:00",
  "PortalCode": "sample string 14",
  "RequestedEffectiveDate": "2025-01-22T01:53:15.4178353-06:00",
  "IPAddress": "sample string 16",
  "SmartIdentifier": "sample string 17",
  "OriginalEffectiveDate": "2025-01-22T01:53:15.4178353-06:00",
  "Dependents": [
    {
      "SSN": "sample string 1",
      "LastName": "sample string 2",
      "FirstName": "sample string 3",
      "MiddleName": "sample string 4",
      "Generation": 0,
      "Gender": 0,
      "Relationship": 0,
      "Birthdate": "2025-01-22T01:53:15.4178353-06:00"
    },
    {
      "SSN": "sample string 1",
      "LastName": "sample string 2",
      "FirstName": "sample string 3",
      "MiddleName": "sample string 4",
      "Generation": 0,
      "Gender": 0,
      "Relationship": 0,
      "Birthdate": "2025-01-22T01:53:15.4178353-06:00"
    }
  ],
  "ProductCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "PremiumMode": 0,
  "AccountType": 0,
  "AccountHolderName": "sample string 19",
  "AccountNumber": "sample string 20",
  "AuthorizationId": "sample string 21",
  "BankName": "sample string 22",
  "RoutingNumber": "sample string 23",
  "BankAccountType": 0,
  "CardType": 0,
  "ExpirationDate": "2025-01-22T01:53:15.4178353-06:00"
}

application/xml, text/xml

Sample:

<EnrollmentRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SSN>sample string 1</SSN>
  <LastName>sample string 2</LastName>
  <FirstName>sample string 3</FirstName>
  <MiddleName>sample string 4</MiddleName>
  <Generation>NA</Generation>
  <Address1>sample string 5</Address1>
  <Address2>sample string 6</Address2>
  <City>sample string 7</City>
  <State>sample string 8</State>
  <Zipcode>sample string 9</Zipcode>
  <Phone>sample string 10</Phone>
  <Birthdate>2025-01-22T01:53:15.4178353-06:00</Birthdate>
  <Gender>Unknown</Gender>
  <Email>sample string 12</Email>
  <EntryDate>2025-01-22T01:53:15.4178353-06:00</EntryDate>
  <PortalCode>sample string 14</PortalCode>
  <RequestedEffectiveDate>2025-01-22T01:53:15.4178353-06:00</RequestedEffectiveDate>
  <IPAddress>sample string 16</IPAddress>
  <SmartIdentifier>sample string 17</SmartIdentifier>
  <OriginalEffectiveDate>2025-01-22T01:53:15.4178353-06:00</OriginalEffectiveDate>
  <Dependents>
    <DependentRequest>
      <SSN>sample string 1</SSN>
      <LastName>sample string 2</LastName>
      <FirstName>sample string 3</FirstName>
      <MiddleName>sample string 4</MiddleName>
      <Generation>NA</Generation>
      <Gender>Unknown</Gender>
      <Relationship>Spouse</Relationship>
      <Birthdate>2025-01-22T01:53:15.4178353-06:00</Birthdate>
    </DependentRequest>
    <DependentRequest>
      <SSN>sample string 1</SSN>
      <LastName>sample string 2</LastName>
      <FirstName>sample string 3</FirstName>
      <MiddleName>sample string 4</MiddleName>
      <Generation>NA</Generation>
      <Gender>Unknown</Gender>
      <Relationship>Spouse</Relationship>
      <Birthdate>2025-01-22T01:53:15.4178353-06:00</Birthdate>
    </DependentRequest>
  </Dependents>
  <ProductCodes>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </ProductCodes>
  <PremiumMode>Monthly</PremiumMode>
  <AccountType>None</AccountType>
  <AccountHolderName>sample string 19</AccountHolderName>
  <AccountNumber>sample string 20</AccountNumber>
  <AuthorizationId>sample string 21</AuthorizationId>
  <BankName>sample string 22</BankName>
  <RoutingNumber>sample string 23</RoutingNumber>
  <BankAccountType>Checking</BankAccountType>
  <CardType>MasterCard</CardType>
  <ExpirationDate>2025-01-22T01:53:15.4178353-06:00</ExpirationDate>
</EnrollmentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EnrollmentResponse

Name	Type	Additional information
EnrollmentId	globally unique identifier	None.
Status	ResponseStatus	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "EnrollmentId": "0a9898c8-8268-49ac-a855-a6c7ba87ed4d",
  "Status": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<EnrollmentResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Status>Success</Status>
  <Message>sample string 2</Message>
  <EnrollmentId>0a9898c8-8268-49ac-a855-a6c7ba87ed4d</EnrollmentId>
</EnrollmentResponse>