Buy credit life cover in one call
POST
/credit-life/onboard
Authorizations
BearerAuth
Type
HTTP (bearer)
Request Body
application/json
JSON "name": "string", "productId": "string", "clientId": 0, "client": { "name": "string", "contactPerson": "string", "contactPersonPhoneNumber": "string", "registrationNumber": "string", "sector": "string", "phoneNumber": "string", "email": "string", "postalAddress": "string", "physicalAddress": "string", "taxPayerId": "string" }, "startDate": "string", "endDate": "string", "currency": "string", "exchangeRate": 0, "loans": [ { "fullName": "string", "nrcNumber": "string", "dateOfBirth": "string", "amount": 0, "startDate": "string", "endDate": "string", "partnerLoanReference": "string", "interestRate": 0 } ], "payment": { "reference": "string", "mobileMoneyAccountNumber": "string", "cardDetails": { "city": "string", "country": "string", "address": "string", "zip": 0 } }
{
}
Responses
The client, the policy, and the batch if borrowers were sent. The batch is already on risk with its premium outstanding — cover does not wait for the money. payment is present only if you asked for it, and comes back Pending: mobile money settles by callback, so poll GET /payments/transactions/{reference}/status and the premium is receipted automatically once the gateway confirms. If a payment could not be started the cover still stands and the reason is in paymentError.
application/json
JSON "policy": { "id": "string", "name": "string", "policyNumber": "string", "status": "string", "currency": "string", "startDate": "string", "endDate": "string", "freeCoverLimit": 0 }, "schedule": { "id": "string", "number": "string", "status": "string", "type": "string", "totalLoans": 0, "loanAmount": 0, "netPremium": 0, "levy": 0, "grossPremium": 0, "amountReceipted": 0, "outstandingPremium": 0, "currency": "string", "createdAt": "string", "loans": [ { "id": { }, "clientName": { }, "nrcNumber": { }, "amount": { }, "coveredAmount": { }, "premiumRate": { }, "netPremium": { }, "levy": { }, "grossPremium": { }, "status": { }, "startDate": { }, "endDate": { }, "partnerLoanReference": { }, "interestRate": { } } ], "skipped": [ { "nrcNumber": { }, "partnerLoanReference": { }, "existingLoanId": { } } ] }, "corporateClientId": "string", "payment": { "status": "string", "message": "string", "txnId": "string", "referenceId": "string", "redirectUrl": "string", "warnings": [ "string" ] }
{
}