Create Employee ID Upload Link

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

Use to:

Generate verification links when employees need to provide ID documentation
Integrate with your existing employee onboarding workflow
Optionally send verification links directly to workers via email

Returns

attribute	type	description
success	boolean	Response status
data	object	The generated verification link URL
errors	array	Contains a list of error objects which consists of: `message`: Error message `code`: Error code as described in Error codes

Parameters

companyID
string
required
ID of the company
employeeID
string
required
ID of the employee requiring information
send_to_worker
boolean
Whether to automatically send the verification link to the worker
document_type
array of strings
required
The documents you want to collect using this link. Can include: government_photo_id, passport, social_security_card, and other
document_type*
ADD string

Example Request

curl --request POST \
     --url https://api.zeal.com/employees/id_upload_link \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Example Response

{
  "status": 200,
  "data": "New Example"
}