AML Watchlist Upload

POST {{baseurl}}/v2/api/verifications/watchlist/upload

Headers

Name	Type	Description
token*	String	API secret token

Request Body

Name	Type	Description
entityType*	String	Entity type can be individual or business
entity*	String	Entity that is being added to the watchlist. This can be an individual's name or business
reasonAdded*	String	This is the reason why the entity is being added to the watchlist
riskRating*	String	This is the level of risk associated with the entity. It can be Low Risk, Medium Risk or High Risk
dateAdded*	String	This is the date the entity is being added. The format is YYYY-MM-DD

AML Watchlist Upload Sample Request

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

Success Response

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

Error Response

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