Background Screening Data Models

The following is a list of all background screening models:

POST Model

This is the main model that will be sent to a background screening provider.

POST model parameters
Parameters	Type	Description
ScreeningReferenceId	String	Screening Reference ID – An identifier to facilitate linking candidates back to entities in your own system. It will be unique.
ScreeningRequestedDate	String (yyyy-MM-ddTHH:mm:ss.fffZ)	Screening Requested Date.
OrderDetails	OrderDetails Model	Information around Order Details.
CandidatePersonal	CandidatePersonal Model	Information around Candidate.
CandidateProfile	CandidateProfile Model	Information around Candidate Education history, Work history, Reference.
JobRequisition	JobRequisitionModel	Information around job requisition being applied.

The OrderDetails, CandidatePersonal, CandidateProfile, and JobRequisition models are detailed in the next section.

OrderDetails Model

This model contains the Package Id, Billing Code, and Recruiter Email. All information is with regards to the screening order.

OrderDetails model parameters
Parameters	Type	Description
PackageId	String	Provider Package ID
BillingCode	String	Provider Billing Code
RecruiterEmail	String	Recruiter Email Address
HiringManagerEmail	String	Hiring Manager Email Address
SubmitterEmail	String	Submitter Email Address

CandidatePersonal Model

This model contains information related to the candidate personal information.

CandidatePersonal model parameters
Parameters	Type	Description
CandidateId	Number	Unique Identifier for Candidate
FirstName	String	Candidate First Name
LastName	String	Candidate Last Name
MiddleName	String	Candidate Middle Name
ConfirmedNoMiddleName	Boolean	Boolean value to indicate if there is a middle name.
PreferredGivenName	String	Candidate Preferred Given Name / Alias
Email*	String	Candidate Email
Phone	String	Candidate Phone Number
PostalAddress	PostalAddress Model	Candidate Postal Address

PostalAddress Model

This is a sub-model of the CandidatePersonal model. It contains information related to the candidate address.

CandidateProfile Model

This model contains information related to the Education History, Employment History, and References of the candidate.

CandidateProfile model parameters
Parameters	Type	Description
EducationHistory	List of CandidateEducationHistory model	Candidate Education History Information
EmploymentHistory	List of CandidateEmploymentHistory model	Candidate Employment History Information
References	List of CandidateReferences model	Candidate References Information

CandidateEducationHistory Model

This model forms the list of objects in the EducationHistory model. It contains information about the education history of the candidate.

Degree Model

This is a sub-model of CandidateEducationHistory model. It contains information specific to the degree.

SchoolLocation Model

This is a sub-model of CandidateEducationHistory model. It contains information specific to the school location.

CandidateEmploymentHistory Model

This model forms the list of objects in the EmploymentHistory model. It contains information about the education history of the candidate.

Location Model

This is a sub-model of CandidateEmploymentHistory model. It contains information specific to the Employment location.

CandidateReferences Model

This model forms the list of objects in the References model. It contains information about the candidate references.

JobRequisition Model

This model contains information related to the job requisition being applied by candidate.

JobRequisition model parameters
Parameters	Type	Description
JobRequisitionId	Number	Job Requisition ID
JobRequisitionTitle	String	Job Requisition Title
JobLocation	String	Job Location
DepartmentName	String	Job Department Name
DepartmentName	String	Job Requisition Hiring Manager
Recruiter	String	Job Requisition Recruiter