Skip to main content

Sapphire Credit | Developer home page

Support
Dashboard
Dashboard

API Documentation

Introduction

Payday Loan

GET
View loan application by IPPIS number
GET
Check eligibility by IPPIS number
GET
View invoice details
POST
Create a new loan
GET
View loan details
PATCH
Accept a loan offer
POST
Reject a loan offer
POST
Login to payday loan service
POST
Onboard user via USSD
GET
Get all loan products

Accounts

GET
Get account information
POST
Initiate Account Linking
POST
Create a payment mandate

Admin

GET
Get collections daily report
GET
Get collections since inception report
GET
Get daily report
GET
Get device report
GET
Get drop off report
GET
Get since inception report
POST
Approve agent KYC
GET
Get All Customers In Ascending Order
GET
Get All Customer KYC Status
GET
Get Approved Refreees
GET
Compare DOB MisMatch
POST
Create Customer Wallet
GET
Fetch all customer drop off points
GET
Fetch all customer drop off record
GET
Get All Mbes With Transaction History
GET
Get Mbe With Customers
GET
Get customers record
GET
Get Rejected Refreees
GET
Get All Sentinel Customers
GET
Get Unapproved Refreees
POST
Update Customer KYC Status
POST
Verify Customer Phone
GET
Get all device list
GET
Get device data
GET
Get device by device name
PUT
Update device status to false by device name
GET
Get device record
GET
Get device by status
GET
Get device by id
POST
Invite an admin
POST
Accept an admin invitation
GET
Get approved loans
GET
Get loan data
GET
Get defaulted loans
GET
Get enrolled loans
GET
Get loan record
POST
Admin login endpoint
POST
Logout
GET
Fetch all products
GET
View Admin Profile
POST
Reject agent KYC
POST
Create a new store
GET
View Paid Stores
GET
View all stores
GET
View Unpaid Stores
PUT
Update Store Payment Status
PUT
Update store details
PATCH
Patch v1adminstores archive
POST
Suspend Users

Agent

POST
Validate and update bank details
POST
Post v1agentchange password
DEL
Delete Agent Account
DEL
Delete Erp Store
GET
Export All MBE Details to Excel
GET
Get All MBE Agents
GET
List All Banks
GET
Get Agent Profile
POST
Assign Agent to Store Branch
GET
Get All Stores
GET
List Vfd Banks
POST
Verify Agent's Guarantor
POST
Submit Agent KYC Step 1
POST
Submit Agent KYC Step 2 (Guarantors)
GET
Fetch Agent's Customer Loan
GET
Fetch Agent's Customer Loan by loanId
GET
Fetch Agent's Customer Loan by customerId
POST
Logout Agent
PUT
Update your profile
POST
Post v1agentpassword reset
POST
Post v1agentpassword resetcomplete
POST
Resend forgot-password OTP
POST
Post v1agentpassword resetverify
POST
Validate Refresh Token
POST
Register a new agent
POST
Resend OTP
POST
Sign in to Agent Account
GET
Find Agent by ID
PUT
Update Agent Status
POST
Upload Agent Profile Image
POST
Verify Agent OTP

Agent ERP

GET
Sync & fetch item balances
GET
Sync & fetch item balances
GET
Fetch item price (ERP only)
GET
List items (ERP only)
GET
Sync & fetch material requests
POST
Create material request in ERP
POST
Create sales invoice in ERP
GET
Sync & fetch stock transfers
POST
Create stock transfer in ERP
PUT
Update ERP transfer status
GET
List warehouses (ERP only)

Application

POST
Account eligibility
POST
Create a customer
POST
Customer eligibility
GET
Get customer by id
DEL
Delete customer
POST
Device enrollment
POST
Get device status
POST
Submit Down Payment
POST
Submit Customer KYC
POST
Submit Loan Data
GET
Get loan record by id
POST
Log drop off
PUT
Update customer kyc
POST
Verify down payment
GET
Verify customer mandate
POST
Verify card tokenization

Bank Statement

GET
Get Statement Bank List
GET
Get Linked Account Statement
POST
Get Bank Statement

Credit Worthiness

POST
Validate BVN Credibility
POST
Determine credit credibility
POST
Fetch credit history
POST
Check Loan Eligibility

Device-Locks

PUT
Bulk Lock Devices
POST
Get Device Status
POST
Unlock Device

Loan Management

POST
Add a new borrower
POST
Create a loan
DEL
Delete a borrower
DEL
Delete a loan
GET
Get a single borrower
GET
Get a single loan
PUT
Update a loan

Payments

GET
VFD Bank List
GET
Get Paystack Banks
POST
Charge Card
POST
Generate Payment Link
POST
Store Payout
GET
Verify Payment

Powerflex

POST
Calculate solar power quote
POST
Calculate custom solar power quote
POST
Calculate quote for predefined package
GET
Get all available packages
GET
Get package details

Resources

GET
Get Device by ID
GET
Get All Devices
GET
Get Devices On Loan With Old ID
GET
Get Devices Without Old ID
GET
Fetch Mbe Promoter
GET
Get Map Stores
POST
Get Powerflex Quote
GET
Get Solar Packages
GET
Get Store by Name
GET
Get Store by ID
GET
Get All Stores
GET
Get Stores in Nigeria
POST
Submit to Relay API
POST
Send Support Message

Sales

GET
Get today’s sales total
GET
Get sale history (filterable)
GET
Get this month’s sales
POST
Record a new sale (commission)
POST
Record a withdrawal
GET
Get top selling devices
GET
Get last 7 days sales
GET
Get total withdrawable commission

Sentinel

POST
Create a new sentinel customer
POST
Post v1sentinelsentinelcustomerresend
POST
Post v1sentinelsentinelcustomerverify
GET
Get v1sentinelsentineldevices
GET
Get v1sentinelsentinelstores

Powerflex

Calculate custom solar power quote

Calculate solar power quote based on custom energy requirements and usage patterns

Was this page helpful?

Calculate solar power quote Calculate quote for predefined package

⌘I

x github linkedin