Skip to main content

Overview

The Carbon Lending API allows fintech partners to originate business loans for their own end-customers. The full flow — from customer enrollment through repayment — is orchestrated via REST API with webhook notifications at every lifecycle event.

Flow

Step-by-step


Key Concepts

Amounts

All monetary values are in kobo. Divide by 100 to get Naira.

application_id vs loan_id

  • application_id — UUID created when POST /v1/loans/apply succeeds. Used in all loan operation routes (:applicationId).
  • loan_id — Populated after disbursement. Used only for repayment routes (:loanId).

Idempotency

Resending the same key returns the existing record rather than creating a duplicate.

Board Resolution

Required for all business customers except sole proprietors. Two-step process:
  1. Upload file via POST /v1/loans/:id/documents with file_tag = BOARD_RESOLUTION_DOC — save the file_url.
  2. Pass file_url to POST /v1/loans/:id/board-resolution.

Webhooks

Subscribe to real-time loan events via the webhook system. Each status change fires an event to your registered webhook URL. See the Webhooks guide for delivery details and retry behaviour.