GAgalileo-ft
Federal Benefit Enrollment

Update Federal Benefit Enrollment

Use the Update Federal Benefits Enrollment endpoint to modify an existing federal benefits enrollment prior to re-submitting it with the <a href="ref:post_resubmitfbenrollment" target="_blank">Resubmit Federal Benefit Enrollment</a> endpoint.

post/updateFbEnrollment

Request

  • Base URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
  • URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/updateFbEnrollment
  • Auth
    none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

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

apiTransKeystring required

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

providerIdinteger required

Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: 9999

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

fbeStatusIdinteger required

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

recipientTypeinteger nullable

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

firstNamestring nullable

Account holder's first name. <a href="ref:api-reference-special-characters" target="_blank">Special character support</a>. Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (') Example: "Ed"

lastNamestring nullable

Account holder's last name. <a href="ref:api-reference-special-characters" target="_blank">Special character support</a>. Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (') Example: "Harley"

ssnstring nullable required

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

agencyTypestring nullable

One of several defined agency types. Pattern: See the <a href="ref:api-reference-federal-benefit-enrollment-agency-types" target="_blank">Federal Benefit Enrollment Agency Types</a> table in Enumerations. Example: "SOCIAL SECURITY"

statusstring nullable

Specifies the state of the federal benefits enrollment. See the <a href="ref:api-reference-federal-benefit-enrollment-statuses" target="_blank">Federal Benefit Enrollment Statuses</a> enumeration for valid values. Pattern: One character Example: "B"

signedFormstring nullable

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

earlyAccessstring nullable

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

agentIdinteger nullable

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

middleNamestring nullable

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

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "fbeStatusId": 38437,
  "recipientType": 1,
  "firstName": "Ed",
  "lastName": "Harley",
  "ssn": "123456789",
  "agencyType": "SOCIAL SECURITY",
  "status": "B",
  "signedForm": "Y",
  "earlyAccess": "Y",
  "agentId": 109405,
  "middleName": "James"
}

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

response_dataobject required

A structure for the response data. This endpoint does not return response data, so it will always be empty.

Changes

No recorded changes to this operation across all 2 revisions of this API.