Skip to Content
Parent Loans APIOverview

Parent Loans API

Endpoints parents use to apply for school fee financing. Every call here requires a Parent JWT, pass it as Authorization: Bearer {parentAccessToken}.

Get that token either from a normal parent login, or from the Partner API’s Create parent SSO session, which lets a parent skip an EdPay login screen entirely.

Try it in your browser

The same shared credentials from the Partner API section power the “Try it” boxes here, just fill in Parent access token below (or on the Partner API overview) and it’s reused on every page in this section.

Playground credentials

Stored only in your browser (localStorage) and sent only to the URL shown on each request, never anywhere else. Fill this in once; every “Try it” box on this site reuses it.

The typical journey

  1. Verify BVN (3 steps under /api/auth/bvn/*), mandatory before credit assessment. Skip this if login/SSO already returned isBvnVerified: true. Keep the same sessionId across all three calls.
  2. Credit assessment: Mono Connect (/mono/exchange → /credit-assessment/mono) or bank-statement upload → returns immediately with status Processing.
  3. Poll the assessment until it’s Completed or Failed.
  4. Upload docs via POST /api/uploads, then submit the loan (single or batch) with the returned S3 keys (utilityBill + idCard for K-12).
  5. Accept terms → Setup mandate (Mono authorization URL) → Verify mandate.
  6. Track progress via my loans, dashboard, loan detail, repayment schedule.
  7. Optionally: cancel the application, attach legacy post-submit documents, or record manual payments.

Key enums

FieldValues
Credit assessment statusProcessing, Completed, Failed
Credit assessment ratingExcellent, Good, Fair, Poor, Ineligible
Loan statusSubmitted, UnderReview, PendingManualReview, Approved, Rejected, Disbursed, Active, Closed, Cancelled
Installment statusScheduled, Processing, Successful, Failed, Retrying, Waived
Manual payment statusPending, Confirmed, Rejected
Loan availableActionsCancelLoan, Reapply, ContactSupport, MakePayment, DownloadStatement

Response shape

Same envelope as the Partner API:

{
  "success": true,
  "message": "Request successful",
  "data": { },
  "errors": [],
  "statusCode": 200
}

What’s in this section

  • BVN Verification: the mandatory 3-step BVN check before financing can start.
  • Credit Assessment: Mono Connect or bank-statement scoring, plus polling.
  • Loan Application: submit (with upload keys), accept terms, set up / verify the repayment mandate, or apply for multiple children at once.
  • Loan Tracking: list, dashboard summary, detail, and cancellation.
  • Documents & Payments: legacy post-submit docs, manual payment claims, payment history, and the repayment schedule.
Loan Status & Parent SSOBVN Verification