Rest API Documentation (UAT)

Introduction

Base URL https://uat.firstcentralcreditbureau.com/firstcentralrestv2/

Integration Steps FirstCentral Credit Bureau API consumption requires three steps only which are:

  1. Login
  1. Consumer Matching / Commercial Matching
  1. Report Generation

Step 1: Login

Login using username and password to get DataTicket

💡
https://uat.firstcentralcreditbureau.com/firstcentralrestv2 /login

Headers

content-type

application/json

Body

username, password

Request: Login sample

{
	"username":"demo",
	"password":"demo@123"
	}

Replace the test credentials with the live one sent to you from the firstCentral team.

Sample Response: Login

[
	{
	"DataTicket": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQiOiIyNyIsInN1Ym5hbWUiOiJGaXJzdENlbnRyYWwgRGF0Y
	SIsInVzZXJuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxNjU2Nzg0OTY1LCJleHAiOjE2NTY3OTU3NjUsImlhdCI6MTY1Nj
	c4NDk2NX0.ipmyPB5mpuEBR9wkPvgF58EXgArF7X1DUEsjacKGuS0"
	}
	]
💡
The ticket expires in 5 hours. You can use the validate endpoint to check if the ticket is still valid.

Check Validity Of Token

To check the validity of a ticket call the endpoint below passing the ticket

https://uat.firstcentralcreditbureau.com/firstcentralrestv2 /ValidateTicket

Request: Validate Ticket

{
	"DataTicket":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQiOiIyNyIsInN1Ym5hbWUiOiJGaXJzdENlbnRyYWwgRGF0YSIsInVzZX
	JuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxNjU2Nzg0OTY1LCJleHAiOjE2NTY3OTU3NjUsImlhdCI6MTY1Njc4NDk2NX
	0.ipmyPB5mpuEBR9wkPvgF58EXgArF7X1DUEsjacKGuS0",
	}

Response: Validate Ticket

[
	{
	"IsTicketValidResult": "True"
	}
	]
💡
If you are calling the login endpoint each time you make a call for instance or the ticket was generated within 5 hours then there’s no need to call this endpoint

Step 2: Consumer Match or Commercial Match

This endpoint simply searches the database for a match using the search parameter passed.

💡
Consumer Match is for Individuals while Commercial Match is for Businesses

https://uat.firstcentralcreditbureau.com/firstcentralrestv2 /ConnectConsumerMatch

https://uat.firstcentralcreditbureau.com/firstcentralrestv2 /ConnectCommercialMatch

Headers

Content-type

application/json

Body Params for Consumer Match

Request sample 1: Consumer Match (Using BVN)

{
	"DataTicket":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQiOiIyNyIsInN1Ym5hbWUiOiJGaXJzdENlbnRyYWwgRGF0YSIsInVzZX
	JuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxNjU2Nzg0OTY1LCJleHAiOjE2NTY3OTU3NjUsImlhdCI6MTY1Njc4NDk2NX
	0.ipmyPB5mpuEBR9wkPvgF58EXgArF7X1DUEsjacKGuS0",
	"EnquiryReason":"Test",
	"ConsumerName":"",
	"DateOfBirth":"",
	"Identification":"22471069115",
	"Accountno":"",
	"ProductID":"45"
	}

Request sample 2: Consumer Match (Using Name + Date of Birth)

{
	"DataTicket":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQiOiIyNyIsInN1Ym5hbWUiOiJGaXJzdENlbnRyYWwgRGF0YSIsInVzZX
	JuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxNjU2Nzg0OTY1LCJleHAiOjE2NTY3OTU3NjUsImlhdCI6MTY1Njc4NDk2NX
	0.ipmyPB5mpuEBR9wkPvgF58EXgArF7X1DUEsjacKGuS0",
	"EnquiryReason":"Test Run",
	"ConsumerName":"",
	"DateOfBirth":"12/12/1950",
	"Identification":"",
	"Accountno":"",
	"ProductID":"45"
	}

Response: Consumer Match

[
	{
	"MatchedConsumer": [
	{
	"MatchingEngineID": "178456248",
	"EnquiryID": "39059388",
	"ConsumerID": "2599049",
	"Reference": "C39059388-2599049",
	"IDNo": null,
	"PassportNo": null,
	"PencomIDno": null,
	"VoterID": null,
	"DriversLicenseNo": null,
	"FirstName": "Testi",
	"Surname": null,
	"SecondName": "Amos",
	"OtherNames": "",
	"Address": "College Road Abaro Aladje",
	"BirthDate": "1977-01-26",
	"GenderInd": null,
	"AccountNo": null,
	"TelePhoneNumber": "",
	"MatchingRate": "90"
	}
	]
	}
	]

💡
When searching with BVN, pass the Name, DOB and AccountNo parameter as an empty string. When searching with Name & DOB, pass the BVN and AccountNo has an empty string. Although BVN is recommended because of its uniqueness, using Name and Date of birth would return a larger response than BVN as it is more available. You can also search with telephone number, or driver's license number by passing it as identification.

