Getting started with the Onboarding API is easy:

1. Create an OAuth app.
2. Authorize users.
3. Create candidates.

Create an OAuth App

Onboarding API requires an OAuth app. To get started as a partner, create an OAuth App in Deel. You can follow this guide to create OAuth app in Deel. Once you create an OAuth app, follow the OAuth - Getting Started guide to implement OAuth in your app.

Authorize users

Once you implement OAuth in your application, enable your users to connect Deel to your organization.

📘

Please make sure to ask for candidates:write scope permission. It is required to create candidates. It is also the only scope you will need for this API write access.

After retrieving the access token, you can make API calls to create candidates in Deel.

Create a Candidate

Request URL

POST https://api.letsdeel.com/rest/v2/candidates

Request Body

POST 'https://api.letsdeel.com/rest/v2/candidates' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}' \
--header 'x-client-id: {client_id}' \
--data-raw '{ 
    "data": {
      "id": "dhzj64mgen",
      "first_name": "Taylor",
      "last_name": "Swift",
      "status": "offer-accepted",
      "link": "https://your-ats.com/path/to/candidate/dhzj64mgen",
      "email": "[email protected]",
      "nationality": "US",
      "country": "US",
      "state": "PA",
      "job_title": "Singer",
      "start_date": "2023-06-30",
    }
}'

Response Body

{
    "data": {
        "created": true
    }
}

Fields