Retrieve Risk Intelligence History
Last updated
Last updated
GET {{baseurl}}/v2/api/identity/risk-check/history
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
{
"success": true,
"statusCode": 200,
"message": "success",
"data": {
"docs": [
{
"identityId": "647f096187f89a18587648cc",
"createdAt": "2023-06-06T10:24:33.317Z",
"parentId": null,
"requestedAt": "2023-06-06T10:24:33.300Z",
"businessId": "62b2e8b281442b03187f7896",
"requestedById": "62b2e8b381442b75857f7898",
"entityInformation": {
"businessInformation": {
"businessName": "Tesla",
"businessIndustry": "others",
"idNumber": "1234567890",
"idExpiryDate": null,
"isIdVerified": true,
"phoneNumber": "08000000000"
},
"geographicInformation": {
"country": "NG",
"city": "lagos",
"lengthOfStay": 321
},
"_id": "647f096187f89a18587648ce"
},
"reportlastUpdatedAt": "2023-06-06T10:25:22.037Z",
"reportNextUpdateAt": "2023-07-06T10:25:22.037Z",
"type": "business",
"latestRiskStatus": "potential_medium_risk",
"trackingStatus": "active",
"trackingInterval": 30,
"latestReport": {
"product": {
"industryScore": 0,
"occupationScoreStatus": "Low Risk",
"weight": 0.25,
"industryScoreStatus": "Low Risk",
"occupationScore": 0,
"weightedScore": 0
},
"geographic": {
"lengthOfStayScoreStatus": "Low Risk",
"phoneIntelligenceScore": 0,
"country": "NG",
"countryScore": 56.78,
"countryScoreStatus": "Potential High Risk",
"city": "lagos",
"lengthOfStayScore": 0,
"cityScoreStatus": "Potential High Risk",
"cityScore": 67.6,
"weight": 0.25,
"phoneIntelligenceScoreStatus": "Low Risk",
"weightedScore": 8.618749999999999
},
"previousRiskScore": 0,
"personal": {
"kycScore": 40,
"accountAgeScoreStatus": "Potential High Risk",
"pAdverseMediaScore": 0,
"adverseMediaScoreStatus": "Potential High Risk",
"sanctionScore": 0,
"weight": 0.5,
"citizenshipScoreStatus": "Potential High Risk",
"sanctionScoreStatus": "Sanction Clear",
"pepScore": 0,
"pepScoreStatus": "PEP Clear",
"pAdverseMediaScoreStatus": "Low Risk",
"kycScoreStatus": "Verified by Client",
"citizenshipScore": 68.8,
"name": "Tesla",
"accountAgeScore": 100,
"weightedScore": 19.68,
"adverseMediaScore": 73.6
},
"riskScore": 28.29875,
"riskStatus": "Potential Medium Risk",
"basicRiskScore": 28.29875
},
"riskReportHistory": [
{
"reportYear": "2023",
"reportMonth": "06",
"product": {
"industryScore": 0,
"actualScore": 0,
"occupationScoreStatus": "Low Risk",
"weight": 0.25,
"industryScoreStatus": "Low Risk",
"occupationScore": 0,
"actualScoreStatus": "Very Low Risk",
"weightedScore": 0
},
"geographic": {
"lengthOfStayScoreStatus": "Low Risk",
"country": "NG",
"countryScore": 56.78,
"city": "lagos",
"actualScore": 34.474999999999994,
"weight": 0.25,
"phoneIntelligenceScore": 0,
"countryScoreStatus": "Potential High Risk",
"lengthOfStayScore": 0,
"cityScoreStatus": "Potential High Risk",
"cityScore": 67.6,
"phoneIntelligenceScoreStatus": "Low Risk",
"actualScoreStatus": "Potential Medium Risk",
"weightedScore": 8.618749999999999
},
"previousRiskScore": 0,
"reportDay": "06",
"personal": {
"kycScore": 40,
"accountAgeScoreStatus": "Potential High Risk",
"pAdverseMediaScore": 0,
"adverseMediaScoreStatus": "Potential High Risk",
"sanctionScore": 0,
"actualScore": 39.36,
"weight": 0.5,
"citizenshipScoreStatus": "Potential High Risk",
"sanctionScoreStatus": "Sanction Clear",
"pepScore": 0,
"pepScoreStatus": "PEP Clear",
"pAdverseMediaScoreStatus": "Low Risk",
"kycScoreStatus": "Verified by Client",
"citizenshipScore": 68.8,
"name": "Tesla",
"accountAgeScore": 100,
"actualScoreStatus": "Potential Medium Risk",
"weightedScore": 19.68,
"adverseMediaScore": 73.6
},
"riskScore": 28.29875,
"riskStatus": "Potential Medium Risk",
"basicRiskScore": 28.29875
}
],
"metadata": {},
"isReportUpdated": true,
"_id": "647f096187f89a18587648cc",
"id": "647f096187f89a18587648cc",
"requestedBy": {
"firstName": "Abdulazeez",
"lastName": "Shittu",
"middleName": ""
}
},
{
"identityId": "647efc16b80d630288c4c283",
"createdAt": "2023-06-06T09:27:50.202Z",
"parentId": null,
"requestedAt": "2023-06-06T09:27:50.177Z",
"businessId": "62b2e8b281442b03187f7896",
"requestedById": "62b2e8b381442b75857f7898",
"entityInformation": {
"businessInformation": {
"businessName": "Tesla",
"businessIndustry": "others",
"idNumber": "1234567890",
"idExpiryDate": null,
"isIdVerified": true,
"phoneNumber": "08000000000"
},
"geographicInformation": {
"country": "NG",
"city": "lagos",
"lengthOfStay": 321
},
"_id": "647efc16b80d630288c4c285"
},
"reportlastUpdatedAt": "2023-06-06T09:28:38.516Z",
"reportNextUpdateAt": "2023-07-06T09:28:38.516Z",
"type": "business",
"latestRiskStatus": "potential_medium_risk",
"trackingStatus": "active",
"trackingInterval": 30,
"latestReport": {
"product": {
"industryScore": 0,
"occupationScoreStatus": "Low Risk",
"weight": 0.25,
"industryScoreStatus": "Low Risk",
"occupationScore": 0,
"weightedScore": 0
},
"geographic": {
"lengthOfStayScoreStatus": "Low Risk",
"phoneIntelligenceScore": 0,
"country": "NG",
"countryScore": 56.78,
"countryScoreStatus": "Potential High Risk",
"city": "lagos",
"lengthOfStayScore": 0,
"cityScoreStatus": "Potential High Risk",
"cityScore": 67.6,
"weight": 0.25,
"phoneIntelligenceScoreStatus": "Low Risk",
"weightedScore": 8.618749999999999
},
"previousRiskScore": 0,
"personal": {
"kycScore": 40,
"accountAgeScoreStatus": "Potential High Risk",
"pAdverseMediaScore": 0,
"adverseMediaScoreStatus": "Potential High Risk",
"sanctionScore": 0,
"weight": 0.5,
"citizenshipScoreStatus": "Potential High Risk",
"sanctionScoreStatus": "Sanction Clear",
"pepScore": 0,
"pepScoreStatus": "PEP Clear",
"pAdverseMediaScoreStatus": "Low Risk",
"kycScoreStatus": "Verified by Client",
"citizenshipScore": 68.8,
"name": "Tesla",
"accountAgeScore": 100,
"weightedScore": 19.68,
"adverseMediaScore": 73.6
},
"riskScore": 28.29875,
"riskStatus": "Potential Medium Risk",
"basicRiskScore": 28.29875
},
"riskReportHistory": [
{
"reportYear": "2023",
"reportMonth": "06",
"product": {
"industryScore": 0,
"actualScore": 0,
"occupationScoreStatus": "Low Risk",
"weight": 0.25,
"industryScoreStatus": "Low Risk",
"occupationScore": 0,
"actualScoreStatus": "Very Low Risk",
"weightedScore": 0
},
"geographic": {
"lengthOfStayScoreStatus": "Low Risk",
"country": "NG",
"countryScore": 56.78,
"city": "lagos",
"actualScore": 34.474999999999994,
"weight": 0.25,
"phoneIntelligenceScore": 0,
"countryScoreStatus": "Potential High Risk",
"lengthOfStayScore": 0,
"cityScoreStatus": "Potential High Risk",
"cityScore": 67.6,
"phoneIntelligenceScoreStatus": "Low Risk",
"actualScoreStatus": "Potential Medium Risk",
"weightedScore": 8.618749999999999
},
"previousRiskScore": 0,
"reportDay": "06",
"personal": {
"kycScore": 40,
"accountAgeScoreStatus": "Potential High Risk",
"pAdverseMediaScore": 0,
"adverseMediaScoreStatus": "Potential High Risk",
"sanctionScore": 0,
"actualScore": 39.36,
"weight": 0.5,
"citizenshipScoreStatus": "Potential High Risk",
"sanctionScoreStatus": "Sanction Clear",
"pepScore": 0,
"pepScoreStatus": "PEP Clear",
"pAdverseMediaScoreStatus": "Low Risk",
"kycScoreStatus": "Verified by Client",
"citizenshipScore": 68.8,
"name": "Tesla",
"accountAgeScore": 100,
"actualScoreStatus": "Potential Medium Risk",
"weightedScore": 19.68,
"adverseMediaScore": 73.6
},
"riskScore": 28.29875,
"riskStatus": "Potential Medium Risk",
"basicRiskScore": 28.29875
}
],
"metadata": {},
"isReportUpdated": true,
"_id": "647efc16b80d630288c4c283",
"id": "647efc16b80d630288c4c283",
"requestedBy": {
"firstName": "API",
"lastName": "User",
"middleName": "",
"id": "628b38f03ae28a5a122d4bf3"
}
}
],
"pagination": {
"totalDocs": 39,
"perPage": 2,
"currentPage": 1,
"totalPages": 20,
"serialNo": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}
},
"links": []
}token*
String
API secret token
page
Number
Page number
Default Value: 1
limit
Number
Search history's list limit
Default value: 20
startDate
String
Start date YYYY-MM-DD
endDate
String
End date YYYY-MM-DD
latestRiskStatus
String
Filter by latestRiskStatus this can be either "pending", "very_low_risk", "low_risk", "potential_medium_risk","potential_high_risk", or"critical_high_risk"
trackingStatus
String
Filter by trackingStatus this can be either "active", "paused", or "stopped"
name
String
Filter history by name . This can be firstName, lastName, or businessName
type
String
Filter by type this can be either "individual", or "business"