Watchlist - UK Sanctions Search

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

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

Request and Response Object Structures.

{
    "name": string,
    "request_data": {"regime_name":string, "group_status":string, "group_type":string},
    "webhook_urls": [string]
}
{
    "success_message": string,
    "data": {
        "id": integer,
        "created_by_user":string,
        "name": string,
        "status": string,
	      "crawler_count": integer,
        "created_at": string,
        "updated_at": string,
        "is_cleared": boolean,
  	    "request_data": {
            "regime_name": string,
            "group_status": string,
            "group_type": string
        }
    },
    "success": boolean
}

Sample Requests and Responses.

{
    "name": "ZAHID ABDUL REHMAN",
    "request_data": {"regime_name":"Afghanistan", "group_status":"Asset Freeze Targets", "group_type":"Individual"},
    "webhook_urls": []
}
{
    "success_message": "Request created successfully",
    "data": {
        "id": 76,
        "created_by_user": "compliancely",
        "name": "ZAHID ABDUL REHMAN",
        "status": "Pending",
        "crawler_count": 0,
        "created_at": "2023-09-19T05:56:13.483288Z",
        "updated_at": "2023-09-19T05:56:13.483306Z",
        "is_cleared": false,
        "request_data": {
            "regime_name": "Afghanistan",
            "group_status": "Asset Freeze Targets",
            "group_type": "Individual"
        }
    },
    "success": true
}
{
    "errors": [
        "Please enter valid regime. Here's the valid list of regimes - ['Afghanistan', 'Belarus', 'Bosnia and Herzegovina', 'Burundi', 'Central African Republic', 'Chemical Weapons', 'Counter-Terrorism (Domestic)', 'Counter-Terrorism (International)', 'Cyber', \"Democratic People's Republic of Korea\", 'Democratic Republic of the Congo', 'Global Anti-Corruption', 'Global Human Rights', 'Guinea', 'Guinea-Bissau', 'Haiti', 'Iran (Human Rights)', 'Iran (Nuclear)', 'Iraq', \"ISIL (Da'esh) and Al-Qaida\", 'Lebanon (Assassination of Rafiq Hariri and others)', 'Libya', 'Mali', 'Myanmar', 'Nicaragua', 'Russia', 'Somalia', 'South Sudan', 'Sudan', 'Syria', 'Unauthorised Drilling Activities in the Eastern Mediterranean', 'Venezuela', 'Yemen', 'Zimbabwe']"
    ],
    "data": null,
    "success": false
}
{
    "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!