This end-point gets an individual credit report from credit bureau.

Request URL: {{baseurl}} /credit-report

Request Body

SN	Field Name	Data Type	Max Length	Required	Description
1	phoneNo	String	15	No	The phone number tied to account of the individual whose score you seek. This field is required if the bvn is not available
2	bvn	String	11	No	The bank verification number for the individual whose score you seek. This field is required if the phone number tied to the account of this individual is not available

Request Header

HTTP Verb: POST

Authentication: Bearer Token

Content-Type: application/json

Sample Request

Sample Request: {
"phoneNo" : "2348123456789",
"bvn" : "12345678912"
}

Sample Response (success)

Response:{
"phoneNo": null,
"bvn": "20000091512",
"creditReport": "SmartScoreResponse
{success='true',
errors=[],
retroDate=Wed Jun 17 13:44:28 UTC 2020,
enquiryDate=Tue Jun 16 23:00:00 UTC 2020,
positiveScoreFactorCount=0, 
negativeScoreFactorCount=0,
scoreModel='Consumer',
scoreType='Generic',
enquiryLoanAmount=0,
statusCode=200, message='',
smartScoreResults=[SmartScoreResult{
name='Mfom Doe Eku', smartScores=[SmartScore{
type='null', populationSegment='null', score=54,   
negativeScoreFactors=null, positiveScoreFactors=null}],
accountOwnerRegistryID='711123472950010065'}]
}"
}