Enrollment

🚧
Use EnrollmentPayload 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

Property	Type	Format	Description
`created_at`	`string`	`date-time`	A `DateTime` string indicating when the `Enrollment` was created.
`estimated_approval_date`	`string`	`date`	The date on which we expect a valid Enrollment to be accepted by Servicer(s).
`id`	`integer`	`int64`	The Payitoff ID value of this `Enrollment`
`repayment_plan`	`object`	`RepaymentPlanSummary`	An object indicating what IDR Plan a `Borrower` is enrolling in.
`status`	`object`	`EnrollmentStatus`	An object providing details on the status of this `Enrollment`.
`uuid`	`string`	`uuid`	A unique UUID identifier for this `Enrollment`.

Example

{
  "created_at": "2021-02-22T17:56:08.368Z",
  "estimated_approval_date": "2021-02-22",
  "id": 123,
  "repayment_plan": {
    "description": "Pay as You Earn",
    "type": "paye"
  },
  "status": {
    "updated_at": "2021-02-22T17:56:08.368Z",
    "description": "Enrollment Pending",
    "type": "pending"
  },
  "uuid": "df6a5264-1081-4494-bf04-ee4139ad82d3"
}

🚧Use EnrollmentPayload to create an Enrollment

Schema Definition

Example

🚧
Use `EnrollmentPayload` to create an `Enrollment`