Body Params for Commercial Match

Request sample 1: Commercial Match (Using Business name)

{
	"DataTicket":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQiOiIyNyIsInN1Ym5hbWUiOiJGaXJzdENlbnRyYWwgRGF0YSIsInVzZX
	JuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxNjU2ODU0ODE3LCJleHAiOjE2NTY4NjU2MTcsImlhdCI6MTY1Njg1NDgxN3
	0.4Vbtt4rHWO8Py7VbadXZEX1P35Apdknrwql7FMzCtKQ",
	"EnquiryReason":"TEST",
	"BusinessName":"OCH TEST DUMMY",
	"BusinessRegistrationNumber":"",
	"AccountNumber":"",
	"ProductID":"47"
	}

Request sample 2: Commercial Match (Using Business Registration Number)

{
	"DataTicket":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQiOiIyNyIsInN1Ym5hbWUiOiJGaXJzdENlbnRyYWwgRGF0YSIsInVzZX
	JuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxNjU2ODU0ODE3LCJleHAiOjE2NTY4NjU2MTcsImlhdCI6MTY1Njg1NDgxN3
	0.4Vbtt4rHWO8Py7VbadXZEX1P35Apdknrwql7FMzCtKQ",
	"EnquiryReason":"TEST",
	"BusinessName":"",
	"BusinessRegistrationNumber":"RCTEST01",
	"AccountNumber":"",
	"ProductID":"47"
	}

Response: Commercial Match

[
	{
	"ConnectCommercialMatch": [
	{
	"MatchingEngineID": "178456266",
	"SubscriberEnquiryID": "39059404",
	"CommercialID": "853535",
	"BusinessName": "OCH TEST DUMMY 5",
	"TradingName": null,
	"RegistrationNo": "",
	"TaxIDNo": "NIL",
	"CommencementDate": null,
	"IncorporationDate": "Jul 30 2018 12:00AM",
	"AccountNo": "1021392523",
	"TelePhoneNumber": null
	},
	{
	"MatchingEngineID": "178456267",
	"SubscriberEnquiryID": "39059404",
	"CommercialID": "853552",
	"BusinessName": "OCH TEST DUMMY 4",
	"TradingName": null,
	"RegistrationNo": "",
	"TaxIDNo": "NIL",
	"CommencementDate": null,
	"IncorporationDate": "Jul 30 2018 12:00AM",
	"AccountNo": "1021392516",
	"TelePhoneNumber": null
	},
	{
	"MatchingEngineID": "178456268",
	"SubscriberEnquiryID": "39059404",
	"CommercialID": "916135",
	"BusinessName": "OCH TEST DUMMY 2",
	"TradingName": null,
	"RegistrationNo": "",
	"TaxIDNo": "NIL",
	"CommencementDate": null,
	"IncorporationDate": "Jul 30 2018 12:00AM",
	"AccountNo": "1021392499",
	"TelePhoneNumber": null
	}
	]
	}
	]

Step 3: Generate Product Report

Individual / Consumer Reports

Below is a list of product names and endpoints for various individual report searches. Please scroll down to view sample request payload.

ProductIDReport NameEnd point
43Consumer Basic Tracehttps://uat.firstcentralcreditbureau.com/firstcentralrestv2/GetConsumerBasicTraceReport
44Consumer Basic Credithttps://uat.firstcentralcreditbureau.com/firstcentralrestv2/GetConsumerBasicCreditReport
44Consumer Basic Credit Binaryhttps://uat.firstcentralcreditbureau.com/firstcentralrestv2/GetConsumerBasicCreditBinaryReport
45Consumer Detailed Credithttps://uat.firstcentralcreditbureau.com/firstcentralrestv2/GetConsumerFullCreditReport
63Consumer Primehttps://uat.firstcentralcreditbureau.com/firstcentralrestv2/GetConsumerPrimeReport
50Xscore Consumer Detailed Credithttps://uat.firstcentralcreditbureau.com/firstcentralrestv2/GetXScoreConsumerFullCreditReport
50Xscore Consumer Detailed Credit Binaryhttps://uat.firstcentralcreditbureau.com/firstcentralrestv2/GetXScoreConsumerFullCreditBinaryReport
64Xscore Consumer Primehttps://uat.firstcentralcreditbureau.com/firstcentralrestv2/GetXScoreConsumerPrimeReport
70iScorehttps://uat.firstcentralcreditbureau.com/firstcentralrestv2/GetiScoreReport
70iScore Binaryhttps://uat.firstcentralcreditbureau.com/firstcentralrestv2/GetiScoreBinaryReport

Headers

content-type

application/json

Body Params for Individual reports

Request: Individual Report

