Get Federal Benefit Enrollments

post

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

Use the Get Federal Benefit Enrollments endpoint to retrieve information on the federal benefit enrollments of the specified account.

Status codes

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

Form Data

apiLogin

string

required

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

apiTransKey

string

required

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

providerId

int32

required

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

transactionId

string

required

1 to 60

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency. A UUID is preferred.
Pattern: Maximum 60 characters
Example: "9845dk-39fdk3fj3-4483483478"

accountNo

string

required

^$|^([0-9]{12}|[0-9]{16})$

The PRN or PAN of the account.
Pattern: PRN or PAN
Example: "074103447228"

fbeDda

string | null

^[0-9]+$

The PRN of the federal benefits enrollment DDA.
Pattern: PRN
Example: "074103447228"

agencyType

string | null

The type of agency that is providing the benefit. See the Federal Benefit Enrollment Agency Types enumeration for valid values.
Pattern: String
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"

beneficiarySsn

string | null

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

beneficiaryFirstName

string | null

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

beneficiaryLastName

string | null

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

enrolledFrom

string | null

[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])

Date enrollment started.
Pattern: YYYY-MM-DD
Example: "2016-01-01"

enrolledTo

string | null

[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])

Date enrolled to.
Pattern: YYYY-MM-DD
Example: "2016-01-01"

submittedFrom

string | null

[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])

Date submitted from.
Pattern: YYYY-MM-DD
Example: "2016-01-01"

submittedTo

string | null

[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])

Date submitted to.
Pattern: YYYY-MM-DD
Example: "2016-01-01"

notedFrom

string | null

[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])

Date noted from.
Pattern: YYYY-MM-DD
Example: "2016-01-01"

notedTo

string | null

[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])

Date noted to.
Pattern: YYYY-MM-DD
Example: "2016-01-01"

enrReturnedFrom

string | null

[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])

Date enr_returned from.
Pattern: YYYY-MM-DD
Example: "2016-01-01"

enrReturnedTo

string | null

[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])

Date enr_returned to.
Pattern: YYYY-MM-DD
Example: "2016-01-01"

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