EnrollmentPayload

To create an Enrollment for a Borrower, use our Create an Enrollment API endpoint with an EnrollmentPayload.

NOTE: The following fields are required:

repayment_plan
signature

🚧
Use EnrollmentPayload for to create an Enrollment
When creating Enrollment objects via API, send an EnrollmentPayload as your request body. You'll receive an Enrollment as a response.

Schema Definition

Properties in bold are required.

Property	Type	Format	Description
`repayment_plan`	`string`	`save` `repaye` `ibr` `new_ibr` `icr`	The Income-Driven Repayment Plan a borrower wishes to enroll in. Should be a `repayment_plan.type` value from a `RepaymentOption`.
`signature`	`boolean`		Does the borrower grant the Partner company (you) and Payitoff the right to process and submit an IDR Enrollment form on their behalf?
`cursive_signature`	`boolean`		Should the borrower's signature be in cursive or typed format on the submitted IDR Enrollment form? Defaults to `true`.

Example

{
  "repayment_plan": "save",
  "signature": true
}

Error Responses

Not all borrowers are eligible to enroll in an IDR plan. In the event a borrower is not eligible, a 409 Conflict status will be returned along with the reason, for example:

{
  "error": {
    "title": "Conflict",
    "detail": "Consumers with income (from wages or unemployment benefits) must upload income certification before enrolling in plan"
  }
}

Possible reasons include:

Consumer name, phone, ssn, and address are required. (in this case, first update the borrower via the Update Borrower API endpoint)
Spouse name, ssn, and date of birth are required when the spouse has Federal student loans. (in this case, first update the spouse via the Update Borrower API endpoint)
Active students cannot submit Enrollment Requests
One or more loans have unrecognized Servicers. Please update their aliases and try again.
A consumer must have loans in order to change their Repayment Plan (in case of missing loans, add them via the Create Loans API endpoint or have the borrower link their loans via Nexus.link)
A consumer must have eligible loans (i.e. Federal loans. Private loans are not eligible for IDR plans.)
Consumer with loans in default may not enroll in a new plan
Consumers with income (from wages or unemployment benefits) must upload income certification before enrolling in plan (in this case, update the borrower via the Update Borrower API endpoint with an income_certification)
Spouses with income (from wages or unemployment benefits) of consumers who file taxes jointly must upload income certification before enrolling in plan (in this case, update the spouse via the Update Borrower API endpoint with an income_certification)
All servicers must be supported in order to generate or submit an enrollment

🚧Use EnrollmentPayload for to create an Enrollment

Schema Definition

Example

Error Responses

🚧
Use `EnrollmentPayload` for to create an `Enrollment`