HomeGuidesAPI Reference
Guides

Enrollments

All you need to know about enrolling your consumers in a plan.

Enrollment is a key feature that lets Partners enroll their qualifying users in Income-Driven Repayment plans chosen from the Repayment Options API endpoint. Additional information about the Consumer must be sent in with the request to create an Enrollment, and a valid income certification for the Consumer must have already been provided via the Consumer create/update endpoints if the consumer has income.

Requirements to Enroll

For an Enrollment to be created, several preconditions must be met:

  • The Consumer must have Student Loan Debts
  • SSN must have been provided in a create/update API request
  • The consumers phone must have been provided in a create/update API request
  • An Address for the consumer must have been provided (at least street1, city, state, and zipcode)
  • AGI must be provided.
  • The Consumer must not be an active student (FULL TIME or THREE QUARTER TIME)
  • marital_status must be provided.

NOTE: If one or more of these preconditions is not met, calls to Create an Enrollment will return a 409 Conflict response.


Married Enrollments

In order to submit an enrollment for a consumer who is married you will need to populate the spouse fields on the consumer. When you want to Enroll, if the spouse record has only the minimum amount of data required by the repayment_options endpoint and the spouse has federal loans, you will need to make sure that you first update these fields on the spouse before attempting to enroll.

  • ssn
  • first_name
  • has_taxable_income
  • last_name
  • date_of_birth

Income Certifications

  • irs_authorized_at- ISO8601 timestamp of when the Consumer agreed for the IRS to verify their income. This may be submitted instead of an income_certification if the Consumer's income has not decreased since they last filed taxes.
  • An IncomeCertification must be provided unless the Consumer is both unemployed and not collecting unemployment, or has not consented to IRS authorization. This is mutually exclusive of irs_authorized_at.
ScenarioRequired Income Certification
Consumer (and spouse if they have one) have no taxable income.Income certification not required. The Consumer's (and spouse's if present) agi must be zero.
Consumer (and spouse if they have one) have income that has not significantly decreased since they filed their taxes.Consumer may consent to IRS authorization. If they do not consent, they must upload their their federal tax return or their tax transcript.
Consumer (and spouse if they have one) have income that has significantly decreased since they last filed their taxes.Consumer and/or their spouse, depending on who actually has taxable income, must upload a recent PAY_STUB, OFFER_LETTER, or unemployment DETERMINATION_SUMMARY for their income certification.

Repayment Plans

Every Enrollment must identify the repayment_plan a consumer wishes to enroll in. The repayment_plan must be one of the supported IDR plans:

  • save
  • repaye replaced by save
  • paye
  • ibr
  • new_ibr
  • icr

These strings correspond to the repayment_plan.type attribute found on a RepaymentOption returned from the Repayment Options endpoint. There is only one ibr plan currently offered, but it has different terms depending on when the consumer first took out a loan—hence the 2009 and 2014 distinctions. This endpoint will accept either ibr (2009) or new_ibr (2014) and funnel those into a single ibr option to streamline the workflow of passing results from Repayment Options into here.

Signed at

The signed_at field is our confirmation that a Partner (that's you!) has obtained the necessary permissions from a consumer to make enrollment filings on their behalf. Partners are responsible for obtaining this permission from their consumers. Usually a brief line of text near the submission button indicating to the effect of "by clicking Submit you authorize us and our affiliates to request the necessary changes to your Repayment Plan." But don't just copy that! Be sure to consult your lawyer first. This request will return a 422 Unprocessable Entity if the signed_at param is nil.

Unprocessable Enrollments

Sometimes, our internal review catches enrollments that should not be processed. This could be because of a large discrepancy between a consumer's reported AGI and the AGI on their supplied Income Certification, or perhaps the consumer requested enrollment in a plan that raises their monthly payment, total cost, and repayment term (ie, it's an all-around worse plan). In that case, we mark an enrollment as unprocessable. This is very similar to the cancelled status, with the difference being who is taking the action—only a consumer may cancel an enrollment, whereas a Payitoff administrator marks an enrollment as unprocessable.