openapi: 3.2.0
info:
title: Program Federal Benefit Enrollment API
version: '4.0'
servers:
- url: api-{corename}.{env}.gpsrv.com/intserv/4.0/
tags:
- name: Federal Benefit Enrollment
paths:
/createFbEnrollment:
parameters:
- $ref: '#/components/parameters/ResponseContentTypeHeaderParam'
post:
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
status_code:
type:
- integer
- 'null'
format: int32
description: The response status code. May return a string for some statuses.
status:
type:
- string
- 'null'
description: The condition of a process or response
processing_time:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transaction_id:
type:
- string
- 'null'
description: An ID that represents an API transaction
provider_timestamp:
type:
- string
- 'null'
format: date-time
description: Store a related timestamp for reporting and troubleshooting purposes
provider_transaction_id:
type:
- string
- 'null'
description: Secondary transaction identifier (generated by a provider)
required:
- provider_timestamp
- provider_transaction_id
- transaction_id
system_timestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A system-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
response_data:
description: A structure for the response data. It can be empty but usually will contain information.
type:
- object
- 'null'
properties:
fbe_status_id:
type: string
description: Federal benefit enrollment ID
required:
- fbe_status_id
required:
- echo
- processing_time
- response_data
- rtoken
- status
- status_code
- system_timestamp
examples:
response:
value: "{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"system_timestamp\": \"2025-07-16 11:46:55\",\n \"response_data\": {\n \"fbe_status_id\": \"23443\"\n },\n \"processing_time\": 0.619,\n \"echo\": {\n \"transaction_id\": \"d7947832-9a82-48bf-a75f-a2da5ec6be0f\",\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\"\n}"
application/xml:
examples:
response:
value: "\n\n 0\n Success\n 2025-07-16 11:46:55\n \n 23443\n \n 0.639\n \n d7947832-9a82-48bf-a75f-a2da5ec6be0f\n \n \n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n"
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Web service username, as provided by SoFi Tech Solutions.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by SoFi Tech Solutions.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Your unique provider identifier from SoFi Tech Solutions.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: '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"`'
example: 123e4567-e89b-12d3-a456-426614174000
accountNo:
type: string
pattern: ^$|^([0-9]{12}|[0-9]{16})$
description: 'The <> or <> of the account.
Pattern: PAN or PRN
Example: `"074103447228"`'
example: 074103447228
location:
type: string
description: 'Unique location identifier; see location types.
Pattern: Must be a number if type is 0; Must be less than 15 characters if type is 1.
Example: `"a455-3483"`'
example: a455-3483
locationType:
type: integer
format: int32
enum:
- 0
- 1
- 2
description: "0=SoFi Tech Solutions location ID\n 1=Partner Location ID\nPattern: `0` or `1`\nExample: `1`"
example: 1
recipientType:
type: integer
format: int32
minimum: 0
maximum: 9
description: 'Specifies whether the owner of the account in `accountNo` is a direct recipient or a beneficiary:
* `0` — Direct recipient
* `1` — Beneficiary
Pattern: Integer
Example: `1`'
example: 1
firstName:
type: string
minLength: 2
maxLength: 30
description: 'Account holder''s first name. Special character support.
Pattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`''`)
Example: `"Ed"`'
example: Ed
lastName:
type: string
minLength: 2
maxLength: 30
description: 'Account holder''s last name. Special character support.
Pattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`''`)
Example: `"Harley"`'
example: Harley
ssn:
type: string
pattern: ^[\d]{9}$
description: 'The Social Security number of the direct recipient of the disbursement.
Pattern: 9-digit Social Security number, no hyphens
Example: `"123456789"`'
example: '123456789'
agencyType:
type: string
pattern: ^[A-Z\/\s]
description: 'One of several defined agency types.
Pattern: See the Federal Benefit Enrollment Agency Types table in Enumerations.
Example: `"SOCIAL SECURITY"`'
example: SOCIAL SECURITY
alerts:
type:
- integer
- 'null'
format: int32
default: 0
enum:
- 0
- 1
description: 'Specifies whether to send alerts regarding the enrollment process.
Pattern: Integer
Example: `1`'
example: 1
agentId:
type:
- integer
- 'null'
format: int32
description: 'Identifier of the agent, for use in transaction reporting and tracking.
Pattern: Integer
Example: `109405`'
example: 109405
middleName:
type:
- string
- 'null'
minLength: 1
maxLength: 53
description: "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. \nPattern: String\nExample: `James`"
example: James
required:
- accountNo
- agencyType
- firstName
- lastName
- location
- locationType
- recipientType
- ssn
- transactionId
- apiLogin
- apiTransKey
- providerId
tags:
- Federal Benefit Enrollment
summary: Create Federal Benefit Enrollment
parameters: []
description: 'Use the Create Federal Benefit Enrollment endpoint to initiate the process for the specified customer to receive U.S. federal benefit funds via ACH deposit. All enrollments that you initiate with this endpoint are queued into a batch file that is sent regularly (usually daily) to the federal government for processing.
[block:callout]
{
"type": "info",
"title": "Note",
"body": "This endpoint automatically creates a secondary account for benefits deposits that shares its balance with the primary account."
}
[/block]'
operationId: post_createfbenrollment
/updateFbEnrollment:
parameters:
- $ref: '#/components/parameters/ResponseContentTypeHeaderParam'
post:
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
status_code:
type:
- integer
- 'null'
format: int32
description: The response status code. May return a string for some statuses.
status:
type:
- string
- 'null'
description: The condition of a process or response
processing_time:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transaction_id:
type:
- string
- 'null'
description: An ID that represents an API transaction
provider_timestamp:
type:
- string
- 'null'
format: date-time
description: Store a related timestamp for reporting and troubleshooting purposes
provider_transaction_id:
type:
- string
- 'null'
description: Secondary transaction identifier (generated by a provider)
required:
- provider_timestamp
- provider_transaction_id
- transaction_id
system_timestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A system-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
response_data:
description: A structure for the response data. This endpoint does not return response data, so it will always be empty.
type: object
properties: {}
required:
- echo
- processing_time
- response_data
- rtoken
- status
- status_code
- system_timestamp
examples:
response:
value: "{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.081,\n \"response_data\": {},\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"V7MEF297XCG81KGWOQN9\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:41:13\"\n}"
application/xml:
examples:
response:
value: "\n\n 0\n Success\n 2025-07-13 10:41:13\n \n 0.081\n \n V7MEF297XCG81KGWOQN9\n \n \n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n"
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Web service username, as provided by SoFi Tech Solutions.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by SoFi Tech Solutions.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Your unique provider identifier from SoFi Tech Solutions.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: '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"`'
example: 123e4567-e89b-12d3-a456-426614174000
fbeStatusId:
type: integer
format: int32
minimum: 1
description: 'The ID parameter value references the Federal Benefits enrollment to be updated.
Pattern: Integer value as returned by getFbEnrollments().
Example: `38437`'
example: 38437
recipientType:
type:
- integer
- 'null'
format: int32
minimum: 0
maximum: 9
description: '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`'
example: 1
firstName:
type:
- string
- 'null'
minimum: 1
maximum: 30
description: 'Account holder''s first name. Special character support.
Pattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`''`)
Example: `"Ed"`'
example: Ed
lastName:
type:
- string
- 'null'
minimum: 2
maximum: 30
description: 'Account holder''s last name. Special character support.
Pattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`''`)
Example: `"Harley"`'
example: Harley
ssn:
type:
- string
- 'null'
pattern: ^[\d]{9}$
description: 'The Social Security number of the direct recipient of the disbursement.
Pattern: 9-digit Social Security number, no hyphens
Example: `"123456789"`'
example: '123456789'
agencyType:
type:
- string
- 'null'
description: 'One of several defined agency types.
Pattern: See the Federal Benefit Enrollment Agency Types table in Enumerations.
Example: `"SOCIAL SECURITY"`'
example: SOCIAL SECURITY
status:
type:
- string
- 'null'
pattern: '[a-zA-z0-9]$'
description: 'Specifies the state of the federal benefits enrollment. See the Federal Benefit Enrollment Statuses enumeration for valid values.
Pattern: One character
Example: `"B"`'
example: B
signedForm:
type:
- string
- 'null'
minimum: 1
maximum: 1
description: 'Specifies whether the form is signed.
Pattern: `Y` or `N`
Example: `"Y"`'
example: Y
earlyAccess:
type:
- string
- 'null'
minimum: 1
maximum: 1
description: 'Specifies whether the account is participating in early access.
Pattern: `Y` or `N`
Example: `"Y"`'
example: Y
agentId:
type:
- integer
- 'null'
format: int32
description: 'Identifier of the agent, for use in transaction reporting and tracking.
Pattern: Integer
Example: `109405`'
example: 109405
middleName:
type:
- string
- 'null'
minLength: 1
maxLength: 53
description: "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. \nPattern: String\nExample: `James`"
example: James
required:
- fbeStatusId
- ssn
- transactionId
- apiLogin
- apiTransKey
- providerId
tags:
- Federal Benefit Enrollment
summary: Update Federal Benefit Enrollment
parameters: []
description: 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.
operationId: post_updatefbenrollment
/getFbEnrollments:
parameters:
- $ref: '#/components/parameters/ResponseContentTypeHeaderParam'
post:
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
status_code:
type:
- integer
- 'null'
format: int32
description: The response status code. May return a string for some statuses.
status:
type:
- string
- 'null'
description: The condition of a process or response
processing_time:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transaction_id:
type:
- string
- 'null'
description: An ID that represents an API transaction
provider_timestamp:
type:
- string
- 'null'
format: date-time
description: Store a related timestamp for reporting and troubleshooting purposes
provider_transaction_id:
type:
- string
- 'null'
description: Secondary transaction identifier (generated by a provider)
required:
- provider_timestamp
- provider_transaction_id
- transaction_id
system_timestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A system-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
response_data:
description: A structure for the response data. It can be empty but usually will contain information.
type:
- object
- 'null'
properties:
found:
type: integer
format: int32
description: The number of federal benefit enrollments found for the account
results:
type: array
description: A list if enrollment objects
items:
description: A data structure that contains enrollment information fields
type: object
properties:
fbe_status_id:
type: string
description: Federal benefit enrollment ID
pmt_ref_no:
type: string
description: Payment reference number.
fbe_dda:
type: string
description: PRN for the federal benefit enrollment <>
status:
type: string
description: The status of the enrollment. See Federal Benefit Enrollment Statuses.
enrolled_date:
type: string
format: date
description: Date when the federal benefit enrollment record was created
submitted_date:
type: string
format: date
description: Date when the federal benefit enrollment record was last submitted
noted_date:
type:
- string
- 'null'
format: date
description: Shows either the date of the last deposit or the last confirmed date
product_description:
type:
- string
- 'null'
description: Description of the product
card_status:
type:
- string
- 'null'
description: The status of the card
beneficiary_ssn:
type:
- string
- 'null'
description: The SSN of the beneficiary
beneficiary_first_name:
type:
- string
- 'null'
description: The first name of the beneficiary
beneficiary_last_name:
type:
- string
- 'null'
description: The last name of the beneficiary
original_pmt_ref_no:
type:
- string
- 'null'
description: PRN for the input account associated with the federal benefit <>
status_description:
type:
- string
- 'null'
description: A description of the status
benefit_type:
type:
- string
- 'null'
description: The federal benefit enrollment agency type
recipient_type:
type:
- string
- 'null'
description: Description of the federal benefit enrollment agency type specified in the `benefit_type` field
beneficiary_middle_name:
type:
- string
- 'null'
description: "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. \nPattern: String\nExample: `James`"
enr_returned_date:
type:
- string
- 'null'
format: date
description: Date when the federal benefit enrollment record was returned
enr_return_code:
type:
- string
- 'null'
description: Return code the federal benefit enrollment was returned with
example: R47
required:
- beneficiary_first_name
- beneficiary_last_name
- beneficiary_ssn
- benefit_type
- card_status
- enrolled_date
- fbe_dda
- fbe_status_id
- noted_date
- pmt_ref_no
- recipient_type
- status
- status_description
- submitted_date
required:
- found
- results
required:
- echo
- processing_time
- response_data
- rtoken
- status
- status_code
- system_timestamp
examples:
response:
value: "{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.578,\n \"response_data\": {\n \"found\": 2,\n \"results\": [\n {\n \"fbe_status_id\": 78,\n \"pmt_ref_no\": \"412101012877\",\n \"fbe_dda\": \"412101012877\",\n \"status\": \"U\",\n \"enrolled_date\": \"2025-04-20\",\n \"submitted_date\": null,\n \"noted_date\": null,\n \"product_description\": \"NexsCard Personalized (MCB)\",\n \"card_status\": \"X\",\n \"beneficiary_ssn\": \"526464928\",\n \"beneficiary_first_name\": \"Ruisiwwk\",\n \"beneficiary_last_name\": \"Qnesgzfd\",\n \"original_pmt_ref_no\": \"412101006366\",\n \"status_description\": \"Updated\",\n \"benefit_type\": \"Social Security\",\n \"recipient_type\": \"Card Holder\"\n },\n {\n \"fbe_status_id\": 79,\n \"pmt_ref_no\": \"412101012885\",\n \"fbe_dda\": \"412101012885\",\n \"status\": \"E\",\n \"enrolled_date\": \"2025-04-20\",\n \"submitted_date\": null,\n \"noted_date\": null,\n \"product_description\": \"NexsCard Personalized (MCB)\",\n \"card_status\": \"X\",\n \"beneficiary_ssn\": \"535732299\",\n \"beneficiary_first_name\": \"Ageqxjel\",\n \"beneficiary_last_name\": \"Ccmragoy\",\n \"original_pmt_ref_no\": \"412101006366\",\n \"status_description\": \"Entered\",\n \"benefit_type\": \"Social Security\",\n \"recipient_type\": \"Card Holder\"\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"DK86NSC5ZCH4W3RA7ESS\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:45:21\"\n}"
application/xml:
examples:
response:
value: "\n\n 0\n Success\n 1.671\n \n 2\n \n \n 78\n 412101012877\n 412101012877\n U\n 2025-04-20\n \n \n NexsCard Personalized (MCB)\n X\n 526464928\n Fvpvefcl\n Gzwywlrl\n 412101006366\n Updated\n Social Security\n Card Holder\n \n \n 79\n 412101012885\n 412101012885\n E\n 2025-04-20\n \n \n NexsCard Personalized (MCB)\n X\n 535732299\n Ageqxjel\n Ccmragoy\n 412101006366\n Entered\n Social Security\n Card Holder\n \n \n \n \n \n \n 3XC10I66K3KL67PRZDVG\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:38:54\n"
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Web service username, as provided by SoFi Tech Solutions.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by SoFi Tech Solutions.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Your unique provider identifier from SoFi Tech Solutions.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: '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"`'
example: 123e4567-e89b-12d3-a456-426614174000
accountNo:
type: string
pattern: ^$|^([0-9]{12}|[0-9]{16})$
description: 'The <> or <> of the account.
Pattern: PRN or PAN
Example: `"074103447228"`'
example: 074103447228
fbeDda:
type:
- string
- 'null'
minLength: 1
maxLength: 19
pattern: ^[0-9]+$
description: 'The PRN of the federal benefits enrollment <>.
Pattern: PRN
Example: `"074103447228"`'
example: 074103447228
agencyType:
type:
- string
- 'null'
description: '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"`'
example: SOCIAL SECURITY
status:
type:
- string
- 'null'
description: 'Specifies the state of the federal benefits enrollment. See the Federal Benefit Enrollment Statuses enumeration for valid values.
Pattern: One character
Example: `"B"`'
example: B
beneficiarySsn:
type:
- string
- 'null'
maxLength: 12
description: 'The Social Security number of the beneficiary of the disbursement.
Pattern: 9-digit Social Security number, no hyphens
Example: `"123456789"`'
example: '123456789'
beneficiaryFirstName:
type:
- string
- 'null'
description: 'Account holder''s first name. Special character support.
Pattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`''`)
Example: `"Ed"`'
example: Ed
beneficiaryLastName:
type:
- string
- 'null'
description: '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"`'
example: Harley
enrolledFrom:
type:
- string
- 'null'
maxLength: 11
pattern: '[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])'
description: 'Date enrollment started.
Pattern: YYYY-MM-DD
Example: `"2016-01-01"`'
example: '2016-01-01'
enrolledTo:
type:
- string
- 'null'
maxLength: 11
pattern: '[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])'
description: 'Date enrolled to.
Pattern: YYYY-MM-DD
Example: `"2016-01-01"`'
example: '2016-01-01'
submittedFrom:
type:
- string
- 'null'
maxLength: 11
pattern: '[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])'
description: 'Date submitted from.
Pattern: YYYY-MM-DD
Example: `"2016-01-01"`'
example: '2016-01-01'
submittedTo:
type:
- string
- 'null'
maxLength: 11
pattern: '[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])'
description: 'Date submitted to.
Pattern: YYYY-MM-DD
Example: `"2016-01-01"`'
example: '2016-01-01'
notedFrom:
type:
- string
- 'null'
maxLength: 11
pattern: '[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])'
description: 'Date noted from.
Pattern: YYYY-MM-DD
Example: `"2016-01-01"`'
notedTo:
type:
- string
- 'null'
maxLength: 11
pattern: '[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])'
description: 'Date noted to.
Pattern: YYYY-MM-DD
Example: `"2016-01-01"`'
example: '2016-01-01'
enrReturnedFrom:
type:
- string
- 'null'
maxLength: 11
pattern: '[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])'
description: 'Date enr_returned from.
Pattern: YYYY-MM-DD
Example: `"2016-01-01"`'
enrReturnedTo:
type:
- string
- 'null'
maxLength: 11
pattern: '[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])'
description: 'Date enr_returned to.
Pattern: YYYY-MM-DD
Example: `"2016-01-01"`'
example: '2016-01-01'
required:
- accountNo
- transactionId
- apiLogin
- apiTransKey
- providerId
tags:
- Federal Benefit Enrollment
summary: Get Federal Benefit Enrollments
parameters: []
description: Use the Get Federal Benefit Enrollments endpoint to retrieve information on the federal benefit enrollments of the specified account.
operationId: post_getfbenrollments
/resubmitFbEnrollment:
parameters:
- $ref: '#/components/parameters/ResponseContentTypeHeaderParam'
post:
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
status_code:
type:
- integer
- 'null'
format: int32
description: The response status code. May return a string for some statuses.
status:
type:
- string
- 'null'
description: The condition of a process or response
processing_time:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transaction_id:
type:
- string
- 'null'
description: An ID that represents an API transaction
provider_timestamp:
type:
- string
- 'null'
format: date-time
description: Store a related timestamp for reporting and troubleshooting purposes
provider_transaction_id:
type:
- string
- 'null'
description: Secondary transaction identifier (generated by a provider)
required:
- provider_timestamp
- provider_transaction_id
- transaction_id
system_timestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A system-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
response_data:
description: A structure for the response data. This endpoint does not return response data, so it will always be empty.
type: object
properties: {}
required:
- echo
- processing_time
- response_data
- rtoken
- status
- status_code
- system_timestamp
examples:
response:
value: "{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.744,\n \"response_data\": {},\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"XZYA1XPQHFL6XLAF8WKW\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:45:25\"\n}"
application/xml:
examples:
response:
value: "\n\n 0\n Success\n 0.114\n \n \n \n \n TR42GAPFK8DQQN2I6NJ8\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:38:55\n"
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Web service username, as provided by SoFi Tech Solutions.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by SoFi Tech Solutions.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Your unique provider identifier from SoFi Tech Solutions.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: '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"`'
example: 123e4567-e89b-12d3-a456-426614174000
fbeStatusId:
type: integer
format: int32
minimum: 1
description: 'The federal benefits enrollment ID (`fbe_status_id`) as returned by the Create Federal Benefit Enrollment endpoint.
Pattern: Integer
Example: `1`'
example: 1
recipientType:
type: integer
format: int32
minimum: 0
maximum: 9
description: '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`'
example: 0
firstName:
type: string
minimum: 1
maximum: 30
description: 'Account holder''s first name. Special character support.
Pattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`''`)
Example: `"Ed"`'
example: Ed
lastName:
type: string
minimum: 2
maximum: 30
description: 'Account holder''s last name. Special character support.
Pattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`''`)
Example: `"Harley"`'
example: Harley
ssn:
type: string
pattern: ^[\d]{9}$
description: 'The Social Security number of the direct recipient of the disbursement.
Pattern: 9-digit Social Security number, no hyphens
Example: `"123456789"`'
example: '123456789'
agencyType:
type: string
description: 'One of several defined agency types.
Pattern: See the Federal Benefit Enrollment Agency Types table in Enumerations.
Example: `"SOCIAL SECURITY"`'
example: SOCIAL SECURITY
agentId:
type:
- integer
- 'null'
format: int32
description: 'Identifier of the agent, for use in transaction reporting and tracking.
Pattern: Integer
Example: `109405`'
example: 109405
middleName:
type:
- string
- 'null'
minLength: 1
maxLength: 53
description: "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. \nPattern: String\nExample: `James`"
example: James
required:
- agencyType
- fbeStatusId
- firstName
- lastName
- recipientType
- ssn
- transactionId
- apiLogin
- apiTransKey
- providerId
tags:
- Federal Benefit Enrollment
summary: Resubmit Federal Benefit Enrollment
parameters: []
description: Use the Resubmit Federal Benefit Enrollment endpoint to submit an amended federal-benefit enrollment record and send it in for processing. You can modify the name and SSN parameters as part of resubmittal.
operationId: post_resubmitfbenrollment
components:
parameters:
ResponseContentTypeHeaderParam:
name: response-content-type
in: header
description: Use this header instead of the standard `accept` header to specify the response format.
schema:
type: string
enum:
- xml
- json
default: json
x-readme:
samples-languages:
- curl
- python
- node
- java
- go
- ruby
- javascript
explorer-enabled: true
proxy-enabled: true