NAV Navigation
HTTP JavaScript Node.JS Python Ruby

CheckHub API v1.72.7

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

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>Hi!</p>",
    "nl": "<p>Hoi!</p>",
    "fr": "<p>Salut!</p>",
    "de": "<p>Hallo!</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>Hi!</p>",
    "nl": "<p>Hoi!</p>",
    "fr": "<p>Salut!</p>",
    "de": "<p>Hallo!</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>Hi!</p>",
    "nl": "<p>Hoi!</p>",
    "fr": "<p>Salut!</p>",
    "de": "<p>Hallo!</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 accountWelcomeText false This scheme is a collection of greetings for users of this account in different languages.
» en body string(html) false Used for users whose language is "English"
» nl body string(html) false Used for users whose language is "Dutch"
» fr body string(html) false Used for users whose language is "French"
» de body string(html) false Used for users whose language is "German"

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": {
    "en": "<p>Hi!</p>",
    "nl": "<p>Hoi!</p>",
    "fr": "<p>Salut!</p>",
    "de": "<p>Hallo!</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 default: 10
skip query number false Number of items skipped during the selection. 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
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": {
      "en": "<p>Hi!</p>",
      "nl": "<p>Hoi!</p>",
      "fr": "<p>Salut!</p>",
      "de": "<p>Hallo!</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",
        "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "additionalEmails": [
          "[email protected]"
        ],
        "snoozed": false,
        "mobilePhone": "003801234567890",
        "notes": "Some notes",
        "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 need to 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 need to 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

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": {
    "en": "<p>Hi!</p>",
    "nl": "<p>Hoi!</p>",
    "fr": "<p>Salut!</p>",
    "de": "<p>Hallo!</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",
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "additionalEmails": [
        "[email protected]"
      ],
      "snoozed": false,
      "mobilePhone": "003801234567890",
      "notes": "Some notes",
      "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>Hi!</p>",
    "nl": "<p>Hoi!</p>",
    "fr": "<p>Salut!</p>",
    "de": "<p>Hallo!</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>Hi!</p>",
    "nl": "<p>Hoi!</p>",
    "fr": "<p>Salut!</p>",
    "de": "<p>Hallo!</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>Hi!</p>",
    "nl": "<p>Hoi!</p>",
    "fr": "<p>Salut!</p>",
    "de": "<p>Hallo!</p>"
  }
}

Parameters

Name In Type Required Description
id path string true Model id which need to be updated
name body string false Account name
reference body string false Account reference (unique identifier for the account)
welcomeText body accountWelcomeText false This scheme is a collection of greetings for users of this account in different languages.
» en body string(html) false Used for users whose language is "English"
» nl body string(html) false Used for users whose language is "Dutch"
» fr body string(html) false Used for users whose language is "French"
» de body string(html) false Used for users whose language is "German"

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": {
    "en": "<p>Hi!</p>",
    "nl": "<p>Hoi!</p>",
    "fr": "<p>Salut!</p>",
    "de": "<p>Hallo!</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 default: 10
skip query number false Number of items skipped during the selection. default: 0
filter[name] query string false Search by admin user firstName, lastName, email
filter[languages][] query string false Search by admin language (or)
includeViewSettings query boolean false To include admin user 'viewSettings' 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

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",
    "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,
    "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"
      ],
      "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"
    }
  }
]

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,
  "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,
  "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,
  "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
password body string true Admin User Password

Enumerated Values

Parameter Value
gender
gender api
gender male
gender female
language en
language fr
language nl
language de

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",
  "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
}

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 need to be founded
includeViewSettings query boolean false To include admin user 'viewSettings' 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",
  "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,
  "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"
    ],
    "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"
  }
}

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,
  "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,
  "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,
  "newPassword": "6kgiWMzhKD0IPzRS"
}

Parameters

Name In Type Required Description
id path string true Model id which need to 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
newPassword body string false New password for the user

Enumerated Values

Parameter Value
gender
gender api
gender male
gender female
language en
language fr
language nl
language de

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",
  "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
}

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
Content-Type: application/json
Accept: application/json

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

fetch('https://api.checkhub.io/adminUsers/{id}',
{
  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 = {};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUsers/{id}',
{
  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/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.delete 'https://api.checkhub.io/adminUsers/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /adminUsers/{id}

Body parameter

{}

Parameters

Name In Type Required Description
id path string true Model id which need to 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": 86400,
  "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

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",
  "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,
  "elevioUserHash": "828caxxxxxxx4cdde",
  "elevioGroups": [],
  "elevioTraits": [],
  "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"
    ],
    "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"
  }
}

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 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 default: 10
skip query number false Number of items skipped during the selection. default: 0
order query string false Admin user group collection order
filter[name] query string false Search by admin user group name

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",
    "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
  }
]

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

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.

Example responses

200 Response

{
  "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": "First-line managers",
  "adminUsers": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "adminUserRights": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "accounts": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "isAllAccounts": false
}

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 need to be founded

Example responses

200 Response

{
  "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": "First-line managers",
  "adminUsers": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "adminUserRights": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "accounts": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "isAllAccounts": false
}

Responses

Status Meaning Description Schema
200 OK Request was successful adminUserGroup

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

Parameters

Name In Type Required Description
id path string true Model id which need to 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.

Example responses

200 Response

{
  "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": "First-line managers",
  "adminUsers": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "adminUserRights": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "accounts": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "isAllAccounts": false
}

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
Content-Type: application/json
Accept: application/json

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

fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
  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 = {};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
  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/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.delete 'https://api.checkhub.io/adminUserGroups/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /adminUserGroups/{id}

Body parameter

{}

Parameters

Name In Type Required Description
id path string true Model id which need to 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 default: 10
skip query number false Number of items skipped during the selection. 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

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 need to 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",
  "additionalEmails": [
    "[email protected]"
  ],
  "snoozed": false,
  "mobilePhone": "+3801234567890",
  "notes": "Some notes",
  "customFields": [
    {
      "customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "value": "custom_value"
    }
  ],
  "tagIds": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ]
}';
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",
  "additionalEmails": [
    "[email protected]"
  ],
  "snoozed": false,
  "mobilePhone": "+3801234567890",
  "notes": "Some notes",
  "customFields": [
    {
      "customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "value": "custom_value"
    }
  ],
  "tagIds": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ]
};
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",
  "additionalEmails": [
    "[email protected]"
  ],
  "snoozed": false,
  "mobilePhone": "+3801234567890",
  "notes": "Some notes",
  "customFields": [
    {
      "customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "value": "custom_value"
    }
  ],
  "tagIds": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ]
}

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

Enumerated Values

Parameter Value
language en
language fr
language nl
language de
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",
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "additionalEmails": [
    "[email protected]"
  ],
  "snoozed": false,
  "mobilePhone": "003801234567890",
  "notes": "Some notes",
  "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
filter[reference] query string false Filter by candidate 'reference' field
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[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)
skip query number false Number of items skipped during the selection. default: 0
limit query number false Maximum number of items in the response default: 10
order query string false Candidates order
includeCompany query boolean false You can include candidate 'company' relation
includeAccount query boolean false You can include candidate 'account' relation
includeDocumentStatistic query boolean false You can include candidate 'documentStatistic' relation
includeConversation query boolean false You can include candidate 'conversation' relation
includeCustomFields query boolean false You can include candidate 'customFields' relation
includeUser query boolean false You can include candidate 'user' relation
includeTags query boolean false You can include candidate 'tags' relation
includeCandidateDocumentTypes query boolean false You can include candidate 'candidateDocumentTypes' relation
includeResources query boolean false You can include candidate 'resources' relation

Enumerated Values

Parameter Value
filter[statuses][] open
filter[statuses][] pending
filter[statuses][] completed
order createdAt asc
order createdAt desc
order updatedAt asc
order updatedAt desc

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",
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "additionalEmails": [
      "[email protected]"
    ],
    "snoozed": false,
    "mobilePhone": "003801234567890",
    "notes": "Some notes",
    "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": {
        "en": "<p>Hi!</p>",
        "nl": "<p>Hoi!</p>",
        "fr": "<p>Salut!</p>",
        "de": "<p>Hallo!</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"
      ],
      "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",
      "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
    },
    "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": [
          {}
        ],
        "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": null,
        "ocrParsedData": {},
        "validationSnapshot": {},
        "integrationTransferedAt": "string",
        "mergeSetFilePath": "string",
        "isMultiple": false,
        "isProcessing": 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,
        "isPaused": 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

Delete 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


const headers = {
  '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 = {
  '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 = {
  'Authorization': 'API_KEY'
}

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

print(r.json())

require 'rest-client'
require 'json'

