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>'

import requests

url = "https://api-stage.karmacheck.io/case/id/{caseId}/candidate/id/{candidateId}/url"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-stage.karmacheck.io/case/id/{caseId}/candidate/id/{candidateId}/url', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-stage.karmacheck.io/case/id/{caseId}/candidate/id/{candidateId}/url",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-stage.karmacheck.io/case/id/{caseId}/candidate/id/{candidateId}/url"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-stage.karmacheck.io/case/id/{caseId}/candidate/id/{candidateId}/url")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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>'

import requests

url = "https://api-stage.karmacheck.io/case/id/{caseId}/candidate/id/{candidateId}/url"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-stage.karmacheck.io/case/id/{caseId}/candidate/id/{candidateId}/url', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-stage.karmacheck.io/case/id/{caseId}/candidate/id/{candidateId}/url",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-stage.karmacheck.io/case/id/{caseId}/candidate/id/{candidateId}/url"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-stage.karmacheck.io/case/id/{caseId}/candidate/id/{candidateId}/url")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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