---
title: "List Screening Results"
method: GET
path: "/screenings/{screeningsKey}/results"
tags: ["Screenings"]
---

# List Screening Results

`GET /screenings/{screeningsKey}/results`

## Request

- Base URL: `https://eu-west-1.api.silverflow.com/v1`
- URL: `https://eu-west-1.api.silverflow.com/v1/screenings/{screeningsKey}/results`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
- TypeScript: <https://skmtc.dev/silverflow/apis/silverflow-api/docs/screenings/:screeningsKey/results/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the results of a screening request.

Requires `screenings:List` permission.

## Path parameters

- `screeningKey` string, required: Uniquely identifies a screening

## Query parameters

- `sortOrder` 'asc' | 'desc'
- `limit` integer
- `offsetToken` string

## Response `200`

List of screening results.

- ScreeningResultsPage
  - `offsetToken` string
  - `moreItems` boolean
  - `screeningResults` ScreeningResult[], required
    - `terminationReason` 'excessive-fraud' | 'excessive-chargebacks' | 'transaction-laundering' | 'illegal-transactions' | 'visa-compliance-program' | 'merchant-collusion' | 'common-point-of-purchase' | 'fraud-conviction' | 'insolvency' | 'violation-of-agreement' | 'violation-of-rules' | 'pci-non-compliance' | 'account-data-compromise' | 'merchant-identity-theft' | 'disqualified-from-network' | 'non-f2f-adult-content', required
    - `terminatedMerchant` union, required
      - VmssScreeningResult
        - `bid` string, required: Visa assigned Business Identifier (BID) of the Acquirer.
        - `doingBusinessAsName` RecordMatchString, required: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
          - `matchType` 'none' | 'partial' | 'phonetic' | 'exact', required
          - `value` string
        - `businessPhoneNumbers` RecordMatchStringArray, required: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks.
          - `matchType` 'none' | 'partial' | 'phonetic' | 'exact', required
          - `value` string[], required
        - `websiteUrl` RecordMatchStringArray, required: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks.
          - `matchType` 'none' | 'partial' | 'phonetic' | 'exact', required
          - `value` string[], required
        - `address` AddressMatch, required
          - `line1` RecordMatchString: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
            - `matchType` 'none' | 'partial' | 'phonetic' | 'exact', required
            - `value` string
          - `city` RecordMatchString: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
            - `matchType` 'none' | 'partial' | 'phonetic' | 'exact', required
            - `value` string
          - `stateOrProvince` RecordMatchString: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
            - `matchType` 'none' | 'partial' | 'phonetic' | 'exact', required
            - `value` string
          - `countryCode` RecordMatchString: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
            - `matchType` 'none' | 'partial' | 'phonetic' | 'exact', required
            - `value` string
          - `postalCode` RecordMatchString: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
            - `matchType` 'none' | 'partial' | 'phonetic' | 'exact', required
            - `value` string
        - `principals` VmssPrincipalResult[], required
          - `firstName` RecordMatchString, required: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
            - `matchType` 'none' | 'partial' | 'phonetic' | 'exact', required
            - `value` string
          - `lastName` RecordMatchString, required: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
            - `matchType` 'none' | 'partial' | 'phonetic' | 'exact', required
            - `value` string
      - union
        - MatchScreeningResult
          - `acquirerIdCode` string, required: AcquirerIdCode that terminated the merchant.
          - `legalName` RecordMatchString, required: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
            - `matchType` 'none' | 'partial' | 'phonetic' | 'exact', required
            - `value` string
          - `doingBusinessAsName` RecordMatchString, required: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
            - `matchType` 'none' | 'partial' | 'phonetic' | 'exact', required
            - `value` string
          - `address` AddressMatch, required
            - `line1` RecordMatchString: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
              - …
            - `city` RecordMatchString: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
              - …
            - `stateOrProvince` RecordMatchString: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
              - …
            - `countryCode` RecordMatchString: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
              - …
            - `postalCode` RecordMatchString: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
              - …
          - `websiteUrl` RecordMatchStringArray, required: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks.
            - `matchType` 'none' | 'partial' | 'phonetic' | 'exact', required
            - `value` string[], required
          - `principals` MatchPrincipalResult[], required
            - `firstName` RecordMatchString, required: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
              - …
            - `lastName` RecordMatchString, required: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
              - …
            - `address` AddressMatch, required
              - …
            - `phoneNumber` RecordMatchString, required: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
              - …
        - MatchProScreeningResult
          - `acquirerIdCode` string, required: AcquirerIdCode that terminated the merchant.
          - `legalName` RecordMatchString, required: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
            - `matchType` 'none' | 'partial' | 'phonetic' | 'exact', required
            - `value` string
          - `doingBusinessAsName` RecordMatchString, required: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
            - `matchType` 'none' | 'partial' | 'phonetic' | 'exact', required
            - `value` string
          - `merchantCategoryCode` RecordMatchString: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
            - `matchType` 'none' | 'partial' | 'phonetic' | 'exact', required
            - `value` string
          - `merchantPhoneNumber` RecordMatchString: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
            - `matchType` 'none' | 'partial' | 'phonetic' | 'exact', required
            - `value` string
          - `address` AddressMatch, required
            - `line1` RecordMatchString: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
              - …
            - `city` RecordMatchString: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
              - …
            - `stateOrProvince` RecordMatchString: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
              - …
            - `countryCode` RecordMatchString: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
              - …
            - `postalCode` RecordMatchString: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
              - …
          - `websiteUrl` RecordMatchStringArray, required: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks.
            - `matchType` 'none' | 'partial' | 'phonetic' | 'exact', required
            - `value` string[], required
          - `principals` MatchProPrincipalResult[], required
            - `firstName` RecordMatchString, required: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
              - …
            - `lastName` RecordMatchString, required: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
              - …
            - `address` AddressMatch, required
              - …
            - `phoneNumber` RecordMatchString, required: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
              - …
            - `email` RecordMatchString: Describes the type of match and the value of the record that matched with the input. Some sensitive fields will be masked by the card networks
              - …

## Other responses

- `400`: The request body was malformed
- `401`: Authentication information is missing or invalid
- `403`: The authenticated client is forbidden to make the request for the resource identified.
- `404`: The requested resource was not found
- `409`: The request could not be completed due to a conflict with the current state of the resources involved in the request.
- `429`: The number of requests (per minute) has exceeded the configured maximum

---

[API](https://skmtc.dev/silverflow/apis/silverflow-api.md) - [All operations](https://skmtc.dev/silverflow/apis/silverflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/silverflow/apis/silverflow-api/revisions/43ecbe4fd6ea?raw)
