Skip to main content
POST
Generate Employee Onboarding Link

Authorizations

Authorization
string
header
required

Body

application/json
companyID
string
required

Company ID of employer

employeeID
string
required

ID of Employee

employee_acct
boolean
default:false

If false, the employee account information (username and password) collection step of the onboarding will be left out

survey
boolean
default:false

If false, the employee survey step will be left out (Early Access)

i9_form
boolean
default:false

If false, the I9 form in the paperwork step of the onboarding will be left out

id_scan
boolean
default:false

If false, the ID scan step of the onboarding will be left out.

payment_method_required
boolean
default:true

If false, the onboarding worker will be able to skip the bank account collection section of onboarding

paycard
boolean
default:false

If false, the paycard enrollment screen will be left out. NOTE: Only applicable for Paycards (Early Access)

instant_pay
boolean

If false, the instant pay enrollment screen will be left out. NOTE: Only applicable for Instant Pay (Early Access)

Response

200

success
boolean
default:true
Example:

true

data
string
Example:

"https://payroll.your-domain.com/form/NjE5NmIyNThjZGQwMDIzYWEwMjFiL2NiYzFkMDcyYjAyNTRjZWY5MzUwNTdlZWExNmUyNjNkLzE2Mzc4NzcxMTcwMTIvP3Rlc3Q9dHJ1ZSZwcm9maWxlPXRydWUmwbG95ZWVfYWNjdD10cnVlJmlkX3NjYW49dHJ1ZSZpOT10cnVlJnBhcGVyd29yaz10cnVl"