NAV Navigation
HTTP JavaScript Node.JS Python Ruby

CheckHub API v1.91.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Welcome to CheckHub API documentation

Every method is protected and requires you to have a valid API Token.

If you don't have it yet, we strongly advise you to start by creating a new one.

To do so :

If you have any questions, please ask !

Please use the following link for bug report: https://form.asana.com/?k=OngbuzmFRVTp_ZMEMuUAbg&d=718323232107850

For convenient tracking of all changes in the API, please use this link: https://changelog.checkhub.io

Base URLs:

Email: CheckHub Technical Team

Authentication

Account

Create new account

Code samples

POST https://api.checkhub.io/accounts HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "name": "Tesla Digital",
  "reference": "ACC_TESLA_DIG_01",
  "welcomeText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "aboutText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "completedBoxText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "completedText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/accounts',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "name": "Tesla Digital",
  "reference": "ACC_TESLA_DIG_01",
  "welcomeText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "aboutText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "completedBoxText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "completedText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  }
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/accounts',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.checkhub.io/accounts', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.checkhub.io/accounts',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /accounts

Body parameter

{
  "name": "Tesla Digital",
  "reference": "ACC_TESLA_DIG_01",
  "welcomeText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "aboutText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "completedBoxText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "completedText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  }
}

Parameters

Name In Type Required Description
name body string true Account name
reference body string false Account reference (unique identifier for the account)
welcomeText body accountWelcomeTextBase false This scheme is a collection of account welcome text for users in different languages.
» en body string(html) false Used for users whose language is "English"
» fr body string(html) false Used for users whose language is "Français"
» nl body string(html) false Used for users whose language is "Nederlands"
» de body string(html) false Used for users whose language is "Deutsch"
» it body string(html) false Used for users whose language is "Italiano"
» pl body string(html) false Used for users whose language is "Polski"
» ro body string(html) false Used for users whose language is "Română"
» sq body string(html) false Used for users whose language is "Shqip"
» be body string(html) false Used for users whose language is "Беларуская"
» bg body string(html) false Used for users whose language is "Български"
» hr body string(html) false Used for users whose language is "Hrvatski"
» cs body string(html) false Used for users whose language is "Čeština"
» da body string(html) false Used for users whose language is "Dansk"
» et body string(html) false Used for users whose language is "Eesti"
» fi body string(html) false Used for users whose language is "Suomi"
» el body string(html) false Used for users whose language is "Ελληνικά"
» hu body string(html) false Used for users whose language is "Magyar"
» is body string(html) false Used for users whose language is "Íslenska"
» ga body string(html) false Used for users whose language is "Gaeilge"
» lv body string(html) false Used for users whose language is "Latviešu"
» lt body string(html) false Used for users whose language is "Lietuvių"
» mk body string(html) false Used for users whose language is "Македонски"
» mt body string(html) false Used for users whose language is "Malti"
» no body string(html) false Used for users whose language is "Norsk"
» pt body string(html) false Used for users whose language is "Português"
» ru body string(html) false Used for users whose language is "Русский"
» sr body string(html) false Used for users whose language is "Српски"
» sk body string(html) false Used for users whose language is "Slovenčina"
» sl body string(html) false Used for users whose language is "Slovenščina"
» es body string(html) false Used for users whose language is "Español"
» sv body string(html) false Used for users whose language is "Svenska"
» uk body string(html) false Used for users whose language is "Українська"
» cy body string(html) false Used for users whose language is "Cymraeg"
aboutText body accountAboutTextBase false This scheme is a collection of account about text for users in different languages.
» en body string(html) false Used for users whose language is "English"
» fr body string(html) false Used for users whose language is "Français"
» nl body string(html) false Used for users whose language is "Nederlands"
» de body string(html) false Used for users whose language is "Deutsch"
» it body string(html) false Used for users whose language is "Italiano"
» pl body string(html) false Used for users whose language is "Polski"
» ro body string(html) false Used for users whose language is "Română"
» sq body string(html) false Used for users whose language is "Shqip"
» be body string(html) false Used for users whose language is "Беларуская"
» bg body string(html) false Used for users whose language is "Български"
» hr body string(html) false Used for users whose language is "Hrvatski"
» cs body string(html) false Used for users whose language is "Čeština"
» da body string(html) false Used for users whose language is "Dansk"
» et body string(html) false Used for users whose language is "Eesti"
» fi body string(html) false Used for users whose language is "Suomi"
» el body string(html) false Used for users whose language is "Ελληνικά"
» hu body string(html) false Used for users whose language is "Magyar"
» is body string(html) false Used for users whose language is "Íslenska"
» ga body string(html) false Used for users whose language is "Gaeilge"
» lv body string(html) false Used for users whose language is "Latviešu"
» lt body string(html) false Used for users whose language is "Lietuvių"
» mk body string(html) false Used for users whose language is "Македонски"
» mt body string(html) false Used for users whose language is "Malti"
» no body string(html) false Used for users whose language is "Norsk"
» pt body string(html) false Used for users whose language is "Português"
» ru body string(html) false Used for users whose language is "Русский"
» sr body string(html) false Used for users whose language is "Српски"
» sk body string(html) false Used for users whose language is "Slovenčina"
» sl body string(html) false Used for users whose language is "Slovenščina"
» es body string(html) false Used for users whose language is "Español"
» sv body string(html) false Used for users whose language is "Svenska"
» uk body string(html) false Used for users whose language is "Українська"
» cy body string(html) false Used for users whose language is "Cymraeg"
completedBoxText body accountCompletedBoxTextBase false This scheme is a collection of account completed box text for users in different languages.
» en body string(html) false Used for users whose language is "English"
» fr body string(html) false Used for users whose language is "Français"
» nl body string(html) false Used for users whose language is "Nederlands"
» de body string(html) false Used for users whose language is "Deutsch"
» it body string(html) false Used for users whose language is "Italiano"
» pl body string(html) false Used for users whose language is "Polski"
» ro body string(html) false Used for users whose language is "Română"
» sq body string(html) false Used for users whose language is "Shqip"
» be body string(html) false Used for users whose language is "Беларуская"
» bg body string(html) false Used for users whose language is "Български"
» hr body string(html) false Used for users whose language is "Hrvatski"
» cs body string(html) false Used for users whose language is "Čeština"
» da body string(html) false Used for users whose language is "Dansk"
» et body string(html) false Used for users whose language is "Eesti"
» fi body string(html) false Used for users whose language is "Suomi"
» el body string(html) false Used for users whose language is "Ελληνικά"
» hu body string(html) false Used for users whose language is "Magyar"
» is body string(html) false Used for users whose language is "Íslenska"
» ga body string(html) false Used for users whose language is "Gaeilge"
» lv body string(html) false Used for users whose language is "Latviešu"
» lt body string(html) false Used for users whose language is "Lietuvių"
» mk body string(html) false Used for users whose language is "Македонски"
» mt body string(html) false Used for users whose language is "Malti"
» no body string(html) false Used for users whose language is "Norsk"
» pt body string(html) false Used for users whose language is "Português"
» ru body string(html) false Used for users whose language is "Русский"
» sr body string(html) false Used for users whose language is "Српски"
» sk body string(html) false Used for users whose language is "Slovenčina"
» sl body string(html) false Used for users whose language is "Slovenščina"
» es body string(html) false Used for users whose language is "Español"
» sv body string(html) false Used for users whose language is "Svenska"
» uk body string(html) false Used for users whose language is "Українська"
» cy body string(html) false Used for users whose language is "Cymraeg"
completedText body accountCompletedTextBase false This scheme is a collection of account completed text for users in different languages.
» en body string(html) false Used for users whose language is "English"
» fr body string(html) false Used for users whose language is "Français"
» nl body string(html) false Used for users whose language is "Nederlands"
» de body string(html) false Used for users whose language is "Deutsch"
» it body string(html) false Used for users whose language is "Italiano"
» pl body string(html) false Used for users whose language is "Polski"
» ro body string(html) false Used for users whose language is "Română"
» sq body string(html) false Used for users whose language is "Shqip"
» be body string(html) false Used for users whose language is "Беларуская"
» bg body string(html) false Used for users whose language is "Български"
» hr body string(html) false Used for users whose language is "Hrvatski"
» cs body string(html) false Used for users whose language is "Čeština"
» da body string(html) false Used for users whose language is "Dansk"
» et body string(html) false Used for users whose language is "Eesti"
» fi body string(html) false Used for users whose language is "Suomi"
» el body string(html) false Used for users whose language is "Ελληνικά"
» hu body string(html) false Used for users whose language is "Magyar"
» is body string(html) false Used for users whose language is "Íslenska"
» ga body string(html) false Used for users whose language is "Gaeilge"
» lv body string(html) false Used for users whose language is "Latviešu"
» lt body string(html) false Used for users whose language is "Lietuvių"
» mk body string(html) false Used for users whose language is "Македонски"
» mt body string(html) false Used for users whose language is "Malti"
» no body string(html) false Used for users whose language is "Norsk"
» pt body string(html) false Used for users whose language is "Português"
» ru body string(html) false Used for users whose language is "Русский"
» sr body string(html) false Used for users whose language is "Српски"
» sk body string(html) false Used for users whose language is "Slovenčina"
» sl body string(html) false Used for users whose language is "Slovenščina"
» es body string(html) false Used for users whose language is "Español"
» sv body string(html) false Used for users whose language is "Svenska"
» uk body string(html) false Used for users whose language is "Українська"
» cy body string(html) false Used for users whose language is "Cymraeg"

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "name": "Tesla Digital",
  "reference": "ACC_TESLA_DIG_01",
  "welcomeText": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "aboutText": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "completedBoxText": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "completedText": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z"
}

Responses

Status Meaning Description Schema
200 OK Request was successful account

Get account collection

Code samples

GET https://api.checkhub.io/accounts HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/accounts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/accounts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/accounts', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/accounts',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /accounts

Parameters

Name In Type Required Description
limit query number false Maximum number of items in the response. min: 1, max: 100, default: 10
skip query number false Number of items skipped during the selection. min: 0, default: 0
order query string false Account collection order
filter[name] query string false Search by account name
filter[reference] query string false Search by account reference
includeShared query boolean false To include accounts from the companies of the same company group
includeWelcomeText query boolean false To include account 'welcomeText' relation
includeAboutText query boolean false To include account 'aboutText' relation
includeCompletedBoxText query boolean false To include account 'completedBoxText' relation
includeCompletedText query boolean false To include account 'completedText' relation
includeCandidates query boolean false To include account 'candidates' relation. deprecated
includeCandidatesCount query boolean false To include account 'candidatesCount' field which will show count of all related candidates

Enumerated Values

Parameter Value
order name asc
order name desc
order createdAt asc
order createdAt desc

Example responses

200 Response

