API Reference
Search…
Custom Lists
Expand our Screening Checks service coverage with your own lists.
A custom lists object provides information on your custom lists. Custom lists can be added and managed through the custom lists page.
The API allows you to retrieve custom lists.
This is service is only available through our Enterprise Plan. Get in touch with your Account Manager or contact us to enable it.

The Custom List Object

Attribute
Type
Description
id
string
The unique identifier for a custom list.
name
string
The custom list's name.
description
string
The custom list's description.
stats
object
Details about the number of entities in the custom list. Also, see the stats object below.
createdAt
string
The date and time when the custom list was created.
updatedAt
string
The date and time when the custom list was updated.

The stats object

Attribute
Type
Description
personCount
number
The number of persons in the custom list.
companyCount
number
The number of companies in the custom list.