Skip to main content

Retrieving Screening Data

You will receive a webhook with type business.change whenever the screening status changes.

Example webhook
{
    "type": "business.change",
    "data": {
        "screeningToken": "f4564d3d-69de-4093-971d-796699c0e8c5"
    },
    "secret": "secret"
}

After receiving this webhook, you can get screening status by making an HTTP GET request to:

api/v2/business/{screeningToken}

Example request
curl -X 'GET' 'https://screenings-api-test.globalpass.ch/api/v2/business/f4564d3d-69de-4093-971d-796699c0e8c5' -H 'accept: text/plain' -H 'Authorization: Bearer {your_access_token} '
Example response
{
    "name": "Apple",
    "taxRegistrationNumber": "0000320193",
    "country": "United States",
    "status": "Accepted"
}

Possible status values:

  • Accepted – screening is completed, AML matches over your set-up threshold are not found.
  • Rejected – screening is completed, AML matches over your set-up threshold are found.

To retrieve AML scan results from a completed screening, make an HTTP GET request to:

/api/v2/business/{screeningToken}/aml/matches

Example request
curl --location --request GET 'https://screenings-api-test.globalpass.ch/api/v2/business/9519c730-5d6e-4c23-b89a-8c4d06899e7f/aml/matches' --header 'Authorization: Bearer {your_access_token}'
Example response
{
    "screeningToken": "9519c730-5d6e-4c23-b89a-8c4d06899e7f",
    "created": "2022-12-28T11:04:25.0931836Z",
    "matches": [
        {
            "name": "Company ABC",
            "matchScore": 99.99999,
            "category": "SOE",
            "subCategory": "Govt Owned Corp",
            "source": {
                "name": "Website",
                "countryName": "International"
            }
        },
        {
            "name": "Company ABC",
            "matchScore": 96.666664,
            "category": "Enforcement",
            "subCategory": "Antitrust Violations",
            "source": {
                "name": "BG–Commission for Protection of Competition",
                "countryName": "Bulgaria",
                "countryCode": "BGR"
            }
        },
        {
            "name": "Company ABC",
            "matchScore": 91.11111,
            "category": "Sanction List",
            "source": {
                "name": "CA-Special Economic Measures against Russia",
                "countryName": "Canada",
                "countryCode": "CAN"
            }
        },
        {
            "name": "Company ABC",
            "matchScore": 74.44444,
            "category": "Associated Entity",
            "subCategory": "Ownership Or Control",
            "source": {
                "name": "UK-Her Majesty’s Treasury Financial Sanctions - Sanctions Ownership or Control",
                "countryName": "United Kingdom",
                "countryCode": "GBR"
            }
        }
    ]
}

Where:

PropertyDescription
nameName of the detected possible AML match
matchScoreAML match strength. Values up to 99.9999 (highest possible strength)
categoryAML match category. Possible categories: "Sanction List", "PEP", "Adverse Media", "Enforcement". One match will have one category.
subCategoryAvailable only for PEP, Adverse Media and Enforcement categories. Specifies subcategory of the main category (e.g., PEP – Family Member, Adverse Media – Burglary, etc.).
levelAvailable only for PEP category. Specifies PEP level – "International", "National", "State", or "Local".
sourceInformation about the source of the AML hit
source.nameName of the source of the hit. Will return exact name of the source when the hit was found on an original list. Will return "Website" when the hit was found in media sources.
source.countryNameFull name of the country that listed the hit (e.g., country that released a sanction list where the hit was count). Will return full country name of the source when the hit was found on an original list. Will return "International" when the hit was found in media sources, or in case of "Consolidated Sanctions List" hit.
source.countryCode3-letter code in ISO 3166-1 Alpha-3 format of the country that released the hit. Available only when countryName is not "International", but a specific country.

To access any given business AML screening, you can navigate to: