SIsilverflow
Screenings

Create Screening Request

Submit merchant information to initiate a merchant screening request. This will trigger a Mastercard MATCH_PRO or a Visa VMSS screening submission. Processing is asynchronous. Results are generally available in under two minutes, but may be delayed depending on the type of screening and the load on the card scheme screening services. <br> Note: The website URL and address are retrieved from the Merchant entity.

  • "https://", "www", and excess subdomains might be trimmed while preserving key URL components for VMSS screening requests to ensure it does not exceed 84 characters.
  • city will be trimmed to ensure it does not exceed 20 characters for MATCH_PRO or 30 characters for VMSS.
  • address lines from the merchant will be trimmed to ensure it does not exceed 60 characters for MATCH.
  • duplicate principals with the same firstName and lastName (case-insensitive) will be deduplicated for VMSS screening requests, keeping only the first occurrence.

<br>Please contact your technical account manager before screening with MATCH_PRO for the first time. Requires screenings:Create permission.

post/screenings

Request

Request body

OR

Example request

{
  "merchantKey": "mct-123dinkqFqfq3q2f2adfa",
  "merchantPhoneNumber": "31850609160",
  "principals": [
    {
      "phoneNumber": "31850609160",
      "address": {
        "countryCode": {
          "alpha3": "NLD"
        }
      }
    }
  ]
}

Response

Information on the submitted screening request.

keystring required

Uniquely identifies a screening

merchantKeystring required

Uniquely identifies a Merchant

binKeystring required

A key assigned by Silverflow to uniquely identify a BIN.

agentKeystring required

Uniquely identifies an Agent

screeningStatus'pending' | 'completed' | 'failed' required

Status of the screening request

errorMessagestring

Error message in case screeningStatus is 'failed'.

screeningType'MATCH' | 'VMSS' | 'MATCH_PRO' required
createdstring date-time required

The date and time this object was created

lastModifiedstring date-time

The date and time this object was last modified

status'active' | 'archived' required

The status of the object

versioninteger required

The version of this object

totalNumberOfResultsnumber

Indicates the number of merchants that matched with the search criteria. totalNumberOfResults will be available when screening is completed.

Example response

{
  "merchantKey": "mct-123dinkqFqfq3q2f2adfa",
  "agentKey": "cgt-1UF2NafdfrdPMf2XrS2",
  "screeningDetail": {
    "address": {
      "countryCode": {
        "alpha3": "NLD",
        "alpha2": "NL",
        "numeric": "528"
      }
    },
    "principals": [
      {
        "phoneNumber": "31850609160",
        "address": {
          "countryCode": {
            "alpha3": "NLD",
            "alpha2": "NL",
            "numeric": "528"
          }
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.