Watchlist - OFAC Search

This endpoint will be used to submit a OFAC search.

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

Request and Response Object Structures.

{
  "name": string,
  "giin": string,
  "webhook_urls": [string],
  "country":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": {
            "score": integer,
            "country": string,
            "name": string
        }
    },
    "success": boolean
}

Sample Requests and Responses.

{
  "name": "laden",
  "giin": "",
  "webhook_urls": [],
  "country":""
}
{
    "success_message": "Created new OFAC record",
    "data": {
        "id": 96,
        "created_by_user": "compliancely",
        "name": "laden",
        "source": "ofac",
        "status": "Pending",
        "crawler_count": 0,
        "created_at": "2023-09-19T06:06:35.918486Z",
        "updated_at": "2023-09-19T06:06:35.918503Z",
        "is_cleared": false,
        "request_data": {
            "score": 100,
            "country": "All",
            "name": "laden"
        }
    },
    "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!