Bgv Object

---

id

string

REQUIRED · 

The BGV's unique identifier

candidate

object

The BGV's candidate

id

string

The candidate's unique identifier

first_name

string

The candidate's first name

middle_name

string

The candidate's middle name

last_name

string

The candidate's last name

name

string

The candidate's full name

emails

object[]

The candidate's email addresses

email

string

The email address

type

string

The type of email address

is_primary

boolean

Whether the email address is primary

phones

object[]

The candidate's phone numbers

number

string

The phone number

extension

string

The extension of the phone number

type

string

The type of phone number

gender

string

The candidate's gender

All possible enum values:

• male
• female
• non_binary
• not_specified
• prefer_not_to_say
• other

date_of_birth

string

The candidate's date of birth

address

object

The candidate's address

street_1

string

The first line of the street address

street_2

string

The second line of the street address

city

string

The city

state

string

The state

postal_code

string

The postal code

country

string

The country

employee_number

string

The candidate's employee number

employee

object

The employee associated with the background verification

References: Employees → id

id

string

The employee's unique identifier

name

string

The employee's name

package

object

The BGV's package

References: BgvPackages → id

id

string

The package's unique identifier

name

string

The package's name

package_group

object

The package's package group

id

string

The package group's unique identifier

name

string

The package group's name

status

string

The BGV's status

All possible enum values:

• draft
• invited
• pending_candidate
• in_progress
• insufficient
• completed
• canceled
• expired
• failed
• unknown

result

string

The BGV's result

All possible enum values:

• clear
• consider
• discrepant
• verified
• unable_to_verify
• not_applicable
• unknown

checks

object[]

The BGV's checks

id

string

The check's unique identifier

name

string

The check's name

type

string

The check's type

status

string

The check's status

result

string

The check's result

details

string

The check's details

documents

object[]

The BGV's documents

id

string

The document's unique identifier

type

string

The document's type

name

string

The document's name

url

string

The document's URL

uploaded_at

string · date-time

The date and time of the document's upload

report

object

The BGV's report

expires_at

string · date-time

The date and time of the report's expiry

mime_type

string

The report's MIME type

urls

object[]

The BGV's URLs

url

string

The URL

type

string

The URL type

All possible enum values:

• invitation
• consent
• candidate_portal
• report

requested_at

string · date-time

The date and time of the BGV's request

submitted_at

string · date-time

The date and time of the candidate's submission

completed_at

string · date-time

The date and time of the BGV's completion

expires_at

string · date-time

The date and time of the BGV's expiry

created_at

string · date-time

The date and time of the BGV's creation

updated_at

string · date-time

The date and time of the BGV's last update

etag

string

The unique identifier for the specific version of the resource

remote_data

object

Raw data returned from the remote API call.