[
  {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "name": "Tesla Digital",
    "reference": "ACC_TESLA_DIG_01",
    "welcomeText": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "en": "<p>English</p>",
      "fr": "<p>Français</p>",
      "nl": "<p>Nederlands</p>",
      "de": "<p>Deutsch</p>",
      "it": "<p>Italiano</p>",
      "pl": "<p>Polski</p>",
      "ro": "<p>Română</p>",
      "sq": "<p>Shqip</p>",
      "be": "<p>Беларуская</p>",
      "bg": "<p>Български</p>",
      "hr": "<p>Hrvatski</p>",
      "cs": "<p>Čeština</p>",
      "da": "<p>Dansk</p>",
      "et": "<p>Eesti</p>",
      "fi": "<p>Suomi</p>",
      "el": "<p>Ελληνικά</p>",
      "hu": "<p>Magyar</p>",
      "is": "<p>Íslenska</p>",
      "ga": "<p>Gaeilge</p>",
      "lv": "<p>Latviešu</p>",
      "lt": "<p>Lietuvių</p>",
      "mk": "<p>Македонски</p>",
      "mt": "<p>Malti</p>",
      "no": "<p>Norsk</p>",
      "pt": "<p>Português</p>",
      "ru": "<p>Русский</p>",
      "sr": "<p>Српски</p>",
      "sk": "<p>Slovenčina</p>",
      "sl": "<p>Slovenščina</p>",
      "es": "<p>Español</p>",
      "sv": "<p>Svenska</p>",
      "uk": "<p>Українська</p>",
      "cy": "<p>Cymraeg</p>"
    },
    "aboutText": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "en": "<p>English</p>",
      "fr": "<p>Français</p>",
      "nl": "<p>Nederlands</p>",
      "de": "<p>Deutsch</p>",
      "it": "<p>Italiano</p>",
      "pl": "<p>Polski</p>",
      "ro": "<p>Română</p>",
      "sq": "<p>Shqip</p>",
      "be": "<p>Беларуская</p>",
      "bg": "<p>Български</p>",
      "hr": "<p>Hrvatski</p>",
      "cs": "<p>Čeština</p>",
      "da": "<p>Dansk</p>",
      "et": "<p>Eesti</p>",
      "fi": "<p>Suomi</p>",
      "el": "<p>Ελληνικά</p>",
      "hu": "<p>Magyar</p>",
      "is": "<p>Íslenska</p>",
      "ga": "<p>Gaeilge</p>",
      "lv": "<p>Latviešu</p>",
      "lt": "<p>Lietuvių</p>",
      "mk": "<p>Македонски</p>",
      "mt": "<p>Malti</p>",
      "no": "<p>Norsk</p>",
      "pt": "<p>Português</p>",
      "ru": "<p>Русский</p>",
      "sr": "<p>Српски</p>",
      "sk": "<p>Slovenčina</p>",
      "sl": "<p>Slovenščina</p>",
      "es": "<p>Español</p>",
      "sv": "<p>Svenska</p>",
      "uk": "<p>Українська</p>",
      "cy": "<p>Cymraeg</p>"
    },
    "completedBoxText": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "en": "<p>English</p>",
      "fr": "<p>Français</p>",
      "nl": "<p>Nederlands</p>",
      "de": "<p>Deutsch</p>",
      "it": "<p>Italiano</p>",
      "pl": "<p>Polski</p>",
      "ro": "<p>Română</p>",
      "sq": "<p>Shqip</p>",
      "be": "<p>Беларуская</p>",
      "bg": "<p>Български</p>",
      "hr": "<p>Hrvatski</p>",
      "cs": "<p>Čeština</p>",
      "da": "<p>Dansk</p>",
      "et": "<p>Eesti</p>",
      "fi": "<p>Suomi</p>",
      "el": "<p>Ελληνικά</p>",
      "hu": "<p>Magyar</p>",
      "is": "<p>Íslenska</p>",
      "ga": "<p>Gaeilge</p>",
      "lv": "<p>Latviešu</p>",
      "lt": "<p>Lietuvių</p>",
      "mk": "<p>Македонски</p>",
      "mt": "<p>Malti</p>",
      "no": "<p>Norsk</p>",
      "pt": "<p>Português</p>",
      "ru": "<p>Русский</p>",
      "sr": "<p>Српски</p>",
      "sk": "<p>Slovenčina</p>",
      "sl": "<p>Slovenščina</p>",
      "es": "<p>Español</p>",
      "sv": "<p>Svenska</p>",
      "uk": "<p>Українська</p>",
      "cy": "<p>Cymraeg</p>"
    },
    "completedText": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "en": "<p>English</p>",
      "fr": "<p>Français</p>",
      "nl": "<p>Nederlands</p>",
      "de": "<p>Deutsch</p>",
      "it": "<p>Italiano</p>",
      "pl": "<p>Polski</p>",
      "ro": "<p>Română</p>",
      "sq": "<p>Shqip</p>",
      "be": "<p>Беларуская</p>",
      "bg": "<p>Български</p>",
      "hr": "<p>Hrvatski</p>",
      "cs": "<p>Čeština</p>",
      "da": "<p>Dansk</p>",
      "et": "<p>Eesti</p>",
      "fi": "<p>Suomi</p>",
      "el": "<p>Ελληνικά</p>",
      "hu": "<p>Magyar</p>",
      "is": "<p>Íslenska</p>",
      "ga": "<p>Gaeilge</p>",
      "lv": "<p>Latviešu</p>",
      "lt": "<p>Lietuvių</p>",
      "mk": "<p>Македонски</p>",
      "mt": "<p>Malti</p>",
      "no": "<p>Norsk</p>",
      "pt": "<p>Português</p>",
      "ru": "<p>Русский</p>",
      "sr": "<p>Српски</p>",
      "sk": "<p>Slovenčina</p>",
      "sl": "<p>Slovenščina</p>",
      "es": "<p>Español</p>",
      "sv": "<p>Svenska</p>",
      "uk": "<p>Українська</p>",
      "cy": "<p>Cymraeg</p>"
    },
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "candidates": [
      {
        "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "email": "[email protected]",
        "firstName": "James",
        "lastName": "Good",
        "reference": "Best Candidate",
        "language": "en",
        "welcomeText": "Hi John, we are glad to welcome you to the company!",
        "welcomeTextType": "default",
        "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "additionalEmails": [
          "[email protected]"
        ],
        "snoozed": false,
        "mobilePhone": "003801234567890",
        "notes": "Some notes",
        "deadline": "2019-09-12T15:36:09.264Z",
        "createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "status": "pending",
        "token": "2ScQsIW1OPHsjEFRs",
        "archived": false,
        "integrationChanged": false,
        "clientIsMobile": false,
        "clientVersion": "",
        "lastLoggedAt": "2019-09-12T15:36:09.264Z",
        "statusUpdateAt": "2019-09-12T15:36:09.264Z",
        "createdAt": "2019-09-12T15:36:09.264Z",
        "updatedAt": "2019-09-12T15:36:09.264Z"
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful accountFindResponse

Response Headers

Status Header Type Format Description
200 X-CURRENT-PAGE integer Current page
200 X-PAGE-OFFSET integer Current offset
200 X-PAGE-LIMIT integer Current limit
200 X-TOTAL-PAGES integer The total number of pages.
200 X-TOTAL-RECORDS integer The total number of items.

Delete account by {{id}}

Code samples

DELETE https://api.checkhub.io/accounts/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/accounts/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/accounts/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.checkhub.io/accounts/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.checkhub.io/accounts/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /accounts/{id}

Parameters

Name In Type Required Description
id path string true Model id which should be deleted

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful successfullyCompletedRequest

Get account by {{id}}.

Code samples

GET https://api.checkhub.io/accounts/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/accounts/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/accounts/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/accounts/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/accounts/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /accounts/{id}

Parameters

Name In Type Required Description
id path string true Model id which should be founded
includeShared query boolean false To include accounts from the companies of the same company group
includeCandidates query boolean false To include account 'candidates' relation. deprecated
includeWelcomeText query boolean false To include account 'welcomeText' relation
includeAboutText query boolean false To include account 'aboutText' relation
includeCompletedBoxText query boolean false To include account 'completedBoxText' relation
includeCompletedText query boolean false To include account 'completedText' relation

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "name": "Tesla Digital",
  "reference": "ACC_TESLA_DIG_01",
  "welcomeText": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "aboutText": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "completedBoxText": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "completedText": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "candidates": [
    {
      "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "email": "[email protected]",
      "firstName": "James",
      "lastName": "Good",
      "reference": "Best Candidate",
      "language": "en",
      "welcomeText": "Hi John, we are glad to welcome you to the company!",
      "welcomeTextType": "default",
      "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "additionalEmails": [
        "[email protected]"
      ],
      "snoozed": false,
      "mobilePhone": "003801234567890",
      "notes": "Some notes",
      "deadline": "2019-09-12T15:36:09.264Z",
      "createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "status": "pending",
      "token": "2ScQsIW1OPHsjEFRs",
      "archived": false,
      "integrationChanged": false,
      "clientIsMobile": false,
      "clientVersion": "",
      "lastLoggedAt": "2019-09-12T15:36:09.264Z",
      "statusUpdateAt": "2019-09-12T15:36:09.264Z",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Request was successful accountFindByIdResponse

Update account by {{id}}

Code samples

PATCH https://api.checkhub.io/accounts/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "name": "Tesla Digital",
  "reference": "ACC_TESLA_DIG_01",
  "welcomeText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "aboutText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "completedBoxText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "completedText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/accounts/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "name": "Tesla Digital",
  "reference": "ACC_TESLA_DIG_01",
  "welcomeText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "aboutText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "completedBoxText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "completedText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  }
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/accounts/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.patch('https://api.checkhub.io/accounts/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.patch 'https://api.checkhub.io/accounts/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /accounts/{id}

Body parameter

{
  "name": "Tesla Digital",
  "reference": "ACC_TESLA_DIG_01",
  "welcomeText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "aboutText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "completedBoxText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "completedText": {
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  }
}

Parameters

Name In Type Required Description
id path string true Model id which should be updated
name body string false Account name
reference body string false Account reference (unique identifier for the account)
welcomeText body accountWelcomeTextBase false This scheme is a collection of account welcome text for users in different languages.
» en body string(html) false Used for users whose language is "English"
» fr body string(html) false Used for users whose language is "Français"
» nl body string(html) false Used for users whose language is "Nederlands"
» de body string(html) false Used for users whose language is "Deutsch"
» it body string(html) false Used for users whose language is "Italiano"
» pl body string(html) false Used for users whose language is "Polski"
» ro body string(html) false Used for users whose language is "Română"
» sq body string(html) false Used for users whose language is "Shqip"
» be body string(html) false Used for users whose language is "Беларуская"
» bg body string(html) false Used for users whose language is "Български"
» hr body string(html) false Used for users whose language is "Hrvatski"
» cs body string(html) false Used for users whose language is "Čeština"
» da body string(html) false Used for users whose language is "Dansk"
» et body string(html) false Used for users whose language is "Eesti"
» fi body string(html) false Used for users whose language is "Suomi"
» el body string(html) false Used for users whose language is "Ελληνικά"
» hu body string(html) false Used for users whose language is "Magyar"
» is body string(html) false Used for users whose language is "Íslenska"
» ga body string(html) false Used for users whose language is "Gaeilge"
» lv body string(html) false Used for users whose language is "Latviešu"
» lt body string(html) false Used for users whose language is "Lietuvių"
» mk body string(html) false Used for users whose language is "Македонски"
» mt body string(html) false Used for users whose language is "Malti"
» no body string(html) false Used for users whose language is "Norsk"
» pt body string(html) false Used for users whose language is "Português"
» ru body string(html) false Used for users whose language is "Русский"
» sr body string(html) false Used for users whose language is "Српски"
» sk body string(html) false Used for users whose language is "Slovenčina"
» sl body string(html) false Used for users whose language is "Slovenščina"
» es body string(html) false Used for users whose language is "Español"
» sv body string(html) false Used for users whose language is "Svenska"
» uk body string(html) false Used for users whose language is "Українська"
» cy body string(html) false Used for users whose language is "Cymraeg"
aboutText body accountAboutTextBase false This scheme is a collection of account about text for users in different languages.
» en body string(html) false Used for users whose language is "English"
» fr body string(html) false Used for users whose language is "Français"
» nl body string(html) false Used for users whose language is "Nederlands"
» de body string(html) false Used for users whose language is "Deutsch"
» it body string(html) false Used for users whose language is "Italiano"
» pl body string(html) false Used for users whose language is "Polski"
» ro body string(html) false Used for users whose language is "Română"
» sq body string(html) false Used for users whose language is "Shqip"
» be body string(html) false Used for users whose language is "Беларуская"
» bg body string(html) false Used for users whose language is "Български"
» hr body string(html) false Used for users whose language is "Hrvatski"
» cs body string(html) false Used for users whose language is "Čeština"
» da body string(html) false Used for users whose language is "Dansk"
» et body string(html) false Used for users whose language is "Eesti"
» fi body string(html) false Used for users whose language is "Suomi"
» el body string(html) false Used for users whose language is "Ελληνικά"
» hu body string(html) false Used for users whose language is "Magyar"
» is body string(html) false Used for users whose language is "Íslenska"
» ga body string(html) false Used for users whose language is "Gaeilge"
» lv body string(html) false Used for users whose language is "Latviešu"
» lt body string(html) false Used for users whose language is "Lietuvių"
» mk body string(html) false Used for users whose language is "Македонски"
» mt body string(html) false Used for users whose language is "Malti"
» no body string(html) false Used for users whose language is "Norsk"
» pt body string(html) false Used for users whose language is "Português"
» ru body string(html) false Used for users whose language is "Русский"
» sr body string(html) false Used for users whose language is "Српски"
» sk body string(html) false Used for users whose language is "Slovenčina"
» sl body string(html) false Used for users whose language is "Slovenščina"
» es body string(html) false Used for users whose language is "Español"
» sv body string(html) false Used for users whose language is "Svenska"
» uk body string(html) false Used for users whose language is "Українська"
» cy body string(html) false Used for users whose language is "Cymraeg"
completedBoxText body accountCompletedBoxTextBase false This scheme is a collection of account completed box text for users in different languages.
» en body string(html) false Used for users whose language is "English"
» fr body string(html) false Used for users whose language is "Français"
» nl body string(html) false Used for users whose language is "Nederlands"
» de body string(html) false Used for users whose language is "Deutsch"
» it body string(html) false Used for users whose language is "Italiano"
» pl body string(html) false Used for users whose language is "Polski"
» ro body string(html) false Used for users whose language is "Română"
» sq body string(html) false Used for users whose language is "Shqip"
» be body string(html) false Used for users whose language is "Беларуская"
» bg body string(html) false Used for users whose language is "Български"
» hr body string(html) false Used for users whose language is "Hrvatski"
» cs body string(html) false Used for users whose language is "Čeština"
» da body string(html) false Used for users whose language is "Dansk"
» et body string(html) false Used for users whose language is "Eesti"
» fi body string(html) false Used for users whose language is "Suomi"
» el body string(html) false Used for users whose language is "Ελληνικά"
» hu body string(html) false Used for users whose language is "Magyar"
» is body string(html) false Used for users whose language is "Íslenska"
» ga body string(html) false Used for users whose language is "Gaeilge"
» lv body string(html) false Used for users whose language is "Latviešu"
» lt body string(html) false Used for users whose language is "Lietuvių"
» mk body string(html) false Used for users whose language is "Македонски"
» mt body string(html) false Used for users whose language is "Malti"
» no body string(html) false Used for users whose language is "Norsk"
» pt body string(html) false Used for users whose language is "Português"
» ru body string(html) false Used for users whose language is "Русский"
» sr body string(html) false Used for users whose language is "Српски"
» sk body string(html) false Used for users whose language is "Slovenčina"
» sl body string(html) false Used for users whose language is "Slovenščina"
» es body string(html) false Used for users whose language is "Español"
» sv body string(html) false Used for users whose language is "Svenska"
» uk body string(html) false Used for users whose language is "Українська"
» cy body string(html) false Used for users whose language is "Cymraeg"
completedText body accountCompletedTextBase false This scheme is a collection of account completed text for users in different languages.
» en body string(html) false Used for users whose language is "English"
» fr body string(html) false Used for users whose language is "Français"
» nl body string(html) false Used for users whose language is "Nederlands"
» de body string(html) false Used for users whose language is "Deutsch"
» it body string(html) false Used for users whose language is "Italiano"
» pl body string(html) false Used for users whose language is "Polski"
» ro body string(html) false Used for users whose language is "Română"
» sq body string(html) false Used for users whose language is "Shqip"
» be body string(html) false Used for users whose language is "Беларуская"
» bg body string(html) false Used for users whose language is "Български"
» hr body string(html) false Used for users whose language is "Hrvatski"
» cs body string(html) false Used for users whose language is "Čeština"
» da body string(html) false Used for users whose language is "Dansk"
» et body string(html) false Used for users whose language is "Eesti"
» fi body string(html) false Used for users whose language is "Suomi"
» el body string(html) false Used for users whose language is "Ελληνικά"
» hu body string(html) false Used for users whose language is "Magyar"
» is body string(html) false Used for users whose language is "Íslenska"
» ga body string(html) false Used for users whose language is "Gaeilge"
» lv body string(html) false Used for users whose language is "Latviešu"
» lt body string(html) false Used for users whose language is "Lietuvių"
» mk body string(html) false Used for users whose language is "Македонски"
» mt body string(html) false Used for users whose language is "Malti"
» no body string(html) false Used for users whose language is "Norsk"
» pt body string(html) false Used for users whose language is "Português"
» ru body string(html) false Used for users whose language is "Русский"
» sr body string(html) false Used for users whose language is "Српски"
» sk body string(html) false Used for users whose language is "Slovenčina"
» sl body string(html) false Used for users whose language is "Slovenščina"
» es body string(html) false Used for users whose language is "Español"
» sv body string(html) false Used for users whose language is "Svenska"
» uk body string(html) false Used for users whose language is "Українська"
» cy body string(html) false Used for users whose language is "Cymraeg"

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "name": "Tesla Digital",
  "reference": "ACC_TESLA_DIG_01",
  "welcomeText": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "aboutText": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "completedBoxText": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "completedText": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "en": "<p>English</p>",
    "fr": "<p>Français</p>",
    "nl": "<p>Nederlands</p>",
    "de": "<p>Deutsch</p>",
    "it": "<p>Italiano</p>",
    "pl": "<p>Polski</p>",
    "ro": "<p>Română</p>",
    "sq": "<p>Shqip</p>",
    "be": "<p>Беларуская</p>",
    "bg": "<p>Български</p>",
    "hr": "<p>Hrvatski</p>",
    "cs": "<p>Čeština</p>",
    "da": "<p>Dansk</p>",
    "et": "<p>Eesti</p>",
    "fi": "<p>Suomi</p>",
    "el": "<p>Ελληνικά</p>",
    "hu": "<p>Magyar</p>",
    "is": "<p>Íslenska</p>",
    "ga": "<p>Gaeilge</p>",
    "lv": "<p>Latviešu</p>",
    "lt": "<p>Lietuvių</p>",
    "mk": "<p>Македонски</p>",
    "mt": "<p>Malti</p>",
    "no": "<p>Norsk</p>",
    "pt": "<p>Português</p>",
    "ru": "<p>Русский</p>",
    "sr": "<p>Српски</p>",
    "sk": "<p>Slovenčina</p>",
    "sl": "<p>Slovenščina</p>",
    "es": "<p>Español</p>",
    "sv": "<p>Svenska</p>",
    "uk": "<p>Українська</p>",
    "cy": "<p>Cymraeg</p>"
  },
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z"
}

Responses

Status Meaning Description Schema
200 OK Request was successful account

Admin User

Get admin user collection

Code samples

GET https://api.checkhub.io/adminUsers HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/adminUsers', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/adminUsers',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /adminUsers

Parameters

Name In Type Required Description
limit query number false Maximum number of items in the response. min: 1, max: 100, default: 10
skip query number false Number of items skipped during the selection. min: 0, default: 0
filter[name] query string false Search by admin user firstName, lastName, email
filter[languages][] query string false Search by admin language (or)
includeSignature query boolean false To include admin user 'signature' relation
includeSignatureOriginal query boolean false To include admin user 'signature' relation 'original' relation
includeSignatureBlack query boolean false To include admin user 'signature' relation 'black' relation
includeSignatureWhite query boolean false To include admin user 'signature' relation 'white' relation
includeCompany query boolean false To include admin user 'company' relation

Enumerated Values

Parameter Value
filter[languages][] en
filter[languages][] fr
filter[languages][] nl
filter[languages][] de
filter[languages][] it
filter[languages][] pl
filter[languages][] ro
filter[languages][] sq
filter[languages][] be
filter[languages][] bg
filter[languages][] hr
filter[languages][] cs
filter[languages][] da
filter[languages][] et
filter[languages][] fi
filter[languages][] el
filter[languages][] hu
filter[languages][] is
filter[languages][] ga
filter[languages][] lv
filter[languages][] lt
filter[languages][] mk
filter[languages][] mt
filter[languages][] no
filter[languages][] pt
filter[languages][] ru
filter[languages][] sr
filter[languages][] sk
filter[languages][] sl
filter[languages][] es
filter[languages][] sv
filter[languages][] uk
filter[languages][] cy

Example responses

200 Response

[
  {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "lastActivityAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "gender": "female",
    "firstName": "James",
    "lastName": "Good",
    "email": "[email protected]",
    "phone": "+32 0x xxx xx xx",
    "position": "Manager",
    "language": "en",
    "forceChangePassword": false,
    "isOwner": false,
    "company": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "",
      "zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
      "replyToEmail": "[email protected]",
      "archiveInactiveCandidateAfterDays": 7,
      "deleteInactiveCandidateAfterDays": 7,
      "logo": "",
      "languages": [
        "en",
        "fr",
        "nl",
        "de",
        "it",
        "pl",
        "ro",
        "sq",
        "be",
        "bg",
        "hr",
        "cs",
        "da",
        "et",
        "fi",
        "el",
        "hu",
        "is",
        "ga",
        "lv",
        "lt",
        "mk",
        "mt",
        "no",
        "pt",
        "ru",
        "sr",
        "sk",
        "sl",
        "es",
        "sv",
        "uk",
        "cy"
      ],
      "fileBoxCss": ".custom {color: red;}",
      "largeDocumentThumbnail": false,
      "isMultipleUploadEnabled": true,
      "maxNumberOfFilesPerDocument": 20,
      "isCandidateConversationEnabled": false,
      "locale": {
        "key": "Belgium_nl",
        "country": "Belgium",
        "lang": "nl",
        "dateFormat": "D/MM/YYYY",
        "code": "BE",
        "phoneCode": "32"
      }
    },
    "viewSettings": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "candidateVisibleColumns": [
        "default_status",
        "default_candidate"
      ],
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z"
    },
    "signature": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z",
      "type": "upload",
      "originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
    }
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful adminUserFindResponse

Response Headers

Status Header Type Format Description
200 X-CURRENT-PAGE integer Current page
200 X-PAGE-OFFSET integer Current offset
200 X-PAGE-LIMIT integer Current limit
200 X-TOTAL-PAGES integer The total number of pages.
200 X-TOTAL-RECORDS integer The total number of items.

Create new admin user

Code samples

POST https://api.checkhub.io/adminUsers HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "gender": "female",
  "firstName": "James",
  "lastName": "Good",
  "email": "[email protected]",
  "phone": "+32 0x xxx xx xx",
  "position": "Manager",
  "language": "en",
  "forceChangePassword": false,
  "isOwner": false,
  "password": "6kgiWMzhKD0IPzRS"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "gender": "female",
  "firstName": "James",
  "lastName": "Good",
  "email": "[email protected]",
  "phone": "+32 0x xxx xx xx",
  "position": "Manager",
  "language": "en",
  "forceChangePassword": false,
  "isOwner": false,
  "password": "6kgiWMzhKD0IPzRS"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.checkhub.io/adminUsers', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.checkhub.io/adminUsers',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /adminUsers

Body parameter

{
  "gender": "female",
  "firstName": "James",
  "lastName": "Good",
  "email": "[email protected]",
  "phone": "+32 0x xxx xx xx",
  "position": "Manager",
  "language": "en",
  "forceChangePassword": false,
  "isOwner": false,
  "password": "6kgiWMzhKD0IPzRS"
}

Parameters

Name In Type Required Description
gender body adminUserGender false Admin User Gender
firstName body string true Admin User First Name
lastName body string true Admin User Last Name
email body string true Admin User Email address
phone body string false Admin User Phone
position body string false Admin User Position
language body adminUserLanguage false Admin User language
forceChangePassword body boolean false Enable password force change
isOwner body boolean false Is owner of company
password body string true Admin User Password

Enumerated Values

Parameter Value
gender
gender male
gender female
language en
language fr
language nl
language de
language it
language pl
language ro
language sq
language be
language bg
language hr
language cs
language da
language et
language fi
language el
language hu
language is
language ga
language lv
language lt
language mk
language mt
language no
language pt
language ru
language sr
language sk
language sl
language es
language sv
language uk
language cy

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "lastActivityAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "gender": "female",
  "firstName": "James",
  "lastName": "Good",
  "email": "[email protected]",
  "phone": "+32 0x xxx xx xx",
  "position": "Manager",
  "language": "en",
  "forceChangePassword": false,
  "isOwner": false
}

Responses

Status Meaning Description Schema
200 OK Request was successful adminUser

Get admin user by {{id}}

