Offboarding
Work Authorization

Update work authorization request

Changed on

Updates a work authorization request.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)-Manage work authorizations (work_authorization:write)
patch/v1/work-authorization-requests/{id}

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/work-authorization-requests/{id}
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, work_authorization:write, employments, all:write)

Path parameters

idstring required

work authorization request ID

Request body

OR

Example request

{
  "employer_special_instructions": "some special instruction",
  "status": "approved_by_manager"
}

Response

Success

Example response

{
  "data": {
    "work_authorization_request": {
      "additional_information": "Some additional information",
      "destination_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,
        "global_payroll_supported": 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"
        ]
      },
      "employer_approver": {
        "email": "user0@company.com",
        "id": "93aaf0b3-1d79-4d2c-8d47-3d5406727d70",
        "name": "User Name"
      },
      "employer_special_instructions": "Some special instruction",
      "id": "d1bb9535-3296-4240-8a67-81475bd24e80",
      "reason": "Some reason",
      "status": "pending",
      "submitted_at": "2021-07-15T18:18:17Z",
      "travel_date_end": "2021-07-01",
      "travel_date_start": "2021-07-01",
      "travel_document_number": "FC123456",
      "user": {
        "email": "user0@company.com",
        "id": "93aaf0b3-1d79-4d2c-8d47-3d5406727d70",
        "name": "User Name"
      },
      "will_negotiate_or_sign_contracts": true,
      "work_location": "Some work location"
    }
  }
}

Changes

  • 51aa6655a32fRevision changes
    • info

      added the optional property /// to the response with the status