Skip to main content
POST
Enroll Customer

Overview

Registers an existing customer with the Carbon lending engine. The customer must already exist (created via POST /v1/customers) and must have a BVN and an active wallet account. This call is idempotent — sending the same customer_id twice returns the existing enrollment with 200 OK instead of creating a duplicate.

Request

Method: POST
URL: /v1/loans/customers/enroll

Parameters

Request Body

Response

201 — New Enrollment

200 — Already Enrolled

Error Responses

Authorizations

apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

x-carbon-key
string
required

Body

application/json

Provide the required values for the request body.

customer_id
string
required

UUID of the customer to enroll

Example:

"1732ca47-42b2-4990-a65d-c369e934eed3"

Response

200 - application/json

Successful response

The response is of type object.