API Reference

Create Contractor ID Upload Link

post
https://api.zeal.com/contractors/id_upload_link

Creates a shareable link for contractors to submit their ID verification information when they receive an id_verification_required status.

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

Use to:

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

Returns

attributetypedescription
successbooleanResponse status
dataobjectThe generated verification link URL
errorsarrayContains a list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Body Params
string
required

ID of the company

string
required

ID of the contractor requiring ID information

boolean
Defaults to false

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*
Responses

Updated 7 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago

Did this page help you?