Manage FBE
Manage FBE
The Manage FBE (Federal Benefits Enrollement) API allows to Create, Change FBE Status, and Update FBE Status of card holders enrollment.
Input Parameters:
BenefitType
Y
Format options: SI (SSI - Suppl. Security Income) SS (Soc Sec - Social Security) BL (Black Lung) IA (Bureau of Indian Affairs) CR (Civil Service Retirement) CS (Civil Service Survivor) MA (Mil. Active) MC (Mil. Civilian Pay) MP (Mil. Pension/Retire) MS (Mil. Survivor) RR (Railroad Retirement) RU (Railroad Unempl. / Sickness) VC (Veterans Compensation/Pension) VE (Veterans Edu. And Sel. Reserve) VM (Veterans Education MGIB) VL (Veterans Life Insurance) VV (Veterans Vocational Rehabilitation)
CardNumber
C
Format: Numeric, 16
Required based on CardParameterType value (CardNumber or RPID). Relevant for ManageFBEOperationType values of: Create, ChangeStatus
CardParameterType
Y
Relevant for ManageFBEOperationType values of: Create
CheckFBOFirstName
N
Format: Alphanumeric, 2-20
Relevant for ManageFBEOperationType values of: Create
CheckFBOLastName
N
Format: Alphanumeric, 2-20
Relevant for ManageFBEOperationType values of: Create
CheckFirstName
N
Format: Alphanumeric, 2-20
Relevant for ManageFBEOperationType values of: Create
CheckLastName
N
Format: Alphanumeric, 2-20
Relevant for ManageFBEOperationType values of: Create
EarlyAccess
N
Format: Y/N
Relevant for ManageFBEOperationType values of: Create
FBEID
C
Format: FBEDetailRecordId - for internal uses
May be required based on FBEParametersType param. Relevant for ManageFBEOperationType values of: ChangeStatus, Update
FBEStatus
N
Format options: Closed list of values (1 char): Submitted (G) Confirmed (C) Error (X) Updated (U) Returned (R) (Enrolled (E) - Initial Status)
Relevant for ManageFBEOperationType values of: ChangeStatus
FBESubmittedFirstName
Y
Format: Alphanumeric, 1-7
Relevant for ManageFBEOperationType values of: Create
FBESubmittedLastName
Y
Format: Alphanumeric, 1-15
Relevant for ManageFBEOperationType values of: Create
ManageFBEOperationType
Y
Format options: Create ChangeStatus Update
Relevant for ManageFBEOperationType values of: Create, ChangeStatus, Update
ManageFBEParameterType
Y
Format options: FBEID (required FBEID Parameter) CardNumberSSNBenefit (required Card Number, SSN and BenefitType parameters)
Relevant for ManageFBEOperationType values of: ChangeStatus, Update
NewBenefitType
Y
Format options: SI (SSI - Suppl. Security Income) SS (Soc Sec - Social Security) BL (Black Lung) IA (Bureau of Indian Affairs) CR (Civil Service Retirement) CS (Civil Service Survivor) MA (Mil. Active) MC (Mil. Civilian Pay) MP (Mil. Pension/Retire) MS (Mil. Survivor) RR (Railroad Retirement) RU (Railroad Unempl. / Sickness) VC (Veterans Compensation/Pension) VE (Veterans Edu. And Sel. Reserve) VM (Veterans Education MGIB) VL (Veterans Life Insurance) VV (Veterans Vocational Rehabilitation)
NewCheckFBOFirstName
Y
Format: Alphanumeric, 2-20
Relevant for ManageFBEOperationType values of: Update
NewCheckFBOLastName
Y
Format: Alphanumeric, 2-20
Relevant for ManageFBEOperationType values of: Update
NewCheckFirstName
Y
Format: Alphanumeric, 2-20
Relevant for ManageFBEOperationType values of: Update
NewCheckLastName
Y
Format: Alphanumeric, 2-20
Relevant for ManageFBEOperationType values of: Update
NewFBESubmittedFirstName
Y
Format: Alphanumeric, 1-7
Relevant for ManageFBEOperationType values of: Update
NewFBESubmittedLastName
Y
Format: Alphanumeric, 1-15
Relevant for ManageFBEOperationType values of: Update
NewSSN
Y
Format: Numeric, 9 Description: SSN of Beneficiary
Relevant for ManageFBEOperationType values of: Update
RPID
C
Format: Numeric, 1-19
Required based on CardParameterType value (CardNumber or RPID), Relevant for ManageFBEOperationType values of: Create
SSN
Y
Format: Numeric, 9 Description: SSN of Beneficiary
Required in Create request. May be required in Update request & Update FBE Status request based on FBEParametersType param
Output Parameters:
XML Samples
Input XML
Last updated