Skip to main content
GET
List background checks

Authorizations

X-API-Key
string
header
required

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

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
status
enum<string>

Filter background checks by status Status of the background check:

  • pending: Background check is being processed
  • completed: Background check has been completed successfully
  • error: Background check encountered an error during processing
Available options:
pending,
completed,
error
Example:

"completed"

country
enum<string>

Filter background checks by country Country scope for background check:

  • MX: Mexico-specific background checks
  • ALL: International background checks across multiple countries
Available options:
MX,
ALL
Example:

"MX"

order[score]
enum<string>

Order by background check score

Available options:
asc,
desc
Example:

"asc"

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 Checks

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

"/background-checks"

@type
string
default:hydra:Collection
hydra:member
object[]
hydra:totalItems
integer

Total number of items found

Required range: x >= 0
Example:

1

hydra:view
object

Pagination information