> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lumos.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Deel

## After this article

You'll be able to connect Deel to Lumos through the Merge.dev partnership to sync employee data, and optionally set Deel as a source of user data in Lumos.

## Capabilities

| Functionality | Type | Sync | Provision | Description |
| - | - | - | - | - |
| Users | Account | Yes | No | Employee records synced via Merge.dev |

As a Merge.dev-brokered HRIS integration, Lumos reconciles account status from the HRIS user status:

* Active maps to Active
* Inactive maps to Suspended
* Pending maps to Staged
* Deleted (no longer returned) maps to Deprovisioned.
* When Deel is the User Source, employment status is reconciled separately:
  * Active maps to Active
  * Inactive maps to Inactive
  * Pending maps to Staged
  * Deleted maps to Inactive.
  * Attributes available for mapping in User Sources include Manager, Team, Title, Employment Type, Start Date, and Termination Date. Per-app field support varies.

## Required plan and roles

* **Deel role:** you must be a **Deel admin** to complete the linking flow.
* **API access:** your Deel account must have **API access enabled**. If you're unsure, contact your Deel account manager to confirm.

## Read-only access vs provisioning

**Is read-only possible?** Yes, and it's the only mode this integration supports.

**What read-only requires.** A Deel admin completes the linking flow through Merge.dev with API access enabled on the Deel account, exactly as described below. There's no separate credential to choose, since this is the only supported mode.

**Watch out for.** Don't expect this connector to create, update, or deprovision Deel accounts, it only reconciles account status and employment data from Deel into Lumos. If you also set Deel as a Source of Truth, that only changes which attributes Lumos reads from Deel, not whether it can write back.

## Instructions

Lumos partners with Merge.dev for the Deel integration. For the integration requirements, see the Merge.dev documentation.

**Phase 1: Prepare Deel**

1. Confirm you're a Deel admin and that API access is enabled on your Deel account.

**Phase 2: Connect in Lumos**

1. Click the Deel card in your Lumos integrations (reconnect an existing card or add a new one).
2. Click the **Connect Deel** button.
3. Follow the instructions in the pop-up that appears to finish connecting the integration.
4. After connecting, you can set Deel as a source of user data through the **Source of Truth** settings.

## Troubleshooting

**The linking flow won't complete.** Confirm the account you're using is a Deel admin. Non-admin accounts can't finish the Merge linking flow.

**Connection fails or no data syncs.** Verify that API access is enabled on your Deel account. Contact your Deel account manager to confirm the setting if you're unsure.
