Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.alterauth.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Connect your users to Deel for global payroll, HR management, and contractor payments.
PropertyValue
Provider IDdeel
CategoryHR
PKCESupported
Token refreshAutomatic
Redirect URIShown in Developer Portal

​
Step 1: Create a Deel OAuth App

1

Go to the Deel Developer Center

Navigate to Deel Developer Center and sign in.
2

Create a new app

Click Create New App.
3

Configure the application

Enter the application name and description. Add the Alter callback URL (from the Developer Portal) to the Redirect URI field.
4

Select scopes

Select the scopes your application needs. See Available Scopes below.
5

Get your credentials

Copy the Client ID and Client Secret.
Never share your Client Secret publicly. Store it securely and only enter it in the Alter Vault Developer Portal.

​
Step 2: Add to Alter Vault

1

Open the Developer Portal

Go to portal.alterauth.com and navigate to your app.
2

Add Deel provider

Go to OAuth Providers > Add Provider > Deel.
3

Enter credentials

  • Client ID: Paste your Deel Client ID
  • Client Secret: Paste your Deel Client Secret
4

Select scopes

Choose the scopes your app needs.
5

Save

Click Save. The provider is now active.

​
Available Scopes

​
Contracts

ScopeDescription
contracts:readRead access to contracts
contracts:writeWrite access to contracts

​
People

ScopeDescription
people:readRead access to people (employees and contractors)
people:writeWrite access to people

​
Payments and Invoices

ScopeDescription
payments:readRead access to payment information
invoices:readRead access to invoices
invoices:writeWrite access to invoices

​
Organizations

ScopeDescription
organizations:readRead access to organization information

​
Notes

  • For read-only HR integrations, contracts:read, people:read, and organizations:read provide sufficient access.
  • See the Deel API documentation for more details on authentication and available endpoints.