| 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 contractors need to provide ID documentation
- Integrate with your existing contractor 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:<br>`message`: Error message<br>`code`: Error code as described in [Error codes](https://docs.zeal.com/reference/error-codes) |

### Parameters

- **companyID**  
  `string`  
  required  
  ID of the company

- **contractorID**  
  `string`  
  required  
  ID of the contractor requiring ID information

- **send_to_worker**  
  `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\***  
  `ADD string`

### Example Request

```bash
curl --request POST \
     --url https://api.zeal.com/contractors/id_upload_link \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "send_to_worker": false
}'
```

### Response Codes

``200 - Result``  
``400 - Result``

Updated 7 months ago