Skip to main content
GET
/
v1
/
screenings
List screenings
curl --request GET \
  --url https://api.beltic.com/v1/screenings \
  --header 'X-Api-Key: <api-key>'
{
  "data": [
    {
      "type": "screening/watchlist",
      "id": "<string>",
      "attributes": {
        "status": "pending",
        "execution_mode": "sync",
        "query": {},
        "has_match": true,
        "created_at": "<string>",
        "completed_at": "<string>",
        "matched_lists": [
          {
            "name": "<string>",
            "url": "<string>",
            "list_type": "<string>",
            "list_types": [
              "<string>"
            ],
            "slug": "<string>",
            "flag_code": "<string>",
            "country_code": "<string>",
            "entities": [
              {
                "name": "<string>",
                "alias_type": "<string>",
                "birthdates": [
                  {
                    "day": "<string>",
                    "year": "<string>",
                    "month": "<string>",
                    "granularity": "<string>"
                  }
                ],
                "birthdate": "<string>"
              }
            ],
            "match_types": [
              "<string>"
            ]
          }
        ],
        "started_at": "<string>",
        "errors": [
          {
            "code": "<string>",
            "message": "<string>",
            "details": {}
          }
        ],
        "ignore_list": [
          "<unknown>"
        ]
      },
      "relationships": {
        "account": {
          "data": {
            "type": "account",
            "id": "<string>"
          }
        },
        "business": {
          "data": {
            "type": "business",
            "id": "<string>"
          }
        }
      }
    }
  ],
  "meta": {
    "page_info": {
      "cursors": {
        "start": "<string>",
        "end": "<string>"
      },
      "hasNextPage": true,
      "hasPreviousPage": true,
      "total": 123
    }
  }
}

Authorizations

​
X-Api-Key
string
header
required

API key for authentication. Access https://console.beltic.com/ to obtain your API key.

Query Parameters

​
type
enum<string>

Filter by screening resource type (e.g. screening/watchlist)

Available options:
screening/watchlist,
screening/politically-exposed-person,
screening/business-watchlist,
screening/business-adverse-media,
screening/business-online-presence,
screening/business-classification,
screening/business-associated-persons,
screening/business-registrations
​
status
enum<string>

Filter by status

Available options:
pending,
processing,
completed,
failed,
not_found
​
page_size
integer
default:20

Number of items per page (max 100)

Required range: 1 <= x <= 100
Example:

20

​
after
string

Cursor for pagination (ID of last item)

Response

Screenings retrieved successfully

​
data
(screening/watchlist · object | screening/politically-exposed-person · object | screening/business-watchlist · object | screening/business-adverse-media · object)[]
required
​
meta
object