Integration POST

I-9 & E-Verify Integrated POST

This API is used to create a new employee or re-hire an existing employee within Guardian and trigger the integrated I-9 workflow. This request is used to add new hires or a new period of employment to Guardian while initiating and overseeing the I-9 and E-Verify process from an external system (e.g. ATS). For re-hires, this workflow assumes that the existing employee record in Guardian is in a terminated state at the time of the request.

For external applications equipped to receive I-9 and/or E-Verify status updates, the value provided for the integrationCandidateId is used to define the employee in the subsequent Guardian status update requests.

 

Method

POST

 

Parameters

Parameter Label Description Type Max Required
integrationCandidateId Partner employee/candidate unique id string 50 Yes
firstName First Name Employee’s first name string 40 Yes
lastName Last Name Employee’s last name string 40 Yes
startDate Date Hired Employee’s hire date date string N/A Yes
emailAddress E-Mail Employee’s email address string 80 Yes
locationId Job Location Employee’s assigned worksite location’s system ID int N/A Yes
onboardingType Indicates the new hire’s applicable workflow. ‘on-site’ signifies the employee will meet with a defined Guardian user to complete the I-9. ‘remote’ signifies the employee will find an individual to act as the authorized representative. string N/A Yes
employeeReturnUrl Designates the webpage the employee is re-directed to after completing Section 1 of the I-9. string 255 No
id System generated unique key int N/A No
middleName Middle Name Employee’s middle name string 25 No
socialSecurityNumber Social Security # Employee’s social security number string 11 No
dateOfBirth Date of Birth Employee’s birthdate date string N/A No
profileId Employee ID Employee’s company-issued identification string 30 No
otherName Maiden Name Employee’s maiden name string 40 No
jobTitle Title Employee’s title string 80 No
legalEntity Current Business Unit Employee’s assigned legal entity’s system ID int N/A No
languagePreference Preferred Language Employee’s preferred language (used to present onscreen help text). Send a 1 value to indicate ‘English’ and 2 to indicate ‘Spanish’ int N/A No
custom1 NA Optional Organization-defined custom field string 255 No
custom2 NA Optional Organization-defined custom field string 255 No
custom3 NA Optional Organization-defined custom field string 255 No
custom4 NA Optional Organization-defined custom field string 255 No
custom5 NA Optional Organization-defined custom field string 255 No
custom6 NA Optional Organization-defined custom field string 255 No
custom7 NA Optional Organization-defined custom field string 255 No
custom8 NA Optional Organization-defined custom field string 255 No
notificationEmail1 Address 1 Optional organization-defined email notification recipient string 255 No
notificationEmail2 Address 2 Optional organization-defined email notification recipient string 255 No
addressStreet Line 1 Physical street address string 80 No
addressStreet2 Line 2 Physical street address string 80 No
addressApartment Apt # Apartment number string 80 No
addressCity City City address string 50 No
addressState State State address string 20 No
addressCountry Country Country address string 50 No
addressZip Zip Zip code address string 10 No
workNumber Work Phone Work phone number string 20 No
workExtension Ext Work phone extension number string 10 No
homeNumber Home Phone Home phone number string 20 No
homeExtension Ext Home phone extension number string 10 No
cellNumber Cell Phone Cell phone number string 20 No
cellExtension Ext Cell phone extension number string 10 No

 

Example

Request Example

POST https:///v1/partners/i9s/section1


 {
 ""integrationCandidateId"": ""123456""
 ""firstName"": ""Jennifer"",
 ""lastName"": ""Smith"",
 ""startDate"": ""2014-01-01"",
 ""emailAddress"": """",
 ""locationId"": 1,
 ""onboardingType"": ""on-site"",
 ""employeeReturnUrl"": ""http://www.examplereturnurl.com
 ""dateOfBirth"": ""04/02/1990"",
 ""middleName"": ""P"",
 ""languagePreference"": 1,
 ""socialSecurityNumber"": ""111-222-333"",
 ""addressStreet"": ""400 17th Street"",
 ""addressApartment"": ""#1238"",
 ""addressCity"": ""Atlanta"",
 ""addressState"": ""GA"",
 ""addressZip"": ""30309""
 }

 

Response Example


 {
 ""i9Section1Link"": ""https:///4DCGI/WEB_Log_Login/EMP/JR6EROOX21G8QR4E/RMLNM"",
 ""id"": 418460,
 ""links"": [
 {
 ""href"": ""/v1/partners/i9s/section1/"",
 ""rel"": ""self""
 }
 ]
 }