Skip to content

Relationships

Schema relationships
graph LR
    Bgv -->|"employee"| Employees
    Bgv -->|"package"| BgvPackages

Properties

idstring
required·

The BGV's unique identifier

candidateobject

The BGV's candidate

addressobject

The candidate's address

6 properties
citystring

The city

countrystring

The country

postal_codestring

The postal code

statestring

The state

street_1string

The first line of the street address

street_2string

The second line of the street address

date_of_birthstring

The candidate's date of birth

emailsobject[]

The candidate's email addresses

3 properties
emailstring

The email address

is_primaryboolean

Whether the email address is primary

typestring

The type of email address

employee_numberstring

The candidate's employee number

first_namestring

The candidate's first name

genderstring

The candidate's gender

Possible values:
malefemalenon_binarynot_specifiedprefer_not_to_sayother
idstring

The candidate's unique identifier

last_namestring

The candidate's last name

middle_namestring

The candidate's middle name

namestring

The candidate's full name

phonesobject[]

The candidate's phone numbers

3 properties
extensionstring

The extension of the phone number

numberstring

The phone number

typestring

The type of phone number

checksobject[]

The BGV's checks

detailsstring

The check's details

idstring

The check's unique identifier

namestring

The check's name

resultstring

The check's result

statusstring

The check's status

typestring

The check's type

completed_atstring · date-time

The date and time of the BGV's completion

created_atstring · date-time

The date and time of the BGV's creation

documentsobject[]

The BGV's documents

idstring

The document's unique identifier

namestring

The document's name

typestring

The document's type

uploaded_atstring · date-time

The date and time of the document's upload

urlstring

The document's URL

employeeobject

The employee associated with the background verification

References: Employees → id
idstring

The employee's unique identifier

namestring

The employee's name

etagstring

The unique identifier for the specific version of the resource

expires_atstring · date-time

The date and time of the BGV's expiry

packageobject

The BGV's package

References: BgvPackages → id
idstring

The package's unique identifier

namestring

The package's name

package_groupobject

The package's package group

2 properties
idstring

The package group's unique identifier

namestring

The package group's name

remote_dataRecord<string, any>

Raw data returned from the remote API call.

reportobject

The BGV's report

expires_atstring · date-time

The date and time of the report's expiry

mime_typestring

The report's MIME type

requested_atstring · date-time

The date and time of the BGV's request

resultstring

The BGV's result

Possible values:
clearconsiderdiscrepantverifiedunable_to_verifynot_applicableunknown
statusstring

The BGV's status

Possible values:
draftinvitedpending_candidatein_progressinsufficientcompletedcanceledexpiredfailedunknown
submitted_atstring · date-time

The date and time of the candidate's submission

updated_atstring · date-time

The date and time of the BGV's last update

urlsobject[]

The BGV's URLs

typestring

The URL type

Possible values:
invitationconsentcandidate_portalreport
urlstring

The URL