Code samples

GET https://api.checkhub.io/adminUsers/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/adminUsers/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/adminUsers/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /adminUsers/{id}

Parameters

Name In Type Required Description
id path string true Model id which should be founded
includeSignature query boolean false To include admin user 'signature' relation
includeSignatureOriginal query boolean false To include admin user 'signature' relation 'original' relation
includeSignatureBlack query boolean false To include admin user 'signature' relation 'black' relation
includeSignatureWhite query boolean false To include admin user 'signature' relation 'white' relation
includeCompany query boolean false To include admin user 'company' relation

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "lastActivityAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "gender": "female",
  "firstName": "James",
  "lastName": "Good",
  "email": "[email protected]",
  "phone": "+32 0x xxx xx xx",
  "position": "Manager",
  "language": "en",
  "forceChangePassword": false,
  "isOwner": false,
  "company": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "name": "",
    "zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
    "replyToEmail": "[email protected]",
    "archiveInactiveCandidateAfterDays": 7,
    "deleteInactiveCandidateAfterDays": 7,
    "logo": "",
    "languages": [
      "en",
      "fr",
      "nl",
      "de",
      "it",
      "pl",
      "ro",
      "sq",
      "be",
      "bg",
      "hr",
      "cs",
      "da",
      "et",
      "fi",
      "el",
      "hu",
      "is",
      "ga",
      "lv",
      "lt",
      "mk",
      "mt",
      "no",
      "pt",
      "ru",
      "sr",
      "sk",
      "sl",
      "es",
      "sv",
      "uk",
      "cy"
    ],
    "fileBoxCss": ".custom {color: red;}",
    "largeDocumentThumbnail": false,
    "isMultipleUploadEnabled": true,
    "maxNumberOfFilesPerDocument": 20,
    "isCandidateConversationEnabled": false,
    "locale": {
      "key": "Belgium_nl",
      "country": "Belgium",
      "lang": "nl",
      "dateFormat": "D/MM/YYYY",
      "code": "BE",
      "phoneCode": "32"
    }
  },
  "viewSettings": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "candidateVisibleColumns": [
      "default_status",
      "default_candidate"
    ],
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z"
  },
  "signature": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "type": "upload",
    "originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  }
}

Responses

Status Meaning Description Schema
200 OK Request was successful adminUserFindByIdResponse

Update admin user by id

Code samples

PATCH https://api.checkhub.io/adminUsers/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "gender": "female",
  "firstName": "James",
  "lastName": "Good",
  "email": "[email protected]",
  "phone": "+32 0x xxx xx xx",
  "position": "Manager",
  "language": "en",
  "forceChangePassword": false,
  "isOwner": false,
  "newPassword": "6kgiWMzhKD0IPzRS"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "gender": "female",
  "firstName": "James",
  "lastName": "Good",
  "email": "[email protected]",
  "phone": "+32 0x xxx xx xx",
  "position": "Manager",
  "language": "en",
  "forceChangePassword": false,
  "isOwner": false,
  "newPassword": "6kgiWMzhKD0IPzRS"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.patch('https://api.checkhub.io/adminUsers/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.patch 'https://api.checkhub.io/adminUsers/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /adminUsers/{id}

Body parameter

{
  "gender": "female",
  "firstName": "James",
  "lastName": "Good",
  "email": "[email protected]",
  "phone": "+32 0x xxx xx xx",
  "position": "Manager",
  "language": "en",
  "forceChangePassword": false,
  "isOwner": false,
  "newPassword": "6kgiWMzhKD0IPzRS"
}

Parameters

Name In Type Required Description
id path string true Model id which should be updated
gender body adminUserGender false Admin User Gender
firstName body string false Admin User First Name
lastName body string false Admin User Last Name
email body string false Admin User Email address
phone body string false Admin User Phone
position body string false Admin User Position
language body adminUserLanguage false Admin User language
forceChangePassword body boolean false Enable password force change
isOwner body boolean false Is owner of company
newPassword body string false New password for the user

Enumerated Values

Parameter Value
gender
gender male
gender female
language en
language fr
language nl
language de
language it
language pl
language ro
language sq
language be
language bg
language hr
language cs
language da
language et
language fi
language el
language hu
language is
language ga
language lv
language lt
language mk
language mt
language no
language pt
language ru
language sr
language sk
language sl
language es
language sv
language uk
language cy

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "lastActivityAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "gender": "female",
  "firstName": "James",
  "lastName": "Good",
  "email": "[email protected]",
  "phone": "+32 0x xxx xx xx",
  "position": "Manager",
  "language": "en",
  "forceChangePassword": false,
  "isOwner": false
}

Responses

Status Meaning Description Schema
200 OK Request was successful adminUser

Delete admin user by id

Code samples

DELETE https://api.checkhub.io/adminUsers/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.checkhub.io/adminUsers/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.checkhub.io/adminUsers/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /adminUsers/{id}

Parameters

Name In Type Required Description
id path string true Model id which should be deleted

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful successfullyCompletedRequest

Get access token for admin user

Code samples

POST https://api.checkhub.io/adminUsers/login HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "email": "[email protected]",
  "password": "eTmESlA3000"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers/login',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "email": "[email protected]",
  "password": "eTmESlA3000"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers/login',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.checkhub.io/adminUsers/login', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.checkhub.io/adminUsers/login',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /adminUsers/login

Body parameter

{
  "email": "[email protected]",
  "password": "eTmESlA3000"
}

Parameters

Name In Type Required Description
email body string false Admin user email
password body string false Admin user password

Example responses

200 Response

{
  "id": "TDzlHHx590XulC7KygP4MIo6BQGg2QKMO3UvEvwEtNssGISZ43FrRUmt2XzbxkOY",
  "ttl": 43200,
  "created": "2019-09-12T15:36:09.264Z",
  "userId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}

Responses

Status Meaning Description Schema
200 OK Request was successful accessToken

Delete access token for current admin user

Code samples

POST https://api.checkhub.io/adminUsers/logout HTTP/1.1
Host: api.checkhub.io



const headers = {
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers/logout',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers/logout',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.checkhub.io/adminUsers/logout', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.checkhub.io/adminUsers/logout',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /adminUsers/logout

Responses

Status Meaning Description Schema
204 No Content Request was successful None

Get current admin user info

Code samples

GET https://api.checkhub.io/adminUsers/me/info HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers/me/info',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers/me/info',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/adminUsers/me/info', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/adminUsers/me/info',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /adminUsers/me/info

Parameters

Name In Type Required Description
includeAcl query boolean false To include admin user info 'acl' with allowed acl settings

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "lastActivityAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "gender": "female",
  "firstName": "James",
  "lastName": "Good",
  "email": "[email protected]",
  "phone": "+32 0x xxx xx xx",
  "position": "Manager",
  "language": "en",
  "forceChangePassword": false,
  "isOwner": false,
  "elevioUserHash": "828caxxxxxxx4cdde",
  "elevioGroups": [],
  "elevioTraits": [],
  "acl": {
    "conditions": [
      {
        "acl": {
          "accountIds": [
            "string"
          ],
          "isAllAccounts": true,
          "availableTagIds": [
            "string"
          ],
          "isAllAvailableTags": true,
          "restrictedTagIds": [
            "string"
          ],
          "restrictedTagsCondition": "or",
          "isAllRestrictedTags": true,
          "rights": [
            "candidateCreate",
            "candidateView"
          ]
        }
      }
    ],
    "rights": [
      "candidateCreate",
      "candidateView"
    ]
  },
  "company": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "name": "",
    "zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
    "replyToEmail": "[email protected]",
    "archiveInactiveCandidateAfterDays": 7,
    "deleteInactiveCandidateAfterDays": 7,
    "logo": "",
    "languages": [
      "en",
      "fr",
      "nl",
      "de",
      "it",
      "pl",
      "ro",
      "sq",
      "be",
      "bg",
      "hr",
      "cs",
      "da",
      "et",
      "fi",
      "el",
      "hu",
      "is",
      "ga",
      "lv",
      "lt",
      "mk",
      "mt",
      "no",
      "pt",
      "ru",
      "sr",
      "sk",
      "sl",
      "es",
      "sv",
      "uk",
      "cy"
    ],
    "fileBoxCss": ".custom {color: red;}",
    "largeDocumentThumbnail": false,
    "isMultipleUploadEnabled": true,
    "maxNumberOfFilesPerDocument": 20,
    "isCandidateConversationEnabled": false,
    "locale": {
      "key": "Belgium_nl",
      "country": "Belgium",
      "lang": "nl",
      "dateFormat": "D/MM/YYYY",
      "code": "BE",
      "phoneCode": "32"
    }
  },
  "viewSettings": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "candidateVisibleColumns": [
      "default_status",
      "default_candidate"
    ],
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z"
  },
  "signature": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "type": "upload",
    "originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  }
}

Responses

Status Meaning Description Schema
200 OK Request was successful adminUserGetInfoResponse

Change admin user password

Code samples

PUT https://api.checkhub.io/adminUsers/me/change-password HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "password": "1xzoJz1mGIMplacy",
  "newPassword": "MxUVl7a3iPyuWR4s",
  "confirmPassword": "MxUVl7a3iPyuWR4s"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers/me/change-password',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "password": "1xzoJz1mGIMplacy",
  "newPassword": "MxUVl7a3iPyuWR4s",
  "confirmPassword": "MxUVl7a3iPyuWR4s"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers/me/change-password',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.put('https://api.checkhub.io/adminUsers/me/change-password', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.put 'https://api.checkhub.io/adminUsers/me/change-password',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /adminUsers/me/change-password

Body parameter

{
  "password": "1xzoJz1mGIMplacy",
  "newPassword": "MxUVl7a3iPyuWR4s",
  "confirmPassword": "MxUVl7a3iPyuWR4s"
}

Parameters

Name In Type Required Description
password body string false Current password
newPassword body string false New password
confirmPassword body string false Confirm new password

Example responses

200 Response

{
  "isPasswordChanged": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful adminUserChangePasswordResponse

Check uniqueness of the email

Code samples

POST https://api.checkhub.io/adminUsers/checkEmail HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "email": "[email protected]",
  "ownId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers/checkEmail',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "email": "[email protected]",
  "ownId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers/checkEmail',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.checkhub.io/adminUsers/checkEmail', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.checkhub.io/adminUsers/checkEmail',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /adminUsers/checkEmail

Body parameter

{
  "email": "[email protected]",
  "ownId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}

Parameters

Name In Type Required Description
email body string true Email to check
ownId body UUID_V4 false Unique identifier for the entity

Example responses

200 Response

{
  "isUnique": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful adminUserCheckEmailResponse

Admin User Signature

Get admin user signature collection

Code samples

GET https://api.checkhub.io/admin-user-signatures HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/admin-user-signatures',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/admin-user-signatures',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/admin-user-signatures', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/admin-user-signatures',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /admin-user-signatures

Parameters

Name In Type Required Description
limit query number false Maximum number of items in the response. min: 1, max: 100, default: 10
skip query number false Number of items skipped during the selection. min: 0, default: 0
order query string false Admin User Signature collection order
filter[adminUserId] query UUID_V4 false Search by admin user signature adminUserId
includeOriginal query boolean false To include admin user signature 'original' relation
includeBlack query boolean false To include admin user signature 'black' relation
includeWhite query boolean false To include admin user signature 'white' relation

Enumerated Values

Parameter Value
order createdAt asc
order createdAt desc
order updatedAt asc
order updatedAt desc

Example responses

200 Response

[
  {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "type": "upload",
    "originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "original": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "checksum": "File checksum",
      "name": "File name",
      "ext": ".jpeg",
      "type": "image/jpeg",
      "size": "image/jpeg",
      "storage": "internal",
      "key": "",
      "url": "",
      "isPublic": false
    },
    "black": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "checksum": "File checksum",
      "name": "File name",
      "ext": ".jpeg",
      "type": "image/jpeg",
      "size": "image/jpeg",
      "storage": "internal",
      "key": "",
      "url": "",
      "isPublic": false
    },
    "white": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "checksum": "File checksum",
      "name": "File name",
      "ext": ".jpeg",
      "type": "image/jpeg",
      "size": "image/jpeg",
      "storage": "internal",
      "key": "",
      "url": "",
      "isPublic": false
    }
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful adminUserSignatureFindResponse

Response Headers

Status Header Type Format Description
200 X-CURRENT-PAGE integer Current page
200 X-PAGE-OFFSET integer Current offset
200 X-PAGE-LIMIT integer Current limit
200 X-TOTAL-PAGES integer The total number of pages.
200 X-TOTAL-RECORDS integer The total number of items.

Get admin user signature by {{id}}

Code samples

GET https://api.checkhub.io/admin-user-signatures/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/admin-user-signatures/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/admin-user-signatures/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/admin-user-signatures/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/admin-user-signatures/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /admin-user-signatures/{id}

Parameters

Name In Type Required Description
id path string true Model id which should be founded
includeOriginal query boolean false To include admin user signature 'original' relation
includeBlack query boolean false To include admin user signature 'black' relation
includeWhite query boolean false To include admin user signature 'white' relation

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "type": "upload",
  "originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "original": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "checksum": "File checksum",
    "name": "File name",
    "ext": ".jpeg",
    "type": "image/jpeg",
    "size": "image/jpeg",
    "storage": "internal",
    "key": "",
    "url": "",
    "isPublic": false
  },
  "black": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "checksum": "File checksum",
    "name": "File name",
    "ext": ".jpeg",
    "type": "image/jpeg",
    "size": "image/jpeg",
    "storage": "internal",
    "key": "",
    "url": "",
    "isPublic": false
  },
  "white": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "checksum": "File checksum",
    "name": "File name",
    "ext": ".jpeg",
    "type": "image/jpeg",
    "size": "image/jpeg",
    "storage": "internal",
    "key": "",
    "url": "",
    "isPublic": false
  }
}

Responses

Status Meaning Description Schema
200 OK Request was successful adminUserSignatureFindByIdResponse

Update admin user signature by id

Code samples

PATCH https://api.checkhub.io/admin-user-signatures/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "type": "upload",
  "originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/admin-user-signatures/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "type": "upload",
  "originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/admin-user-signatures/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.patch('https://api.checkhub.io/admin-user-signatures/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.patch 'https://api.checkhub.io/admin-user-signatures/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /admin-user-signatures/{id}

Body parameter

