Cancel onboarding

Cancel onboarding.

Requirements for the cancellation to succeed:

  • Employment has to be in invited, created, created_awaiting_reserve, created_reserve_paid, pre_hire status
  • Employee must not have signed the employment contract

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 typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage employments (employments)-Manage onboarding (onboarding:write)
Company-scoped access token (assertion)Manage employments (employments)-Manage onboarding (onboarding:write)
Customer API tokenManage employments (employments)-Manage onboarding (onboarding:write)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Employment ID

Query Params
boolean

Whether the request should be performed async

Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json