{
	"DataTicket":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQiOiIyNyIsInN1Ym5hbWUiOiJGaXJzdENlbnRyYWwgRGF0YSIsI
	nVzZXJuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxNjU2Nzk5NjIzLCJleHAiOjE2NTY4MTA0MjMsImlhdCI6MTY1N
	jc5OTYyM30.7V4rFGMqU9dbgzmbWo0PA1InE0h5MQXCZjaXjxYHZFU",
	"consumerID":"13352613",
	"EnquiryID":"39059388",
	"consumerMergeList":"13352613,14713314",
	"SubscriberEnquiryEngineID":"178456248"
	}

Business / Commercial Reports

Below is a list of product names and endpoints for various business report searches. Please scroll down to view sample request and response payload.

ProductIDReport NameEnd point
46Commercial Basic Credithttps://uat.firstcentralcreditbureau.com/firstcentralrestv2/GetCommercialBasicCreditReport
46Commercial Basic Credit Binaryhttps://uat.firstcentralcreditbureau.com/firstcentralrestv2/GetCommercialBasicCreditBinaryReport
47Commercial Full Credithttps://uat.firstcentralcreditbureau.com/firstcentralrestv2GetCommercialFullCreditReport

Body Params for Business reports

Request: Business Report

{
	"DataTicket":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQiOiIyNyIsInN1Ym5hbWUiOiJGaXJzdENlbnRyYWwgRGF0YSIsI
	nVzZXJuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxNjU2Nzk5NjIzLCJleHAiOjE2NTY4MTA0MjMsImlhdCI6MTY1N
	jc5OTYyM30.7V4rFGMqU9dbgzmbWo0PA1InE0h5MQXCZjaXjxYHZFU",
	"commercialID":"13352613",
	"EnquiryID":"39059388",
	"commercialMergeList":"13352613,14713314",
	"SubscriberEnquiryEngineID":"178456248"
	}

Kindly note that SubscriberEnquiryEngineID is returned in the consumermatch and commercialmatch as MatchingEngineID

Other Available Endpoints

💡
You can use the consumerreports or the commercialreports endpoint to fetch any of the previously listed consumer or commercial reports by passing the appropriate productid for the report required. /consumerreports for individuals and /commercialreports for business search

Get all Consumer/Individual reports

productid for report required.

https://uat.firstcentralcreditbureau.com/firstcentralrestv2/consumerreports

Headers

content-type

application/json

The above endpoints would return any of the consumer report excluding the binary reports depending on the productid passed.

Body Params for Consumer reports

Request: Consumer Report

{
	"DataTicket":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQiOiIyNyIsInN1Ym5hbWUiOiJGaXJzdENlbnRyYWwgRGF0YSIsI
	nVzZXJuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxNjU2Nzk5NjIzLCJleHAiOjE2NTY4MTA0MjMsImlhdCI6MTY1N
	jc5OTYyM30.7V4rFGMqU9dbgzmbWo0PA1InE0h5MQXCZjaXjxYHZFU",
	"consumerID":"13352613",
	"EnquiryID":"39059388",
	"consumerMergeList":"13352613,14713314",
	"SubscriberEnquiryEngineID":"178456248",
	"productid":45
	}

Get all Commercial/Business Reports

productid for report required.

https://uat.firstcentralcreditbureau.com/firstcentralrestv2commercialreports

Headers

content-type

application/json

Body Params for Commercial reports

Request: Commercial Report

{
	"DataTicket":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQiOiIyNyIsInN1Ym5hbWUiOiJGaXJzdENlbnRyYWwgRGF0YSIsI
	nVzZXJuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxNjU2Nzk5NjIzLCJleHAiOjE2NTY4MTA0MjMsImlhdCI6MTY1N
	jc5OTYyM30.7V4rFGMqU9dbgzmbWo0PA1InE0h5MQXCZjaXjxYHZFU",
	"commercialID":"13352613",
	"EnquiryID":"39059388",
	"commercialMergeList":"13352613,14713314",
	"SubscriberEnquiryEngineID":"178456248",
	"productid":47
	}

Get KYC Report

Below is the endpoint for the KYC (Know Your Customer) product.

KYC Report 66

https://uat.firstcentralcreditbureau.com/firstcentralrestv2/GetConsumerKYCVerificationReport

Body Params for Consumer KYC report

💡
The request body for Consumer KYC report can be seen below.

Request: Generate Consumer KYC Report

{
	"DataTicket":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQiOiIyNyIsInN1Ym5hbWUiOiJGaXJzdENlbnRyYWwgRGF0YSIsI
	nVzZXJuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxNjU2Nzk5NjIzLCJleHAiOjE2NTY4MTA0MjMsImlhdCI6MTY1N
	jc5OTYyM30.7V4rFGMqU9dbgzmbWo0PA1InE0h5MQXCZjaXjxYHZFU",
	"EnquiryReason":"Test",
	"Identification":"22471069115",
	"ProductID":"45"
	}

Going Live

💡
To go live, contact the firstCentral team for live credentials and instruction email: sales@firstcentralcreditbureau.com || phone number: 0817 837 7643