Upload Employee Government ID

Uploads a government issued ID for a specified employee in Zeal.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

Returns response status and a request id confirming the government ID posted to specified employee.

attributetypedescription
successbooleanResponse status
dataobjectPOSTs government ID for requested employee and returns id number
errorsarrayContains list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Body Params
string
required

the ID of the Employee

string
required

the ID of the Company

string
enum
required

type of the ID to be uploaded, current options are drivers_license, social-security_card and passport

Allowed:
string
required

base64 image of the ID to be uploaded

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json