Resignations

Validate resignation request

Validates a resignation employment request

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:write works too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage employments (employments)	-	Manage resignations (resignation:write)
Company-scoped access token (assertion)	Manage employments (employments)	-	Manage resignations (resignation:write)
Customer API token	Manage employments (employments)	-	Manage resignations (resignation:write)

put/v1/resignations/{offboarding_request_id}/validate

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/resignations/{offboarding_request_id}/validate
Auth
- OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: resignation:write
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: resignation:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

Path parameters

offboarding_request_idstring required

Offboarding request ID

Request body

Example request

{
  "accepts_proposed_notice": false,
  "agrees_to_pto_amount": false,
  "agrees_to_pto_amount_notes": "I don't agree.",
  "agrees_to_resignation_reason": false,
  "agrees_to_resignation_reason_notes": "I don't agree.",
  "has_additional_information": true,
  "has_additional_information_notes": "Some extra info.",
  "has_more_salary_info": true,
  "has_more_salary_info_notes": "Some info about the salary.",
  "is_owed_outstanding_reimbursements": true,
  "owed_outstanding_reimbursements": {
    "amount": 1500,
    "notes": "Compensation."
  },
  "proposed_last_date": {
    "date": "2042-04-15",
    "notes": "This date is better."
  },
  "will_take_more_pto": true,
  "will_take_more_pto_notes": "3 more days."
}

Response

Success

Example response

{
  "data": {
    "status": "ok"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.