headers = {
  '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 need to be deleted

Responses

Status Meaning Description Schema
200 OK Request was successful None

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 need to be founded
includeCompany query boolean false You can include candidate 'company' relation
includeAccount query boolean false You can include candidate 'account' relation
includeDocumentStatistic query boolean false You can include candidate 'documentStatistic' relation
includeConversation query boolean false You can include candidate 'conversation' relation
includeCustomFields query boolean false You can include candidate 'customFields' relation
includeUser query boolean false You can include candidate 'user' relation
includeTags query boolean false You can include candidate 'tags' relation
includeCandidateDocumentTypes query boolean false You can include candidate 'candidateDocumentTypes' relation
includeResources query boolean false You can include candidate 'resources' 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",
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "additionalEmails": [
    "[email protected]"
  ],
  "snoozed": false,
  "mobilePhone": "003801234567890",
  "notes": "Some notes",
  "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": {
      "en": "<p>Hi!</p>",
      "nl": "<p>Hoi!</p>",
      "fr": "<p>Salut!</p>",
      "de": "<p>Hallo!</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"
    ],
    "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",
    "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
  },
  "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": {}
        }
      ],
      "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": null,
      "ocrParsedData": {},
      "validationSnapshot": {},
      "integrationTransferedAt": "string",
      "mergeSetFilePath": "string",
      "isMultiple": false,
      "isProcessing": 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,
      "isPaused": 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",
  "additionalEmails": [
    "[email protected]"
  ],
  "snoozed": false,
  "mobilePhone": "+3801234567890",
  "notes": "Some notes about candidate",
  "archived": false
}';
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",
  "additionalEmails": [
    "[email protected]"
  ],
  "snoozed": false,
  "mobilePhone": "+3801234567890",
  "notes": "Some notes about candidate",
  "archived": false
};
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",
  "additionalEmails": [
    "[email protected]"
  ],
  "snoozed": false,
  "mobilePhone": "+3801234567890",
  "notes": "Some notes about candidate",
  "archived": false
}

Parameters

Name In Type Required Description
id path string true Model id which need to 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
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
archived body boolean false Archive or Unarchive candidate

Enumerated Values

Parameter Value
language en
language fr
language nl
language de
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",
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "additionalEmails": [
    "[email protected]"
  ],
  "snoozed": false,
  "mobilePhone": "003801234567890",
  "notes": "Some notes",
  "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

Body parameter

Parameters

Name In Type Required Description
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[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)
order query string false Candidates order

Enumerated Values

Parameter Value
filter[statuses][] open
filter[statuses][] pending
filter[statuses][] completed
order createdAt asc
order createdAt desc
order updatedAt asc
order updatedAt desc

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",
      "additionalEmails": [
        "[email protected]"
      ],
      "mobilePhone": "+3801234567890",
      "preset": "preset_1, preset_2",
      "tags": [
        "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
      ],
      "presetId": "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"
    }
  ],
  "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",
      "additionalEmails": [
        "[email protected]"
      ],
      "mobilePhone": "+3801234567890",
      "preset": "preset_1, preset_2",
      "tags": [
        "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
      ],
      "presetId": "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"
    }
  ],
  "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",
      "additionalEmails": [
        "[email protected]"
      ],
      "mobilePhone": "+3801234567890",
      "preset": "preset_1, preset_2",
      "tags": [
        "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
      ],
      "presetId": "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"
    }
  ],
  "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
» 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
» 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
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
» commentType info
» commentType success
» commentType warning
» commentType danger
» 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


const headers = {
  'X-CSRF-TOKEN':'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 = {
  'X-CSRF-TOKEN':'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 = {
  'X-CSRF-TOKEN': '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 = {
  'X-CSRF-TOKEN' => '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 need to be founded

Responses

Status Meaning Description Schema
200 OK Request was successful None

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 need to 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 default: 10
skip query number false Number of items skipped during the selection. default: 0
order query string false Candidate Token collection order
filter[validToken] query candidateTokenValid false Search by candidate token state
filter[tokenType] query candidateTokenType false Search by candidate token type
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
filter[tokenType] candidate

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",
    "tokenType": "candidate",
    "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",
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "additionalEmails": [
        "[email protected]"
      ],
      "snoozed": false,
      "mobilePhone": "003801234567890",
      "notes": "Some notes",
      "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",
  "tokenType": "candidate",
  "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",
  "tokenType": "candidate",
  "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",
  "tokenType": "candidate",
  "validToken": true
}

Parameters

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

Enumerated Values

Parameter Value
tokenType candidate

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",
  "tokenType": "candidate",
  "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 need to 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",
  "tokenType": "candidate",
  "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",
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "additionalEmails": [
      "[email protected]"
    ],
    "snoozed": false,
    "mobilePhone": "003801234567890",
    "notes": "Some notes",
    "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 = '{
  "tokenType": "candidate",
  "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 = {
  "tokenType": "candidate",
  "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

{
  "tokenType": "candidate",
  "validToken": true
}

Parameters

Name In Type Required Description
id path string true Model id which need to be updated
tokenType body candidateTokenType false Candidate token type
validToken body candidateTokenValid false Is valid candidate token

Enumerated Values

Parameter Value
tokenType candidate

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",
  "tokenType": "candidate",
  "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
Content-Type: application/json
Accept: application/json

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