{
  "type": "upload",
  "originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}

Parameters

Name In Type Required Description
id path string true Model id which should be updated
type body string false Signature type
originalId body UUID_V4 false Unique identifier for the entity
blackId body UUID_V4 false Unique identifier for the entity
whiteId body UUID_V4 false Unique identifier for the entity

Enumerated Values

Parameter Value
type draw
type upload

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "type": "upload",
  "originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}

Responses

Status Meaning Description Schema
200 OK Request was successful adminUserSignature

Admin User Group

Get admin user group collection

Code samples

GET https://api.checkhub.io/adminUserGroups HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUserGroups',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUserGroups',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/adminUserGroups', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/adminUserGroups',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /adminUserGroups

Parameters

Name In Type Required Description
limit query number false Maximum number of items in the response. min: 1, max: 100, default: 10
skip query number false Number of items skipped during the selection. min: 0, default: 0
order query string false Admin user group collection order
filter[name] query string false Search by admin user group name
includeRestrictedTags query boolean false To include admin user group 'restrictedTags' relation
includeRestrictedTagsTag query boolean false To include admin user group 'restrictedTags' relation with embedded 'tag' relation
includeAvailableTags query boolean false To include admin user group 'availableTags' relation
includeAvailableTagsTag query boolean false To include admin user group 'availableTags' relation with embedded 'tag' relation

Enumerated Values

Parameter Value
order name asc
order name desc
order createdAt asc
order createdAt desc

Example responses

200 Response

[
  {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "isMain": false,
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "name": "First-line managers",
    "adminUsers": [
      "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
    ],
    "adminUserRights": [
      "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
    ],
    "accounts": [
      "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
    ],
    "isAllAccounts": false,
    "restrictedTagsCondition": "or",
    "availableTags": [
      {
        "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "adminUserGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "createdAt": "2019-09-12T15:36:09.264Z",
        "updatedAt": "2019-09-12T15:36:09.264Z"
      }
    ],
    "restrictedTags": [
      {
        "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "adminUserGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "createdAt": "2019-09-12T15:36:09.264Z",
        "updatedAt": "2019-09-12T15:36:09.264Z"
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful adminUserGroupFindResponse

Response Headers

Status Header Type Format Description
200 X-CURRENT-PAGE integer Current page
200 X-PAGE-OFFSET integer Current offset
200 X-PAGE-LIMIT integer Current limit
200 X-TOTAL-PAGES integer The total number of pages.
200 X-TOTAL-RECORDS integer The total number of items.

Create new admin user group

Code samples

POST https://api.checkhub.io/adminUserGroups HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "name": "First-line managers",
  "adminUsers": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "adminUserRights": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "accounts": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "isAllAccounts": false,
  "restrictedTagsCondition": "or",
  "availableTags": [],
  "restrictedTags": []
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUserGroups',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "name": "First-line managers",
  "adminUsers": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "adminUserRights": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "accounts": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "isAllAccounts": false,
  "restrictedTagsCondition": "or",
  "availableTags": [],
  "restrictedTags": []
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUserGroups',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.checkhub.io/adminUserGroups', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.checkhub.io/adminUserGroups',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /adminUserGroups

Body parameter

{
  "name": "First-line managers",
  "adminUsers": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "adminUserRights": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "accounts": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "isAllAccounts": false,
  "restrictedTagsCondition": "or",
  "availableTags": [],
  "restrictedTags": []
}

Parameters

Name In Type Required Description
name body string true Admin user group name
adminUsers body [UUID_V4] false Array of admin users ids related to this group
adminUserRights body [UUID_V4] true Array of admin user rights related to this group
accounts body [UUID_V4] false Array of accounts for which admin users have access and the specified rights apply.
isAllAccounts body boolean false Admin users in this group will have the assigned rights for all company accounts.
restrictedTagsCondition body adminUserGroupRestrictedTagsCondition false none
availableTags body [UUID_V4] false Array of tag ids
restrictedTags body [UUID_V4] false Array of tag ids

Enumerated Values

Parameter Value
restrictedTagsCondition or
restrictedTagsCondition and

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "isMain": false,
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "name": "First-line managers",
  "adminUsers": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "adminUserRights": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "accounts": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "isAllAccounts": false,
  "restrictedTagsCondition": "or"
}

Responses

Status Meaning Description Schema
200 OK Request was successful adminUserGroup

Get admin user group by {{id}}

Code samples

GET https://api.checkhub.io/adminUserGroups/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/adminUserGroups/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/adminUserGroups/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /adminUserGroups/{id}

Parameters

Name In Type Required Description
id path string true Model id which should be founded
includeRestrictedTags query boolean false To include admin user group 'restrictedTags' relation
includeRestrictedTagsTag query boolean false To include admin user group 'restrictedTags' relation with embedded 'tag' relation
includeAvailableTags query boolean false To include admin user group 'availableTags' relation
includeAvailableTagsTag query boolean false To include admin user group 'availableTags' relation with embedded 'tag' relation

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "isMain": false,
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "name": "First-line managers",
  "adminUsers": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "adminUserRights": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "accounts": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "isAllAccounts": false,
  "restrictedTagsCondition": "or",
  "availableTags": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "adminUserGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z"
    }
  ],
  "restrictedTags": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "adminUserGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Request was successful adminUserGroupFindByIdResponse

Update admin user group by id

Code samples

PATCH https://api.checkhub.io/adminUserGroups/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "name": "First-line managers",
  "adminUsers": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "adminUserRights": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "accounts": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "isAllAccounts": false,
  "restrictedTagsCondition": "or",
  "availableTags": [],
  "restrictedTags": []
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "name": "First-line managers",
  "adminUsers": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "adminUserRights": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "accounts": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "isAllAccounts": false,
  "restrictedTagsCondition": "or",
  "availableTags": [],
  "restrictedTags": []
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.patch('https://api.checkhub.io/adminUserGroups/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.patch 'https://api.checkhub.io/adminUserGroups/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /adminUserGroups/{id}

Body parameter

{
  "name": "First-line managers",
  "adminUsers": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "adminUserRights": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "accounts": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "isAllAccounts": false,
  "restrictedTagsCondition": "or",
  "availableTags": [],
  "restrictedTags": []
}

Parameters

Name In Type Required Description
id path string true Model id which should be updated
name body string false Admin user group name
adminUsers body [UUID_V4] false Array of admin users ids related to this group
adminUserRights body [UUID_V4] false Array of admin user rights related to this group
accounts body [UUID_V4] false Array of accounts for which admin users have access and the specified rights apply.
isAllAccounts body boolean false Admin users in this group will have the assigned rights for all company accounts.
restrictedTagsCondition body adminUserGroupRestrictedTagsCondition false none
availableTags body [UUID_V4] false Array of tag ids
restrictedTags body [UUID_V4] false Array of tag ids

Enumerated Values

Parameter Value
restrictedTagsCondition or
restrictedTagsCondition and

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "isMain": false,
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "name": "First-line managers",
  "adminUsers": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "adminUserRights": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "accounts": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "isAllAccounts": false,
  "restrictedTagsCondition": "or"
}

Responses

Status Meaning Description Schema
200 OK Request was successful adminUserGroup

Delete admin user group by id

Code samples

DELETE https://api.checkhub.io/adminUserGroups/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.checkhub.io/adminUserGroups/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.checkhub.io/adminUserGroups/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /adminUserGroups/{id}

Parameters

Name In Type Required Description
id path string true Model id which should be deleted

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful successfullyCompletedRequest

Admin User Right

Get admin user right collection

Code samples

GET https://api.checkhub.io/adminUserRights HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUserRights',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUserRights',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/adminUserRights', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/adminUserRights',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /adminUserRights

Parameters

Name In Type Required Description
limit query number false Maximum number of items in the response. min: 1, max: 100, default: 10
skip query number false Number of items skipped during the selection. min: 0, default: 0
order query string false Admin user right collection order
filter[name] query string false Search by admin user right name
filter[label] query string false Search by admin user right label
filter[searchText] query string false Search by admin user right label/name free text

Enumerated Values

Parameter Value
order name asc
order name desc
order label asc
order label desc
filter[name] accountManagement
filter[name] candidateCreate
filter[name] candidateDelete
filter[name] candidateEdit
filter[name] candidateImport
filter[name] candidateView
filter[name] companySettings
filter[name] customFieldManagement
filter[name] documentTypeManagement
filter[name] documentTypeValidationManagement
filter[name] mergeSetManagement
filter[name] notificationManagement
filter[name] policiesManagement
filter[name] presetManagement
filter[name] resourceManagement
filter[name] superAdmin
filter[name] tagManagement
filter[name] themeManagement
filter[name] userCreate
filter[name] userGroupManagement
filter[name] userResetPassword
filter[name] formManagement
filter[name] signatureManagement
filter[name] registrationPageManagement

Example responses

200 Response

[
  {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "name": "notificationManagement",
    "label": "Access to Notification Management"
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful adminUserRightFindResponse

Response Headers

Status Header Type Format Description
200 X-CURRENT-PAGE integer Current page
200 X-PAGE-OFFSET integer Current offset
200 X-PAGE-LIMIT integer Current limit
200 X-TOTAL-PAGES integer The total number of pages.
200 X-TOTAL-RECORDS integer The total number of items.

Get admin user right by {{id}}

Code samples

GET https://api.checkhub.io/adminUserRights/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUserRights/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUserRights/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/adminUserRights/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/adminUserRights/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /adminUserRights/{id}

Parameters

Name In Type Required Description
id path string true Model id which should be founded

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "name": "notificationManagement",
  "label": "Access to Notification Management"
}

Responses

Status Meaning Description Schema
200 OK Request was successful adminUserRightFindByIdResponse

Candidate

Create a new Candidate.

Code samples

POST https://api.checkhub.io/candidates HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "email": "[email protected]",
  "firstName": "James",
  "lastName": "Good",
  "reference": "Best Candidate",
  "language": "en",
  "welcomeText": "Hi John, we are glad to welcome you to the company!",
  "welcomeTextType": "default",
  "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "additionalEmails": [
    "[email protected]"
  ],
  "snoozed": false,
  "mobilePhone": "+3801234567890",
  "notes": "Some notes",
  "deadline": "2019-09-12T15:36:09.264Z",
  "customFields": [
    {
      "customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "value": "custom_value"
    }
  ],
  "tagIds": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "presetIds": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "presetReferences": [
    "preset_ref_1",
    "preset_ref_2"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "email": "[email protected]",
  "firstName": "James",
  "lastName": "Good",
  "reference": "Best Candidate",
  "language": "en",
  "welcomeText": "Hi John, we are glad to welcome you to the company!",
  "welcomeTextType": "default",
  "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "additionalEmails": [
    "[email protected]"
  ],
  "snoozed": false,
  "mobilePhone": "+3801234567890",
  "notes": "Some notes",
  "deadline": "2019-09-12T15:36:09.264Z",
  "customFields": [
    {
      "customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "value": "custom_value"
    }
  ],
  "tagIds": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "presetIds": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "presetReferences": [
    "preset_ref_1",
    "preset_ref_2"
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.checkhub.io/candidates', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.checkhub.io/candidates',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /candidates

Body parameter

{
  "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "email": "[email protected]",
  "firstName": "James",
  "lastName": "Good",
  "reference": "Best Candidate",
  "language": "en",
  "welcomeText": "Hi John, we are glad to welcome you to the company!",
  "welcomeTextType": "default",
  "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "additionalEmails": [
    "[email protected]"
  ],
  "snoozed": false,
  "mobilePhone": "+3801234567890",
  "notes": "Some notes",
  "deadline": "2019-09-12T15:36:09.264Z",
  "customFields": [
    {
      "customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "value": "custom_value"
    }
  ],
  "tagIds": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "presetIds": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "presetReferences": [
    "preset_ref_1",
    "preset_ref_2"
  ]
}

Parameters

Name In Type Required Description
accountId body UUID_V4 true Unique identifier for the entity
email body string true Candidate Email address
firstName body string true User First Name
lastName body string true User Last Name
reference body string false Candidate reference
language body language true none
welcomeText body string false Welcome text for the candidate. (only if type 'custom' is selected)
welcomeTextType body string false Welcome text type
assigneeId body UUID_V4 false Unique identifier for the entity
additionalEmails body [string] false Candidate additional emails. Not more than 5 emails
snoozed body boolean false Turns off future notifications (email and SMS) to this candidate
mobilePhone body string false User mobile phone number in the international format
notes body string false Candidate additional notes
deadline body DateISO(date-time) false Datetime in ISO format
customFields body [candidateCreateCustomField] false Custom fields that will be applied to the candidate during creation.
» customFieldId body UUID_V4 false Unique identifier for the entity
» value body string false Custom field value
tagIds body [UUID_V4] false Tags that will be applied to the candidate during creation.
presetIds body [UUID_V4] false Candidate preset ids
presetReferences body [string] false Candidate preset references

Enumerated Values

Parameter Value
language en
language fr
language nl
language de
language it
language pl
language ro
language sq
language be
language bg
language hr
language cs
language da
language et
language fi
language el
language hu
language is
language ga
language lv
language lt
language mk
language mt
language no
language pt
language ru
language sr
language sk
language sl
language es
language sv
language uk
language cy
welcomeTextType default
welcomeTextType custom
welcomeTextType none

Example responses

200 Response

{
  "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "email": "[email protected]",
  "firstName": "James",
  "lastName": "Good",
  "reference": "Best Candidate",
  "language": "en",
  "welcomeText": "Hi John, we are glad to welcome you to the company!",
  "welcomeTextType": "default",
  "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "additionalEmails": [
    "[email protected]"
  ],
  "snoozed": false,
  "mobilePhone": "003801234567890",
  "notes": "Some notes",
  "deadline": "2019-09-12T15:36:09.264Z",
  "createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "status": "pending",
  "token": "2ScQsIW1OPHsjEFRs",
  "archived": false,
  "integrationChanged": false,
  "clientIsMobile": false,
  "clientVersion": "",
  "lastLoggedAt": "2019-09-12T15:36:09.264Z",
  "statusUpdateAt": "2019-09-12T15:36:09.264Z",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z"
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidate

Get candidates collection matched by query params.

Code samples

GET https://api.checkhub.io/candidates HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/candidates', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/candidates',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /candidates

Parameters

Name In Type Required Description
limit query number false Maximum number of items in the response. min: 1, max: 100, default: 10
skip query number false Number of items skipped during the selection. min: 0, default: 0
order query string false Candidates order
filter[reference] query string false Filter by candidate 'reference' field
filter[references][] query string false Filter result by candidate references (or)
filter[firstName] query string false Filter by candidate 'firstName' field
filter[lastName] query string false Filter by candidate 'lastName' field
filter[archived] query boolean false Filter by candidate 'archived' field
filter[accountId] query UUID_V4 false Filter by candidate 'accountId' field
filter[tagIds][] query UUID_V4 false Filter by candidate related tag ids
filter[withoutTagIds][] query UUID_V4 false Filter by candidate without tag ids
filter[searchText] query string false Search result by following properties: ('email', 'firstName', 'lastName', 'notes', 'reference', 'candidateCustomField.value')
filter[statuses][] query candidateStatus false Filter result by custom statuses (or)
filter[comments] query candidateCommentsFilter false Filter result by comments
filter[assigneeId] query UUID_V4 false Filter by candidate 'assigneeId' field
filter[isAssigned] query boolean false Filter by 'isAssigned' candidate
includeAccount query boolean false You can include candidate 'account' relation
includeUser query boolean false You can include candidate 'user' relation
includeChecks query boolean false You can include candidate 'checks' relation
includeDocumentStatistic query boolean false You can include candidate 'documentStatistic' relation
includeCandidateDocumentTypes query boolean false You can include candidate 'candidateDocumentTypes' relation
includeResources query boolean false You can include candidate 'resources' relation
includeForms query boolean false You can include candidate 'forms' relation
includeFormsData query boolean false You can include candidate forms with included form 'data' relation
includeFormsAdditions query boolean false You can include candidate forms with included form 'additions' relation
includeFormsAdditionsData query boolean false You can include candidate forms additions with included addition 'data' relation
includeFormsAdditionsAttachments query boolean false You can include candidate forms additions with included addition 'attachments' relation
includeFormsAdditionsAttachmentsWithFile query boolean false You can include candidate forms additions attachments with included attachment 'file' relation
includeFormsAttachments query boolean false You can include candidate forms with included form 'attachments' relation
includeFormsAttachmentsWithFile query boolean false You can include candidate forms attachments with included attachment 'file' relation
includeFormsSignatureRequest query boolean false You can include candidate forms with included form 'signatureRequest' relation
includeFormsSignatureRequestSigners query boolean false You can include candidate forms signatureRequest with included signatureRequest 'signers' relation
includeFormsSignatureRequestSignersEntity query boolean false You can include candidate forms signatureRequest signers with included signer 'entity' relation
includeFormsSignatureRequestSignature query boolean false You can include candidate forms signatureRequest with included signatureRequest 'signature' relation
includeConversation query boolean false You can include candidate 'conversation' relation
includeCustomFields query boolean false You can include candidate 'customFields' relation
includeTags query boolean false You can include candidate 'tags' relation
includeAssignee query boolean false You can include candidate 'assignee' relation
includeSelfie query boolean false You can include candidate 'selfie' relation
includeSelfieFront query boolean false You can include candidate 'selfie' relation with embedded 'front' relation
includeSelfieFrontThumbnail query boolean false You can include candidate 'selfie' relation with embedded 'frontThumbnail' relation

Enumerated Values

Parameter Value
order candidate.createdAt asc
order candidate.createdAt desc
order candidate.updatedAt asc
order candidate.updatedAt desc
order candidate.lastName asc
order candidate.lastName desc
order candidate.deadline asc
order candidate.deadline desc
order custom_field_order.value.{customFieldId}
filter[statuses][] open
filter[statuses][] pending
filter[statuses][] completed
filter[statuses][] rejected
filter[comments] all
filter[comments] unread

Example responses

200 Response

[
  {
    "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "email": "[email protected]",
    "firstName": "James",
    "lastName": "Good",
    "reference": "Best Candidate",
    "language": "en",
    "welcomeText": "Hi John, we are glad to welcome you to the company!",
    "welcomeTextType": "default",
    "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "additionalEmails": [
      "[email protected]"
    ],
    "snoozed": false,
    "mobilePhone": "003801234567890",
    "notes": "Some notes",
    "deadline": "2019-09-12T15:36:09.264Z",
    "createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "status": "pending",
    "token": "2ScQsIW1OPHsjEFRs",
    "archived": false,
    "integrationChanged": false,
    "clientIsMobile": false,
    "clientVersion": "",
    "lastLoggedAt": "2019-09-12T15:36:09.264Z",
    "statusUpdateAt": "2019-09-12T15:36:09.264Z",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "account": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "Tesla Digital",
      "reference": "ACC_TESLA_DIG_01",
      "welcomeText": {
        "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "en": "<p>English</p>",
        "fr": "<p>Français</p>",
        "nl": "<p>Nederlands</p>",
        "de": "<p>Deutsch</p>",
        "it": "<p>Italiano</p>",
        "pl": "<p>Polski</p>",
        "ro": "<p>Română</p>",
        "sq": "<p>Shqip</p>",
        "be": "<p>Беларуская</p>",
        "bg": "<p>Български</p>",
        "hr": "<p>Hrvatski</p>",
        "cs": "<p>Čeština</p>",
        "da": "<p>Dansk</p>",
        "et": "<p>Eesti</p>",
        "fi": "<p>Suomi</p>",
        "el": "<p>Ελληνικά</p>",
        "hu": "<p>Magyar</p>",
        "is": "<p>Íslenska</p>",
        "ga": "<p>Gaeilge</p>",
        "lv": "<p>Latviešu</p>",
        "lt": "<p>Lietuvių</p>",
        "mk": "<p>Македонски</p>",
        "mt": "<p>Malti</p>",
        "no": "<p>Norsk</p>",
        "pt": "<p>Português</p>",
        "ru": "<p>Русский</p>",
        "sr": "<p>Српски</p>",
        "sk": "<p>Slovenčina</p>",
        "sl": "<p>Slovenščina</p>",
        "es": "<p>Español</p>",
        "sv": "<p>Svenska</p>",
        "uk": "<p>Українська</p>",
        "cy": "<p>Cymraeg</p>"
      },
      "aboutText": {
        "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "en": "<p>English</p>",
        "fr": "<p>Français</p>",
        "nl": "<p>Nederlands</p>",
        "de": "<p>Deutsch</p>",
        "it": "<p>Italiano</p>",
        "pl": "<p>Polski</p>",
        "ro": "<p>Română</p>",
        "sq": "<p>Shqip</p>",
        "be": "<p>Беларуская</p>",
        "bg": "<p>Български</p>",
        "hr": "<p>Hrvatski</p>",
        "cs": "<p>Čeština</p>",
        "da": "<p>Dansk</p>",
        "et": "<p>Eesti</p>",
        "fi": "<p>Suomi</p>",
        "el": "<p>Ελληνικά</p>",
        "hu": "<p>Magyar</p>",
        "is": "<p>Íslenska</p>",
        "ga": "<p>Gaeilge</p>",
        "lv": "<p>Latviešu</p>",
        "lt": "<p>Lietuvių</p>",
        "mk": "<p>Македонски</p>",
        "mt": "<p>Malti</p>",
        "no": "<p>Norsk</p>",
        "pt": "<p>Português</p>",
        "ru": "<p>Русский</p>",
        "sr": "<p>Српски</p>",
        "sk": "<p>Slovenčina</p>",
        "sl": "<p>Slovenščina</p>",
        "es": "<p>Español</p>",
        "sv": "<p>Svenska</p>",
        "uk": "<p>Українська</p>",
        "cy": "<p>Cymraeg</p>"
      },
      "completedBoxText": {
        "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "en": "<p>English</p>",
        "fr": "<p>Français</p>",
        "nl": "<p>Nederlands</p>",
        "de": "<p>Deutsch</p>",
        "it": "<p>Italiano</p>",
        "pl": "<p>Polski</p>",
        "ro": "<p>Română</p>",
        "sq": "<p>Shqip</p>",
        "be": "<p>Беларуская</p>",
        "bg": "<p>Български</p>",
        "hr": "<p>Hrvatski</p>",
        "cs": "<p>Čeština</p>",
        "da": "<p>Dansk</p>",
        "et": "<p>Eesti</p>",
        "fi": "<p>Suomi</p>",
        "el": "<p>Ελληνικά</p>",
        "hu": "<p>Magyar</p>",
        "is": "<p>Íslenska</p>",
        "ga": "<p>Gaeilge</p>",
        "lv": "<p>Latviešu</p>",
        "lt": "<p>Lietuvių</p>",
        "mk": "<p>Македонски</p>",
        "mt": "<p>Malti</p>",
        "no": "<p>Norsk</p>",
        "pt": "<p>Português</p>",
        "ru": "<p>Русский</p>",
        "sr": "<p>Српски</p>",
        "sk": "<p>Slovenčina</p>",
        "sl": "<p>Slovenščina</p>",
        "es": "<p>Español</p>",
        "sv": "<p>Svenska</p>",
        "uk": "<p>Українська</p>",
        "cy": "<p>Cymraeg</p>"
      },
      "completedText": {
        "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "en": "<p>English</p>",
        "fr": "<p>Français</p>",
        "nl": "<p>Nederlands</p>",
        "de": "<p>Deutsch</p>",
        "it": "<p>Italiano</p>",
        "pl": "<p>Polski</p>",
        "ro": "<p>Română</p>",
        "sq": "<p>Shqip</p>",
        "be": "<p>Беларуская</p>",
        "bg": "<p>Български</p>",
        "hr": "<p>Hrvatski</p>",
        "cs": "<p>Čeština</p>",
        "da": "<p>Dansk</p>",
        "et": "<p>Eesti</p>",
        "fi": "<p>Suomi</p>",
        "el": "<p>Ελληνικά</p>",
        "hu": "<p>Magyar</p>",
        "is": "<p>Íslenska</p>",
        "ga": "<p>Gaeilge</p>",
        "lv": "<p>Latviešu</p>",
        "lt": "<p>Lietuvių</p>",
        "mk": "<p>Македонски</p>",
        "mt": "<p>Malti</p>",
        "no": "<p>Norsk</p>",
        "pt": "<p>Português</p>",
        "ru": "<p>Русский</p>",
        "sr": "<p>Српски</p>",
        "sk": "<p>Slovenčina</p>",
        "sl": "<p>Slovenščina</p>",
        "es": "<p>Español</p>",
        "sv": "<p>Svenska</p>",
        "uk": "<p>Українська</p>",
        "cy": "<p>Cymraeg</p>"
      },
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z"
    },
    "company": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "",
      "zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
      "replyToEmail": "[email protected]",
      "archiveInactiveCandidateAfterDays": 7,
      "deleteInactiveCandidateAfterDays": 7,
      "logo": "",
      "languages": [
        "en",
        "fr",
        "nl",
        "de",
        "it",
        "pl",
        "ro",
        "sq",
        "be",
        "bg",
        "hr",
        "cs",
        "da",
        "et",
        "fi",
        "el",
        "hu",
        "is",
        "ga",
        "lv",
        "lt",
        "mk",
        "mt",
        "no",
        "pt",
        "ru",
        "sr",
        "sk",
        "sl",
        "es",
        "sv",
        "uk",
        "cy"
      ],
      "fileBoxCss": ".custom {color: red;}",
      "largeDocumentThumbnail": false,
      "isMultipleUploadEnabled": true,
      "maxNumberOfFilesPerDocument": 20,
      "isCandidateConversationEnabled": false,
      "locale": {
        "key": "Belgium_nl",
        "country": "Belgium",
        "lang": "nl",
        "dateFormat": "D/MM/YYYY",
        "code": "BE",
        "phoneCode": "32"
      }
    },
    "documentStatistic": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "docRequestedTotal": 7,
      "docProvidedTotal": 6,
      "docMandatoryRequestedTotal": 4,
      "docMandatoryProvidedTotal": 4,
      "docOptionalRequestedTotal": 3,
      "docOptionalProvidedTotal": 2,
      "resourceTotal": 5,
      "resourceCompletedTotal": 2,
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z"
    },
    "conversation": null,
    "customFields": [
      {
        "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "createdAt": "2019-09-12T15:36:09.264Z",
        "updatedAt": "2019-09-12T15:36:09.264Z",
        "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "value": "1234-456-32"
      }
    ],
    "user": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "lastActivityAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z",
      "gender": "female",
      "firstName": "James",
      "lastName": "Good",
      "email": "[email protected]",
      "phone": "+32 0x xxx xx xx",
      "position": "Manager",
      "language": "en",
      "forceChangePassword": false,
      "isOwner": false
    },
    "tags": [
      {
        "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "createdAt": "2019-09-12T15:36:09.264Z"
      }
    ],
    "resources": [
      {
        "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "name": "Manager's contract",
        "locked": false,
        "text": "<p>It's the contract.</p>",
        "completedActions": [
          "complete",
          "download"
        ],
        "file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
        "filename": "Contract J.J. Mask.pdf",
        "remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
        "attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
        "attachedFilename": "Contract_example.pdf",
        "fields": [
          {
            "reference": "Mask",
            "value": {
              "checkbox": false,
              "text": "Mask",
              "email": "Mask",
              "signature": "data:image/png;base64,iVBORw0KGg"
            }
          }
        ],
        "status": "requested",
        "createdAt": "2019-09-12T15:36:09.264Z",
        "updatedAt": "2019-09-12T15:36:09.264Z",
        "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "actions": [
          "complete",
          "download"
        ],
        "blocking": false,
        "folder": "Policies"
      }
    ],
    "candidateDocumentTypes": [
      {
        "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "name": "ASAP",
        "description": "Description of the document type",
        "internal": false,
        "folder": "string",
        "customStatus": "pending",
        "ocrParsedData": {},
        "validationSnapshot": {
          "total": 10,
          "totalToBePending": 10,
          "conditions": [
            {
              "type": "or",
              "action": "score",
              "score": 10,
              "sequence": 1,
              "isValid": true,
              "validations": [
                {
                  "rule": "string",
                  "method": "contains",
                  "value": {
                    "value": "value"
                  },
                  "fieldName": "firstName",
                  "fieldValue": "Field value",
                  "sequence": 1,
                  "isValid": true
                }
              ]
            }
          ]
        },
        "integrationTransferedAt": "string",
        "mergeSetFilePath": "string",
        "isMultiple": false,
        "isProcessing": false,
        "isPaused": false,
        "combinedMultipleDocumentPath": "string",
        "combinedMultipleDocumentName": "string",
        "expiresOn": "2019-09-12T15:36:09.264Z",
        "createdAt": "2019-09-12T15:36:09.264Z",
        "updatedAt": "2019-09-12T15:36:09.264Z",
        "filename": "file_of_the_company_candidate_{candidateFirstname}",
        "comment": "string",
        "commentType": "info",
        "mandatory": false
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful candidateFindResponse

Response Headers

Status Header Type Format Description
200 X-CURRENT-PAGE integer Current page
200 X-PAGE-OFFSET integer Current offset
200 X-PAGE-LIMIT integer Current limit
200 X-TOTAL-PAGES integer The total number of pages.
200 X-TOTAL-RECORDS integer The total number of items.

Delete Candidates

Code samples

DELETE https://api.checkhub.io/candidates HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.checkhub.io/candidates', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.checkhub.io/candidates',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /candidates

Parameters

Name In Type Required Description
filter query candidateDeleteFilter false Delete Candidates filter params

Example responses

200 Response

{
  "count": 3
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateDeleteResponse

Deleting a model instance by {{id}} from the data source.

Code samples

DELETE https://api.checkhub.io/candidates/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.checkhub.io/candidates/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.checkhub.io/candidates/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /candidates/{id}

Parameters

Name In Type Required Description
id path string true Model id which should be deleted

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Candidate is deleted successfullyCompletedRequest

Get candidate by {{id}} from the data source.

Code samples

GET https://api.checkhub.io/candidates/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/candidates/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/candidates/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /candidates/{id}

Parameters

Name In Type Required Description
id path string true Model id which should be founded
includeAccount query boolean false You can include candidate 'account' relation
includeUser query boolean false You can include candidate 'user' relation
includeChecks query boolean false You can include candidate 'checks' relation
includeDocumentStatistic query boolean false You can include candidate 'documentStatistic' relation
includeCandidateDocumentTypes query boolean false You can include candidate 'candidateDocumentTypes' relation
includeResources query boolean false You can include candidate 'resources' relation
includeForms query boolean false You can include candidate 'forms' relation
includeFormsData query boolean false You can include candidate forms with included form 'data' relation
includeFormsAdditions query boolean false You can include candidate forms with included form 'additions' relation
includeFormsAdditionsData query boolean false You can include candidate forms additions with included addition 'data' relation
includeFormsAdditionsAttachments query boolean false You can include candidate forms additions with included addition 'attachments' relation
includeFormsAdditionsAttachmentsWithFile query boolean false You can include candidate forms additions attachments with included attachment 'file' relation
includeFormsAttachments query boolean false You can include candidate forms with included form 'attachments' relation
includeFormsAttachmentsWithFile query boolean false You can include candidate forms attachments with included attachment 'file' relation
includeFormsSignatureRequest query boolean false You can include candidate forms with included form 'signatureRequest' relation
includeFormsSignatureRequestSigners query boolean false You can include candidate forms signatureRequest with included signatureRequest 'signers' relation
includeFormsSignatureRequestSignersEntity query boolean false You can include candidate forms signatureRequest signers with included signer 'entity' relation
includeFormsSignatureRequestSignature query boolean false You can include candidate forms signatureRequest with included signatureRequest 'signature' relation
includeConversation query boolean false You can include candidate 'conversation' relation
includeCustomFields query boolean false You can include candidate 'customFields' relation
includeTags query boolean false You can include candidate 'tags' relation
includeAssignee query boolean false You can include candidate 'assignee' relation
includeSelfie query boolean false You can include candidate 'selfie' relation
includeSelfieFront query boolean false You can include candidate 'selfie' relation with embedded 'front' relation
includeSelfieFrontThumbnail query boolean false You can include candidate 'selfie' relation with embedded 'frontThumbnail' relation

Example responses

200 Response

{
  "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "email": "[email protected]",
  "firstName": "James",
  "lastName": "Good",
  "reference": "Best Candidate",
  "language": "en",
  "welcomeText": "Hi John, we are glad to welcome you to the company!",
  "welcomeTextType": "default",
  "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "additionalEmails": [
    "[email protected]"
  ],
  "snoozed": false,
  "mobilePhone": "003801234567890",
  "notes": "Some notes",
  "deadline": "2019-09-12T15:36:09.264Z",
  "createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "status": "pending",
  "token": "2ScQsIW1OPHsjEFRs",
  "archived": false,
  "integrationChanged": false,
  "clientIsMobile": false,
  "clientVersion": "",
  "lastLoggedAt": "2019-09-12T15:36:09.264Z",
  "statusUpdateAt": "2019-09-12T15:36:09.264Z",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "account": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "name": "Tesla Digital",
    "reference": "ACC_TESLA_DIG_01",
    "welcomeText": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "en": "<p>English</p>",
      "fr": "<p>Français</p>",
      "nl": "<p>Nederlands</p>",
      "de": "<p>Deutsch</p>",
      "it": "<p>Italiano</p>",
      "pl": "<p>Polski</p>",
      "ro": "<p>Română</p>",
      "sq": "<p>Shqip</p>",
      "be": "<p>Беларуская</p>",
      "bg": "<p>Български</p>",
      "hr": "<p>Hrvatski</p>",
      "cs": "<p>Čeština</p>",
      "da": "<p>Dansk</p>",
      "et": "<p>Eesti</p>",
      "fi": "<p>Suomi</p>",
      "el": "<p>Ελληνικά</p>",
      "hu": "<p>Magyar</p>",
      "is": "<p>Íslenska</p>",
      "ga": "<p>Gaeilge</p>",
      "lv": "<p>Latviešu</p>",
      "lt": "<p>Lietuvių</p>",
      "mk": "<p>Македонски</p>",
      "mt": "<p>Malti</p>",
      "no": "<p>Norsk</p>",
      "pt": "<p>Português</p>",
      "ru": "<p>Русский</p>",
      "sr": "<p>Српски</p>",
      "sk": "<p>Slovenčina</p>",
      "sl": "<p>Slovenščina</p>",
      "es": "<p>Español</p>",
      "sv": "<p>Svenska</p>",
      "uk": "<p>Українська</p>",
      "cy": "<p>Cymraeg</p>"
    },
    "aboutText": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "en": "<p>English</p>",
      "fr": "<p>Français</p>",
      "nl": "<p>Nederlands</p>",
      "de": "<p>Deutsch</p>",
      "it": "<p>Italiano</p>",
      "pl": "<p>Polski</p>",
      "ro": "<p>Română</p>",
      "sq": "<p>Shqip</p>",
      "be": "<p>Беларуская</p>",
      "bg": "<p>Български</p>",
      "hr": "<p>Hrvatski</p>",
      "cs": "<p>Čeština</p>",
      "da": "<p>Dansk</p>",
      "et": "<p>Eesti</p>",
      "fi": "<p>Suomi</p>",
      "el": "<p>Ελληνικά</p>",
      "hu": "<p>Magyar</p>",
      "is": "<p>Íslenska</p>",
      "ga": "<p>Gaeilge</p>",
      "lv": "<p>Latviešu</p>",
      "lt": "<p>Lietuvių</p>",
      "mk": "<p>Македонски</p>",
      "mt": "<p>Malti</p>",
      "no": "<p>Norsk</p>",
      "pt": "<p>Português</p>",
      "ru": "<p>Русский</p>",
      "sr": "<p>Српски</p>",
      "sk": "<p>Slovenčina</p>",
      "sl": "<p>Slovenščina</p>",
      "es": "<p>Español</p>",
      "sv": "<p>Svenska</p>",
      "uk": "<p>Українська</p>",
      "cy": "<p>Cymraeg</p>"
    },
    "completedBoxText": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "en": "<p>English</p>",
      "fr": "<p>Français</p>",
      "nl": "<p>Nederlands</p>",
      "de": "<p>Deutsch</p>",
      "it": "<p>Italiano</p>",
      "pl": "<p>Polski</p>",
      "ro": "<p>Română</p>",
      "sq": "<p>Shqip</p>",
      "be": "<p>Беларуская</p>",
      "bg": "<p>Български</p>",
      "hr": "<p>Hrvatski</p>",
      "cs": "<p>Čeština</p>",
      "da": "<p>Dansk</p>",
      "et": "<p>Eesti</p>",
      "fi": "<p>Suomi</p>",
      "el": "<p>Ελληνικά</p>",
      "hu": "<p>Magyar</p>",
      "is": "<p>Íslenska</p>",
      "ga": "<p>Gaeilge</p>",
      "lv": "<p>Latviešu</p>",
      "lt": "<p>Lietuvių</p>",
      "mk": "<p>Македонски</p>",
      "mt": "<p>Malti</p>",
      "no": "<p>Norsk</p>",
      "pt": "<p>Português</p>",
      "ru": "<p>Русский</p>",
      "sr": "<p>Српски</p>",
      "sk": "<p>Slovenčina</p>",
      "sl": "<p>Slovenščina</p>",
      "es": "<p>Español</p>",
      "sv": "<p>Svenska</p>",
      "uk": "<p>Українська</p>",
      "cy": "<p>Cymraeg</p>"
    },
    "completedText": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "en": "<p>English</p>",
      "fr": "<p>Français</p>",
      "nl": "<p>Nederlands</p>",
      "de": "<p>Deutsch</p>",
      "it": "<p>Italiano</p>",
      "pl": "<p>Polski</p>",
      "ro": "<p>Română</p>",
      "sq": "<p>Shqip</p>",
      "be": "<p>Беларуская</p>",
      "bg": "<p>Български</p>",
      "hr": "<p>Hrvatski</p>",
      "cs": "<p>Čeština</p>",
      "da": "<p>Dansk</p>",
      "et": "<p>Eesti</p>",
      "fi": "<p>Suomi</p>",
      "el": "<p>Ελληνικά</p>",
      "hu": "<p>Magyar</p>",
      "is": "<p>Íslenska</p>",
      "ga": "<p>Gaeilge</p>",
      "lv": "<p>Latviešu</p>",
      "lt": "<p>Lietuvių</p>",
      "mk": "<p>Македонски</p>",
      "mt": "<p>Malti</p>",
      "no": "<p>Norsk</p>",
      "pt": "<p>Português</p>",
      "ru": "<p>Русский</p>",
      "sr": "<p>Српски</p>",
      "sk": "<p>Slovenčina</p>",
      "sl": "<p>Slovenščina</p>",
      "es": "<p>Español</p>",
      "sv": "<p>Svenska</p>",
      "uk": "<p>Українська</p>",
      "cy": "<p>Cymraeg</p>"
    },
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z"
  },
  "company": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "name": "",
    "zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
    "replyToEmail": "[email protected]",
    "archiveInactiveCandidateAfterDays": 7,
    "deleteInactiveCandidateAfterDays": 7,
    "logo": "",
    "languages": [
      "en",
      "fr",
      "nl",
      "de",
      "it",
      "pl",
      "ro",
      "sq",
      "be",
      "bg",
      "hr",
      "cs",
      "da",
      "et",
      "fi",
      "el",
      "hu",
      "is",
      "ga",
      "lv",
      "lt",
      "mk",
      "mt",
      "no",
      "pt",
      "ru",
      "sr",
      "sk",
      "sl",
      "es",
      "sv",
      "uk",
      "cy"
    ],
    "fileBoxCss": ".custom {color: red;}",
    "largeDocumentThumbnail": false,
    "isMultipleUploadEnabled": true,
    "maxNumberOfFilesPerDocument": 20,
    "isCandidateConversationEnabled": false,
    "locale": {
      "key": "Belgium_nl",
      "country": "Belgium",
      "lang": "nl",
      "dateFormat": "D/MM/YYYY",
      "code": "BE",
      "phoneCode": "32"
    }
  },
  "documentStatistic": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "docRequestedTotal": 7,
    "docProvidedTotal": 6,
    "docMandatoryRequestedTotal": 4,
    "docMandatoryProvidedTotal": 4,
    "docOptionalRequestedTotal": 3,
    "docOptionalProvidedTotal": 2,
    "resourceTotal": 5,
    "resourceCompletedTotal": 2,
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z"
  },
  "conversation": null,
  "customFields": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z",
      "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "value": "1234-456-32"
    }
  ],
  "user": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "lastActivityAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "gender": "female",
    "firstName": "James",
    "lastName": "Good",
    "email": "[email protected]",
    "phone": "+32 0x xxx xx xx",
    "position": "Manager",
    "language": "en",
    "forceChangePassword": false,
    "isOwner": false
  },
  "tags": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "createdAt": "2019-09-12T15:36:09.264Z"
    }
  ],
  "resources": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "Manager's contract",
      "locked": false,
      "text": "<p>It's the contract.</p>",
      "completedActions": [
        "complete",
        "download"
      ],
      "file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
      "filename": "Contract J.J. Mask.pdf",
      "remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
      "attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
      "attachedFilename": "Contract_example.pdf",
      "fields": [
        {
          "reference": "Mask",
          "value": {
            "checkbox": false,
            "text": "Mask",
            "email": "Mask",
            "signature": "data:image/png;base64,iVBORw0KGg"
          }
        }
      ],
      "status": "requested",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z",
      "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ],
      "blocking": false,
      "folder": "Policies"
    }
  ],
  "candidateDocumentTypes": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "ASAP",
      "description": "Description of the document type",
      "internal": false,
      "folder": "string",
      "customStatus": "pending",
      "ocrParsedData": {},
      "validationSnapshot": {
        "total": 10,
        "totalToBePending": 10,
        "conditions": [
          {
            "type": "or",
            "action": "score",
            "score": 10,
            "sequence": 1,
            "isValid": true,
            "validations": [
              {
                "rule": "string",
                "method": "contains",
                "value": {
                  "value": "value"
                },
                "fieldName": "firstName",
                "fieldValue": "Field value",
                "sequence": 1,
                "isValid": true
              }
            ]
          }
        ]
      },
      "integrationTransferedAt": "string",
      "mergeSetFilePath": "string",
      "isMultiple": false,
      "isProcessing": false,
      "isPaused": false,
      "combinedMultipleDocumentPath": "string",
      "combinedMultipleDocumentName": "string",
      "expiresOn": "2019-09-12T15:36:09.264Z",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z",
      "filename": "file_of_the_company_candidate_{candidateFirstname}",
      "comment": "string",
      "commentType": "info",
      "mandatory": false
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateFindByIdResponse

