# AML Watchlist Upload

<mark style="color:green;">`POST`</mark> `{{baseurl}}/v2/api/verifications/watchlist/upload`

#### Headers

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

#### Request Body

| Name                                          | Type   | Description                                                                                                                          |
| --------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| entityType<mark style="color:red;">\*</mark>  | String | Entity type can be  <mark style="color:red;">`individual or business`</mark>                                                         |
| entity<mark style="color:red;">\*</mark>      | String | Entity that is being added to the watchlist. This can be an individual's name or business                                            |
| reasonAdded<mark style="color:red;">\*</mark> | String | This is the reason why the entity is being added to the watchlist                                                                    |
| riskRating<mark style="color:red;">\*</mark>  | String | This is the level of risk associated with the entity. It can be <mark style="color:red;">`Low Risk, Medium Risk or High Risk`</mark> |
| dateAdded<mark style="color:red;">\*</mark>   | String | This is the date the entity is being added. The format is <mark style="color:red;">`YYYY-MM-DD`</mark>                               |

{% tabs %}
{% tab title="AML Watchlist Upload Sample Request" %}

```json
{
    "entityType": "individual",
    "entity": "Shekau",
    "reasonAdded": "Fraud",
    "dateAdded": "2023-11-22",
    "riskRating": "High Risk"
}
```

{% endtab %}
{% endtabs %}

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

```json
{
    "success": true,
    "statusCode": 201,
    "message": "Entity added to watchlist successfully!",
    "data": {
        "entity": "Shekau",
        "entityType": "individual",
        "reasonAdded": "Fraud",
        "riskRating": "High Risk",
        "dateAdded": "2023-11-22T00:00:00.000Z",
        "businessId": "628b38f03ae28a14f52d4bf7",
        "parentId": null,
        "createdAt": "2023-11-22T04:46:27.645Z",
        "lastModifiedAt": "2023-11-22T04:46:27.645Z",
        "_createdAt": "2023-11-22T04:46:2727+00:00",
        "_lastModifiedAt": "2023-11-22T04:46:2727+00:00",
        "id": "655d87a3194cc13dfa887d6a"
    },
    "links": []
}
```

{% endtab %}

{% tab title="Error Response" %}

```json
{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}
```

{% endtab %}
{% endtabs %}
