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

Risk Intelligence: Initialise Risk Check

You can use this endpoint to start a process of verifying the risk level associated with an entity, which can be either a person or a company.

POST {{baseurl}}/v2/api/identity/risk-check/initialize

Headers

Name
Type
Description

token*

String

API secret token

Request Body

Name
Type
Description

type*

String

Entity type This can either "individual" or "business"

firstName*

String

Entity's FirstName. This is Not Required if type is business

lastName*

String

Entity's LastName. This is Not Required if type is business

businessName*

String

Entity's businessName. This is Not Required if type is individual

businessIndustry*

String

Entity's industry This is Not Required if type is individ

country*

Array

Entity's current country code

city*

Array

Entity's current city

isSubjectConsent*

Boolean

Indicate subject has given consent. Must be true

advancedOptions

Object

Advanced Options

idNumber

String

Entity's identity number

idExpiryDate

Date

Entity's identity number expiry date.

isIdVerified

Boolean

If you have conducted your own verification of the ID. If you have, then it is True

phoneNumber

String

Entity's phone number

lengthOfStay

String

Entity's current address length of stay (In Month)

occupation

String

Entity's occupation. This is specifically for individual type

industry

String

Entity's Industry. This is specially for Individual type.

{
    "type": "individual",
    "firstName": "Ahmed",
    "lastName": "Al Khalid",
    "businessName": null,
    "businessIndustry": null,
    "country": "NG",
    "city": "abuja",
    "advanceOptions": {
        "idNumber": "1234567890",
        "idExpiryDate": null,
        "isIdVerified": true,
        "phoneNumber": "08000000000",
        "lengthOfStay": "321",
        "occupation": "casinos",
        "industry": "casinos"
    },
    "verificationId": null,
    "metadata": {},
    "isSubjectConsent": true
}
{
    "type": "business",
    "firstName": null,
    "lastName": null,
    "businessName": "Tesla",
    "businessIndustry": "others",
    "country": "NG",
    "city": "lagos",
    "advanceOptions": {
        "idNumber": "1234567890",
        "idExpiryDate": null,
        "isIdVerified": true,
        "phoneNumber": "08000000000",
        "lengthOfStay": "321",
        "occupation": "casinos",
        "industry": "casinos"
    },
    "verificationId": null,
    "metadata": {},
    "isSubjectConsent": true
}

{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "latestReport": null,
        "parentId": null,
        "type": "individual",
        "latestRiskScore": 0,
        "latestAdverseMediaScore": 0,
        "latestRiskStatus": "pending",
        "trackingInterval": 30,
        "trackingStatus": "active",
        "riskReportHistory": [],
        "_id": "647efaac5ba52600eb2a4ac7",
        "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": "647efaac5ba52600eb2a4ac9"
        },
        "businessId": "62b2e8b281442b03187f7896",
        "requestedAt": "2023-06-06T09:21:48.930Z",
        "requestedById": "62b2e8b381442b75857f7898",
        "reportNextUpdateAt": "2023-06-06T09:21:48.938Z",
        "reportlastUpdatedAt": "2023-06-06T09:21:48.938Z",
        "createdAt": "2023-06-06T09:21:48.946Z",
        "lastModifiedAt": "2023-06-06T09:21:48.946Z",
        "_createdAt": "2023-06-06T10:21:4848+01:00",
        "_lastModifiedAt": "2023-06-06T10:21:4848+01:00",
        "enterpriseCode": 471335,
        "allValidationPassed": false,
        "id": "647efaac5ba52600eb2a4ac7",
        "metadata": {},
       "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "middleName": "",
            "id": "628b38f03ae28a5a122d4bf3"
        }
    },
    "links": []
}
{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "latestReport": null,
        "parentId": null,
        "type": "business",
        "latestRiskScore": 0,
        "latestAdverseMediaScore": 0,
        "latestRiskStatus": "pending",
        "trackingInterval": 30,
        "trackingStatus": "active",
        "riskReportHistory": [],
        "_id": "647f096187f89a18587648cc",
        "entityInformation": {
            "businessInformation": {
                "businessName": "Tesla",
                "businessIndustry": "others",
                "idNumber": "1234567890",
                "idExpiryDate": null,
                "isIdVerified": true,
                "phoneNumber": "08000000000"
            },
            "geographicInformation": {
                "country": "NG",
                "city": "lagos",
                "lengthOfStay": 321
            },
            "_id": "647f096187f89a18587648ce"
        },
        "businessId": "62b2e8b281442b03187f7896",
        "requestedAt": "2023-06-06T10:24:33.300Z",
        "requestedById": "62b2e8b381442b75857f7898",
        "reportNextUpdateAt": "2023-06-06T10:24:33.309Z",
        "reportlastUpdatedAt": "2023-06-06T10:24:33.309Z",
        "createdAt": "2023-06-06T10:24:33.317Z",
        "lastModifiedAt": "2023-06-06T10:24:33.317Z",
        "_createdAt": "2023-06-06T11:24:3333+01:00",
        "_lastModifiedAt": "2023-06-06T11:24:3333+01:00",
        "enterpriseCode": 471335,
        "allValidationPassed": false,
        "id": "647f096187f89a18587648cc",
        "metadata": {},
        "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "middleName": "",
            "id": "628b38f03ae28a5a122d4bf3"
        }
    },
    "links": []
}
PreviousRisk IntelligenceNextRetrieve Risk Intelligence Profile

Last updated 1 year ago

Was this helpful?