Using the Deel API, you can connect your company’s internal tools to Deel for an even smoother, personalized experience.
This enables you to implement customizable integrations between your company’s internal tools and the Deel platform, so you can determine what data transfer happens, and where. That makes managing your payroll and compliance operations even easier.
In this article you will find:
These are the current capabilities of Deel API, which are currently centered around our contractor product. The key API resources include:
- Off-cycle payments
- Invoice adjustments
We are continuing to expand the operations available via the API, including expanding capabilities with our other products such as EOR Employee contracts.
If you’re interested in learning more about the current or future functionality of Deel API, you can contact us 24/7, or reach out to your Deel point of contact.
If you are interested in implementing the API with your internal tools, you can access the API documentation.
You will first need to generate an access token, then use the token to create an API Sandbox account.
Generate access token
✅ Step 1 - Select the Apps & Integrations tab and then select the Developer Center
✅ Step 2 - Generate a token and choose a unique name
✅ Step 3 - Select the scopes for the access token and click Generate
✅ Step 4 - Copy the token and store it in a safe place
You won't be able to see the token again, so make sure you remember where you've copied it!
You can find more information on token creation in our API documentation guides.
Create an API sandbox account
The Deel API Sandbox is a test account that our clients and partners can use to test the API with sample data during the implementation phase. Users will be able to easily create a sandbox account (containing sample data) from the developer center in the Deel platform.
✅ Step 1 - Create new sandbox with an email address and password
✅ Step 2 - Click Confirm to create a sandbox
You can click Go To Sandbox to enter the sandbox immediately
✅ Step 3 - Access the sandbox from the Deel platform by clicking Go To Sandbox
You can find more information on sandbox creation in our API documentation guides.
How long does it take to set up an API?
This varies depending on the system the prospect is looking to sync the Deel platform; what resources you have available; as well as the range of functionalities you wish to set up within the API.
Setting up a basic 'proof of concept' may only take one day, but usually, we see the process takes a couple of weeks based on internal prioritization of the implementation.
Is Deel involved with the implementation process?
Deel is not at all involved in the implementation process and any consultative or development work should come from your own resources.
If you do have any specific questions about the API itself, we can help answer any questions you may have, you can reach out to the Deel Support team or to your Deel point of contact with these.
When will functionality for EOR be available?
These will be launching later in 2022 and will include operations such as logging
What support does Deel provide during the implementation process?
We’re happy to answer any technical questions you may have, or potentially share any insights on the integration you’re planning to build, but we don’t actively get involved in the implementation process itself.