Edit candidate by {{id}}

Code samples

PATCH https://api.checkhub.io/candidates/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "email": "[email protected]",
  "firstName": "James",
  "lastName": "Good",
  "reference": "Best Candidate",
  "language": "en",
  "welcomeText": "<p>Hi!</p>>",
  "welcomeTextType": "default",
  "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "additionalEmails": [
    "[email protected]"
  ],
  "snoozed": false,
  "mobilePhone": "+3801234567890",
  "notes": "Some notes about candidate",
  "deadline": "2019-09-12T15:36:09.264Z",
  "archived": false,
  "tagIds": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "email": "[email protected]",
  "firstName": "James",
  "lastName": "Good",
  "reference": "Best Candidate",
  "language": "en",
  "welcomeText": "<p>Hi!</p>>",
  "welcomeTextType": "default",
  "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "additionalEmails": [
    "[email protected]"
  ],
  "snoozed": false,
  "mobilePhone": "+3801234567890",
  "notes": "Some notes about candidate",
  "deadline": "2019-09-12T15:36:09.264Z",
  "archived": false,
  "tagIds": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.patch('https://api.checkhub.io/candidates/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.patch 'https://api.checkhub.io/candidates/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /candidates/{id}

Body parameter

{
  "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "email": "[email protected]",
  "firstName": "James",
  "lastName": "Good",
  "reference": "Best Candidate",
  "language": "en",
  "welcomeText": "<p>Hi!</p>>",
  "welcomeTextType": "default",
  "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "additionalEmails": [
    "[email protected]"
  ],
  "snoozed": false,
  "mobilePhone": "+3801234567890",
  "notes": "Some notes about candidate",
  "deadline": "2019-09-12T15:36:09.264Z",
  "archived": false,
  "tagIds": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ]
}

