v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Create Contractor ID Verification Link

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

post/contractors/id_upload_link

Request body

companyIDstring required

ID of the company

contractorIDstring required

ID of the contractor requiring ID information

send_to_workerboolean

Whether to automatically send the verification link to the worker

document_typestring[] required

The documents you want to collect using this link. Can include: government_photo_id, passport, social_security_card, and other

Response

200

datastring
successboolean
testModeboolean

Example response

{
  "data": "https://verification-link-url",
  "success": true
}