Watchlist - UN Sanctions Search

This endpoint will be used to submit a check for UN Sanctions.

Credit Message Error
- {"code": "credit_message", "message": "Credit limit reached! For assistance, please contact the support"}

Request and Response Object Structures.

{
  "name": string,
  "callback_url": [string]
}
{
    "success_message": string,
    "data": {
        "id": integer,
        "created_by_user":string,
        "name": string,
        "status": string,
        "created_at": string,
        "updated_at": string,
        "is_cleared": boolean
    },
    "success": boolean
}

Sample Requests and Responses.

{
  "name":"kain",
  "webhook_urls":[]
}
{
    "success_message": "Created new UN Sanctions record",
    "data": {
        "id": 33,
        "created_by_user": "compliancely",
        "name": "kain",
        "status": "Pending",
        "created_at": "2023-09-19T05:12:17.759296Z",
        "updated_at": "2023-09-19T05:12:17.759310Z",
        "is_cleared": false
    },
    "success": true
}
{
    "errors": [
        {
            "name": [
                "This field may not be blank."
            ]
        }
    ],
    "data": null,
    "success": false
}
{
    "detail": "Authentication credentials were not provided."
}
{
    "errors": [
        "Credit limit reached! For assistance, please contact the support"
    ],
    "data": null,
    "success": false
}
{
    "detail": "Invalid token."
}
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!