Custom List Test Cases

You can test your integration with Custom List Screening Service by sending one of the special test requests below with your TEST API key. Test requests are free, so you will always be sure that your integration is successful.

MATCH Profile

1. For getting usual "Match" profile, send the request data below:

{
  "firstName": "SAMPLE",
  "lastName": "TEST",
  "dateOfBirths": "1975-01-01",
  "state": "KS",
  "services": [
    "AED0308E-209E-46A1-9CF5-5171DA0215B1"
  ]
}

You will get this successful response:

[
  {
    "serviceId": "aed0308e-209e-46a1-9cf5-5171da0215b1",
    "serviceName": "Custom Screening List",
    "serviceDescription": "Check if the provided data matches a record in the uploaded custom lists. These custom lists are user created and uploaded through the web portal",
    "error": null,
    "success": true,
    "locationId": null,
    "readOnlyAccessLocationIds": null,
    "profiles": [
      {
        "internalId": null,
        "firstName": "SAMPLE",
        "middleName": null,
        "lastName": "TEST",
        "fullName": "SAMPLE TEST",
        "dateOfBirths": null,
        "sex": null,
        "address": null,
        "countryName": "USA",
        "countryCode": null,
        "street1": "MAIN ST",
        "street2": null,
        "city": "SAN ANTONIO",
        "state": "KS",
        "zipCode": null,
        "county": null,
        "convictiontype": null,
        "aliases": null,
        "offenses": null,
        "photoUrl": null,
        "source": "MY TEST CUSTOM LIST",
        "otherInformation": "OTHER INFORMATION",
        "idNumber": null,
        "verificationResult": null,
        "driverLicenseVerificationResult": null
      }
    ]
  }
]