Skip to main content
GET
Retrieve a background check

Authorizations

X-API-Key
string
header
required

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

Path Parameters

id
string<uuid>
required

Response

Background Check

id
string<uuid>
required

Unique background check ID

Example:

"91ab5678-1234-5678-9abc-def012345678"

Entity associated with the background check

Example:

"/entities/91ab5678-1234-5678-9abc-def012345678"

country
enum<string>
required

Country scope for the background check

Available options:
MX,
ALL
Example:

"MX"

score
number<float>
required

Overall score returned by the background check provider

Example:

85.5

status
enum<string>
required

Processing status for the background check

Available options:
pending,
completed,
error
Example:

"completed"

scores
object[]
required

Scores returned for each background check category

databaseStatuses
object[]
required

Status information for each database checked by the provider

files
object[]
required

Files produced by the background check, including PDF reports when available

createdAt
string
required

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

updatedAt
string
required

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"

@context
any
@id
string<iri-reference>

Background Check IRI reference

Example:

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

@type
string
default:BackgroundCheck