Blacklist Blacklist
cURL

Introduction

Welcome to the Blacklist API! You can use our API to upload or get information of chronic debtors.

Blacklist API are HTTP based RESTful APIs. API request and response format are in JSON.

Authentication

To authorize, use this code:

curl --request POST \
curl "https://blacklistng.com/api/"
  -H "Authorization: YOUR-API-KEY"

Make sure to replace YOUR-API-KEY with your API key.

Blacklist authenticates your API requests using your account’s API keys. If you do not include your key when making an API request or use one that is incorrect or outdated, blacklist returns an error.

Your API keys are available in the Dashboard by navigating to Profile - > API

Include API key in all API requests to the server in a header that looks like the following:

Blacklist Search

Sample Request:

curl --request GET \
--url https://blacklistng.com/api/?bvn=bvnnumber -H "Authorization: YOUR-API-KEY"

The above command returns JSON structured like this: {Success or error}

			    

Success

Error

This shows how to check your customer's BVN

HTTP Request

GET https://blacklistng.com/api/

Query Parameters

Parameter Required Description
bvn true customer's BVN

We passed the bvn of the customer to the endpoint as a query parameter e.g.
https://blacklistng.com/api/?bvn=bvnnumber

Add Blacklist

Sample Request:

curl --request POST \
--url https://blacklistng.com/api/add -H "Authorization: YOUR-API-KEY" -data '{"name":"John Doe","bvn":1562772282,"phone":"08162727822","email":"[email protected]","gender":"male","loan_amount":14000,"amount_paid":2000,"due_date":"1/20/2020","location":"Lagos"}'

The above command returns JSON structured like this (success / error):

			    

Success

Error

This shows how to add upload blacklist to your dashboard

HTTP Request

POST https://blacklistng.com/api/add

Body Params

Parameter Type Required Description
name string true Custormer Name
bvn int true Custormer BVN
phone string true Custormer Phone
email string true Custormer Email
gender string false Custormer Gender
loan_amount int true Loan Amount Collected
amount_paid int true Amount Paid
due_date string true E.g. 1/20/2020 (m-d-Y)
location string false Custormer City or State

Delete Blacklist

Sample Request:

curl --request POST \
--url https://blacklistng.com/api/delete -H "Authorization: YOUR-API-KEY" -data '{"bvn":1562772282}'

The above command returns JSON structured like this (success / error):

			    

Success

Error

This shows you how to delete a blacklist.

HTTP Request

POST https://blacklistng.com/api/delete

Query Parameters

Parameter Required Description
bvn true customer's BVN

API Response

This describes the Response format for Blacklist APIs

Each REST API request returns a success or error HTTP status code.

Status code Description
200 OK The request succeeded.
404 Not Found The server did not find anything that matches the request URI. Either the URI is incorrect or the resource is not available. For example, no data exists in the database at that key.
500 Internal Server Error A system or application error occurred. Although the client appears to provide a correct request, something unexpected occurred on the server.
503 Service Unavailable The server cannot handle the request for a service due to temporary maintenance.