PEZESHA APIs
  • Pezesha (means capital enabler)
  • Get Started
    • Authentication
    • Errors & Status Codes
  • User Registration
  • Terms & Conditions
  • Opt Out
  • Data Ingestion
  • Loan Offers
  • Loan Application
  • Loan Status
  • Loan History
  • Active Loans
  • Loan Repayment Schedule
  • Pezesha Wallet
    • Loan Confirmation
    • Loan Repayment
  • Pezesha Mpesa STK
  • FAQs
Powered by GitBook
On this page

Was this helpful?

User Registration

Use this endpoint to register borrowers, merchants or agents onto PEZESHA

Pezesha ID

Make sure to persist customer_id as you will need this during loan application (pezesha_id)

Register Merchant

POST {{BASE_URL}}/mfi/v1/borrowers

This endpoint allows you to register merchant on to PEZESHA

Headers

Name
Type
Description

Authentication*

string

Authentication token generated from Authentication Endpoint

Request Body

Name
Type
Description

terms

boolean

User has accepted Pezesha Ts&Cs

location

string

Location of merchant business

merchant_reg_date

string

Date Merchant was first registered in Pezesha partner's system

merchant_id

string

Merchant ID in partner's system

email

string

User's email ID

dob

string

Date of Birth (Y-m-d format)

phone

string

User's phone number

full_names

string

Full Names

national_id

string

National ID Number

other_phone_nos

string[]

Other phone numbers tied to merchant

geo_location.long

string

geo_location.lat

string

meta_data

array

Additional data requested by Pezesha in Key Value Pairs

channel

string

The Client Name shared by Pezesha

{
   "error":false,
   "status":200,
   "response_code":0,
   "data":{
      "customer_id":1,
      "customer_names":"John",
      "customer_identification":"292309489",
      "customer_phoneno":"0721234567"
   }
}
{
  "error": true,
  "status": 422,
  "message": {
	"phone": [
  	"The phone field is required."
	]
  }
}
{
   "full_names":"John Doe",
   "phone":"254721XXXXXX",
   "other_phone_nos":[
      "25471XXXXXXX",
      "25472XXXXXXXX"
   ],
   "national_id":"12311313",
   "dob":"1999-01-01",
   "email":"",
   "merchant_id":"",
   "merchant_reg_date":"",
   "location":"",
   "geo_location":{
      "long":"",
      "lat":""
   }
}{
   "full_names":"John Doe",
   "phone":"254721XXXXXX",
   "other_phone_nos":[
      "25471XXXXXXX",
      "25472XXXXXXXX"
   ],
   "national_id":"12311313",
   "dob":"1999-01-01",
   "email":"",
   "merchant_id":"",
   "merchant_reg_date":"",
   "location":"",
   "geo_location":{
      "long":"",
      "lat":""
   }
}{
   "full_names":"John Doe",
   "phone":"254721XXXXXX",
   "other_phone_nos":[
      "25471XXXXXXX",
      "25472XXXXXXXX"
   ],
   "national_id":"12311313",
   "dob":"1999-01-01",
   "email":"",
   "merchant_id":"",
   "merchant_reg_date":"",
   "location":"",
   "geo_location":{
      "long":"",
      "lat":""
   }
}{
   "full_names":"John Doe",
   "phone":"254721XXXXXX",
   "other_phone_nos":[
      "25471XXXXXXX",
      "25472XXXXXXXX"
   ],
   "national_id":"12311313",
   "dob":"1999-01-01",
   "email":"",
   "merchant_id":"",
   "merchant_reg_date":"",
   "location":"",
   "geo_location":{
      "long":"",
      "lat":""
   }
}wddwe{
   "full_names":"John Doe",
   "phone":"254721XXXXXX",
   "other_phone_nos":[
      "25471XXXXXXX",
      "25472XXXXXXXX"
   ],
   "national_id":"12311313",
   "dob":"1999-01-01",
   "email":"",
   "merchant_id":"",
   "merchant_reg_date":"",
   "location":"",
   "geo_location":{
      "long":"",
      "lat":""
   }
}{
   "full_names":"John Doe",
   "phone":"254721XXXXXX",
   "other_phone_nos":[
      "25471XXXXXXX",
      "25472XXXXXXXX"
   ],
   "national_id":"12311313",
   "dob":"1999-01-01",
   "email":"",
   "merchant_id":"",
   "merchant_reg_date":"",
   "location":"",
   "geo_location":{
      "long":"",
      "lat":""
   }
}
{
   "channel": "Partner Name",
   "full_names":"John Doe",
   "phone":"254721XXXXXX",
   "other_phone_nos":[
      "25471XXXXXXX",
      "25472XXXXXXXX"
   ],
   "national_id":"12311313",
   "dob":"1999-01-01",
   "email":"example@gmail.com",
   "gender":"Female",
   "merchant_id":"",
   "merchant_reg_date":"",
   "location":"",
   "county":"",
   "sub_county":"",
   "alternative_customer_phoneno":"",
   "next_of_kin_name":"",
   "next_of_kin_phoneno":"",
   "geo_location":{
      "long":"",
      "lat":""
   },
   "meta_data":[
      {
         "key":"",
         "value":""
      }
   ]
}

PreviousErrors & Status CodesNextTerms & Conditions

Last updated 1 year ago

Was this helpful?