Parameters

Name In Type Required Description
id path string true Model id which should be updated
accountId body UUID_V4 true Unique identifier for the entity
email body string true Candidate Email address
firstName body string true User First Name
lastName body string true User Last Name
reference body string true Candidate reference
language body language true none
welcomeText body string false Candidate welcome text
welcomeTextType body string false Candidate welcome type
assigneeId body UUID_V4 false Unique identifier for the entity
additionalEmails body [string] false Candidate additional emails. Not more than 5 emails
snoozed body boolean false Turns off future notifications (email and SMS) to this candidate
mobilePhone body string false User mobile phone number in the international format
notes body string false Candidate additional notes
deadline body DateISO(date-time) false Datetime in ISO format
archived body boolean false Archive or Unarchive candidate
tagIds body [UUID_V4] false Tags that will be applied to the candidate during update.

Enumerated Values

Parameter Value
language en
language fr
language nl
language de
language it
language pl
language ro
language sq
language be
language bg
language hr
language cs
language da
language et
language fi
language el
language hu
language is
language ga
language lv
language lt
language mk
language mt
language no
language pt
language ru
language sr
language sk
language sl
language es
language sv
language uk
language cy
welcomeTextType default
welcomeTextType custom
welcomeTextType none

Example responses

200 Response

{
  "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "email": "[email protected]",
  "firstName": "James",
  "lastName": "Good",
  "reference": "Best Candidate",
  "language": "en",
  "welcomeText": "Hi John, we are glad to welcome you to the company!",
  "welcomeTextType": "default",
  "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "additionalEmails": [
    "[email protected]"
  ],
  "snoozed": false,
  "mobilePhone": "003801234567890",
  "notes": "Some notes",
  "deadline": "2019-09-12T15:36:09.264Z",
  "createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "status": "pending",
  "token": "2ScQsIW1OPHsjEFRs",
  "archived": false,
  "integrationChanged": false,
  "clientIsMobile": false,
  "clientVersion": "",
  "lastLoggedAt": "2019-09-12T15:36:09.264Z",
  "statusUpdateAt": "2019-09-12T15:36:09.264Z",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z"
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidate

Export candidates

Code samples

GET https://api.checkhub.io/candidates/export HTTP/1.1
Host: api.checkhub.io
Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet



const headers = {
  'Accept':'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates/export',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates/export',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/candidates/export', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/candidates/export',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /candidates/export

Parameters

Name In Type Required Description
filter[reference] query string false Filter by candidate 'reference' field
filter[references][] query string false Filter result by candidate references (or)
filter[archived] query boolean false Filter by candidate 'archived' field
filter[accountId] query UUID_V4 false Filter by candidate 'accountId' field
filter[tagIds][] query UUID_V4 false Filter by candidate related tag ids
filter[withoutTagIds][] query UUID_V4 false Filter by candidate without tag ids
filter[searchText] query string false Search result by following properties: ('email', 'firstName', 'lastName', 'notes', 'reference', 'candidateCustomField.value')
filter[statuses][] query candidateStatus false Filter result by custom statuses (or)
filter[comments] query candidateCommentsFilter false Filter result by comments
filter[assigneeId] query UUID_V4 false Filter by candidate 'assigneeId' field
filter[isAssigned] query boolean false Filter by 'isAssigned' candidate
order query string false Candidates order

Enumerated Values

Parameter Value
filter[statuses][] open
filter[statuses][] pending
filter[statuses][] completed
filter[statuses][] rejected
filter[comments] all
filter[comments] unread
order candidate.createdAt asc
order candidate.createdAt desc
order candidate.updatedAt asc
order candidate.updatedAt desc
order candidate.lastName asc
order candidate.lastName desc
order candidate.deadline asc
order candidate.deadline desc
order custom_field_order.value.{customFieldId}

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Export XLSX file with candidates string

Import candidates with some relations

Code samples

POST https://api.checkhub.io/candidates/bulk HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "mode": "immediately",
  "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "candidates": [
    {
      "firstName": "James",
      "lastName": "Good",
      "email": "[email protected]",
      "reference": "j_good1991",
      "language": "en",
      "deadline": "2019-09-12T15:36:09.264Z",
      "additionalEmails": [
        "[email protected]"
      ],
      "mobilePhone": "+3801234567890",
      "preset": "preset_1, preset_2",
      "tags": [
        "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
      ],
      "presetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "customFields": [
        {
          "reference": "string",
          "value": "string"
        }
      ]
    }
  ],
  "documents": [
    {
      "documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "string",
      "description": "string",
      "filename": "file_of_the_company_candidate_{candidateFirstName}",
      "comment": "string",
      "commentType": "info",
      "mandatory": true,
      "folder": "string"
    }
  ],
  "forms": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ],
      "isMandatory": true,
      "signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
    }
  ],
  "resources": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ]
    }
  ],
  "tags": {
    "create": [
      "string"
    ],
    "apply": [
      "string"
    ]
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates/bulk',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "mode": "immediately",
  "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "candidates": [
    {
      "firstName": "James",
      "lastName": "Good",
      "email": "[email protected]",
      "reference": "j_good1991",
      "language": "en",
      "deadline": "2019-09-12T15:36:09.264Z",
      "additionalEmails": [
        "[email protected]"
      ],
      "mobilePhone": "+3801234567890",
      "preset": "preset_1, preset_2",
      "tags": [
        "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
      ],
      "presetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "customFields": [
        {
          "reference": "string",
          "value": "string"
        }
      ]
    }
  ],
  "documents": [
    {
      "documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "string",
      "description": "string",
      "filename": "file_of_the_company_candidate_{candidateFirstName}",
      "comment": "string",
      "commentType": "info",
      "mandatory": true,
      "folder": "string"
    }
  ],
  "forms": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ],
      "isMandatory": true,
      "signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
    }
  ],
  "resources": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ]
    }
  ],
  "tags": {
    "create": [
      "string"
    ],
    "apply": [
      "string"
    ]
  }
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates/bulk',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.checkhub.io/candidates/bulk', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.checkhub.io/candidates/bulk',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /candidates/bulk

Body parameter

{
  "mode": "immediately",
  "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "candidates": [
    {
      "firstName": "James",
      "lastName": "Good",
      "email": "[email protected]",
      "reference": "j_good1991",
      "language": "en",
      "deadline": "2019-09-12T15:36:09.264Z",
      "additionalEmails": [
        "[email protected]"
      ],
      "mobilePhone": "+3801234567890",
      "preset": "preset_1, preset_2",
      "tags": [
        "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
      ],
      "presetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "customFields": [
        {
          "reference": "string",
          "value": "string"
        }
      ]
    }
  ],
  "documents": [
    {
      "documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "string",
      "description": "string",
      "filename": "file_of_the_company_candidate_{candidateFirstName}",
      "comment": "string",
      "commentType": "info",
      "mandatory": true,
      "folder": "string"
    }
  ],
  "forms": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ],
      "isMandatory": true,
      "signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
    }
  ],
  "resources": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ]
    }
  ],
  "tags": {
    "create": [
      "string"
    ],
    "apply": [
      "string"
    ]
  }
}

Parameters

Name In Type Required Description
mode body string true Import mode
accountId body UUID_V4 true Unique identifier for the entity
candidates body [candidateBulkCandidate] true Candidates data
» firstName body string true User First Name
» lastName body string true User Last Name
» email body string true Candidate Email address
» reference body string false Candidate reference
» language body language true none
» deadline body DateISO(date-time) false Datetime in ISO format
» additionalEmails body [string] false Candidate additional emails. Not more than 5 emails
» mobilePhone body string false User mobile phone number in the international format
» preset body string false Presets references with ',' separator
» tags body [UUID_V4] false Tags that will be applied to the candidate during creation.
» presetId body UUID_V4 false Unique identifier for the entity
» assigneeId body UUID_V4 false Unique identifier for the entity
» customFields body [object] false Candidate custom fields
»» reference body string true Custom field reference
»» value body string true Custom field value
documents body [candidateBulkDocument] true Candidate Documents data
» documentTypeId body UUID_V4 true Unique identifier for the entity
» name body string false Candidate Document Type name
» description body string false Candidate Document Type description
» filename body string false Candidate Document filename. It can include dynamic fields like {candidateFirstName}
» comment body string false Candidate Document Type comment
» commentType body candidateDocumentTypeCommentType false Candidate document type comment type
» mandatory body boolean true It says that Candidate Document Type is mandatory or optional for the candidate
» folder body string false Candidate Document Type files folder name
forms body [candidateBulkForm] false Candidate Forms data
» id body UUID_V4 true Unique identifier for the entity
» actions body [formAction] true

Form actions (at least one action required);

Please note that allowable actions depend on the type of the original form:

file, readonly and combo types: read, eSign, download

editable type: complete, eSign, download
» isMandatory body boolean false It says that form is mandatory or optional for the candidate.
» signatureId body UUID_V4 false Unique identifier for the entity
» fileId body UUID_V4 false Unique identifier for the entity
resources body [candidateBulkResource] true Candidate resources data
» id body UUID_V4 true Unique identifier for the entity
» actions body [resourceAction] true Resource actions (at least one action required)
tags body candidateBulkTags false none
» create body [string] true New tag names
» apply body [string] true Selected tag names

Enumerated Values

Parameter Value
mode immediately
mode postponed
» language en
» language fr
» language nl
» language de
» language it
» language pl
» language ro
» language sq
» language be
» language bg
» language hr
» language cs
» language da
» language et
» language fi
» language el
» language hu
» language is
» language ga
» language lv
» language lt
» language mk
» language mt
» language no
» language pt
» language ru
» language sr
» language sk
» language sl
» language es
» language sv
» language uk
» language cy
» commentType info
» commentType success
» commentType warning
» commentType danger
» actions read
» actions complete
» actions eSign
» actions download
» actions read
» actions complete
» actions download

Example responses

200 Response

