Order Background Check Request
curl --request POST \
--url https://api.stackone.com/unified/ats/background_checks/orders \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'x-account-id: <x-account-id>' \
--data @- <<EOF
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"application": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"application_status": {
"value": "hired",
"source_value": "Hired"
},
"passthrough": {
"other_known_names": "John Doe"
}
},
"job": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"title": "Software Engineer",
"hiring_team": [
{
"user_id": "123456",
"remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@gmail.com",
"role": "Software Engineer"
}
],
"passthrough": {
"other_known_names": "John Doe"
}
},
"candidate": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"first_name": "Romain",
"last_name": "Sestier",
"emails": [
{
"type": "personal",
"value": "sestier.romain123@gmail.com"
}
],
"passthrough": {
"other_known_names": "John Doe"
},
"profile_url": "https://exmaple.com/candidate?id=xyz"
},
"requester": {
"user_id": "123456",
"remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@gmail.com",
"role": "Software Engineer"
},
"results_update_url": "https://exmaple.com/integrations/results/update",
"package": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Test 1",
"description": "Skills test to gauge a candidate's proficiency in job-specific skills",
"tests": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Test 1",
"description": "Skills test to gauge a candidate's proficiency in job-specific skills"
}
]
},
"passthrough": {
"other_known_names": "John Doe"
}
}
EOFimport requests
url = "https://api.stackone.com/unified/ats/background_checks/orders"
payload = {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"application": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"application_status": {
"value": "hired",
"source_value": "Hired"
},
"passthrough": { "other_known_names": "John Doe" }
},
"job": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"title": "Software Engineer",
"hiring_team": [
{
"user_id": "123456",
"remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@gmail.com",
"role": "Software Engineer"
}
],
"passthrough": { "other_known_names": "John Doe" }
},
"candidate": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"first_name": "Romain",
"last_name": "Sestier",
"emails": [
{
"type": "personal",
"value": "sestier.romain123@gmail.com"
}
],
"passthrough": { "other_known_names": "John Doe" },
"profile_url": "https://exmaple.com/candidate?id=xyz"
},
"requester": {
"user_id": "123456",
"remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@gmail.com",
"role": "Software Engineer"
},
"results_update_url": "https://exmaple.com/integrations/results/update",
"package": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Test 1",
"description": "Skills test to gauge a candidate's proficiency in job-specific skills",
"tests": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Test 1",
"description": "Skills test to gauge a candidate's proficiency in job-specific skills"
}
]
},
"passthrough": { "other_known_names": "John Doe" }
}
headers = {
"x-account-id": "<x-account-id>",
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-account-id': '<x-account-id>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
application: {
id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
application_status: {value: 'hired', source_value: 'Hired'},
passthrough: {other_known_names: 'John Doe'}
},
job: {
id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
title: 'Software Engineer',
hiring_team: [
{
user_id: '123456',
remote_user_id: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48',
first_name: 'John',
last_name: 'Doe',
email: 'john.doe@gmail.com',
role: 'Software Engineer'
}
],
passthrough: {other_known_names: 'John Doe'}
},
candidate: {
id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
first_name: 'Romain',
last_name: 'Sestier',
emails: [{type: 'personal', value: 'sestier.romain123@gmail.com'}],
passthrough: {other_known_names: 'John Doe'},
profile_url: 'https://exmaple.com/candidate?id=xyz'
},
requester: {
user_id: '123456',
remote_user_id: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48',
first_name: 'John',
last_name: 'Doe',
email: 'john.doe@gmail.com',
role: 'Software Engineer'
},
results_update_url: 'https://exmaple.com/integrations/results/update',
package: {
id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
name: 'Test 1',
description: 'Skills test to gauge a candidate\'s proficiency in job-specific skills',
tests: [
{
id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
name: 'Test 1',
description: 'Skills test to gauge a candidate\'s proficiency in job-specific skills'
}
]
},
passthrough: {other_known_names: 'John Doe'}
})
};
fetch('https://api.stackone.com/unified/ats/background_checks/orders', 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.stackone.com/unified/ats/background_checks/orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'remote_id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'application' => [
'id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'remote_id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'application_status' => [
'value' => 'hired',
'source_value' => 'Hired'
],
'passthrough' => [
'other_known_names' => 'John Doe'
]
],
'job' => [
'id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'remote_id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'title' => 'Software Engineer',
'hiring_team' => [
[
'user_id' => '123456',
'remote_user_id' => 'e3cb75bf-aa84-466e-a6c1-b8322b257a48',
'first_name' => 'John',
'last_name' => 'Doe',
'email' => 'john.doe@gmail.com',
'role' => 'Software Engineer'
]
],
'passthrough' => [
'other_known_names' => 'John Doe'
]
],
'candidate' => [
'id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'remote_id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'first_name' => 'Romain',
'last_name' => 'Sestier',
'emails' => [
[
'type' => 'personal',
'value' => 'sestier.romain123@gmail.com'
]
],
'passthrough' => [
'other_known_names' => 'John Doe'
],
'profile_url' => 'https://exmaple.com/candidate?id=xyz'
],
'requester' => [
'user_id' => '123456',
'remote_user_id' => 'e3cb75bf-aa84-466e-a6c1-b8322b257a48',
'first_name' => 'John',
'last_name' => 'Doe',
'email' => 'john.doe@gmail.com',
'role' => 'Software Engineer'
],
'results_update_url' => 'https://exmaple.com/integrations/results/update',
'package' => [
'id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'remote_id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'name' => 'Test 1',
'description' => 'Skills test to gauge a candidate\'s proficiency in job-specific skills',
'tests' => [
[
'id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'remote_id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'name' => 'Test 1',
'description' => 'Skills test to gauge a candidate\'s proficiency in job-specific skills'
]
]
],
'passthrough' => [
'other_known_names' => 'John Doe'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"x-account-id: <x-account-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.stackone.com/unified/ats/background_checks/orders"
payload := strings.NewReader("{\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"application\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"application_status\": {\n \"value\": \"hired\",\n \"source_value\": \"Hired\"\n },\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n },\n \"job\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"title\": \"Software Engineer\",\n \"hiring_team\": [\n {\n \"user_id\": \"123456\",\n \"remote_user_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@gmail.com\",\n \"role\": \"Software Engineer\"\n }\n ],\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n },\n \"candidate\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"first_name\": \"Romain\",\n \"last_name\": \"Sestier\",\n \"emails\": [\n {\n \"type\": \"personal\",\n \"value\": \"sestier.romain123@gmail.com\"\n }\n ],\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n },\n \"profile_url\": \"https://exmaple.com/candidate?id=xyz\"\n },\n \"requester\": {\n \"user_id\": \"123456\",\n \"remote_user_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@gmail.com\",\n \"role\": \"Software Engineer\"\n },\n \"results_update_url\": \"https://exmaple.com/integrations/results/update\",\n \"package\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"Test 1\",\n \"description\": \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n \"tests\": [\n {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"Test 1\",\n \"description\": \"Skills test to gauge a candidate's proficiency in job-specific skills\"\n }\n ]\n },\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-account-id", "<x-account-id>")
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.stackone.com/unified/ats/background_checks/orders")
.header("x-account-id", "<x-account-id>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"application\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"application_status\": {\n \"value\": \"hired\",\n \"source_value\": \"Hired\"\n },\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n },\n \"job\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"title\": \"Software Engineer\",\n \"hiring_team\": [\n {\n \"user_id\": \"123456\",\n \"remote_user_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@gmail.com\",\n \"role\": \"Software Engineer\"\n }\n ],\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n },\n \"candidate\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"first_name\": \"Romain\",\n \"last_name\": \"Sestier\",\n \"emails\": [\n {\n \"type\": \"personal\",\n \"value\": \"sestier.romain123@gmail.com\"\n }\n ],\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n },\n \"profile_url\": \"https://exmaple.com/candidate?id=xyz\"\n },\n \"requester\": {\n \"user_id\": \"123456\",\n \"remote_user_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@gmail.com\",\n \"role\": \"Software Engineer\"\n },\n \"results_update_url\": \"https://exmaple.com/integrations/results/update\",\n \"package\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"Test 1\",\n \"description\": \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n \"tests\": [\n {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"Test 1\",\n \"description\": \"Skills test to gauge a candidate's proficiency in job-specific skills\"\n }\n ]\n },\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/unified/ats/background_checks/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-account-id"] = '<x-account-id>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"application\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"application_status\": {\n \"value\": \"hired\",\n \"source_value\": \"Hired\"\n },\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n },\n \"job\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"title\": \"Software Engineer\",\n \"hiring_team\": [\n {\n \"user_id\": \"123456\",\n \"remote_user_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@gmail.com\",\n \"role\": \"Software Engineer\"\n }\n ],\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n },\n \"candidate\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"first_name\": \"Romain\",\n \"last_name\": \"Sestier\",\n \"emails\": [\n {\n \"type\": \"personal\",\n \"value\": \"sestier.romain123@gmail.com\"\n }\n ],\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n },\n \"profile_url\": \"https://exmaple.com/candidate?id=xyz\"\n },\n \"requester\": {\n \"user_id\": \"123456\",\n \"remote_user_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@gmail.com\",\n \"role\": \"Software Engineer\"\n },\n \"results_update_url\": \"https://exmaple.com/integrations/results/update\",\n \"package\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"Test 1\",\n \"description\": \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n \"tests\": [\n {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"Test 1\",\n \"description\": \"Skills test to gauge a candidate's proficiency in job-specific skills\"\n }\n ]\n },\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"test_url": "https://exmaple.com/integrations/candidate/test"
}{
"statusCode": 400,
"message": "Bad Request",
"timestamp": "2023-05-30T00:00:00.000Z",
"data": {
"statusCode": 400,
"message": "Bad Request",
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
},
"provider_errors": [
{
"status": 400,
"url": "https://api.provider.com/v1/resource",
"raw": {
"message": "Invalid input parameters"
},
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
}
]
}{
"statusCode": 401,
"message": "Unauthorized",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 403,
"message": "Forbidden resource",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 404,
"message": "Not Found",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 408,
"message": "Request timed out",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 409,
"message": "Conflict",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 412,
"message": "Precondition failed",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 422,
"message": "Unprocessable Entity",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 429,
"message": "Too many requests",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 500,
"message": "Internal server error",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 501,
"message": "Not Implemented",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 502,
"message": "Bad Gateway",
"timestamp": "2023-05-30T00:00:00.000Z"
}Order Background Check Request
POST
/
unified
/
ats
/
background_checks
/
orders
Order Background Check Request
curl --request POST \
--url https://api.stackone.com/unified/ats/background_checks/orders \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'x-account-id: <x-account-id>' \
--data @- <<EOF
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"application": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"application_status": {
"value": "hired",
"source_value": "Hired"
},
"passthrough": {
"other_known_names": "John Doe"
}
},
"job": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"title": "Software Engineer",
"hiring_team": [
{
"user_id": "123456",
"remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@gmail.com",
"role": "Software Engineer"
}
],
"passthrough": {
"other_known_names": "John Doe"
}
},
"candidate": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"first_name": "Romain",
"last_name": "Sestier",
"emails": [
{
"type": "personal",
"value": "sestier.romain123@gmail.com"
}
],
"passthrough": {
"other_known_names": "John Doe"
},
"profile_url": "https://exmaple.com/candidate?id=xyz"
},
"requester": {
"user_id": "123456",
"remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@gmail.com",
"role": "Software Engineer"
},
"results_update_url": "https://exmaple.com/integrations/results/update",
"package": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Test 1",
"description": "Skills test to gauge a candidate's proficiency in job-specific skills",
"tests": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Test 1",
"description": "Skills test to gauge a candidate's proficiency in job-specific skills"
}
]
},
"passthrough": {
"other_known_names": "John Doe"
}
}
EOFimport requests
url = "https://api.stackone.com/unified/ats/background_checks/orders"
payload = {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"application": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"application_status": {
"value": "hired",
"source_value": "Hired"
},
"passthrough": { "other_known_names": "John Doe" }
},
"job": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"title": "Software Engineer",
"hiring_team": [
{
"user_id": "123456",
"remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@gmail.com",
"role": "Software Engineer"
}
],
"passthrough": { "other_known_names": "John Doe" }
},
"candidate": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"first_name": "Romain",
"last_name": "Sestier",
"emails": [
{
"type": "personal",
"value": "sestier.romain123@gmail.com"
}
],
"passthrough": { "other_known_names": "John Doe" },
"profile_url": "https://exmaple.com/candidate?id=xyz"
},
"requester": {
"user_id": "123456",
"remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@gmail.com",
"role": "Software Engineer"
},
"results_update_url": "https://exmaple.com/integrations/results/update",
"package": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Test 1",
"description": "Skills test to gauge a candidate's proficiency in job-specific skills",
"tests": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Test 1",
"description": "Skills test to gauge a candidate's proficiency in job-specific skills"
}
]
},
"passthrough": { "other_known_names": "John Doe" }
}
headers = {
"x-account-id": "<x-account-id>",
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-account-id': '<x-account-id>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
application: {
id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
application_status: {value: 'hired', source_value: 'Hired'},
passthrough: {other_known_names: 'John Doe'}
},
job: {
id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
title: 'Software Engineer',
hiring_team: [
{
user_id: '123456',
remote_user_id: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48',
first_name: 'John',
last_name: 'Doe',
email: 'john.doe@gmail.com',
role: 'Software Engineer'
}
],
passthrough: {other_known_names: 'John Doe'}
},
candidate: {
id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
first_name: 'Romain',
last_name: 'Sestier',
emails: [{type: 'personal', value: 'sestier.romain123@gmail.com'}],
passthrough: {other_known_names: 'John Doe'},
profile_url: 'https://exmaple.com/candidate?id=xyz'
},
requester: {
user_id: '123456',
remote_user_id: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48',
first_name: 'John',
last_name: 'Doe',
email: 'john.doe@gmail.com',
role: 'Software Engineer'
},
results_update_url: 'https://exmaple.com/integrations/results/update',
package: {
id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
name: 'Test 1',
description: 'Skills test to gauge a candidate\'s proficiency in job-specific skills',
tests: [
{
id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
name: 'Test 1',
description: 'Skills test to gauge a candidate\'s proficiency in job-specific skills'
}
]
},
passthrough: {other_known_names: 'John Doe'}
})
};
fetch('https://api.stackone.com/unified/ats/background_checks/orders', 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.stackone.com/unified/ats/background_checks/orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'remote_id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'application' => [
'id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'remote_id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'application_status' => [
'value' => 'hired',
'source_value' => 'Hired'
],
'passthrough' => [
'other_known_names' => 'John Doe'
]
],
'job' => [
'id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'remote_id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'title' => 'Software Engineer',
'hiring_team' => [
[
'user_id' => '123456',
'remote_user_id' => 'e3cb75bf-aa84-466e-a6c1-b8322b257a48',
'first_name' => 'John',
'last_name' => 'Doe',
'email' => 'john.doe@gmail.com',
'role' => 'Software Engineer'
]
],
'passthrough' => [
'other_known_names' => 'John Doe'
]
],
'candidate' => [
'id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'remote_id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'first_name' => 'Romain',
'last_name' => 'Sestier',
'emails' => [
[
'type' => 'personal',
'value' => 'sestier.romain123@gmail.com'
]
],
'passthrough' => [
'other_known_names' => 'John Doe'
],
'profile_url' => 'https://exmaple.com/candidate?id=xyz'
],
'requester' => [
'user_id' => '123456',
'remote_user_id' => 'e3cb75bf-aa84-466e-a6c1-b8322b257a48',
'first_name' => 'John',
'last_name' => 'Doe',
'email' => 'john.doe@gmail.com',
'role' => 'Software Engineer'
],
'results_update_url' => 'https://exmaple.com/integrations/results/update',
'package' => [
'id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'remote_id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'name' => 'Test 1',
'description' => 'Skills test to gauge a candidate\'s proficiency in job-specific skills',
'tests' => [
[
'id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'remote_id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'name' => 'Test 1',
'description' => 'Skills test to gauge a candidate\'s proficiency in job-specific skills'
]
]
],
'passthrough' => [
'other_known_names' => 'John Doe'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"x-account-id: <x-account-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.stackone.com/unified/ats/background_checks/orders"
payload := strings.NewReader("{\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"application\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"application_status\": {\n \"value\": \"hired\",\n \"source_value\": \"Hired\"\n },\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n },\n \"job\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"title\": \"Software Engineer\",\n \"hiring_team\": [\n {\n \"user_id\": \"123456\",\n \"remote_user_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@gmail.com\",\n \"role\": \"Software Engineer\"\n }\n ],\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n },\n \"candidate\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"first_name\": \"Romain\",\n \"last_name\": \"Sestier\",\n \"emails\": [\n {\n \"type\": \"personal\",\n \"value\": \"sestier.romain123@gmail.com\"\n }\n ],\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n },\n \"profile_url\": \"https://exmaple.com/candidate?id=xyz\"\n },\n \"requester\": {\n \"user_id\": \"123456\",\n \"remote_user_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@gmail.com\",\n \"role\": \"Software Engineer\"\n },\n \"results_update_url\": \"https://exmaple.com/integrations/results/update\",\n \"package\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"Test 1\",\n \"description\": \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n \"tests\": [\n {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"Test 1\",\n \"description\": \"Skills test to gauge a candidate's proficiency in job-specific skills\"\n }\n ]\n },\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-account-id", "<x-account-id>")
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.stackone.com/unified/ats/background_checks/orders")
.header("x-account-id", "<x-account-id>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"application\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"application_status\": {\n \"value\": \"hired\",\n \"source_value\": \"Hired\"\n },\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n },\n \"job\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"title\": \"Software Engineer\",\n \"hiring_team\": [\n {\n \"user_id\": \"123456\",\n \"remote_user_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@gmail.com\",\n \"role\": \"Software Engineer\"\n }\n ],\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n },\n \"candidate\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"first_name\": \"Romain\",\n \"last_name\": \"Sestier\",\n \"emails\": [\n {\n \"type\": \"personal\",\n \"value\": \"sestier.romain123@gmail.com\"\n }\n ],\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n },\n \"profile_url\": \"https://exmaple.com/candidate?id=xyz\"\n },\n \"requester\": {\n \"user_id\": \"123456\",\n \"remote_user_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@gmail.com\",\n \"role\": \"Software Engineer\"\n },\n \"results_update_url\": \"https://exmaple.com/integrations/results/update\",\n \"package\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"Test 1\",\n \"description\": \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n \"tests\": [\n {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"Test 1\",\n \"description\": \"Skills test to gauge a candidate's proficiency in job-specific skills\"\n }\n ]\n },\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/unified/ats/background_checks/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-account-id"] = '<x-account-id>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"application\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"application_status\": {\n \"value\": \"hired\",\n \"source_value\": \"Hired\"\n },\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n },\n \"job\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"title\": \"Software Engineer\",\n \"hiring_team\": [\n {\n \"user_id\": \"123456\",\n \"remote_user_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@gmail.com\",\n \"role\": \"Software Engineer\"\n }\n ],\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n },\n \"candidate\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"first_name\": \"Romain\",\n \"last_name\": \"Sestier\",\n \"emails\": [\n {\n \"type\": \"personal\",\n \"value\": \"sestier.romain123@gmail.com\"\n }\n ],\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n },\n \"profile_url\": \"https://exmaple.com/candidate?id=xyz\"\n },\n \"requester\": {\n \"user_id\": \"123456\",\n \"remote_user_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@gmail.com\",\n \"role\": \"Software Engineer\"\n },\n \"results_update_url\": \"https://exmaple.com/integrations/results/update\",\n \"package\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"Test 1\",\n \"description\": \"Skills test to gauge a candidate's proficiency in job-specific skills\",\n \"tests\": [\n {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"Test 1\",\n \"description\": \"Skills test to gauge a candidate's proficiency in job-specific skills\"\n }\n ]\n },\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"test_url": "https://exmaple.com/integrations/candidate/test"
}{
"statusCode": 400,
"message": "Bad Request",
"timestamp": "2023-05-30T00:00:00.000Z",
"data": {
"statusCode": 400,
"message": "Bad Request",
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
},
"provider_errors": [
{
"status": 400,
"url": "https://api.provider.com/v1/resource",
"raw": {
"message": "Invalid input parameters"
},
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
}
]
}{
"statusCode": 401,
"message": "Unauthorized",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 403,
"message": "Forbidden resource",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 404,
"message": "Not Found",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 408,
"message": "Request timed out",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 409,
"message": "Conflict",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 412,
"message": "Precondition failed",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 422,
"message": "Unprocessable Entity",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 429,
"message": "Too many requests",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 500,
"message": "Internal server error",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 501,
"message": "Not Implemented",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 502,
"message": "Bad Gateway",
"timestamp": "2023-05-30T00:00:00.000Z"
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Headers
The account identifier
Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)
Example:
"heartbeat"
Body
application/json
Unique identifier
Example:
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
Example:
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Results update url
Example:
"https://exmaple.com/integrations/results/update"
Show child attributes
Show child attributes
Value to pass through to the provider
Example:
{ "other_known_names": "John Doe" }
Response
The order request of the background check for candidate.
Was this page helpful?
⌘I