CreditScore Webhook

Every time a credit score is generated, a webhook is sent to the URL.
This response usually contains an array of all the credit score responses that have been generated for that particular statement.

Credit Score Webhook Response

Here is an example of the response from a credit score endpoint call that is sent to the webhook.

To compare the hash; serialize the whole credit score response object, hash the response and compare both

JSON

{
"metadata": {
		"statusMessage": "SUCCESSFUL",
		"statusCode": "200",
		"timeStamp": "07/05/2022 03:10:09",
		"responseType": "CREDITSCORE",
		"hmacMessage": "de695b2a0ed4f33f4dd07e538c569f137b48c1f77715ff4b5cb394ff28023a5a735700f520a6e9193ad10584efae05fc22a5079f7656bffad747d4d3185aaf47"
	},
	"statementName": "Mandatory Statement Name",
	"statementKey": 938,
  "statementUniqueCode":"67hgcd56",
	"affordabilityResponse": null,
	"creditScoreResponse": [
		{
			"Key": 95,
			"RulesScore": 240,
			"BaseScore": 300,
			"CalculatedScore": 540,
			"DidPass": false,
			"PassReasons": [
				"Rule AccountSweepNo was met because $Statement.AccountSweep was EQUALS No and 60 were added to the score",
				"Rule GamblingRateEqualsTo0% was met because $Statement.GamblingRate was EQUALS 0 and 60 were added to the score"
			],
			"FailReasons": [
				"Rule AccountSweepYes was not met because $Statement.AccountSweep was not EQUALS Yes and 0 were not added to the score",
				"Rule MostFrequentBalanceRangeBetween100k-500k was not met because $Statement.MostFrequentBalanceRange was not EQUALS 100k-500k and 60 were not added to the score",
				"Rule MostFrequentBalanceRangeBetween10k-100k was not met because $Statement.MostFrequentBalanceRange was not EQUALS 10k-100k and 30 were not added to the score"
			],
			"Type": "POINTS"
		}
	],
	"insightsResponse": null
}