Update Federal Benefit Enrollment

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/updateFbEnrollment

Use the Update Federal Benefits Enrollment endpoint to modify an existing federal benefits enrollment prior to re-submitting it with the Resubmit Federal Benefit Enrollment endpoint.

Status codes

See Global Response Statuses for status codes that are common across endpoints.

The table below lists status codes that apply to this specific endpoint.

Status code	Description
528-01	Enrollment not found
528-02	Invalid agencyType
528-03	Invalid status
528-04	Invalid signedForm value
528-05	Invalid earlyAccess value
528-06	Error saving data
528-07	Invalid recipientType

Form Data

apiLogin

string

required

Web service username, as provided by Galileo.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by Galileo.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

providerId

int32

required

Galileo-issued provider identifier.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

A unique provider-generated ID to identify this API call. A UUID is preferred.
Pattern: 60 characters or less
Example: "9845dk-39fdk3fj3-4483483478"

fbeStatusId

int32

required

≥ 1

The ID parameter value references the Federal Benefits enrollment to be updated.
Pattern: Integer value as returned by getFbEnrollments().
Example: 38437

recipientType

int32 | null

0 to 9

Specifies whether the owner of the account in accountNo is a direct recipient or a beneficiary:

0 — Direct recipient
1 — Beneficiary

Pattern: 0 or 1
Example: 1

firstName

string | null

1 to 30

Account holder's first name. Special character support.
Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (')
Example: "Ed"

lastName

string | null

2 to 30

Account holder's last name. Special character support.
Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (')
Example: "Harley"

ssn

string | null

required

The Social Security number of the direct recipient of the disbursement.
Pattern: 9-digit Social Security number, no hyphens
Example: "123456789"

agencyType

string | null

One of several defined agency types.
Pattern: See the Federal Benefit Enrollment Agency Types table in Enumerations.
Example: "SOCIAL SECURITY"

status

string | null

Specifies the state of the federal benefits enrollment. See the Federal Benefit Enrollment Statuses enumeration for valid values.
Pattern: One character
Example: "B"

signedForm

string | null

1 to 1

Specifies whether the form is signed.
Pattern: Y or N
Example: "Y"

earlyAccess

string | null

1 to 1

Specifies whether the account is participating in early access.
Pattern: Y or N
Example: "Y"

agentId

int32 | null

Identifier of the agent, for use in transaction reporting and tracking.
Pattern: Integer
Example: 109405

middleName

string | null

Middle name of the beneficiary.Middle names are not used in ENR transactions, but they are included here for parity between the Account Management and Federal Benefit Enrollment data models.
Pattern: String
Example: James

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

Status codes

default