Skip to content

Deel: Submit employee sign-off review for offboarding documents

Deel eorOffboarding.reviewEoroffboardingEmployeeSignOffs: arguments, response, policy and SDK examples.

← EOR offboarding operations · Get started

Operation deel.eoroffboarding_revieweoroffboardingemployeesignoffs

Provider route: POST /eor/contracts/{contract_id}/offboarding/review-employee-sign-offs. 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["eorOffboarding"]["reviewEoroffboardingEmployeeSignOffs"]>[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.eorOffboarding.reviewEoroffboardingEmployeeSignOffs(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_offboarding.review_eoroffboarding_employee_sign_offs(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.dataModelOptionalExpand Submit employee sign-off review for offboarding documents — request body — body data

Referenced models: Submit employee sign-off review for offboarding documents — request body — body data

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Create client sign off — 200 response body

Referenced models: Create client sign off — 200 response body

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

Submit employee sign-off review for offboarding documents — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
approvedbooleanRequired within parentIndicates if the employee has approved the sign-off review
requested_changesstring or nullRequired within parentDetails of requested changes if the review is not approved
Maximum length: 2000
reviewer_signaturestring or nullRequired within parentSignature of the reviewer if the review is approved
Maximum length: 1000
Create client sign off — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create client sign off — 200 response body — data

Referenced models: Create client sign off — 200 response body — data

Create client sign off — 200 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 Create client sign off — 200 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, Create client sign off — 200 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

Create client sign off — 200 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 Create client sign off — 200 response body — data documents offboarding item
resignation_letterJSONOptional
resignation_letter (anyOf 1)ModelAlternativeExpand Create client sign off — 200 response body — data documents resignation letter created at, id, signature, signed at, updated at
resignation_letter (anyOf 2)nullAlternative
supportingarrayRequired within parent
supporting[]ModelEach itemExpand Create client sign off — 200 response body — data documents supporting item

Referenced models: Create client sign off — 200 response body — data documents supporting item, Create client sign off — 200 response body — data documents offboarding item, Create client sign off — 200 response body — data documents resignation letter created at, id, signature, signed at, updated at

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

SDK function policy ID: deel.eoroffboarding_revieweoroffboardingemployeesignoffs. Catalog operation: eoroffboarding_revieweoroffboardingemployeesignoffs. 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.