Comment on page
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
Parameters
Header
token*
String
API secret token
Body
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.
Responses
​
Individual type Sample Request
Business type Sample Request
{
    "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
}
​
Individual Type Success Response
Business Type Success Response
{
    "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": []
}
Risk Intelligence
Retrieve Risk Intelligence Profile
Last modified 4mo ago