{"openapi":"3.1.0","info":{"title":"EOR Worker Endpoints","version":"1.0.0"},"paths":{"/eor/worker":{"post":{"operationId":"create-worker","summary":"Create EOR Worker","description":"Creates an EOR worker record and returns the associated `user_id`, `profile_id`, and `hris_profile_id`.\n **Token scopes**: `people:write`","tags":["subpackage_eorWorkerAccounts"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-accounts_createWorker_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEorWorker-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkerPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/eor/workers/contracts/{contract_id}/employee-agreement/download":{"get":{"operationId":"download-worker-employee-agreement","summary":"Download employee agreement PDF","description":"Returns a time-limited download URL for the employee agreement PDF associated with the given `contract_id`. When the optional `version` parameter is supplied and a version mismatch is detected, behaviour diverges from the default resolution path.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerAgreements"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"version","in":"query","description":"Optional version of the Employment Agreement to be signed. If informed and in the case of a mismatch, the API will return an error.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-agreements_downloadWorkerEmployeeAgreement_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"409":{"description":"Employment Agreement version mismatch.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadEmployeeAgreementPdfRequestConflictError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/workers/contracts/{contract_id}/offer-letter":{"get":{"operationId":"download-worker-offer-letter","summary":"Preview job offer letter","description":"Returns the job offer letter for an EOR contract in HTML format. IC and Global Payroll contract types are not supported and will not return a result.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerAgreements"],"parameters":[{"name":"contract_id","in":"path","description":"Deel contract id.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/workers/contracts/{contract_id}/signatures":{"post":{"operationId":"sign-eor-contract-as-worker","summary":"Sign a contract ","description":"Signs a contract on behalf of the contractor, transitioning contract status to active and completing the contractor onboarding workflow.\n **Token scopes**: `worker:write`","tags":["subpackage_eorWorkerAgreements"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-agreements_signEORContractAsWorker_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"409":{"description":"Employment Agreement version mismatch.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignAContractRequestConflictError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/eor/workers/banks-guide/country/{country}/currency/{currency}":{"get":{"operationId":"get-eor-worker-bank-guide-by-country-and-currency","summary":"Retrieve bank account guide","description":"Returns the bank account form guide for the specified `country` and `currency` combination, providing the field structure required to add a new bank account for an EOR employee.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerBanks"],"parameters":[{"name":"country","in":"path","description":"Country","required":true,"schema":{"type":"string"}},{"name":"currency","in":"path","description":"Currency","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-banks_getEORWorkerBankGuideByCountryAndCurrency_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveBankAccountGuide-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/workers/banks/guide":{"get":{"operationId":"get-eor-worker-bank-guide","summary":"Retrieve bank account guide","description":"Returns the bank account form guide for an EOR employee, providing the field structure required to add a new bank account.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerBanks"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-banks_getEORWorkerBankGuide_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/worker/benefits":{"get":{"operationId":"get-eor-worker-benefits","summary":"Retrieve Benefits for Employee","description":"Returns the benefits for the authenticated employee. The employee identity is inferred from the auth token, so this endpoint must be called with an employee-scoped token rather than a client token.\n **Token scopes**: `benefits:read`","tags":["subpackage_eorWorkerBenefits"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-benefits_getEORWorkerBenefits_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveBenefitsForEmployee-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/workers/compliance-documents/{document_id}/acknowledgement":{"post":{"operationId":"create-compliance-document-acknowledgement","summary":"Acknowledge a compliance document","description":"Submits the worker's consent acknowledgement for a compliance document that requires it. This operation is required before documents marked as needing acknowledgement are considered complete.\n **Token scopes**: `worker:write`","tags":["subpackage_eorWorkerCompliance"],"parameters":[{"name":"document_id","in":"path","description":"The unique identifier of the compliance document.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Document was acknowledged successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-compliance_createComplianceDocumentAcknowledgement_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcknowledgeAComplianceDocumentRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcknowledgeAComplianceDocumentRequestInternalServerError"}}}}}}},"/eor/workers/compliance-documents/{document_id}/templates/download":{"get":{"operationId":"download-compliance-document-template","summary":"Download employee compliance document template","description":"Returns a time-limited download URL for the compliance document template associated with the given `document_id`, only if a template exists for that document.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerCompliance"],"parameters":[{"name":"document_id","in":"path","description":"Unique identifier for a compliance document in Deel.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-compliance_downloadComplianceDocumentTemplate_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/workers/compliance-documents/{document_id}/download":{"get":{"operationId":"download-compliance-document","summary":"Download submitted compliance document","description":"Returns a time-limited download URL for a submitted compliance document. The URL expires at the time indicated by `expires_at` in the response.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerCompliance"],"parameters":[{"name":"document_id","in":"path","description":"Unique identifier for a compliance document in Deel.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-compliance_downloadComplianceDocument_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadSubmittedComplianceDocumentRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/workers/compliance-documents":{"get":{"operationId":"get-eor-worker-compliance-documents","summary":"List of employee compliance documents","description":"Returns the list of compliance documents associated with an EOR employee.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerCompliance"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-compliance_getEORWorkerComplianceDocuments_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Authentication failed. The access token is missing, expired, or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfEmployeeComplianceDocuments-v2026-01-01RequestUnauthorizedError"}}}},"403":{"description":"Access denied. The authenticated user does not have the required worker:read scope or is not an employee profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfEmployeeComplianceDocuments-v2026-01-01RequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfEmployeeComplianceDocuments-v2026-01-01RequestInternalServerError"}}}}}}},"/eor/workers/compliance-documents/{document_id}":{"post":{"operationId":"upload-eor-worker-compliance-document","summary":"Upload employee compliance document","description":"Uploads a compliance document file against the specified `document_id` for an EOR employee.\n **Token scopes**: `worker:write`","tags":["subpackage_eorWorkerCompliance"],"parameters":[{"name":"document_id","in":"path","description":"Unique identifier for a compliance document in Deel.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-compliance_uploadEORWorkerComplianceDocument_Response_200"}}}},"400":{"description":"Bad request. The file is missing or the document_id format is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadEmployeeComplianceDocument-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Authentication failed. Bearer token is missing, expired, or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadEmployeeComplianceDocument-v2026-01-01RequestUnauthorizedError"}}}},"403":{"description":"Forbidden. The worker does not have permission to upload to this compliance document, the document cannot be submitted in its current state, or the requirement is obsolete.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadEmployeeComplianceDocument-v2026-01-01RequestForbiddenError"}}}},"404":{"description":"The compliance document specified by document_id was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadEmployeeComplianceDocument-v2026-01-01RequestNotFoundError"}}}},"500":{"description":"Internal server error. The file upload failed or an unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadEmployeeComplianceDocument-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"description":"The employee compliance document data to upload","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The employee compliance document to upload. Accepted formats: PNG, JPG, JPEG, HEIC, PDF."}}}}}}}},"/eor/workers/contracts/{contract_id}/hr-documents":{"get":{"operationId":"get-eor-worker-hr-documents","summary":"List HR verification letters and documents","description":"Returns all HR verification letters and documents associated with the employee contract.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerDocuments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-documents_getEORWorkerHRDocuments_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/workers/contracts/{contract_id}/additional-information":{"post":{"operationId":"create-gp-worker-additional-information","summary":"Add additional information","description":"Adds supplemental information fields to an EOR employee's contract record.\n **Token scopes**: `worker:write`","tags":["subpackage_eorWorkerInformation"],"parameters":[{"name":"contract_id","in":"path","description":"Deel contract id.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-information_createGPWorkerAdditionalInformation_Response_200"}}}},"400":{"description":"Bad request. Contract not found, contract is not EOR, required base fields are missing, or country-specific additional field validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAdditionalInformation-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Authentication failed. Bearer token is missing, expired, or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAdditionalInformation-v2026-01-01RequestUnauthorizedError"}}}},"403":{"description":"Forbidden. The token lacks worker:write scope or the worker cannot update this contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAdditionalInformation-v2026-01-01RequestForbiddenError"}}}},"404":{"description":"Not found. No additional information template exists for the employment country/state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAdditionalInformation-v2026-01-01RequestNotFoundError"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAdditionalInformation-v2026-01-01RequestTooManyRequestsError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAdditionalInformation-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"description":"Add additional information for an EOR employee.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostRequestBodyContentApplicationJsonSchemaData","description":"Additional fields are country/state-specific and validated against the worker additional fields form for the employment country."}},"required":["data"]}}}}},"patch":{"operationId":"update-eor-worker-additional-information","summary":"Update additional information","description":"Partially updates the additional information on an EOR employee agreement. This operation is only permitted when the contract status is `new`, `under_review`, or `waiting_for_employee_contract`; invoking it with any other status will result in an error.\n **Token scopes**: `worker:write`","tags":["subpackage_eorWorkerInformation"],"parameters":[{"name":"contract_id","in":"path","description":"Deel contract id.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-information_updateEORWorkerAdditionalInformation_Response_200"}}}},"400":{"description":"Bad request. Contract not found, contract is not EOR, or additional information validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdditionalInformation-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Authentication failed. Bearer token is missing, expired, or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdditionalInformation-v2026-01-01RequestUnauthorizedError"}}}},"403":{"description":"Forbidden. The token lacks worker:write scope or the worker cannot update this contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdditionalInformation-v2026-01-01RequestForbiddenError"}}}},"404":{"description":"Not found. No additional info template exists for the employment country/state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdditionalInformation-v2026-01-01RequestNotFoundError"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdditionalInformation-v2026-01-01RequestTooManyRequestsError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdditionalInformation-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"description":"Patch additional information for an EOR employee contract.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchRequestBodyContentApplicationJsonSchemaData","description":"You can submit any subset of fields. Keys not listed above are treated as country/state-specific additional information fields. Those keys must match the fields returned by GET /forms/eor/worker-additional-fields/{country_code} (public keys)."}},"required":["data"]}}}}}},"/eor/workers/banks":{"post":{"operationId":"create-eor-worker-bank-account","summary":"Add bank account","description":"Registers a bank account for an EOR employee. Returns the `id` of the newly created bank account record.\n **Token scopes**: `worker:write`","tags":["subpackage_eorWorkerInformation"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-information_createEORWorkerBankAccount_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersBanksPostRequestBodyContentApplicationJsonSchemaDataItems"},"description":"Array of key value properties of bank account"}},"required":["data"]}}}}}},"/eor/workers/tax-documents":{"get":{"operationId":"get-eor-worker-tax-documents","summary":"List of tax documents for an employee","description":"Returns tax documents for the authenticated worker.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerInformation"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Tax documents successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-information_getEORWorkerTaxDocuments_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/mailboxes/change-password":{"post":{"operationId":"change-password","summary":"Change EOR Mailbox Password","description":"Changes the mailbox password for an EOR worker.\n **Token scopes**: `worker:write`","tags":["subpackage_eorWorkerMailboxes"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-mailboxes_changePassword_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeEorMailboxPasswordRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeEorMailboxPasswordRequestInternalServerError"}}}}},"requestBody":{"description":"The new password to be set","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorMailboxesChangePasswordPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/eor/workers/contracts/{contract_id}/offboarding/resignation-letter":{"get":{"operationId":"download-employee-resignation-letter","summary":"Preview Resignation Letter","description":"Returns a preview of the resignation letter for the EOR contract before the worker submits their signature.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"File download successful","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewResignationLetterRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewResignationLetterRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewResignationLetterRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewResignationLetterRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/offboarding/resignation":{"post":{"operationId":"create-employee-resignation","summary":"Request contract resignation","description":"Initiates a resignation request for an EOR contract.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorWorkerOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Resignation request submitted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-offboarding_createEmployeeResignation_Response_201"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestContractResignationRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestContractResignationRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestContractResignationRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestContractResignationRequestInternalServerError"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaData"}},"required":["data"]}}}}}},"/eor/workers/resignations":{"get":{"operationId":"get-employee-resignations","summary":"Retrieve worker resignations","description":"Returns resignations submitted by EOR workers, optionally filtered by resignation letter status.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerOffboarding"],"parameters":[{"name":"status","in":"query","description":"Filter by resignation letter status","required":false,"schema":{"$ref":"#/components/schemas/EorWorkersResignationsGetParametersStatus"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-offboarding_getEmployeeResignations_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveWorkerResignationsRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveWorkerResignationsRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveWorkerResignationsRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveWorkerResignationsRequestInternalServerError"}}}}}}},"/eor/workers/contracts/{contract_id}/offboarding/resignation-letter/sign":{"post":{"operationId":"sign-employee-resignation-letter","summary":"Sign Resignation Letter","description":"Records the worker's signature on the resignation letter for the contract, which is required to finalize the resignation process; upon successful submission, the signed letter is queued for PDF generation and further processing.\n **Token scopes**: `worker:write`","tags":["subpackage_eorWorkerOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Resignation signed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-offboarding_signEmployeeResignationLetter_Response_201"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignResignationLetterRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignResignationLetterRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignResignationLetterRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignResignationLetterRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/eor/workers/contracts/{contract_id}/offboarding":{"post":{"operationId":"submit-eor-worker-resignation","summary":"Submit EOR Worker Resignation","description":"Formally initiates the resignation process for the EOR contract by submitting a resignation request on behalf of the worker.\n **Token scopes**: `worker:write`","tags":["subpackage_eorWorkerOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Ok response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-offboarding_submitEORWorkerResignation_Response_201"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEorWorkerResignationRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEorWorkerResignationRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEorWorkerResignationRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEorWorkerResignationRequestInternalServerError"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaData"}},"required":["data"]}}}}}},"/eor/workers/{worker_id}/payslips/{payslip_id}/download":{"get":{"operationId":"get-worker-payslips-download","summary":"Retrieve payslip PDF download link","description":"Returns a URL for downloading the specified payslip as a PDF.\n **Token scopes**: `payslips:read`","tags":["subpackage_eorWorkerPayslips"],"parameters":[{"name":"worker_id","in":"path","description":"The ID of the worker whose payslip download link is being requested.","required":true,"schema":{"type":"string"}},{"name":"payslip_id","in":"path","description":"The ID of the specific payslip to download.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the payslip download link.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-payslips_getWorkerPayslipsDownload_Response_200"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}}},"servers":[{"url":"https://api.letsdeel.com/rest/v2"},{"url":"https://api-staging.letsdeel.com/rest/v2"}],"components":{"schemas":{"EorWorkerPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"contract_id":{"type":"string","description":"ID of the contract associated with the timesheet"}},"required":["contract_id"],"title":"EorWorkerPostRequestBodyContentApplicationJsonSchemaData"},"EorWorkerPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"user_id":{"type":"string","format":"uuid","description":"The ID of the worker's user profile"},"profile_id":{"type":"string","format":"uuid","description":"The ID of the worker's profile"},"hris_profile_id":{"type":"string","format":"uuid","description":"The ID of the worker's HRIS profile"}},"required":["user_id","profile_id","hris_profile_id"],"title":"EorWorkerPostResponsesContentApplicationJsonSchemaData"},"eor-worker-accounts_createWorker_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkerPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-accounts_createWorker_Response_201"},"EorWorkerPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"path":{"type":"string","description":"The JSON path where input validation failed"},"message":{"type":"string","description":"A description of the returned error"}},"title":"EorWorkerPostResponsesContentApplicationJsonSchemaErrorsItems"},"EorWorkerPostResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"method":{"type":"string","description":"The HTTP method of the failed request"},"source":{"type":"string","description":"The source handler which produced the returned error"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"}},"title":"EorWorkerPostResponsesContentApplicationJsonSchemaRequest"},"CreateEorWorker-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkerPostResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorWorkerPostResponsesContentApplicationJsonSchemaRequest"}},"title":"CreateEorWorker-v2026-01-01RequestBadRequestError"},"ApiErrorRequest":{"type":"object","properties":{"method":{"type":"string","description":"The HTTP method of the failed request"},"url":{"type":"string","description":"The relative URL of the failed request"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"source":{"type":"string","description":"The source handler which produced the returned error"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"}},"title":"ApiErrorRequest"},"ApiError":{"type":"object","properties":{"message":{"type":"string","description":"A description of the returned error"},"path":{"type":"string","description":"The JSON path where input validation failed"}},"title":"ApiError"},"ApiErrorContainer":{"type":"object","properties":{"request":{"$ref":"#/components/schemas/ApiErrorRequest"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}},"title":"ApiErrorContainer"},"EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"url":{"type":"string","description":"URL to requested employee agreement to download."},"expires_at":{"type":"string","format":"date-time","description":"Expiration date time of download URL."}},"title":"EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaData"},"eor-worker-agreements_downloadWorkerEmployeeAgreement_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-agreements_downloadWorkerEmployeeAgreement_Response_200"},"EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"The error message"}},"title":"EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaErrorsItems"},"EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"method":{"type":"string","description":"The HTTP method of the failed request"},"source":{"type":"string","description":"The source handler which produced the returned error"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"}},"title":"EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaRequest"},"DownloadEmployeeAgreementPdfRequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaRequest"}},"title":"DownloadEmployeeAgreementPdfRequestConflictError"},"EorWorkersContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"version":{"type":"string","description":"Optional version of the Employment Agreement to be signed. If informed and in the case of a mismatch, the API will return an error."},"signature":{"type":"string","description":"Signature of employee."}},"required":["signature"],"title":"EorWorkersContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData"},"EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created":{"type":"boolean"}},"required":["created"],"title":"EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData"},"eor-worker-agreements_signEORContractAsWorker_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-agreements_signEORContractAsWorker_Response_201"},"EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"The error message"}},"title":"EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems"},"EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"method":{"type":"string","description":"The HTTP method of the failed request"},"source":{"type":"string","description":"The source handler which produced the returned error"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"}},"title":"EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaRequest"},"SignAContractRequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaRequest"}},"title":"SignAContractRequestConflictError"},"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsUiGuide":{"type":"object","properties":{"label":{"type":"string","description":"Label for this field."},"order":{"type":"integer","description":"Order of the field in the form."},"helper_text":{"type":["string","null"],"description":"Helper text to guide the user."}},"description":"UI guidance information for rendering this field in forms.","title":"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsUiGuide"},"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType":{"type":"string","enum":["MIN_LENGTH","MAX_LENGTH","REGEX"],"description":"The type of validation rule to apply.","title":"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType"},"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"The value to use for the validation rule (e.g., minimum length, regex pattern).","title":"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue"},"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType","description":"The type of validation rule to apply."},"value":{"$ref":"#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue","description":"The value to use for the validation rule (e.g., minimum length, regex pattern)."},"error_message":{"type":"string","description":"Error message to be displayed if validation fails."}},"title":"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems"},"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems":{"type":"object","properties":{"label":{"type":"string","description":"The name of the allowed value."},"value":{"type":"string","description":"The value of the allowed value."}},"title":"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems"},"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"key":{"type":"string","description":"The key of the field."},"type":{"type":"string","description":"Type of the field"},"ui_guide":{"$ref":"#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsUiGuide","description":"UI guidance information for rendering this field in forms."},"is_required":{"type":["boolean","null"],"description":"Whether the field is required or not."},"validations":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems"},"description":"Array of validation rules that apply to this field."},"values_allowed":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems"},"description":"Array of allowed values for this field (used for dropdowns, select lists, etc.)."}},"required":["key","ui_guide","is_required"],"title":"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItems"},"eor-worker-banks_getEORWorkerBankGuideByCountryAndCurrency_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"eor-worker-banks_getEORWorkerBankGuideByCountryAndCurrency_Response_200"},"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"field":{"type":"string","description":"Name of the field causing the error (for validation issues)"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveBankAccountGuide-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveBankAccountGuide-v2026-01-01RequestBadRequestError"},"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType":{"type":"string","enum":["MIN_LENGTH","MAX_LENGTH","REGEX"],"title":"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType"},"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue"},"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType"},"value":{"$ref":"#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue"}},"title":"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems"},"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems":{"type":"object","properties":{"label":{"type":"string","description":"The name of the allowed value."},"value":{"type":"string","description":"The value of the allowed value."}},"title":"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems"},"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"key":{"type":"string","description":"The key of the field."},"type":{"type":"string","description":"Type of the field"},"label":{"type":"string","description":"Label for this field."},"required":{"type":"boolean","description":"Whether the field is required or not."},"validations":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems"}},"values_allowed":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems"}}},"required":["key","required"],"title":"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItems"},"eor-worker-banks_getEORWorkerBankGuide_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"eor-worker-banks_getEORWorkerBankGuide_Response_200"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentWindow":{"type":"object","properties":{"ends_at":{"type":"string","description":"Last date the enrollment window is open (ISO 8601, `YYYY-MM-DD`). After this date, enrollment is locked until a new window is triggered."},"trigger":{"type":"string","description":"Business reason this window was opened. new_hire = initial enrollment after onboarding completes. open_enrollment = scheduled annual election period. qualifying_life_event = permitted mid-year change after a life event (for example marriage, birth, divorce) per plan rules. termination = window tied to offboarding, often for continuation or COBRA-style elections in applicable jurisdictions."},"starts_at":{"type":"string","description":"First date the enrollment window is open (ISO 8601, `YYYY-MM-DD`). Enrollment actions are accepted on or after this date only."}},"required":["ends_at","trigger","starts_at"],"description":"Calendar window during which the employee may enroll in, change, or opt out of this benefit. Omitted when no window is returned (enrollment changes are then not accepted until a new window opens, for example open enrollment, a qualifying life event, or a new-hire cycle per employer configuration).","title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentWindow"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedPlanAttachmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this attachment document."},"url":{"type":"string","description":"Direct URL to download or view the attachment. Typically a PDF. Use as the href for a download link."},"label":{"type":"string","description":"Human-readable filename or label for the attachment (e.g. 'Canada_Benefits.pdf'). Use as the visible text for download links."}},"required":["id","url","label"],"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedPlanAttachmentsItems"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedPlan":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this benefit plan. Use when referencing the plan in enrollment or amendment API calls."},"name":{"type":"string","description":"Display name of the plan tier (e.g. 'Gold', 'Silver', 'Bronze'). Shown to employees during enrollment selection and in benefits summaries."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedPlanAttachmentsItems"},"description":"Downloadable documents associated with this plan (e.g. Summary of Benefits and Coverage, Certificate of Coverage, plan brochure). Render each item as a labeled download link."}},"required":["id","name","attachments"],"description":"The specific benefit plan the employee is enrolled in (e.g. 'Gold', 'Silver', 'Bronze'). Contains the plan's ID, display name, and downloadable plan documents.","title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedPlan"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedProviderAttachmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this attachment document."},"url":{"type":"string","description":"Direct URL to download or view the attachment. Use as the href for a download link."},"label":{"type":"string","description":"Human-readable filename or label for the attachment. Use as the visible text for download links."}},"required":["id","url","label"],"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedProviderAttachmentsItems"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedProvider":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this provider."},"name":{"type":"string","description":"Display name of the insurance carrier or benefit provider (e.g. 'ManuLife', 'Aetna'). Use for labeling in UI."},"is_unisure":{"type":"boolean","description":"True if this benefit is administered through Unisure, a global group insurance platform Deel uses to deliver international EOR benefits. Relevant for understanding the benefit's administration model and claims process."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedProviderAttachmentsItems"},"description":"Provider-level documents such as general coverage guides, network directories, or enrollment guides. Render each as a labeled download link."},"home_page_url":{"type":"string","description":"URL to the employee-facing provider portal where the employee can view claims, access ID cards, find in-network providers, and manage coverage details."}},"required":["id","name","attachments","home_page_url"],"description":"The insurance carrier or benefit administrator managing the employee's currently enrolled plan. Includes portal access URL and provider-level documents.","title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedProvider"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetails":{"type":"object","properties":{"selected_plan":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedPlan","description":"The specific benefit plan the employee is enrolled in (e.g. 'Gold', 'Silver', 'Bronze'). Contains the plan's ID, display name, and downloadable plan documents."},"selected_provider":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedProvider","description":"The insurance carrier or benefit administrator managing the employee's currently enrolled plan. Includes portal access URL and provider-level documents."},"current_cycle_plan_cost":{"type":"number","format":"double","description":"Total cost of the selected plan for the current billing cycle, in the contract's currency. This is the gross plan cost before employer contributions are applied. Subtract current_cycle_employer_contribution to get the employee's net out-of-pocket cost."},"current_cycle_employer_contribution":{"type":"number","format":"double","description":"Amount the employer contributes toward the plan cost for the current billing cycle, in the contract's currency. This is the portion the company pays on the employee's behalf. The employee's actual cost is current_cycle_plan_cost minus this value."}},"required":["selected_plan","selected_provider","current_cycle_plan_cost","current_cycle_employer_contribution"],"description":"Details about the specific plan and provider the employee is currently enrolled in, along with the cost breakdown for the current billing cycle. Reflects the employee's actual enrollment, which may differ from organization_selection if the employee made their own plan choice.","title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetails"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployeeContributionValue":{"oneOf":[{"type":"number","format":"double"},{"type":"string"}],"description":"Raw contribution input from configuration or upstream systems; may be a number or string (for example `\"1.23\"`). Use `amount` for display and arithmetic — it is the normalized numeric value in `currency` per `frequency`.","title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployeeContributionValue"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployeeContribution":{"type":"object","properties":{"type":{"type":"string","description":"How the employee contribution is derived. FIXED_AMOUNT = flat currency per `frequency`. PERCENTAGE = percent of an earnings or cost basis defined by the plan. Additional values (for example employer match shapes on retirement benefits) can appear for specialized products."},"value":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployeeContributionValue","description":"Raw contribution input from configuration or upstream systems; may be a number or string (for example `\"1.23\"`). Use `amount` for display and arithmetic — it is the normalized numeric value in `currency` per `frequency`."},"amount":{"type":"number","format":"double","description":"Resolved employee contribution in `currency` for each `frequency` period (for example `100` with `USD` and `MONTHLY` means one hundred US dollars per month)."},"currency":{"type":"string","description":"ISO 4217 currency code for `amount` (for example USD, CAD, GBP). Matches the parent contract's `currency` for this benefits payload."},"frequency":{"type":"string","description":"Payroll or billing cadence for this contribution. Typical values include MONTHLY, SEMI_MONTHLY (twice per month), BIWEEKLY, WEEKLY, and ANNUALLY; exact strings follow Deel payroll configuration."}},"required":["type","value","amount","currency","frequency"],"description":"Recurring portion of plan cost collected from the employee's pay for this benefit. Expressed with calculation metadata (`type`, `value`), resolved `amount`, `currency`, and `frequency`. For a given period, `employee_contribution.amount` plus `employer_contribution.amount` reflects the split of premium or plan cost represented here; use `enrollment_details` cycle fields when you need billed totals for the current cycle.","title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployeeContribution"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployerContributionValue":{"oneOf":[{"type":"number","format":"double"},{"type":"string"}],"description":"Raw employer contribution input; may be number or string depending on source. Prefer `amount` for calculations and UI.","title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployerContributionValue"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployerContribution":{"type":"object","properties":{"type":{"type":"string","description":"How the employer contribution is derived. FIXED_AMOUNT = flat currency per `frequency`. PERCENTAGE = percent of an earnings or cost basis. Additional values may appear for specialized products."},"value":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployerContributionValue","description":"Raw employer contribution input; may be number or string depending on source. Prefer `amount` for calculations and UI."},"amount":{"type":"number","format":"double","description":"Resolved employer contribution in `currency` per `frequency` period."},"currency":{"type":"string","description":"ISO 4217 currency code for `amount`. Matches the parent contract's `currency`."},"frequency":{"type":"string","description":"Cadence at which the employer contribution is applied. Same vocabulary as `employee_contribution.frequency`."}},"required":["type","value","amount","currency","frequency"],"description":"Recurring employer-paid portion for this benefit, same shape as `employee_contribution`. Together with `employee_contribution.amount`, describes how premium or plan cost is split for the modeled period; billed totals for the active cycle may also appear under `enrollment_details`.","title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployerContribution"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedPlanAttachmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this attachment document."},"url":{"type":"string","description":"Direct URL to download or view the attachment."},"label":{"type":"string","description":"Human-readable filename or label for the attachment."}},"required":["id","url","label"],"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedPlanAttachmentsItems"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedPlan":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the organization's selected plan."},"name":{"type":"string","description":"Display name of the plan tier the organization has selected (e.g. 'Gold', 'Silver'). Shown to employees as the employer-offered default."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedPlanAttachmentsItems"},"description":"Downloadable plan documents for the organization's selected plan."}},"required":["id","name","attachments"],"description":"The plan tier the organization has chosen to offer employees by default for this benefit.","title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedPlan"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedProviderAttachmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this attachment document."},"url":{"type":"string","description":"Direct URL to download or view the attachment."},"label":{"type":"string","description":"Human-readable filename or label for the attachment."}},"required":["id","url","label"],"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedProviderAttachmentsItems"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedProvider":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the organization's selected provider."},"name":{"type":"string","description":"Display name of the provider the organization has selected (e.g. 'ManuLife', 'Aetna')."},"is_unisure":{"type":"boolean","description":"True if this provider is Unisure, a global group insurance platform used by Deel for international EOR benefits."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedProviderAttachmentsItems"},"description":"Provider-level documents associated with the organization's selected provider."},"home_page_url":{"type":"string","description":"URL to the employee-facing portal for the organization's selected provider."}},"required":["id","name","attachments","home_page_url"],"description":"The insurance carrier or benefit provider the organization has contracted with to administer this benefit.","title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedProvider"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelection":{"type":"object","properties":{"selected_plan":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedPlan","description":"The plan tier the organization has chosen to offer employees by default for this benefit."},"selected_provider":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedProvider","description":"The insurance carrier or benefit provider the organization has contracted with to administer this benefit."}},"required":["selected_plan","selected_provider"],"description":"The plan and provider the client organization has configured as the default offering for this benefit type. This reflects the employer's choice, which may differ from enrollment_details if the employee hasn't enrolled yet or selected a different option during open enrollment.","title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelection"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier (UUID) for this benefit instance. Use this when referencing the benefit in subsequent API calls."},"name":{"type":"string","description":"Human-readable display name of the benefit (e.g. 'Healthcare', 'Dental', '401(k)'). Suitable for display in UI."},"type":{"type":["string","null"],"description":"High-level category of the benefit (e.g. HEALTHCARE, DENTAL, VISION). May be null if uncategorized. Use benefit_type_code for a more specific, jurisdiction-aware value."},"status":{"type":"string","description":"Enrollment lifecycle state for this benefit. Populated with the same value as `enrollment_status` (both fields are returned for backward compatibility). ENROLLED = active, claimable coverage. OPTED_OUT = employee stopped or waived the coverage. TERMINATED = cancelled mid-contract. EXPIRED = coverage period ended. PENDING, AWAITING_ENROLLMENT, AWAITING_CARRIER_CONFIRMATION, and AWAITING_CONTRACT_ACTIVATION indicate transitional or pre-active states; see `enrollment_status` for the same enumeration and definitions."},"end_date":{"type":"string","description":"Date on which this benefit's coverage ends (ISO 8601, `YYYY-MM-DD`). Benefit record's effective end, termination, or offer end where applicable. Null or absent when no definitive end date is set on this record (coverage may still change if the contract or offering is updated)."},"plan_url":{"type":"string","description":"URL to this specific plan's portal or documentation — for example, a plan summary PDF, carrier-hosted plan detail page, or plan materials. Distinct from `provider_website_url` (the provider organization as a whole) and `home_page_url` (employee portal for claims and ID cards)."},"description":{"type":"string","description":"Plain-text explanation of what this benefit covers and why it matters to the employee. Suitable for display in a benefits overview UI or summary card."},"contract_type":{"type":"string","description":"Workforce product for the contract this benefit belongs to. EOR — Employer of Record; Deel is the legal employer. GP — Global Payroll; the client is the legal employer and Deel runs payroll. PEO — Professional Employer Organization (US co-employment). EMBEDDED — payroll or HR through an embedded partner integration."},"provider_name":{"type":"string","description":"Display name of the insurance carrier or benefit provider administering this plan (for example Allianz, Cigna, ManuLife)."},"coverage_group":{"type":"string","description":"Who is covered under this benefit, derived from enrolled dependents on the contract benefit. EMPLOYEE = employee only. EMPLOYEE_AND_SPOUSE = employee plus legal spouse. EMPLOYEE_AND_DOMESTIC_PARTNER = employee plus registered domestic partner where applicable. EMPLOYEE_AND_CHILD = employee plus dependent child coverage structured as a single-child tier. EMPLOYEE_AND_CHILDREN = employee plus all enrolled children. EMPLOYEE_AND_FAMILY = employee plus spouse or partner and children (full family tier) per plan rules."},"effective_date":{"type":"string","description":"Date from which this benefit offering is in effect for this employee in this response (ISO 8601, `YYYY-MM-DD`). The benefit offering's offered-at date when present — not the same as contract coverage start or plan-specific coverage start dates inside enrollment."},"benefit_type_code":{"type":"string","description":"Jurisdiction-aware classification code for this benefit. Use this (not only `type`) when product logic must differ by country — for example retirement: `401_K` in the US versus `OCCUPATIONAL_PENSION` in the UK and Ireland. Other common values include HEALTHCARE, DENTAL, VISION, LIFE_INSURANCE, ACCIDENT_INSURANCE, and CRITICAL_ILLNESS; the full set may expand as new benefit types are added."},"enrollment_status":{"type":"string","description":"Enrollment lifecycle state for this benefit. Always matches `status` in this API version; both are returned so integrations can use the explicit `enrollment_status` name. PENDING = benefit exists but no enrollment action yet. AWAITING_ENROLLMENT = employee must complete enrollment while an enrollment window applies. AWAITING_CARRIER_CONFIRMATION = submission received; awaiting carrier or administrator confirmation. AWAITING_CONTRACT_ACTIVATION = enrollment cannot complete until the underlying employment contract is active. ENROLLED = active coverage. OPTED_OUT = employee stopped or waived the coverage. TERMINATED = stopped before natural expiry. EXPIRED = coverage window has ended."},"enrollment_window":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentWindow","description":"Calendar window during which the employee may enroll in, change, or opt out of this benefit. Omitted when no window is returned (enrollment changes are then not accepted until a new window opens, for example open enrollment, a qualifying life event, or a new-hire cycle per employer configuration)."},"enrollment_details":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetails","description":"Details about the specific plan and provider the employee is currently enrolled in, along with the cost breakdown for the current billing cycle. Reflects the employee's actual enrollment, which may differ from organization_selection if the employee made their own plan choice."},"provider_website_url":{"type":"string","description":"Public marketing or corporate website for the carrier or administrator. For the employee-facing portal (claims, ID cards, provider search), use `home_page_url` when enrolled."},"employee_contribution":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployeeContribution","description":"Recurring portion of plan cost collected from the employee's pay for this benefit. Expressed with calculation metadata (`type`, `value`), resolved `amount`, `currency`, and `frequency`. For a given period, `employee_contribution.amount` plus `employer_contribution.amount` reflects the split of premium or plan cost represented here; use `enrollment_details` cycle fields when you need billed totals for the current cycle."},"employer_contribution":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEmployerContribution","description":"Recurring employer-paid portion for this benefit, same shape as `employee_contribution`. Together with `employee_contribution.amount`, describes how premium or plan cost is split for the modeled period; billed totals for the active cycle may also appear under `enrollment_details`."},"organization_selection":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelection","description":"The plan and provider the client organization has configured as the default offering for this benefit type. This reflects the employer's choice, which may differ from enrollment_details if the employee hasn't enrolled yet or selected a different option during open enrollment."}},"required":["name","type","status","description","enrollment_details","organization_selection"],"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItems"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"benefits":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItems"},"description":"All benefits associated with this contract, regardless of enrollment status. Includes benefits the employee is enrolled in, has opted out of, or is pending enrollment for."},"currency":{"type":"string","description":"ISO 4217 currency code for all monetary amounts within this contract's benefits (e.g. 'USD', 'CAD', 'GBP'). Applies to all cost and contribution fields in this contract grouping."},"contract_id":{"type":"string","description":"Unique identifier for the employment contract these benefits are associated with. Use to correlate benefits with a specific contract when the employee has multiple active engagements."}},"required":["benefits","currency","contract_id"],"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-worker-benefits_getEORWorkerBenefits_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of contracts with their associated benefits. An employee may have benefits across multiple contracts if they have more than one active engagement."}},"required":["data"],"title":"eor-worker-benefits_getEORWorkerBenefits_Response_200"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"path":{"type":"string","description":"The JSON path where input validation failed"},"message":{"type":"string","description":"A description of the returned error"}},"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaErrorsItems"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"method":{"type":"string","description":"The HTTP method of the failed request"},"source":{"type":"string","description":"The source handler which produced the returned error"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"}},"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaRequest"},"RetrieveBenefitsForEmployee-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaRequest"}},"title":"RetrieveBenefitsForEmployee-v2026-01-01RequestBadRequestError"},"eor-worker-compliance_createComplianceDocumentAcknowledgement_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"eor-worker-compliance_createComplianceDocumentAcknowledgement_Response_204"},"EorWorkersComplianceDocumentsDocumentIdAcknowledgementPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"EorWorkersComplianceDocumentsDocumentIdAcknowledgementPostResponsesContentApplicationJsonSchemaErrorsItems"},"AcknowledgeAComplianceDocumentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdAcknowledgementPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"AcknowledgeAComplianceDocumentRequestBadRequestError"},"AcknowledgeAComplianceDocumentRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdAcknowledgementPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"AcknowledgeAComplianceDocumentRequestInternalServerError"},"EorWorkersComplianceDocumentsDocumentIdTemplatesDownloadGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"url":{"type":"string","description":"The URL for the requested compliance document template."},"expires_at":{"type":["string","null"],"format":"date-time","description":"Expiration date time of download URL."},"updated_at":{"type":"string","format":"date-time","description":"Last modified date of the template file"}},"title":"EorWorkersComplianceDocumentsDocumentIdTemplatesDownloadGetResponsesContentApplicationJsonSchemaData"},"eor-worker-compliance_downloadComplianceDocumentTemplate_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdTemplatesDownloadGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-compliance_downloadComplianceDocumentTemplate_Response_200"},"EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"url":{"type":"string","description":"The URL for the requested compliance document."},"expires_at":{"type":"string","format":"date-time","description":"Expiration date time of download URL."}},"title":"EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaData"},"eor-worker-compliance_downloadComplianceDocument_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-compliance_downloadComplianceDocument_Response_200"},"EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"path":{"type":"string","description":"The JSON path where input validation failed"},"message":{"type":"string","description":"A description of the returned error"}},"title":"EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems"},"EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"method":{"type":"string","description":"The HTTP method of the failed request"},"source":{"type":"string","description":"The source handler which produced the returned error"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"}},"title":"EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaRequest"},"DownloadSubmittedComplianceDocumentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaRequest"}},"title":"DownloadSubmittedComplianceDocumentRequestBadRequestError"},"EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus":{"type":"string","enum":["AWAITING_EX_REVIEW","AWAITING_EXTERNAL_REVIEW","REJECTED","APPROVED","ON_HOLD"],"description":"Review status of the uploaded document, null if no document has been uploaded yet.","title":"EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus"},"EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the compliance document requirement."},"name":{"type":"string","description":"Display name of the compliance document."},"status":{"oneOf":[{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus"},{"type":"null"}],"description":"Review status of the uploaded document, null if no document has been uploaded yet."},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code where the document is required."},"fillable":{"type":"boolean","description":"Whether the document can be filled through the Deel platform."},"filenames":{"type":"array","items":{"type":"string"},"description":"List of uploaded file names. Empty array when no files have been uploaded."},"description":{"type":"string","description":"Description of the document requirement. Empty string when no description exists."},"is_optional":{"type":"boolean","description":"Whether the document is optional for the worker. Also true when the document is required within 30 days."},"uploaded_at":{"type":["string","null"],"format":"date-time","description":"ISO 8601 timestamp when the document was uploaded, null if no document has been uploaded."},"has_template":{"type":"boolean","description":"Whether a template is available for this document."},"rejection_message":{"type":"string","description":"Plain text message explaining why the document was rejected. Empty string when no rejection message exists."},"is_consent_required":{"type":"boolean","description":"Whether consent is required for acknowledgement-only documents. Only present when is_acknowledgement_only_document is true."},"required_in_30_days":{"type":"boolean","description":"Whether the document is required within 30 days of employment start."},"is_acknowledgement_only_document":{"type":"boolean","description":"Whether this document only requires acknowledgement without file upload."}},"required":["id","name","status","country","fillable","filenames","description","is_optional","uploaded_at","has_template","rejection_message","required_in_30_days","is_acknowledgement_only_document"],"title":"EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItems"},"EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"documents":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItems"},"description":"List of compliance documents required for the worker."}},"required":["documents"],"title":"EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaData"},"eor-worker-compliance_getEORWorkerComplianceDocuments_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-compliance_getEORWorkerComplianceDocuments_Response_200"},"EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"field":{"type":["string","null"]},"message":{"type":"string"}},"required":["code","message"],"title":"EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"},"ListOfEmployeeComplianceDocuments-v2026-01-01RequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ListOfEmployeeComplianceDocuments-v2026-01-01RequestUnauthorizedError"},"ListOfEmployeeComplianceDocuments-v2026-01-01RequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ListOfEmployeeComplianceDocuments-v2026-01-01RequestForbiddenError"},"ListOfEmployeeComplianceDocuments-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ListOfEmployeeComplianceDocuments-v2026-01-01RequestInternalServerError"},"EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the file upload was successful."}},"required":["success"],"title":"EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaData"},"eor-worker-compliance_uploadEORWorkerComplianceDocument_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-compliance_uploadEORWorkerComplianceDocument_Response_200"},"EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error message."}},"required":["message"],"title":"EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems"},"UploadEmployeeComplianceDocument-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UploadEmployeeComplianceDocument-v2026-01-01RequestBadRequestError"},"UploadEmployeeComplianceDocument-v2026-01-01RequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UploadEmployeeComplianceDocument-v2026-01-01RequestUnauthorizedError"},"UploadEmployeeComplianceDocument-v2026-01-01RequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UploadEmployeeComplianceDocument-v2026-01-01RequestForbiddenError"},"UploadEmployeeComplianceDocument-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UploadEmployeeComplianceDocument-v2026-01-01RequestNotFoundError"},"UploadEmployeeComplianceDocument-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UploadEmployeeComplianceDocument-v2026-01-01RequestInternalServerError"},"EorWorkersContractsContractIdHrDocumentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Document Id."},"name":{"type":"string","description":"Name of the document."}},"required":["id","name"],"title":"EorWorkersContractsContractIdHrDocumentsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-worker-documents_getEORWorkerHRDocuments_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdHrDocumentsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"eor-worker-documents_getEORWorkerHRDocuments_Response_200"},"EorWorkersContractsContractIdAdditionalInformationPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"city":{"type":"string","description":"City"},"phone":{"type":"string","description":"Worker phone"},"state":{"type":"string","description":"State/province (required for countries with provinces/states)."},"street":{"type":"string","description":"Street"},"zip_code":{"type":"string","description":"Zipcode/Post code"},"tax_residence":{"type":"string","description":"Worker tax residence"},"is_payslip_access_allowed":{"type":"boolean","description":"Worker access to payslips"},"is_compliance_access_allowed":{"type":"boolean","description":"Worker access to compliance documents"}},"required":["city","phone","street","zip_code","tax_residence","is_payslip_access_allowed","is_compliance_access_allowed"],"description":"Additional fields are country/state-specific and validated against the worker additional fields form for the employment country.","title":"EorWorkersContractsContractIdAdditionalInformationPostRequestBodyContentApplicationJsonSchemaData"},"EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"updated":{"type":"boolean","description":"Indicates if contract was updated"}},"required":["updated"],"title":"EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaData"},"eor-worker-information_createGPWorkerAdditionalInformation_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-information_createGPWorkerAdditionalInformation_Response_200"},"EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems"},"EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaTranslationsItems":{"type":"object","properties":{"originalKey":{"type":"string"},"publicApiKey":{"type":"string"}},"required":["originalKey","publicApiKey"],"title":"EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaTranslationsItems"},"AddAdditionalInformation-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems"}},"translations":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaTranslationsItems"},"description":"Present when additional fields fail validation, to map internal field keys back to public API keys."}},"required":["errors"],"title":"AddAdditionalInformation-v2026-01-01RequestBadRequestError"},"AddAdditionalInformation-v2026-01-01RequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AddAdditionalInformation-v2026-01-01RequestUnauthorizedError"},"AddAdditionalInformation-v2026-01-01RequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AddAdditionalInformation-v2026-01-01RequestForbiddenError"},"AddAdditionalInformation-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AddAdditionalInformation-v2026-01-01RequestNotFoundError"},"AddAdditionalInformation-v2026-01-01RequestTooManyRequestsError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AddAdditionalInformation-v2026-01-01RequestTooManyRequestsError"},"AddAdditionalInformation-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AddAdditionalInformation-v2026-01-01RequestInternalServerError"},"EorWorkersBanksPostRequestBodyContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"key":{"type":"string","description":"The key of the bank account properties."},"value":{"type":"string","description":"The value for that key property."}},"required":["key","value"],"title":"EorWorkersBanksPostRequestBodyContentApplicationJsonSchemaDataItems"},"EorWorkersBanksPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"ID of Bank Account."}},"required":["id"],"title":"EorWorkersBanksPostResponsesContentApplicationJsonSchemaData"},"eor-worker-information_createEORWorkerBankAccount_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersBanksPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-information_createEORWorkerBankAccount_Response_201"},"EorWorkersTaxDocumentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Id of the tax document"},"url":{"type":"string","description":"URL of the tax document"},"type":{"type":"string","description":"Type of the tax document"},"year":{"type":"number","format":"double","description":"Year of tax document"},"country":{"type":"string","description":"Country of the tax document"}},"title":"EorWorkersTaxDocumentsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-worker-information_getEORWorkerTaxDocuments_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersTaxDocumentsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"eor-worker-information_getEORWorkerTaxDocuments_Response_200"},"EorWorkersContractsContractIdAdditionalInformationPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"dob":{"type":"string","description":"Date of birth (ISO 8601 date)"},"city":{"type":"string","description":"City"},"phone":{"type":"string","description":"Worker phone"},"state":{"type":"string","description":"State/province"},"street":{"type":"string","description":"Street"},"zip_code":{"type":"string","description":"Zipcode/Post code"},"tax_residence":{"type":"string","description":"Worker tax residence"},"is_payslip_access_allowed":{"type":"boolean","description":"Worker access to payslips"},"is_compliance_access_allowed":{"type":"boolean","description":"Worker access to compliance documents"}},"description":"You can submit any subset of fields. Keys not listed above are treated as country/state-specific additional information fields. Those keys must match the fields returned by GET /forms/eor/worker-additional-fields/{country_code} (public keys).","title":"EorWorkersContractsContractIdAdditionalInformationPatchRequestBodyContentApplicationJsonSchemaData"},"EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"updated":{"type":"boolean","description":"Indicates if contract was updated"}},"required":["updated"],"title":"EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaData"},"eor-worker-information_updateEORWorkerAdditionalInformation_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-information_updateEORWorkerAdditionalInformation_Response_200"},"EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"},"UpdateAdditionalInformation-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateAdditionalInformation-v2026-01-01RequestBadRequestError"},"UpdateAdditionalInformation-v2026-01-01RequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateAdditionalInformation-v2026-01-01RequestUnauthorizedError"},"UpdateAdditionalInformation-v2026-01-01RequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateAdditionalInformation-v2026-01-01RequestForbiddenError"},"UpdateAdditionalInformation-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateAdditionalInformation-v2026-01-01RequestNotFoundError"},"UpdateAdditionalInformation-v2026-01-01RequestTooManyRequestsError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateAdditionalInformation-v2026-01-01RequestTooManyRequestsError"},"UpdateAdditionalInformation-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateAdditionalInformation-v2026-01-01RequestInternalServerError"},"EorMailboxesChangePasswordPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"password":{"type":"string","description":"The new password."}},"title":"EorMailboxesChangePasswordPostRequestBodyContentApplicationJsonSchemaData"},"eor-worker-mailboxes_changePassword_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"eor-worker-mailboxes_changePassword_Response_204"},"EorMailboxesChangePasswordPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"EorMailboxesChangePasswordPostResponsesContentApplicationJsonSchemaErrorsItems"},"ChangeEorMailboxPasswordRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorMailboxesChangePasswordPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ChangeEorMailboxPasswordRequestBadRequestError"},"ChangeEorMailboxPasswordRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorMailboxesChangePasswordPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ChangeEorMailboxPasswordRequestInternalServerError"},"EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems"},"PreviewResignationLetterRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"PreviewResignationLetterRequestBadRequestError"},"PreviewResignationLetterRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"PreviewResignationLetterRequestUnauthorizedError"},"PreviewResignationLetterRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"PreviewResignationLetterRequestForbiddenError"},"PreviewResignationLetterRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"PreviewResignationLetterRequestInternalServerError"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataReason":{"type":"string","enum":["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","DEEL_COLLECTIONS","EMPLOYEE_DID_NOT_TAKE_THE_OFFER","EMPLOYEE_PROVIDED_NO_REASON","OTHER_BUSINESS_REASONS"],"description":"Reason why the contract is being terminated","title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataReason"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType":{"type":"string","enum":["ON_PLATFORM","OFF_PLATFORM"],"description":"Type of time off tracking - whether it's tracked on Deel platform or off platform","title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"Amount of time off used in the period"},"tracking_period":{"type":"string","format":"date","description":"Start date of the tracking period"},"tracking_period_end_date":{"type":"string","format":"date","description":"End date of the tracking period"}},"required":["used","tracking_period","tracking_period_end_date"],"title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR","WEEK","MONTH","YEAR"],"description":"Unit of measurement for the time off entitlements","title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff":{"type":"object","properties":{"entitlements":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems"},"description":"Array of time off entitlements for different tracking periods"},"total_scheduled":{"type":"number","format":"double","description":"Total amount of time off scheduled until the end date"},"entitlement_unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit","description":"Unit of measurement for the time off entitlements"}},"required":["entitlements","total_scheduled","entitlement_unit"],"description":"Required when tracking_type is OFF_PLATFORM, null otherwise","title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff":{"type":"object","properties":{"tracking_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType","description":"Type of time off tracking - whether it's tracked on Deel platform or off platform"},"off_platform_used_time_off":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff"},{"type":"null"}],"description":"Required when tracking_type is OFF_PLATFORM, null otherwise"}},"title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType":{"type":"string","enum":["DAYS","WEEKS","MONTHS","CASH"],"description":"The type of severance selected by the client. It's an optional field","title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason":{"type":"string","enum":["MOVING_TO_INTERNAL_ENTITY_WITH_DEEL_GLOBAL_PAYROLL","MOVING_TO_INTERNAL_ENTITY_WITH_OTHER_PROVIDER"],"description":"An additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataReason","description":"Reason why the contract is being terminated"},"attachments":{"type":"string","format":"binary","description":"This field allows for uploading multiple files at once. Attach any document that is important for the request to terminate the contract. Includes common image formats (JPG, JPEG, PNG, HEIC) and PDF documents"},"is_sensitive":{"type":"boolean","description":"Defines whether the termination is sensitive. In this case, only the person requesting the termination will be able to view the termination, receive emails or notifications."},"reason_detail":{"type":"string","description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff"},"severance_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType","description":"The type of severance selected by the client. It's an optional field"},"desired_end_date":{"type":"string","format":"date","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"severance_amount":{"type":"number","format":"double","description":"The amount of severance needed"},"additional_reason":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason"},{"type":"null"}],"description":"An additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY"},"termination_notes":{"type":"array","items":{"type":"string"},"description":"Additional notes can be provided regarding the termination for Deel, like questions and doubts"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligible_for_rehire"},"is_employee_staying_with_deel":{"type":["boolean","null"],"description":"Defines if employee will keep using Deel as provider"}},"required":["reason","used_time_off","is_employee_staying_with_deel"],"title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaData"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"},"is_additional_supporting_document":{"type":"boolean","description":"Indicates if this is an additional supporting document added after the initial submission"}},"required":["id","name","type","created_at","updated_at","is_additional_supporting_document"],"title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"}},"required":["id","name","type","created_at"],"title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus":{"type":"string","enum":["AWAITING_REVIEW","AWAITING_FEEDBACK","FEEDBACK_PROVIDED","APPROVED","CHANGES_REQUESTED_BY_CLIENT","CHANGES_REQUESTED_BY_EMPLOYEE","WAIVED_REVIEW","NOT_RESPONDED","CANCELLED"],"description":"The current status of the document review","title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType":{"type":"string","enum":["CLIENT","EMPLOYEE"],"description":"The type of reviewer for this document","title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the document set shared with the employee."},"files":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"}},"status":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus","description":"The current status of the document review"},"created_at":{"type":"string","format":"date-time","description":"The date and time the document set was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the document set was updated"},"reviewed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the document was reviewed"},"reviewed_by":{"type":["string","null"],"description":"The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client"},"reviewer_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType","description":"The type of reviewer for this document"},"reviewer_feedback":{"type":["string","null"],"description":"Feedback provided by the reviewer"},"notification_instructions":{"type":["string","null"],"description":"HTML instructions for the reviewer notification"},"is_employee_notification_required":{"type":"boolean","description":"Indicates if the employee should be notified about this document review"}},"required":["files","status","reviewer_type","is_employee_notification_required"],"title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocuments":{"type":"object","properties":{"supporting":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"}},"offboarding":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"description":"Document set shared that requires client or employee review"}},"required":["supporting","offboarding"],"description":"Document management structure for termination workflow including review processes and supporting documents","title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocuments"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataReason":{"type":"string","enum":["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"],"description":"The reason for the termination","title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataReason"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"The unit of measurement for time off tracking","title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"The amount of time off used in this tracking period"},"end_date":{"type":"string","format":"date-time","description":"The end date of the tracking period"},"start_date":{"type":"string","format":"date-time","description":"The start date of the tracking period"}},"required":["used","end_date","start_date"],"title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit","description":"The unit of measurement for time off tracking"},"policy_type":{"type":"string","description":"The type of time-off policy"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"The amount of time off scheduled until the end date of the current tracking period"}},"required":["unit","policy_type","tracking_periods","scheduled_until_end_date"],"title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails":{"type":"object","properties":{"notes":{"type":["string","null"],"description":"Additional notes or comments about the time-off data"},"updated_by":{"type":["string","null"],"description":"The person or system that last updated the time-off data"},"last_updated_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the time-off data was last updated"}},"title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"}},"additional_details":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},{"type":"null"}]},"is_deel_pto_confirmed":{"type":"boolean","description":"Indicates whether the PTO allocation has been confirmed by Deel's system"}},"required":["time_offs","is_deel_pto_confirmed"],"description":"Time-off usage data including policy information and tracking periods","title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataReason","description":"The reason for the termination"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff","description":"Time-off usage data including policy information and tracking periods"},"desired_end_date":{"type":["string","null"],"format":"date","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligible_for_rehire"}},"title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestData"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the offboarding request"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"documents":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocuments","description":"Document management structure for termination workflow including review processes and supporting documents"},"created_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was updated"},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"is_sensitive":{"type":"boolean","description":"Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team."},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaData"},"eor-worker-offboarding_createEmployeeResignation_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-offboarding_createEmployeeResignation_Response_201"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems"},"RequestContractResignationRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RequestContractResignationRequestBadRequestError"},"RequestContractResignationRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RequestContractResignationRequestUnauthorizedError"},"RequestContractResignationRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RequestContractResignationRequestForbiddenError"},"RequestContractResignationRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RequestContractResignationRequestInternalServerError"},"EorWorkersResignationsGetParametersStatus":{"type":"string","enum":["AWAITING_SIGNATURE","SIGNED"],"title":"EorWorkersResignationsGetParametersStatus"},"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["COMPLETED","AWAITING_REFUND","PROCESSING","AWAITING_TRIAGE","AWAITING_PROCESSING","CANCELLED","AWAITING_PTO"],"description":"The status of the resignation","title":"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetterStatus":{"type":"string","enum":["AWAITING_SIGNATURE","SIGNED"],"description":"The status of the resignation letter","title":"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetterStatus"},"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetter":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the resignation letter"},"status":{"$ref":"#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetterStatus","description":"The status of the resignation letter"},"signature":{"type":["string","null"],"description":"The signature of the resignation letter"},"signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time the resignation letter was signed"},"created_at":{"type":"string","format":"date-time","description":"The date and time the resignation letter was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the resignation letter was updated"}},"required":["id","status","signature","signed_at","created_at","updated_at"],"title":"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetter"},"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the resignation"},"status":{"$ref":"#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"The status of the resignation"},"end_date":{"type":["string","null"],"format":"date-time","description":"The confirmed end date of the resignation"},"created_at":{"type":"string","format":"date-time","description":"The date and time the resignation was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the resignation was updated"},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date of the resignation"},"resignation_letter":{"oneOf":[{"$ref":"#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetter"},{"type":"null"}]}},"required":["id","status","end_date","created_at","updated_at","contract_id","desired_end_date","resignation_letter"],"title":"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-worker-offboarding_getEmployeeResignations_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"eor-worker-offboarding_getEmployeeResignations_Response_200"},"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveWorkerResignationsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveWorkerResignationsRequestBadRequestError"},"RetrieveWorkerResignationsRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveWorkerResignationsRequestUnauthorizedError"},"RetrieveWorkerResignationsRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveWorkerResignationsRequestForbiddenError"},"RetrieveWorkerResignationsRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveWorkerResignationsRequestInternalServerError"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"signature":{"type":"string","description":"Employee signature"}},"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostRequestBodyContentApplicationJsonSchemaData"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems":{"type":"object","properties":{"id":{"type":"string","format":"cuid","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"},"is_additional_supporting_document":{"type":"boolean","description":"Indicates if this is an additional supporting document added after the initial submission"}},"required":["id","name","type","created_at","updated_at","is_additional_supporting_document"],"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems":{"type":"object","properties":{"id":{"type":"string","format":"cuid","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"}},"required":["id","name","type","created_at"],"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus":{"type":"string","enum":["AWAITING_REVIEW","AWAITING_FEEDBACK","FEEDBACK_PROVIDED","APPROVED","CHANGES_REQUESTED_BY_CLIENT","CHANGES_REQUESTED_BY_EMPLOYEE","WAIVED_REVIEW","NOT_RESPONDED","CANCELLED"],"description":"The current status of the document review","title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType":{"type":"string","enum":["CLIENT","EMPLOYEE"],"description":"The type of reviewer for this document","title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the document set shared with the employee."},"files":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"}},"status":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus","description":"The current status of the document review"},"created_at":{"type":"string","format":"date-time","description":"The date and time the document set was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the document set was updated"},"reviewed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the document was reviewed"},"reviewed_by":{"type":["string","null"],"description":"The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client"},"reviewer_type":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType","description":"The type of reviewer for this document"},"reviewer_feedback":{"type":["string","null"],"description":"Feedback provided by the reviewer"},"notification_instructions":{"type":["string","null"],"description":"HTML instructions for the reviewer notification"},"is_employee_notification_required":{"type":"boolean","description":"Indicates if the employee should be notified about this document review"}},"required":["files","status","reviewer_type","is_employee_notification_required"],"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the resignation letter"},"signature":{"type":["string","null"],"description":"The signature of the resignation letter"},"signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the resignation letter was signed"},"created_at":{"type":"string","format":"date-time","description":"The date and time the resignation letter was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the resignation letter was updated"}},"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocuments":{"type":"object","properties":{"supporting":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"}},"offboarding":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"description":"Document set shared that requires client or employee review"},"resignation_letter":{"oneOf":[{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter"},{"type":"null"}]}},"required":["supporting","offboarding"],"description":"Document management structure for termination workflow including review processes and supporting documents","title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocuments"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataReason":{"type":"string","enum":["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"],"description":"The reason for the termination","title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataReason"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"The unit of measurement for time off tracking","title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"The amount of time off used in this tracking period"},"end_date":{"type":"string","format":"date-time","description":"The end date of the tracking period"},"start_date":{"type":"string","format":"date-time","description":"The start date of the tracking period"}},"required":["used","end_date","start_date"],"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit","description":"The unit of measurement for time off tracking"},"policy_type":{"type":"string","description":"The type of time-off policy"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"The amount of time off scheduled until the end date of the current tracking period"}},"required":["unit","policy_type","tracking_periods","scheduled_until_end_date"],"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails":{"type":"object","properties":{"notes":{"type":["string","null"],"description":"Additional notes or comments about the time-off data"},"updated_by":{"type":["string","null"],"description":"The person or system that last updated the time-off data"},"last_updated_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the time-off data was last updated"}},"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"}},"additional_details":{"oneOf":[{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},{"type":"null"}]},"is_deel_pto_confirmed":{"type":"boolean","description":"Indicates whether the PTO allocation has been confirmed by Deel's system"}},"required":["time_offs","is_deel_pto_confirmed"],"description":"Time-off usage data including policy information and tracking periods","title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataReason","description":"The reason for the termination"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff","description":"Time-off usage data including policy information and tracking periods"},"desired_end_date":{"type":["string","null"],"format":"date","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligible_for_rehire"}},"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestData"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the offboarding request"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"documents":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocuments","description":"Document management structure for termination workflow including review processes and supporting documents"},"created_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was updated"},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"is_sensitive":{"type":"boolean","description":"Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team."},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaData"},"eor-worker-offboarding_signEmployeeResignationLetter_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-offboarding_signEmployeeResignationLetter_Response_201"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems"},"SignResignationLetterRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SignResignationLetterRequestBadRequestError"},"SignResignationLetterRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SignResignationLetterRequestUnauthorizedError"},"SignResignationLetterRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SignResignationLetterRequestForbiddenError"},"SignResignationLetterRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SignResignationLetterRequestInternalServerError"},"EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaDataReason":{"type":"string","enum":["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"],"description":"The reason for the employee's resignation","title":"EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaDataReason"},"EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaDataReason","description":"The reason for the employee's resignation"},"signature":{"type":"string","description":"Employee signature"},"reason_detail":{"type":"string","description":"Additional details explaining the resignation reason"},"desired_end_date":{"type":"string","format":"date","description":"The employee's desired last day of work in YYYY-MM-DD format"},"supporting_documents":{"type":"string","format":"binary","description":"This field allows for uploading multiple files at once. Includes common image formats (JPG, JPEG, PNG, HEIC) and PDF documents."}},"required":["reason","signature","desired_end_date"],"title":"EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaData"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems":{"type":"object","properties":{"id":{"type":"string","format":"cuid","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"},"is_additional_supporting_document":{"type":"boolean","description":"Indicates if this is an additional supporting document added after the initial submission"}},"required":["id","name","type","created_at","updated_at","is_additional_supporting_document"],"title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems":{"type":"object","properties":{"id":{"type":"string","format":"cuid","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"}},"required":["id","name","type","created_at"],"title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus":{"type":"string","enum":["AWAITING_REVIEW","AWAITING_FEEDBACK","FEEDBACK_PROVIDED","APPROVED","CHANGES_REQUESTED_BY_CLIENT","CHANGES_REQUESTED_BY_EMPLOYEE","WAIVED_REVIEW","NOT_RESPONDED","CANCELLED"],"description":"The current status of the document review","title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType":{"type":"string","enum":["CLIENT","EMPLOYEE"],"description":"The type of reviewer for this document","title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the document set shared with the employee."},"files":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"}},"status":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus","description":"The current status of the document review"},"created_at":{"type":"string","format":"date-time","description":"The date and time the document set was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the document set was updated"},"reviewed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the document was reviewed"},"reviewed_by":{"type":["string","null"],"description":"The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client"},"reviewer_type":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType","description":"The type of reviewer for this document"},"reviewer_feedback":{"type":["string","null"],"description":"Feedback provided by the reviewer"},"notification_instructions":{"type":["string","null"],"description":"HTML instructions for the reviewer notification"},"is_employee_notification_required":{"type":"boolean","description":"Indicates if the employee should be notified about this document review"}},"required":["files","status","reviewer_type","is_employee_notification_required"],"title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocuments":{"type":"object","properties":{"supporting":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"}},"offboarding":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"description":"Document set shared that requires client or employee review"}},"required":["supporting","offboarding"],"description":"Document management structure for termination workflow including review processes and supporting documents","title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocuments"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataReason":{"type":"string","enum":["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"],"description":"The reason for the termination","title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataReason"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"The unit of measurement for time off tracking","title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"The amount of time off used in this tracking period"},"end_date":{"type":"string","format":"date-time","description":"The end date of the tracking period"},"start_date":{"type":"string","format":"date-time","description":"The start date of the tracking period"}},"required":["used","end_date","start_date"],"title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit","description":"The unit of measurement for time off tracking"},"policy_type":{"type":"string","description":"The type of time-off policy"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"The amount of time off scheduled until the end date of the current tracking period"}},"required":["unit","policy_type","tracking_periods","scheduled_until_end_date"],"title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails":{"type":"object","properties":{"notes":{"type":["string","null"],"description":"Additional notes or comments about the time-off data"},"updated_by":{"type":["string","null"],"description":"The person or system that last updated the time-off data"},"last_updated_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the time-off data was last updated"}},"title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"}},"additional_details":{"oneOf":[{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},{"type":"null"}]},"is_deel_pto_confirmed":{"type":"boolean","description":"Indicates whether the PTO allocation has been confirmed by Deel's system"}},"required":["time_offs","is_deel_pto_confirmed"],"description":"Time-off usage data including policy information and tracking periods","title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataReason","description":"The reason for the termination"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff","description":"Time-off usage data including policy information and tracking periods"},"desired_end_date":{"type":["string","null"],"format":"date","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligible_for_rehire"}},"title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestData"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the offboarding request"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"documents":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocuments","description":"Document management structure for termination workflow including review processes and supporting documents"},"created_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was updated"},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"is_sensitive":{"type":"boolean","description":"Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team."},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaData"},"eor-worker-offboarding_submitEORWorkerResignation_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-offboarding_submitEORWorkerResignation_Response_201"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems"},"SubmitEorWorkerResignationRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEorWorkerResignationRequestBadRequestError"},"SubmitEorWorkerResignationRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEorWorkerResignationRequestUnauthorizedError"},"SubmitEorWorkerResignationRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEorWorkerResignationRequestForbiddenError"},"SubmitEorWorkerResignationRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEorWorkerResignationRequestInternalServerError"},"EorWorkersWorkerIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"url":{"type":"string","description":"The URL to download the payslip PDF."}},"required":["url"],"title":"EorWorkersWorkerIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaData"},"eor-worker-payslips_getWorkerPayslipsDownload_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersWorkerIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-payslips_getWorkerPayslipsDownload_Response_200"}},"securitySchemes":{"deelToken":{"type":"http","scheme":"bearer","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n"},"oauth2":{"type":"http","scheme":"bearer","description":"Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/"}}}}