Get one-time token link

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

{
  "ottUrl": "https://my.karmacheck.com/ott/a1bc234-56de-7891-234a-b5c6d7c8e901"
}

Candidate Onboarding

Get one-time token link

Retrieves a one-time token (OTT) URL to give to a candidate so that they can complete onboarding for a case. The returned URL contains a token, ensuring that the candidate secures their account before proceeding with onboarding.

This endpoint is typically called when a candidate has been newly integrated into KarmaCheck by a partner. This is so that testimony can be presented on behalf of the candidate for a case before onboarding begins. The URL is designed to ensure that the onboarding process includes a step where the candidate can secure their account before continuing.

Note: To properly redirect the candidate to the provided invitation context to commence their background check, append the full invitation link to the end of the returned OTT URL as a redirect_url query parameter. For example:

https://my.karmacheck.com/ott/{ott}?redirect_url=/invite/{invitationToken}
https://my.karmacheck.com/ott/{ott}?redirect_url=https://my.karmacheck.com/invite/{invitationToken}

GET

case

{caseId}

candidate

{candidateId}

url

Get one-time token link

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

{
  "ottUrl": "https://my.karmacheck.com/ott/a1bc234-56de-7891-234a-b5c6d7c8e901"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

caseId

string

required

candidateId

string

required

The ID of the candidate for the case.

Response

ottUrl

string

required

The URL in the format https://my{-env}.karmacheck.com/ott/{ott}, with {ott} as the token.

Example:

"https://my.karmacheck.com/ott/a1bc234-56de-7891-234a-b5c6d7c8e901"

⌘I