Skip to content

Relationships

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

Properties

idstring
required·

The unique identifier for the background verification case

candidateobject

The person whose background verification is being run. Providers may call this person a candidate, applicant, or employee.

addressobject

The candidate address used for the background verification case

6 properties
citystring

The city of the address

countrystring

The country of the address

postal_codestring

The postal code of the address

statestring

The state or province of the address

street_1string

The first line of the address

street_2string

The second line of the address

date_of_birthstring

The candidate date of birth

emailsobject[]

The candidate 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 provider or customer employee number associated with the candidate, when available. This is not a Truto employees.id reference.

first_namestring

The candidate first name

genderstring

The candidate gender. If no clear mapping is available, the raw provider value is returned.

idstring

The provider identifier for the candidate or applicant

last_namestring

The candidate last name

middle_namestring

The candidate middle name

namestring

The candidate full name

phonesobject[]

The candidate phone numbers

3 properties
extensionstring

The extension of the phone number

numberstring

The phone number

typestring

The type of phone number

candidate_portal_urlstring

A URL for the candidate portal, when available

checksobject[]

Individual checks that compose this background verification case.

detailsstring

Additional provider details for the check

idstring

The unique identifier for the check

namestring

The check name

resultstring

The check result

statusstring

The check lifecycle status

typestring

The check type

completed_atstring · date-time

The date when the background verification was completed

consent_urlstring

A URL for candidate consent, when available

created_atstring · date-time

The date when the background verification case was created

documentsobject[]

Documents associated with this background verification case.

idstring

The unique identifier for the document

namestring

The document name

typestring

The document type

uploaded_atstring · date-time

The date when the document was uploaded

urlstring

A provider URL for the document, when available

employeeobject

The HRIS employee associated with this background verification case when a real Truto employee identifier is known. Provider-specific employee numbers are returned on candidate.employee_number instead.

References: Employees → id
idstring

The unique identifier for employees

namestring

This represents the name of the employee

etagstring

The unique identifier for the specific version of the resource

expires_atstring · date-time

The date when the background verification expires

invitation_urlstring

A URL for the candidate invitation, when available

packageobject

The verification package, program, or screening bundle used for this case.

References: BgvPackages → id
idstring

The unique identifier for the BGV package

namestring

The name of the BGV package

remote_dataRecord<string, any>

Raw data returned from the remote API call.

reportobject

The final background verification report when available.

expires_atstring · date-time

The date when the report URL expires

mime_typestring

The report MIME type

urlstring

A URL for the report, when available

requested_atstring · date-time

The date when the background verification was requested

resultstring

The normalized verification outcome. This is not a hiring recommendation. If no clear mapping is available, the raw provider value is returned.

Possible values:
clearconsiderdiscrepantverifiedunable_to_verifynot_applicableunknown
statusstring

The normalized lifecycle status of the background verification case. If no clear mapping is available, the raw provider value is returned.

Possible values:
draftinvitedpending_candidatein_progressinsufficientcompletedcanceledexpiredfailedunknown
submitted_atstring · date-time

The date when the candidate submitted required information

updated_atstring · date-time

The date when the background verification case was updated