SIsilverflow
Screenings

Get a Screening

Retrieve a screening entity.

Requires screenings:Get permission.

get/screenings/{screeningsKey}

Request

Path parameters

screeningKeystring required

Uniquely identifies a screening

Immutable, unique identifier of the screening

Response

Information on the requested screening.

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.