LogoLogo
Home
  • Youverify API Documentation
  • Getting Started
    • Getting your API Key
    • Getting your Public Merchant Key
    • Environment
    • Response Codes
  • Know Your Customer Services (KYC)
    • ID Document Verification (SDK)
      • Web SDK
      • iOS SDK
        • iOS Liveness SDK
        • iOS (Compat) Liveness SDK
        • iOS Document Capture SDK
      • Android SDK
        • Android Document Capture SDK
        • Android Liveness SDK
      • Document Capture Supported Countries
        • 🌏Asia
        • πŸ‡ͺπŸ‡ΊEurope
        • 🌎Latin America and the Caribbean
        • 🌍Middle East and Africa
        • 🌎North America
        • 🌏Oceania
    • ID Data Matching (eIDV)
      • 🌐Global
        • Supported Countries
      • πŸ‡ΏπŸ‡¦South Africa
        • Verify South African ID Number (SAID)
        • Verify South African Phone Number
        • Bank Account Verification
        • Proof of Address Verification
      • πŸ‡°πŸ‡ͺKenya
        • Verify International Passport
        • Verify Alien ID
        • Verify Drivers License
        • Verify Plate Number
        • Verify Collateral ID
        • Kenyan Bank Account Verification
          • Bank List
        • Credit History
        • Employment History
        • Verify Address Information
        • Verify Phone Number
        • Verify Identity Number
        • Verify Tax PIN
      • πŸ‡¬πŸ‡­Ghana
        • Verify International Passport
        • Verify Social Security and National Insurance Trust (SSNIT)
        • Verify Ghana Voters Card (GVC)
      • πŸ‡³πŸ‡¬Nigeria
        • Verify Bank Verification Number (BVN)
        • Verify Bank Verification Number (BVN Premium)
        • Verify Virtual National Identification Number (vNIN)
        • Verify National Identification Number (NIN)
        • Verify Nigerian Driver's License (Driver's License)
        • Advanced Phone Search
        • Verify Nigerian International Passport (Passport)
        • Verify Nigerian Permanent Voters Card (PVC)
        • Verify Phone Number
        • Individual Credit Report
        • Bank Account Verification
          • Basic Bank Account Verification
          • Bank List
            • Getting the list of Banks for Basic Bank Account
    • Facial Comparison
    • Retrieve an Identity
    • Identity History
  • Know Your Business Services (KYB)
    • 🌍Business Verification
    • 🌍Search for Businesses
    • Get Supported Countries and Regions
    • Retrieve Business details
    • Country-Specific KYB Services
      • πŸ‡³πŸ‡¬Nigeria
        • Tax Identification Number (TIN) Verification
      • πŸ‡ΏπŸ‡¦South Africa
        • Business Account Verification
        • Business Address Verification
  • Know Your Transaction Service (KYT)
    • Customer Management
      • Create an Individual Client
      • Create a Business Client
      • Initiate an Individual Client Assessment
      • Initiate an Business Client Assessment
      • Update a Client
      • Retrieve all Clients
      • Retrieve a Client
      • Delete a Client
    • Transaction Management
      • Create a Transaction
      • Retrieve an Evaluation
  • Risk Intelligence
    • Risk Intelligence: Initialise Risk Check
    • Retrieve Risk Intelligence Profile
    • Retrieve Risk Intelligence History
  • AML Services (Anti-Money Laundering)
    • PEP and Sanction Screening
      • Search using Name
        • Advanced Filters
      • Search using Identity
        • Advanced Filters
      • Search using Crypto
        • Advanced Filters
      • Retrieve a PEP and Sanction Screening Search
      • Screening Data Sources
      • Domestic PEP Search
    • Adverse Media Intelligence
    • Custom AML Watchlist
      • AML Watchlist (Sample list)
      • AML Watchlist Upload (Bulk Upload)
      • AML Watchlist Upload
      • Retrieve AML Watchlist
      • AML Watchlist Entity Update
      • AML Watchlist Entity Removal
  • Custom Workflow Builder (CWB)
    • CWB Webhook
    • CWB External API
      • Retrieve CWB History
      • Retrieve CWB Responses
      • Retrieve CWB Report
  • Youverify OS Error Codes
  • Webhooks
    • Know Your Customer Webhooks
      • Identity Verification
      • Address Verification
    • Know Your Transaction Webhooks
      • Customer Management Webhooks
        • Client Created
        • Client Updated
      • Alert Service Webhooks
        • Alert Created
        • Alert Triage Created
        • Alert Updated
      • Evaluation Webhooks
        • Evaluation Completed
        • Evaluation Started
        • Transaction Updated
  • Test Data
  • Our Legacy API and SDK
Powered by GitBook
On this page

Was this helpful?

  1. Risk Intelligence

Retrieve Risk Intelligence History

GET {{baseurl}}/v2/api/identity/risk-check/history

Headers

Name
Type
Description

token*

String

API secret token

Request Body

Name
Type
Description

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"

{
    "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": []
}
PreviousRetrieve Risk Intelligence ProfileNextAML Services (Anti-Money Laundering)

Last updated 1 year ago

Was this helpful?