Custom List

The Custom List Screening Service allows the user to upload CSV files that contain records that can then be matched against later when making requests.

Example Request

Send POST request with CURL

curl -X POST https://screening.idware.net/api/Check -H "Content-Type: application/json" -H "Authorization: Bearer {token}" -d "{ \"firstName\": \"john\", \"lastName\": \"doe\", \"services\": [ \"AED0308E-209E-46A1-9CF5-5171DA0215B1\" ]}"

Request

{
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "dateOfBirths": "2021-09-27",
  "sex": "string",
  "address": "string",
  "addressLine2": "string",
  "city": "string",
  "county": "string",
  "state": "string",
  "zip": "string",
  "ssn": "string", 
  "services": [
    "AED0308E-209E-46A1-9CF5-5171DA0215B1"
  ],
  "idType": "string",
  "idNumber": "string",
  "driverLicenseNumber": "string",
  "documentCategoryCode": 0,
  "driverLicenseIssueDate": "2021-09-27",
  "driverLicenseExpirationDate": "2021-09-27",
  "referenceId": "string",
  "metadata": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "emailAddress": "user@example.com",
  "phone": {
    "phoneNumber": "string",
    "sendPhoneVerification": true,
    "forceVerificationByCall": true
  },
  "locationId": 0,
  "readOnlyAccessLocationIds": [
    0
  ]
}

Request Fields

Field Name	Required Fields for Custom List Service
"firstName"	Required

The "firstName" field is used for the name of a business when checking a custom list for business records.

The "services" field is an array of IDs. Each ID is of a service that the client would like to run on the supplied data.

To run the Custom List Service include - "AED0308E-209E-46A1-9CF5-5171DA0215B1"

To have multiple screening services run during a single request, please see details

Important

When the "services" field is null or is an empty array all the services your account has enabled will run. We do not recommend submitting request in this way. We recommend being explicit about which services you would like to run.

Sample Results

Sample Result with a Match

[
  {
    "serviceId": "aed0308e-209e-46a1-9cf5-5171da0215b1",
    "serviceName": "Custom Screening List",
    "serviceDescription": "Check person in Custom Screening List Of Persons. These lists are created by Customer him/herself through the portal",
    "error": null,
    "success": true,
    "locationId": 0,
    "readOnlyAccessLocationIds": [
      0
    ],
    "profiles": [
      {
        "internalId": null,
        "firstName": "BRIAN",
        "middleName": "EDWARD",
        "lastName": "MULHALL",
        "fullName": "BRIAN EDWARD  MULHALL",
        "dateOfBirths": null,
        "sex": null,
        "address": null,
        "countryName": "USA",
        "countryCode": null,
        "street1": "2300 NEAL ST",
        "street2": null,
        "city": "AUGUSTA",
        "state": "GA",
        "zipCode": "30906",
        "county": null,
        "convictiontype": null,
        "aliases": null,
        "offenses": null,
        "photoUrl": null,
        "source": "Test List Two",
        "otherInformation": "SOME INFORMATION",
        "idNumber": null,
        "verificationResult": null,
        "driverLicenseVerificationResult": null
      }
    ]
  }
]

Note

There can be multiple profiles in the "Profiles" field, because a person can be found in the multiple lists.

Sample Result Without a Match

[
  {
    "serviceId": "aed0308e-209e-46a1-9cf5-5171da0215b1",
    "serviceName": "Custom Screening List",
    "serviceDescription": "Check person in Custom Screening List Of Persons. These lists are created by Customer him/herself through the portal",
    "error": null,
    "success": true,
    "locationId": 0,
    "readOnlyAccessLocationIds": [
      0
    ],
    "profiles": []
  }
]