{"openapi":"3.1.0","info":{"title":"Endpoints","version":"1.0.0"},"paths":{"/legal-entities/{legal_entity_id}/cost-centers":{"get":{"operationId":"get-legal-entity-cost-centers","summary":"Get cost centers by legal entity","description":"Fetch all cost centers related to a given legal entity id\n **Token scopes**: `legal-entity:read`","tags":["subpackage_costCenters"],"parameters":[{"name":"legal_entity_id","in":"path","description":"Legal entity id","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":"Cost center data was successfully fetched","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cost-centers_getLegalEntityCostCenters_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCostCentersByLegalEntityRequestBadRequestError"}}}},"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"}}}}}}},"/groups/{id}/clone":{"post":{"operationId":"clone-group","summary":"Clone a Group","description":"Clone an existing group within the organization. This creates a new group with the specified name, copying the structure and settings from the source group.\n **Token scopes**: `groups:write`","tags":["subpackage_groups"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the group to be cloned.","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":{"201":{"description":"Group cloned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_cloneGroup_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloneAGroupRequestBadRequestError"}}}},"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/GroupsIdClonePostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/groups":{"post":{"operationId":"create-group","summary":"Create a group","description":"Create a new group within your organization.\n **Token scopes**: `groups:read`, `groups:write`","tags":["subpackage_groups"],"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":"Group created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_createGroup_Response_200"}}}},"400":{"description":"Invalid request payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupRequestBadRequestError"}}}},"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/GroupsPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}},"get":{"operationId":"get-groups","summary":"Return list of groups","description":"List all the groups in your organization.\n **Token scopes**: `groups:read`","tags":["subpackage_groups"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of groups to return (between 1 and 100)","required":false,"schema":{"type":"integer","default":100}},{"name":"sort_order","in":"query","description":"Sort the results in ascending (ASC) or descending (DESC) order based on the group name.","required":false,"schema":{"$ref":"#/components/schemas/GroupsGetParametersSortOrder"}},{"name":"cursor","in":"query","description":"The encoded cursor for paginated results. This is an opaque string that allows fetching the next set of results.","required":false,"schema":{"type":"string"}},{"name":"include_archived_groups","in":"query","description":"Include archived groups (soft deleted records). Defaults to `true`.","required":false,"schema":{"type":"boolean","default":true}},{"name":"external_metadata","in":"query","description":"Extra information about the group.","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":"A list of groups in the organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_getGroups_Response_200"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGroupsRequestBadRequestError"}}}},"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"}}}}}}},"/groups/{id}":{"delete":{"operationId":"delete-group","summary":"Delete a group","description":"Archive an existing group.\n **Token scopes**: `groups:write`","tags":["subpackage_groups"],"parameters":[{"name":"id","in":"path","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":"Group archived successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_deleteGroup_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteGroupRequestBadRequestError"}}}},"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":"Group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteGroupRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"patch":{"operationId":"update-group","summary":"Edit a group","description":"Edit the details of an existing group.\n **Token scopes**: `groups:read`, `groups:write`","tags":["subpackage_groups"],"parameters":[{"name":"id","in":"path","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":"Group updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_updateGroup_Response_200"}}}},"400":{"description":"Invalid request payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditGroupRequestBadRequestError"}}}},"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/GroupsIdPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/immigration/visa-requirement/business":{"get":{"operationId":"get-business-visa-requirement","summary":"Get business visa eligibility and requirements","description":"This endpoint receives personal information and desired travel information, analyzes and returns the possible business visa options for the given data.\n **Token scopes**: `immigration:read`","tags":["subpackage_immigration"],"parameters":[{"name":"destination_country","in":"query","description":"The destination country code of the trip in ISO 3166-1 alpha-2 format","required":true,"schema":{"type":"string"}},{"name":"nationality","in":"query","description":"The nationality country code of the person in ISO 3166-1 alpha-2 format","required":true,"schema":{"type":"string"}},{"name":"residence_country","in":"query","description":"The residence country code of the person in ISO 3166-1 alpha-2 format","required":true,"schema":{"type":"string"}},{"name":"trip_start_date","in":"query","description":"The trip start date in ISO 8601 format (YYYY-MM-DD)","required":true,"schema":{"type":"string","format":"date"}},{"name":"trip_end_date","in":"query","description":"The trip end date in ISO 8601 format (YYYY-MM-DD)","required":true,"schema":{"type":"string","format":"date"}},{"name":"trip_reason","in":"query","description":"The reason for the trip","required":true,"schema":{"$ref":"#/components/schemas/ImmigrationVisaRequirementBusinessGetParametersTripReason"}},{"name":"second_nationality","in":"query","description":"The second nationality country code of the person in ISO 3166-1 alpha-2 format (optional)","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/immigration_getBusinessVisaRequirement_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBusinessVisaEligibilityAndRequirementsRequestBadRequestError"}}}},"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/GetBusinessVisaEligibilityAndRequirementsRequestInternalServerError"}}}}}}},"/immigration/client/cases/{id}":{"get":{"operationId":"get-client-case","summary":"Get immigration case details","description":"Get detailed information for a specific immigration case. Use this to check case status and track process progress. The id path parameter is the case UUID returned from the 'Create Client Case' endpoint. Response is enriched with applicant profile, visa type, case status, estimated completion date, process details, and compliance document details.\n **Token scopes**: `immigration:read`","tags":["subpackage_immigration"],"parameters":[{"name":"id","in":"path","description":"Immigration case 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/immigration_getClientCase_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetImmigrationCaseDetails-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/GetImmigrationCaseDetails-v2026-01-01RequestInternalServerError"}}}}}}},"/immigration/workers/cases/{case_id}":{"get":{"operationId":"get-worker-case","summary":"Get specific immigration case details ","description":"Get detailed information for a specific immigration case. Use this to check case status and track process progress. The id path parameter is the case UUID returned from the 'Create Client Case' endpoint. Response is enriched with applicant profile, visa type, case status, estimated completion date, process details, and compliance document details.\n **Token scopes**: `worker:read`","tags":["subpackage_immigration"],"parameters":[{"name":"case_id","in":"path","description":"Filter by case ID","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/immigration_getWorkerCase_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSpecificImmigrationCaseDetails-v2026-04-02RequestBadRequestError"}}}},"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/GetSpecificImmigrationCaseDetails-v2026-04-02RequestInternalServerError"}}}}}}},"/immigration/documents/{id}":{"get":{"operationId":"get-document","summary":"Immigration document","description":"Fetch immigration document details by document id\n **Token scopes**: `immigration:read`","tags":["subpackage_immigration"],"parameters":[{"name":"id","in":"path","description":"Immigration case document 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/immigration_getDocument_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"}}}}}}},"/immigration/visa-types/{country_code}":{"get":{"operationId":"get-visa-types","summary":"Immigration visa types","description":"Fetch immigration supported visa types by country\n **Token scopes**: `immigration:read`","tags":["subpackage_immigration"],"parameters":[{"name":"country_code","in":"path","description":"Alpha 2 country code","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/immigration_getVisaTypes_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"}}}}}}},"/immigration/client/cases":{"get":{"operationId":"get-client-cases","summary":"List of immigration cases","description":"Retrieves a paginated list of immigration cases with filters for applicant name, case type, status, and country. Returns case details including type, status, process, timestamps, and optional closure information.\n **Token scopes**: `immigration:read`","tags":["subpackage_immigration"],"parameters":[{"name":"search","in":"query","description":"Search by applicant name or code","required":false,"schema":{"type":"string"}},{"name":"case_type_ids","in":"query","description":"Filter by case type IDs","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"statuses","in":"query","description":"Filter by case status","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationClientCasesGetParametersStatusesSchemaItems"}}},{"name":"countries","in":"query","description":"Filter by country. Uses ISO 3166-1 alpha-2 codes (https://www.iban.com/country-codes).","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"cursor","in":"query","description":"Pagination cursor for fetching next set of results","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Max number of results to return","required":false,"schema":{"type":"integer","default":20}},{"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/immigration_getClientCases_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfImmigrationCases-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/ListOfImmigrationCases-v2026-01-01RequestInternalServerError"}}}}}}},"/immigration/workers/cases":{"get":{"operationId":"get-worker-cases","summary":"List of immigration cases for workers","description":"Retrieves a paginated list of immigration cases with filters for applicant name, case type, status, and country. Returns case details including type, status, process, timestamps, and optional closure information.\n **Token scopes**: `worker:read`","tags":["subpackage_immigration"],"parameters":[{"name":"search","in":"query","description":"Search by applicant name or code","required":false,"schema":{"type":"string"}},{"name":"case_type_ids","in":"query","description":"Filter by case type IDs","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"statuses","in":"query","description":"Filter by case status","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetParametersStatusesSchemaItems"}}},{"name":"countries","in":"query","description":"Filter by country. Uses ISO 3166-1 alpha-2 codes (https://www.iban.com/country-codes).","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"cursor","in":"query","description":"Pagination cursor for fetching next set of results","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Max number of results to return","required":false,"schema":{"type":"integer","default":20}},{"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/immigration_getWorkerCases_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfImmigrationCasesForWorkers-v2026-04-02RequestBadRequestError"}}}},"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/ListOfImmigrationCasesForWorkers-v2026-04-02RequestInternalServerError"}}}}}}},"/immigration/workers/{worker_id}/cases/{case_id}/required-document":{"get":{"operationId":"get-worker-case-required-document","summary":"Retrieve a required document for a case","description":"Use this endpoint to retrieve the details of a specific document requirement for a worker's case. This includes the requirement's status and information about any previously rejected documents\n **Token scopes**: `worker:read`","tags":["subpackage_immigration"],"parameters":[{"name":"worker_id","in":"path","description":"The hris profile oid (public id) of the worker.","required":true,"schema":{"type":"string"}},{"name":"case_id","in":"path","description":"The unique identifier of the case for which the required document is being requested.","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/immigration_getWorkerCaseRequiredDocument_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"}}}}}}},"/immigration/workers/{worker_id}/onboarding-case":{"get":{"operationId":"get-worker-onboarding-case","summary":"Retrieve onboarding right-to-work case for a worker","description":"Returns the right to work case for employee onboarding including the documents if any. In case no right to work case is open, the response will be empty.\n **Token scopes**: `worker:read`","tags":["subpackage_immigration"],"parameters":[{"name":"worker_id","in":"path","description":"The hris profile oid (public id) of the worker.","required":true,"schema":{"type":"string"}},{"name":"contract_id","in":"query","description":"Filters the worker's onboarding case to a specific contract. If the worker has multiple contracts and this parameter is omitted, the response may return a case from any associated contract; the response includes contract.id to indicate which contract was used. Provide this parameter for deterministic results.","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/immigration_getWorkerOnboardingCase_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOnboardingRightToWorkCaseForAWorkerRequestBadRequestError"}}}},"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":"Case not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOnboardingRightToWorkCaseForAWorkerRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOnboardingRightToWorkCaseForAWorkerRequestInternalServerError"}}}}}}},"/immigration/workers/{worker_id}/cases/{case_id}/required-document/{document_request_id}":{"post":{"operationId":"create-worker-case-required-document","summary":"Upload a required immigration document","description":"Upload a required immigration document for a specific case. The document will be submitted for review.\n **Token scopes**: `worker:write`","tags":["subpackage_immigration"],"parameters":[{"name":"worker_id","in":"path","description":"The hris profile oid (public id) of the worker.","required":true,"schema":{"type":"string"}},{"name":"case_id","in":"path","description":"The unique identifier of the case for which the required document is being requested.","required":true,"schema":{"type":"string"}},{"name":"document_request_id","in":"path","description":"The unique identifier of the document request fo which this document is being uplodaded","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":"Document uploaded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/immigration_createWorkerCaseRequiredDocument_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":{"description":"Upload of immigration document","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostRequestBodyContentMultipartFormDataSchemaData","description":"Details of immigration document upload"}},"required":["data"]}}}}}},"/legal-entities":{"post":{"operationId":"create-legal-entity","summary":"Create a new legal entity","description":"Create a new legal entity under an organization.\n **Token scopes**: `legal-entity:write`, `legal-entity:read`","tags":["subpackage_legalEntities"],"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":"Successfully created legal entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/legal-entities_createLegalEntity_Response_200"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLegalEntityRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Permission denied. User must have the `entities.manage` permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLegalEntityRequestForbiddenError"}}}},"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/LegalEntitiesPostRequestBodyContentApplicationJsonSchemaData"}}}}}}},"get":{"operationId":"get-legal-entities","summary":"List of legal entities","description":"Retrieve a list of legal entities in your account.\n **Token scopes**: `organizations:read`, `accounting:read`","tags":["subpackage_legalEntities"],"parameters":[{"name":"limit","in":"query","description":"The number of results to return per page.","required":false,"schema":{"type":"integer","default":100}},{"name":"sort_order","in":"query","description":"Sorting order of the results.","required":false,"schema":{"$ref":"#/components/schemas/LegalEntitiesGetParametersSortOrder"}},{"name":"cursor","in":"query","description":"Cursor for pagination.","required":false,"schema":{"type":"string"}},{"name":"include_archived","in":"query","description":"Whether to include archived legal entities in the results.","required":false,"schema":{"type":"boolean","default":true}},{"name":"legal_entity_id","in":"query","description":"Filter by specific legal entity ID.","required":false,"schema":{"type":"string"}},{"name":"global_payroll","in":"query","description":"Filter by global payroll flag.","required":false,"schema":{"type":"boolean"}},{"name":"type","in":"query","description":"Filter by entity type.","required":false,"schema":{"type":"string"}},{"name":"country","in":"query","description":"Filter by country.","required":false,"schema":{"type":"string"}},{"name":"include_payroll_settings","in":"query","description":"Whether to include payroll settings in the response.","required":false,"schema":{"type":"boolean"}},{"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/legal-entities_getLegalEntities_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"}}}}}}},"/legal-entities/{id}":{"delete":{"operationId":"delete-legal-entity","summary":"Delete a legal entity","description":"Archive a legal entity. This marks the entity as inactive but does not permanently remove it.\n **Token scopes**: `legal-entity:read`, `legal-entity:write`","tags":["subpackage_legalEntities"],"parameters":[{"name":"id","in":"path","description":"The ID of the legal entity to archive.","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 archived the legal entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/legal-entities_deleteLegalEntity_Response_200"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteLegalEntityRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Permission denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteLegalEntityRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"patch":{"operationId":"update-legal-entity","summary":"Edit a legal entity","description":"Update the details of an existing legal entity.\n **Token scopes**: `legal-entity:read`, `legal-entity:write`","tags":["subpackage_legalEntities"],"parameters":[{"name":"id","in":"path","description":"The ID of the legal entity to update.","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 updated the legal entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/legal-entities_updateLegalEntity_Response_200"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditLegalEntityRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Permission denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditLegalEntityRequestForbiddenError"}}}},"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":{"name":{"type":"string","description":"The name of the legal entity."},"phone":{"type":"string","description":"The phone number of the legal entity."},"address":{"$ref":"#/components/schemas/LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaAddress"},"sic_number":{"type":"string","description":"The SIC number of the legal entity."},"entity_type":{"type":"string","description":"The type of the legal entity."},"industry_name":{"type":"string","description":"The industry name of the legal entity."},"company_identifiers":{"$ref":"#/components/schemas/LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaCompanyIdentifiers","description":"Identifiers associated with the legal entity."}}}}}}}},"/industries":{"get":{"operationId":"get-industries","summary":"List all industry subcategories","description":"List industry subcategories with their parent category details, supporting cursor-based pagination and sorting by category or subcategory name. Each subcategory is identified by a UUID and includes NAICS codes. Used during entity setup to select an industry classification.\n **Token scopes**: `legal-entity:read`","tags":["subpackage_legalEntities"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of items to return per page.","required":false,"schema":{"type":"integer"}},{"name":"order","in":"query","description":"Sorting order of the results.","required":false,"schema":{"$ref":"#/components/schemas/IndustriesGetParametersOrder"}},{"name":"sort_by","in":"query","description":"Field used to sort the results.","required":false,"schema":{"$ref":"#/components/schemas/IndustriesGetParametersSortBy"}},{"name":"cursor","in":"query","description":"Cursor used for paginating to the next page of results.","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":"List of industry subcategories.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/legal-entities_getIndustries_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllIndustrySubcategories-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"}}}}}}},"/lookups/job-titles":{"get":{"operationId":"get-job-titles","summary":"Job titles list","description":"Retrieve a list of pre-defined job titles in Deel platform.","tags":["subpackage_lookups"],"parameters":[{"name":"after_cursor","in":"query","description":"Cursor for pagination. Use this to retrieve the next page of results.","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/lookups_getJobTitles_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"}}}}}}},"/lookups/countries":{"get":{"operationId":"get-countries","summary":"Retrieve Country List","description":"Retrieve a list of countries supported by Deel, along with details about visa and EoR support, sub-territories, and their classifications.","tags":["subpackage_lookups"],"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/lookups_getCountries_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"}}}}}}},"/lookups/seniorities":{"get":{"operationId":"get-seniority-levels","summary":"Retrieve Seniority Levels","description":"Retrieve a list of predefined seniority levels for roles in the Deel platform, including their names, hierarchical levels, and unique identifiers.","tags":["subpackage_lookups"],"parameters":[{"name":"is_eor_contract","in":"query","description":"when `true`, exclude C-level seniorities for EOR contracts. Set to `false` to return all seniorities","required":false,"schema":{"type":"boolean","default":true}},{"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/lookups_getSeniorityLevels_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"}}}}}}},"/lookups/currencies":{"get":{"operationId":"get-currencies","summary":"Retrieve Supported Currency List","description":"Retrieve the list of currencies supported by Deel, including their ISO codes and names","tags":["subpackage_lookups"],"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/lookups_getCurrencies_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"}}}}}}},"/lookups/time-off-types":{"get":{"operationId":"get-time-off-types","summary":"Retrieve Time-Off Types","description":"Retrieve a list of predefined time-off types that can be registered in the Deel platform.","tags":["subpackage_lookups"],"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/lookups_getTimeOffTypes_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":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveTimeOffTypesRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/magic-link":{"post":{"operationId":"create-magic-link","summary":"Create magic link","description":"Use this endpoint to generate secure, time-limited magic links that enable password-free, seamless worker authentication for quick and safe access. Ideal for temporary sessions or low-friction login flows.\n **Token scopes**: `worker:read`","tags":["subpackage_magicLink"],"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":"Magic link generated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-link_createMagicLink_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Unauthorized - Invalid or missing authentication token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMagicLinkRequestUnauthorizedError"}}}},"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":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMagicLinkRequestInternalServerError"}}}}},"requestBody":{"description":"Details for magic link generation.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MagicLinkPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/managers":{"post":{"operationId":"create-manager","summary":"Create a Manager","description":"Create a new manager for the organization by providing the required user details. This endpoint returns the newly created manager's information.\n **Token scopes**: `organizations:write`","tags":["subpackage_managers"],"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":"Manager created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/managers_createManager_Response_201"}}}},"400":{"description":"Invalid request. The input data did not meet the required validation rules.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateManagerRequestBadRequestError"}}}},"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":"Conflict. A manager with the provided email already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateManagerRequestConflictError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"description":"Details of the new manager to be created.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ManagersPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}},"get":{"operationId":"get-managers","summary":"Retrieve List of Managers","description":"Retrieve a list of all managers in the organization along with pagination details.\n **Token scopes**: `organizations:read`","tags":["subpackage_managers"],"parameters":[{"name":"limit","in":"query","description":"The number of records to return in the response.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The offset or starting point for pagination.","required":false,"schema":{"type":"integer"}},{"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/managers_getManagers_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"}}}}}}},"/organizations/children":{"post":{"operationId":"create-organization-child","summary":"Create child organization","description":"Creates a new organization along with:\n\n- An API token scoped to the new organization. This token can be used to perform API operations on behalf of the new organization.\n- A default group for the organization.\n- A hierarchy linking the authenticated organization (the Parent Organization) with the new one (the Child Organization).\n- A user from the parent organization who will be assigned to the child organization.\n\nThis endpoint sets up the bare minimum required for the new organization to be operational immediately after creation.\n **Token scopes**: `organizations:write`","tags":["subpackage_organizations"],"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":"Operation successful. The child organization was created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations_createOrganizationChild_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChildOrganizationRequestBadRequestError"}}}},"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/OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaData","description":"The request payload."}},"required":["data"]}}}}}},"/organizations":{"get":{"operationId":"get-organizations","summary":"Get Current Organization","description":"Retrieve details of the current organization associated with the authenticated user. The organization is automatically detected based on the authentication token provided in the request.\n **Token scopes**: `organizations:read`","tags":["subpackage_organizations"],"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 retrieval of the organization details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations_getOrganizations_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Unauthorized. The request is missing authentication credentials or the credentials provided are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrganizationsRequestUnauthorizedError"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Organization not found. The current organization associated with the authentication token could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrganizationsRequestNotFoundError"}}}},"500":{"description":"Internal server error. An error occurred on the server while processing the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrganizationsRequestInternalServerError"}}}}}}},"/screenings/manual-verification":{"post":{"operationId":"create-manual-verification","summary":"Create manual verification screening","description":"Use this endpoint to create a manual identity verification submission (in case automated one has failed multiple times or document country is not supported by automated solution)\n **Token scopes**: `worker:write`","tags":["subpackage_screenings"],"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/screenings_createManualVerification_Response_201"}}}},"400":{"description":"Bad Request - Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateManualVerificationScreeningRequestBadRequestError"}}}},"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":"Conflict - There is an existing name change screening pending","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateManualVerificationScreeningRequestConflictError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"back":{"type":"string","format":"binary","description":"The back side of the document"},"front":{"type":"string","format":"binary","description":"The front side of the document"},"additional":{"type":"string","format":"binary","description":"An additional document"},"document_type":{"$ref":"#/components/schemas/ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaDocumentType","description":"The type of document to be verified"},"operation_type":{"$ref":"#/components/schemas/ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaOperationType","description":"The type of KYC operation to perform"},"selfie_with_id":{"type":"string","format":"binary","description":"A selfie of the user holding the ID document"},"document_country":{"type":"string","description":"The issuing country code of the document to be verified (ISO 3166-1 alpha-2)"},"proof_of_residence":{"type":"string","format":"binary","description":"A proof of residence document"},"translation_required":{"type":"boolean","description":"Indicates whether the document requires translation"}},"required":["front","document_type","operation_type","selfie_with_id","translation_required"]}}}}}},"/veriff/session":{"post":{"operationId":"create-veriff-session","summary":"Create Veriff session","description":"Create Veriff session\n **Token scopes**: `screenings:write`, `worker:write`","tags":["subpackage_screenings"],"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/screenings_createVeriffSession_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":{"$ref":"#/components/schemas/VeriffSessionPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/screenings/aml/{entity_type}/{entity_id}":{"get":{"operationId":"get-aml-details","summary":"Get entity screening details","description":"Get the latest screening for an entity.\n **Token scopes**: `screenings:read`","tags":["subpackage_screenings"],"parameters":[{"name":"entity_type","in":"path","description":"The type of entity to screen. Only 'profile', 'hris_profile', 'legal_entity' are accepted.","required":true,"schema":{"$ref":"#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetParametersEntityType"}},{"name":"entity_id","in":"path","description":"UUID v4 of the entity","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":"Details of the screening request for the specified entity type and ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/screenings_getAMLDetails_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AmlApiForWhitelabelDataRetrieval-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":"Entity not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AmlApiForWhitelabelDataRetrieval-v2026-01-01RequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/screenings/verification-method":{"get":{"operationId":"get-verification-method","summary":"Get verification method","description":"Get verification method by provided country and document type\n **Token scopes**: `screenings:read`, `worker:read`","tags":["subpackage_screenings"],"parameters":[{"name":"country","in":"query","description":"The document's issuing country code (ISO 3166-1 alpha-2)","required":true,"schema":{"type":"string"}},{"name":"document_type","in":"query","description":"The document to be provided during KYC","required":true,"schema":{"$ref":"#/components/schemas/ScreeningsVerificationMethodGetParametersDocumentType"}},{"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/screenings_getVerificationMethod_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"}}}}}}},"/screenings/kyc/details":{"get":{"operationId":"get-kyc-details","summary":"Get worker's KYC details","description":"This endpoint allows organizations managing workers on Deel to retrieve detailed KYC verification data using the worker’s profile ID. It provides comprehensive information including verification status, document type, submission, approval, rejection, and expiry dates, supporting compliance monitoring and onboarding workflows\n **Token scopes**: `screenings:read`","tags":["subpackage_screenings"],"parameters":[{"name":"worker_profile_id","in":"query","description":"Worker's HRIS profile public ID client requests to fetch KYC details for. This parameter is mutually exclusive with profile_id","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"contract_id","in":"query","description":"Worker's contract ID. This parameter is required in case there are multiple profiles associated to the target worker. For example, when worker used to work for the former company he had another profile ID. So we need contract ID to properly resolve profile's KYC details.  In case this parameter is not provided and multiple associated profiles are found, exception with 409 status code will be thrown","required":false,"schema":{"type":"string"}},{"name":"profile_id","in":"query","description":"Worker's profile public ID client requests to fetch KYC details for, This parameter is mutually exclusive with worker_profile_id ","required":false,"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":"KYC details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/screenings_getKYCDetails_Response_200"}}}},"400":{"description":"Bad request - Invalid worker profile ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWorkersKycDetailsRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Forbidden - User not authorized to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWorkersKycDetailsRequestForbiddenError"}}}},"404":{"description":"Not Found - We could not extract any profile by the provided hris profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWorkersKycDetailsRequestNotFoundError"}}}},"409":{"description":"Conflict - We found multiple profiles for the provided worker ID. Please provide the contract id to resolve KYC details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWorkersKycDetailsRequestConflictError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/webhooks":{"post":{"operationId":"create-webhook","summary":"Create a webhook","description":"Create a new webhooks subscription.","tags":["subpackage_webhooks"],"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/WebhookItemResponse"}}}},"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"}}}},"405":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"429":{"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":{"$ref":"#/components/schemas/CreateWebhookRequest"}}}}},"get":{"operationId":"get-webhooks","summary":"List of webhooks","description":"Retrieve a list of webhook subscriptions.","tags":["subpackage_webhooks"],"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/WebhookListResponse"}}}},"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"}}}},"405":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"429":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/webhooks/{id}":{"delete":{"operationId":"delete-webhook","summary":"Delete a webhook","description":"Delete a webhook subscription.","tags":["subpackage_webhooks"],"parameters":[{"name":"id","in":"path","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/GenericResultDeleted"}}}},"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"}}}},"405":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"429":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"patch":{"operationId":"update-webhook","summary":"Edit a webhook","description":"Edit a webhook subscription.","tags":["subpackage_webhooks"],"parameters":[{"name":"id","in":"path","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/WebhookItemResponse"}}}},"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"}}}},"405":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"429":{"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":{"$ref":"#/components/schemas/PatchWebhookRequest"}}}}},"get":{"operationId":"get-webhook","summary":"Retrieve a single webhook","description":"Retrieve a single webhook subscription.","tags":["subpackage_webhooks"],"parameters":[{"name":"id","in":"path","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/WebhookItemResponse"}}}},"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"}}}},"405":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"429":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/webhooks/events/types":{"get":{"operationId":"get-webhook-events","summary":"List of webhook event types","description":"Retrieve a list of webhook event types.","tags":["subpackage_webhooks"],"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/WebhookEventTypeListResponse"}}}},"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"}}}},"405":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"429":{"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":{"LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Cost center Id"},"created_at":{"type":"string","format":"date-time","description":"Cost center date of registration on Deel"},"updated_at":{"type":"string","format":"date-time","description":"Cost center date of most recent update on Deel"},"cost_center_name":{"type":"string","description":"Cost center name to be displayed"},"cost_center_number":{"type":"string","description":"Cost center code"}},"title":"LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaDataItems"},"cost-centers_getLegalEntityCostCenters_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"cost-centers_getLegalEntityCostCenters_Response_200"},"LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"},"message":{"type":"string","description":"A description of the returned error"}},"title":"LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaErrorsItems"},"LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaRequest":{"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":"LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaRequest"},"GetCostCentersByLegalEntityRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaRequest"}},"title":"GetCostCentersByLegalEntityRequestBadRequestError"},"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"},"GroupsIdClonePostRequestBodyContentApplicationJsonSchemaDataExternalMetadata":{"type":"object","properties":{},"description":"The extra information of the group to be created.","title":"GroupsIdClonePostRequestBodyContentApplicationJsonSchemaDataExternalMetadata"},"GroupsIdClonePostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"The name of the group to be created."},"external_metadata":{"$ref":"#/components/schemas/GroupsIdClonePostRequestBodyContentApplicationJsonSchemaDataExternalMetadata","description":"The extra information of the group to be created."}},"required":["name"],"title":"GroupsIdClonePostRequestBodyContentApplicationJsonSchemaData"},"GroupsIdClonePostResponsesContentApplicationJsonSchemaDataExternalMetadata":{"type":"object","properties":{},"description":"Extra information of the group.","title":"GroupsIdClonePostResponsesContentApplicationJsonSchemaDataExternalMetadata"},"GroupsIdClonePostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the created group."},"name":{"type":"string","description":"The name of the created group."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the group was created."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the group was last updated."},"external_metadata":{"$ref":"#/components/schemas/GroupsIdClonePostResponsesContentApplicationJsonSchemaDataExternalMetadata","description":"Extra information of the group."}},"title":"GroupsIdClonePostResponsesContentApplicationJsonSchemaData"},"groups_cloneGroup_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GroupsIdClonePostResponsesContentApplicationJsonSchemaData"}},"title":"groups_cloneGroup_Response_201"},"GroupsIdClonePostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"A description of the returned error"}},"title":"GroupsIdClonePostResponsesContentApplicationJsonSchemaErrorsItems"},"CloneAGroupRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/GroupsIdClonePostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"CloneAGroupRequestBadRequestError"},"GroupsPostRequestBodyContentApplicationJsonSchemaDataExternalMetadata":{"type":"object","properties":{},"description":"The extra information of the group to be created.","title":"GroupsPostRequestBodyContentApplicationJsonSchemaDataExternalMetadata"},"GroupsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"The name of the group to be created."},"external_metadata":{"$ref":"#/components/schemas/GroupsPostRequestBodyContentApplicationJsonSchemaDataExternalMetadata","description":"The extra information of the group to be created."}},"required":["name"],"title":"GroupsPostRequestBodyContentApplicationJsonSchemaData"},"GroupsPostResponsesContentApplicationJsonSchemaDataExternalMetadata":{"type":"object","properties":{},"description":"Extra information of the group.","title":"GroupsPostResponsesContentApplicationJsonSchemaDataExternalMetadata"},"GroupsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the created group."},"name":{"type":"string","description":"The name of the created group."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the group was created."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the group was last updated."},"external_metadata":{"$ref":"#/components/schemas/GroupsPostResponsesContentApplicationJsonSchemaDataExternalMetadata","description":"Extra information of the group."}},"title":"GroupsPostResponsesContentApplicationJsonSchemaData"},"groups_createGroup_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GroupsPostResponsesContentApplicationJsonSchemaData"}},"title":"groups_createGroup_Response_200"},"GroupsPostResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"message":{"type":"string","description":"Description of the error."}},"title":"GroupsPostResponsesContentApplicationJsonSchemaError"},"CreateGroupRequestBadRequestError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/GroupsPostResponsesContentApplicationJsonSchemaError"}},"title":"CreateGroupRequestBadRequestError"},"GroupsIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"archived_at":{"type":"string","format":"date-time","description":"The timestamp when the group was archived."}},"title":"GroupsIdDeleteResponsesContentApplicationJsonSchemaData"},"groups_deleteGroup_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GroupsIdDeleteResponsesContentApplicationJsonSchemaData"}},"title":"groups_deleteGroup_Response_200"},"GroupsIdDeleteResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"message":{"type":"string","description":"Group not found error message."}},"title":"GroupsIdDeleteResponsesContentApplicationJsonSchemaError"},"DeleteGroupRequestBadRequestError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/GroupsIdDeleteResponsesContentApplicationJsonSchemaError"}},"title":"DeleteGroupRequestBadRequestError"},"DeleteGroupRequestNotFoundError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/GroupsIdDeleteResponsesContentApplicationJsonSchemaError"}},"title":"DeleteGroupRequestNotFoundError"},"GroupsIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"The updated name of the group."}},"required":["name"],"title":"GroupsIdPatchRequestBodyContentApplicationJsonSchemaData"},"GroupsIdPatchResponsesContentApplicationJsonSchemaDataExternalMetadata":{"type":"object","properties":{},"description":"Extra information of the group.","title":"GroupsIdPatchResponsesContentApplicationJsonSchemaDataExternalMetadata"},"GroupsIdPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the updated group."},"name":{"type":"string","description":"The updated name of the group."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the group was created."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the group was last updated."},"external_metadata":{"$ref":"#/components/schemas/GroupsIdPatchResponsesContentApplicationJsonSchemaDataExternalMetadata","description":"Extra information of the group."}},"title":"GroupsIdPatchResponsesContentApplicationJsonSchemaData"},"groups_updateGroup_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GroupsIdPatchResponsesContentApplicationJsonSchemaData"}},"title":"groups_updateGroup_Response_200"},"GroupsIdPatchResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"message":{"type":"string","description":"Description of the error."}},"title":"GroupsIdPatchResponsesContentApplicationJsonSchemaError"},"EditGroupRequestBadRequestError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/GroupsIdPatchResponsesContentApplicationJsonSchemaError"}},"title":"EditGroupRequestBadRequestError"},"GroupsGetParametersSortOrder":{"type":"string","enum":["ASC","DESC"],"default":"ASC","title":"GroupsGetParametersSortOrder"},"GroupsGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["active","archived"],"description":"The current status of the group (active or archived).","title":"GroupsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"GroupsGetResponsesContentApplicationJsonSchemaDataItemsExternalMetadata":{"type":"object","properties":{},"description":"Extra information about the group.","title":"GroupsGetResponsesContentApplicationJsonSchemaDataItemsExternalMetadata"},"GroupsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the group."},"name":{"type":"string","description":"The name of the group."},"status":{"$ref":"#/components/schemas/GroupsGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"The current status of the group (active or archived)."},"managers":{"type":"number","format":"double","description":"The number of managers associated with the group."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the group was created."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the group was last updated."},"archived_at":{"type":["string","null"],"format":"date-time","description":"The timestamp when the group was archived (if applicable)."},"external_metadata":{"$ref":"#/components/schemas/GroupsGetResponsesContentApplicationJsonSchemaDataItemsExternalMetadata","description":"Extra information about the group."}},"title":"GroupsGetResponsesContentApplicationJsonSchemaDataItems"},"GroupsGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"cursor":{"type":"string","description":"An opaque cursor to fetch the next set of results."},"total_rows":{"type":"integer","description":"The total number of groups available for the current query (including pagination)."}},"title":"GroupsGetResponsesContentApplicationJsonSchemaPage"},"groups_getGroups_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GroupsGetResponsesContentApplicationJsonSchemaDataItems"}},"page":{"$ref":"#/components/schemas/GroupsGetResponsesContentApplicationJsonSchemaPage"}},"title":"groups_getGroups_Response_200"},"GetGroupsRequestBadRequestError":{"type":"object","properties":{"message":{"type":"string","description":"Error message explaining what went wrong."}},"title":"GetGroupsRequestBadRequestError"},"ImmigrationVisaRequirementBusinessGetParametersTripReason":{"type":"string","enum":["INTERNAL_BUSINESS_WITH_WORK_FOR_CLIENT","INTERNAL_BUSINESS_WITHOUT_WORK_FOR_CLIENT","MEETINGS_WITH_OR_FOR_A_CLIENT","MEETINGS_WITH_POTENTIAL_CLIENTS","NEGOTIATING_CONTRACTS_OR_SIGNING_AGREEMENTS","OTHER_EXTERNAL_BUSINESS","CONFERENCE","TEAM_OFFSITE","SPEAKING_AT_CONFERENCE_UNPAID","SPEAKING_AT_CONFERENCE_PAID","ATTENDING_INTERNAL_TRAINING","ATTENDING_EXTERNAL_TRAINING","DELIVERING_TRAINING_TO_INTERNAL_PARTICIPANTS","DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_UNPAID","DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_PAID","PARTICIPATION_IN_RESEARCH_PROJECTS_AND_STUDIES","ASSEMBLY_MAINTENANCE_REPAIR_INSTALLATION","TECHNICAL_SUPPORT_OR_SUPERVISION","OTHER_HANDS_ON_LABOUR","MARKET_RESEARCH_AND_EXPLORING_INVESTMENT_OPPORTUNITIES","OTHER"],"title":"ImmigrationVisaRequirementBusinessGetParametersTripReason"},"ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataQualification":{"type":"string","enum":["VISA_REQUIRED","NO_VISA_REQUIRED","UNSUPPORTED"],"description":"Visa qualification status, whether it is required or not. It can be also unsupported if the country does not support business visa options.","title":"ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataQualification"},"ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataEstimatedTimeline":{"type":"string","enum":["SIX_WEEKS","THREE_MONTHS","ONE_WEEK","THREE_WEEKS","ONE_YEAR","TWO_WEEKS","FIVE_WEEKS","TWO_MONTHS","FIVE_MONTHS","FOUR_MONTHS","SIX_MONTHS","FOUR_WEEKS"],"description":"Estimated processing timeline, in weeks, months or years","title":"ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataEstimatedTimeline"},"ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"fee":{"type":["number","null"],"format":"double","description":"Fee amount"},"name":{"type":["string","null"],"description":"Name of the visa type"},"description":{"type":"string","description":"Description of the visa type"},"fee_currency":{"type":["string","null"],"description":"Currency code for the fee in ISO 4217 format"},"visa_type_id":{"type":["string","null"],"format":"uuid","description":"Unique identifier of the visa type. This can be used to create a new business visa case on the create cases endpoint."},"qualification":{"$ref":"#/components/schemas/ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataQualification","description":"Visa qualification status, whether it is required or not. It can be also unsupported if the country does not support business visa options."},"estimated_timeline":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataEstimatedTimeline"},{"type":"null"}],"description":"Estimated processing timeline, in weeks, months or years"}},"required":["fee","name","description","fee_currency","visa_type_id","qualification","estimated_timeline"],"title":"ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaData"},"immigration_getBusinessVisaRequirement_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"immigration_getBusinessVisaRequirement_Response_200"},"ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetBusinessVisaEligibilityAndRequirementsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetBusinessVisaEligibilityAndRequirementsRequestBadRequestError"},"GetBusinessVisaEligibilityAndRequirementsRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetBusinessVisaEligibilityAndRequirementsRequestInternalServerError"},"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["OPEN","CLOSED","ON_HOLD"],"description":"Status of the immigration case.","title":"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataStatus"},"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataProcess":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the current active process."},"name":{"type":"string","description":"Name of the current active process."},"status":{"type":"string","description":"Status of the current active process."}},"title":"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataProcess"},"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataApplicant":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the applicant profile id."},"external_id":{"type":["string","null"],"description":"External identifier of the applicant."}},"title":"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataApplicant"},"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus":{"type":"string","enum":["IN_REVIEW","APPROVED","REJECTED"],"description":"Status of the document.","title":"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus"},"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the document."},"status":{"$ref":"#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus","description":"Status of the document."},"document_type":{"type":"string","description":"The type of the document. Represents the visa type for right to work cases."},"expiration_date":{"type":"string","format":"date-time","description":"Expiry date of the document."}},"title":"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems"},"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of immigration case."},"status":{"$ref":"#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataStatus","description":"Status of the immigration case."},"process":{"$ref":"#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataProcess"},"applicant":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataApplicant"},{"type":"null"}]},"case_type":{"type":"string","description":"Name of the case type"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems"}},"visa_type":{"type":["string","null"],"description":"The type of the the visa."},"country_code":{"type":"string","description":"The country of the immigration case."},"last_update_at":{"type":"string","format":"date-time","description":"Last activity on the immigration case."},"case_created_at":{"type":"string","format":"date-time","description":"Creation date of the immigration case."},"estimated_completion_date":{"type":["string","null"],"format":"date-time","description":"Estimated completion date of the immigration case."}},"title":"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaData"},"immigration_getClientCase_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaData"}},"title":"immigration_getClientCase_Response_200"},"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetImmigrationCaseDetails-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetImmigrationCaseDetails-v2026-01-01RequestBadRequestError"},"GetImmigrationCaseDetails-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetImmigrationCaseDetails-v2026-01-01RequestInternalServerError"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["OPEN","CLOSED","ON_HOLD"],"description":"Status of the immigration case.","title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataStatus"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcessName":{"type":"string","enum":["WORK_AUTHORIZATION_VERIFICATION"],"description":"Name of the current active process.","title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcessName"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcessStatus":{"type":"string","enum":["CANCELLED","AWAITING_DOCUMENTS","IN_REVIEW","APPROVED","REJECTED","IN_PROGRESS"],"description":"Status of the current active process.","title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcessStatus"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcess":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the current active process."},"name":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcessName","description":"Name of the current active process."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcessStatus","description":"Status of the current active process."},"rejection_note":{"type":"string","description":"A detailed description of why the case was rejected. Only available if the case status is REJECTED."},"rejection_reason":{"type":"string","description":"The reason why the case was rejected. Only available if the case status is REJECTED."}},"description":"The current active process","title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcess"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataContract":{"type":"object","properties":{"id":{"type":["string","null"],"description":"Id of the contract associated with the immigration case"}},"description":"The contract associated with the returned immigration case","title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataContract"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataApplicant":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the applicant profile id."},"external_id":{"type":["string","null"],"description":"External identifier of the applicant  (from partner system or third party)."}},"description":"The employee for which this Right to Work case has been created for","title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataApplicant"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataCaseType":{"type":"string","enum":["IMMIGRATION_DOCUMENT_REVIEW"],"description":" Type of the case. It will always be IMMIGRATION_DOCUMENT_REVIEW for this endpoint.","title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataCaseType"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus":{"type":"string","enum":["IN_REVIEW","ACTIVE","EXPIRED","EXPIRING"],"description":"Status of the document.","title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the document."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus","description":"Status of the document."},"document_type":{"type":["string","null"],"description":"The type of the document. Represents the visa type for right to work cases."},"expiration_date":{"type":["string","null"],"format":"date-time","description":"Expiry date of the document. If document does not expire, it will be null"}},"title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of immigration case."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataStatus","description":"Status of the immigration case."},"process":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcess","description":"The current active process"},"contract":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataContract","description":"The contract associated with the returned immigration case"},"applicant":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataApplicant"},{"type":"null"}],"description":"The employee for which this Right to Work case has been created for"},"case_type":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataCaseType","description":" Type of the case. It will always be IMMIGRATION_DOCUMENT_REVIEW for this endpoint."},"documents":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems"},"description":"A list of documents associated to the immigration case"},"visa_type":{"type":["string","null"],"description":"The type of the visa."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the immigration case."},"updated_at":{"type":"string","format":"date-time","description":"Last activity on the immigration case."},"country_code":{"type":"string","description":"The country of the immigration case."},"estimated_completion_date":{"type":["string","null"],"format":"date-time","description":"Estimated completion date of the immigration case."}},"title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaData"},"immigration_getWorkerCase_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaData"}},"title":"immigration_getWorkerCase_Response_200"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetSpecificImmigrationCaseDetails-v2026-04-02RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetSpecificImmigrationCaseDetails-v2026-04-02RequestBadRequestError"},"GetSpecificImmigrationCaseDetails-v2026-04-02RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetSpecificImmigrationCaseDetails-v2026-04-02RequestInternalServerError"},"ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["IN_REVIEW","APPROVED","REJECTED"],"description":"Current status of the document.","title":"ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"The UUID of document entity."},"status":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaDataItemsStatus"},{"type":"null"}],"description":"Current status of the document."},"document_type":{"type":["string","null"],"description":"The type of the document. Represents the visa type for right to work cases."},"download_link":{"type":"array","items":{"type":"string"},"description":"S3 download link of all the files uploaded within current document record."},"expiration_date":{"type":["string","null"],"format":"date-time","description":"Expiry date of the document."}},"title":"ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaDataItems"},"immigration_getDocument_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"immigration_getDocument_Response_200"},"ImmigrationVisaTypesCountryCodeGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of a visa type."},"name":{"type":"string","description":"The name of a visa."}},"title":"ImmigrationVisaTypesCountryCodeGetResponsesContentApplicationJsonSchemaDataItems"},"immigration_getVisaTypes_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationVisaTypesCountryCodeGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"immigration_getVisaTypes_Response_200"},"ImmigrationClientCasesGetParametersStatusesSchemaItems":{"type":"string","enum":["OPEN","ON_HOLD","CLOSED"],"title":"ImmigrationClientCasesGetParametersStatusesSchemaItems"},"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["OPEN","CLOSED","ON_HOLD"],"description":"Current lifecycle status of the immigration case.","title":"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason":{"type":"string","enum":["CONTRACT_CANCELLED","NATIONALITY_CHANGE","NEW_CASE_TYPE_IS_REQUIRED","ONBOARDING_RELEASED","OTHER"],"description":"Reason why the immigration case was closed.","title":"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason"},"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure":{"type":"object","properties":{"note":{"type":["string","null"],"description":"Additional notes explaining the case closure."},"reason":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason"},{"type":"null"}],"description":"Reason why the immigration case was closed."}},"required":["note","reason"],"description":"Closure details of the case if the case has been closed.","title":"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure"},"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Unique identifier of the process status."},"name":{"type":["string","null"],"description":"Human-readable name of the process status."}},"required":["id","name"],"description":"Current status of the process.","title":"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus"},"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the current process."},"name":{"type":"string","description":"Human-readable name of the current process step."},"status":{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus","description":"Current status of the process."}},"required":["id","name","status"],"description":"Current active process associated with the case.","title":"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess"},"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Unique identifier of the applicant."},"name":{"type":"string","description":"Full name of the applicant."}},"required":["name"],"description":"Applicant associated with the immigration case.","title":"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant"},"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the case type."},"name":{"type":"string","description":"Human-readable name of the case type."}},"required":["id","name"],"description":"Type of immigration case.","title":"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType"},"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the immigration case."},"status":{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"Current lifecycle status of the immigration case."},"closure":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure"},{"type":"null"}],"description":"Closure details of the case if the case has been closed."},"process":{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess","description":"Current active process associated with the case."},"applicant":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant"},{"type":"null"}],"description":"Applicant associated with the immigration case."},"case_type":{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType","description":"Type of immigration case."},"created_at":{"type":"string","format":"date-time","description":"Timestamp indicating when the case was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp indicating when the case was last updated."}},"required":["id","status","closure","process","applicant","case_type","created_at","updated_at"],"title":"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItems"},"immigration_getClientCases_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of cases in the current page."},"has_more":{"type":"boolean","description":"Indicates whether more results are available for pagination."},"next_cursor":{"type":["string","null"],"description":"Cursor value to be used for fetching the next page of results."},"total_count":{"type":"integer","description":"Total number of cases matching the search criteria."}},"required":["data","has_more","total_count"],"title":"immigration_getClientCases_Response_200"},"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaErrorsItems"},"ListOfImmigrationCases-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListOfImmigrationCases-v2026-01-01RequestBadRequestError"},"ListOfImmigrationCases-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListOfImmigrationCases-v2026-01-01RequestInternalServerError"},"ImmigrationWorkersCasesGetParametersStatusesSchemaItems":{"type":"string","enum":["OPEN","ON_HOLD","CLOSED"],"title":"ImmigrationWorkersCasesGetParametersStatusesSchemaItems"},"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["OPEN","CLOSED","ON_HOLD"],"description":"Current lifecycle status of the immigration case.","title":"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason":{"type":"string","enum":["CONTRACT_CANCELLED","NATIONALITY_CHANGE","NEW_CASE_TYPE_IS_REQUIRED","ONBOARDING_RELEASED","OTHER"],"description":"Reason why the immigration case was closed.","title":"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason"},"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure":{"type":"object","properties":{"note":{"type":["string","null"],"description":"Additional notes explaining the case closure."},"reason":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason"},{"type":"null"}],"description":"Reason why the immigration case was closed."}},"required":["note","reason"],"description":"Closure details of the case if the case has been closed.","title":"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure"},"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Unique identifier of the process status."},"name":{"type":["string","null"],"description":"Human-readable name of the process status."}},"required":["id","name"],"description":"Current status of the process.","title":"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus"},"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the current process."},"name":{"type":"string","description":"Human-readable name of the current process step."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus","description":"Current status of the process."}},"required":["id","name","status"],"description":"Current active process associated with the case.","title":"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess"},"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Unique identifier of the applicant."},"name":{"type":"string","description":"Full name of the applicant."}},"required":["name"],"description":"Applicant associated with the immigration case.","title":"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant"},"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the case type."},"name":{"type":"string","description":"Human-readable name of the case type."}},"required":["id","name"],"description":"Type of immigration case.","title":"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType"},"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the immigration case."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"Current lifecycle status of the immigration case."},"closure":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure"},{"type":"null"}],"description":"Closure details of the case if the case has been closed."},"process":{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess","description":"Current active process associated with the case."},"applicant":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant"},{"type":"null"}],"description":"Applicant associated with the immigration case."},"case_type":{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType","description":"Type of immigration case."},"created_at":{"type":"string","format":"date-time","description":"Timestamp indicating when the case was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp indicating when the case was last updated."}},"required":["id","status","closure","process","applicant","case_type","created_at","updated_at"],"title":"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItems"},"immigration_getWorkerCases_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of cases in the current page."},"has_more":{"type":"boolean","description":"Indicates whether more results are available for pagination."},"next_cursor":{"type":["string","null"],"description":"Cursor value to be used for fetching the next page of results."},"total_count":{"type":"integer","description":"Total number of cases matching the search criteria."}},"required":["data","has_more","total_count"],"title":"immigration_getWorkerCases_Response_200"},"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaErrorsItems"},"ListOfImmigrationCasesForWorkers-v2026-04-02RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListOfImmigrationCasesForWorkers-v2026-04-02RequestBadRequestError"},"ListOfImmigrationCasesForWorkers-v2026-04-02RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListOfImmigrationCasesForWorkers-v2026-04-02RequestInternalServerError"},"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocumentStatus":{"type":"string","enum":["PENDING","IN_REVIEW","ACTIVE","EXPIRING","EXPIRED"],"description":"Status of the document.","title":"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocumentStatus"},"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocument":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the document."},"name":{"type":"string","description":"The name of the document."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocumentStatus","description":"Status of the document."},"expiration_date":{"type":["string","null"],"format":"date-time","description":"Expiration date of the document. If document does not expire, it will be null"}},"title":"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocument"},"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocumentStatus":{"type":"string","enum":["REJECTED"],"description":"Status of the document.","title":"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocumentStatus"},"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocument":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the document."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocumentStatus","description":"Status of the document."},"rejection_note":{"type":["string","null"],"description":"A detailed description about why the document was rejected."},"rejection_reason":{"type":["string","null"],"description":"The reason why the document was rejected."}},"title":"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocument"},"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the document requirement."},"name":{"type":"string","description":"The name of the document requirement to be uploaded."},"document":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocument"},"created_at":{"type":"string","format":"date-time","description":"Creation date of the document request."},"updated_at":{"type":"string","format":"date-time","description":"Last update date of the document request."},"description":{"type":"string","description":"A short text description of the document requirement to be uploaded."},"previous_rejected_document":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocument"},"immigration_document_requirement_id":{"type":"string","description":"The unique identifier of the immigration document requirement."}},"title":"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaData"},"immigration_getWorkerCaseRequiredDocument_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaData"}},"title":"immigration_getWorkerCaseRequiredDocument_Response_200"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["OPEN","CLOSED","ON_HOLD"],"description":"Status of the immigration case.","title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataStatus"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessName":{"type":"string","enum":["WORK_AUTHORIZATION_VERIFICATION"],"description":"Name of the current active process.","title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessName"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessStatus":{"type":"string","enum":["CANCELLED","AWAITING_DOCUMENTS","IN_REVIEW","APPROVED","REJECTED"],"description":"Status of the current active process.","title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessStatus"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcess":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the current active process."},"name":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessName","description":"Name of the current active process."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessStatus","description":"Status of the current active process."},"rejection_note":{"type":"string","description":"A detailed description of why the case was rejected. Only available if the case status is REJECTED."},"rejection_reason":{"type":"string","description":"The reason why the case was rejected. Only available if the case status is REJECTED."}},"description":"The current active process","title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcess"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataContract":{"type":"object","properties":{"id":{"type":["string","null"],"description":"Id of the contract associated with the immigration case"}},"description":"The contract associated with the returned immigration case","title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataContract"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataApplicant":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the applicant profile id."},"external_id":{"type":["string","null"],"description":"External identifier of the applicant  (from partner system or third party)."}},"description":"The employee for which this Right to Work case has been created for","title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataApplicant"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataCaseType":{"type":"string","enum":["IMMIGRATION_DOCUMENT_REVIEW"],"description":" Type of the case. It will always be IMMIGRATION_DOCUMENT_REVIEW for this endpoint.","title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataCaseType"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus":{"type":"string","enum":["IN_REVIEW","ACTIVE","EXPIRED","EXPIRING"],"description":"Status of the document.","title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the document."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus","description":"Status of the document."},"document_type":{"type":["string","null"],"description":"The type of the document. Represents the visa type for right to work cases."},"expiration_date":{"type":["string","null"],"format":"date-time","description":"Expiry date of the document. If document does not expire, it will be null"}},"title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItems"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of immigration case."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataStatus","description":"Status of the immigration case."},"process":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcess","description":"The current active process"},"contract":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataContract","description":"The contract associated with the returned immigration case"},"applicant":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataApplicant"},{"type":"null"}],"description":"The employee for which this Right to Work case has been created for"},"case_type":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataCaseType","description":" Type of the case. It will always be IMMIGRATION_DOCUMENT_REVIEW for this endpoint."},"documents":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItems"},"description":"A list of documents associated to the immigration case"},"visa_type":{"type":["string","null"],"description":"The type of the visa."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the immigration case."},"updated_at":{"type":"string","format":"date-time","description":"Last activity on the immigration case."},"country_code":{"type":"string","description":"The country of the immigration case."},"estimated_completion_date":{"type":["string","null"],"format":"date-time","description":"Estimated completion date of the immigration case."}},"title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaData"},"immigration_getWorkerOnboardingCase_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaData"}},"title":"immigration_getWorkerOnboardingCase_Response_200"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveOnboardingRightToWorkCaseForAWorkerRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOnboardingRightToWorkCaseForAWorkerRequestBadRequestError"},"RetrieveOnboardingRightToWorkCaseForAWorkerRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"RetrieveOnboardingRightToWorkCaseForAWorkerRequestNotFoundError"},"RetrieveOnboardingRightToWorkCaseForAWorkerRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOnboardingRightToWorkCaseForAWorkerRequestInternalServerError"},"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostRequestBodyContentMultipartFormDataSchemaData":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"Immigration right to work document. More than 1 document can be uploaded at the same time (e.g.: front and back)"}},"required":["file"],"description":"Details of immigration document upload","title":"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostRequestBodyContentMultipartFormDataSchemaData"},"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["IN_REVIEW"],"description":"Status of the document.","title":"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaDataStatus"},"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the document."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaDataStatus","description":"Status of the document."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the document."},"updated_at":{"type":"string","format":"date-time","description":"Last update date of the document."}},"title":"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaData"},"immigration_createWorkerCaseRequiredDocument_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaData"}},"title":"immigration_createWorkerCaseRequiredDocument_Response_201"},"LegalEntitiesPostRequestBodyContentApplicationJsonSchemaDataAddress":{"type":"object","properties":{"zip":{"type":"string","description":"Zip code."},"city":{"type":"string","description":"City name."},"state":{"type":"string","description":"State "},"street":{"type":"string","description":"Street address."},"country":{"type":"string","description":"Country code."}},"required":["zip","city","street","country"],"description":"The physical address of the entity.","title":"LegalEntitiesPostRequestBodyContentApplicationJsonSchemaDataAddress"},"LegalEntitiesPostRequestBodyContentApplicationJsonSchemaDataCompanyIdentifiers":{"type":"object","properties":{"tax_number":{"type":"string","description":"Tax number of the entity."},"registration_number":{"type":"string","description":"Registration number of the entity."}},"required":["tax_number","registration_number"],"title":"LegalEntitiesPostRequestBodyContentApplicationJsonSchemaDataCompanyIdentifiers"},"LegalEntitiesPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"The legal name of the entity."},"phone":{"type":"string","description":"Contact phone number for the entity."},"address":{"$ref":"#/components/schemas/LegalEntitiesPostRequestBodyContentApplicationJsonSchemaDataAddress","description":"The physical address of the entity."},"sic_number":{"type":"string","description":"The SIC number for the entity."},"entity_type":{"type":"string","description":"Type of the entity."},"company_identifiers":{"$ref":"#/components/schemas/LegalEntitiesPostRequestBodyContentApplicationJsonSchemaDataCompanyIdentifiers"}},"required":["name","phone","address","sic_number","entity_type","company_identifiers"],"title":"LegalEntitiesPostRequestBodyContentApplicationJsonSchemaData"},"LegalEntitiesPostResponsesContentApplicationJsonSchemaDataAddress":{"type":"object","properties":{"zip":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"country":{"type":"string"}},"description":"The entity's address.","title":"LegalEntitiesPostResponsesContentApplicationJsonSchemaDataAddress"},"LegalEntitiesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the legal entity."},"name":{"type":"string","description":"The name of the entity."},"phone":{"type":"string","description":"The contact number of the entity."},"address":{"$ref":"#/components/schemas/LegalEntitiesPostResponsesContentApplicationJsonSchemaDataAddress","description":"The entity's address."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the entity was created."},"sic_number":{"type":"string","description":"The SIC number of the entity."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the entity was last updated."},"entity_type":{"type":"string","description":"Type of the entity."}},"title":"LegalEntitiesPostResponsesContentApplicationJsonSchemaData"},"legal-entities_createLegalEntity_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LegalEntitiesPostResponsesContentApplicationJsonSchemaData"}},"title":"legal-entities_createLegalEntity_Response_200"},"CreateLegalEntityRequestBadRequestError":{"type":"object","properties":{"message":{"type":"string","description":"Error message explaining what went wrong."}},"title":"CreateLegalEntityRequestBadRequestError"},"CreateLegalEntityRequestForbiddenError":{"type":"object","properties":{"message":{"type":"string","description":"Error message explaining the lack of permission."}},"title":"CreateLegalEntityRequestForbiddenError"},"legal-entities_deleteLegalEntity_Response_200":{"type":"object","properties":{"archived_at":{"type":"string","format":"date-time","description":"The timestamp when the legal entity was archived."}},"title":"legal-entities_deleteLegalEntity_Response_200"},"DeleteLegalEntityRequestBadRequestError":{"type":"object","properties":{"message":{"type":"string","description":"Error message explaining what went wrong."}},"title":"DeleteLegalEntityRequestBadRequestError"},"DeleteLegalEntityRequestForbiddenError":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining why access is denied."}},"title":"DeleteLegalEntityRequestForbiddenError"},"LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaAddress":{"type":"object","properties":{"city":{"type":"string","description":"The city."},"state":{"type":"string","description":"The state."},"street":{"type":"string","description":"The street address."},"country":{"type":"string","description":"The ISO 2-letter country code."}},"title":"LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaAddress"},"LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaCompanyIdentifiers":{"type":"object","properties":{"tax_number":{"type":"string","description":"The tax identification number of the legal entity."},"registration_number":{"type":"string","description":"The registration number of the legal entity."}},"description":"Identifiers associated with the legal entity.","title":"LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaCompanyIdentifiers"},"LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaDataAddress":{"type":"object","properties":{"city":{"type":"string","description":"The city."},"state":{"type":"string","description":"The state."},"street":{"type":"string","description":"The street address."},"country":{"type":"string","description":"The ISO 2-letter country code."}},"title":"LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaDataAddress"},"LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaDataCompanyIdentifiers":{"type":"object","properties":{"tax_number":{"type":"string","description":"The tax identification number of the legal entity."},"registration_number":{"type":"string","description":"The registration number of the legal entity."}},"title":"LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaDataCompanyIdentifiers"},"LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the legal entity."},"name":{"type":"string","description":"The name of the legal entity."},"phone":{"type":"string","description":"The phone number of the legal entity."},"address":{"$ref":"#/components/schemas/LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaDataAddress"},"sic_number":{"type":"string","description":"The SIC number of the legal entity."},"entity_type":{"type":"string","description":"The type of the legal entity."},"industry_name":{"type":"string","description":"The industry name of the legal entity."},"company_identifiers":{"$ref":"#/components/schemas/LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaDataCompanyIdentifiers"}},"title":"LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaData"},"legal-entities_updateLegalEntity_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaData"}},"title":"legal-entities_updateLegalEntity_Response_200"},"EditLegalEntityRequestBadRequestError":{"type":"object","properties":{"message":{"type":"string","description":"Error message explaining what went wrong."}},"title":"EditLegalEntityRequestBadRequestError"},"EditLegalEntityRequestForbiddenError":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining why access is denied."}},"title":"EditLegalEntityRequestForbiddenError"},"IndustriesGetParametersOrder":{"type":"string","enum":["ASC","DESC"],"default":"ASC","title":"IndustriesGetParametersOrder"},"IndustriesGetParametersSortBy":{"type":"string","enum":["subcategoryName","categoryName"],"default":"categoryName","title":"IndustriesGetParametersSortBy"},"IndustriesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"UUID of the subcategory."},"name":{"type":"string","description":"Name of the industry subcategory."},"created_at":{"type":"string","format":"date-time","description":"Date and time when the subcategory was created."},"updated_at":{"type":"string","format":"date-time","description":"Date and time when the subcategory was last updated."},"category_name":{"type":["string","null"],"description":"Name of the associated industry category."}},"required":["id","name","created_at","updated_at","category_name"],"title":"IndustriesGetResponsesContentApplicationJsonSchemaDataItems"},"legal-entities_getIndustries_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IndustriesGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of industry subcategories."},"has_more":{"type":"boolean","description":"Indicates if there are more results available."},"next_cursor":{"type":["string","null"],"description":"Cursor to fetch the next page of results."},"total_count":{"type":"integer","description":"Total number of results matching the query."}},"required":["data","has_more","next_cursor","total_count"],"title":"legal-entities_getIndustries_Response_200"},"IndustriesGetResponsesContentApplicationJsonSchemaErrorsItems":{"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":"IndustriesGetResponsesContentApplicationJsonSchemaErrorsItems"},"IndustriesGetResponsesContentApplicationJsonSchemaRequest":{"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":"IndustriesGetResponsesContentApplicationJsonSchemaRequest"},"ListAllIndustrySubcategories-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/IndustriesGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/IndustriesGetResponsesContentApplicationJsonSchemaRequest"}},"title":"ListAllIndustrySubcategories-v2026-01-01RequestBadRequestError"},"LegalEntitiesGetParametersSortOrder":{"type":"string","enum":["ASC","DESC"],"default":"ASC","title":"LegalEntitiesGetParametersSortOrder"},"LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsAddress":{"type":"object","properties":{"zip":{"type":"string","description":"Zip code"},"city":{"type":["string","null"],"description":"City"},"state":{"type":["string","null"],"description":"State"},"street":{"type":"string","description":"Street"},"country":{"type":"string","description":"Country"}},"title":"LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsAddress"},"LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsEntityType":{"type":"string","enum":["individual","company"],"description":"Entity type","title":"LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsEntityType"},"LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Id of the legal entity"},"name":{"type":"string","description":"Name of the legal entity"},"phone":{"type":["string","null"],"description":"Phone number"},"vat_id":{"type":["string","null"],"description":"VAT ID"},"address":{"oneOf":[{"$ref":"#/components/schemas/LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsAddress"},{"type":"null"}]},"country":{"type":["string","null"],"description":"Country of the legal entity"},"created_at":{"type":"string","format":"date-time","description":"Created date"},"sic_number":{"type":["string","null"],"description":"SIC Company Identifier"},"updated_at":{"type":"string","format":"date-time","description":"Updated date"},"archived_at":{"type":["string","null"],"format":"date-time","description":"Archived date"},"entity_type":{"$ref":"#/components/schemas/LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsEntityType","description":"Entity type"},"industry_name":{"type":["string","null"],"description":"Industry name"},"entity_subtype":{"type":"string","description":"Entity sub type"},"registrationNumber":{"type":["string","null"],"description":"Registration number"}},"title":"LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItems"},"LegalEntitiesGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"cursor":{"type":["string","null"],"description":"Cursor link"}},"title":"LegalEntitiesGetResponsesContentApplicationJsonSchemaPage"},"legal-entities_getLegalEntities_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItems"}},"page":{"$ref":"#/components/schemas/LegalEntitiesGetResponsesContentApplicationJsonSchemaPage"}},"title":"legal-entities_getLegalEntities_Response_200"},"LookupsJobTitlesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"identifier of the job title"},"name":{"type":"string","description":"Job title."}},"required":["id","name"],"title":"LookupsJobTitlesGetResponsesContentApplicationJsonSchemaDataItems"},"LookupsJobTitlesGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"cursor":{"type":"string","description":"Use for pagination to get next set of records after the given cursor."}},"required":["cursor"],"title":"LookupsJobTitlesGetResponsesContentApplicationJsonSchemaPage"},"lookups_getJobTitles_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LookupsJobTitlesGetResponsesContentApplicationJsonSchemaDataItems"}},"page":{"$ref":"#/components/schemas/LookupsJobTitlesGetResponsesContentApplicationJsonSchemaPage"}},"title":"lookups_getJobTitles_Response_200"},"LookupsCountriesGetResponsesContentApplicationJsonSchemaDataItemsStatesItems":{"type":"object","properties":{"code":{"type":"string","description":"The code representing the sub-territory (e.g., state or region)."},"name":{"type":"string","description":"The name of the sub-territory (e.g., state or region)."}},"required":["code","name"],"title":"LookupsCountriesGetResponsesContentApplicationJsonSchemaDataItemsStatesItems"},"LookupsCountriesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"code":{"type":"string","description":"The ISO 3166-1 alpha-2 country code."},"name":{"type":"string","description":"The official name of the country."},"states":{"type":"array","items":{"$ref":"#/components/schemas/LookupsCountriesGetResponsesContentApplicationJsonSchemaDataItemsStatesItems"},"description":"List of sub-territories within the country. These may be called states, provinces, prefectures, regions, or may not exist."},"state_type":{"type":["string","null"],"description":"The designation for sub-territories within the country, such as 'state', 'province', 'prefecture', or 'region'. If none, this field will be null."},"eor_support":{"type":"boolean","description":"Indicates whether Deel provides Employer of Record (EoR) support in this country."},"visa_support":{"type":"boolean","description":"Indicates whether Deel provides visa support for employees being hired in this country."},"default_currency":{"type":"string","description":"Indicates the default currency 3-letter ISO code"}},"required":["code","name","states","state_type","eor_support","visa_support","default_currency"],"title":"LookupsCountriesGetResponsesContentApplicationJsonSchemaDataItems"},"lookups_getCountries_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LookupsCountriesGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"lookups_getCountries_Response_200"},"LookupsSenioritiesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"A unique identifier for the seniority level."},"name":{"type":"string","description":"The name of the seniority level, e.g., 'Mid (Individual Contributor Level 2)'."},"level":{"type":["number","null"],"format":"double","description":"The hierarchical level of seniority, where higher numbers indicate greater seniority."}},"required":["id","name"],"title":"LookupsSenioritiesGetResponsesContentApplicationJsonSchemaDataItems"},"lookups_getSeniorityLevels_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LookupsSenioritiesGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of predefined seniority levels supported by the Deel platform."}},"title":"lookups_getSeniorityLevels_Response_200"},"LookupsCurrenciesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"code":{"type":"string","description":"The ISO 4217 three-letter currency code."},"name":{"type":["string","null"],"description":"The name of the currency. This may be null if a name is not available."}},"required":["code"],"title":"LookupsCurrenciesGetResponsesContentApplicationJsonSchemaDataItems"},"lookups_getCurrencies_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LookupsCurrenciesGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of currencies supported by Deel."}},"title":"lookups_getCurrencies_Response_200"},"LookupsTimeOffTypesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"string","enum":["VACATION","SICK_LEAVE","OTHER","UNPAID_LEAVE"],"description":"Predefined time-off types. Possible values include 'VACATION', 'SICK_LEAVE', 'UNPAID_LEAVE'  and 'OTHER'.","title":"LookupsTimeOffTypesGetResponsesContentApplicationJsonSchemaDataItems"},"lookups_getTimeOffTypes_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LookupsTimeOffTypesGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of predefined time-off types supported by the Deel platform."}},"title":"lookups_getTimeOffTypes_Response_200"},"LookupsTimeOffTypesGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing what went wrong."}},"required":["message"],"title":"LookupsTimeOffTypesGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveTimeOffTypesRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/LookupsTimeOffTypesGetResponsesContentApplicationJsonSchemaErrorsItems"},"description":"Array of error objects containing error messages."}},"required":["errors"],"title":"RetrieveTimeOffTypesRequestNotFoundError"},"MagicLinkPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"redirect_path":{"type":"string","description":"Path to redirect the user to after successful authentication."}},"title":"MagicLinkPostRequestBodyContentApplicationJsonSchemaData"},"MagicLinkPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"expires_at":{"type":"string","format":"date-time","description":"When the magic link expires (ISO 8601 format)"},"magic_link":{"type":"string","description":"The magic link URL that users can click and log in to deel automatically."}},"required":["expires_at","magic_link"],"title":"MagicLinkPostResponsesContentApplicationJsonSchemaData"},"magic-link_createMagicLink_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MagicLinkPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"magic-link_createMagicLink_Response_201"},"CreateMagicLinkRequestUnauthorizedError":{"type":"object","properties":{"error":{"type":"string"}},"title":"CreateMagicLinkRequestUnauthorizedError"},"CreateMagicLinkRequestInternalServerError":{"type":"object","properties":{"error":{"type":"string"}},"title":"CreateMagicLinkRequestInternalServerError"},"ManagersPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"The email address of the manager."},"last_name":{"type":"string","description":"The last name of the manager."},"first_name":{"type":"string","description":"The first name of the manager."}},"required":["email","last_name","first_name"],"title":"ManagersPostRequestBodyContentApplicationJsonSchemaData"},"ManagersPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the created manager."},"email":{"type":"string","format":"email","description":"The email address of the created manager."},"last_name":{"type":"string","description":"The last name of the created manager."},"first_name":{"type":"string","description":"The first name of the created manager."}},"required":["id","email","last_name","first_name"],"title":"ManagersPostResponsesContentApplicationJsonSchemaData"},"managers_createManager_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ManagersPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"managers_createManager_Response_201"},"CreateManagerRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string","description":"Description of the validation error."}},"title":"CreateManagerRequestBadRequestError"},"CreateManagerRequestConflictError":{"type":"object","properties":{"error":{"type":"string","description":"Explanation of the conflict error."}},"title":"CreateManagerRequestConflictError"},"ManagersGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the manager."},"email":{"type":"string","format":"email","description":"The email address of the manager."},"last_name":{"type":"string","description":"The last name of the manager."},"first_name":{"type":"string","description":"The first name of the manager."}},"required":["id"],"title":"ManagersGetResponsesContentApplicationJsonSchemaDataItems"},"ManagersGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"offset":{"type":["number","null"],"format":"double","description":"The offset/index of the current page."},"total_rows":{"type":"number","format":"double","description":"Total number of rows available for this resource."},"items_per_page":{"type":["number","null"],"format":"double","description":"Number of items returned per page."}},"required":["total_rows"],"description":"Pagination details for the response.","title":"ManagersGetResponsesContentApplicationJsonSchemaPage"},"managers_getManagers_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ManagersGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of managers in the organization."},"page":{"$ref":"#/components/schemas/ManagersGetResponsesContentApplicationJsonSchemaPage","description":"Pagination details for the response."}},"required":["data","page"],"title":"managers_getManagers_Response_200"},"OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataChildOrganization":{"type":"object","properties":{"name":{"type":"string","description":"The organization's name."},"department":{"type":"string","description":"The department's name where the manager will be added"},"is_api_enabled":{"type":"boolean","description":"The flag that enables the public API for the child organization."},"workforce_size":{"type":"integer","description":"The workforce size of the child organization."},"headquarters_country":{"type":"string","description":"The 2-letter country code of the organization's headquarters."}},"required":["name"],"description":"The object that contains all the information related to the child organization that will be created.","title":"OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataChildOrganization"},"OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataParentOrganization":{"type":"object","properties":{"admin_email":{"type":"string","description":"The email of one of the managers of the parent organization that will be used to create an user for the child organization, it should exists on the parent organization."}},"description":"The object that contains the information related to the parent_organization.","title":"OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataParentOrganization"},"OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"child_organization":{"$ref":"#/components/schemas/OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataChildOrganization","description":"The object that contains all the information related to the child organization that will be created."},"parent_organization":{"$ref":"#/components/schemas/OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataParentOrganization","description":"The object that contains the information related to the parent_organization."}},"required":["child_organization","parent_organization"],"description":"The request payload.","title":"OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaData"},"OrganizationsChildrenPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the created child organization."},"token":{"type":"string","description":"The API token generated for the created child organization"},"created_at":{"type":"string","format":"date-time","description":"When the created child organization was created (ISO 8601 format)"},"updated_at":{"type":"string","format":"date-time","description":"When the created child organization was updated for the last time (ISO 8601 format)"}},"required":["id","token","created_at","updated_at"],"title":"OrganizationsChildrenPostResponsesContentApplicationJsonSchemaData"},"organizations_createOrganizationChild_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OrganizationsChildrenPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"organizations_createOrganizationChild_Response_201"},"OrganizationsChildrenPostResponsesContentApplicationJsonSchemaErrorsItems":{"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":"OrganizationsChildrenPostResponsesContentApplicationJsonSchemaErrorsItems"},"OrganizationsChildrenPostResponsesContentApplicationJsonSchemaRequest":{"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":"OrganizationsChildrenPostResponsesContentApplicationJsonSchemaRequest"},"CreateChildOrganizationRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationsChildrenPostResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/OrganizationsChildrenPostResponsesContentApplicationJsonSchemaRequest"}},"title":"CreateChildOrganizationRequestBadRequestError"},"OrganizationsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the organization."},"name":{"type":"string","description":"The name of the organization."}},"required":["id","name"],"title":"OrganizationsGetResponsesContentApplicationJsonSchemaDataItems"},"organizations_getOrganizations_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationsGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"organizations_getOrganizations_Response_200"},"GetOrganizationsRequestUnauthorizedError":{"type":"object","properties":{"error":{"type":"string","description":"An error message indicating that the authentication failed."}},"title":"GetOrganizationsRequestUnauthorizedError"},"GetOrganizationsRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string","description":"An error message indicating that no organization was found for the authenticated user."}},"title":"GetOrganizationsRequestNotFoundError"},"GetOrganizationsRequestInternalServerError":{"type":"object","properties":{"error":{"type":"string","description":"A general error message indicating that the server encountered an unexpected issue."}},"title":"GetOrganizationsRequestInternalServerError"},"ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaDocumentType":{"type":"string","enum":["PASSPORT","DRIVING_LICENSE","GOVERNMENT_ID","OTHER"],"description":"The type of document to be verified","title":"ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaDocumentType"},"ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaOperationType":{"type":"string","enum":["IDENTITY_RESUBMISSION_KYC","IDENTITY_VERIFICATION_KYC","NAME_CHANGE_KYC"],"description":"The type of KYC operation to perform","title":"ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaOperationType"},"ScreeningsManualVerificationPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"Timestamp when screening was successfully received and processed (ISO 8601)"},"request_id":{"type":"string","description":"Unique request identifier"}},"required":["created_at","request_id"],"title":"ScreeningsManualVerificationPostResponsesContentApplicationJsonSchemaData"},"screenings_createManualVerification_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScreeningsManualVerificationPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"screenings_createManualVerification_Response_201"},"CreateManualVerificationScreeningRequestBadRequestError":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string","description":"Human-readable error message"}},"required":["code","message"],"title":"CreateManualVerificationScreeningRequestBadRequestError"},"CreateManualVerificationScreeningRequestConflictError":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"title":"CreateManualVerificationScreeningRequestConflictError"},"VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataUserInput":{"type":"object","properties":{"last_name":{"type":"string","description":"The desired last name of the user"},"first_name":{"type":"string","description":"The desired first name of the user"},"middle_name":{"type":["string","null"],"description":"The desired middle name of the user"}},"required":["last_name","first_name"],"description":"Input data for the name change KYC operation","title":"VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataUserInput"},"VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataOperationType":{"type":"string","enum":["IDENTITY_RESUBMISSION_KYC","IDENTITY_VERIFICATION_KYC","NAME_CHANGE_KYC","EMAIL_CHANGE_KYC"],"description":"The type of KYC operation to perform","title":"VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataOperationType"},"VeriffSessionPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"user_input":{"$ref":"#/components/schemas/VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataUserInput","description":"Input data for the name change KYC operation"},"operation_type":{"$ref":"#/components/schemas/VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataOperationType","description":"The type of KYC operation to perform"}},"required":["operation_type"],"title":"VeriffSessionPostRequestBodyContentApplicationJsonSchemaData"},"VeriffSessionPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"url":{"type":"string","description":"The URL of the Veriff session"}},"required":["url"],"title":"VeriffSessionPostResponsesContentApplicationJsonSchemaData"},"screenings_createVeriffSession_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/VeriffSessionPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"screenings_createVeriffSession_Response_201"},"ScreeningsAmlEntityTypeEntityIdGetParametersEntityType":{"type":"string","enum":["profile","hris_profile","legal_entity"],"title":"ScreeningsAmlEntityTypeEntityIdGetParametersEntityType"},"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaResult":{"type":"string","enum":["ACCEPT","REJECT","REFERRED","PENDING"],"description":"The result of the screening. ACCEPT means the screening passed, REJECT means it failed, and REFERRED means it is pending further review.","title":"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaResult"},"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaEntityType":{"type":"string","enum":["profile","hris_profile","legal_entity"],"description":"The type of entity being screened.","title":"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaEntityType"},"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsPep":{"type":"string","enum":["PASS","FAIL"],"description":"The result of the PEP (Politically Exposed Person) check.","title":"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsPep"},"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsSanctions":{"type":"string","enum":["PASS","FAIL"],"description":"The result of the sanctions check.","title":"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsSanctions"},"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsAdverseMedia":{"type":"string","enum":["PASS","FAIL"],"description":"The result of the adverse media check.","title":"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsAdverseMedia"},"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResults":{"type":"object","properties":{"pep":{"$ref":"#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsPep","description":"The result of the PEP (Politically Exposed Person) check."},"sanctions":{"$ref":"#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsSanctions","description":"The result of the sanctions check."},"adverse_media":{"$ref":"#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsAdverseMedia","description":"The result of the adverse media check."}},"description":"Details of checks performed for this screening.","title":"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResults"},"screenings_getAMLDetails_Response_200":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaResult","description":"The result of the screening. ACCEPT means the screening passed, REJECT means it failed, and REFERRED means it is pending further review."},"entity_id":{"type":"string","description":"UUID of the entity."},"entity_type":{"$ref":"#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaEntityType","description":"The type of entity being screened."},"detailed_results":{"$ref":"#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResults","description":"Details of checks performed for this screening."}},"required":["result","entity_id","entity_type","detailed_results"],"title":"screenings_getAMLDetails_Response_200"},"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"A description of the returned error"}},"title":"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"AmlApiForWhitelabelDataRetrieval-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"AmlApiForWhitelabelDataRetrieval-v2026-01-01RequestBadRequestError"},"AmlApiForWhitelabelDataRetrieval-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"AmlApiForWhitelabelDataRetrieval-v2026-01-01RequestNotFoundError"},"ScreeningsVerificationMethodGetParametersDocumentType":{"type":"string","enum":["passport","government_id","driving_license","other"],"title":"ScreeningsVerificationMethodGetParametersDocumentType"},"ScreeningsVerificationMethodGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"verification_method":{"type":"string","description":"The supported method for KYC"}},"required":["verification_method"],"title":"ScreeningsVerificationMethodGetResponsesContentApplicationJsonSchemaData"},"screenings_getVerificationMethod_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScreeningsVerificationMethodGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"screenings_getVerificationMethod_Response_200"},"ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataKycStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING_REVIEW","EXPIRED","EXPIRING_SOON","NOT_SUBMITTED","NOT_REQUESTED"],"description":"The current KYC verification status of the profile","title":"ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataKycStatus"},"ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataIdentityDocumentType":{"type":"string","enum":["DRIVING_LICENSE","PASSPORT","GOVERNMENT_ID","SELFIE_WITH_ID","PROOF_OF_RESIDENCY","OTHER"],"description":"The type of identity document used for verification","title":"ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataIdentityDocumentType"},"ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the KYC screening was created"},"kyc_status":{"$ref":"#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataKycStatus","description":"The current KYC verification status of the profile"},"updated_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the KYC screening was last updated"},"approval_date":{"type":["string","null"],"format":"date-time","description":"The date and time when the KYC screening was approved (null if not approved)"},"rejection_date":{"type":["string","null"],"format":"date-time","description":"The date and time when the KYC screening was rejected (null if not rejected or pending review for Veriff)"},"expiration_date":{"type":["string","null"],"format":"date-time","description":"The date and time when the KYC screening expires (null if no expiry)"},"submission_date":{"type":["string","null"],"format":"date-time","description":"The date and time when the KYC screening was submitted"},"identity_document_name":{"type":["string","null"],"description":"The name of the identity document used for verification (in case of other document type)"},"identity_document_type":{"oneOf":[{"$ref":"#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataIdentityDocumentType"},{"type":"null"}],"description":"The type of identity document used for verification"},"identity_document_number":{"type":["string","null"],"description":"Number of the submitted document"},"document_extracted_last_name":{"type":["string","null"],"description":"The last name extracted from the submitted document"},"document_extracted_first_name":{"type":["string","null"],"description":"The first name extracted from the submitted document"},"document_extracted_middle_name":{"type":["string","null"],"description":"The middle name extracted from the submitted document"}},"required":["created_at","kyc_status","updated_at","approval_date","rejection_date","expiration_date","submission_date","identity_document_type","document_extracted_middle_name"],"title":"ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaData"},"screenings_getKYCDetails_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"screenings_getKYCDetails_Response_200"},"ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetWorkersKycDetailsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetWorkersKycDetailsRequestBadRequestError"},"GetWorkersKycDetailsRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetWorkersKycDetailsRequestForbiddenError"},"GetWorkersKycDetailsRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetWorkersKycDetailsRequestNotFoundError"},"GetWorkersKycDetailsRequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetWorkersKycDetailsRequestConflictError"},"CreateWebhookRequestStatus":{"type":"string","enum":["enabled","disabled"],"description":"Status of webhook.","title":"CreateWebhookRequestStatus"},"CreateWebhookRequest":{"type":"object","properties":{"name":{"type":["string","null"],"description":"Webhook subscription name."},"description":{"type":["string","null"],"description":"Webhook subscription description."},"status":{"$ref":"#/components/schemas/CreateWebhookRequestStatus","description":"Status of webhook."},"url":{"type":"string","description":"Endpoint to receive webhook."},"signing_key":{"type":["string","null"],"description":"The webhook's signing key, used to generate webhook signatures."},"api_version":{"type":"string","default":"v2","description":"Deel API version. Currently Deel accepts v1 or v2 version."},"events":{"type":"array","items":{"type":"string"},"description":"The list of events to enable for this subscription."}},"required":["name","description","status","url","signing_key","api_version","events"],"title":"CreateWebhookRequest"},"WebhookItemStatus":{"type":"string","enum":["enabled","disabled"],"description":"Status of webhook.","title":"WebhookItemStatus"},"WebhookItem":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this resource."},"name":{"type":["string","null"],"description":"Webhook subscription name."},"description":{"type":["string","null"],"description":"Webhook subscription description."},"status":{"$ref":"#/components/schemas/WebhookItemStatus","description":"Status of webhook."},"url":{"type":"string","description":"Endpoint to receive webhook."},"signing_key":{"type":["string","null"],"description":"The webhook's signing key, used to generate webhook signatures."},"api_version":{"type":"string","default":"v2","description":"Deel API version. Currently Deel accepts v1 or v2 version."},"events":{"type":"array","items":{"type":"string"},"description":"The list of events to enable for this subscription."},"created_at":{"type":"string","description":"Time at which the webhook was created."},"updated_at":{"type":"string","description":"Time at which the webhook was updated."},"hidden":{"type":["boolean","null"],"description":"Property to hide the webhook from frontend view. Commonly by Dell 3rd party apps"},"internal":{"type":"boolean"},"deleted_at":{"type":"string","description":"Time at which the webhook was deleted."}},"required":["id","name","description","status","url","signing_key","api_version","events","created_at","updated_at"],"title":"WebhookItem"},"WebhookItemResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WebhookItem"}},"required":["data"],"title":"WebhookItemResponse"},"GenericResultDeletedData":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Confirms the deletion."}},"required":["deleted"],"title":"GenericResultDeletedData"},"GenericResultDeleted":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GenericResultDeletedData"}},"required":["data"],"title":"GenericResultDeleted"},"PatchWebhookRequestStatus":{"type":"string","enum":["enabled","disabled"],"description":"Status of webhook.","title":"PatchWebhookRequestStatus"},"PatchWebhookRequest":{"type":"object","properties":{"name":{"type":["string","null"],"description":"Webhook subscription name."},"description":{"type":["string","null"],"description":"Webhook subscription description."},"status":{"$ref":"#/components/schemas/PatchWebhookRequestStatus","description":"Status of webhook."},"url":{"type":"string","description":"Endpoint to receive webhook."},"signing_key":{"type":["string","null"],"description":"The webhook's signing key, used to generate webhook signatures."},"api_version":{"type":"string","default":"v2","description":"Deel API version. Currently Deel accepts v1 or v2 version."},"events":{"type":"array","items":{"type":"string"},"description":"The list of events to enable for this subscription."}},"required":["name","description","status","url","signing_key","events"],"title":"PatchWebhookRequest"},"WebhookEventTypeResponse":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"Event type unique identifier."},"module_name":{"type":"string","description":"Name of the rabbit queue."},"module_label":{"type":"string","description":"Display name of the rabbit queue in Deel UI."},"name":{"type":"string","description":"Name of the webhook event."},"description":{"type":"string","description":"Describes the webhook event and other pertinent info."},"payload_example":{"type":["string","null"],"description":"JSON payload example of the specific event."},"created_at":{"type":"string","description":"Time at which the event type was created."},"updated_at":{"type":"string","description":"Time at which the event type was updated."}},"required":["id","module_name","module_label","name","description"],"title":"WebhookEventTypeResponse"},"WebhookEventTypeListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookEventTypeResponse"}}},"title":"WebhookEventTypeListResponse"},"WebhookListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookItem"}}},"required":["data"],"title":"WebhookListResponse"}},"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/"}}}}