Refresh invitation for case

curl --request PUT \
  --url https://api-stage.karmacheck.io/case/id/{caseId}/action/refreshinvite \
  --header 'Authorization: Bearer <token>'

Candidate Onboarding

Refresh invitation for case

Refreshes the expiration date for an existing invitation.

When an onboarding invitation is generated, the candidate has 14 days (the default expiration period) to begin and complete their onboarding, or else the link in their invitation email becomes invalid.

As long as the invitation is refreshed during the 14-day period, enough time will be added so that the candidate has 14 days to complete onboarding. For example, if only 1 day remains, 13 days will be added. If 12 days still remain, only 2 days will be added.

Note that for your cases that don’t rely on the candidate to onboard, such as those that use the customer PII entry feature, you’ll never need to call this API.

PUT

case

{caseId}

action

refreshinvite

Refresh invitation for case

curl --request PUT \
  --url https://api-stage.karmacheck.io/case/id/{caseId}/action/refreshinvite \
  --header 'Authorization: Bearer <token>'

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

caseId

string

required

The ID of the case to refresh the invitation for.

Response

⌘I