diff --git a/fraudScan.json b/fraudScan.json index 87a8e6e..a373c4c 100644 --- a/fraudScan.json +++ b/fraudScan.json @@ -9,11 +9,13 @@ }, "fraudScanId": { "type": "string", - "description": "Unique reference for this fraud scan" + "description": "Unique reference for this fraud scan", + "deprecated": true }, "connectorLibrary": { "type": "string", - "description": "Connector used for this fraud scan" + "description": "Connector used for this fraud scan", + "deprecated": true }, "suggestedAction": { "type": "string", @@ -30,17 +32,25 @@ "description": "Time the scan was performed, output as the number of seconds since unix epoch" }, "overallScore": { - "$ref": "fraudScore.json" + "$ref": "fraudScore.json", + "deprecated": true }, "subScores": { "type": "array", "items": { "$ref": "fraudScore.json" - } + }, + "deprecated": true }, "references": { "type": "object", "description": "References associated with this scan" + }, + "scanData": { + "type": "array", + "items": { + "$ref": "fraudScanData.json" + } } } } diff --git a/fraudScanData.json b/fraudScanData.json new file mode 100644 index 0000000..2bfa7a0 --- /dev/null +++ b/fraudScanData.json @@ -0,0 +1,52 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "name": "fraudScanData", + "type": "object", + "properties": { + "chargeUuid": { + "type": "string", + "description": "Unique ID for the charge that has been created" + }, + "fraudScanId": { + "type": "string", + "description": "Unique reference for this fraud scan" + }, + "connectorLibrary": { + "type": "string", + "description": "Connector used for this fraud scan" + }, + "suggestedAction": { + "type": "string", + "enum": [ + "NO_SUGGESTION", + "REVIEW", + "ALLOW", + "DENY" + ], + "description": "Recommendation from the fraud scan" + }, + "scanTime": { + "type": "number", + "description": "Time the scan was performed, output as the number of seconds since unix epoch" + }, + "overallScore": { + "$ref": "fraudScore.json" + }, + "subScores": { + "type": "array", + "items": { + "$ref": "fraudScore.json" + } + }, + "references": { + "type": "object", + "description": "References associated with this scan" + }, + "subScans": { + "type": "array", + "items": { + "$ref": "fraudScan.json" + } + } + } +}