Invite a contractor
Learn how to invite a contractor to sign the contract and complete the contract creation process
After you have signed the contract, the independent contractor must also sign it. This guide explains how to invite the contractor to sign the contract using the API.
Before you begin
To invite the contractor to sign the contract, make sure to have:
- The contract ID returned when creating the contract
- The contractor's email address
Step 1. Sending the contract
To send the contract, make a POST request to the Send contract to worker endpoint.
curl --request POST \
--url 'https://api.letsdeel.com/rest/v2/CONTRACT_ID/invitations' \
--header 'accept: application/json' \
--header 'authorization: Bearer TOKEN' \
--header 'content-type: application/json' \
--data '
{
"data": {
"email": "[email protected]",
"locale": "en",
"message": "Welcome to Acme Corp! Please sign the contract. We look forward to start working with you."
}
}
'
In the path:
| Name | Required | Type | Format | Description | Example |
|---|---|---|---|---|---|
CONTRACT_ID | true | string | UUID | The ID of the contract that the contractor must sign. | d3m0d3m0 |
In the body:
| Name | Required | Type | Format | Description | Example |
|---|---|---|---|---|---|
email | true | string | The email address of the contractor. | [email protected] | |
locale | false | string | ISO | The language code for the invitation email. Uses a two-letter ISO 639-1 language code. | en |
message | false | string | - | The message that will appear in the invitation sent to the contractor. | Welcome to Acme Corp! Please sign the contract. We look forward to start working with you. |
A note on emails
- If you're planning on creating a contract for testing purposes, don't use the same email used for the client account. Emails in the system must be unique and each one is linked to a separate account.
- Emails are not sent out when using the sandbox, so you won't receive the invitation email. To test the contract signing process, follow the instructions in Step 2. Test the contract signing as an Independent Contractor (from UI).
A successful response (201) returns a confirmation message that the invitation was sent and the contractor will receive the contract agreement to sign.
{
"data": {
"created": true
}
}
Step 2. Test the contract signing as a Independent Contractor (from UI)
If you're on a Sandbox, you can simulate the contract signing process as an contractor from the UI. When impersonating an contractor, keep in mind:
- Use a unique email address for the contractor account. If the email address already exists in the system, login issues may occur.
- Invitation emails are not sent in sandbox. Instead, locate the invite link directly from the UI.
To test the contract signing:
- After signing the contract, log into your Deel sandbox account.
- Go to People, locate the contractor, and click on their name to open their profile.
- On their profile page, under the Contracts card, click View contract for the one you would like to sign as an contractor.
- On the contract page, click Copy Invitation Link.
- Open an incognito browser session and paste the invitation link.
- Complete the onboarding process as an contractor. For detailed instructions on how to complete the creation of the contractor account, visit Contractor Account Overview.
- Sign the contract. You can find it on the Contracts card on the home page. To sign the contract, open it and then click Review & Sign.
Additional forms or documents may be required
Based on the country of residence of the contractor or the country where the company has business in, as a contractor you may be required to fill additional forms or provide additional documents.
Updated 22 days ago