Skip to content

Deel: Submit EOR Worker Resignation

Deel eorWorkerOffboarding.submitEorworkerResignation: arguments, response, policy and SDK examples.

← EOR worker offboarding operations · Get started

Operation deel.eorworkeroffboarding_submiteorworkerresignation

Provider route: POST /eor/workers/contracts/{contract_id}/offboarding. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["eorWorkerOffboarding"]["submitEorworkerResignation"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.eorWorkerOffboarding.submitEorworkerResignation(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.eor_worker_offboarding.submit_eorworker_resignation(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.contract_idstringRequired within parent
bodyobjectOptional
body.dataobjectRequired within parent
body.data.desired_end_datestringRequired within parentThe employee’s desired last day of work in YYYY-MM-DD format
Format: date
Pattern: ^\d{4}-\d{2}-\d{2}$
body.data.reasonstringRequired within parentThe reason for the employee’s resignation
One of: EMPLOYEE_IS_MOVING_TO_ANOTHER_COUNTRY, MOVING_EMPLOYEE_TO_INTERNAL_ENTITY, MOVING_EMPLOYEE_TO_DEEL_PEO, EMPLOYEE_FOUND_ANOTHER_JOB, EMPLOYEE_NOT_HAPPY_WITH_BENEFITS, EMPLOYEE_NOT_HAPPY_WITH_SALARY, EMPLOYEE_NOT_HAPPY_WITH_THE_ROLE, EMPLOYEE_NOT_HAPPY_WITH_COMPANY_CULTURE, EMPLOYEE_NOT_HAPPY_WITH_DEEL, EMPLOYEE_PROJECT_ENDED, EMPLOYEE_SWITCHING_TO_OTHER_EOR_PROVIDER, EMPLOYEE_LEFT_ROLE_FOR_PERSONAL_MATTERS, EMPLOYEE_MOVING_FROM_EOR_TO_CONTRACTOR_OR_FREELANCE, WORKER_TYPE_CHANGE, PREFERRED_NOT_TO_SAY
body.data.reason_detailstringOptionalAdditional details explaining the resignation reason
Maximum length: 500
body.data.signaturestringRequired within parentEmployee signature
body.data.supporting_documentsJSONOptionalThis field allows for uploading multiple files at once. Includes common image formats (JPG, JPEG, PNG, HEIC) and PDF documents.
body.data.supporting_documents (anyOf 1)objectAlternativeAdditional keys: not allowed
body.data.supporting_documents (anyOf 1).filenamestringRequired within parentMinimum length: 1
body.data.supporting_documents (anyOf 1).content_typestringRequired within parentMinimum length: 1
body.data.supporting_documents (anyOf 1).content_base64stringRequired within parent
body.data.supporting_documents (anyOf 2)arrayAlternativeMinimum items: 1
body.data.supporting_documents (anyOf 2)[]objectEach itemAdditional keys: not allowed
body.data.supporting_documents (anyOf 2)[].filenamestringRequired within parentMinimum length: 1
body.data.supporting_documents (anyOf 2)[].content_typestringRequired within parentMinimum length: 1
body.data.supporting_documents (anyOf 2)[].content_base64stringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Submit EOR Worker Resignation — 201 response body

Referenced models: Submit EOR Worker Resignation — 201 response body

5 more schemas are linked from the tables above, on the schema pages.

Submit EOR Worker Resignation — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Submit EOR Worker Resignation — 201 response body — data

Referenced models: Submit EOR Worker Resignation — 201 response body — data

Submit EOR Worker Resignation — 201 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
contract_idstringOptionalThe unique identifier of the employee contract.
created_atstringOptionalThe date and time the offboarding request was created
Format: date-time
desired_end_dateJSONOptional
desired_end_date (anyOf 1)stringAlternativeThe desired end date. If the date is not provided, it will be selected by HRX the closest date possible
Format: date-time
desired_end_date (anyOf 2)nullAlternativeThe desired end date. If the date is not provided, it will be selected by HRX the closest date possible
Format: date-time
documentsModelOptionalExpand Submit EOR Worker Resignation — 201 response body — data documents
Document management structure for termination workflow including review processes and supporting documents
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeThe definitive contract end date
Format: date-time
end_date (anyOf 2)nullAlternativeThe definitive contract end date
Format: date-time
idstringOptionalThe unique identifier of the offboarding request
Format: uuid
is_sensitivebooleanOptionalIndicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team.
request_dataJSONOptional
request_data (anyOf 1)ModelAlternativeExpand Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off
request_data (anyOf 2)nullAlternative
updated_atstringOptionalThe date and time the offboarding request was updated
Format: date-time

Referenced models: Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off, Submit EOR Worker Resignation — 201 response body — data documents

Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off
FieldTypePresenceDescription and constraints
$objectRoot
desired_end_dateJSONOptional
desired_end_date (anyOf 1)stringAlternativeThe desired end date. If the date is not provided, it will be selected by HRX the closest date possible
Format: date
desired_end_date (anyOf 2)nullAlternativeThe desired end date. If the date is not provided, it will be selected by HRX the closest date possible
Format: date
eligible_for_rehireJSONOptionalParameter to inform whether it would be possible for the client to hire the employee again
eligible_for_rehire (anyOf 1)stringAlternativeParameter to inform whether it would be possible for the client to hire the employee again
Known values: YES, NO, DONT_KNOW
eligible_for_rehire (anyOf 2)nullAlternative
eligible_for_rehire_reasonJSONOptional
eligible_for_rehire_reason (anyOf 1)stringAlternativeDescribe if the option DONT_KNOW was selected on eligible_for_rehire
eligible_for_rehire_reason (anyOf 2)nullAlternativeDescribe if the option DONT_KNOW was selected on eligible_for_rehire
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeThe definitive contract end date
Format: date-time
end_date (anyOf 2)nullAlternativeThe definitive contract end date
Format: date-time
reasonModelOptionalExpand Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off reason
The reason for the termination
reason_detailJSONOptional
reason_detail (anyOf 1)stringAlternativeOptional field to describe the reason behind the resignation request
reason_detail (anyOf 2)nullAlternativeOptional field to describe the reason behind the resignation request
used_time_offModelOptionalExpand Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off used time off
Time-off usage data including policy information and tracking periods

Referenced models: Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off used time off, Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off reason

Submit EOR Worker Resignation — 201 response body — data documents
FieldTypePresenceDescription and constraints
$objectRootDocument management structure for termination workflow including review processes and supporting documents
offboardingarrayRequired within parentDocument set shared that requires client or employee review
offboarding[]ModelEach itemExpand Sign Resignation Letter — 201 response body — data documents offboarding item
supportingarrayRequired within parent
supporting[]ModelEach itemExpand Sign Resignation Letter — 201 response body — data documents supporting item

Referenced models: Sign Resignation Letter — 201 response body — data documents supporting item, Sign Resignation Letter — 201 response body — data documents offboarding item

Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off used time off
FieldTypePresenceDescription and constraints
$objectRootTime-off usage data including policy information and tracking periods
additional_detailsJSONOptional
additional_details (anyOf 1)ModelAlternativeExpand Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off used time off additional details last updated at, notes, updated by
additional_details (anyOf 2)nullAlternative
is_deel_pto_confirmedbooleanRequired within parentIndicates whether the PTO allocation has been confirmed by Deel's system
time_offsarrayRequired within parent
time_offs[]ModelEach itemExpand Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off used time off time offs item

Referenced models: Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off used time off additional details last updated at, notes, updated by, Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off used time off time offs item

Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off reason
FieldTypePresenceDescription and constraints
$stringRootThe reason for the termination
Known values: STATUS_CHANGE, RELOCATION, COMPENSATION, RETIREMENT, JOB_ABANDONMENT, WORK_RELATED, PERSONAL, OTHER_OPPORTUNITY, NON_RENEWAL, PROBATION, ASSIGNMENT_ENDED, POSITION_ELIMINATION, FORCE_REDUCTION, DEATH, FOR_CAUSE, PERFORMANCE, MEDICAL, PERFORMANCE_ISSUES, ATTENDANCE_ISSUES, REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE, ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED, OFFER_WAS_REVOKED, EXITING_THE_MARKET, NO_LONGER_WISH_TO_WORK_WITH_DEEL, COMPANY_ACQUIRED, STEALING, MISCONDUCT, FALSIFYING, HARASSMENT, VIOLENCE, REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED, UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE, STANDARD_RESELLER_PRACTICE, MOVING_EMPLOYEE_TO_INTERNAL_ENTITY, MOVING_EMPLOYEE_TO_DEEL_PEO, OTHER
Sign Resignation Letter — 201 response body — data documents supporting item
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentThe date and time the file was created
Format: date-time
idstringRequired within parentThe unique identifier of the file
Format: cuid
is_additional_supporting_documentbooleanRequired within parentIndicates if this is an additional supporting document added after the initial submission
namestringRequired within parentThe name of the file
typestringRequired within parentThe type/extension of the file
updated_atstringRequired within parentThe date and time the file was updated
Format: date-time

SDK function policy ID: deel.eorworkeroffboarding_submiteorworkerresignation. Catalog operation: eorworkeroffboarding_submiteorworkerresignation. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["worker:write"]

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.