Skip to main content
GET
List background check records

Authorizations

X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

backgroundCheckId
string<uuid>
required

The background check ID

Query Parameters

id[lt]
string

Collection cursor pointer to the next page

id[gt]
string

Collection cursor pointer to the previous page

itemsPerPage
integer
default:20

Number of items per page

Required range: 1 <= x <= 1000
category
enum<string>

Filter background check records by category Category of background check:

  • personal_identity: Identity verification and personal information
  • criminal_record: Criminal background and legal history
  • legal_background: Legal proceedings and court records
  • business_background: Business registration and commercial activity
  • professional_background: Professional licenses and certifications
  • credit_history: Credit and financial history
  • taxes_and_finances: Tax compliance and financial records
  • affiliations_and_insurances: Professional affiliations and insurance records
  • driving_licenses: Driving licenses and vehicle permits
  • vehicle_information: Vehicle ownership and registration
  • vehicle_permits: Vehicle permits and registrations
  • traffic_fines: Traffic violations and fines
  • alert_in_media: Media mentions and public records
  • behavior: Behavioral patterns and risk indicators
  • international_background: International records and verification
  • politically_exposed_person: PEP (Politically Exposed Person) screening
  • document_validation: Document authenticity verification
  • unknown: Unknown or unclassified category
Available options:
affiliations_and_insurances,
alert_in_media,
behavior,
business_background,
criminal_record,
driving_licenses,
international_background,
legal_background,
personal_identity,
professional_background,
traffic_fines,
vehicle_information,
vehicle_permits,
taxes_and_finances,
politically_exposed_person,
credit_history,
document_validation,
unknown
Example:

"criminal_record"

order[createdAt]
enum<string>

Order by resource creation date

Available options:
asc,
desc
Example:

"asc"

order[updatedAt]
enum<string>

Order by resource update date

Available options:
asc,
desc
Example:

"asc"

Response

Background Check Records

@context
string
default:/contexts/BackgroundCheckRecord
@id
string
Example:

"/background-checks/91ab5678-1234-5678-9abc-def012345678/records"

@type
string
default:hydra:Collection
hydra:member
object[]
hydra:view
object

Pagination information