Introduction
Base URL https://uat.firstcentralcreditbureau.com /firstcentralrestv2
Integration Steps
FirstCentral Credit Bureau API consumption requires three steps only which are:
1. Login
2. Consumer Matching / Commercial Matching
3. Report Generation
Step 1: Login
Login using username and password to get DataTicket
Untitled 3
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.
{
“DataTicket”: “eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQi
SIsInVzZXJuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmI
c4NDk2NX0.ipmyPB5mpuEBR9wkPvgF58EXgArF7X1DUEsjacKGuS0″
}
{
"DataTicket": "eyJhbGciOiJIUzI1NiIsInR5cCI6
IkpXVCJ9.eyJzdWJzY3JpYmVya
WQi
SIsInVzZXJuYW1lIjoiai5pbWFma
WRvbiIsInN5c3RlbXVzZXJpZCI
6IjkxODEyIiwibmJmI
c4NDk2NX0.ipmyPB5mpuEBR
9wkPvgF58EXgArF7X1DUEsjac
KGuS0"
}
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
/ValidateTicket
Request: Login sample
{
“DataTicket”:”eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQiO
JuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxNjU2Nz
0.ipmyPB5mpuEBR9wkPvgF58EXgArF7X1DUEsjacKGuS0″,
}
{
"DataTicket":"eyJhbGciOiJIUzI1
NiIsInR5cCI6IkpXVCJ9.eyJzdW
JzY3JpYmVyaWQiO
JuYW1lIjoiai5pbWFmaWRvbiIsI
nN5c3RlbXVzZXJpZCI6IjkxOD
EyIiwibmJmIjoxNjU2Nz
0.ipmyPB5mpuEBR9wkPvgF5
8EXgArF7X1DUEsjacKGuS0",
}
Request: Login sample
[
{
“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.
/ConnectConsumerMatch
/ConnectCommercialMatch
Headers
Content-Type
application/json
Body Params for Consumer Match
Request: Consumer Match
{
“DataTicket”:”eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQiO
JuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxNjU2Nz
0.ipmyPB5mpuEBR9wkPvgF58EXgArF7X1DUEsjacKGuS0″,
“EnquiryReason”:”Test”,
“ConsumerName”:””,
“DateOfBirth”:””,
“Identification”:”22471069115″,
“Accountno”:””,
“ProductID”:”45″
}
{
"DataTicket":"eyJhbGciOiJIUzI1
NiIsInR5cCI6IkpXVCJ9.eyJzdW
JzY3JpYmVyaWQiO
JuYW1lIjoiai5pbWFmaWRvbiIsI
nN5c3RlbXVzZXJpZCI6IjkxOD
EyIiwibmJmIjoxNjU2Nz
0.ipmyPB5mpuEBR9wkPvgF5
8EXgArF7X1DUEsjacKGuS0",
"EnquiryReason":"Test",
"ConsumerName":"",
"DateOfBirth":"",
"Identification":"22471069115",
"Accountno":"",
"ProductID":"45"
}
Request: 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. BVN however is the recommended search option because of its
uniqueness.
Body Params for Commercial Match
Request: Commercial Match
{
“DataTicket”:”eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQiO
JuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxNjU2OD
0.4Vbtt4rHWO8Py7VbadXZEX1P35Apdknrwql7FMzCtKQ”,
“EnquiryReason”:”TEST”,
“BusinessName”:”OCH TEST DUMMY”,
“BusinessRegistrationNumber”:””,
“AccountNumber”:””,
“ProductID”:”47″
}
{
"DataTicket":"eyJhbGciOiJIUzI1
NiIsInR5cCI6IkpXVCJ9.eyJzdW
JzY3JpYmVyaWQiO
JuYW1lIjoiai5pbWFmaWRvbiIsI
nN5c3RlbXVzZXJpZCI6IjkxOD
EyIiwibmJmIjoxNjU2OD
0.4Vbtt4rHWO8Py7VbadXZEX
1P35Apdknrwql7FMzCtKQ",
"EnquiryReason":"TEST",
"BusinessName":"OCH TEST DUMMY",
"BusinessRegistrationNumber":"",
"AccountNumber":"",
"ProductID":"47"
}
Request: 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 Reports
Below is a list of product names and endpoints for various individual
report searches. Please scroll down to view sample request payload.
Consumer Basic Trace
43
/GetConsumerBasicTraceReport
Consumer Basic Credit
44
/GetConsumerBasicCreditReport
Consumer Basic Credit Binary
44
/GetConsumerBasicCreditBinarReport
Consumer Prime
63
/GetConsumerPrimeReport
Xscore Consumer Detailed Credit
50
/GetXScoreConsumerFullCreditReport
Xscore Consumer Detailed Credit Binary
50
/GetXScoreConsumerFullCreditBinaryReport
Xscore Consumer Prime
64
/GetXScoreConsumerPrimeReport
iScore Binary
70
/GetiScoreBinaryReport
Headers
Content-Type
application/json
Body Params for Individual reports
Request: Individual Report
{
“DataTicket”:”eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQiO
nVzZXJuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxN
jc5OTYyM30.7V4rFGMqU9dbgzmbWo0PA1InE0h5MQXCZjaXjxYHZFU”,
“consumerID”:”13352613″,
“EnquiryID”:”39059388″,
“consumerMergeList”:”13352613,14713314″,
“SubscriberEnquiryEngineID”:”178456248″
}
{
"DataTicket":"eyJhbGciOiJIUzI
1NiIsInR5cCI6IkpXVCJ9.eyJzd
WJzY3JpYmVyaWQiO
nVzZXJuYW1lIjoiai5pbWFmaW
RvbiIsInN5c3RlbXVzZXJpZCI6
IjkxODEyIiwibmJmIjoxN
jc5OTYyM30.7V4rFGMqU9dbg
zmbWo0PA1InE0h5MQXCZjaX
jxYHZFU",
"consumerID":"13352613",
"EnquiryID":"39059388",
"consumerMergeList": "13352613,14713314",
"SubscriberEnquiryEngineID": "178456248"
}
Business 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.
Commercial Basic Credit
46
/GetCommercialBasicCreditReport
Commercial Basic Credit Binary
46
/GetCommercialBasicCreditBinaryReport
Commercial Mini Report
72
/GetCommercialminireport
Commercial Full Credit
47
/GetCommercialFullCreditReport
Body Params for Business reports
Request: Business Report
{
“DataTicket”:”eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQiO
nVzZXJuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxN
jc5OTYyM30.7V4rFGMqU9dbgzmbWo0PA1InE0h5MQXCZjaXjxYHZFU”,
“commercialID”:”13352613″,
“EnquiryID”:”39059388″,
“commercialMergeList”:”13352613,14713314″,
“SubscriberEnquiryEngineID”:”178456248″
}
{
"DataTicket":"eyJhbGciOiJIUzI
1NiIsInR5cCI6IkpXVCJ9.eyJzd
WJzY3JpYmVyaWQiO
nVzZXJuYW1lIjoiai5pbWFmaW
RvbiIsInN5c3RlbXVzZXJpZCI6
IjkxODEyIiwibmJmIjoxN
jc5OTYyM30.7V4rFGMqU9dbg
zmbWo0PA1InE0h5MQXCZjaX
jxYHZFU",
"commercialID":"13352613",
"EnquiryID":"39059388",
"commercialMergeList": "13352613,14713314",
"SubscriberEnquiryEngineID": "178456248"
}
Kindly note that SubscriberEnquiryEngineID is returned in the
consumermatch and commercialmatch as MatchingEngineID
KYC Reports
Below is the endpoint for the KYC (Know Your Customer) product.
Consumer KYC Report
66
/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.eyJzdWJzY3JpYmVyaWQiO
nVzZXJuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxN
jc5OTYyM30.7V4rFGMqU9dbgzmbWo0PA1InE0h5MQXCZjaXjxYHZFU”,
“EnquiryReason”:”Test”,
“Identification”:”22471069115″,
“ProductID”:”45″
}
{
"DataTicket":"eyJhbGciOiJIUzI
1NiIsInR5cCI6IkpXVCJ9.eyJzd
WJzY3JpYmVyaWQiO
nVzZXJuYW1lIjoiai5pbWFmaW
RvbiIsInN5c3RlbXVzZXJpZCI6
IjkxODEyIiwibmJmIjoxN
jc5OTYyM30.7V4rFGMqU9dbg
zmbWo0PA1InE0h5MQXCZjaX
jxYHZFU",
"EnquiryReason":"Test",
"Identification":"22471069115",
"ProductID":"45"
}
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
Consumerreport
productid for report required
consumerreports
Headers
Content-Type
application/json
The above endpoints would return any of the consumer or commercial
reports excluding the binary reports depending on the productid
passed.
Body Params for Consumer reports
Request: Consumer Report
{
“DataTicket”:”eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQiO
nVzZXJuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxN
jc5OTYyM30.7V4rFGMqU9dbgzmbWo0PA1InE0h5MQXCZjaXjxYHZFU”,
“consumerID”:”13352613″,
“EnquiryID”:”39059388″,
“consumerMergeList”:”13352613,14713314″,
“SubscriberEnquiryEngineID”:”178456248″,
“productid”:45
}
{
"DataTicket":"eyJhbGciOiJIUzI
1NiIsInR5cCI6IkpXVCJ9.eyJzd
WJzY3JpYmVyaWQiO
nVzZXJuYW1lIjoiai5pbWFmaW
RvbiIsInN5c3RlbXVzZXJpZCI6
IjkxODEyIiwibmJmIjoxN
jc5OTYyM30.7V4rFGMqU9dbg
zmbWo0PA1InE0h5MQXCZjaX
jxYHZFU",
"consumerID":"13352613",
"EnquiryID":"39059388",
"consumerMergeList": "13352613,14713314",
"SubscriberEnquiryEngineID": "178456248",
"productid":45
}
Commercialreport
productid for report required
commercialreports
Headers
Content-Type
application/json
Body Params for Commercial reports
Request: Commercial Report
{
“DataTicket”:”eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWJzY3JpYmVyaWQiO
nVzZXJuYW1lIjoiai5pbWFmaWRvbiIsInN5c3RlbXVzZXJpZCI6IjkxODEyIiwibmJmIjoxN
jc5OTYyM30.7V4rFGMqU9dbgzmbWo0PA1InE0h5MQXCZjaXjxYHZFU”,
“commercialID”:”13352613″,
“EnquiryID”:”39059388″,
“commercialMergeList”:”13352613,14713314″,
“SubscriberEnquiryEngineID”:”178456248″,
“productid”:47
}
{
"DataTicket":"eyJhbGciOiJIUzI
1NiIsInR5cCI6IkpXVCJ9.eyJzd
WJzY3JpYmVyaWQiO
nVzZXJuYW1lIjoiai5pbWFmaW
RvbiIsInN5c3RlbXVzZXJpZCI6
IjkxODEyIiwibmJmIjoxN
jc5OTYyM30.7V4rFGMqU9dbg
zmbWo0PA1InE0h5MQXCZjaX
jxYHZFU",
"commercialID":"13352613",
"EnquiryID":"39059388",
"commercialMergeList": "13352613,14713314",
"SubscriberEnquiryEngineID": "178456248",
"productid":47
}
Going Live
To go live, contact us by sending a mail to sales@firstcentralcreditbureau.com or
call 0817 837 7643
