Upload Employee Government ID
| Time | Status | User Agent |
|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
Uploads/POSTs a passport or driver's license government ID for the specified employee. These IDs can be accessed under the employee's ID section of their Zeal UI employee dashboard.
Returns Skip link to Returns
Returns response status and a request id confirming the government ID posted to specified employee.
| attribute | type | description |
|---|---|---|
| success | boolean | Response status |
| data | object | POSTs government ID for requested employee and returns id number |
| errors | array | Contains list of error objects which consists of:message: Error messagecode: Error code as described in Error codes |
employeeID
string
required
the ID of the Employee
companyID
string
required
the ID of the Company
id_type
string
enum
required
type of the ID to be uploaded, current options are drivers_license, social-security_card and passport
drivers_licensesocial_security_cardpassport
Allowed:
drivers_license``social_security_card``passport
id_base64
string
required
base64 image of the ID to be uploaded
``200 200
``400 400
Updated 7 months ago
ShellNodeRubyPHPPython
xxxxxxxxxx
curl --request POST \
--url https://api.zeal.com/employees/id \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"id_type": "drivers_license"
}
'
Click Try It! to start a request and see the response here! Or choose an example:
application/json
200 - Result400 - Result
Updated7 months ago