> ## Documentation Index > Fetch the complete documentation index at: https://developer.remote.com/llms.txt > Use this file to discover all available pages before exploring further. # Show employment Shows all the information of an employment. This endpoint requires and returns country-specific data. The exact required and returned fields will vary depending on which country the employment is in. To see the list of parameters for each country, see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. Please note that the compliance requirements for each country are subject to change according to local laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid compliance issues and to have the latest version of a country requirements. If you are using this endpoint to build an integration, make sure you are dynamically collecting or displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. For more information on JSON Schemas, see the **How JSON Schemas work** documentation. To learn how you can dynamically generate forms to display in your UI, see the documentation for the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. ## Scopes | Category | Read only Scope | Write only Scope (read access implicit) | |---|---|---| | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | # OpenAPI definition ```json { "components": { "schemas": { "Employment": { "description": "Complete information of an employment, including all onboarding task statuses, country-specific form data (address, contract, administrative, etc.), and contractor-specific settings where applicable.", "example": { "address_details": {}, "administrative_details": {}, "bank_account_details": [], "basic_information": {}, "billing_address_details": {}, "company_id": "e31adae1-company-id-af5fba7dd803", "contract_details": {}, "country": { "alpha_2_code": "PT", "code": "PRT", "contractor_products_available": [ "standard", "plus", "cor" ], "country_subdivisions": [ { "code": "PT-06", "name": "Coimbra", "subdivision_type": "District" }, { "code": "PT-11", "name": "Lisboa", "subdivision_type": "District" } ], "employment_agreement_preview_available": true, "eor_onboarding": true, "locked_benefits": "after_first_hire", "name": "Portugal", "region": "Europe", "subregion": "Southern Europe", "supported_json_schemas": [ "additional_documents", "address_details", "administrative_details", "employment-basic-information", "bank_account_details", "contract_details", "emergency_contact" ] }, "created_at": "2021-11-11T18:44:39", "eligible_for_onboarding_cancellation": true, "emergency_contact_details": {}, "employment_lifecycle_stage": "employee_self_enrollment", "employment_model": "eor", "files": [], "full_name": "Jane Smith", "id": "20a72f86-employment-id-9e4942a902ff", "job_title": "Engineer", "login_email": "jane@smith.com", "manager": "John Doe", "manager_email": "john.doe@company.com", "manager_employment_id": "20a72f86-employment-id-9e4942a902ff", "onboarding_tasks": { "address_details": { "description": "Primary residence.", "status": "completed" }, "administrative_details": { "description": "Information we need for tax purposes.", "status": "completed" }, "bank_account_details": { "description": "Bank account used for receiving salary payments.", "status": "completed" }, "billing_address_details": { "description": "Address associated with the employee's bank account.", "status": "completed" }, "contract_details": { "description": "Employee-specific details for their employment agreement.", "status": "completed" }, "emergency_contact_details": { "description": "Who should be called in an emergency.", "status": "completed" }, "employment_document_details": { "description": "We need some additional documents.", "status": "pending" }, "personal_details": { "description": "Personal details, such as name and date of birth.", "status": "completed" }, "pricing_plan_details": { "description": "How often Remote will bill employers for management fees.", "status": "completed" } }, "personal_details": {}, "personal_email": "jane@smith.com", "pricing_plan_details": { "frequency": "annually" }, "provisional_start_date": "2021-07-03", "status": "created", "type": "employee", "updated_at": "2021-07-15T18:18:17Z", "user_status": "active", "work_address_details": {}, "work_email": "jane.smith@company.com" }, "properties": { "personal_details": { "description": "Personal details information. Its properties may vary depending on the country.", "type": "object" }, "short_id": { "$ref": "#/components/schemas/ShortId" }, "department": { "description": "Name of related department, if any. Otherwise, null.", "nullable": true, "type": "string" }, "manager_email": { "description": "The email address of the employee's manager. Null if no manager is assigned.", "nullable": true, "type": "string" }, "provisional_start_date": { "$ref": "#/components/schemas/ProvisionalStartDate" }, "address_details": { "description": "Home address information. Its properties may vary depending on the country.", "type": "object" }, "pricing_plan_details": { "$ref": "#/components/schemas/PricingPlanDetails" }, "full_name": { "description": "The employee's full name.", "type": "string" }, "type": { "description": "For the employment types `contractor`, `global_payroll_employee` and `direct_employee`, only [List employments](#operation/get_index_employment) and\n[Show employment](#operation/get_show_employment) operations are available.\n", "enum": [ "employee", "contractor", "direct_employee", "global_payroll_employee" ], "type": "string" }, "contractor_settings": { "description": "Contractor-specific settings. Only present for contractor employments.", "nullable": true, "properties": { "requires_work_confirmation": { "description": "Whether the contractor requires work confirmation before submitting invoices.", "type": "boolean" } }, "type": "object" }, "employment_lifecycle_stage": { "$ref": "#/components/schemas/EmploymentLifecycleStage" }, "administrative_details": { "description": "Administrative information. Its properties may vary depending on the country.", "type": "object" }, "contractor_type": { "description": "Type of contractor product. Only present for contractor employments. 'standard' for Contractor Standard, 'cor' for Contractor of Record, 'plus' for Contractor Plus.", "enum": [ "standard", "cor", "plus" ], "nullable": true, "type": "string" }, "contractor_rate": { "description": "Contractor compensation rate details. Only present for contractor employments when rate is configured.", "nullable": true, "properties": { "amount": { "properties": { "amount": { "description": "Rate amount as decimal", "type": "number" }, "currency": { "properties": { "code": { "description": "Currency code (e.g., USD, EUR)", "type": "string" } }, "type": "object" } }, "type": "object" }, "pay_frequency": { "description": "Payment frequency cadence", "enum": [ "weekly", "bi_weekly", "semi_monthly", "monthly" ], "nullable": true, "type": "string" }, "slug": { "description": "Unique identifier for the contractor rate", "type": "string" }, "type": { "description": "Rate type indicating billing frequency", "enum": [ "hourly", "daily", "weekly", "monthly", "one_off" ], "type": "string" } }, "type": "object" }, "company_id": { "description": "The unique identifier (UUID) of the company this employment belongs to.", "type": "string" }, "work_address_details": { "description": "Work address information. Its properties may vary depending on the country.", "type": "object" }, "work_email": { "description": "The employee's work email address, typically provided by the employer.", "type": "string" }, "status": { "$ref": "#/components/schemas/EmploymentStatus" }, "updated_at": { "description": "The timestamp when this employment record was last updated.", "format": "date-time", "type": "string" }, "basic_information": { "description": "Employment basic information. Its properties may vary depending on the country.\n", "type": "object" }, "job_title": { "description": "The employee's job title. May be null if not yet set.", "nullable": true, "type": "string" }, "id": { "description": "The unique identifier (UUID) of the employment.", "type": "string" }, "probation_period_end_date": { "description": "The date when the employee's probation period ends, if applicable.", "format": "date", "type": "string" }, "department_id": { "description": "Unique ID of related department, if any. Otherwise, null.", "example": "663e0b79-c893-45ff-a1b2-f6dcabc098b5", "format": "uuid", "nullable": true, "title": "DepartmentID", "type": "string" }, "manager": { "description": "The full name of the employee's manager.", "type": "string" }, "login_email": { "description": "The email address the employee uses to log in to the Remote platform.", "type": "string" }, "external_id": { "description": "A unique reference code for the employment record in a non-Remote system. While uniqueness is recommended, it is not strictly enforced within Remote's system.", "type": "string" }, "employment_model": { "description": "For the employment models `peo` and `global_payroll`, only [List employments](#operation/get_index_employment) and\n[Show employment](#operation/get_show_employment) operations are available.\n", "enum": [ "global_payroll", "peo", "eor" ], "nullable": true, "type": "string" }, "personal_email": { "description": "The employee's personal email address, used for account-related communications.", "type": "string" }, "country": { "$ref": "#/components/schemas/NullableCountry" }, "user_status": { "$ref": "#/components/schemas/UserStatus" }, "seniority_date": { "$ref": "#/components/schemas/EmploymentSeniorityDate" }, "bank_account_details": { "items": { "description": "List of bank account information. Its properties may vary depending on the country.", "type": "object" }, "type": "array" }, "files": { "description": "Documents associated with this employment (e.g., contracts, tax forms, identity documents).", "items": { "$ref": "#/components/schemas/File" }, "type": "array" }, "active_contract_id": { "description": "The unique identifier (UUID) of the currently active contract for this employment.", "type": "string" }, "billing_address_details": { "description": "Billing address information. Its properties may vary depending on the country.", "type": "object" }, "onboarding_tasks": { "$ref": "#/components/schemas/OnboardingTasks" }, "contract_details": { "description": "Contract information. Its properties may vary depending on the country.", "type": "object" }, "emergency_contact_details": { "description": "Emergency contact information. Its properties may vary depending on the country.", "type": "object" }, "eligible_for_onboarding_cancellation": { "description": "Whether this employment can still be cancelled during the onboarding process. Once the employment is active, this will be false.", "type": "boolean" }, "manager_employment_id": { "description": "The employment ID of the employee's manager on Remote, if the manager is also managed through Remote. Null otherwise.", "nullable": true, "type": "string" }, "created_at": { "description": "The timestamp when this employment record was created.", "type": "string" } }, "required": [ "address_details", "administrative_details", "bank_account_details", "billing_address_details", "company_id", "contract_details", "country", "created_at", "emergency_contact_details", "files", "full_name", "id", "type", "employment_model", "work_address_details", "job_title", "manager_email", "manager_employment_id", "onboarding_tasks", "personal_details", "personal_email", "login_email", "pricing_plan_details", "status", "employment_lifecycle_stage", "updated_at", "work_email", "eligible_for_onboarding_cancellation" ], "title": "Employment", "type": "object" }, "ActionError": { "properties": { "action": { "description": "The action that lead to the error message.", "type": "string" }, "code": { "description": "An error code that describes the nature of the error.", "type": "string" }, "message": { "description": "A developer friendly error message that gives details on what the error was and how it may be remedied.", "type": "string" } }, "required": [ "code", "message", "action" ], "title": "ActionError", "type": "object" }, "EmploymentShowResponse": { "description": "Response containing the full employment record, including the termination date if the employment has an active offboarding.", "example": { "data": { "employment": { "address_details": {}, "administrative_details": {}, "bank_account_details": [], "basic_information": {}, "billing_address_details": {}, "company_id": "e31adae1-company-id-af5fba7dd803", "contract_details": {}, "country": { "alpha_2_code": "PT", "code": "PRT", "contractor_products_available": [ "standard", "plus", "cor" ], "country_subdivisions": [ { "code": "PT-06", "name": "Coimbra", "subdivision_type": "District" }, { "code": "PT-11", "name": "Lisboa", "subdivision_type": "District" } ], "employment_agreement_preview_available": true, "eor_onboarding": true, "locked_benefits": "after_first_hire", "name": "Portugal", "region": "Europe", "subregion": "Southern Europe", "supported_json_schemas": [ "additional_documents", "address_details", "administrative_details", "employment-basic-information", "bank_account_details", "contract_details", "emergency_contact" ] }, "created_at": "2021-11-11T18:44:39", "eligible_for_onboarding_cancellation": true, "emergency_contact_details": {}, "employment_lifecycle_stage": "employee_self_enrollment", "employment_model": "eor", "files": [], "full_name": "Jane Smith", "id": "20a72f86-employment-id-9e4942a902ff", "job_title": "Engineer", "login_email": "jane@smith.com", "manager": "John Doe", "manager_email": "john.doe@company.com", "manager_employment_id": "20a72f86-employment-id-9e4942a902ff", "onboarding_tasks": { "address_details": { "description": "Primary residence.", "status": "completed" }, "administrative_details": { "description": "Information we need for tax purposes.", "status": "completed" }, "bank_account_details": { "description": "Bank account used for receiving salary payments.", "status": "completed" }, "billing_address_details": { "description": "Address associated with the employee's bank account.", "status": "completed" }, "contract_details": { "description": "Employee-specific details for their employment agreement.", "status": "completed" }, "emergency_contact_details": { "description": "Who should be called in an emergency.", "status": "completed" }, "employment_document_details": { "description": "We need some additional documents.", "status": "pending" }, "personal_details": { "description": "Personal details, such as name and date of birth.", "status": "completed" }, "pricing_plan_details": { "description": "How often Remote will bill employers for management fees.", "status": "completed" } }, "personal_details": {}, "personal_email": "jane@smith.com", "pricing_plan_details": { "frequency": "annually" }, "provisional_start_date": "2021-07-03", "status": "created", "type": "employee", "updated_at": "2021-07-15T18:18:17Z", "user_status": "active", "work_address_details": {}, "work_email": "jane.smith@company.com" } } }, "properties": { "data": { "properties": { "employment": { "allOf": [ { "$ref": "#/components/schemas/Employment" }, { "properties": { "termination_date": { "description": "Most updated termination date for the offboarding. This date is subject to change through the offboarding process even after it is finalized.", "format": "date", "nullable": true, "type": "string" } } } ] } } } }, "required": [ "data" ], "title": "EmploymentShowResponse", "type": "object" }, "UserStatus": { "description": "The status of the user account associated with this employment.\n\n- `active`: The user account is active and the user can log in.\n- `created`: The user account has been created but not yet activated.\n- `initiated`: The user has been invited but has not completed registration.\n- `cancelled`: The user account was cancelled before activation.\n- `inactive`: The user account has been deactivated (e.g., after offboarding).\n- `deleted`: The user account has been deleted.\n", "enum": [ "active", "created", "initiated", "cancelled", "inactive", "deleted" ], "example": "active", "title": "UserStatus", "type": "string" }, "File": { "additionalProperties": false, "description": "A file associated with an employment, such as a contract, tax form, or identity document.", "example": { "id": "9880b711-file-id-ecf8f551bd78", "inserted_at": "2021-07-15T18:18:17Z", "name": "id.pdf", "sub_type": "personal_id", "type": "id" }, "properties": { "id": { "description": "The unique identifier (UUID) of the file.", "type": "string" }, "inserted_at": { "$ref": "#/components/schemas/DateTimeIso8601" }, "name": { "description": "The file name including extension (e.g., \"id.pdf\", \"contract.pdf\").", "type": "string" }, "sub_type": { "description": "A more specific classification of the file within its type (e.g., \"personal_id\" within type \"id\", or \"ir_35\" within type \"contract\"). Null if no sub-type applies.", "nullable": true, "type": "string" }, "type": { "description": "The broad category of the file (e.g., \"id\", \"contract\", \"tax_form\").", "type": "string" } }, "required": [ "id", "inserted_at", "name", "type" ], "title": "File", "type": "object" }, "ShortId": { "description": "Unique short identifier for the employment, automatically generated and visible in select areas of the Remote platform. Not intended as a replacement for the employment `id` field.", "example": "WN1IZT", "title": "ShortId", "type": "string" }, "UnprocessableEntityResponse": { "anyOf": [ { "properties": { "errors": { "type": "object" } }, "required": [ "errors" ], "type": "object" }, { "properties": { "message": { "oneOf": [ { "type": "string" }, { "$ref": "#/components/schemas/ParameterError" }, { "items": { "$ref": "#/components/schemas/ParameterError" }, "title": "ParameterErrors", "type": "array" }, { "$ref": "#/components/schemas/ActionError" }, { "items": { "$ref": "#/components/schemas/ActionError" }, "title": "ActionErrors", "type": "array" } ] } }, "required": [ "message" ], "type": "object" } ], "example": { "errors": { "some_field": [ "is invalid" ] } }, "title": "UnprocessableEntityResponse", "type": "object" }, "EmploymentSeniorityDate": { "description": "The date the employee first started working for your company. If you don’t include a seniority date,\nthe employee’s start date with Remote will be deemed as the start of the employee’s seniority.\n\n**Example**: Your employee started working for your company on Feb 1, 2022.\nOn Aug 1, 2022, you transferred the employee to Remote and started managing them on the platform.\nFeb 1, 2022 would be their seniority date. Aug 1, 2022 would be their starting date.\n", "example": "2022-03-21", "format": "date", "title": "EmploymentSeniorityDate", "type": "string" }, "ProvisionalStartDate": { "description": "Indicates the expected start date of the employee or contractor.\n\nRequired for employees, but optional for contractors. Date format is in ISO8601 without the time component.\n\nSee the **Date and Time Format** documentation for more details on how the Remote API works with dates.\n", "example": "2022-03-21", "format": "date", "title": "ProvisionalStartDate", "type": "string" }, "TaskDescription": { "description": "Description and status of an onboarding task.", "example": { "description": "Information we need for tax purposes.", "status": "completed" }, "properties": { "description": { "description": "A human-readable description of what this onboarding task requires.", "type": "string" }, "status": { "description": "The status of the task", "enum": [ "completed", "pending" ], "example": "completed", "title": "TaskStatus", "type": "string" } }, "title": "TaskDescription", "type": "object" }, "CountrySubdivision": { "description": "A subdivision of a supported country on Remote", "example": { "code": "PT-11", "name": "Lisboa", "subdivision_type": "District" }, "properties": { "code": { "description": "The ISO 3166-2 subdivision code (e.g., \"PT-11\" for Lisboa).", "type": "string" }, "name": { "description": "The subdivision's name (e.g., \"Lisboa\", \"California\").", "type": "string" }, "subdivision_type": { "description": "The type of subdivision (e.g., \"District\", \"State\", \"Province\").", "type": "string" } }, "required": [ "name" ], "title": "CountrySubdivision", "type": "object" }, "EmploymentLifecycleStage": { "description": "The stage of employment lifecycle. When it's `onboarded` means the employee is ready to commence or has already commenced.", "enum": [ "employment_creation", "employee_self_enrollment", "right_to_work_check", "contract_signing", "remote_enrollment", "onboarded", "offboarded" ], "example": "employee_self_enrollment", "title": "EmploymentLifecycleStage", "type": "string" }, "NullableCountry": { "description": "A supported country on Remote", "example": { "alpha_2_code": "PT", "code": "PRT", "contractor_products_available": [ "standard", "plus", "cor" ], "country_subdivisions": [ { "code": "PT-06", "name": "Coimbra", "subdivision_type": "District" }, { "code": "PT-11", "name": "Lisboa", "subdivision_type": "District" } ], "employment_agreement_preview_available": true, "eor_onboarding": true, "locked_benefits": "after_first_hire", "name": "Portugal", "region": "Europe", "subregion": "Southern Europe", "supported_json_schemas": [ "additional_documents", "address_details", "administrative_details", "employment-basic-information", "bank_account_details", "contract_details", "emergency_contact" ] }, "nullable": true, "properties": { "alpha_2_code": { "description": "The ISO 3166-1 alpha-2 country code (e.g., \"PT\").", "type": "string" }, "code": { "description": "The ISO 3166-1 alpha-3 country code (e.g., \"PRT\"). This is the primary code used across the Remote API.", "type": "string" }, "contractor_products_available": { "description": "Contractor product names available for this country", "items": { "enum": [ "standard", "plus", "cor" ], "type": "string" }, "type": "array" }, "country_subdivisions": { "description": "Administrative subdivisions of the country (e.g., states, provinces, districts). Null if the country has no subdivisions relevant to Remote's services.", "items": { "$ref": "#/components/schemas/CountrySubdivision" }, "nullable": true, "type": "array" }, "employment_agreement_preview_available": { "description": "Whether an Employment Agreement preview is available for this country.", "type": "boolean" }, "eor_onboarding": { "description": "Whether EOR (Employer of Record) onboarding is available in this country.", "type": "boolean" }, "locked_benefits": { "description": "When benefit plan selections become locked for this country (e.g., \"after_first_hire\" means benefits cannot be changed after the first employee is hired).", "type": "string" }, "name": { "description": "The country's full English name.", "type": "string" }, "region": { "description": "The geographic region the country belongs to (e.g., \"Europe\", \"Asia\", \"Americas\").", "type": "string" }, "subregion": { "description": "The geographic subregion (e.g., \"Southern Europe\", \"Southeast Asia\"). Null for some countries.", "nullable": true, "type": "string" }, "supported_json_schemas": { "description": "The list of JSON schema form names available for this country (e.g., \"address_details\", \"contract_details\"). Use these with the Show form schema endpoint to get country-specific field requirements.", "items": { "type": "string" }, "type": "array" } }, "required": [ "alpha_2_code", "code", "name" ], "title": "NullableCountry", "type": "object" }, "OnboardingTasks": { "description": "All tasks that need to be completed before marking the employment as ready", "example": { "address_details": { "description": "Primary residence.", "status": "completed" }, "administrative_details": { "description": "Information we need for tax purposes.", "status": "completed" }, "bank_account_details": { "description": "Bank account used for receiving salary payments.", "status": "completed" }, "billing_address_details": { "description": "Address associated with the employee's bank account.", "status": "completed" }, "contract_details": { "description": "Employee-specific details for their employment agreement.", "status": "completed" }, "emergency_contact_details": { "description": "Who should be called in an emergency.", "status": "completed" }, "employment_document_details": { "description": "We need some additional documents.", "status": "pending" }, "personal_details": { "description": "Personal details, such as name and date of birth.", "status": "completed" }, "pricing_plan_details": { "description": "How often Remote will bill employers for management fees.", "status": "completed" } }, "properties": { "address_details": { "$ref": "#/components/schemas/TaskDescription" }, "administrative_details": { "$ref": "#/components/schemas/TaskDescription" }, "bank_account_details": { "$ref": "#/components/schemas/TaskDescription" }, "billing_address_details": { "$ref": "#/components/schemas/TaskDescription" }, "contract_details": { "$ref": "#/components/schemas/TaskDescription" }, "emergency_contact_details": { "$ref": "#/components/schemas/TaskDescription" }, "employment_document_details": { "$ref": "#/components/schemas/TaskDescription" }, "personal_details": { "$ref": "#/components/schemas/TaskDescription" }, "pricing_plan_details": { "$ref": "#/components/schemas/TaskDescription" } }, "required": [ "address_details", "administrative_details", "bank_account_details", "billing_address_details", "contract_details", "emergency_contact_details", "employment_document_details", "personal_details", "pricing_plan_details" ], "title": "OnboardingTasks", "type": "object" }, "EmploymentStatus": { "description": "The current status of the employment record.\n\n- `active`: The employee is fully onboarded and actively working.\n- `created`: The employment has been created but onboarding has not started.\n- `pre_hire`: A pre-hire employment record, created before formal onboarding begins.\n- `created_awaiting_reserve`: The employment is created but waiting for a risk reserve deposit to be paid.\n- `created_reserve_paid`: The risk reserve has been paid and the employment can proceed with onboarding.\n- `initiated`: Onboarding has been started by the employer.\n- `invited`: The employee has been invited to complete their self-enrollment on Remote.\n- `pending`: The employment is pending review or further action before it can become active.\n- `review`: The employment is under review by Remote (e.g., contract or compliance review).\n- `archived`: The employment has been terminated or offboarded.\n- `deleted`: The employment record has been deleted.\n", "enum": [ "active", "created", "pre_hire", "created_awaiting_reserve", "created_reserve_paid", "initiated", "invited", "pending", "review", "job_title_review", "pending_post_self_enrollment_actions", "offboarding", "archived", "deleted" ], "example": "active", "title": "EmploymentStatus", "type": "string" }, "TooManyRequestsResponse": { "description": "Returned when the API rate limit has been exceeded (HTTP 429). Wait before retrying. Check the `Retry-After` response header for the recommended wait time.", "example": { "message": "Too many requests" }, "properties": { "message": { "pattern": "Too many requests", "type": "string" } }, "title": "TooManyRequestsResponse", "type": "object" }, "ConflictResponse": { "description": "Returned when the request conflicts with the current state of a resource (HTTP 409). For example, trying to create a resource that already exists or performing an action that requires the resource to be in a different state.", "example": { "message": "Company needs to be in status active to manage employments" }, "properties": { "message": { "description": "A human-readable message describing the conflict and the expected state.", "type": "string" } }, "title": "ConflictResponse", "type": "object" }, "BadRequestResponse": { "description": "Returned when the request is malformed or contains invalid parameters. The message may be a simple string or a structured object with a code and detailed message.", "example": { "message": "invalid {resource}" }, "oneOf": [ { "properties": { "message": { "description": "A human-readable error message describing what was wrong with the request.", "type": "string" } }, "required": [ "message" ], "type": "object" }, { "properties": { "message": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "type": "object" } ], "title": "BadRequestResponse", "type": "object" }, "PricingPlanDetails": { "description": "Selected type of payment.", "example": { "frequency": "annually" }, "properties": { "frequency": { "description": "How often Remote bills the employer for management fees. Annual billing typically offers a discount.", "enum": [ "annually", "monthly" ], "type": "string" } }, "required": [ "frequency" ], "title": "PricingPlanDetails", "type": "object" }, "DateTimeIso8601": { "description": "UTC date time in [ISO 8601][] format.\n\n[ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601\n", "example": "2021-07-15T18:18:17Z", "format": "date-time", "title": "DateTimeIso8601", "type": "string" }, "ParameterError": { "example": { "code": "invalid_param", "message": "Invalid parameter", "param": "employment_id" }, "properties": { "code": { "description": "An error code that describes the nature of the error.", "type": "string" }, "message": { "description": "A developer friendly error message that gives details on what the error was and how it may be remedied.", "type": "string" }, "param": { "description": "The parameter that lead to the error message.", "type": "string" } }, "required": [ "code", "message", "param" ], "title": "ParameterError", "type": "object" }, "ForbiddenResponse": { "description": "Returned when the authenticated user or token does not have permission to perform the requested action. Check that the token has the required OAuth2 scopes and that the user has the necessary role.", "example": { "message": "Forbidden" }, "properties": { "message": { "pattern": "Forbidden", "type": "string" } }, "required": [ "message" ], "title": "ForbiddenResponse", "type": "object" } }, "securitySchemes": { "CustomerAPIToken": { "description": "Authenticate using API Key generated by the customer in their Integration Settings page.\n", "scheme": "bearer", "type": "http" }, "OAuth2": { "description": "Authenticate using OAuth 2.0 protocol.\n", "flows": { "authorizationCode": { "authorizationUrl": "/auth/oauth2/authorize", "scopes": { "company_department:read": "company_department:read", "webhook:write": "webhook:write", "magic_link:write": "magic_link:write", "offboarding:write": "offboarding:write", "custom_field:write": "custom_field:write", "address:write": "address:write", "expense:read": "expense:read", "employment:write": "employment:write", "identity_verification:write": "identity_verification:write", "timesheet:write": "timesheet:write", "travel_letter:write": "travel_letter:write", "incentive:read": "incentive:read", "personal_detail:read": "personal_detail:read", "invoices:write": "invoices:write", "work_authorization:write": "work_authorization:write", "timeoff:write": "timeoff:write", "company_structure:read": "company_structure:read", "benefit_renewal:write": "benefit_renewal:write", "benefit_offer:read": "benefit_offer:read", "employment_documents": "employment_documents", "onboarding:write": "onboarding:write", "payroll_run:read": "payroll_run:read", "risk_reserve:write": "risk_reserve:write", "invoices": "invoices", "resignation_letter:read": "resignation_letter:read", "resignation:read": "resignation:read", "convert_currency:read": "convert_currency:read", "employments": "employments", "probation_document:read": "probation_document:read", "company_admin": "company_admin", "payroll": "payroll", "help_center_article:read": "help_center_article:read", "timesheet:read": "timesheet:read", "custom_field_value:write": "custom_field_value:write", "company_currencies:read": "company_currencies:read", "payslip:read": "payslip:read", "pay_item:write": "pay_item:write", "resignation:write": "resignation:write", "custom_field:read": "custom_field:read", "payroll_calendar:read": "payroll_calendar:read", "contract_amendment:write": "contract_amendment:write", "offboarding:read": "offboarding:read", "timeoff:read": "timeoff:read", "probation_document:write": "probation_document:write", "country:read": "country:read", "webhook:read": "webhook:read", "company_department:write": "company_department:write", "company_manager:read": "company_manager:read", "pay_item:read": "pay_item:read", "contract_amendment:read": "contract_amendment:read", "company:read": "company:read", "sso_configuration:write": "sso_configuration:write", "benefit_offer:write": "benefit_offer:write", "contract_eligibility:write": "contract_eligibility:write", "benefit_renewal:read": "benefit_renewal:read", "background_check:read": "background_check:read", "custom_field_value:read": "custom_field_value:read", "expense:write": "expense:write", "identity_verification:read": "identity_verification:read", "address:read": "address:read", "document:write": "document:write", "time_and_attendance": "time_and_attendance", "employment_payments": "employment_payments", "form:read": "form:read", "work_authorization:read": "work_authorization:read", "invoices:read": "invoices:read", "incentive:write": "incentive:write", "employment:read": "employment:read", "contract:read": "contract:read", "company_manager:write": "company_manager:write", "travel_letter:read": "travel_letter:read", "document:read": "document:read", "sso_configuration:read": "sso_configuration:read" }, "tokenUrl": "/auth/oauth2/token" }, "clientCredentials": { "scopes": { "company:read": "company:read", "company:write": "company:write", "company_admin": "company_admin", "company_management": "company_management", "convert_currency:read": "convert_currency:read", "country:read": "country:read", "employment_documents": "employment_documents", "employment_payments": "employment_payments", "employments": "employments", "help_center_article:read": "help_center_article:read", "invoices": "invoices", "payroll": "payroll", "payroll_calendar:read": "payroll_calendar:read", "pricing_plan:read": "pricing_plan:read", "pricing_plan:write": "pricing_plan:write", "time_and_attendance": "time_and_attendance", "webhook:read": "webhook:read", "webhook:write": "webhook:write" }, "tokenUrl": "/auth/oauth2/token" } }, "type": "oauth2" }, "OAuth2AuthorizationCode": { "description": "Authenticate as the token authorizer using `authorization_code` / `refresh_token` grants in the OAuth 2.0 protocol.\n", "flows": { "authorizationCode": { "authorizationUrl": "/auth/oauth2/authorize", "refreshUrl": "/auth/oauth2/token", "scopes": { "company_department:read": "company_department:read", "webhook:write": "webhook:write", "magic_link:write": "magic_link:write", "offboarding:write": "offboarding:write", "custom_field:write": "custom_field:write", "address:write": "address:write", "expense:read": "expense:read", "employment:write": "employment:write", "identity_verification:write": "identity_verification:write", "timesheet:write": "timesheet:write", "travel_letter:write": "travel_letter:write", "incentive:read": "incentive:read", "personal_detail:read": "personal_detail:read", "invoices:write": "invoices:write", "work_authorization:write": "work_authorization:write", "timeoff:write": "timeoff:write", "company_structure:read": "company_structure:read", "benefit_renewal:write": "benefit_renewal:write", "benefit_offer:read": "benefit_offer:read", "employment_documents": "employment_documents", "onboarding:write": "onboarding:write", "payroll_run:read": "payroll_run:read", "risk_reserve:write": "risk_reserve:write", "invoices": "invoices", "resignation_letter:read": "resignation_letter:read", "resignation:read": "resignation:read", "convert_currency:read": "convert_currency:read", "employments": "employments", "probation_document:read": "probation_document:read", "company_admin": "company_admin", "payroll": "payroll", "help_center_article:read": "help_center_article:read", "timesheet:read": "timesheet:read", "custom_field_value:write": "custom_field_value:write", "company_currencies:read": "company_currencies:read", "payslip:read": "payslip:read", "pay_item:write": "pay_item:write", "resignation:write": "resignation:write", "custom_field:read": "custom_field:read", "payroll_calendar:read": "payroll_calendar:read", "contract_amendment:write": "contract_amendment:write", "offboarding:read": "offboarding:read", "timeoff:read": "timeoff:read", "probation_document:write": "probation_document:write", "country:read": "country:read", "webhook:read": "webhook:read", "company_department:write": "company_department:write", "company_manager:read": "company_manager:read", "pay_item:read": "pay_item:read", "contract_amendment:read": "contract_amendment:read", "company:read": "company:read", "sso_configuration:write": "sso_configuration:write", "benefit_offer:write": "benefit_offer:write", "contract_eligibility:write": "contract_eligibility:write", "benefit_renewal:read": "benefit_renewal:read", "background_check:read": "background_check:read", "custom_field_value:read": "custom_field_value:read", "expense:write": "expense:write", "identity_verification:read": "identity_verification:read", "address:read": "address:read", "document:write": "document:write", "time_and_attendance": "time_and_attendance", "employment_payments": "employment_payments", "form:read": "form:read", "work_authorization:read": "work_authorization:read", "invoices:read": "invoices:read", "incentive:write": "incentive:write", "employment:read": "employment:read", "contract:read": "contract:read", "company_manager:write": "company_manager:write", "travel_letter:read": "travel_letter:read", "document:read": "document:read", "sso_configuration:read": "sso_configuration:read" }, "tokenUrl": "/auth/oauth2/token" } }, "type": "oauth2" } } }, "info": { "title": "Employments", "version": "1.0.0" }, "openapi": "3.1.0", "paths": { "/v1/employments/{employment_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "Shows all the information of an employment.\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Countries](#tag/Countries) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) |\n", "operationId": "get_v1_employments_employment_id", "parameters": [ { "description": "Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.\n\nThe refresh token needs to have been obtained through the Authorization Code flow.\n", "example": "Bearer ", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" } }, { "description": "Employment ID", "example": "93t3j-employment-id-9suej43", "in": "path", "name": "employment_id", "required": true, "schema": { "type": "string" } }, { "description": "Wether files should be excluded", "example": "true", "in": "query", "name": "exclude_files", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmploymentShowResponse" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } }, "description": "Forbidden" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } }, "description": "Unprocessable Entity" } }, "security": [ { "CustomerAPIToken": [ "https://gateway.remote.com/company.manage", "employment:read", "employment:write", "employments", "all:write", "all:read" ], "OAuth2AuthorizationCode": [ "https://gateway.remote.com/company.manage", "employment:read", "employment:write", "employments", "all:write", "all:read" ] } ], "summary": "Show employment", "tags": [ "Employment Management" ] } } }, "security": [ { "OAuth2": [] } ], "servers": [ { "url": "https://gateway.remote.com/", "variables": {} }, { "url": "https://gateway.remote-sandbox.com/", "variables": {} } ], "tags": [ { "name": "Employments" } ], "webhooks": { "background_check.status.updated": { "post": { "deprecated": false, "description": "This event is triggered when a background check request status is updated.", "operationId": "background_check.status.updated", "requestBody": { "content": { "application/json": { "schema": { "example": { "background_check_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "company_id": "ba310525-9282-40c9-8977-14d844bf891a", "employment_id": "e966a8b8-1076-11ee-a5f2-9b3997a968f6", "event_type": "background_check.status.updated" }, "properties": { "background_check_id": { "description": "The unique identifier of the background check.", "type": "string" }, "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "background_check_id", "company_id", "employment_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "background_check.status.updated", "tags": [ "Background Checks" ] } }, "employment.account.updated": { "post": { "deprecated": false, "description": "This event is triggered whenever an employment account email is updated.", "operationId": "employment.account.updated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.account.updated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.account.updated", "tags": [ "Employment Management" ] } }, "employment.administrative_details.updated": { "post": { "deprecated": false, "description": "This event is triggered when the administrative details of an employment are updated.", "operationId": "employment.administrative_details.updated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_slug": "f2a1b3c4-d5e6-7f8g-9h0i-j1k2l3m4n5o6", "event_type": "employment.administrative_details.updated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_slug": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_slug", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.administrative_details.updated", "tags": [ "Employment Management" ] } }, "employment.details.updated": { "post": { "deprecated": false, "description": "This event is triggered whenever an employment `department` or `manager` is updated.", "operationId": "employment.details.updated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.details.updated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.details.updated", "tags": [ "Employment Management" ] } }, "employment.employment_agreement.available": { "post": { "deprecated": false, "description": "This event is triggered when an employment agreement is available for a user", "operationId": "employment.employment_agreement.available", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.employment_agreement.available", "file_id": "0073fcb5-b669-4e4a-b963-2a47744e75a1" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" }, "file_id": { "description": "The unique identifier of the related file.", "type": "string" } }, "required": [ "file_id", "employment_id", "event_type", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.employment_agreement.available", "tags": [ "Employments" ] } }, "employment.eor_hiring.invoice_created": { "post": { "deprecated": false, "description": "This event is triggered when a invoice report is created for a employment.", "operationId": "employment.eor_hiring.invoice_created", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "f2a1b3c4-d5e6-7f8g-9h0i-j1k2l3m4n5o6", "employment_id": "f8e9d2c7-3a1b-4f5c-9e6d-8b7a2c1d0e3f", "event_type": "employment.eor_hiring.invoice_created", "invoice_report_id": "c7f8e9d2-3a1b-4f5c-9e6d-8b7a2c1d0e3f" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" }, "invoice_report_id": { "description": "The unique identifier of the invoice report.", "type": "string" } }, "required": [ "event_type", "employment_id", "invoice_report_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.eor_hiring.invoice_created", "tags": [ "Employments" ] } }, "employment.eor_hiring.proof_of_payment_accepted": { "post": { "deprecated": false, "description": "This event is triggered when a proof of payment is accepted.", "operationId": "employment.eor_hiring.proof_of_payment_accepted", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "f2a1b3c4-d5e6-7f8g-9h0i-j1k2l3m4n5o6", "employment_id": "f8e9d2c7-3a1b-4f5c-9e6d-8b7a2c1d0e3f", "event_type": "employment.eor_hiring.proof_of_payment_accepted", "proof_of_payment_id": "c7f8e9d2-3a1b-4f5c-9e6d-8b7a2c1d0e3f" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" }, "proof_of_payment_id": { "description": "The unique identifier of the proof of payment.", "type": "string" } }, "required": [ "event_type", "employment_id", "proof_of_payment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.eor_hiring.proof_of_payment_accepted", "tags": [ "Employments" ] } }, "employment.eor_hiring.proof_of_payment_submitted": { "post": { "deprecated": false, "description": "This event is triggered when a proof of payment is submitted (uploaded) for an EOR hiring onboarding.", "operationId": "employment.eor_hiring.proof_of_payment_submitted", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "f2a1b3c4-d5e6-7f8g-9h0i-j1k2l3m4n5o6", "employment_id": "f8e9d2c7-3a1b-4f5c-9e6d-8b7a2c1d0e3f", "event_type": "employment.eor_hiring.proof_of_payment_submitted", "proof_of_payment_id": "c7f8e9d2-3a1b-4f5c-9e6d-8b7a2c1d0e3f" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" }, "proof_of_payment_id": { "description": "The unique identifier of the proof of payment.", "type": "string" } }, "required": [ "event_type", "employment_id", "proof_of_payment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.eor_hiring.proof_of_payment_submitted", "tags": [ "Employments" ] } }, "employment.no_longer_eligible_for_onboarding_cancellation": { "post": { "deprecated": false, "description": "This event is triggered when an employment is no longer eligible for onboarding cancellation.", "operationId": "employment.no_longer_eligible_for_onboarding_cancellation", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_slug": "ba310525-9282-40c9-8977-14d844bf891a" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_slug": { "description": "The unique identifier of the related employment.", "type": "string" } }, "required": [ "employment_slug", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.no_longer_eligible_for_onboarding_cancellation", "tags": [ "Employments" ] } }, "employment.onboarding.cancelled": { "post": { "deprecated": false, "description": "This event is triggered when an employment onboarding is cancelled.", "operationId": "employment.onboarding.cancelled", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "f8e9d2c7-3a1b-4f5c-9e6d-8b7a2c1d0e3f", "event_type": "employment.onboarding.cancelled" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.onboarding.cancelled", "tags": [ "Employments" ] } }, "employment.onboarding.completed": { "post": { "deprecated": false, "description": "This event is triggered when an employment onboarding is completed and the\nemployment is set to `active`.\n\nAn onboarding is considered complete when the employee finishes their self-enrollment\nand has completed all the onboarding tasks assigned to them (Personal profile, Administrative details,\nEmergency contact, Supporting documentation, etc).\n", "operationId": "employment.onboarding.completed", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.onboarding.completed" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.onboarding.completed", "tags": [ "Employment Management" ] } }, "employment.onboarding.started": { "post": { "deprecated": false, "description": "This event is triggered when an employment onboarding is started.\n", "operationId": "employment.onboarding.started", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.onboarding.started" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.onboarding.started", "tags": [ "Employment Management" ] } }, "employment.onboarding_task.completed": { "post": { "deprecated": false, "description": "This event is triggered everytime an employment onboarding task\n(Personal profile, Administrative details, Emergency contact,\nSupporting documentation, etc) is completed by an employee during\nthe self-enrollment.\n", "operationId": "employment.onboarding_task.completed", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "97c7ce7e-ca67-11ed-bce5-3bb70cbb9f9e", "completed_task": { "action": "administrative_details", "completed_at": "2023-03-23T03:21:23Z", "description": "description for administrative details", "name": "Administrative details", "required": true, "status": "completed" }, "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.onboarding_task.completed" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "completed_task": { "properties": { "action": { "description": "The action identifier for this task.", "enum": [ "additional_documents", "administrative_details", "business_information", "emergency_contact", "home_address", "i9_verification", "identity_verification", "payment_details", "review_compensation", "safetywing_enrollment", "user_details", "employment_eligibility" ], "type": "string" }, "completed_at": { "description": "The timestamp when the task was completed.", "format": "datetime", "type": "string" }, "description": { "description": "A description of what this onboarding task covers.", "type": "string" }, "name": { "description": "The name of the completed onboarding task (e.g., \"Personal details\").", "type": "string" }, "required": { "description": "Whether this task was required for onboarding completion.", "type": "boolean" }, "status": { "description": "The status of the task.", "enum": [ "created", "completed" ], "type": "string" } }, "required": [ "name", "description", "required", "completed_at", "action", "status" ] }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "company_id", "employment_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.onboarding_task.completed", "tags": [ "Employment Management" ] } }, "employment.personal_information.updated": { "post": { "deprecated": false, "description": "This event is triggered whenever an employment personal details is updated. Personal details includes personal informations, home address and emergency contact.", "operationId": "employment.personal_information.updated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.personal_information.updated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.personal_information.updated", "tags": [ "Employment Management" ] } }, "employment.start_date.changed": { "post": { "deprecated": false, "description": "This event is triggered when the start date of an employment is changed", "operationId": "employment.start_date.changed", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.start_date.changed" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "employment_id", "event_type", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.start_date.changed", "tags": [ "Employment Management" ] } }, "employment.status.updated": { "post": { "deprecated": false, "description": "This event is triggered when the employment status is updated", "operationId": "employment.status.updated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.status.updated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "employment_id", "event_type", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.status.updated", "tags": [ "Employment Management" ] } }, "employment.updated": { "post": { "deprecated": false, "description": "This event is triggered when an employment is updated.\n", "operationId": "employment.updated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.updated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.updated", "tags": [ "Employment Management" ] } }, "employment.user_status.activated": { "post": { "deprecated": false, "description": "This event is triggered whenever an employment user is updated to the active status.", "operationId": "employment.user_status.activated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.user_status.activated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.user_status.activated", "tags": [ "Employment Management" ] } }, "employment.user_status.deactivated": { "post": { "deprecated": false, "description": "This event is triggered whenever an employment user is updated to the inactive status.", "operationId": "employment.user_status.deactivated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.user_status.deactivated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.user_status.deactivated", "tags": [ "Employment Management" ] } }, "employment.user_status.initiated": { "post": { "deprecated": false, "description": "This event is triggered whenever an employment user is updated to the initiated status.", "operationId": "employment.user_status.initiated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.user_status.initiated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.user_status.initiated", "tags": [ "Employment Management" ] } }, "employment.user_status.invited": { "post": { "deprecated": false, "description": "This event is triggered when an employment user status is updated to invited.", "operationId": "employment.user_status.invited", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.user_status.invited" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "employment_id", "event_type", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.user_status.invited", "tags": [ "Employment Management" ] } }, "employment.work_email.updated": { "post": { "deprecated": false, "description": "This event is triggered when an employment work email is updated.\n", "operationId": "employment.work_email.updated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment.work_email.updated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment.work_email.updated", "tags": [ "Employment Management" ] } }, "employment_basic_information.updated": { "post": { "deprecated": false, "description": "This event is triggered when the basic information for an employment is updated", "operationId": "employment_basic_information.updated", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "employment_basic_information.updated" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "employment_id", "event_type", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "employment_basic_information.updated", "tags": [ "Employments" ] } }, "identity_verification.verification_required": { "post": { "deprecated": false, "description": "This event is triggered whenever an identity verification is required for an employment.", "operationId": "identity_verification.verification_required", "requestBody": { "content": { "application/json": { "schema": { "example": { "company_id": "d2091b1e-b1a4-437a-91ea-2809ffbb6d59", "employment_id": "2614f814-b08e-4c8e-8c4d-ddbcc4692d99", "event_type": "identity_verification.verification_required" }, "properties": { "company_id": { "description": "The unique identifier of the related company.", "type": "string" }, "employment_id": { "description": "The unique identifier of the related employment.", "type": "string" }, "event_type": { "description": "The webhook event type identifier.", "type": "string" } }, "required": [ "event_type", "employment_id", "company_id" ] } } } }, "responses": { "2XX": { "description": "Any 200 response confirms that the webhook was delivered." } }, "security": [], "summary": "identity_verification.verification_required", "tags": [ "Identity Verification" ] } } } } ```