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

Request Body

{
    "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
}

{
    "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": []
}

Last updated