[
  {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "reference": "b_candidate100"
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful candidateBulkResponse

Reset candidate pending

Code samples

POST https://api.checkhub.io/candidates/{id}/reset-candidate-pending HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates/{id}/reset-candidate-pending',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates/{id}/reset-candidate-pending',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.checkhub.io/candidates/{id}/reset-candidate-pending', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.checkhub.io/candidates/{id}/reset-candidate-pending',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /candidates/{id}/reset-candidate-pending

Parameters

Name In Type Required Description
id path string true Model id which should be founded

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Candidate reminder is reset successfullyCompletedRequest

Get candidate last activity

Code samples

GET https://api.checkhub.io/candidates/{id}/last-activity HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates/{id}/last-activity',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidates/{id}/last-activity',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/candidates/{id}/last-activity', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/candidates/{id}/last-activity',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /candidates/{id}/last-activity

Parameters

Name In Type Required Description
id path string true Model id which should be founded

Example responses

200 Response

{
  "email": {
    "createdAt": "2019-09-12T15:36:09.264Z",
    "target": "[email protected]",
    "triggerType": "manually",
    "templateName": "string",
    "scenarioName": "string",
    "scenarioEventName": "string",
    "deliveryStatus": "string"
  },
  "sms": {
    "createdAt": "2019-09-12T15:36:09.264Z",
    "target": "00380506339231",
    "triggerType": "manually",
    "templateName": "string",
    "scenarioName": "string",
    "scenarioEventName": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateGetLastActivityResponse

Candidate Token

Get candidate token collection

Code samples

GET https://api.checkhub.io/candidateTokens HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateTokens',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateTokens',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/candidateTokens', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/candidateTokens',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /candidateTokens

Parameters

Name In Type Required Description
limit query number false Maximum number of items in the response. min: 1, max: 100, default: 10
skip query number false Number of items skipped during the selection. min: 0, default: 0
order query string false Candidate Token collection order
filter[validToken] query candidateTokenValid false Search by candidate token state
filter[ids][] query UUID_V4 false Search by candidate token ids (or)
filter[candidateId] query UUID_V4 false Search by candidate token candidateId
includeCandidate query boolean false To include candidateToken 'candidate' relation

Enumerated Values

Parameter Value
order createdAt asc
order createdAt desc
order validToken asc
order validToken desc
order candidateId asc
order candidateId desc
order tokenLink asc
order tokenLink desc

Example responses

200 Response

[
  {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "tokenLink": "1BlgIvCY20NjUXlRj",
    "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "validToken": true,
    "candidate": {
      "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "email": "[email protected]",
      "firstName": "James",
      "lastName": "Good",
      "reference": "Best Candidate",
      "language": "en",
      "welcomeText": "Hi John, we are glad to welcome you to the company!",
      "welcomeTextType": "default",
      "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "additionalEmails": [
        "[email protected]"
      ],
      "snoozed": false,
      "mobilePhone": "003801234567890",
      "notes": "Some notes",
      "deadline": "2019-09-12T15:36:09.264Z",
      "createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "status": "pending",
      "token": "2ScQsIW1OPHsjEFRs",
      "archived": false,
      "integrationChanged": false,
      "clientIsMobile": false,
      "clientVersion": "",
      "lastLoggedAt": "2019-09-12T15:36:09.264Z",
      "statusUpdateAt": "2019-09-12T15:36:09.264Z",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z"
    }
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful candidateTokenFindResponse

Response Headers

Status Header Type Format Description
200 X-CURRENT-PAGE integer Current page
200 X-PAGE-OFFSET integer Current offset
200 X-PAGE-LIMIT integer Current limit
200 X-TOTAL-PAGES integer The total number of pages.
200 X-TOTAL-RECORDS integer The total number of items.

Create candidate token

Code samples

POST https://api.checkhub.io/candidateTokens HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "validToken": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateTokens',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "validToken": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateTokens',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.checkhub.io/candidateTokens', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.checkhub.io/candidateTokens',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /candidateTokens

Body parameter

{
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "validToken": true
}

Parameters

Name In Type Required Description
candidateId body UUID_V4 true Unique identifier for the entity
validToken body candidateTokenValid false Is valid candidate token

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "tokenLink": "1BlgIvCY20NjUXlRj",
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "validToken": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateToken

Get candidate token by {{id}}

Code samples

GET https://api.checkhub.io/candidateTokens/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateTokens/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateTokens/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/candidateTokens/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/candidateTokens/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /candidateTokens/{id}

Parameters

Name In Type Required Description
id path string true Model id which should be founded
includeCandidate query boolean false To include candidateToken 'candidate' relation

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "tokenLink": "1BlgIvCY20NjUXlRj",
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "validToken": true,
  "candidate": {
    "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "email": "[email protected]",
    "firstName": "James",
    "lastName": "Good",
    "reference": "Best Candidate",
    "language": "en",
    "welcomeText": "Hi John, we are glad to welcome you to the company!",
    "welcomeTextType": "default",
    "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "additionalEmails": [
      "[email protected]"
    ],
    "snoozed": false,
    "mobilePhone": "003801234567890",
    "notes": "Some notes",
    "deadline": "2019-09-12T15:36:09.264Z",
    "createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "status": "pending",
    "token": "2ScQsIW1OPHsjEFRs",
    "archived": false,
    "integrationChanged": false,
    "clientIsMobile": false,
    "clientVersion": "",
    "lastLoggedAt": "2019-09-12T15:36:09.264Z",
    "statusUpdateAt": "2019-09-12T15:36:09.264Z",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateTokenFindByIdResponse

Update candidate token by {{id}}

Code samples

PATCH https://api.checkhub.io/candidateTokens/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "validToken": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateTokens/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "validToken": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateTokens/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.patch('https://api.checkhub.io/candidateTokens/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.patch 'https://api.checkhub.io/candidateTokens/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /candidateTokens/{id}

Body parameter

{
  "validToken": true
}

Parameters

Name In Type Required Description
id path string true Model id which should be updated
validToken body candidateTokenValid false Is valid candidate token

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "tokenLink": "1BlgIvCY20NjUXlRj",
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "validToken": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateToken

Delete candidate token by {{id}}

Code samples

DELETE https://api.checkhub.io/candidateTokens/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateTokens/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateTokens/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.checkhub.io/candidateTokens/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.checkhub.io/candidateTokens/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /candidateTokens/{id}

Parameters

Name In Type Required Description
id path string true Model id which should be deleted

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful successfullyCompletedRequest

Get candidate token by {{link}}

Code samples

GET https://api.checkhub.io/candidateTokens/link/:link HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateTokens/link/:link',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateTokens/link/:link',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/candidateTokens/link/:link', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/candidateTokens/link/:link',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /candidateTokens/link/:link

Parameters

Name In Type Required Description
link path string true Token link

Example responses

200 Response

{
  "token": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateTokenFindByLinkResponse

Candidate Tag

Remove tags from the candidate.

Code samples

DELETE https://api.checkhub.io/candidateTags/{candidateId} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '[
  "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateTags/{candidateId}',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = [
  "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
];
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateTags/{candidateId}',
{
  method: 'DELETE',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.checkhub.io/candidateTags/{candidateId}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.checkhub.io/candidateTags/{candidateId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /candidateTags/{candidateId}

Body parameter

[
  "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]

Parameters

Name In Type Required Description
candidateId path UUID_V4 true The candidate ID for whom the operation will be performed.
body body candidateTagDelete false none

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful successfullyCompletedRequest

Add tags to the candidate.

Code samples

POST https://api.checkhub.io/candidateTags/{candidateId} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '[
  "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateTags/{candidateId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = [
  "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
];
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateTags/{candidateId}',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.checkhub.io/candidateTags/{candidateId}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.checkhub.io/candidateTags/{candidateId}',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /candidateTags/{candidateId}

Body parameter

[
  "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]

Parameters

Name In Type Required Description
candidateId path UUID_V4 true The candidate ID for whom the operation will be performed.
body body candidateTagCreate false none

Example responses

200 Response

[
  {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "createdAt": "2019-09-12T15:36:09.264Z"
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful candidateTagArray

Candidate Selfie

Get candidate selfie collection

Code samples

GET https://api.checkhub.io/candidate-selfies HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidate-selfies',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidate-selfies',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/candidate-selfies', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/candidate-selfies',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /candidate-selfies

Parameters

Name In Type Required Description
limit query number false Maximum number of items in the response. min: 1, max: 100, default: 10
skip query number false Number of items skipped during the selection. min: 0, default: 0
order query string false Candidate Selfie collection order
filter[candidateId] query UUID_V4 false Search by candidate selfie candidateId
includeCandidate query boolean false To include candidate selfie 'candidate' relation
includeFrontThumbnail query boolean false To include candidate selfie 'frontThumbnail' relation
includeFront query boolean false To include candidate selfie 'front' relation
includeLeft query boolean false To include candidate selfie 'left' relation
includeRight query boolean false To include candidate selfie 'right' relation

Enumerated Values

Parameter Value
order createdAt asc
order createdAt desc
order updatedAt asc
order updatedAt desc

Example responses

200 Response

[
  {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "frontThumbnailId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "isLocked": false,
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "candidate": {
      "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "email": "[email protected]",
      "firstName": "James",
      "lastName": "Good",
      "reference": "Best Candidate",
      "language": "en",
      "welcomeText": "Hi John, we are glad to welcome you to the company!",
      "welcomeTextType": "default",
      "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "additionalEmails": [
        "[email protected]"
      ],
      "snoozed": false,
      "mobilePhone": "003801234567890",
      "notes": "Some notes",
      "deadline": "2019-09-12T15:36:09.264Z",
      "createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "status": "pending",
      "token": "2ScQsIW1OPHsjEFRs",
      "archived": false,
      "integrationChanged": false,
      "clientIsMobile": false,
      "clientVersion": "",
      "lastLoggedAt": "2019-09-12T15:36:09.264Z",
      "statusUpdateAt": "2019-09-12T15:36:09.264Z",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z"
    },
    "frontThumbnail": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "checksum": "File checksum",
      "name": "File name",
      "ext": ".jpeg",
      "type": "image/jpeg",
      "size": "image/jpeg",
      "storage": "internal",
      "key": "",
      "url": "",
      "isPublic": false
    },
    "front": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "checksum": "File checksum",
      "name": "File name",
      "ext": ".jpeg",
      "type": "image/jpeg",
      "size": "image/jpeg",
      "storage": "internal",
      "key": "",
      "url": "",
      "isPublic": false
    },
    "left": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "checksum": "File checksum",
      "name": "File name",
      "ext": ".jpeg",
      "type": "image/jpeg",
      "size": "image/jpeg",
      "storage": "internal",
      "key": "",
      "url": "",
      "isPublic": false
    },
    "right": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "checksum": "File checksum",
      "name": "File name",
      "ext": ".jpeg",
      "type": "image/jpeg",
      "size": "image/jpeg",
      "storage": "internal",
      "key": "",
      "url": "",
      "isPublic": false
    }
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful candidateSelfieFindResponse

Response Headers

Status Header Type Format Description
200 X-CURRENT-PAGE integer Current page
200 X-PAGE-OFFSET integer Current offset
200 X-PAGE-LIMIT integer Current limit
200 X-TOTAL-PAGES integer The total number of pages.
200 X-TOTAL-RECORDS integer The total number of items.

Create new candidate selfie

Code samples

POST https://api.checkhub.io/candidate-selfies HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidate-selfies',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidate-selfies',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.checkhub.io/candidate-selfies', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.checkhub.io/candidate-selfies',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /candidate-selfies

Body parameter

{
  "frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}

Parameters

Name In Type Required Description
frontId body UUID_V4 false Unique identifier for the entity
leftId body UUID_V4 false Unique identifier for the entity
rightId body UUID_V4 false Unique identifier for the entity
candidateId body UUID_V4 true Unique identifier for the entity

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "frontThumbnailId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "isLocked": false,
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateSelfie

Get candidate selfie by {{id}}

Code samples

GET https://api.checkhub.io/candidate-selfies/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidate-selfies/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidate-selfies/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/candidate-selfies/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/candidate-selfies/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /candidate-selfies/{id}

Parameters

Name In Type Required Description
id path string true Model id which should be founded
includeCandidate query boolean false To include candidate selfie 'candidate' relation
includeFrontThumbnail query boolean false To include candidate selfie 'frontThumbnail' relation
includeFront query boolean false To include candidate selfie 'front' relation
includeLeft query boolean false To include candidate selfie 'left' relation
includeRight query boolean false To include candidate selfie 'right' relation

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "frontThumbnailId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "isLocked": false,
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "candidate": {
    "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "email": "[email protected]",
    "firstName": "James",
    "lastName": "Good",
    "reference": "Best Candidate",
    "language": "en",
    "welcomeText": "Hi John, we are glad to welcome you to the company!",
    "welcomeTextType": "default",
    "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "additionalEmails": [
      "[email protected]"
    ],
    "snoozed": false,
    "mobilePhone": "003801234567890",
    "notes": "Some notes",
    "deadline": "2019-09-12T15:36:09.264Z",
    "createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "status": "pending",
    "token": "2ScQsIW1OPHsjEFRs",
    "archived": false,
    "integrationChanged": false,
    "clientIsMobile": false,
    "clientVersion": "",
    "lastLoggedAt": "2019-09-12T15:36:09.264Z",
    "statusUpdateAt": "2019-09-12T15:36:09.264Z",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z"
  },
  "frontThumbnail": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "checksum": "File checksum",
    "name": "File name",
    "ext": ".jpeg",
    "type": "image/jpeg",
    "size": "image/jpeg",
    "storage": "internal",
    "key": "",
    "url": "",
    "isPublic": false
  },
  "front": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "checksum": "File checksum",
    "name": "File name",
    "ext": ".jpeg",
    "type": "image/jpeg",
    "size": "image/jpeg",
    "storage": "internal",
    "key": "",
    "url": "",
    "isPublic": false
  },
  "left": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "checksum": "File checksum",
    "name": "File name",
    "ext": ".jpeg",
    "type": "image/jpeg",
    "size": "image/jpeg",
    "storage": "internal",
    "key": "",
    "url": "",
    "isPublic": false
  },
  "right": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "checksum": "File checksum",
    "name": "File name",
    "ext": ".jpeg",
    "type": "image/jpeg",
    "size": "image/jpeg",
    "storage": "internal",
    "key": "",
    "url": "",
    "isPublic": false
  }
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateSelfieFindByIdResponse

Update candidate selfie by id

Code samples

PATCH https://api.checkhub.io/candidate-selfies/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidate-selfies/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidate-selfies/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.patch('https://api.checkhub.io/candidate-selfies/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.patch 'https://api.checkhub.io/candidate-selfies/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /candidate-selfies/{id}

Body parameter

{
  "frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}

Parameters

Name In Type Required Description
id path string true Model id which should be updated
frontId body UUID_V4 false Unique identifier for the entity
leftId body UUID_V4 false Unique identifier for the entity
rightId body UUID_V4 false Unique identifier for the entity

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "frontThumbnailId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "isLocked": false,
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateSelfie

Delete candidate selfie by id

Code samples

DELETE https://api.checkhub.io/candidate-selfies/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidate-selfies/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidate-selfies/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.checkhub.io/candidate-selfies/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.checkhub.io/candidate-selfies/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /candidate-selfies/{id}

Parameters

Name In Type Required Description
id path string true Model id which should be deleted

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful successfullyCompletedRequest

Download candidate selfie file (by candidate)

Code samples

GET https://api.checkhub.io/candidate-selfies/{id}/files/{fileId}/download HTTP/1.1
Host: api.checkhub.io
Accept: application/pdf



const headers = {
  'Accept':'application/pdf',
  'X-CSRF-TOKEN':'API_KEY'
};

fetch('https://api.checkhub.io/candidate-selfies/{id}/files/{fileId}/download',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/pdf',
  'X-CSRF-TOKEN':'API_KEY'
};

fetch('https://api.checkhub.io/candidate-selfies/{id}/files/{fileId}/download',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/pdf',
  'X-CSRF-TOKEN': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/candidate-selfies/{id}/files/{fileId}/download', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/pdf',
  'X-CSRF-TOKEN' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/candidate-selfies/{id}/files/{fileId}/download',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /candidate-selfies/{id}/files/{fileId}/download

Parameters

Name In Type Required Description
id path UUID_V4 true The candidate selfie Id for download.
fileId path UUID_V4 true The candidate selfie fileId for download.

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Candidate selfie file. downloadFileResponse

Candidate Custom Field

Add new custom fields for candidate

Code samples

POST https://api.checkhub.io/candidateCustomFields HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "value": "1234-456-32"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateCustomFields',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "value": "1234-456-32"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateCustomFields',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.checkhub.io/candidateCustomFields', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.checkhub.io/candidateCustomFields',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /candidateCustomFields

Body parameter

{
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "value": "1234-456-32"
}

Parameters

Name In Type Required Description
candidateId body UUID_V4 true Unique identifier for the entity
customFieldId body UUID_V4 true Unique identifier for the entity
value body any false none
» anonymous body string false String custom field value
» anonymous body string false Date custom field value (based on Company locale date format)
» anonymous body string false Email custom field value
» anonymous body string false Simple List selected option
» anonymous body [string] false Multiple List selected options
» anonymous body object false Simple Query selected option
»» label body string true Option Label
»» value body string true Option Value
»» id body string false Option unique field
» anonymous body [object] false Multiple Query selected options
»» label body string true Option Label
»» value body string true Option Value
»» id body string false Option unique field

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "value": "1234-456-32"
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateCustomField

Get list of candidate custom fields

Code samples

GET https://api.checkhub.io/candidateCustomFields HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateCustomFields',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateCustomFields',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/candidateCustomFields', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/candidateCustomFields',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /candidateCustomFields

Parameters

Name In Type Required Description
limit query number false Maximum number of items in the response. min: 1, max: 100, default: 10
skip query number false Number of items skipped during the selection. min: 0, default: 0
order query string false Candidate custom field collection order
filter[candidateId] query UUID_V4 false Search by candidateId
filter[customFieldId] query UUID_V4 false Search by customFieldId
filter[value] query string false Search by value
includeCustomField query boolean false To include candidate custom field 'customField' relation
includeCandidate query boolean false To include candidate custom field 'candidate' relation

Enumerated Values

Parameter Value
order candidateId asc
order candidateId desc
order value asc
order value desc
order customFieldId asc
order customFieldId desc

Example responses

200 Response

[
  {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "value": "1234-456-32",
    "candidate": {
      "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "email": "[email protected]",
      "firstName": "James",
      "lastName": "Good",
      "reference": "Best Candidate",
      "language": "en",
      "welcomeText": "Hi John, we are glad to welcome you to the company!",
      "welcomeTextType": "default",
      "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "additionalEmails": [
        "[email protected]"
      ],
      "snoozed": false,
      "mobilePhone": "003801234567890",
      "notes": "Some notes",
      "deadline": "2019-09-12T15:36:09.264Z",
      "createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "status": "pending",
      "token": "2ScQsIW1OPHsjEFRs",
      "archived": false,
      "integrationChanged": false,
      "clientIsMobile": false,
      "clientVersion": "",
      "lastLoggedAt": "2019-09-12T15:36:09.264Z",
      "statusUpdateAt": "2019-09-12T15:36:09.264Z",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z"
    },
    "customField": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z",
      "name": "Document Number",
      "nameI18n": {
        "en": "",
        "fr": "",
        "nl": "",
        "de": "",
        "it": "",
        "pl": "",
        "ro": "",
        "sq": "",
        "be": "",
        "bg": "",
        "hr": "",
        "cs": "",
        "da": "",
        "et": "",
        "fi": "",
        "el": "",
        "hu": "",
        "is": "",
        "ga": "",
        "lv": "",
        "lt": "",
        "mk": "",
        "mt": "",
        "no": "",
        "pt": "",
        "ru": "",
        "sr": "",
        "sk": "",
        "sl": "",
        "es": "",
        "sv": "",
        "uk": "",
        "cy": ""
      },
      "reference": "DOC_NUM",
      "fieldType": "string",
      "description": "This custom field is required to store the passport series.",
      "descriptionI18n": {
        "en": "",
        "fr": "",
        "nl": "",
        "de": "",
        "it": "",
        "pl": "",
        "ro": "",
        "sq": "",
        "be": "",
        "bg": "",
        "hr": "",
        "cs": "",
        "da": "",
        "et": "",
        "fi": "",
        "el": "",
        "hu": "",
        "is": "",
        "ga": "",
        "lv": "",
        "lt": "",
        "mk": "",
        "mt": "",
        "no": "",
        "pt": "",
        "ru": "",
        "sr": "",
        "sk": "",
        "sl": "",
        "es": "",
        "sv": "",
        "uk": "",
        "cy": ""
      },
      "visibilityRules": {
        "admin": {
          "visible": true,
          "editable": true,
          "mandatory": false
        },
        "candidate": {
          "visible": true,
          "editable": true,
          "mandatory": false
        }
      },
      "accountIds": [
        "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
      ],
      "docTypeIds": [
        "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
      ],
      "orderNbr": 3
    }
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful candidateCustomFieldFindResponse

Response Headers

Status Header Type Format Description
200 X-CURRENT-PAGE integer Current page
200 X-PAGE-OFFSET integer Current offset
200 X-PAGE-LIMIT integer Current limit
200 X-TOTAL-PAGES integer The total number of pages.
200 X-TOTAL-RECORDS integer The total number of items.

Deleting custom field by {{id}} from candidate

Code samples

DELETE https://api.checkhub.io/candidateCustomFields/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateCustomFields/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateCustomFields/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.delete('https://api.checkhub.io/candidateCustomFields/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete 'https://api.checkhub.io/candidateCustomFields/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /candidateCustomFields/{id}

Parameters

Name In Type Required Description
id path string true Model id which should be deleted

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful successfullyCompletedRequest

Get candidate custom field by {{id}}

Code samples

GET https://api.checkhub.io/candidateCustomFields/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateCustomFields/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateCustomFields/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/candidateCustomFields/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/candidateCustomFields/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /candidateCustomFields/{id}

Parameters

Name In Type Required Description
id path string true Model id which should be founded
includeCustomField query boolean false To include candidate custom field 'customField' relation
includeCandidate query boolean false To include candidate custom field 'candidate' relation

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "value": "1234-456-32",
  "candidate": {
    "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "email": "[email protected]",
    "firstName": "James",
    "lastName": "Good",
    "reference": "Best Candidate",
    "language": "en",
    "welcomeText": "Hi John, we are glad to welcome you to the company!",
    "welcomeTextType": "default",
    "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "additionalEmails": [
      "[email protected]"
    ],
    "snoozed": false,
    "mobilePhone": "003801234567890",
    "notes": "Some notes",
    "deadline": "2019-09-12T15:36:09.264Z",
    "createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "status": "pending",
    "token": "2ScQsIW1OPHsjEFRs",
    "archived": false,
    "integrationChanged": false,
    "clientIsMobile": false,
    "clientVersion": "",
    "lastLoggedAt": "2019-09-12T15:36:09.264Z",
    "statusUpdateAt": "2019-09-12T15:36:09.264Z",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z"
  },
  "customField": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "name": "Document Number",
    "nameI18n": {
      "en": "",
      "fr": "",
      "nl": "",
      "de": "",
      "it": "",
      "pl": "",
      "ro": "",
      "sq": "",
      "be": "",
      "bg": "",
      "hr": "",
      "cs": "",
      "da": "",
      "et": "",
      "fi": "",
      "el": "",
      "hu": "",
      "is": "",
      "ga": "",
      "lv": "",
      "lt": "",
      "mk": "",
      "mt": "",
      "no": "",
      "pt": "",
      "ru": "",
      "sr": "",
      "sk": "",
      "sl": "",
      "es": "",
      "sv": "",
      "uk": "",
      "cy": ""
    },
    "reference": "DOC_NUM",
    "fieldType": "string",
    "description": "This custom field is required to store the passport series.",
    "descriptionI18n": {
      "en": "",
      "fr": "",
      "nl": "",
      "de": "",
      "it": "",
      "pl": "",
      "ro": "",
      "sq": "",
      "be": "",
      "bg": "",
      "hr": "",
      "cs": "",
      "da": "",
      "et": "",
      "fi": "",
      "el": "",
      "hu": "",
      "is": "",
      "ga": "",
      "lv": "",
      "lt": "",
      "mk": "",
      "mt": "",
      "no": "",
      "pt": "",
      "ru": "",
      "sr": "",
      "sk": "",
      "sl": "",
      "es": "",
      "sv": "",
      "uk": "",
      "cy": ""
    },
    "visibilityRules": {
      "admin": {
        "visible": true,
        "editable": true,
        "mandatory": false
      },
      "candidate": {
        "visible": true,
        "editable": true,
        "mandatory": false
      }
    },
    "accountIds": [
      "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
    ],
    "docTypeIds": [
      "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
    ],
    "orderNbr": 3
  }
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateCustomFieldFindByIdResponse

Update candidate custom field by {{id}}

Code samples

PATCH https://api.checkhub.io/candidateCustomFields/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "value": "1234-456-32"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateCustomFields/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "value": "1234-456-32"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateCustomFields/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.patch('https://api.checkhub.io/candidateCustomFields/{id}', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.patch 'https://api.checkhub.io/candidateCustomFields/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /candidateCustomFields/{id}

Body parameter

{
  "value": "1234-456-32"
}

Parameters

Name In Type Required Description
id path string true Model id which should be updated
value body string true The value of the candidate's custom field.

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "value": "1234-456-32"
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateCustomField

Candidate Document Type

Create a new Candidate Document Type.

Code samples

POST https://api.checkhub.io/candidateDocumentTypes HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '{
  "documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "name": "ASAP",
  "description": "Description of the document type",
  "filename": "file_of_the_company_candidate_{candidateFirstname}",
  "comment": "string",
  "commentType": "info",
  "mandatory": false,
  "folder": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateDocumentTypes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = {
  "documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "name": "ASAP",
  "description": "Description of the document type",
  "filename": "file_of_the_company_candidate_{candidateFirstname}",
  "comment": "string",
  "commentType": "info",
  "mandatory": false,
  "folder": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateDocumentTypes',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.checkhub.io/candidateDocumentTypes', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post 'https://api.checkhub.io/candidateDocumentTypes',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /candidateDocumentTypes

Body parameter

{
  "documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "name": "ASAP",
  "description": "Description of the document type",
  "filename": "file_of_the_company_candidate_{candidateFirstname}",
  "comment": "string",
  "commentType": "info",
  "mandatory": false,
  "folder": "string"
}

Parameters

Name In Type Required Description
documentTypeId body UUID_V4 true Unique identifier for the entity
candidateId body UUID_V4 true Unique identifier for the entity
name body string true Candidate Document Type name
description body string false Candidate Document Type description
filename body string true Document type filename. It can include dynamic fields like {candidateFirstname}
comment body string false Candidate Document Type comment
commentType body candidateDocumentTypeCommentType false Candidate document type comment type
mandatory body boolean true It says that Candidate Document Type is mandatory or optional for the candidate
folder body string false Candidate Document Type files folder name

Enumerated Values

Parameter Value
commentType info
commentType success
commentType warning
commentType danger

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "name": "ASAP",
  "description": "Description of the document type",
  "internal": false,
  "folder": "string",
  "customStatus": "pending",
  "ocrParsedData": {},
  "validationSnapshot": {
    "total": 10,
    "totalToBePending": 10,
    "conditions": [
      {
        "type": "or",
        "action": "score",
        "score": 10,
        "sequence": 1,
        "isValid": true,
        "validations": [
          {
            "rule": "string",
            "method": "contains",
            "value": {
              "value": "value"
            },
            "fieldName": "firstName",
            "fieldValue": "Field value",
            "sequence": 1,
            "isValid": true
          }
        ]
      }
    ]
  },
  "integrationTransferedAt": "string",
  "mergeSetFilePath": "string",
  "isMultiple": false,
  "isProcessing": false,
  "isPaused": false,
  "combinedMultipleDocumentPath": "string",
  "combinedMultipleDocumentName": "string",
  "expiresOn": "2019-09-12T15:36:09.264Z",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "filename": "file_of_the_company_candidate_{candidateFirstname}",
  "comment": "string",
  "commentType": "info",
  "mandatory": false
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateDocumentType

Get candidate document type collection

Code samples

GET https://api.checkhub.io/candidateDocumentTypes HTTP/1.1
Host: api.checkhub.io
Accept: application/json



const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateDocumentTypes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateDocumentTypes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://api.checkhub.io/candidateDocumentTypes', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://api.checkhub.io/candidateDocumentTypes',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /candidateDocumentTypes

Parameters

Name In Type Required Description
limit query number false Maximum number of items in the response. min: 1, max: 100, default: 10
skip query number false Number of items skipped during the selection. min: 0, default: 0
order query string false Candidate Document type collection order
filter[accountId] query UUID_V4 false Filter result by candidate account id 'accountId'
filter[candidateId] query UUID_V4 false Filter result by candidate id 'candidateId'
filter[candidateEmail] query string false Filter result by candidate 'email'
filter[candidateArchived] query boolean false Filter result by candidate 'archived'
filter[searchText] query string false Search result by following properties: ('candidate.email', 'candidate.firstName', 'candidate.lastName', 'name')
filter[customStatuses][] query candidateDocumentTypeStatus false Filter result by custom statuses (or)
filter[createdAtFrom] query DateISO false Filter result by creation time >=
filter[createdAtTo] query DateISO false Filter result by creation time <=
filter[updatedAtFrom] query DateISO false Filter result by update time >=
filter[updatedAtTo] query DateISO false Filter result by update time <=
filter[assigneeId] query UUID_V4 false Filter result by candidate 'assigneeId' field
filter[isAssigned] query boolean false Filter result by 'isAssigned' candidate
includeCustomFields query boolean false To include 'customFields' relation
includeDocumentType query boolean false To include 'documentType' relation
includeCandidate query boolean false To include 'candidate' relation
includeDocuments query boolean false To include 'documents' relation
includeCandidateAssignee query boolean false To include candidate with 'assignee' relation
includeCandidateSelfie query boolean false To include candidate with 'selfie' relation
includeCandidateSelfieFront query boolean false To include candidate with 'selfie' relation with related 'front' relation
includeCandidateSelfieFrontThumbnail query boolean false To include candidate with 'selfie' relation with related 'frontThumbnail' relation
includeFaceMatch query boolean false To include 'faceMatch' relation
includeImages query boolean false To include 'images' relation which is used for Face Matching

Enumerated Values

Parameter Value
order id asc
order id desc
order name asc
order name desc
order createdAt asc
order createdAt desc
order updatedAt asc
order updatedAt desc
filter[customStatuses][] provided
filter[customStatuses][] pending
filter[customStatuses][] validated
filter[customStatuses][] expired
filter[customStatuses][] rejected

Example responses

200 Response

[
  {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "name": "ASAP",
    "description": "Description of the document type",
    "internal": false,
    "folder": "string",
    "customStatus": "pending",
    "ocrParsedData": {},
    "validationSnapshot": {
      "total": 10,
      "totalToBePending": 10,
      "conditions": [
        {
          "type": "or",
          "action": "score",
          "score": 10,
          "sequence": 1,
          "isValid": true,
          "validations": [
            {
              "rule": "string",
              "method": "contains",
              "value": {
                "value": "value"
              },
              "fieldName": "firstName",
              "fieldValue": "Field value",
              "sequence": 1,
              "isValid": true
            }
          ]
        }
      ]
    },
    "integrationTransferedAt": "string",
    "mergeSetFilePath": "string",
    "isMultiple": false,
    "isProcessing": false,
    "isPaused": false,
    "combinedMultipleDocumentPath": "string",
    "combinedMultipleDocumentName": "string",
    "expiresOn": "2019-09-12T15:36:09.264Z",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "filename": "file_of_the_company_candidate_{candidateFirstname}",
    "comment": "string",
    "commentType": "info",
    "mandatory": false,
    "documentType": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z",
      "filename": "file_of_the_company_candidate_{candidateFirstname}",
      "name": "ASAP",
      "reference": "dt_asap_eu",
      "nameI18n": {
        "en": "",
        "fr": "",
        "nl": "",
        "de": "",
        "it": "",
        "pl": "",
        "ro": "",
        "sq": "",
        "be": "",
        "bg": "",
        "hr": "",
        "cs": "",
        "da": "",
        "et": "",
        "fi": "",
        "el": "",
        "hu": "",
        "is": "",
        "ga": "",
        "lv": "",
        "lt": "",
        "mk": "",
        "mt": "",
        "no": "",
        "pt": "",
        "ru": "",
        "sr": "",
        "sk": "",
        "sl": "",
        "es": "",
        "sv": "",
        "uk": "",
        "cy": ""
      },
      "description": "Document Type description",
      "descriptionI18n": {
        "en": "",
        "fr": "",
        "nl": "",
        "de": "",
        "it": "",
        "pl": "",
        "ro": "",
        "sq": "",
        "be": "",
        "bg": "",
        "hr": "",
        "cs": "",
        "da": "",
        "et": "",
        "fi": "",
        "el": "",
        "hu": "",
        "is": "",
        "ga": "",
        "lv": "",
        "lt": "",
        "mk": "",
        "mt": "",
        "no": "",
        "pt": "",
        "ru": "",
        "sr": "",
        "sk": "",
        "sl": "",
        "es": "",
        "sv": "",
        "uk": "",
        "cy": ""
      },
      "documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "validationType": "auto",
      "integrationSendOriginal": false,
      "convertToPDF": false,
      "isUnique": false,
      "expiresInMonths": 2,
      "isRectoVerso": false,
      "skipBackup": false
    },
    "candidate": {
      "accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "email": "[email protected]",
      "firstName": "James",
      "lastName": "Good",
      "reference": "Best Candidate",
      "language": "en",
      "welcomeText": "Hi John, we are glad to welcome you to the company!",
      "welcomeTextType": "default",
      "assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "additionalEmails": [
        "[email protected]"
      ],
      "snoozed": false,
      "mobilePhone": "003801234567890",
      "notes": "Some notes",
      "deadline": "2019-09-12T15:36:09.264Z",
      "createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "status": "pending",
      "token": "2ScQsIW1OPHsjEFRs",
      "archived": false,
      "integrationChanged": false,
      "clientIsMobile": false,
      "clientVersion": "",
      "lastLoggedAt": "2019-09-12T15:36:09.264Z",
      "statusUpdateAt": "2019-09-12T15:36:09.264Z",
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z"
    },
    "documents": [
      {
        "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "name": "ASAP",
        "description": "Description of the document type",
        "internal": false,
        "folder": "string",
        "customStatus": "validated",
        "isProcessing": false,
        "combinedMultipleDocumentPath": "string",
        "combinedMultipleDocumentName": "string",
        "createdAt": "2019-09-12T15:36:09.264Z",
        "updatedAt": "2019-09-12T15:36:09.264Z",
        "filename": "file_of_the_company_candidate_{candidateFirstname}",
        "comment": "string",
        "commentType": "info",
        "mandatory": false
      }
    ],
    "customFields": [
      {
        "customField": {
          "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
          "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
          "createdAt": "2019-09-12T15:36:09.264Z",
          "updatedAt": "2019-09-12T15:36:09.264Z",
          "name": "Document Number",
          "nameI18n": {
            "en": "",
            "fr": "",
            "nl": "",
            "de": "",
            "it": "",
            "pl": "",
            "ro": "",
            "sq": "",
            "be": "",
            "bg": "",
            "hr": "",
            "cs": "",
            "da": "",
            "et": "",
            "fi": "",
            "el": "",
            "hu": "",
            "is": "",
            "ga": "",
            "lv": "",
            "lt": "",
            "mk": "",
            "mt": "",
            "no": "",
            "pt": "",
            "ru": "",
            "sr": "",
            "sk": "",
            "sl": "",
            "es": "",
            "sv": "",
            "uk": "",
            "cy": ""
          },
          "reference": "DOC_NUM",
          "fieldType": "string",
          "description": "This custom field is required to store the passport series.",
          "descriptionI18n": {
            "en": "",
            "fr": "",
            "nl": "",
            "de": "",
            "it": "",
            "pl": "",
            "ro": "",
            "sq": "",
            "be": "",
            "bg": "",
            "hr": "",
            "cs": "",
            "da": "",
            "et": "",
            "fi": "",
            "el": "",
            "hu": "",
            "is": "",
            "ga": "",
            "lv": "",
            "lt": "",
            "mk": "",
            "mt": "",
            "no": "",
            "pt": "",
            "ru": "",
            "sr": "",
            "sk": "",
            "sl": "",
            "es": "",
            "sv": "",
            "uk": "",
            "cy": ""
          },
          "visibilityRules": {
            "admin": {
              "visible": true,
              "editable": true,
              "mandatory": false
            },
            "candidate": {
              "visible": true,
              "editable": true,
              "mandatory": false
            }
          },
          "accountIds": [
            "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
          ],
          "docTypeIds": [
            "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
          ],
          "orderNbr": 3
        },
        "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "createdAt": "2019-09-12T15:36:09.264Z",
        "updatedAt": "2019-09-12T15:36:09.264Z",
        "candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "value": "1234-456-32"
      }
    ],
    "faceMatch": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "similarity": 0.999332,
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z"
    },
    "images": [
      {
        "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "type": "portrait",
        "createdAt": "2019-09-12T15:36:09.264Z",
        "updatedAt": "2019-09-12T15:36:09.264Z"
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful candidateDocumentTypeFindResponse

Response Headers

Status Header Type Format Description
200 X-CURRENT-PAGE integer Current page
200 X-PAGE-OFFSET integer Current offset
200 X-PAGE-LIMIT integer Current limit
200 X-TOTAL-PAGES integer The total number of pages.
200 X-TOTAL-RECORDS integer The total number of items.

Update candidate document types

Code samples

PATCH https://api.checkhub.io/candidateDocumentTypes HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json


const inputBody = '[
  {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "customStatus": "validated",
    "comment": "string",
    "commentType": "info"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateDocumentTypes',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


const fetch = require('node-fetch');
const inputBody = [
  {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "customStatus": "validated",
    "comment": "string",
    "commentType": "info"
  }
];
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateDocumentTypes',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.patch('https://api.checkhub.io/candidateDocumentTypes', headers = headers)

print(r.json())


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.patch 'https://api.checkhub.io/candidateDocumentTypes',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /candidateDocumentTypes

Body parameter

[
  {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "customStatus": "validated",
    "comment": "string",
    "commentType": "info"
  }
]

Parameters

Name In Type Required Description
body body candidateDocumentTypeUpdateBody false none

Example responses

200 Response

[
  {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "name": "ASAP",
    "description": "Description of the document type",
    "internal": false,
    "folder": "string",
    "customStatus": "pending",
    "ocrParsedData": {},
    "validationSnapshot": {
      "total": 10,
      "totalToBePending": 10,
      "conditions": [
        {
          "type": "or",
          "action": "score",
          "score": 10,
          "sequence": 1,
          "isValid": true,
          "validations": [
            {
              "rule": "string",
              "method": "contains",
              "value": {
                "value": "value"
              },
              "fieldName": "firstName",
              "fieldValue": "Field value",
              "sequence": 1,
              "isValid": true
            }
          ]
        }
      ]
    },
    "integrationTransferedAt": "string",
    "mergeSetFilePath": "string",
    "isMultiple": false,
    "isProcessing": false,
    "isPaused": false,
    "combinedMultipleDocumentPath": "string",
    "combinedMultipleDocumentName": "string",
    "expiresOn": "2019-09-12T15:36:09.264Z",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "filename": "file_of_the_company_candidate_{candidateFirstname}",
    "comment": "string",
    "commentType": "info",
    "mandatory": false
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful candidateDocumentTypeArray

Change candidate document types

Code samples

PUT