| Time | Status | User Agent |  |
| :-- | :-- | :-- | :-- |
| Make a request to see history. |

#### URL Expired

The URL for this request expired after 30 days.

Retrieve an expirable link to Zeal's employee payroll onboarding. Zeal’s onboarding collects:

- Profile information (e.g. SSN, DOB, Address)
- Employee account username and password (optional)
- Employee Survey attributes (optional). **NOTE: Only applicable for Custom Attributes (Early Access)**
- ID collection (optional - Zeal collects Driver's License + Social Security Card OR Passport) NOTE - If passing the onboarding link in a `src` of an iframe, the `allow="camera"` flag must be passed in order for the iframe to prompt or access a user's camera.
- Paperwork. This includes the Federal W4, State W4, I-9 (optional--see below)
- Bank Account Information (optional)
- Paycard enrollment information for the employee (optional). **NOTE: Only applicable for Paycards (Early Access)**
- Instant Pay enrollment information for the employee (optional). **NOTE: Only applicable for Instant Pay (Early Access)**

You can choose whether you want to turn on or off these sections of Zeal onboarding by using this endpoint. This onboarding flow was custom-made to take less than 5 minutes to complete. After onboarding is completed, the employee can start getting paid.

## Returns   [Skip link to Returns](https://docs.zeal.com/reference/generate-employee-onboarding-link#returns)

Returns a success response and employee onboarding link.

| attribute | type | description |
| --- | --- | --- |
| success | boolean | Response status |
| data | object | Employee onboarding link |
| errors | array | Show child attributes<br>- **message** type: string description: Error message<br>- **status** type: number description: HTTP response code<br>- **code** type: number description: Error code (see [Error codes](https://docs.zeal.com/reference/generate-employee-onboarding-link)) |

companyID

string

required

Company ID of employer

employeeID

string

required

ID of Employee

employee_acct

boolean

Defaults to false

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

truefalse

survey

boolean

Defaults to false

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

truefalse

i9_form

boolean

Defaults to false

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

truefalse

id_scan

boolean

Defaults to false

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

truefalse

payment_method_required

boolean

Defaults to true

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

truefalse

paycard

boolean

Defaults to false

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

truefalse

instant_pay

boolean

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

truefalse

# ``200      200

# ``400      400

Updated 12 months ago

* * *

ShellNodeRubyPHPPython

```

xxxxxxxxxx

curl --request POST \

--url https://api.zeal.com/employees/onboard \

--header 'accept: application/json' \

--header 'content-type: application/json' \

--data '

{

"employee_acct": false,

"survey": false,

"i9_form": false,

"id_scan": false,

"payment_method_required": true,

"paycard": false

}

'
```

Click `Try It!` to start a request and see the response here! Or choose an example:

application/json

``200 - Result``400 - Result

Updated12 months ago

* * *