Get Credit Score

This endpoint returns the customer’s current credit score generated by the Credit Score Engine for the customer.

Test Client id : IKIA9614B82064D632E9B6418DF358A6A4AEA84D7218

Test Client Secret : XCTiBtLy1G9chAnyg0z3BcaFK4cVpwDg/GTw2EmjTZ8=

Request Base URL: https://sandbox.interswitchng.com/credit-score-engine/

Endpoint

GET /v1/credit-score?msisdn={customer msisdn}

Headers

Headers: Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJhdWQiOlsiY2Flc2FyIiwiY2FyZGxlc3Mtc2V…

Request Parameters

Field#	Field name	Data type	Max length	Required	Description
1	msisdn	String	13	true	The Phone number(MSISDN) of the customer whose credit score we are trying to retrieve

Sample request

/v1/credit-score?msisdn=2348123456789

Response Message  field description

Field#	Field name	Description
1	responseCode	Response code from the API
2	responseMessage	The description of the response code
3	score	The numerical value of the generated credit score
4	dateCreated	The date the credit score was generated

Sample Response (success)

{     “responseCode”: “00”,     “responseDescription”: “Successful”,     “creditScores”: [         {             “id”: 487,             “msisdn”: “2348123456789”,             “score”: “32”,             “dateCreated”: “2020-09-04”         }     ] }

Sample Response (failure)

{"responseCode":"4004","responseMessage":"No Credit Score."}

Get Credit Score History

This endpoint returns the customer’s historical credit scores generated by the Credit Score Engine for the customer.

Request Parameters

Field#	Field name	Data type	Max length	Required	Description
1	msisdn	String	13	true	The Phone number(MSISDN) of the customer whose credit score we are trying to retrieve
2
3

Endpoint

GET /v1/credit-score/history?msisdn={customer msisdn}

Sample Request

Sample request

GET /v1/credit-score/history?msisdn=234123456789

Response Message  field description

Field#	Field name	Description
1	responseCode	Response code from the API
2	responseMessage	The description of the response code
3	score	The numerical value of the generated credit score
4	dateCreated	The date the credit score was generated
5	msisdn	Customer phone number

Sample Response (success)

{ "responseCode": "00", "responseDescription": "Successful", "creditScores": [ {"msisdn": "2348123456789", "score": "40", "dateCreated": "2018-07-10"} ,{"msisdn": " 2348123456789 ", "score": "30", "dateCreated": "2018-07-05"}] }

Sample Response (failure)

{"responseCode":"4004","responseMessage":"No Credit Score."}

Response Codes

Response Code	Response Message
00	Success
4004	No Credit Score