Skip to main content
POST
/
v1
/
screenings
Create screening
curl --request POST \
  --url https://api.beltic.com/v1/screenings \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "data": {
    "type": "screening/politically-exposed-person",
    "attributes": {
      "execution_mode": "sync",
      "query": {
        "name_first": "John",
        "name_last": "Doe",
        "birthdate": "1985-01-15",
        "country_code": "US"
      }
    }
  }
}
'
{
  "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>"
        }
      }
    }
  }
}

Authorizations

X-Api-Key
string
header
required

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

Body

application/json
data
screening/politically-exposed-person · object
required
Example:
{
"type": "screening/politically-exposed-person",
"attributes": {
"execution_mode": "sync",
"query": {
"name_first": "John",
"name_last": "Doe",
"birthdate": "1985-01-15",
"country_code": "US"
}
}
}

Response

Screening created successfully

data
screening/watchlist · object
required