For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Support Deel Home

Overview Platform Employer of Record Contractors Global Payroll HR Embedded Deel IT API Reference Changelog

Resources
Endpoints

Download invoice PDF
Get invoice by id
Retrieve a payment breakdown
Retrieve Deel invoices
Retrieve invoices
Retrieve payment receipts
Retrieve refund statements
Adjustments
Create a new adjustment
Delete an adjustment
Retrieve adjustments
Retrieve an adjustment
Retrieve categories
Update an adjustment
Event: IT Asset Archived
Event: IT Asset Created
Event: IT Asset Location Updated
List IT assets
Retrieve an IT asset
Ats
List feedbacks for an application
List interviews
List job openings
Retrieve a list of ATS job boards
Retrieve a list of ATS teams
Retrieve ATS Application form
Upload ATS Candidate CV
Upsert tags in bulk
Ats Application Sources
Retrieve a list of ATS application sources
Ats Applications
Add note to an application
Assign application to interview plan stage
Create ATS Application
Event: ATS Application Created
Event: ATS Application Transitioned
Retrieve a list of ATS applications
Retrieve ATS application
Ats Attachments
Retrieve paginated list of ATS attachment files
Ats Candidates
Create ATS Candidate
Create candidate tags
Retrieve paginated list of ATS Candidates
Ats Departments
Retrieve a list of ATS departments
Ats Email Templates
Retrieve a list of published ATS email templates
Ats Employment Types
Retrieve a list of ATS employment types
Ats Hiring Members
Retrieve ATS hiring members
Ats Job Postings
Event: ATS Job Posting Created
Event: ATS Job Posting Publication Created
Event: ATS Job Posting Publication Updated
Event: ATS Job Posting Updated
Retrieve a list of ATS job postings
Retrieve ATS job posting
Retrieve ATS job postings
Ats Jobs
Create ATS Job
Retrieve a list of ATS jobs
Ats Locations
Retrieve a list of ATS locations
Ats Offers
Retrieve a list of ATS offers
Ats Reasons
Retrieve paginated list of ATS Rejection/Archivation reasons
Ats Tags
List tags
Candidates
Add Candidate
Clearance Requests
Cancel a clearance request
List clearance requests
Retrieve a clearance request
Consent
Create a consent token
Amend contract
List contract amendments
Attach a file to contract
Get worker invite link
Preview a contract agreement
Remove invite
Retrieve contractor payment dates
Send contract to worker
Sign a contract
Add external Id
Approve an equity exercise
Create a new contract
Create a request to exercise equity.
Create a work statement payment policy
Event: Contract Amended
Event: Contract Created
Event: Contract Duplicated
Event: Contract Sign Team Member Invited
Event: Contract Status Updated
List contract termination reasons
List of contracts
List work statement payment policies
Reject contract
Retrieve a single contract
Retrieve contract PDF download link
Retrieve contract templates
Sign Amendment
Sign worker contract
Update contract payment type
Calculate Employee Costs Globally
Cost Centers
Assign cost centers to an employment contract
Get cost centers by legal entity
Sync cost centers for legal entity
Delete Contract custom field by Id
Get custom fields from contracts
List all custom fields
Retrieve custom fields for a contract
Update custom field value
Delete the custom field value from Worker by Id
Get custom field from people by id
List all people custom fields
Retrieve custom fields for a worker
Update custom field value
Get list of payslips for an EOR employee
Modify bank account for an EOR employee
Add Files To Legal Entity Registration Document
Create Organization Secure Vault Folder
Delete Legal Entity Registration Document
Delete Legal Entity Registration Document Files
Delete Organization Secure Vault File
Delete Organization Secure Vault Folder
Download Legal Entity Registration Document File
Download Legal Entity Registration Document Requirement Template
Get Legal Entity Registration Document
Get Organization Secure Vault Folder
List Legal Entity Registration Documents
List Organization Registration Documents
List Organization Secure Vault Folder Items
Submit Legal Entity Registration Documents
Update Legal Entity Registration Document Files
Update Organization Secure Vault Folder
Upload Organization Secure Vault Files
Upload Organization Secure Vault Files To Folder
Employee Information
Employee additional info template
Acknowledge assignment agreement
Event: EOR Project Assignment Checkin Created
Event: EOR Project Assignment Created
Event: EOR Quote Created
Get amendment data points configuration by country
Get employee agreement draft preview
Modify bank account for an EOR employee
Reject an EOR quote
Accept amendment
Cancel amendment
Confirm amendment
Contract amendment PDF
Create amendment
Event: EOR Amendment Status Updated
Get amendment by ID
Get amendment validation settings
Get amendments by contract
Retrieve Effective Date Limitations
Sign a contract amendment (employee)
Update amendment
Validate amendment data points
Retrieve Benefits for EOR Contract
Eor Contract
Create an EOR contract
Retrieve EOR Contract Details
Update EOR Contract
Fetch EOR contract document
Fetch EOR contract documents
Cancel EOR Contract
Delay EOR employee onboarding
Fetch EOR Contract form
Fetch Start Date for EOR Contracts
Get EOR Additional Costs
Retrieve Benefits by Country
Retrieve detailed hiring guide for a country
Sign EOR contract document
Update Employee Information for EOR Contract
List of job scope templates for EOR contracts
Request job scope validation
Create client sign off
Get additional information required to request employee termination
Retrieve Employee Time Off Data for Offboarding
Retrieve offboarding attachment
Retrieve Offboarding Request
Retrieve restricted offboarding dates
Submit employee resignation PTO review
Submit employee sign-off review for offboarding documents
Event: EOR Payslips Available
Retrieve employee payslip records
Accept EOR project assignment as client
Fetch EOR project assignment PDF
Fetch Project Assignment Checkin Questionnaire Data
Submit Project Assignment Checkin Questionnaire Data
Get termination
Initiate EOR contract termination request
Request EOR Contract Resignation
Termination Request
Create EOR Worker
Download employee agreement PDF
Preview job offer letter
Sign a contract
Retrieve bank account guide
Retrieve bank account guide
Retrieve Benefits for Employee
Acknowledge a compliance document
Download employee compliance document template
Download submitted compliance document
List of employee compliance documents
Upload employee compliance document
List HR verification letters and documents
Add additional information
Add bank account
List of tax documents for an employee
Update additional information
Change EOR Mailbox Password
Preview Resignation Letter
Request contract resignation
Retrieve worker resignations
Sign Resignation Letter
Submit EOR Worker Resignation
Retrieve payslip PDF download link
Create equity or token tax event
List equity awards granted
List equity grant expense amortization records
List equity grant total expense records
List equity grant valuations
List equity grants with tax events
List equity option ledger entries
List equity participants
List Shareworks equity exercises
Files
Check file upload status
Complete a multipart upload
Create a file upload
Forms
Fetch multiple EOR Contract forms
Get worker additional fields for (EOR)
Add payroll migration files to a legal entity
Download a GP worker payslip
Event: GP Payslips Available
Event: GP Termination Confirmed
Get a payroll migration import
Get additional info for a contract
List payroll groups for a legal entity
List payroll migration imports for a legal entity
Retrieve additional information fields for GP workers by country
Submit a payroll migration import for review
Update employment type for a contract
Create a Global Payroll (GP) contract
Request termination
Groups
Clone a Group
Create a group
Delete a group
Edit a group
Return list of groups
Event: Employee Created Contractor
Event: Employee Created Direct
Event: Employee Created EOR
Event: Employee Updated Direct
Event: Worker Created (SCIM)
Event: Worker V2 Created
Event: Worker V2 Deleted
Event: Worker V2 Updated
Hrx Documents
Download HRX documents
Retrieve HRX documents
Ic Invoicing Taxes
Create IC invoicing tax
Delete IC invoicing tax
Get IC invoicing taxes
Update IC invoicing tax
Immigration
Create an immigration case
Event: Immigration Case Process Status Update
Event: Immigration Case Renewal Created
Get business visa eligibility and requirements
Get immigration case details
Get specific immigration case details
Immigration document
Immigration visa types
List case notes
List of immigration cases
List of immigration cases for workers
Retrieve a required document for a case
Retrieve onboarding right-to-work case for a worker
Upload a required immigration document
Integrations
Get integration consent
Create an invoice adjustment
Delete adjustment
Event: Invoice Adjustment Created
Event: Invoice Adjustment Pending For Approval
Event: Invoice Adjustment Reviewed
Invoice line item by Id
Invoice line items by contract
List invoice adjustments
Review a single invoice adjustment
Update an invoice adjustment
It Agreements
List agreements
Retrieve an agreement
It Assets
Create a collection for an IT asset
Create a delivery request for an IT asset
Create an IT asset
Update asset location
It Orders
Cancel an IT order
It Warehouses
List warehouses
Retrieve a warehouse
Knowledge Hub
Get Knowledge Hub Country Guides by Country Code
Learning
Event: Engage Learning Journeys Assignments Created
Event: Engage Learning Journeys Assignments Reminded
Retrieve worker's actionable journeys
Legal Entities
Create a new legal entity
Create a new light legal entity
Delete a legal entity
Edit a legal entity
Get registration/tax identifier fields for a country
List all industry subcategories
List of legal entities
Retrieve a legal entity
Update GP employee app access for a legal entity
List Cycles
List payroll cycles
Job titles list
Retrieve Country List
Retrieve lookup information for currencies, countries, entity types, etc
Retrieve Seniority Levels
Retrieve Supported Currency List
Retrieve Time-Off Types
Create magic link
Managers
Create a Manager
Generate magic link for manager login
Retrieve List of Managers
Milestones
Create a Milestone
Delete a Milestone
Retrieve a single milestone
Retrieve Milestones by Contract
Event: Oauth2 Token Revoked
Add off-cycle payment
Get Contract Off Cycle Payment By Id
List of off-cycle payments
Off Cycle Payments
Retrieve a single off-cycle payment
Retrieve offboarding list
Retrieve termination details
Retrieve termination details by HRIS profile identifier
On Demand Payroll
Attach entries to On-Demand Payroll
Cancel On-Demand Payroll
Create On-Demand Payroll
Detach entries from On-Demand Payroll
List On-Demand Payroll entries
Retrieve current On-Demand Payroll
Submit On-Demand Payroll
Onboarding
Event: Onboarding Checklist Updated
Event: Onboarding Status Updated
Get onboarding details by employee HRIS profile ID
Get onboarding details by onboarding tracker ID
List onboarding employees
Event: IT Order Created
Event: IT Order Updated
List IT orders
Retrieve an IT order
Organization Structure
Create a new HRIS Organization Structure.
Delete an Org Structure from the Organization
Delete an Org Structure from the Organization by external ID
Get Organization Structure
Get Organization Structure by External ID
Get Organization Structures
Update an existing HRIS Org Structure
Update an existing HRIS Org Structure by external ID
Update organization structure
Update organization structure team custom fields
Organization Tasks
List organization tasks
Create a session token for a child organization
Create child organization
Create organization custom role.
Get Current Organization
Get Teams
Get the roles of the current organization.
Retrieve Departments
Retrieve working locations
Update organization custom role
Payments
Create and pay a payment statement
Event: Payment Statement Initiated
Event: Payment Statement Mark Paid
Retrieve a payment statement
Add/Edit Bank Details
Change the auto-withdrawal setting
Create a bank transfer method
Delete Bank Details
Dynamic Requirements
Fetch all payout methods
Get Bank Details
Get bank transfer requirements
Get bank transfer supported routes for contractor
Get the auto-withdrawal setting
List Contractor Balances
Request to withdraw funds
Update a bank transfer method
Update auto withdraw setting for contractor
Event: Payslip Document Deleted
Retrieve employee payslips
People
Create a direct employee
Create a person without a contract
Get my current personal profile
List of People
Retrieve a single person
Update working location
Get personal information by id
Get worker profile by external ID
Profiles
Update personal information
Update personal information by external id
List IT hardware policies
Positions
Apply changes to positions.
Get Positions by Profile
Event: Profile KYC Changed
Create Hourly Report Preset
Create Hourly Report Root Preset
Delete Hourly Report Preset
Get Hourly Report Preset by ID
Get Hourly Report Presets
Get Hourly Report Root Preset by ID
Get Hourly Report Root Presets
Update Hourly Report Preset
Refund Statements
Retrieve refund statement credit-note breakdown
Reports
Download gross to net report
Gets G2N report data for a given payroll cycle by it's ID.
List gross-to-net report.
List payroll events by legal entity
Screenings
Create manual verification screening
Create Veriff session
Event: Background Check Result Available
Get entity screening details
Get verification method
Get worker's KYC details
Submit external KYC
Talent
List job requests
Tasks
Create a new task
Delete task
List of tasks
Review a single task
Review multiple tasks
Update Task By ID
Event: Tax Document Available
Event: Tax Document Deleted
Terminations
Delete Contract Termination Request
Event: Contract Terminated
Terminate contract
Time Off
Approve or reject time-off requests
Cancel time-off request
Create time-off request
Event: Time Off Created
Event: Time Off Deleted
Event: Time Off Reviewed
Event: Time Off Updated
Get Policies for Organization
Get Profile Entitlements
Get Profiles Assigned to Policy
Get Time Off Events for Profile
Get time-off attachment download URL
Get Work Schedule and Holidays
List policies
List time-off requests
List time-off requests for Organization
Process time-off requests from an external HRIS
Retrieve policy validation templates
Update time-off request
Validate time-off request
Create a New Shift Rate
Delete a Shift Rate by external ID
Generate timesheet upload url
Retrieve a Paginated List of Shift Rates
Retrieve a Shift Rate by External ID
Retrieve a timesheet
Review a submitted timesheet
Update a shift rate
Time Tracking Shifts
Create raw time tracking shifts
Create shifts
Delete a Shift by External ID
Delete multiple shifts by External ID
Get shift details
List of shifts
Update a shift
Timesheets
Create a timesheet entry
Create Timesheet Review
Delete a timesheet entry
Event: Timesheet Created
Event: Timesheet Reviewed
Get Timesheet By Id
List of timesheets
List of timesheets by contract
Retrieve a single timesheet entry
Review a single timesheet
Review multiple timesheets
Update a timesheet entry
Update Timesheet
Treasury
Create Vendor Bill
Upload Vendor Bill Attachment
List users
Retrieve a single User
Create a webhook
Delete a webhook
List webhook event types
List webhooks
Retrieve a single webhook
Update a webhook
Worker Hr
Get HRX manager for worker
Add bank account
Add GP Workers Additional Information
Modify bank account
Retrieve bank accounts
Retrieve bank guide
Update address
Update compensation
Update employee information
Update GP worker additional information
Update PTO policy
Worker Relations
Create a parent worker relation
Create a parent worker relation with external id
Create a worker relation
Create child worker relation
Create child worker relation with external Id
Create worker relation type
Create worker relation with external Ids
Delete a worker relation
Delete a worker relation by external id
Delete a worker relation type
Delete a worker relation type by external id
Fetch Worker Relations of a given HrisProfile by external id
List of worker relations
Retrieve all worker relation types
Update a worker relation type
Update a worker relation type by external id
Worker Session
Create worker access token
Delete worker access token
Complete individual contractor profile setup
Create a new worker
Create a tax form for the authenticated worker
Delete the submission of one compliance document of a worker contract
Get a download URL for one compliance document of a worker contract
Get invoice details by ID
List compliance documents of a worker contract
List of worker compliance documents
List tax forms for the authenticated worker
Retrieve IC worker invoice PDF download link
Retrieve one compliance document of a worker contract
Submit files for one compliance document of a worker contract
Update a tax form for the authenticated worker

Support Deel Home

Endpoints

Onboarding

API endpoints related to Onboarding.

Was this page helpful?