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 Profile

GET {{baseurl}}/v2/api/identity/risk-check/entities/:entityId

Headers

Name
Type
Description

token*

String

API secret token

{
    "success": true,
    "statusCode": 200,
    "message": "Risk intelligence entity result retrieved successfully!",
    "data": {
        "latestReport": {
            "geographic": {
                "weight": 0.25,
                "country": "NG",
                "countryScore": 56.78,
                "countryScoreStatus": "Potential High Risk",
                "city": "abuja",
                "cityScore": 50,
                "cityScoreStatus": "Potential Medium Risk",
                "lengthOfStayScore": 0,
                "lengthOfStayScoreStatus": "Low Risk",
                "phoneIntelligenceScore": 0,
                "phoneIntelligenceScoreStatus": null,
                "actualScore": 37.373,
                "actualScoreOverallPercentage": 24.041350118685394,
                "actualScoreStatus": "Potential Medium Risk",
                "weightedScore": 9.34325
            },
            "product": {
                "weight": 0.25,
                "industryScore": 100,
                "industryScoreStatus": "Potential High Risk",
                "occupationScore": 0,
                "occupationScoreStatus": "Low Risk",
                "actualScore": 90,
                "actualScoreOverallPercentage": 57.895312409538576,
                "actualScoreStatus": "Critical High Risk",
                "weightedScore": 22.5
            },
            "personal": {
                "weight": 0.5,
                "name": "Ahmed Al Khalid",
                "kycScore": 40,
                "kycScoreStatus": "Verified by Client",
                "sanctionScore": 0,
                "sanctionScoreStatus": "Sanction Clear",
                "pepScore": 0,
                "pepScoreStatus": "PEP Clear",
                "adverseMediaScore": 0,
                "adverseMediaScoreStatus": "Low Risk",
                "pAdverseMediaScore": 0,
                "pAdverseMediaScoreStatus": "Low Risk",
                "accountAgeScore": 100,
                "accountAgeScoreStatus": "Potential High Risk",
                "citizenshipScore": 67.2,
                "citizenshipScoreStatus": "Potential High Risk",
                "actualScore": 28.08,
                "actualScoreOverallPercentage": 18.063337471776038,
                "actualScoreStatus": "Potential Medium Risk",
                "weightedScore": 14.04
            },
            "basicRiskScore": 45.88325,
            "previousRiskScore": 0,
            "riskScore": 56.235162499999994,
            "riskStatus": "Potential Medium Risk",
            "reportYears": null,
            "reportMonth": "07",
            "reportDay": "10"
        },
        "parentId": null,
        "userId": "6222a5ed3e7a41c29c031ece",
        "type": "individual",
        "ipAddress": "102.88.84.143",
        "latestRiskScore": 56.235162499999994,
        "latestAdverseMediaScore": 0,
        "latestRiskStatus": "potential_medium_risk",
        "trackingInterval": 30,
        "trackingStatus": "active",
        "riskReportHistory": [
            {
                "geographic": {
                    "weight": 0.25,
                    "country": "NG",
                    "countryScore": 56.78,
                    "countryScoreStatus": "Potential High Risk",
                    "city": "abuja",
                    "cityScore": 50,
                    "cityScoreStatus": "Potential Medium Risk",
                    "lengthOfStayScore": 0,
                    "lengthOfStayScoreStatus": "Low Risk",
                    "actualScore": 37.373,
                    "actualScoreStatus": "Potential Medium Risk",
                    "weightedScore": 9.34325,
                    "actualScoreOverallPercentage": 24.041350118685394
                },
                "product": {
                    "weight": 0.25,
                    "industryScore": 100,
                    "industryScoreStatus": "Potential High Risk",
                    "occupationScore": 0,
                    "occupationScoreStatus": "Low Risk",
                    "actualScore": 90,
                    "actualScoreStatus": "Critical High Risk",
                    "weightedScore": 22.5,
                    "actualScoreOverallPercentage": 57.895312409538576
                },
                "personal": {
                    "weight": 0.5,
                    "name": "Ahmed Al Khalid",
                    "kycScore": 40,
                    "kycScoreStatus": "Verified by Client",
                    "sanctionScore": 0,
                    "sanctionScoreStatus": "Sanction Clear",
                    "pepScore": 0,
                    "pepScoreStatus": "PEP Clear",
                    "adverseMediaScore": 0,
                    "adverseMediaScoreStatus": "Low Risk",
                    "pAdverseMediaScore": 0,
                    "pAdverseMediaScoreStatus": "Low Risk",
                    "accountAgeScore": 100,
                    "accountAgeScoreStatus": "Potential High Risk",
                    "citizenshipScore": 67.2,
                    "citizenshipScoreStatus": "Potential High Risk",
                    "actualScore": 28.08,
                    "actualScoreStatus": "Potential Medium Risk",
                    "weightedScore": 14.04,
                    "actualScoreOverallPercentage": 18.063337471776038
                },
                "basicRiskScore": 45.88325,
                "previousRiskScore": 0,
                "riskScore": 56.235162499999994,
                "riskStatus": "Potential Medium Risk",
                "reportYear": "2024",
                "reportMonth": "07",
                "reportDay": "10"
            }
        ],
        "_id": "668e3f0e4b87a868fd716fc5",
        "entityInformation": {
            "personalInformation": {
                "firstName": "Ahmed",
                "lastName": "Al Khalid",
                "idNumber": "1234567890",
                "idExpiryDate": null,
                "isIdVerified": true,
                "phoneNumber": "08000000000"
            },
            "geographicInformation": {
                "country": "NG",
                "city": "abuja",
                "lengthOfStay": 321
            },
            "workInformation": {
                "occupation": "casinos",
                "industry": "casinos"
            },
            "_id": "668e3f0e4b87a81b91716fc7"
        },
        "businessId": "6222a5ed3e7a41c29c031ecc",
        "requestedAt": "2024-07-10T07:58:06.221Z",
        "requestedById": "6222a5ed3e7a41c29c031ece",
        "reportNextUpdateAt": "2024-08-09T07:58:11.950Z",
        "reportlastUpdatedAt": "2024-07-10T07:58:11.950Z",
        "createdAt": "2024-07-10T07:58:06.241Z",
        "lastModifiedAt": "2024-07-10T07:58:12.018Z",
        "_createdAt": "2024-07-10T07:58:066+00:00",
        "_lastModifiedAt": "2024-07-10T07:58:1212+00:00",
        "enterpriseCode": 471335,
        "allValidationPassed": false,
        "id": "668e3f0e4b87a868fd716fc5",
        "metadata": {},
        "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "middleName": "",
            "id": "6222a5ed3e7a41c29c031ece"
        }
    },
    "links": []
}
PreviousRisk Intelligence: Initialise Risk CheckNextRetrieve Risk Intelligence History

Last updated 9 months ago

Was this helpful?