# 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.

<mark style="color:green;">`POST`</mark> `{{baseurl}}/v2/api/identity/risk-check/initialize`

#### Headers

| Name                                    | Type   | Description      |
| --------------------------------------- | ------ | ---------------- |
| token<mark style="color:red;">\*</mark> | String | API secret token |

#### Request Body

| Name                                               | Type    | Description                                                                                                           |
| -------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------- |
| type<mark style="color:red;">\*</mark>             | String  | Entity type <mark style="color:red;">`This can either "individual" or "business"`</mark>                              |
| firstName<mark style="color:red;">\*</mark>        | String  | Entity's FirstName. <mark style="color:red;">`This is Not Required if type is business`</mark>                        |
| lastName<mark style="color:red;">\*</mark>         | String  | Entity's LastName. <mark style="color:red;">`This is Not Required if type is business`</mark>                         |
| businessName<mark style="color:red;">\*</mark>     | String  | Entity's businessName. <mark style="color:red;">`This is Not Required if type is individual`</mark>                   |
| businessIndustry<mark style="color:red;">\*</mark> | String  | Entity's industry <mark style="color:red;">`This is Not Required if type is individ`</mark>                           |
| country<mark style="color:red;">\*</mark>          | Array   | Entity's current country code                                                                                         |
| city<mark style="color:red;">\*</mark>             | Array   | Entity's current city                                                                                                 |
| isSubjectConsent<mark style="color:red;">\*</mark> | Boolean | Indicate subject has given consent. <mark style="color:red;">`Must be true`</mark>                                    |
| 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 <mark style="color:red;">`True`</mark> |
| phoneNumber                                        | String  | Entity's phone number                                                                                                 |
| lengthOfStay                                       | String  | Entity's current address length of stay <mark style="color:red;">`(In Month)`</mark>                                  |
| occupation                                         | String  | Entity's occupation. This is specifically for <mark style="color:red;">`individual type`</mark>                       |
| industry                                           | String  | Entity's Industry. This is specially for <mark style="color:red;">`Individual type`</mark>.                           |

{% tabs %}
{% tab title="Individual type Sample Request" %}

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

{% endtab %}

{% tab title="Business type Sample Request" %}

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

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Individual Type Success Response" %}

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

{% endtab %}

{% tab title="Business Type Success Response" %}

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

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.youverify.co/risk-intelligence/risk-intelligence-initialise-risk-check.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.