fetch('https://api.checkhub.io/candidateTokens/{id}',
{
  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 = {};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateTokens/{id}',
{
  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/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.delete 'https://api.checkhub.io/candidateTokens/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /candidateTokens/{id}

Body parameter

{}

Parameters

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

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful successfullyCompletedRequest

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

Name In Type Required Description
link path string true Token link

Example responses

200 Response

{
  "token": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "tokenType": "candidate"
}
Status Meaning Description Schema
200 OK Request was successful candidateTokenFindByLinkResponse

Tag

Add new tag to the company

Code samples

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

const inputBody = '{
  "name": "ASAP",
  "color": "#F09E38"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/tags',
{
  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": "ASAP",
  "color": "#F09E38"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/tags',
{
  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/tags', 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/tags',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /tags

Body parameter

{
  "name": "ASAP",
  "color": "#F09E38"
}

Parameters

Name In Type Required Description
body body tagCreate false none

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "name": "ASAP",
  "color": "#F09E38",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z"
}

Responses

Status Meaning Description Schema
200 OK Request was successful tag

Get list of existing tags

Code samples

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


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

fetch('https://api.checkhub.io/tags',
{
  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/tags',
{
  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/tags', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

GET /tags

Parameters

Name In Type Required Description
filter[searchText] query string false Search by tag name
order query string false Tags collection order
limit query number false Maximum number of items in the response default: 10
skip query number false Number of items skipped during the selection. default: 0
includeStatistic query boolean false To include tag statistic 'statistic' 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",
    "name": "ASAP",
    "color": "#F09E38",
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z",
    "statistic": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "scenarios": 3,
      "candidates": 12
    }
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful tagFind

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 tag by {{id}} from the company.

Code samples

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


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

fetch('https://api.checkhub.io/tags/{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/tags/{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/tags/{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/tags/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /tags/{id}

Parameters

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

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful successfullyCompletedRequest

Get tag by {{id}}

Code samples

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


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

fetch('https://api.checkhub.io/tags/{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/tags/{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/tags/{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/tags/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /tags/{id}

Parameters

Name In Type Required Description
id path string true Model id which need to be founded
includeStatistic query boolean false To include tag statistic 'statistic' relation

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "name": "ASAP",
  "color": "#F09E38",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z",
  "statistic": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "scenarios": 3,
    "candidates": 12
  }
}

Responses

Status Meaning Description Schema
200 OK Request was successful tagWithStatistic

Update tag by {{id}}

Code samples

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

const inputBody = '{
  "name": "ASAP",
  "color": "#F09E38"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/tags/{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": "ASAP",
  "color": "#F09E38"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/tags/{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/tags/{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/tags/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /tags/{id}

Body parameter

{
  "name": "ASAP",
  "color": "#F09E38"
}

Parameters

Name In Type Required Description
id path string true Model id which need to be updated
body body tagUpdate false none

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "name": "ASAP",
  "color": "#F09E38",
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z"
}

Responses

Status Meaning Description Schema
200 OK Request was successful tag

Number of tags in the company

Code samples

GET https://api.checkhub.io/tags/count HTTP/1.1
Host: api.checkhub.io


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

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

  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/tags/count',
{
  method: 'GET',

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

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

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

print(r.json())

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

GET /tags/count

Responses

Status Meaning Description Schema
200 OK Request was successful None

Check if such tag name exists

Code samples

GET https://api.checkhub.io/tags/validate?name=string HTTP/1.1
Host: api.checkhub.io
Accept: application/json


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

fetch('https://api.checkhub.io/tags/validate?name=string',
{
  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/tags/validate?name=string',
{
  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/tags/validate', params={
  'name': 'string'
}, headers = headers)

print(r.json())

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.checkhub.io/tags/validate',
  params: {
  'name' => 'string'
}, headers: headers

p JSON.parse(result)

GET /tags/validate

Parameters

Name In Type Required Description
name query string true Tag name to check

Example responses

200 Response

{
  "uniq": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful tagValidate

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,
  "isPaused": 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,
  "isPaused": 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,
  "isPaused": 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
isPaused body boolean false Cancels the automatic confirm of the document if the uploading is not confirmed manually.
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": null,
  "ocrParsedData": {},
  "validationSnapshot": {},
  "integrationTransferedAt": "string",
  "mergeSetFilePath": "string",
  "isMultiple": false,
  "isProcessing": 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,
  "isPaused": 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 default: 10
skip query number false Number of items skipped during the selection. 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 undefined false Filter result by custom statuses (or)
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

Enumerated Values

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

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": null,
    "ocrParsedData": {},
    "validationSnapshot": {},
    "integrationTransferedAt": "string",
    "mergeSetFilePath": "string",
    "isMultiple": false,
    "isProcessing": 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,
    "isPaused": 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",
      "nameI18n": {
        "en": "",
        "fr": "",
        "nl": "",
        "de": ""
      },
      "description": "Document Type description",
      "descriptionI18n": {
        "en": "",
        "fr": "",
        "nl": "",
        "de": ""
      },
      "documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "validationType": "auto",
      "integrationSendOriginal": false,
      "convertToPDF": false,
      "isUnique": false,
      "expiresInMonths": 2,
      "isRectoVerso": 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",
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "additionalEmails": [
        "[email protected]"
      ],
      "snoozed": false,
      "mobilePhone": "003801234567890",
      "notes": "Some notes",
      "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": null,
        "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": [
      {
        "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"
      }
    ]
  }
]

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"
  }
]';
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"
  }
];
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"
  }
]

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": null,
    "ocrParsedData": {},
    "validationSnapshot": {},
    "integrationTransferedAt": "string",
    "mergeSetFilePath": "string",
    "isMultiple": false,
    "isProcessing": 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,
    "isPaused": false
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful candidateDocumentTypeArray

Change candidate document types

Code samples

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

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

fetch('https://api.checkhub.io/candidateDocumentTypes',
{
  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 = {
  "create": [],
  "delete": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateDocumentTypes',
{
  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/candidateDocumentTypes', 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/candidateDocumentTypes',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /candidateDocumentTypes

Body parameter

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

Parameters

Name In Type Required Description
body body candidateDocumentTypeChangeBody false none

Example responses

200 Response

{
  "created": [
    {
      "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": null,
      "ocrParsedData": {},
      "validationSnapshot": {},
      "integrationTransferedAt": "string",
      "mergeSetFilePath": "string",
      "isMultiple": false,
      "isProcessing": 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,
      "isPaused": false
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateDocumentTypeChangeResponse

Delete candidate document types

Code samples

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

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

fetch('https://api.checkhub.io/candidateDocumentTypes',
{
  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 = {
  "ids": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateDocumentTypes',
{
  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/candidateDocumentTypes', 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/candidateDocumentTypes',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /candidateDocumentTypes

Body parameter

{
  "ids": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ]
}

Parameters

Name In Type Required Description
limit query number false Maximum number of items in the response default: 10
skip query number false Number of items skipped during the selection. 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 undefined false Filter result by custom statuses (or)
ids body [UUID_V4] true Candidate document type ids

Enumerated Values

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

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful successfullyCompletedRequest

Get candidate document type by {{id}}

Code samples

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


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

fetch('https://api.checkhub.io/candidateDocumentTypes/{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/candidateDocumentTypes/{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/candidateDocumentTypes/{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/candidateDocumentTypes/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /candidateDocumentTypes/{id}

Parameters

Name In Type Required Description
id path string true Model id which need to be founded
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

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": null,
  "ocrParsedData": {},
  "validationSnapshot": {},
  "integrationTransferedAt": "string",
  "mergeSetFilePath": "string",
  "isMultiple": false,
  "isProcessing": 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,
  "isPaused": 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",
    "nameI18n": {
      "en": "",
      "fr": "",
      "nl": "",
      "de": ""
    },
    "description": "Document Type description",
    "descriptionI18n": {
      "en": "",
      "fr": "",
      "nl": "",
      "de": ""
    },
    "documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "validationType": "auto",
    "integrationSendOriginal": false,
    "convertToPDF": false,
    "isUnique": false,
    "expiresInMonths": 2,
    "isRectoVerso": 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",
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "additionalEmails": [
      "[email protected]"
    ],
    "snoozed": false,
    "mobilePhone": "003801234567890",
    "notes": "Some notes",
    "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": null,
      "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": [
    {
      "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"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateDocumentTypeFindByIdResponse

Update candidate document type by {{id}}

Code samples

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

const inputBody = '{
  "ocrParsedData": {},
  "isPaused": false,
  "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/{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 = {
  "ocrParsedData": {},
  "isPaused": false,
  "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/{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/candidateDocumentTypes/{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/candidateDocumentTypes/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /candidateDocumentTypes/{id}

Body parameter

{
  "ocrParsedData": {},
  "isPaused": false,
  "filename": "file_of_the_company_candidate_{candidateFirstname}",
  "comment": "string",
  "commentType": "info",
  "mandatory": false,
  "folder": "string"
}

Parameters

Name In Type Required Description
id path string true Model id which need to be updated
ocrParsedData body object false Candidate Document Type parsed data
isPaused body boolean false Cancels the automatic confirm of the document if the uploading is not confirmed manually.
filename body string false 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 false 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": null,
  "ocrParsedData": {},
  "validationSnapshot": {},
  "integrationTransferedAt": "string",
  "mergeSetFilePath": "string",
  "isMultiple": false,
  "isProcessing": 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,
  "isPaused": false
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateDocumentType

Delete candidate document type by {{id}}

Code samples

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


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

fetch('https://api.checkhub.io/candidateDocumentTypes/{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/candidateDocumentTypes/{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/candidateDocumentTypes/{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/candidateDocumentTypes/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /candidateDocumentTypes/{id}

Body parameter

Parameters

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

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful successfullyCompletedRequest

Archive candidate document types

Code samples

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

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

fetch('https://api.checkhub.io/candidateDocumentTypes/archive',
{
  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 = {
  "ids": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/zip',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateDocumentTypes/archive',
{
  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/zip',
  'Authorization': 'API_KEY'
}

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

print(r.json())

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

POST /candidateDocumentTypes/archive

Body parameter

{
  "ids": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ]
}

Parameters

Name In Type Required Description
limit query number false Maximum number of items in the response default: 10
skip query number false Number of items skipped during the selection. 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 undefined false Filter result by custom statuses (or)
ids body [UUID_V4] false Array of candidate document type ids

Enumerated Values

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

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Download ZIP archive file with candidate documents string

Export candidate document types

Code samples

POST https://api.checkhub.io/candidateDocumentTypes/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/candidateDocumentTypes/export',
{
  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/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
  'Authorization':'API_KEY'
};

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

  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.post('https://api.checkhub.io/candidateDocumentTypes/export', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

POST /candidateDocumentTypes/export

Body parameter

Parameters

Name In Type Required Description
limit query number false Maximum number of items in the response default: 10
skip query number false Number of items skipped during the selection. 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 undefined false Filter result by custom statuses (or)

Enumerated Values

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

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Export XLSX file with candidate document types details string

Complete single or multiple document upload

Code samples

POST https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/uploadComplete HTTP/1.1
Host: api.checkhub.io
Accept: application/json


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

fetch('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/uploadComplete',
{
  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',
  'X-CSRF-TOKEN':'API_KEY'
};

fetch('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/uploadComplete',
{
  method: 'POST',

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

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

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

print(r.json())

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

POST /candidateDocumentTypes/{candidateDocumentTypeId}/uploadComplete

Parameters

Name In Type Required Description
candidateDocumentTypeId path string true Candidate document type id which need to be used to work with related resources

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful successfullyCompletedRequest

Update candidate documents

Code samples

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

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

fetch('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents',
{
  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",
    "position": 1
  }
];
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-CSRF-TOKEN':'API_KEY'
};

fetch('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents',
{
  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',
  'X-CSRF-TOKEN': 'API_KEY'
}

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

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'X-CSRF-TOKEN' => 'API_KEY'
}

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

p JSON.parse(result)

PATCH /candidateDocumentTypes/{candidateDocumentTypeId}/documents

Body parameter

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

Parameters

Name In Type Required Description
candidateDocumentTypeId path string true Candidate document type id which need to be used to work with related resources
body body candidateDocumentTypeUpdateCandidateDocumentsBody 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": null,
    "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
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful candidateDocumentArray

Delete candidate documents

Code samples

DELETE https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json

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

fetch('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents',
{
  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 = {
  "ids": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents',
{
  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/candidateDocumentTypes/{candidateDocumentTypeId}/documents', 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/candidateDocumentTypes/{candidateDocumentTypeId}/documents',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /candidateDocumentTypes/{candidateDocumentTypeId}/documents

Body parameter

{
  "ids": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ]
}

Parameters

Name In Type Required Description
candidateDocumentTypeId path string true Candidate document type id which need to be used to work with related resources
ids body [UUID_V4] true Candidate document ids

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful successfullyCompletedRequest

Delete candidate document by {{id}}

Code samples

DELETE https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents/{candidateDocumentId} HTTP/1.1
Host: api.checkhub.io
Accept: application/json


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

fetch('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents/{candidateDocumentId}',
{
  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',
  'X-CSRF-TOKEN':'API_KEY'
};

fetch('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents/{candidateDocumentId}',
{
  method: 'DELETE',

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

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

r = requests.delete('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents/{candidateDocumentId}', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

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

result = RestClient.delete 'https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents/{candidateDocumentId}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /candidateDocumentTypes/{candidateDocumentTypeId}/documents/{candidateDocumentId}

Body parameter

Parameters

Name In Type Required Description
candidateDocumentTypeId path string true Candidate document type id which need to be used to work with related resources
candidateDocumentId path string true Candidate document should be deleted by the 'candidateDocumentId'

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful successfullyCompletedRequest

Candidate Resource

Add new resource for candidate

Code samples

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

const inputBody = '{
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "actions": [
    "complete",
    "download"
  ],
  "blocking": false,
  "folder": "Policies"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateResources',
{
  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",
  "resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "actions": [
    "complete",
    "download"
  ],
  "blocking": false,
  "folder": "Policies"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateResources',
{
  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/candidateResources', 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/candidateResources',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /candidateResources

Body parameter

{
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "actions": [
    "complete",
    "download"
  ],
  "blocking": false,
  "folder": "Policies"
}

Parameters

Name In Type Required Description
candidateId body UUID_V4 true Unique identifier for the entity
resourceId body UUID_V4 true Unique identifier for the entity
actions body [resourceAction] false Resource actions (at least one action required)
blocking body boolean false Used for resources that must be completed before starting to work with documents.
folder body string false The folder to which the candidate resource will belong. Note: this is only visual separation, does not affect storage in the file system in any way.

Enumerated Values

Parameter Value
actions read
actions complete
actions download

Example responses

200 Response

{
  "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"
      }
    }
  ],
  "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"
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateResource

Create or update new resource for candidate

Code samples

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

const inputBody = '{
  "create": [
    {
      "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ],
      "blocking": false,
      "folder": "Policies"
    }
  ],
  "delete": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateResources',
{
  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 = {
  "create": [
    {
      "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ],
      "blocking": false,
      "folder": "Policies"
    }
  ],
  "delete": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateResources',
{
  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/candidateResources', 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/candidateResources',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /candidateResources

Body parameter

{
  "create": [
    {
      "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ],
      "blocking": false,
      "folder": "Policies"
    }
  ],
  "delete": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
    }
  ]
}

Parameters

Name In Type Required Description
body body candidateResourceChangeBody false none

Example responses

200 Response

{
  "created": [
    {
      "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": {}
        }
      ],
      "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"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateResourceChangeResponse

Get list of candidate resources

Code samples

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


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

fetch('https://api.checkhub.io/candidateResources',
{
  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/candidateResources',
{
  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/candidateResources', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

GET /candidateResources

Parameters

Name In Type Required Description
limit query number false Maximum number of items in the response default: 10
skip query number false Number of items skipped during the selection. default: 0
order query string false Candidate resource collection order
filter[candidateId] query UUID_V4 false Search by candidateId
filter[resourceId] query UUID_V4 false Search by resourceId
filter[ids][] query UUID_V4 false Search by candidate resources ids
filter[blocking] query boolean false Search by candidate resource blocking property
filter[locked] query boolean false Search by candidate resource locked property
filter[name] query string false Search by candidate resource name property
includeResource query boolean false To include candidate resource 'resource' relation
includeCandidate query boolean false To include candidate resource 'candidate' relation

Enumerated Values

Parameter Value
order candidateId asc
order candidateId desc
order resourceId asc
order resourceId desc
order name asc
order name desc
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",
    "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"
        }
      }
    ],
    "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",
    "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",
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "additionalEmails": [
        "[email protected]"
      ],
      "snoozed": false,
      "mobilePhone": "003801234567890",
      "notes": "Some notes",
      "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"
    },
    "resource": {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "Diploma",
      "filename": "diploma_{candidateFirstname}",
      "type": "editable",
      "language": "en",
      "shareCode": "",
      "blocking": false,
      "version": 1,
      "actions": [
        "complete",
        "download"
      ],
      "content": {
        "text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n",
        "file": "resources/5fa52f8d07763975db16e720/4d30393f-eb29-4bb8-ba3e-c40efa79fb00_test.pdf",
        "originalFilename": "test.pdf"
      },
      "fields": [
        {
          "reference": "firstNameRef",
          "name": "First Name",
          "contentType": "text",
          "prefilled": "{candidateLastname}",
          "editable": true,
          "mandatory": false
        }
      ],
      "createdAt": "2019-09-12T15:36:09.264Z",
      "updatedAt": "2019-09-12T15:36:09.264Z"
    }
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful candidateResourceFindResponse

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 many candidate resources from candidate

Code samples

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

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

fetch('https://api.checkhub.io/candidateResources',
{
  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 = {
  "ids": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "locked": false,
  "blocking": false
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateResources',
{
  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/candidateResources', 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/candidateResources',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /candidateResources

Body parameter

{
  "ids": [
    "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
  ],
  "candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "locked": false,
  "blocking": false
}

Parameters

Name In Type Required Description
ids body [UUID_V4] false [Unique identifier for the entity]
candidateId body UUID_V4 false Unique identifier for the entity
resourceId body UUID_V4 false Unique identifier for the entity
locked body boolean false none
blocking body boolean false none

Example responses

200 Response

{
  "count": 1
}

Responses

Status Meaning Description Schema
200 OK Request was successful countOfModifiedObjects

Delete candidate resource by {{id}} from candidate

Code samples

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


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

fetch('https://api.checkhub.io/candidateResources/{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/candidateResources/{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/candidateResources/{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/candidateResources/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /candidateResources/{id}

Parameters

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

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful successfullyCompletedRequest

Get candidate resource by {{id}}

Code samples

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


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

fetch('https://api.checkhub.io/candidateResources/{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/candidateResources/{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/candidateResources/{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/candidateResources/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /candidateResources/{id}

Parameters

Name In Type Required Description
id path string true Model id which need to be founded
includeResource query boolean false To include candidate resource 'resource' relation
includeCandidate query boolean false To include candidate resource 'candidate' relation

Example responses

200 Response

{
  "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"
      }
    }
  ],
  "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",
  "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",
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "additionalEmails": [
      "[email protected]"
    ],
    "snoozed": false,
    "mobilePhone": "003801234567890",
    "notes": "Some notes",
    "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"
  },
  "resource": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "name": "Diploma",
    "filename": "diploma_{candidateFirstname}",
    "type": "editable",
    "language": "en",
    "shareCode": "",
    "blocking": false,
    "version": 1,
    "actions": [
      "complete",
      "download"
    ],
    "content": {
      "text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n",
      "file": "resources/5fa52f8d07763975db16e720/4d30393f-eb29-4bb8-ba3e-c40efa79fb00_test.pdf",
      "originalFilename": "test.pdf"
    },
    "fields": [
      {
        "reference": "firstNameRef",
        "name": "First Name",
        "contentType": "text",
        "prefilled": "{candidateLastname}",
        "editable": true,
        "mandatory": false
      }
    ],
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateResourceFindByIdResponse

Update candidate resource by {{id}}

Code samples

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

const inputBody = '{
  "actions": [
    "complete",
    "download"
  ],
  "blocking": false,
  "folder": "Policies"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateResources/{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 = {
  "actions": [
    "complete",
    "download"
  ],
  "blocking": false,
  "folder": "Policies"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidateResources/{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/candidateResources/{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/candidateResources/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /candidateResources/{id}

Body parameter

{
  "actions": [
    "complete",
    "download"
  ],
  "blocking": false,
  "folder": "Policies"
}

Parameters

Name In Type Required Description
id path string true Model id which need to be updated
actions body [resourceAction] false Resource actions (at least one action required)
blocking body boolean false Used for resources that must be completed before starting to work with documents.
folder body string false The folder to which the candidate resource will belong. Note: this is only visual separation, does not affect storage in the file system in any way.

Enumerated Values

Parameter Value
actions read
actions complete
actions download

Example responses

200 Response

{
  "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"
      }
    }
  ],
  "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"
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateResource

Set completed action by candidate

Code samples

PUT https://api.checkhub.io/candidateResources/{id}/{action} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "fields": {
    "{field reference for checkbox}": false,
    "{field reference for text}": "Mask",
    "{field reference for signature}": "data:image/png;base64,iVBORw0KGg"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-CSRF-TOKEN':'API_KEY'
};

fetch('https://api.checkhub.io/candidateResources/{id}/{action}',
{
  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 = {
  "fields": {
    "{field reference for checkbox}": false,
    "{field reference for text}": "Mask",
    "{field reference for signature}": "data:image/png;base64,iVBORw0KGg"
  }
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-CSRF-TOKEN':'API_KEY'
};

fetch('https://api.checkhub.io/candidateResources/{id}/{action}',
{
  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',
  'X-CSRF-TOKEN': 'API_KEY'
}

r = requests.put('https://api.checkhub.io/candidateResources/{id}/{action}', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'X-CSRF-TOKEN' => 'API_KEY'
}

result = RestClient.put 'https://api.checkhub.io/candidateResources/{id}/{action}',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /candidateResources/{id}/{action}

Body parameter

{
  "fields": {
    "{field reference for checkbox}": false,
    "{field reference for text}": "Mask",
    "{field reference for signature}": "data:image/png;base64,iVBORw0KGg"
  }
}

Parameters

Name In Type Required Description
id path string true Model id which need to be updated
action path string false Action completed by candidate
fields body object false Mapping of references and their actual values filled in by the candidate.
» {field reference for checkbox} body boolean false The value chosen by the candidate.
» {field reference for text} body string false The value entered by the candidate.
» {field reference for signature} body string false Base64 signature image.

Enumerated Values

Parameter Value
action read
action complete
action download

Example responses

200 Response

{
  "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"
      }
    }
  ],
  "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",
  "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",
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "additionalEmails": [
      "[email protected]"
    ],
    "snoozed": false,
    "mobilePhone": "003801234567890",
    "notes": "Some notes",
    "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"
  },
  "resource": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "name": "Diploma",
    "filename": "diploma_{candidateFirstname}",
    "type": "editable",
    "language": "en",
    "shareCode": "",
    "blocking": false,
    "version": 1,
    "actions": [
      "complete",
      "download"
    ],
    "content": {
      "text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n",
      "file": "resources/5fa52f8d07763975db16e720/4d30393f-eb29-4bb8-ba3e-c40efa79fb00_test.pdf",
      "originalFilename": "test.pdf"
    },
    "fields": [
      {
        "reference": "firstNameRef",
        "name": "First Name",
        "contentType": "text",
        "prefilled": "{candidateLastname}",
        "editable": true,
        "mandatory": false
      }
    ],
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateResourceFindByIdResponse

Get candidate editable resource content by candidate resource {{id}}

Code samples

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


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

fetch('https://api.checkhub.io/candidateResources/{id}/text',
{
  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',
  'X-CSRF-TOKEN':'API_KEY'
};

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

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

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

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

print(r.json())

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

GET /candidateResources/{id}/text

Parameters

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

Example responses

200 Response

{
  "text": "<p>It's the contract for Elon Mask.</p>"
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateResourceGetEditableContentResponse

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 string false 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

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 default: 10
skip query number false Number of items skipped during the selection. 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",
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "additionalEmails": [
        "[email protected]"
      ],
      "snoozed": false,
      "mobilePhone": "003801234567890",
      "notes": "Some notes",
      "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": ""
      },
      "reference": "DOC_NUM",
      "fieldType": "string",
      "description": "This custom field is required to store the passport series.",
      "descriptionI18n": {
        "en": "",
        "fr": "",
        "nl": "",
        "de": ""
      },
      "validationRules": {},
      "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.

Delete 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 need to 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 need to 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",
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "additionalEmails": [
      "[email protected]"
    ],
    "snoozed": false,
    "mobilePhone": "003801234567890",
    "notes": "Some notes",
    "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": ""
    },
    "reference": "DOC_NUM",
    "fieldType": "string",
    "description": "This custom field is required to store the passport series.",
    "descriptionI18n": {
      "en": "",
      "fr": "",
      "nl": "",
      "de": ""
    },
    "validationRules": {},
    "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 need to 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

Update candidate custom fields by candidate token

Code samples

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

const inputBody = '{
  "customFields": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "Document Number",
      "fieldType": "string",
      "orderNbr": 3,
      "value": "1234-456-32",
      "visibilityRules": {
        "visible": true,
        "editable": true,
        "mandatory": false
      }
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-CSRF-TOKEN':'API_KEY'
};

fetch('https://api.checkhub.io/candidateCustomFields/update/:candidateId',
{
  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 = {
  "customFields": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "Document Number",
      "fieldType": "string",
      "orderNbr": 3,
      "value": "1234-456-32",
      "visibilityRules": {
        "visible": true,
        "editable": true,
        "mandatory": false
      }
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-CSRF-TOKEN':'API_KEY'
};

fetch('https://api.checkhub.io/candidateCustomFields/update/:candidateId',
{
  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',
  'X-CSRF-TOKEN': 'API_KEY'
}

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

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'X-CSRF-TOKEN' => 'API_KEY'
}

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

p JSON.parse(result)

PUT /candidateCustomFields/update/:candidateId

Body parameter

{
  "customFields": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "Document Number",
      "fieldType": "string",
      "orderNbr": 3,
      "value": "1234-456-32",
      "visibilityRules": {
        "visible": true,
        "editable": true,
        "mandatory": false
      }
    }
  ]
}

Parameters

Name In Type Required Description
id path string true Model id which need to be updated
customFields body [candidateCustomFieldToUpdateByCandidate] false Array of candidate custom fields to update
» id body UUID_V4 true Unique identifier for the entity
» name body string true Visible name of the custom field.
» fieldType body string true Custom field type (only string is supported)
» orderNbr body number true Priority / order of the custom field in the list.
» value body string true none
» visibilityRules body customFieldVisibilityRulesOptions true Visibility rules for the entity
»» visible body boolean false Is this field visible.
»» editable body boolean false Is this field editable.
»» mandatory body boolean false Is this field mandatory.

Example responses

200 Response

{
  "customFields": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "Document Number",
      "fieldType": "string",
      "orderNbr": 3,
      "value": "1234-456-32",
      "visibilityRules": {
        "visible": true,
        "editable": true,
        "mandatory": false
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidateCustomFieldsToUpdateByCandidate

Candidate Preset

Get candidate preset collection

Code samples

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


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

fetch('https://api.checkhub.io/candidatePresets',
{
  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/candidatePresets',
{
  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/candidatePresets', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

GET /candidatePresets

Parameters

Name In Type Required Description
limit query number false Maximum number of items in the response default: 10
skip query number false Number of items skipped during the selection. default: 0
order query string false Candidate Preset collection order
filter[name] query string false Search by candidate preset name
filter[reference] query string false Search by candidate preset reference
includeCompany query boolean false To include candidate preset 'company' relation
includeShared query boolean false To include candidate presets from the companies of the same company group

Enumerated Values

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

Example responses

200 Response

[
  {
    "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": "Welcome set for NL",
    "reference": "WELCOME_SET",
    "docTypes": [
      {
        "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "name": "(Copy of the passport)",
        "comment": "Some comment",
        "folder": "Some comment",
        "commentType": "info",
        "mandatory": false
      }
    ],
    "resources": [
      {
        "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "actions": [
          "complete",
          "download"
        ]
      }
    ],
    "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"
      ],
      "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"
      }
    }
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful candidatePresetFindResponse

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 preset

Code samples

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

const inputBody = '{
  "name": "Welcome set for NL",
  "reference": "WELCOME_SET",
  "docTypes": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "(Copy of the passport)",
      "comment": "Some comment",
      "folder": "Some comment",
      "commentType": "info",
      "mandatory": false
    }
  ],
  "resources": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ]
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidatePresets',
{
  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": "Welcome set for NL",
  "reference": "WELCOME_SET",
  "docTypes": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "(Copy of the passport)",
      "comment": "Some comment",
      "folder": "Some comment",
      "commentType": "info",
      "mandatory": false
    }
  ],
  "resources": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ]
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidatePresets',
{
  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/candidatePresets', 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/candidatePresets',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /candidatePresets

Body parameter

{
  "name": "Welcome set for NL",
  "reference": "WELCOME_SET",
  "docTypes": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "(Copy of the passport)",
      "comment": "Some comment",
      "folder": "Some comment",
      "commentType": "info",
      "mandatory": false
    }
  ],
  "resources": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ]
    }
  ]
}

Parameters

Name In Type Required Description
name body string true Candidate Preset name
reference body string false Candidate Preset reference
docTypes body [candidatePresetDocType] false Documents to be applied to the candidate.
» id body UUID_V4 true Unique identifier for the entity
» name body string false Alternative name for document (for example, if added several identical document types.)
» comment body string false Comment for document
» folder body string false Folder for document
» commentType body candidateDocumentTypeCommentType false Candidate document type comment type
» mandatory body boolean false Folder for document
resources body [candidatePresetResource] false Resources to be applied to the candidate.
» id body UUID_V4 true Unique identifier for the entity
» actions body [resourceAction] true Resource actions (at least one action required)

Enumerated Values

Parameter Value
» commentType info
» commentType success
» commentType warning
» commentType danger
» actions read
» actions complete
» actions download

Example responses

200 Response

{
  "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": "Welcome set for NL",
  "reference": "WELCOME_SET",
  "docTypes": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "(Copy of the passport)",
      "comment": "Some comment",
      "folder": "Some comment",
      "commentType": "info",
      "mandatory": false
    }
  ],
  "resources": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidatePreset

Get candidate preset by {{id}}

Code samples

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


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

fetch('https://api.checkhub.io/candidatePresets/{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/candidatePresets/{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/candidatePresets/{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/candidatePresets/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /candidatePresets/{id}

Parameters

Name In Type Required Description
id path string true Model id which need to be founded
includeCompany query boolean false To include candidate preset 'company' relation
includeShared query boolean false To include candidate presets from the companies of the same company group

Example responses

200 Response

{
  "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": "Welcome set for NL",
  "reference": "WELCOME_SET",
  "docTypes": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "(Copy of the passport)",
      "comment": "Some comment",
      "folder": "Some comment",
      "commentType": "info",
      "mandatory": false
    }
  ],
  "resources": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ]
    }
  ],
  "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"
    ],
    "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"
    }
  }
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidatePresetFindByIdResponse

Update candidate preset by {{id}}

Code samples

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

const inputBody = '{
  "name": "Welcome set for NL",
  "reference": "WELCOME_SET",
  "docTypes": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "(Copy of the passport)",
      "comment": "Some comment",
      "folder": "Some comment",
      "commentType": "info",
      "mandatory": false
    }
  ],
  "resources": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ]
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidatePresets/{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": "Welcome set for NL",
  "reference": "WELCOME_SET",
  "docTypes": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "(Copy of the passport)",
      "comment": "Some comment",
      "folder": "Some comment",
      "commentType": "info",
      "mandatory": false
    }
  ],
  "resources": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ]
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidatePresets/{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/candidatePresets/{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/candidatePresets/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /candidatePresets/{id}

Body parameter

{
  "name": "Welcome set for NL",
  "reference": "WELCOME_SET",
  "docTypes": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "(Copy of the passport)",
      "comment": "Some comment",
      "folder": "Some comment",
      "commentType": "info",
      "mandatory": false
    }
  ],
  "resources": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ]
    }
  ]
}

Parameters

Name In Type Required Description
id path string true Model id which need to be updated
name body string true Candidate Preset name
reference body string false Candidate Preset reference
docTypes body [candidatePresetDocType] false Documents to be applied to the candidate.
» id body UUID_V4 true Unique identifier for the entity
» name body string false Alternative name for document (for example, if added several identical document types.)
» comment body string false Comment for document
» folder body string false Folder for document
» commentType body candidateDocumentTypeCommentType false Candidate document type comment type
» mandatory body boolean false Folder for document
resources body [candidatePresetResource] false Resources to be applied to the candidate.
» id body UUID_V4 true Unique identifier for the entity
» actions body [resourceAction] true Resource actions (at least one action required)

Enumerated Values

Parameter Value
» commentType info
» commentType success
» commentType warning
» commentType danger
» actions read
» actions complete
» actions download

Example responses

200 Response

{
  "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": "Welcome set for NL",
  "reference": "WELCOME_SET",
  "docTypes": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": "(Copy of the passport)",
      "comment": "Some comment",
      "folder": "Some comment",
      "commentType": "info",
      "mandatory": false
    }
  ],
  "resources": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "actions": [
        "complete",
        "download"
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Request was successful candidatePreset

Delete candidate preset by {{id}}

Code samples

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

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

fetch('https://api.checkhub.io/candidatePresets/{id}',
{
  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 = {};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/candidatePresets/{id}',
{
  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/candidatePresets/{id}', 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/candidatePresets/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /candidatePresets/{id}

Body parameter

{}

Parameters

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

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful successfullyCompletedRequest

Company

Get own company information

Code samples

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


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

fetch('https://api.checkhub.io/companies/me',
{
  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'
};

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

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

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

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

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

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

p JSON.parse(result)

GET /companies/me

The method allows you to get information about the company that owns the token.

Parameters

Name In Type Required Description
includePolicy query boolean false You can include company 'policy' relation

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "name": "",
  "zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
  "replyToEmail": "[email protected]",
  "archiveInactiveCandidateAfterDays": 7,
  "deleteInactiveCandidateAfterDays": 7,
  "logo": "",
  "languages": [
    "en",
    "fr",
    "nl",
    "de"
  ],
  "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"
  },
  "policy": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "en": "<p>Hi, this is our policy!</p>",
    "nl": "<p>Hoi, this is our policy!</p>",
    "fr": "<p>Salut, this is our policy!</p>",
    "de": "<p>Hallo, this is our policy!</p>"
  }
}

Responses

Status Meaning Description Schema
200 OK Request was successful companyFindByMeResponse

Edit company by {{id}}

Code samples

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

const inputBody = '{
  "name": "",
  "zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
  "replyToEmail": "[email protected]",
  "archiveInactiveCandidateAfterDays": 7,
  "deleteInactiveCandidateAfterDays": 7,
  "logo": "",
  "languages": [
    "en",
    "fr",
    "nl",
    "de"
  ],
  "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"
  },
  "policy": {
    "en": "<p>Hi, this is our policy!</p>",
    "nl": "<p>Hoi, this is our policy!</p>",
    "fr": "<p>Salut, this is our policy!</p>",
    "de": "<p>Hallo, this is our policy!</p>"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/companies/{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": "",
  "zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
  "replyToEmail": "[email protected]",
  "archiveInactiveCandidateAfterDays": 7,
  "deleteInactiveCandidateAfterDays": 7,
  "logo": "",
  "languages": [
    "en",
    "fr",
    "nl",
    "de"
  ],
  "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"
  },
  "policy": {
    "en": "<p>Hi, this is our policy!</p>",
    "nl": "<p>Hoi, this is our policy!</p>",
    "fr": "<p>Salut, this is our policy!</p>",
    "de": "<p>Hallo, this is our policy!</p>"
  }
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/companies/{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/companies/{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/companies/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /companies/{id}

Body parameter

{
  "name": "",
  "zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
  "replyToEmail": "[email protected]",
  "archiveInactiveCandidateAfterDays": 7,
  "deleteInactiveCandidateAfterDays": 7,
  "logo": "",
  "languages": [
    "en",
    "fr",
    "nl",
    "de"
  ],
  "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"
  },
  "policy": {
    "en": "<p>Hi, this is our policy!</p>",
    "nl": "<p>Hoi, this is our policy!</p>",
    "fr": "<p>Salut, this is our policy!</p>",
    "de": "<p>Hallo, this is our policy!</p>"
  }
}

Parameters

Name In Type Required Description
id path string true Model id which need to be updated
body body companyEditByIdRequest false none

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "name": "",
  "zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
  "replyToEmail": "[email protected]",
  "archiveInactiveCandidateAfterDays": 7,
  "deleteInactiveCandidateAfterDays": 7,
  "logo": "",
  "languages": [
    "en",
    "fr",
    "nl",
    "de"
  ],
  "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"
  },
  "policy": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "en": "<p>Hi, this is our policy!</p>",
    "nl": "<p>Hoi, this is our policy!</p>",
    "fr": "<p>Salut, this is our policy!</p>",
    "de": "<p>Hallo, this is our policy!</p>"
  }
}

Responses

Status Meaning Description Schema
200 OK Request was successful companyEditByIdResponse

Validate Company reference

Code samples

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

const inputBody = '{
  "reference": "example value",
  "ownId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "model": "candidate"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/companies/validate-reference',
{
  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 = {
  "reference": "example value",
  "ownId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "model": "candidate"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/companies/validate-reference',
{
  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/companies/validate-reference', 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/companies/validate-reference',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /companies/validate-reference

Body parameter

{
  "reference": "example value",
  "ownId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "model": "candidate"
}

Parameters

Name In Type Required Description
body body companyValidateReference false none

Example responses

200 Response

{
  "isValid": true,
  "isValidString": true,
  "isUnique": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful companyValidateReferenceResponse

Resource

Get Resource Collection

Code samples

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


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

fetch('https://api.checkhub.io/resources',
{
  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/resources',
{
  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/resources', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

GET /resources

Parameters

Name In Type Required Description
limit query number false Maximum number of items in the response default: 10
skip query number false Number of items skipped during the selection. default: 0
order query string false Resource collection order
filter[searchText] query string false Resource Partial search by text of resource name
filter[languages][] query string false Filter resources by languages
filter[types][] query string false Filter resources by types

Enumerated Values

Parameter Value
order name asc
order name desc
filter[languages][] en
filter[languages][] fr
filter[languages][] nl
filter[languages][] de
filter[types][] readonly
filter[types][] editable
filter[types][] file

Example responses

200 Response

[
  {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "name": "Diploma",
    "filename": "diploma_{candidateFirstname}",
    "type": "editable",
    "language": "en",
    "shareCode": "",
    "blocking": false,
    "version": 1,
    "actions": [
      "complete",
      "download"
    ],
    "content": {
      "text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n",
      "file": "resources/5fa52f8d07763975db16e720/4d30393f-eb29-4bb8-ba3e-c40efa79fb00_test.pdf",
      "originalFilename": "test.pdf"
    },
    "fields": [
      {
        "reference": "firstNameRef",
        "name": "First Name",
        "contentType": "text",
        "prefilled": "{candidateLastname}",
        "editable": true,
        "mandatory": false
      }
    ],
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z"
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful resourceArray

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 Resource

Code samples

POST https://api.checkhub.io/resources HTTP/1.1
Host: api.checkhub.io
Content-Type: multipart/form-data
Accept: application/json

const inputBody = '{
  "name": "ASAP",
  "filename": "diploma_{candidateFirstname}",
  "actions": [
    "complete",
    "download"
  ],
  "language": "en",
  "blocking": false,
  "fields": [
    {
      "reference": "firstNameRef",
      "name": "First Name",
      "contentType": "text",
      "prefilled": "{candidateLastname}",
      "editable": true,
      "mandatory": false
    }
  ],
  "content": {
    "text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n"
  }
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/resources',
{
  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": "ASAP",
  "filename": "diploma_{candidateFirstname}",
  "actions": [
    "complete",
    "download"
  ],
  "language": "en",
  "blocking": false,
  "fields": [
    {
      "reference": "firstNameRef",
      "name": "First Name",
      "contentType": "text",
      "prefilled": "{candidateLastname}",
      "editable": true,
      "mandatory": false
    }
  ],
  "content": {
    "text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n"
  }
};
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/resources',
{
  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': 'multipart/form-data',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

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

print(r.json())

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

POST /resources

Body parameter

name: ASAP
filename: diploma_{candidateFirstname}
actions:
  - complete
  - download
language: en
blocking: false
fields:
  - reference: firstNameRef
    name: First Name
    contentType: text
    prefilled: "{candidateLastname}"
    editable: true
    mandatory: false
content:
  text: \n\n\n\n\n<p>{candidateFirstname}<br />Some
    candidate first name</p>\n\n

Parameters

Name In Type Required Description
body body resourceCreate false none

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "name": "Diploma",
  "filename": "diploma_{candidateFirstname}",
  "type": "editable",
  "language": "en",
  "shareCode": "",
  "blocking": false,
  "version": 1,
  "actions": [
    "complete",
    "download"
  ],
  "content": {
    "text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n",
    "file": "resources/5fa52f8d07763975db16e720/4d30393f-eb29-4bb8-ba3e-c40efa79fb00_test.pdf",
    "originalFilename": "test.pdf"
  },
  "fields": [
    {
      "reference": "firstNameRef",
      "name": "First Name",
      "contentType": "text",
      "prefilled": "{candidateLastname}",
      "editable": true,
      "mandatory": false
    }
  ],
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z"
}

Responses

Status Meaning Description Schema
200 OK Request was successful resource

Get Resource by {{id}}

Code samples

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


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

fetch('https://api.checkhub.io/resources/{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/resources/{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/resources/{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/resources/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /resources/{id}

Parameters

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

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "name": "Diploma",
  "filename": "diploma_{candidateFirstname}",
  "type": "editable",
  "language": "en",
  "shareCode": "",
  "blocking": false,
  "version": 1,
  "actions": [
    "complete",
    "download"
  ],
  "content": {
    "text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n",
    "file": "resources/5fa52f8d07763975db16e720/4d30393f-eb29-4bb8-ba3e-c40efa79fb00_test.pdf",
    "originalFilename": "test.pdf"
  },
  "fields": [
    {
      "reference": "firstNameRef",
      "name": "First Name",
      "contentType": "text",
      "prefilled": "{candidateLastname}",
      "editable": true,
      "mandatory": false
    }
  ],
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z"
}

Responses

Status Meaning Description Schema
200 OK Request was successful resource

Update Resource by {{id}}

Code samples

PUT https://api.checkhub.io/resources/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: multipart/form-data
Accept: application/json

const inputBody = '{
  "name": "ASAP",
  "filename": "diploma_{candidateFirstname}",
  "actions": [
    "complete",
    "download"
  ],
  "language": "en",
  "blocking": false,
  "fields": [
    {
      "reference": "firstNameRef",
      "name": "First Name",
      "contentType": "text",
      "prefilled": "{candidateLastname}",
      "editable": true,
      "mandatory": false
    }
  ],
  "content": {
    "text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n"
  }
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/resources/{id}',
{
  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 = {
  "name": "ASAP",
  "filename": "diploma_{candidateFirstname}",
  "actions": [
    "complete",
    "download"
  ],
  "language": "en",
  "blocking": false,
  "fields": [
    {
      "reference": "firstNameRef",
      "name": "First Name",
      "contentType": "text",
      "prefilled": "{candidateLastname}",
      "editable": true,
      "mandatory": false
    }
  ],
  "content": {
    "text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n"
  }
};
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/resources/{id}',
{
  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': 'multipart/form-data',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

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

print(r.json())

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

PUT /resources/{id}

Body parameter

name: ASAP
filename: diploma_{candidateFirstname}
actions:
  - complete
  - download
language: en
blocking: false
fields:
  - reference: firstNameRef
    name: First Name
    contentType: text
    prefilled: "{candidateLastname}"
    editable: true
    mandatory: false
content:
  text: \n\n\n\n\n<p>{candidateFirstname}<br />Some
    candidate first name</p>\n\n

Parameters

Name In Type Required Description
id path string true Model id which need to be updated
body body resourceUpdate false none

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "name": "Diploma",
  "filename": "diploma_{candidateFirstname}",
  "type": "editable",
  "language": "en",
  "shareCode": "",
  "blocking": false,
  "version": 1,
  "actions": [
    "complete",
    "download"
  ],
  "content": {
    "text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n",
    "file": "resources/5fa52f8d07763975db16e720/4d30393f-eb29-4bb8-ba3e-c40efa79fb00_test.pdf",
    "originalFilename": "test.pdf"
  },
  "fields": [
    {
      "reference": "firstNameRef",
      "name": "First Name",
      "contentType": "text",
      "prefilled": "{candidateLastname}",
      "editable": true,
      "mandatory": false
    }
  ],
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z"
}

Responses

Status Meaning Description Schema
200 OK Request was successful resource

Delete Resource by {{id}}

Code samples

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

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

fetch('https://api.checkhub.io/resources/{id}',
{
  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 = {};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/resources/{id}',
{
  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/resources/{id}', 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/resources/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /resources/{id}

Body parameter

{}

Parameters

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

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful resourceSuccessResponse

Duplicate Resource

Code samples

POST https://api.checkhub.io/resources/{id}/duplicate HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json

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

fetch('https://api.checkhub.io/resources/{id}/duplicate',
{
  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 = {};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/resources/{id}/duplicate',
{
  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/resources/{id}/duplicate', 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/resources/{id}/duplicate',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /resources/{id}/duplicate

Body parameter

{}

Parameters

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

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "name": "Diploma",
  "filename": "diploma_{candidateFirstname}",
  "type": "editable",
  "language": "en",
  "shareCode": "",
  "blocking": false,
  "version": 1,
  "actions": [
    "complete",
    "download"
  ],
  "content": {
    "text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n",
    "file": "resources/5fa52f8d07763975db16e720/4d30393f-eb29-4bb8-ba3e-c40efa79fb00_test.pdf",
    "originalFilename": "test.pdf"
  },
  "fields": [
    {
      "reference": "firstNameRef",
      "name": "First Name",
      "contentType": "text",
      "prefilled": "{candidateLastname}",
      "editable": true,
      "mandatory": false
    }
  ],
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z"
}

Responses

Status Meaning Description Schema
200 OK Request was successful resource

Share Resource

Code samples

PUT https://api.checkhub.io/resources/{id}/share HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json

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

fetch('https://api.checkhub.io/resources/{id}/share',
{
  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 = {};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/resources/{id}/share',
{
  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/resources/{id}/share', 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/resources/{id}/share',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /resources/{id}/share

Body parameter

{}

Parameters

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

Example responses

200 Response

{
  "shareCode": "DQ6M57AH"
}

Responses

Status Meaning Description Schema
200 OK Request was successful resourceShareResponse

Unshare Resource

Code samples

DELETE https://api.checkhub.io/resources/{id}/unshare HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json

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

fetch('https://api.checkhub.io/resources/{id}/unshare',
{
  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 = {};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/resources/{id}/unshare',
{
  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/resources/{id}/unshare', 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/resources/{id}/unshare',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /resources/{id}/unshare

Body parameter

{}

Parameters

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

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful resourceSuccessResponse

Validate Shared Code

Code samples

PUT https://api.checkhub.io/resources/validate HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json

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

fetch('https://api.checkhub.io/resources/validate',
{
  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 = {
  "shareCode": ""
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/resources/validate',
{
  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/resources/validate', 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/resources/validate',
  params: {
  }, headers: headers

p JSON.parse(result)

PUT /resources/validate

Body parameter

{
  "shareCode": ""
}

Parameters

Name In Type Required Description
body body resourceValidateSharedCode false none

Example responses

200 Response

{
  "resource": {
    "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "name": "Diploma",
    "filename": "diploma_{candidateFirstname}",
    "type": "editable",
    "language": "en",
    "shareCode": "",
    "blocking": false,
    "version": 1,
    "actions": [
      "complete",
      "download"
    ],
    "content": {
      "text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n",
      "file": "resources/5fa52f8d07763975db16e720/4d30393f-eb29-4bb8-ba3e-c40efa79fb00_test.pdf",
      "originalFilename": "test.pdf"
    },
    "fields": [
      {
        "reference": "firstNameRef",
        "name": "First Name",
        "contentType": "text",
        "prefilled": "{candidateLastname}",
        "editable": true,
        "mandatory": false
      }
    ],
    "createdAt": "2019-09-12T15:36:09.264Z",
    "updatedAt": "2019-09-12T15:36:09.264Z"
  }
}

Responses

Status Meaning Description Schema
200 OK Request was successful resourceValidateSharedCodeResponse

Import Resource by Shared Code

Code samples

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

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

fetch('https://api.checkhub.io/resources/import',
{
  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 = {
  "shareCode": ""
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/resources/import',
{
  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/resources/import', 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/resources/import',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /resources/import

Body parameter

{
  "shareCode": ""
}

Parameters

Name In Type Required Description
body body resourceImport false none

Example responses

200 Response

{
  "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "name": "Diploma",
  "filename": "diploma_{candidateFirstname}",
  "type": "editable",
  "language": "en",
  "shareCode": "",
  "blocking": false,
  "version": 1,
  "actions": [
    "complete",
    "download"
  ],
  "content": {
    "text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n",
    "file": "resources/5fa52f8d07763975db16e720/4d30393f-eb29-4bb8-ba3e-c40efa79fb00_test.pdf",
    "originalFilename": "test.pdf"
  },
  "fields": [
    {
      "reference": "firstNameRef",
      "name": "First Name",
      "contentType": "text",
      "prefilled": "{candidateLastname}",
      "editable": true,
      "mandatory": false
    }
  ],
  "createdAt": "2019-09-12T15:36:09.264Z",
  "updatedAt": "2019-09-12T15:36:09.264Z"
}

Responses

Status Meaning Description Schema
200 OK Request was successful resource

Document Type

Create a new Document Type.

Code samples

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

const inputBody = '{
  "filename": "file_of_the_company_candidate_{candidateFirstname}",
  "name": "ASAP",
  "nameI18n": {
    "en": "",
    "fr": "",
    "nl": "",
    "de": ""
  },
  "description": "Document Type description",
  "descriptionI18n": {
    "en": "",
    "fr": "",
    "nl": "",
    "de": ""
  },
  "documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "validationType": "auto",
  "integrationSendOriginal": false,
  "convertToPDF": false,
  "isUnique": false,
  "expiresInMonths": 2,
  "isRectoVerso": false
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/documentTypes',
{
  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 = {
  "filename": "file_of_the_company_candidate_{candidateFirstname}",
  "name": "ASAP",
  "nameI18n": {
    "en": "",
    "fr": "",
    "nl": "",
    "de": ""
  },
  "description": "Document Type description",
  "descriptionI18n": {
    "en": "",
    "fr": "",
    "nl": "",
    "de": ""
  },
  "documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "validationType": "auto",
  "integrationSendOriginal": false,
  "convertToPDF": false,
  "isUnique": false,
  "expiresInMonths": 2,
  "isRectoVerso": false
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/documentTypes',
{
  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/documentTypes', 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/documentTypes',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /documentTypes

Body parameter

{
  "filename": "file_of_the_company_candidate_{candidateFirstname}",
  "name": "ASAP",
  "nameI18n": {
    "en": "",
    "fr": "",
    "nl": "",
    "de": ""
  },
  "description": "Document Type description",
  "descriptionI18n": {
    "en": "",
    "fr": "",
    "nl": "",
    "de": ""
  },
  "documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "validationType": "auto",
  "integrationSendOriginal": false,
  "convertToPDF": false,
  "isUnique": false,
  "expiresInMonths": 2,
  "isRectoVerso": false
}

Parameters

Name In Type Required Description
filename body string true Document type filename. It can include dynamic fields like {candidateFirstname}
name body string true Document type name
nameI18n body translations false none
» en body string false none
» fr body string false none
» nl body string false none
» de body string false none
description body string false Document type description
descriptionI18n body translations false none
documentParserId body UUID_V4 false Unique identifier for the entity
documentValidationSetId body UUID_V4 false Unique identifier for the entity
validationType body string false Document validation type
integrationSendOriginal body boolean false It says that uploaded document original file should be send to integrations
convertToPDF body boolean false It says that document should be converted to pdf
isUnique body boolean false It says that document type should be unique for a candidate
expiresInMonths body number false Document should be expired after the amount of months.
isRectoVerso body boolean false It says that document must have two parts (front and back sides). Document parts will be combined to pdf file

Enumerated Values

Parameter Value
validationType auto
validationType manual
validationType always_valid

Example responses

200 Response

{
  "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",
  "nameI18n": {
    "en": "",
    "fr": "",
    "nl": "",
    "de": ""
  },
  "description": "Document Type description",
  "descriptionI18n": {
    "en": "",
    "fr": "",
    "nl": "",
    "de": ""
  },
  "documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "validationType": "auto",
  "integrationSendOriginal": false,
  "convertToPDF": false,
  "isUnique": false,
  "expiresInMonths": 2,
  "isRectoVerso": false
}

Responses

Status Meaning Description Schema
200 OK Request was successful documentType

Get document type collection

Code samples

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


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

fetch('https://api.checkhub.io/documentTypes',
{
  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/documentTypes',
{
  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/documentTypes', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

GET /documentTypes

Parameters

Name In Type Required Description
limit query number false Maximum number of items in the response default: 10
skip query number false Number of items skipped during the selection. default: 0
order query string false Document type collection order
filter[ids][] query UUID_V4 false Search by document type ids
includeShared query boolean false To include document types from the companies of the same company group
includeCandidateDocumentTypes query boolean false To include document type 'candidateDocumentTypes' relation
includeMimeTypes query boolean false To include document type 'mimeTypes' relation
includeValidationSet query boolean false To include document type 'validationSet' relation
includeDocumentParser query boolean false To include document type 'documentparser' relation

Enumerated Values

Parameter Value
order name asc
order name desc

Example responses

200 Response

[
  {
    "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",
    "nameI18n": {
      "en": "",
      "fr": "",
      "nl": "",
      "de": ""
    },
    "description": "Document Type description",
    "descriptionI18n": {
      "en": "",
      "fr": "",
      "nl": "",
      "de": ""
    },
    "documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
    "validationType": "auto",
    "integrationSendOriginal": false,
    "convertToPDF": false,
    "isUnique": false,
    "expiresInMonths": 2,
    "isRectoVerso": false,
    "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": null,
        "ocrParsedData": {},
        "validationSnapshot": {},
        "integrationTransferedAt": "string",
        "mergeSetFilePath": "string",
        "isMultiple": false,
        "isProcessing": 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,
        "isPaused": false
      }
    ],
    "mimeTypes": [
      {
        "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
        "name": ".pdf name",
        "extension": ".pdf",
        "mime": "application/pdf",
        "icon": ""
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Request was successful documentTypeFindResponse

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 document type by {{id}}

Code samples

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


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

fetch('https://api.checkhub.io/documentTypes/{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/documentTypes/{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/documentTypes/{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/documentTypes/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /documentTypes/{id}

Parameters

Name In Type Required Description
id path string true Model id which need to be founded
includeShared query boolean false To include document types from the companies of the same company group
includeCandidateDocumentTypes query boolean false To include document type 'candidateDocumentTypes' relation
includeMimeTypes query boolean false To include document type 'mimeTypes' relation
includeValidationSet query boolean false To include document type 'validationSet' relation
includeDocumentParser query boolean false To include document type 'documentparser' relation

Example responses

200 Response

{
  "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",
  "nameI18n": {
    "en": "",
    "fr": "",
    "nl": "",
    "de": ""
  },
  "description": "Document Type description",
  "descriptionI18n": {
    "en": "",
    "fr": "",
    "nl": "",
    "de": ""
  },
  "documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "validationType": "auto",
  "integrationSendOriginal": false,
  "convertToPDF": false,
  "isUnique": false,
  "expiresInMonths": 2,
  "isRectoVerso": false,
  "mimeTypes": [
    {
      "id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
      "name": ".pdf name",
      "extension": ".pdf",
      "mime": "application/pdf",
      "icon": ""
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Request was successful documentTypeFindOneResponse

Edit document type by {{id}}

Code samples

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

const inputBody = '{
  "filename": "file_of_the_company_candidate_{candidateFirstname}",
  "name": "ASAP",
  "nameI18n": {
    "en": "",
    "fr": "",
    "nl": "",
    "de": ""
  },
  "description": "Document Type description",
  "descriptionI18n": {
    "en": "",
    "fr": "",
    "nl": "",
    "de": ""
  },
  "documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "validationType": "auto",
  "integrationSendOriginal": false,
  "convertToPDF": false,
  "isUnique": false,
  "expiresInMonths": 2,
  "isRectoVerso": false
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/documentTypes/{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 = {
  "filename": "file_of_the_company_candidate_{candidateFirstname}",
  "name": "ASAP",
  "nameI18n": {
    "en": "",
    "fr": "",
    "nl": "",
    "de": ""
  },
  "description": "Document Type description",
  "descriptionI18n": {
    "en": "",
    "fr": "",
    "nl": "",
    "de": ""
  },
  "documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "validationType": "auto",
  "integrationSendOriginal": false,
  "convertToPDF": false,
  "isUnique": false,
  "expiresInMonths": 2,
  "isRectoVerso": false
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/documentTypes/{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/documentTypes/{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/documentTypes/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

PATCH /documentTypes/{id}

Body parameter

{
  "filename": "file_of_the_company_candidate_{candidateFirstname}",
  "name": "ASAP",
  "nameI18n": {
    "en": "",
    "fr": "",
    "nl": "",
    "de": ""
  },
  "description": "Document Type description",
  "descriptionI18n": {
    "en": "",
    "fr": "",
    "nl": "",
    "de": ""
  },
  "documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "validationType": "auto",
  "integrationSendOriginal": false,
  "convertToPDF": false,
  "isUnique": false,
  "expiresInMonths": 2,
  "isRectoVerso": false
}

Parameters

Name In Type Required Description
id path string true Model id which need to be updated
filename body string false Document type filename. It can include dynamic fields like {candidateFirstname}
name body string false Document type name
nameI18n body translations false none
» en body string false none
» fr body string false none
» nl body string false none
» de body string false none
description body string false Document type description
descriptionI18n body translations false none
documentParserId body UUID_V4 false Unique identifier for the entity
documentValidationSetId body UUID_V4 false Unique identifier for the entity
validationType body string false Document validation type
integrationSendOriginal body boolean false It says that uploaded document original file should be send to integrations
convertToPDF body boolean false It says that document should be converted to pdf
isUnique body boolean false It says that document type should be unique for a candidate
expiresInMonths body number false Document should be expired after the amount of months.
isRectoVerso body boolean false It says that document must have two parts (front and back sides). Document parts will be combined to pdf file

Enumerated Values

Parameter Value
validationType auto
validationType manual
validationType always_valid

Example responses

200 Response

{
  "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",
  "nameI18n": {
    "en": "",
    "fr": "",
    "nl": "",
    "de": ""
  },
  "description": "Document Type description",
  "descriptionI18n": {
    "en": "",
    "fr": "",
    "nl": "",
    "de": ""
  },
  "documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
  "validationType": "auto",
  "integrationSendOriginal": false,
  "convertToPDF": false,
  "isUnique": false,
  "expiresInMonths": 2,
  "isRectoVerso": false
}

Responses

Status Meaning Description Schema
200 OK Request was successful documentType

Delete document type by {{id}}

Code samples

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

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

fetch('https://api.checkhub.io/documentTypes/{id}',
{
  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 = {};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://api.checkhub.io/documentTypes/{id}',
{
  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/documentTypes/{id}', 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/documentTypes/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

DELETE /documentTypes/{id}

Body parameter

{}

Parameters

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

Example responses

200 Response

{
  "success": true
}

Responses

Status Meaning Description Schema
200 OK Request was successful successfullyCompletedRequest

Document Validation Set

Get document validation set collection

Code samples

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


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

fetch('https://api.checkhub.io/documentValidationSets',
{
  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/documentValidationSets',
{
  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/documentValidationSets', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

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